conekta 2.5.0 → 6.0.0

data/docs/CreateCustomerPaymentMethodsResponse.md

@@ -0,0 +1,83 @@
+# Conekta::CreateCustomerPaymentMethodsResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsResponse.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCardResponse',
+#   :'PaymentMethodCashResponse',
+#   :'PaymentMethodSpeiRecurrent'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsResponse.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsResponse.openapi_discriminator_mapping
+# =>
+# {
+#   :'card' => :'PaymentMethodCardResponse',
+#   :'cash' => :'PaymentMethodCashResponse',
+#   :'oxxo_recurrent' => :'PaymentMethodCashResponse',
+#   :'spei_recurrent' => :'PaymentMethodSpeiRecurrent'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CreateCustomerPaymentMethodsResponse.build(data)
+# => #<PaymentMethodCardResponse:0x00007fdd4aab02a0>
+
+Conekta::CreateCustomerPaymentMethodsResponse.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PaymentMethodCardResponse`
+- `PaymentMethodCashResponse`
+- `PaymentMethodSpeiRecurrent`
+- `nil` (if no type matches)
+

data/docs/CreateRiskRulesData.md

@@ -0,0 +1,22 @@
+# Conekta::CreateRiskRulesData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the rule |  |
+| **field** | **String** | Field to be used for the rule |  |
+| **value** | **String** | Value to be used for the rule |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CreateRiskRulesData.new(
+  description: this client email was verified at 20/09/22 by internal process,
+  field: email | phone | card_token,
+  value: email@example.com | 818081808180 | src_2qUCNd5AyQqfPMBuV
+)
+```
+

data/docs/Customer.md

