Skip to content

Latest commit

 

History

History
385 lines (279 loc) · 10.8 KB

WebhookKeysApi.md

File metadata and controls

385 lines (279 loc) · 10.8 KB
Raw

Conekta::WebhookKeysApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
create_webhook_key POST /webhook_keys Create Webhook Key
delete_webhook_key DELETE /webhook_keys/{id} Delete Webhook key
get_webhook_key GET /webhook_keys/{id} Get Webhook Key
get_webhook_keys GET /webhook_keys Get List of Webhook Keys
update_webhook_key PUT /webhook_keys/{id} Update Webhook Key

create_webhook_key

create_webhook_key(opts)

Create Webhook Key

Create a webhook key

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::WebhookKeysApi.new
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  webhook_key_request: Conekta::WebhookKeyRequest.new # WebhookKeyRequest | 
}

begin
  # Create Webhook Key
  result = api_instance.create_webhook_key(opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->create_webhook_key: #{e}"
end

Using the create_webhook_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_webhook_key_with_http_info(opts)

begin
  # Create Webhook Key
  data, status_code, headers = api_instance.create_webhook_key_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookKeyCreateResponse>
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->create_webhook_key_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
accept_language String Use for knowing which language to use [optional][default to 'es']
webhook_key_request WebhookKeyRequest [optional]

Return type

WebhookKeyCreateResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json

delete_webhook_key

delete_webhook_key(id, opts)

Delete Webhook key

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::WebhookKeysApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
opts = {
  accept_language: 'es' # String | Use for knowing which language to use
}

begin
  # Delete Webhook key
  result = api_instance.delete_webhook_key(id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->delete_webhook_key: #{e}"
end

Using the delete_webhook_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_webhook_key_with_http_info(id, opts)

begin
  # Delete Webhook key
  data, status_code, headers = api_instance.delete_webhook_key_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookKeyDeleteResponse>
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->delete_webhook_key_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
accept_language String Use for knowing which language to use [optional][default to 'es']

Return type

WebhookKeyDeleteResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

get_webhook_key

get_webhook_key(id, opts)

Get Webhook Key

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::WebhookKeysApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
}

begin
  # Get Webhook Key
  result = api_instance.get_webhook_key(id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->get_webhook_key: #{e}"
end

Using the get_webhook_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_webhook_key_with_http_info(id, opts)

begin
  # Get Webhook Key
  data, status_code, headers = api_instance.get_webhook_key_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookKeyResponse>
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->get_webhook_key_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
accept_language String Use for knowing which language to use [optional][default to 'es']
x_child_company_id String In the case of a holding company, the company id of the child company to which will process the request. [optional]

Return type

WebhookKeyResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

get_webhook_keys

get_webhook_keys(opts)

Get List of Webhook Keys

Consume the list of webhook keys you have

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::WebhookKeysApi.new
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  x_child_company_id: '6441b6376b60c3a638da80af', # String | In the case of a holding company, the company id of the child company to which will process the request.
  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
  search: 'search_example', # String | General order search, e.g. by mail, reference etc.
  _next: '_next_example', # String | next page
  previous: 'previous_example' # String | previous page
}

begin
  # Get List of Webhook Keys
  result = api_instance.get_webhook_keys(opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->get_webhook_keys: #{e}"
end

Using the get_webhook_keys_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_webhook_keys_with_http_info(opts)

begin
  # Get List of Webhook Keys
  data, status_code, headers = api_instance.get_webhook_keys_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetWebhookKeysResponse>
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->get_webhook_keys_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
accept_language String Use for knowing which language to use [optional][default to 'es']
x_child_company_id String In the case of a holding company, the company id of the child company to which will process the request. [optional]
limit Integer The numbers of items to return, the maximum value is 250 [optional][default to 20]
search String General order search, e.g. by mail, reference etc. [optional]
_next String next page [optional]
previous String previous page [optional]

Return type

GetWebhookKeysResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

update_webhook_key

update_webhook_key(id, opts)

Update Webhook Key

updates an existing webhook key

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::WebhookKeysApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  webhook_key_update_request: Conekta::WebhookKeyUpdateRequest.new # WebhookKeyUpdateRequest | 
}

begin
  # Update Webhook Key
  result = api_instance.update_webhook_key(id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->update_webhook_key: #{e}"
end

Using the update_webhook_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_webhook_key_with_http_info(id, opts)

begin
  # Update Webhook Key
  data, status_code, headers = api_instance.update_webhook_key_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <WebhookKeyResponse>
rescue Conekta::ApiError => e
  puts "Error when calling WebhookKeysApi->update_webhook_key_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
accept_language String Use for knowing which language to use [optional][default to 'es']
webhook_key_update_request WebhookKeyUpdateRequest [optional]

Return type

WebhookKeyResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.conekta-v2.1.0+json