digital_femsa 1.0.0

data/docs/ChargeOrderResponsePaymentMethod.md

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

data/docs/ChargeRequest.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::ChargeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **payment_method** | [**ChargeRequestPaymentMethod**](ChargeRequestPaymentMethod.md) |  |  |
+| **reference_id** | **String** | Custom reference to add to the charge | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeRequest.new(
+  amount: 40000,
+  payment_method: null,
+  reference_id: null
+)
+```
+

data/docs/ChargeRequestPaymentMethod.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::ChargeRequestPaymentMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Integer** | Method expiration date as unix timestamp | [optional] |
+| **type** | **String** |  |  |
+| **payment_source_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeRequestPaymentMethod.new(
+  expires_at: 1677196303,
+  type: cash,
+  payment_source_id: src_2tLkkyfMPh6v7pFry
+)
+```
+

data/docs/ChargeResponse.md

@@ -0,0 +1,52 @@
+# DigitalFemsa::ChargeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] |
+| **created_at** | **Integer** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **customer_id** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **device_fingerprint** | **String** |  | [optional] |
+| **failure_code** | **String** |  | [optional] |
+| **failure_message** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **paid_at** | **Integer** |  | [optional] |
+| **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) |  | [optional] |
+| **reference_id** | **String** | Reference ID of the charge | [optional] |
+| **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeResponse.new(
+  amount: 4321,
+  channel: null,
+  created_at: 1676386026,
+  currency: MXN,
+  customer_id: null,
+  description: Payment from order,
+  device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba,
+  failure_code: suspected_fraud,
+  failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
+  id: 63efa757cf65380001aec040,
+  livemode: null,
+  object: null,
+  order_id: ord_2tN73UdUSNrYRPD9r,
+  paid_at: 1676390742,
+  payment_method: null,
+  reference_id: ref_2tN73UdUSNrYRPD9r,
+  refunds: null,
+  status: pending_payment
+)
+```
+

data/docs/ChargeResponseChannel.md

@@ -0,0 +1,24 @@
+# DigitalFemsa::ChargeResponseChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **segment** | **String** |  | [optional] |
+| **checkout_request_id** | **String** |  | [optional] |
+| **checkout_request_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeResponseChannel.new(
+  segment: Checkout,
+  checkout_request_id: 6fca054a-8519-4c43-971e-cea35cc519bb,
+  checkout_request_type: HostedPayment,
+  id: channel_2tNDzhA4Akmzj11AU
+)
+```
+

data/docs/ChargeResponsePaymentMethod.md

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

data/docs/ChargeResponseRefunds.md

@@ -0,0 +1,26 @@
+# DigitalFemsa::ChargeResponseRefunds
+
+## 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<ChargeResponseRefundsData>**](ChargeResponseRefundsData.md) | refunds | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeResponseRefunds.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/ChargeResponseRefundsData.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::ChargeResponseRefundsData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  |  |
+| **auth_code** | **String** |  | [optional] |
+| **created_at** | **Integer** |  |  |
+| **expires_at** | **Integer** | refund expiration date | [optional] |
+| **id** | **String** |  |  |
+| **object** | **String** |  |  |
+| **status** | **String** | refund status | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeResponseRefundsData.new(
+  amount: -15000,
+  auth_code: 867372,
+  created_at: 1678226878,
+  expires_at: 1678226878,
+  id: 6407b5bee1329a000175ba11,
+  object: refund,
+  status: pending
+)
+```
+

data/docs/ChargeUpdateRequest.md

@@ -0,0 +1,18 @@
+# DigitalFemsa::ChargeUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference_id** | **String** | custom reference id | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargeUpdateRequest.new(
+  reference_id: 278482642
+)
+```
+

data/docs/ChargesApi.md

