conekta 2.5.0 → 6.0.0

data/docs/CheckoutOrderTemplate.md

@@ -0,0 +1,24 @@
+# Conekta::CheckoutOrderTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. |  |
+| **customer_info** | [**CheckoutOrderTemplateCustomerInfo**](CheckoutOrderTemplateCustomerInfo.md) |  | [optional] |
+| **line_items** | [**Array<Product>**](Product.md) | They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order. |  |
+| **metadata** | **Hash<String, Object>** | It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CheckoutOrderTemplate.new(
+  currency: MXN,
+  customer_info: null,
+  line_items: null,
+  metadata: {key=value}
+)
+```
+

data/docs/CheckoutOrderTemplateCustomerInfo.md

@@ -0,0 +1,49 @@
+# Conekta::CheckoutOrderTemplateCustomerInfo
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CheckoutOrderTemplateCustomerInfo.openapi_one_of
+# =>
+# [
+#   :'CustomerInfo',
+#   :'CustomerInfoJustCustomerId'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CheckoutOrderTemplateCustomerInfo.build(data)
+# => #<CustomerInfo:0x00007fdd4aab02a0>
+
+Conekta::CheckoutOrderTemplateCustomerInfo.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `CustomerInfo`
+- `CustomerInfoJustCustomerId`
+- `nil` (if no type matches)
+

data/docs/CheckoutRequest.md

@@ -0,0 +1,34 @@
+# Conekta::CheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link |  |
+| **expires_at** | **Integer** | Unix timestamp of checkout expiration | [optional] |
+| **failure_url** | **String** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] |
+| **monthly_installments_enabled** | **Boolean** |  | [optional] |
+| **monthly_installments_options** | **Array<Integer>** |  | [optional] |
+| **name** | **String** | Reason for payment | [optional] |
+| **on_demand_enabled** | **Boolean** |  | [optional] |
+| **success_url** | **String** | Redirection url back to the site in case of successful payment, applies only to HostedPayment | [optional] |
+| **type** | **String** | This field represents the type of checkout | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CheckoutRequest.new(
+  allowed_payment_methods: [cash, card, bank_transfer],
+  expires_at: null,
+  failure_url: null,
+  monthly_installments_enabled: false,
+  monthly_installments_options: [3, 6, 12],
+  name: null,
+  on_demand_enabled: true,
+  success_url: null,
+  type: Integration
+)
+```
+

data/docs/CheckoutResponse.md

@@ -0,0 +1,66 @@
+# Conekta::CheckoutResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_payment_methods** | **Array<String>** |  | [optional] |
+| **can_not_expire** | **Boolean** |  | [optional] |
+| **emails_sent** | **Integer** |  | [optional] |
+| **exclude_card_networks** | **Array<Object>** |  | [optional] |
+| **expires_at** | **Integer** |  | [optional] |
+| **failure_url** | **String** |  | [optional] |
+| **force_3ds_flow** | **Boolean** |  | [optional] |
+| **id** | **String** |  |  |
+| **livemode** | **Boolean** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **monthly_installments_enabled** | **Boolean** |  | [optional] |
+| **monthly_installments_options** | **Array<Integer>** |  | [optional] |
+| **name** | **String** | Reason for charge |  |
+| **needs_shipping_contact** | **Boolean** |  | [optional] |
+| **object** | **String** |  |  |
+| **paid_payments_count** | **Integer** |  | [optional] |
+| **payments_limit_count** | **Integer** |  | [optional] |
+| **recurrent** | **Boolean** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **sms_sent** | **Integer** |  | [optional] |
+| **starts_at** | **Integer** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **success_url** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CheckoutResponse.new(
+  allowed_payment_methods: [cash, card, bank_transfer],
+  can_not_expire: false,
+  emails_sent: 0,
+  exclude_card_networks: null,
+  expires_at: 1680397724,
+  failure_url: https://pay.conekta.com/failure,
+  force_3ds_flow: false,
+  id: b0bf16c4-18b9-445e-ba24-01604f329dbf,
+  livemode: true,
+  metadata: {key=value},
+  monthly_installments_enabled: false,
+  monthly_installments_options: [3, 6, 12],
+  name: Payment Link Name 1594138857,
+  needs_shipping_contact: false,
+  object: checkout,
+  paid_payments_count: 0,
+  payments_limit_count: 5,
+  recurrent: false,
+  slug: b0bf16c418b9445eba2401604f329dbf,
+  sms_sent: 0,
+  starts_at: 1677650400,
+  status: Issued,
+  success_url: https://pay.conekta.com/success,
+  type: PaymentLink,
+  url: https://pay.conekta.com/link/b0bf16c418b9445eba2401604f329dbf
+)
+```
+

data/docs/CheckoutsResponse.md

@@ -0,0 +1,26 @@
+# Conekta::CheckoutsResponse
+
+## 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<CheckoutResponse>**](CheckoutResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CheckoutsResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/CheckoutsResponseAllOf.md

@@ -0,0 +1,18 @@
+# Conekta::CheckoutsResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CheckoutResponse>**](CheckoutResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CheckoutsResponseAllOf.new(
+  data: null
+)
+```
+

