digital_femsa 1.0.0

data/docs/CustomerAddress.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::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][default to false] |
+| **external_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerAddress.new(
+  street1: Nuevo Leon 254,
+  street2: Departamento 404,
+  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 @@
+# DigitalFemsa::CustomerAntifraudInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_created_at** | **Integer** |  | [optional] |
+| **first_paid_at** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerAntifraudInfo.new(
+  account_created_at: 1484040996,
+  first_paid_at: 1485151007
+)
+```
+

data/docs/CustomerAntifraudInfoResponse.md

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

data/docs/CustomerFiscalEntitiesDataResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::CustomerFiscalEntitiesDataResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**CustomerAddress**](CustomerAddress.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 'digital_femsa'
+
+instance = DigitalFemsa::CustomerFiscalEntitiesDataResponse.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: Femsa,
+  id: ship_cont_2tKZsTYcsryyu7Ah8,
+  object: shipping_contact,
+  created_at: 1675715413,
+  parent_id: cus_2tKcHxhTz7xU5SymF,
+  default: null
+)
+```
+

data/docs/CustomerFiscalEntitiesRequest.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::CustomerFiscalEntitiesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**CustomerAddress**](CustomerAddress.md) |  |  |
+| **tax_id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerFiscalEntitiesRequest.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: Femsa
+)
+```
+

data/docs/CustomerFiscalEntitiesResponse.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::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 'digital_femsa'
+
+instance = DigitalFemsa::CustomerFiscalEntitiesResponse.new(
+  has_more: false,
+  object: list,
+  data: null
+)
+```
+

data/docs/CustomerInfo.md

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

data/docs/CustomerInfoJustCustomerId.md

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

data/docs/CustomerInfoJustCustomerIdResponse.md

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

data/docs/CustomerPaymentMethodRequest.md

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

data/docs/CustomerPaymentMethodsData.md

@@ -0,0 +1,77 @@
+# DigitalFemsa::CustomerPaymentMethodsData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsData.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCashResponse'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsData.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsData.openapi_discriminator_mapping
+# =>
+# {
+#   :'cash' => :'PaymentMethodCashResponse',
+#   :'oxxo_recurrent' => :'PaymentMethodCashResponse'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsData.build(data)
+# => #<PaymentMethodCashResponse:0x00007fdd4aab02a0>
+
+DigitalFemsa::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
+
+- `PaymentMethodCashResponse`
+- `nil` (if no type matches)
+

data/docs/CustomerPaymentMethodsRequest.md

@@ -0,0 +1,47 @@
+# DigitalFemsa::CustomerPaymentMethodsRequest
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsRequest.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCashRequest'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::CustomerPaymentMethodsRequest.build(data)
+# => #<PaymentMethodCashRequest:0x00007fdd4aab02a0>
+
+DigitalFemsa::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
+
+- `PaymentMethodCashRequest`
+- `nil` (if no type matches)
+

data/docs/CustomerPaymentMethodsResponse.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::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 'digital_femsa'
+
+instance = DigitalFemsa::CustomerPaymentMethodsResponse.new(
+  has_more: false,
+  object: list,
+  next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
+  data: null
+)
+```
+

data/docs/CustomerResponse.md

@@ -0,0 +1,50 @@
+# DigitalFemsa::CustomerResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **antifraud_info** | [**CustomerAntifraudInfoResponse**](CustomerAntifraudInfoResponse.md) |  | [optional] |
+| **corporate** | **Boolean** | true if the customer is a company | [optional] |
+| **created_at** | **Integer** | Creation date of the object |  |
+| **custom_reference** | **String** | Custom reference | [optional] |
+| **default_fiscal_entity_id** | **String** |  | [optional] |
+| **default_shipping_contact_id** | **String** |  | [optional] |
+| **default_payment_source_id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **fiscal_entities** | [**CustomerFiscalEntitiesResponse**](CustomerFiscalEntitiesResponse.md) |  | [optional] |
+| **id** | **String** | Customer's ID |  |
+| **livemode** | **Boolean** | true if the object exists in live mode or the value false if the object exists in test mode |  |
+| **name** | **String** | Customer's name |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **object** | **String** |  |  |
+| **payment_sources** | [**CustomerPaymentMethodsResponse**](CustomerPaymentMethodsResponse.md) |  | [optional] |
+| **phone** | **String** | Customer's phone number | [optional] |
+| **shipping_contacts** | [**CustomerResponseShippingContacts**](CustomerResponseShippingContacts.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerResponse.new(
+  antifraud_info: null,
+  corporate: null,
+  created_at: 1485151007,
+  custom_reference: custom_reference,
+  default_fiscal_entity_id: fis_ent_2tKqqAfqPi21oCmEJ,
+  default_shipping_contact_id: ship_cont_2tKZsTYcsryyu7Ah8,
+  default_payment_source_id: src_2tHJfJ79KyUwpxTio,
+  email: Felipe@gmail.com,
+  fiscal_entities: null,
+  id: cus_2tHJfJ79KyUwpxTik,
+  livemode: true,
+  name: Felipe,
+  metadata: null,
+  object: customer,
+  payment_sources: null,
+  phone: +5215555555555,
+  shipping_contacts: null
+)
+```
+