@@ -0,0 +1,241 @@
+# DigitalFemsa::ChargesApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_charges**](ChargesApi.md#get_charges) | **GET** /charges | Get A List of Charges |
+| [**orders_create_charge**](ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge |
+| [**update_charge**](ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge |
+
+
+## get_charges
+
+> <GetChargesResponse> get_charges(opts)
+
+Get A List of Charges
+
+### 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::ChargesApi.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 Charges
+  result = api_instance.get_charges(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->get_charges: #{e}"
+end
+```
+
+#### Using the get_charges_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetChargesResponse>, Integer, Hash)> get_charges_with_http_info(opts)
+
+```ruby
+begin
+  # Get A List of Charges
+  data, status_code, headers = api_instance.get_charges_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetChargesResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->get_charges_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
+
+[**GetChargesResponse**](GetChargesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## orders_create_charge
+
+> <ChargeOrderResponse> orders_create_charge(id, charge_request, opts)
+
+Create charge
+
+Create charge for an existing orden
+
+### 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::ChargesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+charge_request = DigitalFemsa::ChargeRequest.new({payment_method: DigitalFemsa::ChargeRequestPaymentMethod.new({type: 'cash'})}) # ChargeRequest | requested field for a charge
+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 charge
+  result = api_instance.orders_create_charge(id, charge_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->orders_create_charge: #{e}"
+end
+```
+
+#### Using the orders_create_charge_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChargeOrderResponse>, Integer, Hash)> orders_create_charge_with_http_info(id, charge_request, opts)
+
+```ruby
+begin
+  # Create charge
+  data, status_code, headers = api_instance.orders_create_charge_with_http_info(id, charge_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChargeOrderResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->orders_create_charge_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **charge_request** | [**ChargeRequest**](ChargeRequest.md) | requested field for a charge |  |
+| **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
+
+[**ChargeOrderResponse**](ChargeOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## update_charge
+
+> <ChargeResponse> update_charge(id, charge_update_request, opts)
+
+Update a charge
+
+### 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::ChargesApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+charge_update_request = DigitalFemsa::ChargeUpdateRequest.new # ChargeUpdateRequest | requested field for update a charge
+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
+  # Update a charge
+  result = api_instance.update_charge(id, charge_update_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->update_charge: #{e}"
+end
+```
+
+#### Using the update_charge_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChargeResponse>, Integer, Hash)> update_charge_with_http_info(id, charge_update_request, opts)
+
+```ruby
+begin
+  # Update a charge
+  data, status_code, headers = api_instance.update_charge_with_http_info(id, charge_update_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChargeResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ChargesApi->update_charge_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **charge_update_request** | [**ChargeUpdateRequest**](ChargeUpdateRequest.md) | requested field for update a charge |  |
+| **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
+
+[**ChargeResponse**](ChargeResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/ChargesDataResponse.md

@@ -0,0 +1,52 @@
+# DigitalFemsa::ChargesDataResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] |
+| **created_at** | **Integer** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **customer_id** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **device_fingerprint** | **String** |  | [optional] |
+| **failure_code** | **String** |  | [optional] |
+| **failure_message** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **paid_at** | **Integer** |  | [optional] |
+| **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) |  | [optional] |
+| **reference_id** | **String** | Reference ID of the charge | [optional] |
+| **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::ChargesDataResponse.new(
+  amount: 4321,
+  channel: null,
+  created_at: 1676386026,
+  currency: MXN,
+  customer_id: null,
+  description: Payment from order,
+  device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba,
+  failure_code: suspected_fraud,
+  failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
+  id: 63efa757cf65380001aec040,
+  livemode: null,
+  object: null,
+  order_id: ord_2tN73UdUSNrYRPD9r,
+  paid_at: 1676390742,
+  payment_method: null,
+  reference_id: ref_2tN73UdUSNrYRPD9r,
+  refunds: null,
+  status: pending_payment
+)
+```
+

data/docs/Checkout.md

@@ -0,0 +1,34 @@
+# DigitalFemsa::Checkout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_payment_methods** | **Array<String>** | Those are the payment methods that will be available for the link |  |
+| **expires_at** | **Integer** | It is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs)  |  |
+| **name** | **String** | Reason for charge |  |
+| **needs_shipping_contact** | **Boolean** | This flag allows you to fill in the shipping information at checkout. | [optional] |
+| **on_demand_enabled** | **Boolean** | This flag allows you to specify if the link will be on demand. | [optional] |
+| **order_template** | [**CheckoutOrderTemplate**](CheckoutOrderTemplate.md) |  |  |
+| **payments_limit_count** | **Integer** | It is the number of payments that can be made through the link. | [optional] |
+| **recurrent** | **Boolean** | false: single use. true: multiple payments |  |
+| **type** | **String** | It is the type of link that will be created. It must be a valid type. |  |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::Checkout.new(
+  allowed_payment_methods: ["cash"],
+  expires_at: 1680397724,
+  name: Payment Link Name 1594138857,
+  needs_shipping_contact: false,
+  on_demand_enabled: true,
+  order_template: null,
+  payments_limit_count: 5,
+  recurrent: false,
+  type: PaymentLink
+)
+```
+