digital_femsa 1.0.0

data/docs/ApiKeyResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::ApiKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the api key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] |
+| **updated_at** | **Integer** | Unix timestamp in seconds of when the api key was last updated | [optional] |
+| **deactivated_at** | **Integer** | Unix timestamp in seconds of when the api key was deleted | [optional] |
+| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
+| **id** | **String** | Unique identifier of the api key | [optional] |
+| **livemode** | **Boolean** | Indicates if the api key is in production | [optional] |
+| **deleted** | **Boolean** | Indicates if the api key was deleted | [optional] |
+| **object** | **String** | Object name, value is 'api_key' | [optional] |
+| **prefix** | **String** | The first few characters of the authentication_token | [optional] |
+| **role** | **String** | Indicates if the api key is private or public | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ApiKeyResponse.new(
+  active: true,
+  created_at: 1684167881,
+  updated_at: 1684167923,
+  deactivated_at: null,
+  description: online store,
+  id: 64625cc9f3e02c00163f5e4d,
+  livemode: false,
+  deleted: false,
+  object: api_key,
+  prefix: key_rp,
+  role: private
+)
+```
+

data/docs/ApiKeyResponseOnDelete.md

@@ -0,0 +1,34 @@
+# DigitalFemsa::ApiKeyResponseOnDelete
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the api key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] |
+| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
+| **livemode** | **Boolean** | Indicates if the api key is in production | [optional] |
+| **prefix** | **String** | The first few characters of the authentication_token | [optional] |
+| **id** | **String** | Unique identifier of the api key | [optional] |
+| **object** | **String** | Object name, value is 'api_key' | [optional] |
+| **deleted** | **Boolean** | Indicates if the api key was deleted | [optional] |
+| **role** | **String** | Indicates if the api key is private or public | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ApiKeyResponseOnDelete.new(
+  active: true,
+  created_at: 1684167881,
+  description: online store,
+  livemode: false,
+  prefix: key_rp,
+  id: 64625cc9f3e02c00163f5e4d,
+  object: api_key,
+  deleted: false,
+  role: private
+)
+```
+

data/docs/ApiKeyUpdateRequest.md

