digital_femsa 1.0.0

data/docs/EventsApi.md

@@ -0,0 +1,239 @@
+# DigitalFemsa::EventsApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_event**](EventsApi.md#get_event) | **GET** /events/{id} | Get Event |
+| [**get_events**](EventsApi.md#get_events) | **GET** /events | Get list of Events |
+| [**resend_event**](EventsApi.md#resend_event) | **POST** /events/{event_id}/webhook_logs/{webhook_log_id}/resend | Resend Event |
+
+
+## get_event
+
+> <EventResponse> get_event(id, opts)
+
+Get Event
+
+Returns a single event
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::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 DigitalFemsa::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(<EventResponse>, Integer, Hash)> get_event_with_http_info(id, opts)
+
+```ruby
+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 DigitalFemsa::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 &#39;es&#39;] |
+| **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**](EventResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_events
+
+> <GetEventsResponse> get_events(opts)
+
+Get list of Events
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::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 DigitalFemsa::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(<GetEventsResponse>, Integer, Hash)> get_events_with_http_info(opts)
+
+```ruby
+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 DigitalFemsa::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 &#39;es&#39;] |
+| **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**](GetEventsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## resend_event
+
+> <EventsResendResponse> resend_event(event_id, webhook_log_id, opts)
+
+Resend Event
+
+Try to send an event
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::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 DigitalFemsa::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(<EventsResendResponse>, Integer, Hash)> resend_event_with_http_info(event_id, webhook_log_id, opts)
+
+```ruby
+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 DigitalFemsa::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 &#39;es&#39;] |
+
+### Return type
+
+[**EventsResendResponse**](EventsResendResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/EventsResendResponse.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::EventsResendResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **failed_attempts** | **Integer** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **last_attempted_at** | **Integer** |  | [optional] |
+| **last_http_response_status** | **Integer** |  | [optional] |
+| **response_data** | **Hash<String, Object>** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::EventsResendResponse.new(
+  failed_attempts: 6,
+  id: webhl_2svd2sh6GbqzyWBNZ,
+  last_attempted_at: 1684265970,
+  last_http_response_status: 405,
+  response_data: {},
+  url: https://username:password@mockoon.stg.femsa.io/payments-api/cash/merchant_approval
+)
+```
+

data/docs/FiscalEntityAddress.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::FiscalEntityAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street1** | **String** | Street name and number |  |
+| **street2** | **String** | Street name and number | [optional] |
+| **postal_code** | **String** | Postal code |  |
+| **city** | **String** | City |  |
+| **state** | **String** | State | [optional] |
+| **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) |  |
+| **external_number** | **String** | External number |  |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::FiscalEntityAddress.new(
+  street1: Nuevo Leon 254,
+  street2: Departamento 404,
+  postal_code: 06100,
+  city: Ciudad de Mexico,
+  state: Ciudad de Mexico,
+  country: MX,
+  external_number: 123
+)
+```
+

data/docs/GetApiKeysResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetApiKeysResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **data** | [**Array<ApiKeyResponse>**](ApiKeyResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetApiKeysResponse.new(
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  has_more: false,
+  object: list,
+  data: null
+)
+```
+

data/docs/GetChargesResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetChargesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<ChargeResponse>**](ChargeResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetChargesResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetCompaniesResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetCompaniesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<CompanyResponse>**](CompanyResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetCompaniesResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetCustomerPaymentMethodDataResponse.md

@@ -0,0 +1,77 @@
+# DigitalFemsa::GetCustomerPaymentMethodDataResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::GetCustomerPaymentMethodDataResponse.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCashResponse'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::GetCustomerPaymentMethodDataResponse.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::GetCustomerPaymentMethodDataResponse.openapi_discriminator_mapping
+# =>
+# {
+#   :'cash' => :'PaymentMethodCashResponse',
+#   :'oxxo_recurrent' => :'PaymentMethodCashResponse'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::GetCustomerPaymentMethodDataResponse.build(data)
+# => #<PaymentMethodCashResponse:0x00007fdd4aab02a0>
+
+DigitalFemsa::GetCustomerPaymentMethodDataResponse.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PaymentMethodCashResponse`
+- `nil` (if no type matches)
+

data/docs/GetEventsResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetEventsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<EventResponse>**](EventResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetEventsResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetOrderDiscountLinesResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetOrderDiscountLinesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<DiscountLinesResponse>**](DiscountLinesResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetOrderDiscountLinesResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetOrdersResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetOrdersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<OrderResponse>**](OrderResponse.md) |  |  |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetOrdersResponse.new(
+  data: null,
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1
+)
+```
+

data/docs/GetPaymentMethodResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetPaymentMethodResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<GetCustomerPaymentMethodDataResponse>**](GetCustomerPaymentMethodDataResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetPaymentMethodResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetTransactionsResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetTransactionsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<TransactionResponse>**](TransactionResponse.md) | Transactions | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetTransactionsResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetTransfersResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetTransfersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<TransfersResponse>**](TransfersResponse.md) | Transfers | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetTransfersResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetWebhookKeysResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetWebhookKeysResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<WebhookKeyResponse>**](WebhookKeyResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetWebhookKeysResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/GetWebhooksResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::GetWebhooksResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+| **data** | [**Array<WebhookResponse>**](WebhookResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::GetWebhooksResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+