digital_femsa 1.0.0

data/docs/TransfersApi.md

@@ -0,0 +1,165 @@
+# DigitalFemsa::TransfersApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_transfer**](TransfersApi.md#get_transfer) | **GET** /transfers/{id} | Get Transfer |
+| [**get_transfers**](TransfersApi.md#get_transfers) | **GET** /transfers | Get a list of transfers |
+
+
+## get_transfer
+
+> <TransferResponse> get_transfer(id, opts)
+
+Get Transfer
+
+Get the details of a Transfer
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::TransfersApi.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 Transfer
+  result = api_instance.get_transfer(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransfersApi->get_transfer: #{e}"
+end
+```
+
+#### Using the get_transfer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransferResponse>, Integer, Hash)> get_transfer_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Transfer
+  data, status_code, headers = api_instance.get_transfer_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransferResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransfersApi->get_transfer_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
+
+[**TransferResponse**](TransferResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_transfers
+
+> <GetTransfersResponse> get_transfers(opts)
+
+Get a list of transfers
+
+Get transfers details in the form of a list
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::TransfersApi.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 transfers
+  result = api_instance.get_transfers(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransfersApi->get_transfers: #{e}"
+end
+```
+
+#### Using the get_transfers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTransfersResponse>, Integer, Hash)> get_transfers_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of transfers
+  data, status_code, headers = api_instance.get_transfers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTransfersResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling TransfersApi->get_transfers_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
+
+[**GetTransfersResponse**](GetTransfersResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/TransfersResponse.md

@@ -0,0 +1,36 @@
+# DigitalFemsa::TransfersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Amount in cents of the transfer. | [optional] |
+| **created_at** | **Integer** | Date and time of creation of the transfer. | [optional] |
+| **currency** | **String** | The currency of the transfer. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] |
+| **id** | **String** | Unique identifier of the transfer. | [optional] |
+| **livemode** | **Boolean** | Indicates whether the transfer was created in live mode or test mode. | [optional] |
+| **method** | [**TransferMethodResponse**](TransferMethodResponse.md) |  | [optional] |
+| **object** | **String** | Object name, which is transfer. | [optional] |
+| **statement_description** | **String** | Description of the transfer. | [optional] |
+| **statement_reference** | **String** | Reference number of the transfer. | [optional] |
+| **status** | **String** | Code indicating transfer status. | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::TransfersResponse.new(
+  amount: 10000,
+  created_at: 1553273553,
+  currency: MXN,
+  id: 5b0337d4dD344ef954fe1X4b6,
+  livemode: true,
+  method: null,
+  object: transfer,
+  statement_description: Femsa 4401234,
+  statement_reference: 4401234,
+  status: pending
+)
+```
+

data/docs/UpdateCustomer.md

@@ -0,0 +1,40 @@
+# DigitalFemsa::UpdateCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **antifraud_info** | [**UpdateCustomerAntifraudInfo**](UpdateCustomerAntifraudInfo.md) |  | [optional] |
+| **default_payment_source_id** | **String** | It is a parameter that allows to identify in the response, the Femsa ID of a payment method (payment_id) | [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). | [optional] |
+| **name** | **String** | Client's name | [optional] |
+| **phone** | **String** | Is the customer's phone number | [optional] |
+| **default_shipping_contact_id** | **String** | It is a parameter that allows to identify in the response, the Femsa ID of the shipping address (shipping_contact) | [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] |
+| **fiscal_entities** | [**Array<CustomerFiscalEntitiesRequest>**](CustomerFiscalEntitiesRequest.md) |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Femsa | [optional] |
+| **shipping_contacts** | [**Array<CustomerShippingContacts>**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Femsa | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::UpdateCustomer.new(
+  antifraud_info: null,
+  default_payment_source_id: src_1a2b3c4d5e6f7g8h,
+  email: miguel@gmail.com,
+  name: miguel,
+  phone: +5215555555555,
+  default_shipping_contact_id: ship_cont_1a2b3c4d5e6f7g8h,
+  corporate: false,
+  custom_reference: null,
+  fiscal_entities: null,
+  metadata: null,
+  payment_sources: null,
+  shipping_contacts: null
+)
+```
+

data/docs/UpdateCustomerAntifraudInfo.md

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

data/docs/UpdateCustomerFiscalEntitiesResponse.md

@@ -0,0 +1,38 @@
+# DigitalFemsa::UpdateCustomerFiscalEntitiesResponse
+
+## 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::UpdateCustomerFiscalEntitiesResponse.new(
+  address: null,
+  tax_id: null,
+  email: null,
+  phone: null,
+  metadata: null,
+  company_name: Femsa,
+  id: fis_ent_2tKZsTYcsryyu7Ah8,
+  object: fiscal_entities,
+  created_at: 1675715413,
+  parent_id: cus_2tKcHxhTz7xU5SymF,
+  default: null
+)
+```
+

data/docs/UpdateCustomerPaymentMethodsResponse.md

@@ -0,0 +1,77 @@
+# DigitalFemsa::UpdateCustomerPaymentMethodsResponse
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::UpdateCustomerPaymentMethodsResponse.openapi_one_of
+# =>
+# [
+#   :'PaymentMethodCashResponse'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::UpdateCustomerPaymentMethodsResponse.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::UpdateCustomerPaymentMethodsResponse.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::UpdateCustomerPaymentMethodsResponse.build(data)
+# => #<PaymentMethodCashResponse:0x00007fdd4aab02a0>
+
+DigitalFemsa::UpdateCustomerPaymentMethodsResponse.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/UpdateOrderDiscountLinesRequest.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::UpdateOrderDiscountLinesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **code** | **String** | Discount code. | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::UpdateOrderDiscountLinesRequest.new(
+  amount: 500,
+  code: 123,
+  type: loyalty
+)
+```
+

data/docs/UpdateOrderTaxRequest.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::UpdateOrderTaxRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to be collected for tax in cents | [optional] |
+| **description** | **String** | description or tax's name | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::UpdateOrderTaxRequest.new(
+  amount: 100,
+  description: testing,
+  metadata: null
+)
+```
+

data/docs/UpdateOrderTaxResponse.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::UpdateOrderTaxResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount to be collected for tax in cents |  |
+| **description** | **String** | description or tax's name |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **id** | **String** |  |  |
+| **object** | **String** |  | [optional] |
+| **parent_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::UpdateOrderTaxResponse.new(
+  amount: 100,
+  description: testing,
+  metadata: {key=value},
+  id: tax_lin_2tQ8dC5mg1UADmVPo,
+  object: tax_line,
+  parent_id: ord_2tPAmKCEJqh8RE6nY
+)
+```
+

