Skip to content

Latest commit

 

History

History
239 lines (174 loc) · 6.65 KB

EventsApi.md

File metadata and controls

239 lines (174 loc) · 6.65 KB

Conekta::EventsApi

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

Method HTTP request Description
get_event GET /events/{id} Get Event
get_events GET /events Get list of Events
resend_event POST /events/{event_id}/webhook_logs/{webhook_log_id}/resend Resend Event

get_event

get_event(id, opts)

Get Event

Returns a single event

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::EventsApi.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 Event
  result = api_instance.get_event(id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->get_event: #{e}"
end

Using the get_event_with_http_info variant

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

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

begin
  # Get Event
  data, status_code, headers = api_instance.get_event_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EventResponse>
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->get_event_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

EventResponse

Authorization

bearerAuth

HTTP request headers

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

get_events

get_events(opts)

Get list of Events

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::EventsApi.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 Events
  result = api_instance.get_events(opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->get_events: #{e}"
end

Using the get_events_with_http_info variant

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

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

begin
  # Get list of Events
  data, status_code, headers = api_instance.get_events_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetEventsResponse>
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->get_events_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

GetEventsResponse

Authorization

bearerAuth

HTTP request headers

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

resend_event

resend_event(event_id, webhook_log_id, opts)

Resend Event

Try to send an event

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::EventsApi.new
event_id = '6463d6e35a4c3e001819e760' # String | event identifier
webhook_log_id = 'webhl_2tsv6NzWJHBWCkqGt' # String | webhook log identifier
opts = {
  accept_language: 'es' # String | Use for knowing which language to use
}

begin
  # Resend Event
  result = api_instance.resend_event(event_id, webhook_log_id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->resend_event: #{e}"
end

Using the resend_event_with_http_info variant

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

<Array(, Integer, Hash)> resend_event_with_http_info(event_id, webhook_log_id, opts)

begin
  # Resend Event
  data, status_code, headers = api_instance.resend_event_with_http_info(event_id, webhook_log_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <EventsResendResponse>
rescue Conekta::ApiError => e
  puts "Error when calling EventsApi->resend_event_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
event_id String event identifier
webhook_log_id String webhook log identifier
accept_language String Use for knowing which language to use [optional][default to 'es']

Return type

EventsResendResponse

Authorization

bearerAuth

HTTP request headers

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