digital_femsa 1.0.0

data/docs/TaxesApi.md

@@ -0,0 +1,243 @@
+# DigitalFemsa::TaxesApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**orders_create_taxes**](TaxesApi.md#orders_create_taxes) | **POST** /orders/{id}/tax_lines | Create Tax |
+| [**orders_delete_taxes**](TaxesApi.md#orders_delete_taxes) | **DELETE** /orders/{id}/tax_lines/{tax_id} | Delete Tax |
+| [**orders_update_taxes**](TaxesApi.md#orders_update_taxes) | **PUT** /orders/{id}/tax_lines/{tax_id} | Update Tax |
+
+
+## orders_create_taxes
+
+> <UpdateOrderTaxResponse> orders_create_taxes(id, order_tax_request, opts)
+
+Create Tax
+
+Create new taxes for an existing orden
+
+### 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::TaxesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+order_tax_request = DigitalFemsa::OrderTaxRequest.new({amount: 100, description: 'testing'}) # OrderTaxRequest | requested field for a taxes
+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 Tax
+  result = api_instance.orders_create_taxes(id, order_tax_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_create_taxes: #{e}"
+end
+```
+
+#### Using the orders_create_taxes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateOrderTaxResponse>, Integer, Hash)> orders_create_taxes_with_http_info(id, order_tax_request, opts)
+
+```ruby
+begin
+  # Create Tax
+  data, status_code, headers = api_instance.orders_create_taxes_with_http_info(id, order_tax_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateOrderTaxResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_create_taxes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **order_tax_request** | [**OrderTaxRequest**](OrderTaxRequest.md) | requested field for a taxes |  |
+| **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
+
+[**UpdateOrderTaxResponse**](UpdateOrderTaxResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## orders_delete_taxes
+
+> <UpdateOrderTaxResponse> orders_delete_taxes(id, tax_id, opts)
+
+Delete Tax
+
+Delete taxes for an existing orden
+
+### 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::TaxesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+tax_id = 'tax_lin_2tQ974hSHcsdeSZHG' # String | identifier
+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
+  # Delete Tax
+  result = api_instance.orders_delete_taxes(id, tax_id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_delete_taxes: #{e}"
+end
+```
+
+#### Using the orders_delete_taxes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateOrderTaxResponse>, Integer, Hash)> orders_delete_taxes_with_http_info(id, tax_id, opts)
+
+```ruby
+begin
+  # Delete Tax
+  data, status_code, headers = api_instance.orders_delete_taxes_with_http_info(id, tax_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateOrderTaxResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_delete_taxes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **tax_id** | **String** | identifier |  |
+| **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
+
+[**UpdateOrderTaxResponse**](UpdateOrderTaxResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## orders_update_taxes
+
+> <UpdateOrderTaxResponse> orders_update_taxes(id, tax_id, update_order_tax_request, opts)
+
+Update Tax
+
+Update taxes for an existing orden
+
+### 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::TaxesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+tax_id = 'tax_lin_2tQ974hSHcsdeSZHG' # String | identifier
+update_order_tax_request = DigitalFemsa::UpdateOrderTaxRequest.new # UpdateOrderTaxRequest | requested field for taxes
+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
+  # Update Tax
+  result = api_instance.orders_update_taxes(id, tax_id, update_order_tax_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_update_taxes: #{e}"
+end
+```
+
+#### Using the orders_update_taxes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateOrderTaxResponse>, Integer, Hash)> orders_update_taxes_with_http_info(id, tax_id, update_order_tax_request, opts)
+
+```ruby
+begin
+  # Update Tax
+  data, status_code, headers = api_instance.orders_update_taxes_with_http_info(id, tax_id, update_order_tax_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateOrderTaxResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TaxesApi->orders_update_taxes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **tax_id** | **String** | identifier |  |
+| **update_order_tax_request** | [**UpdateOrderTaxRequest**](UpdateOrderTaxRequest.md) | requested field for taxes |  |
+| **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
+
+[**UpdateOrderTaxResponse**](UpdateOrderTaxResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/TransactionResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::TransactionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount of the transaction. |  |
+| **charge** | **String** | Randomly assigned unique order identifier associated with the charge. |  |
+| **created_at** | **Integer** | Date and time of creation of the transaction in Unix format. |  |
+| **currency** | **String** | The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) |  |
+| **fee** | **Integer** | The amount to be deducted for taxes and commissions. |  |
+| **id** | **String** | Unique identifier of the transaction. |  |
+| **livemode** | **Boolean** | Indicates whether the transaction was created in live mode or test mode. |  |
+| **net** | **Integer** | The net amount after deducting commissions and taxes. |  |
+| **object** | **String** | Object name, which is transaction. |  |
+| **status** | **String** | Code indicating transaction status. |  |
+| **type** | **String** | Transaction Type |  |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::TransactionResponse.new(
+  amount: 1000,
+  charge: 5ee7ec58885a45585e6d9f8m,
+  created_at: 1553273553,
+  currency: MXN,
+  fee: 560,
+  id: 5ee7ec5b8dea41085erb7f9e,
+  livemode: true,
+  net: 440,
+  object: transaction,
+  status: pending,
+  type: capture
+)
+```
+

data/docs/TransactionsApi.md

@@ -0,0 +1,171 @@
+# DigitalFemsa::TransactionsApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /transactions/{id} | Get transaction |
+| [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /transactions | Get List transactions |
+
+
+## get_transaction
+
+> <TransactionResponse> get_transaction(id, opts)
+
+Get transaction
+
+Get the details of a transaction
+
+### 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::TransactionsApi.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 transaction
+  result = api_instance.get_transaction(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction: #{e}"
+end
+```
+
+#### Using the get_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionResponse>, Integer, Hash)> get_transaction_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get transaction
+  data, status_code, headers = api_instance.get_transaction_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction_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
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_transactions
+
+> <GetTransactionsResponse> get_transactions(opts)
+
+Get List transactions
+
+Get transaction details in the form of a list
+
+### 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::TransactionsApi.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
+  id: '65412a893cd69a0001c25892', # String | id of the object to be retrieved
+  charge_id: '65412a893cd69a0001c25892', # String | id of the charge used for filtering
+  type: 'capture', # String | type of the object to be retrieved
+  currency: 'MXN' # String | currency of the object to be retrieved
+}
+
+begin
+  # Get List transactions
+  result = api_instance.get_transactions(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransactionsApi->get_transactions: #{e}"
+end
+```
+
+#### Using the get_transactions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTransactionsResponse>, Integer, Hash)> get_transactions_with_http_info(opts)
+
+```ruby
+begin
+  # Get List transactions
+  data, status_code, headers = api_instance.get_transactions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTransactionsResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransactionsApi->get_transactions_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] |
+| **id** | **String** | id of the object to be retrieved | [optional] |
+| **charge_id** | **String** | id of the charge used for filtering | [optional] |
+| **type** | **String** | type of the object to be retrieved | [optional] |
+| **currency** | **String** | currency of the object to be retrieved | [optional] |
+
+### Return type
+
+[**GetTransactionsResponse**](GetTransactionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/TransferDestinationResponse.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::TransferDestinationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_holder** | **String** | Name of the account holder. | [optional] |
+| **account_number** | **String** | Account number of the bank account. | [optional] |
+| **bank** | **String** | Name of the bank. | [optional] |
+| **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] |
+| **id** | **String** | Unique identifier of the transfer. | [optional] |
+| **object** | **String** | Object name, which is bank_transfer_payout_method. | [optional] |
+| **payee_id** | **String** | Unique identifier of the payee. | [optional] |
+| **type** | **String** | Type of the payee. | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::TransferDestinationResponse.new(
+  account_holder: John Doe,
+  account_number: 012180023547896764,
+  bank: BBVA Bancomer,
+  created_at: 1553273553,
+  id: pytmtd_2ide3qwTdDvNBosEC,
+  object: bank_transfer_payout_method,
+  payee_id: payee_2icdDewRxDENBos85,
+  type: BankTransferPayoutMethod
+)
+```
+

data/docs/TransferMethodResponse.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::TransferMethodResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_holder** | **String** | Name of the account holder. | [optional] |
+| **account_number** | **String** | Account number of the bank account. | [optional] |
+| **bank** | **String** | Name of the bank. | [optional] |
+| **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] |
+| **id** | **String** | Unique identifier of the transfer. | [optional] |
+| **object** | **String** | Object name, which is bank_transfer_payout_method. | [optional] |
+| **payee_id** | **String** | Unique identifier of the payee. | [optional] |
+| **type** | **String** | Type of the payee. | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::TransferMethodResponse.new(
+  account_holder: John Doe,
+  account_number: 012180023547896764,
+  bank: BBVA Bancomer,
+  created_at: 1553273553,
+  id: pytmtd_2ide3qwTdDvNBosEC,
+  object: bank_transfer_payout_method,
+  payee_id: payee_2icdDewRxDENBos85,
+  type: BankTransferPayoutMethod
+)
+```
+

data/docs/TransferResponse.md

@@ -0,0 +1,36 @@
+# DigitalFemsa::TransferResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Amount in cents of the transfer. | [optional] |
+| **created_at** | **Integer** | Date and time of creation of the transfer in Unix format. | [optional] |
+| **currency** | **String** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] |
+| **id** | **String** | Unique identifier of the transfer. | [optional] |
+| **livemode** | **Boolean** | Indicates whether the transfer was created in live mode or test mode. | [optional] |
+| **destination** | [**TransferDestinationResponse**](TransferDestinationResponse.md) |  | [optional] |
+| **object** | **String** | Object name, which is transfer. | [optional] |
+| **statement_description** | **String** | Description of the transfer. | [optional] |
+| **statement_reference** | **String** | Reference number of the transfer. | [optional] |
+| **status** | **String** | Code indicating transfer status. | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::TransferResponse.new(
+  amount: 10000,
+  created_at: 1553273553,
+  currency: MXN,
+  id: 5b0337d4dD344ef954fe1X4b6,
+  livemode: true,
+  destination: null,
+  object: transfer,
+  statement_description: Femsa 4401234,
+  statement_reference: 4401234,
+  status: pending
+)
+```
+