data/docs/UpdatePaymentMethods.md

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

data/docs/UpdateProduct.md

@@ -0,0 +1,34 @@
+# DigitalFemsa::UpdateProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **antifraud_info** | **Hash<String, Object>** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **sku** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **unit_price** | **Integer** |  | [optional] |
+| **quantity** | **Integer** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::UpdateProduct.new(
+  antifraud_info: null,
+  description: null,
+  sku: null,
+  name: Box of Cohiba S1s,
+  unit_price: 20000,
+  quantity: 1,
+  tags: null,
+  brand: null,
+  metadata: null
+)
+```
+

data/docs/WebhookKeyCreateResponse.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::WebhookKeyCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] |
+| **id** | **String** | Unique identifier of the webhook key | [optional] |
+| **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] |
+| **object** | **String** | Object name, value is webhook_key | [optional] |
+| **public_key** | **String** | Public key to be used in the webhook | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookKeyCreateResponse.new(
+  active: true,
+  created_at: 1577836800,
+  id: 62730ba6fb7dfd6a712f118e,
+  livemode: false,
+  object: webhook_key,
+  public_key: -----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n
+)
+```
+

data/docs/WebhookKeyDeleteResponse.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::WebhookKeyDeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] |
+| **deleted** | **Boolean** | Indicates if the webhook key is deleted | [optional] |
+| **id** | **String** | Unique identifier of the webhook key | [optional] |
+| **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] |
+| **object** | **String** | Object name, value is webhook_key | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookKeyDeleteResponse.new(
+  active: true,
+  created_at: 1577836800,
+  deleted: true,
+  id: 62730ba6fb7dfd6a712f118e,
+  livemode: false,
+  object: webhook_key
+)
+```
+

data/docs/WebhookKeyRequest.md

@@ -0,0 +1,18 @@
+# DigitalFemsa::WebhookKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookKeyRequest.new(
+  active: true
+)
+```
+

data/docs/WebhookKeyResponse.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::WebhookKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the webhook key | [optional] |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds with the creation date of the webhook key | [optional] |
+| **deactivated_at** | **Integer** | Unix timestamp in seconds with the deactivation date of the webhook key | [optional] |
+| **public_key** | **String** | Public key to be used in the webhook | [optional] |
+| **livemode** | **Boolean** | Indicates if the webhook key is in live mode | [optional] |
+| **object** | **String** | Object name, value is webhook_key | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookKeyResponse.new(
+  id: 62730ba6fb7dfd6a712f118e,
+  active: true,
+  created_at: 1577836800,
+  deactivated_at: null,
+  public_key: -----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\n8QIDAQAB\n-----END PUBLIC KEY-----\n,
+  livemode: false,
+  object: webhook_key
+)
+```
+

data/docs/WebhookKeyUpdateRequest.md

@@ -0,0 +1,18 @@
+# DigitalFemsa::WebhookKeyUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the webhook key is active | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookKeyUpdateRequest.new(
+  active: false
+)
+```
+