data/docs/CustomerResponseShippingContacts.md

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

data/docs/CustomerShippingContacts.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::CustomerShippingContacts
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | Phone contact | [optional] |
+| **receiver** | **String** | Name of the person who will receive the order | [optional] |
+| **between_streets** | **String** | The street names between which the order will be delivered. | [optional] |
+| **address** | [**CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) |  |  |
+| **parent_id** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+| **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerShippingContacts.new(
+  phone: +525511223344,
+  receiver: Marvin Fuller,
+  between_streets: Ackerman Crescent,
+  address: null,
+  parent_id: null,
+  default: null,
+  deleted: null,
+  metadata: null
+)
+```
+

data/docs/CustomerShippingContactsAddress.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::CustomerShippingContactsAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **street1** | **String** |  | [optional] |
+| **street2** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerShippingContactsAddress.new(
+  street1: Nuevo Leon 254,
+  street2: Departamento 404,
+  postal_code: 06100,
+  city: Ciudad de Mexico,
+  state: Ciudad de Mexico,
+  country: MX,
+  residential: true
+)
+```
+

data/docs/CustomerShippingContactsDataResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::CustomerShippingContactsDataResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** | Phone contact | [optional] |
+| **receiver** | **String** | Name of the person who will receive the order | [optional] |
+| **between_streets** | **String** | The street names between which the order will be delivered. | [optional] |
+| **address** | [**CustomerShippingContactsAddress**](CustomerShippingContactsAddress.md) |  |  |
+| **parent_id** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+| **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **created_at** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerShippingContactsDataResponse.new(
+  phone: +525511223344,
+  receiver: Marvin Fuller,
+  between_streets: Ackerman Crescent,
+  address: null,
+  parent_id: null,
+  default: null,
+  deleted: null,
+  metadata: null,
+  id: ship_cont_2tKZsTYcsryyu7Ah8,
+  object: shipping_contact,
+  created_at: 1675715413
+)
+```
+

data/docs/CustomerShippingContactsResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::CustomerShippingContactsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** |  | [optional] |
+| **receiver** | **String** |  | [optional] |
+| **between_streets** | **String** |  | [optional] |
+| **address** | [**CustomerShippingContactsResponseAddress**](CustomerShippingContactsResponseAddress.md) |  | [optional] |
+| **parent_id** | **String** |  | [optional] |
+| **default** | **Boolean** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **created_at** | **Integer** |  | [optional] |
+| **metadata** | **Hash<String, Object>** | Metadata associated with the shipping contact | [optional] |
+| **object** | **String** |  | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerShippingContactsResponse.new(
+  phone: +525511223344,
+  receiver: Marvin Fuller,
+  between_streets: Ackerman Crescent,
+  address: null,
+  parent_id: null,
+  default: false,
+  id: adr_1234567890,
+  created_at: 1675715413,
+  metadata: null,
+  object: shipping_contact,
+  deleted: false
+)
+```
+

data/docs/CustomerShippingContactsResponseAddress.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::CustomerShippingContactsResponseAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **street1** | **String** |  | [optional] |
+| **street2** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **residential** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerShippingContactsResponseAddress.new(
+  object: shipping_address,
+  street1: Nuevo Leon 254,
+  street2: Departamento 404,
+  postal_code: 06100,
+  city: Ciudad de Mexico,
+  state: Ciudad de Mexico,
+  country: MX,
+  residential: true
+)
+```
+

data/docs/CustomerUpdateFiscalEntitiesRequest.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::CustomerUpdateFiscalEntitiesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**CustomerAddress**](CustomerAddress.md) |  | [optional] |
+| **tax_id** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **company_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::CustomerUpdateFiscalEntitiesRequest.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: Femsa
+)
+```
+