conekta 2.5.0 → 6.0.0

data/docs/TaxesApi.md

@@ -0,0 +1,243 @@
+# Conekta::TaxesApi
+
+All URIs are relative to *https://api.conekta.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 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::TaxesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+order_tax_request = Conekta::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 Conekta::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 Conekta::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.conekta-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 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::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 Conekta::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 Conekta::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.conekta-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 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::TaxesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+tax_id = 'tax_lin_2tQ974hSHcsdeSZHG' # String | identifier
+update_order_tax_request = Conekta::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 Conekta::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 Conekta::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.conekta-v2.1.0+json
+

data/docs/Token.md

@@ -0,0 +1,20 @@
+# Conekta::Token
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card** | [**TokenCard**](TokenCard.md) |  | [optional] |
+| **checkout** | [**TokenCheckout**](TokenCheckout.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::Token.new(
+  card: null,
+  checkout: null
+)
+```
+

data/docs/TokenCard.md

@@ -0,0 +1,28 @@
+# Conekta::TokenCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cvc** | **String** | It is a value that allows identifying the security code of the card. |  |
+| **device_fingerprint** | **String** | It is a value that allows identifying the device fingerprint. | [optional] |
+| **exp_month** | **String** | It is a value that allows identifying the expiration month of the card. |  |
+| **exp_year** | **String** | It is a value that allows identifying the expiration year of the card. |  |
+| **name** | **String** | It is a value that allows identifying the name of the cardholder. |  |
+| **number** | **String** | It is a value that allows identifying the number of the card. |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::TokenCard.new(
+  cvc: 123,
+  device_fingerprint: zptcxk4p6w1ijwz85snf1l3bqe5g09ie,
+  exp_month: 12,
+  exp_year: 26,
+  name: Miguel,
+  number: 4242424242424242
+)
+```
+

data/docs/TokenCheckout.md

@@ -0,0 +1,18 @@
+# Conekta::TokenCheckout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **returns_control_on** | **String** | It is a value that allows identifying the returns control on. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::TokenCheckout.new(
+  returns_control_on: Token
+)
+```
+

data/docs/TokenResponse.md

@@ -0,0 +1,26 @@
+# Conekta::TokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout** | [**TokenResponseCheckout**](TokenResponseCheckout.md) |  | [optional] |
+| **id** | **String** | Unique identifier for the token generated by Conekta. |  |
+| **livemode** | **Boolean** | Indicates whether the token is in live mode or test mode. |  |
+| **object** | **String** | Indicates the type of object, in this case token |  |
+| **used** | **Boolean** | Indicates if the token has been used |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::TokenResponse.new(
+  checkout: null,
+  id: cus_2tHJfJ79KyUwpxTik,
+  livemode: true,
+  object: token,
+  used: false
+)
+```
+

data/docs/TokenResponseCheckout.md

@@ -0,0 +1,62 @@
+# Conekta::TokenResponseCheckout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_payment_methods** | **Array<String>** |  | [optional] |
+| **can_not_expire** | **Boolean** | Indicates if the checkout can not expire. | [optional] |
+| **emails_sent** | **Integer** |  | [optional] |
+| **exclude_card_networks** | **Array<String>** |  | [optional] |
+| **expires_at** | **Integer** | Date and time when the checkout expires. | [optional] |
+| **failure_url** | **String** | URL to redirect the customer to if the payment process fails. | [optional] |
+| **force_3ds_flow** | **Boolean** | Indicates if the checkout forces the 3DS flow. | [optional] |
+| **id** | **String** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **monthly_installments_enabled** | **Boolean** | Indicates if the checkout allows monthly installments. | [optional] |
+| **monthly_installments_options** | **Array<Integer>** | List of monthly installments options. | [optional] |
+| **name** | **String** |  | [optional] |
+| **needs_shipping_contact** | **Boolean** |  | [optional] |
+| **object** | **String** | Indicates the type of object, in this case checkout. | [optional] |
+| **on_demand_enabled** | **Boolean** | Indicates if the checkout allows on demand payments. | [optional] |
+| **paid_payments_count** | **Integer** | Number of payments that have been paid. | [optional] |
+| **recurrent** | **Boolean** | Indicates if the checkout is recurrent. | [optional] |
+| **sms_sent** | **Integer** |  | [optional] |
+| **starts_at** | **Integer** | Date and time when the checkout starts. | [optional] |
+| **status** | **String** | Status of the checkout. | [optional] |
+| **success_url** | **String** | URL to redirect the customer to after the payment process is completed. | [optional] |
+| **type** | **String** | Type of checkout. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::TokenResponseCheckout.new(
+  allowed_payment_methods: null,
+  can_not_expire: false,
+  emails_sent: 0,
+  exclude_card_networks: null,
+  expires_at: 1675715413,
+  failure_url: https://example.com/failure,
+  force_3ds_flow: false,
+  id: 524f9d2f-8c2e-4e64-a33d-6006711a91bd,
+  livemode: true,
+  metadata: {key=value},
+  monthly_installments_enabled: false,
+  monthly_installments_options: null,
+  name: tok-2toNoPZpJgRU4PvgZ,
+  needs_shipping_contact: false,
+  object: checkout,
+  on_demand_enabled: false,
+  paid_payments_count: 0,
+  recurrent: false,
+  sms_sent: 0,
+  starts_at: 1675715413,
+  status: Issued,
+  success_url: https://example.com/success,
+  type: Integration
+)
+```
+

data/docs/TokensApi.md

@@ -0,0 +1,81 @@
+# Conekta::TokensApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_token**](TokensApi.md#create_token) | **POST** /tokens | Create Token |
+
+
+## create_token
+
+> <TokenResponse> create_token(token, opts)
+
+Create Token
+
+Generate a payment token, to associate it with a card 
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::TokensApi.new
+token = Conekta::Token.new # Token | requested field for token
+opts = {
+  accept_language: 'es' # String | Use for knowing which language to use
+}
+
+begin
+  # Create Token
+  result = api_instance.create_token(token, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling TokensApi->create_token: #{e}"
+end
+```
+
+#### Using the create_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenResponse>, Integer, Hash)> create_token_with_http_info(token, opts)
+
+```ruby
+begin
+  # Create Token
+  data, status_code, headers = api_instance.create_token_with_http_info(token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling TokensApi->create_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | [**Token**](Token.md) | requested field for token |  |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/TransactionResponse.md

@@ -0,0 +1,38 @@
+# Conekta::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 'conekta'
+
+instance = Conekta::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,165 @@
+# Conekta::TransactionsApi
+
+All URIs are relative to *https://api.conekta.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 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::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 Conekta::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 Conekta::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.conekta-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 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::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
+  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 transactions
+  result = api_instance.get_transactions(opts)
+  p result
+rescue Conekta::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 Conekta::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] |
+| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
+| **_next** | **String** | next page | [optional] |
+| **previous** | **String** | previous page | [optional] |
+
+### Return type
+
+[**GetTransactionsResponse**](GetTransactionsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+