conekta 2.5.0 → 6.0.0

data/docs/PaymentLinkApi.md

@@ -0,0 +1,463 @@
+# Conekta::PaymentLinkApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_checkout**](PaymentLinkApi.md#cancel_checkout) | **PUT** /checkouts/{id}/cancel | Cancel Payment Link |
+| [**create_checkout**](PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Unique Payment Link |
+| [**email_checkout**](PaymentLinkApi.md#email_checkout) | **POST** /checkouts/{id}/email | Send an email |
+| [**get_checkout**](PaymentLinkApi.md#get_checkout) | **GET** /checkouts/{id} | Get a payment link by ID |
+| [**get_checkouts**](PaymentLinkApi.md#get_checkouts) | **GET** /checkouts | Get a list of payment links |
+| [**sms_checkout**](PaymentLinkApi.md#sms_checkout) | **POST** /checkouts/{id}/sms | Send an sms |
+
+
+## cancel_checkout
+
+> <CheckoutResponse> cancel_checkout(id, opts)
+
+Cancel Payment Link
+
+### 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::PaymentLinkApi.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
+  # Cancel Payment Link
+  result = api_instance.cancel_checkout(id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->cancel_checkout: #{e}"
+end
+```
+
+#### Using the cancel_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutResponse>, Integer, Hash)> cancel_checkout_with_http_info(id, opts)
+
+```ruby
+begin
+  # Cancel Payment Link
+  data, status_code, headers = api_instance.cancel_checkout_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->cancel_checkout_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
+
+[**CheckoutResponse**](CheckoutResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## create_checkout
+
+> <CheckoutResponse> create_checkout(checkout, opts)
+
+Create Unique Payment Link
+
+### 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::PaymentLinkApi.new
+checkout = Conekta::Checkout.new({allowed_payment_methods: [cash,  card,  bank_transfer], expires_at: 1680397724, name: 'Payment Link Name 1594138857', order_template: Conekta::CheckoutOrderTemplate.new({currency: 'MXN', line_items: [Conekta::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000})]}), recurrent: false, type: 'PaymentLink'}) # Checkout | requested field for checkout
+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 Unique Payment Link
+  result = api_instance.create_checkout(checkout, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->create_checkout: #{e}"
+end
+```
+
+#### Using the create_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutResponse>, Integer, Hash)> create_checkout_with_http_info(checkout, opts)
+
+```ruby
+begin
+  # Create Unique Payment Link
+  data, status_code, headers = api_instance.create_checkout_with_http_info(checkout, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->create_checkout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout** | [**Checkout**](Checkout.md) | requested field for checkout |  |
+| **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
+
+[**CheckoutResponse**](CheckoutResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## email_checkout
+
+> <CheckoutResponse> email_checkout(id, email_checkout_request, opts)
+
+Send an email
+
+### 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::PaymentLinkApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+email_checkout_request = Conekta::EmailCheckoutRequest.new({email: 'example@conekta.com'}) # EmailCheckoutRequest | requested field for sms checkout
+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
+  # Send an email
+  result = api_instance.email_checkout(id, email_checkout_request, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->email_checkout: #{e}"
+end
+```
+
+#### Using the email_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutResponse>, Integer, Hash)> email_checkout_with_http_info(id, email_checkout_request, opts)
+
+```ruby
+begin
+  # Send an email
+  data, status_code, headers = api_instance.email_checkout_with_http_info(id, email_checkout_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->email_checkout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **email_checkout_request** | [**EmailCheckoutRequest**](EmailCheckoutRequest.md) | requested field for sms checkout |  |
+| **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
+
+[**CheckoutResponse**](CheckoutResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## get_checkout
+
+> <CheckoutResponse> get_checkout(id, opts)
+
+Get a payment link by ID
+
+### 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::PaymentLinkApi.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 a payment link by ID
+  result = api_instance.get_checkout(id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->get_checkout: #{e}"
+end
+```
+
+#### Using the get_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutResponse>, Integer, Hash)> get_checkout_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get a payment link by ID
+  data, status_code, headers = api_instance.get_checkout_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->get_checkout_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
+
+[**CheckoutResponse**](CheckoutResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## get_checkouts
+
+> <CheckoutsResponse> get_checkouts(opts)
+
+Get a list of payment links
+
+Returns a list of links generated by the merchant
+
+### 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::PaymentLinkApi.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 a list of payment links
+  result = api_instance.get_checkouts(opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->get_checkouts: #{e}"
+end
+```
+
+#### Using the get_checkouts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutsResponse>, Integer, Hash)> get_checkouts_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of payment links
+  data, status_code, headers = api_instance.get_checkouts_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutsResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->get_checkouts_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
+
+[**CheckoutsResponse**](CheckoutsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## sms_checkout
+
+> <CheckoutResponse> sms_checkout(id, sms_checkout_request, opts)
+
+Send an sms
+
+### 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::PaymentLinkApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+sms_checkout_request = Conekta::SmsCheckoutRequest.new({phonenumber: '5566982090'}) # SmsCheckoutRequest | requested field for sms checkout
+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
+  # Send an sms
+  result = api_instance.sms_checkout(id, sms_checkout_request, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->sms_checkout: #{e}"
+end
+```
+
+#### Using the sms_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckoutResponse>, Integer, Hash)> sms_checkout_with_http_info(id, sms_checkout_request, opts)
+
+```ruby
+begin
+  # Send an sms
+  data, status_code, headers = api_instance.sms_checkout_with_http_info(id, sms_checkout_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckoutResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling PaymentLinkApi->sms_checkout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **sms_checkout_request** | [**SmsCheckoutRequest**](SmsCheckoutRequest.md) | requested field for sms checkout |  |
+| **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
+
+[**CheckoutResponse**](CheckoutResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/PaymentMethod.md

@@ -0,0 +1,20 @@
+# Conekta::PaymentMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethod.new(
+  type: null,
+  object: payment_source
+)
+```
+

data/docs/PaymentMethodBankTransfer.md

@@ -0,0 +1,52 @@
+# Conekta::PaymentMethodBankTransfer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **object** | **String** |  |  |
+| **bank** | **String** |  | [optional] |
+| **clabe** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **executed_at** | **Integer** |  | [optional] |
+| **expires_at** | **Integer** |  | [optional] |
+| **issuing_account_bank** | **String** |  | [optional] |
+| **issuing_account_number** | **String** |  | [optional] |
+| **issuing_account_holder_name** | **String** |  | [optional] |
+| **issuing_account_tax_id** | **String** |  | [optional] |
+| **payment_attempts** | **Array<Object>** |  | [optional] |
+| **receiving_account_holder_name** | **String** |  | [optional] |
+| **receiving_account_number** | **String** |  | [optional] |
+| **receiving_account_bank** | **String** |  | [optional] |
+| **receiving_account_tax_id** | **String** |  | [optional] |
+| **reference_number** | **String** |  | [optional] |
+| **tracking_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodBankTransfer.new(
+  type: null,
+  object: payment_source,
+  bank: STP,
+  clabe: 646180111805034237,
+  description: null,
+  executed_at: null,
+  expires_at: 1683053729,
+  issuing_account_bank: null,
+  issuing_account_number: null,
+  issuing_account_holder_name: null,
+  issuing_account_tax_id: null,
+  payment_attempts: null,
+  receiving_account_holder_name: null,
+  receiving_account_number: 646180111805034237,
+  receiving_account_bank: STP,
+  receiving_account_tax_id: null,
+  reference_number: null,
+  tracking_code: null
+)
+```
+

data/docs/PaymentMethodCard.md

@@ -0,0 +1,42 @@
+# Conekta::PaymentMethodCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **object** | **String** |  |  |
+| **account_type** | **String** |  | [optional] |
+| **auth_code** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **contract_id** | **String** | Id sent for recurrent charges. | [optional] |
+| **country** | **String** |  | [optional] |
+| **exp_month** | **String** |  | [optional] |
+| **exp_year** | **String** |  | [optional] |
+| **fraud_indicators** | **Array<Object>** |  | [optional] |
+| **issuer** | **String** |  | [optional] |
+| **last4** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodCard.new(
+  type: null,
+  object: payment_source,
+  account_type: Credit,
+  auth_code: 867372,
+  brand: visa,
+  contract_id: S781317595,
+  country: MX,
+  exp_month: 02,
+  exp_year: 30,
+  fraud_indicators: null,
+  issuer: BANAMEX,
+  last4: 4242,
+  name: Fulanito Perez
+)
+```
+

data/docs/PaymentMethodCardRequest.md

@@ -0,0 +1,20 @@
+# Conekta::PaymentMethodCardRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of payment method |  |
+| **token_id** | **String** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.1.0/reference/createsubscription] tutorial for more information on how to tokenize cards. |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodCardRequest.new(
+  type: card | cash | spei,
+  token_id: tok_32hj4g234as
+)
+```
+

data/docs/PaymentMethodCardRequestAllOf.md

@@ -0,0 +1,18 @@
+# Conekta::PaymentMethodCardRequestAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token_id** | **String** | Token id that will be used to create a \"card\" type payment method. See the (subscriptions)[https://developers.conekta.com/v2.1.0/reference/createsubscription] tutorial for more information on how to tokenize cards. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodCardRequestAllOf.new(
+  token_id: tok_32hj4g234as
+)
+```
+

data/docs/PaymentMethodCardResponse.md

@@ -0,0 +1,46 @@
+# Conekta::PaymentMethodCardResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created_at** | **Integer** |  |  |
+| **parent_id** | **String** |  | [optional] |
+| **last4** | **String** |  | [optional] |
+| **bin** | **String** |  | [optional] |
+| **card_type** | **String** |  | [optional] |
+| **exp_month** | **String** |  | [optional] |
+| **exp_year** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **visible_on_checkout** | **Boolean** |  | [optional] |
+| **payment_source_status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodCardResponse.new(
+  type: null,
+  id: src_2s8K1B3PBKDontpi9,
+  object: payment_source,
+  created_at: 1675715413,
+  parent_id: cus_2s8K1B3PBKDontpi8,
+  last4: 6410,
+  bin: 40276657,
+  card_type: debit,
+  exp_month: 10,
+  exp_year: 25,
+  brand: visa,
+  name: Fulano Perez",
+  default: null,
+  visible_on_checkout: null,
+  payment_source_status: active
+)
+```
+

data/docs/PaymentMethodCardResponseAllOf.md

@@ -0,0 +1,36 @@
+# Conekta::PaymentMethodCardResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **last4** | **String** |  | [optional] |
+| **bin** | **String** |  | [optional] |
+| **card_type** | **String** |  | [optional] |
+| **exp_month** | **String** |  | [optional] |
+| **exp_year** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **visible_on_checkout** | **Boolean** |  | [optional] |
+| **payment_source_status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::PaymentMethodCardResponseAllOf.new(
+  last4: 6410,
+  bin: 40276657,
+  card_type: debit,
+  exp_month: 10,
+  exp_year: 25,
+  brand: visa,
+  name: Fulano Perez",
+  default: null,
+  visible_on_checkout: null,
+  payment_source_status: active
+)
+```
+