data/docs/CompaniesApi.md

@@ -0,0 +1,159 @@
+# Conekta::CompaniesApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_companies**](CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies |
+| [**get_company**](CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company |
+
+
+## get_companies
+
+> <GetCompaniesResponse> get_companies(opts)
+
+Get List of Companies
+
+Consume the list of child companies.  This is used for holding companies with several child entities.
+
+### 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::CompaniesApi.new
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  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 Companies
+  result = api_instance.get_companies(opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CompaniesApi->get_companies: #{e}"
+end
+```
+
+#### Using the get_companies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCompaniesResponse>, Integer, Hash)> get_companies_with_http_info(opts)
+
+```ruby
+begin
+  # Get List of Companies
+  data, status_code, headers = api_instance.get_companies_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCompaniesResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CompaniesApi->get_companies_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;] |
+| **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
+
+[**GetCompaniesResponse**](GetCompaniesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## get_company
+
+> <CompanyResponse> get_company(id, opts)
+
+Get Company
+
+### 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::CompaniesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es' # String | Use for knowing which language to use
+}
+
+begin
+  # Get Company
+  result = api_instance.get_company(id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CompaniesApi->get_company: #{e}"
+end
+```
+
+#### Using the get_company_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CompanyResponse>, Integer, Hash)> get_company_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Company
+  data, status_code, headers = api_instance.get_company_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CompanyResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CompaniesApi->get_company_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
+
+[**CompanyResponse**](CompanyResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/CompanyFiscalInfoAddressResponse.md

@@ -0,0 +1,34 @@
+# Conekta::CompanyFiscalInfoAddressResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The resource's type | [optional] |
+| **street1** | **String** | Street Address | [optional] |
+| **street2** | **String** | Colonia | [optional] |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **country** | **String** | Country | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **external_number** | **String** | Street number | [optional] |
+| **internal_number** | **String** | Unit / apartment number | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CompanyFiscalInfoAddressResponse.new(
+  object: null,
+  street1: Calle 13,
+  street2: Navarte,
+  city: Cuauhtémoc,
+  state: Ciudad de México,
+  country: MX,
+  postal_code: 3072,
+  external_number: 123,
+  internal_number: 123
+)
+```
+

data/docs/CompanyFiscalInfoResponse.md

@@ -0,0 +1,30 @@
+# Conekta::CompanyFiscalInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The resource's type | [optional] |
+| **tax_id** | **String** | Tax ID of the company | [optional] |
+| **legal_entity_name** | **String** | Legal name of the company | [optional] |
+| **business_type** | **String** | Business type of the company | [optional] |
+| **phone** | **String** | Phone number of the company | [optional] |
+| **physical_person_business_type** | **String** | Business type if 'persona_fisica' | [optional] |
+| **address** | [**CompanyFiscalInfoAddressResponse**](CompanyFiscalInfoAddressResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CompanyFiscalInfoResponse.new(
+  object: null,
+  tax_id: XAXX010101000,
+  legal_entity_name: Child Company A,
+  business_type: persona_moral,
+  phone: 5555555555,
+  physical_person_business_type: null,
+  address: null
+)
+```
+

data/docs/CompanyPayoutDestinationResponse.md

@@ -0,0 +1,28 @@
+# Conekta::CompanyPayoutDestinationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The resource's type | [optional] |
+| **currency** | **String** | currency of the receiving account | [optional] |
+| **account_holder_name** | **String** | Name of the account holder | [optional] |
+| **bank** | **String** | Name of the bank | [optional] |
+| **type** | **String** | Type of the payout destination | [optional] |
+| **account_number** | **String** | Account number of the receiving account | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CompanyPayoutDestinationResponse.new(
+  object: null,
+  currency: MXN,
+  account_holder_name: Child Company A,
+  bank: BBVA,
+  type: null,
+  account_number: 123456789012345678
+)
+```
+

data/docs/CompanyResponse.md

@@ -0,0 +1,32 @@
+# Conekta::CompanyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The child company's unique identifier | [optional] |
+| **created_at** | **Integer** | The resource's creation date (unix timestamp) | [optional] |
+| **name** | **String** | The child company's name | [optional] |
+| **object** | **String** | The resource's type | [optional] |
+| **parent_company_id** | **String** | Id of the parent company | [optional] |
+| **use_parent_fiscal_data** | **Boolean** | Whether the parent company's fiscal data is to be used for liquidation and tax purposes | [optional] |
+| **payout_destination** | [**CompanyPayoutDestinationResponse**](CompanyPayoutDestinationResponse.md) |  | [optional] |
+| **fiscal_info** | [**CompanyFiscalInfoResponse**](CompanyFiscalInfoResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CompanyResponse.new(
+  id: 6441bb27659a060465da7335,
+  created_at: 1680397724,
+  name: Child Company A,
+  object: null,
+  parent_company_id: 6441bb3c62db5812e7920c31,
+  use_parent_fiscal_data: false,
+  payout_destination: null,
+  fiscal_info: null
+)
+```
+

data/docs/CreateCustomerFiscalEntitiesResponse.md

@@ -0,0 +1,38 @@
+# Conekta::CreateCustomerFiscalEntitiesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**CustomerFiscalEntitiesRequestAddress**](CustomerFiscalEntitiesRequestAddress.md) |  |  |
+| **tax_id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created_at** | **Integer** |  |  |
+| **parent_id** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CreateCustomerFiscalEntitiesResponse.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: conekta,
+  id: ship_cont_2tKZsTYcsryyu7Ah8,
+  object: shipping_contact,
+  created_at: 1675715413,
+  parent_id: cus_2tKcHxhTz7xU5SymF,
+  default: null
+)
+```
+

data/docs/CreateCustomerFiscalEntitiesResponseAllOf.md

@@ -0,0 +1,26 @@
+# Conekta::CreateCustomerFiscalEntitiesResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created_at** | **Integer** |  |  |
+| **parent_id** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CreateCustomerFiscalEntitiesResponseAllOf.new(
+  id: ship_cont_2tKZsTYcsryyu7Ah8,
+  object: shipping_contact,
+  created_at: 1675715413,
+  parent_id: cus_2tKcHxhTz7xU5SymF,
+  default: null
+)
+```
+

data/docs/CreateCustomerPaymentMethodsRequest.md

@@ -0,0 +1,51 @@
+# Conekta::CreateCustomerPaymentMethodsRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsRequest.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCardRequest',
+#   :'PaymentMethodCashRequest',
+#   :'PaymentMethodSpeiRequest'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsRequest.build(data)
+# => #<PaymentMethodCardRequest:0x00007fdd4aab02a0>
+
+Conekta::CreateCustomerPaymentMethodsRequest.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PaymentMethodCardRequest`
+- `PaymentMethodCashRequest`
+- `PaymentMethodSpeiRequest`
+- `nil` (if no type matches)
+