@@ -0,0 +1,20 @@
+# DigitalFemsa::ApiKeyUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional] |
+| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ApiKeyUpdateRequest.new(
+  active: true,
+  description: online store
+)
+```
+

data/docs/ApiKeysApi.md

@@ -0,0 +1,391 @@
+# DigitalFemsa::ApiKeysApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_api_key**](ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create Api Key |
+| [**delete_api_key**](ApiKeysApi.md#delete_api_key) | **DELETE** /api_keys/{id} | Delete Api Key |
+| [**get_api_key**](ApiKeysApi.md#get_api_key) | **GET** /api_keys/{id} | Get Api Key |
+| [**get_api_keys**](ApiKeysApi.md#get_api_keys) | **GET** /api_keys | Get list of Api Keys |
+| [**update_api_key**](ApiKeysApi.md#update_api_key) | **PUT** /api_keys/{id} | Update Api Key |
+
+
+## create_api_key
+
+> <ApiKeyCreateResponse> create_api_key(api_key_request, opts)
+
+Create Api Key
+
+Create a api key
+
+### 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::ApiKeysApi.new
+api_key_request = DigitalFemsa::ApiKeyRequest.new({role: 'private'}) # ApiKeyRequest | requested field for a api keys
+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
+  # Create Api Key
+  result = api_instance.create_api_key(api_key_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->create_api_key: #{e}"
+end
+```
+
+#### Using the create_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiKeyCreateResponse>, Integer, Hash)> create_api_key_with_http_info(api_key_request, opts)
+
+```ruby
+begin
+  # Create Api Key
+  data, status_code, headers = api_instance.create_api_key_with_http_info(api_key_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiKeyCreateResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->create_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_request** | [**ApiKeyRequest**](ApiKeyRequest.md) | requested field for a api keys |  |
+| **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
+
+[**ApiKeyCreateResponse**](ApiKeyCreateResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## delete_api_key
+
+> <DeleteApiKeysResponse> delete_api_key(id, opts)
+
+Delete Api Key
+
+Deletes a api key that corresponds to a api key ID
+
+### 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::ApiKeysApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es' # String | Use for knowing which language to use
+}
+
+begin
+  # Delete Api Key
+  result = api_instance.delete_api_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->delete_api_key: #{e}"
+end
+```
+
+#### Using the delete_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteApiKeysResponse>, Integer, Hash)> delete_api_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Delete Api Key
+  data, status_code, headers = api_instance.delete_api_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteApiKeysResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->delete_api_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 &#39;es&#39;] |
+
+### Return type
+
+[**DeleteApiKeysResponse**](DeleteApiKeysResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_api_key
+
+> <ApiKeyResponse> get_api_key(id, opts)
+
+Get Api Key
+
+Gets a api key that corresponds to a api key ID
+
+### 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::ApiKeysApi.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 Api Key
+  result = api_instance.get_api_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->get_api_key: #{e}"
+end
+```
+
+#### Using the get_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiKeyResponse>, Integer, Hash)> get_api_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Api Key
+  data, status_code, headers = api_instance.get_api_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiKeyResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->get_api_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 &#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
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_api_keys
+
+> <GetApiKeysResponse> get_api_keys(opts)
+
+Get list of Api Keys
+
+Consume the list of api keys you have
+
+### 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::ApiKeysApi.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
+  _next: '_next_example', # String | next page
+  previous: 'previous_example', # String | previous page
+  search: 'search_example' # String | General search, e.g. by id, description, prefix
+}
+
+begin
+  # Get list of Api Keys
+  result = api_instance.get_api_keys(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->get_api_keys: #{e}"
+end
+```
+
+#### Using the get_api_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApiKeysResponse>, Integer, Hash)> get_api_keys_with_http_info(opts)
+
+```ruby
+begin
+  # Get list of Api Keys
+  data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApiKeysResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->get_api_keys_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] |
+| **_next** | **String** | next page | [optional] |
+| **previous** | **String** | previous page | [optional] |
+| **search** | **String** | General search, e.g. by id, description, prefix | [optional] |
+
+### Return type
+
+[**GetApiKeysResponse**](GetApiKeysResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## update_api_key
+
+> <ApiKeyResponse> update_api_key(id, opts)
+
+Update Api Key
+
+Update an existing api key
+
+### 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::ApiKeysApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  api_key_update_request: DigitalFemsa::ApiKeyUpdateRequest.new # ApiKeyUpdateRequest | 
+}
+
+begin
+  # Update Api Key
+  result = api_instance.update_api_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->update_api_key: #{e}"
+end
+```
+
+#### Using the update_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApiKeyResponse>, Integer, Hash)> update_api_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update Api Key
+  data, status_code, headers = api_instance.update_api_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApiKeyResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ApiKeysApi->update_api_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 &#39;es&#39;] |
+| **api_key_update_request** | [**ApiKeyUpdateRequest**](ApiKeyUpdateRequest.md) |  | [optional] |
+
+### Return type
+
+[**ApiKeyResponse**](ApiKeyResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/BalanceCommonField.md

@@ -0,0 +1,20 @@
+# DigitalFemsa::BalanceCommonField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The balance's amount | [optional] |
+| **currency** | **String** | The balance's currency | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::BalanceCommonField.new(
+  amount: 100,
+  currency: MXN
+)
+```
+

data/docs/BalanceResponse.md

@@ -0,0 +1,36 @@
+# DigitalFemsa::BalanceResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's available | [optional] |
+| **cashout_retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's cashout retention amount | [optional] |
+| **conekta_retention** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's Femsa retention | [optional] |
+| **gateway** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's gateway | [optional] |
+| **pending** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's pending | [optional] |
+| **retained** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's retained | [optional] |
+| **retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's retention amount | [optional] |
+| **target_collateral_amount** | **Object** | The balance's target collateral amount | [optional] |
+| **target_retention_amount** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's target retention amount | [optional] |
+| **temporarily_retained** | [**Array<BalanceCommonField>**](BalanceCommonField.md) | The balance's temporarily retained | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::BalanceResponse.new(
+  available: null,
+  cashout_retention_amount: null,
+  conekta_retention: null,
+  gateway: null,
+  pending: null,
+  retained: null,
+  retention_amount: null,
+  target_collateral_amount: null,
+  target_retention_amount: null,
+  temporarily_retained: null
+)
+```
+

data/docs/BalancesApi.md

@@ -0,0 +1,79 @@
+# DigitalFemsa::BalancesApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_balance**](BalancesApi.md#get_balance) | **GET** /balance | Get a company's balance |
+
+
+## get_balance
+
+> <BalanceResponse> get_balance(opts)
+
+Get a company's balance
+
+Get a company's balance
+
+### 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::BalancesApi.new
+opts = {
+  accept_language: 'es' # String | Use for knowing which language to use
+}
+
+begin
+  # Get a company's balance
+  result = api_instance.get_balance(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling BalancesApi->get_balance: #{e}"
+end
+```
+
+#### Using the get_balance_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BalanceResponse>, Integer, Hash)> get_balance_with_http_info(opts)
+
+```ruby
+begin
+  # Get a company's balance
+  data, status_code, headers = api_instance.get_balance_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BalanceResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling BalancesApi->get_balance_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;] |
+
+### Return type
+
+[**BalanceResponse**](BalanceResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/ChargeOrderResponse.md

@@ -0,0 +1,52 @@
+# DigitalFemsa::ChargeOrderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] |
+| **created_at** | **Integer** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **customer_id** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **device_fingerprint** | **String** |  | [optional] |
+| **failure_code** | **String** |  | [optional] |
+| **failure_message** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **paid_at** | **Integer** |  | [optional] |
+| **payment_method** | [**ChargeOrderResponsePaymentMethod**](ChargeOrderResponsePaymentMethod.md) |  | [optional] |
+| **reference_id** | **String** | Reference ID of the charge | [optional] |
+| **refunds** | **Array<Object>** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeOrderResponse.new(
+  amount: 4321,
+  channel: null,
+  created_at: 1676386026,
+  currency: MXN,
+  customer_id: null,
+  description: Payment from order,
+  device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba,
+  failure_code: suspected_fraud,
+  failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
+  id: 63efa757cf65380001aec040,
+  livemode: true,
+  object: null,
+  order_id: ord_2tN73UdUSNrYRPD9r,
+  paid_at: 1676390742,
+  payment_method: null,
+  reference_id: ref_2tN73UdUSNrYRPD9r,
+  refunds: null,
+  status: pending_payment
+)
+```
+