@@ -0,0 +1,44 @@
+# Conekta::Customer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **antifraud_info** | [**CustomerAntifraudInfo**](CustomerAntifraudInfo.md) |  | [optional] |
+| **corporate** | **Boolean** | It is a value that allows identifying if the email is corporate or not. | [optional][default to false] |
+| **custom_reference** | **String** | It is an undefined value. | [optional] |
+| **email** | **String** | An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). |  |
+| **default_payment_source_id** | **String** | It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) | [optional] |
+| **default_shipping_contact_id** | **String** | It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) | [optional] |
+| **fiscal_entities** | [**Array<CustomerFiscalEntitiesRequest>**](CustomerFiscalEntitiesRequest.md) |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **name** | **String** | Client's name |  |
+| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Conekta | [optional] |
+| **phone** | **String** | Is the customer's phone number |  |
+| **plan_id** | **String** | Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription | [optional] |
+| **shipping_contacts** | [**Array<CustomerShippingContacts>**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Conekta | [optional] |
+| **subscription** | [**SubscriptionRequest**](SubscriptionRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::Customer.new(
+  antifraud_info: null,
+  corporate: false,
+  custom_reference: null,
+  email: miguel@gmail.com,
+  default_payment_source_id: src_1a2b3c4d5e6f7g8h,
+  default_shipping_contact_id: ship_cont_1a2b3c4d5e6f7g8h,
+  fiscal_entities: null,
+  metadata: null,
+  name: miguel,
+  payment_sources: null,
+  phone: +5215555555555,
+  plan_id: plan_987234823,
+  shipping_contacts: null,
+  subscription: null
+)
+```
+

data/docs/CustomerAddress.md

@@ -0,0 +1,32 @@
+# Conekta::CustomerAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street1** | **String** |  |  |
+| **street2** | **String** |  | [optional] |
+| **postal_code** | **String** |  |  |
+| **city** | **String** |  |  |
+| **state** | **String** |  | [optional] |
+| **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] |
+| **residential** | **Boolean** |  | [optional] |
+| **external_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerAddress.new(
+  street1: avenida siempre viva,
+  street2: fake street,
+  postal_code: 06100,
+  city: Ciudad de Mexico,
+  state: Ciudad de Mexico,
+  country: MX,
+  residential: true,
+  external_number: null
+)
+```
+

data/docs/CustomerAntifraudInfo.md

@@ -0,0 +1,20 @@
+# Conekta::CustomerAntifraudInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_created_at** | **Integer** |  | [optional] |
+| **first_paid_at** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerAntifraudInfo.new(
+  account_created_at: 1484040996,
+  first_paid_at: 1485151007
+)
+```
+

data/docs/CustomerAntifraudInfoResponse.md

@@ -0,0 +1,20 @@
+# Conekta::CustomerAntifraudInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_paid_at** | **Integer** |  | [optional] |
+| **account_created_at** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerAntifraudInfoResponse.new(
+  first_paid_at: 1485151007,
+  account_created_at: 1484040996
+)
+```
+

data/docs/CustomerFiscalEntitiesDataResponse.md

@@ -0,0 +1,38 @@
+# Conekta::CustomerFiscalEntitiesDataResponse
+
+## 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::CustomerFiscalEntitiesDataResponse.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/CustomerFiscalEntitiesRequest.md

@@ -0,0 +1,28 @@
+# Conekta::CustomerFiscalEntitiesRequest
+
+## 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] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerFiscalEntitiesRequest.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: conekta
+)
+```
+

data/docs/CustomerFiscalEntitiesRequestAddress.md

@@ -0,0 +1,32 @@
+# Conekta::CustomerFiscalEntitiesRequestAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street1** | **String** |  |  |
+| **street2** | **String** |  | [optional] |
+| **postal_code** | **String** |  |  |
+| **city** | **String** |  |  |
+| **state** | **String** |  | [optional] |
+| **country** | **String** | this field follows the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] |
+| **residential** | **Boolean** |  | [optional] |
+| **external_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerFiscalEntitiesRequestAddress.new(
+  street1: avenida siempre viva,
+  street2: fake street,
+  postal_code: 06100,
+  city: Ciudad de Mexico,
+  state: Ciudad de Mexico,
+  country: MX,
+  residential: true,
+  external_number: null
+)
+```
+

data/docs/CustomerFiscalEntitiesResponse.md

@@ -0,0 +1,22 @@
+# Conekta::CustomerFiscalEntitiesResponse
+
+## 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 |  |
+| **data** | [**Array<CustomerFiscalEntitiesDataResponse>**](CustomerFiscalEntitiesDataResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerFiscalEntitiesResponse.new(
+  has_more: false,
+  object: list,
+  data: null
+)
+```
+

data/docs/CustomerFiscalEntitiesResponseAllOf.md

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

data/docs/CustomerInfo.md

@@ -0,0 +1,26 @@
+# Conekta::CustomerInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **phone** | **String** |  |  |
+| **corporate** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerInfo.new(
+  name: DevTest,
+  email: test@conekta.com,
+  phone: 5522997233,
+  corporate: null,
+  object: customer_info
+)
+```
+

data/docs/CustomerInfoJustCustomerId.md

@@ -0,0 +1,18 @@
+# Conekta::CustomerInfoJustCustomerId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerInfoJustCustomerId.new(
+  customer_id: cus_23874283647
+)
+```
+

data/docs/CustomerInfoJustCustomerIdResponse.md

@@ -0,0 +1,18 @@
+# Conekta::CustomerInfoJustCustomerIdResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerInfoJustCustomerIdResponse.new(
+  customer_id: cus_23874283647
+)
+```
+

data/docs/CustomerInfoResponse.md

@@ -0,0 +1,26 @@
+# Conekta::CustomerInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **corporate** | **Boolean** |  | [optional][default to false] |
+| **object** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerInfoResponse.new(
+  name: DevTest,
+  email: test@conekta.com,
+  phone: 5522997233,
+  corporate: null,
+  object: customer_info
+)
+```
+

data/docs/CustomerPaymentMethodRequest.md

@@ -0,0 +1,18 @@
+# Conekta::CustomerPaymentMethodRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of payment method |  |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerPaymentMethodRequest.new(
+  type: card | cash | spei
+)
+```
+

data/docs/CustomerPaymentMethods.md

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

data/docs/CustomerPaymentMethodsData.md

@@ -0,0 +1,83 @@
+# Conekta::CustomerPaymentMethodsData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CustomerPaymentMethodsData.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCardResponse',
+#   :'PaymentMethodCashResponse',
+#   :'PaymentMethodSpeiRecurrent'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CustomerPaymentMethodsData.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CustomerPaymentMethodsData.openapi_discriminator_mapping
+# =>
+# {
+#   :'card' => :'PaymentMethodCardResponse',
+#   :'cash' => :'PaymentMethodCashResponse',
+#   :'oxxo_recurrent' => :'PaymentMethodCashResponse',
+#   :'spei_recurrent' => :'PaymentMethodSpeiRecurrent'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CustomerPaymentMethodsData.build(data)
+# => #<PaymentMethodCardResponse:0x00007fdd4aab02a0>
+
+Conekta::CustomerPaymentMethodsData.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PaymentMethodCardResponse`
+- `PaymentMethodCashResponse`
+- `PaymentMethodSpeiRecurrent`
+- `nil` (if no type matches)
+

data/docs/CustomerPaymentMethodsRequest.md

@@ -0,0 +1,51 @@
+# Conekta::CustomerPaymentMethodsRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'conekta'
+
+Conekta::CustomerPaymentMethodsRequest.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::CustomerPaymentMethodsRequest.build(data)
+# => #<PaymentMethodCardRequest:0x00007fdd4aab02a0>
+
+Conekta::CustomerPaymentMethodsRequest.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)
+

data/docs/CustomerPaymentMethodsResponse.md

@@ -0,0 +1,26 @@
+# Conekta::CustomerPaymentMethodsResponse
+
+## 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<CustomerPaymentMethodsData>**](CustomerPaymentMethodsData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomerPaymentMethodsResponse.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
+)
+```
+