digital_femsa 1.0.0

data/docs/OrderResponse.md

@@ -0,0 +1,58 @@
+# DigitalFemsa::OrderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The total amount to be collected in cents | [optional] |
+| **amount_refunded** | **Integer** | The total amount refunded in cents | [optional] |
+| **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) |  | [optional] |
+| **charges** | [**OrderResponseCharges**](OrderResponseCharges.md) |  | [optional] |
+| **checkout** | [**OrderResponseCheckout**](OrderResponseCheckout.md) |  | [optional] |
+| **created_at** | **Integer** | The time at which the object was created in seconds since the Unix epoch | [optional] |
+| **currency** | **String** | The three-letter ISO 4217 currency code. The currency of the order. | [optional] |
+| **customer_info** | [**OrderResponseCustomerInfo**](OrderResponseCustomerInfo.md) |  | [optional] |
+| **discount_lines** | [**OrderResponseDiscountLines**](OrderResponseDiscountLines.md) |  | [optional] |
+| **fiscal_entity** | [**OrderFiscalEntityResponse**](OrderFiscalEntityResponse.md) |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **is_refundable** | **Boolean** |  | [optional] |
+| **line_items** | [**OrderResponseProducts**](OrderResponseProducts.md) |  | [optional] |
+| **livemode** | **Boolean** | Whether the object exists in live mode or test mode | [optional] |
+| **metadata** | **Hash<String, Object>** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [optional] |
+| **next_action** | [**OrderNextActionResponse**](OrderNextActionResponse.md) |  | [optional] |
+| **object** | **String** | String representing the object’s type. Objects of the same type share the same value. | [optional] |
+| **payment_status** | **String** | The payment status of the order. | [optional] |
+| **processing_mode** | **String** | Indicates the processing mode for the order, either ecommerce, recurrent or validation. | [optional] |
+| **shipping_contact** | [**OrderResponseShippingContact**](OrderResponseShippingContact.md) |  | [optional] |
+| **updated_at** | **Integer** | The time at which the object was last updated in seconds since the Unix epoch | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderResponse.new(
+  amount: 21605,
+  amount_refunded: 0,
+  channel: null,
+  charges: null,
+  checkout: null,
+  created_at: 1676328434,
+  currency: MXN,
+  customer_info: null,
+  discount_lines: null,
+  fiscal_entity: null,
+  id: ord_2tMtQQpDvfnNjiuFG,
+  is_refundable: false,
+  line_items: null,
+  livemode: false,
+  metadata: null,
+  next_action: null,
+  object: order,
+  payment_status: paid,
+  processing_mode: ecommerce,
+  shipping_contact: null,
+  updated_at: 1676328434
+)
+```
+

data/docs/OrderResponseCharges.md

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

data/docs/OrderResponseCheckout.md

@@ -0,0 +1,58 @@
+# DigitalFemsa::OrderResponseCheckout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **allowed_payment_methods** | **Array<String>** |  | [optional] |
+| **can_not_expire** | **Boolean** |  | [optional] |
+| **emails_sent** | **Integer** |  | [optional] |
+| **expires_at** | **Integer** |  | [optional] |
+| **failure_url** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **is_redirect_on_failure** | **Boolean** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **needs_shipping_contact** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **on_demand_enabled** | **Boolean** |  | [optional] |
+| **recurrent** | **Boolean** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **sms_sent** | **Integer** |  | [optional] |
+| **success_url** | **String** |  | [optional] |
+| **starts_at** | **Integer** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderResponseCheckout.new(
+  allowed_payment_methods: null,
+  can_not_expire: false,
+  emails_sent: 0,
+  expires_at: 1676613599,
+  failure_url: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx,
+  id: 6fca054a-8519-4c43-971e-cea35cc519bb,
+  is_redirect_on_failure: false,
+  livemode: false,
+  metadata: null,
+  name: ord-2tNDzhA4Akmzj11AS,
+  needs_shipping_contact: false,
+  object: checkout,
+  on_demand_enabled: true,
+  recurrent: false,
+  slug: 6fca054a85194c43971ecea35cc519bb,
+  sms_sent: 0,
+  success_url: http://187.216.228.66:2222/SysVentasPagos/Acceso.aspx,
+  starts_at: 1676354400,
+  status: Issued,
+  type: HostedPayment,
+  url: https://pay.stg.femsa.io/checkout/6fca054a85194c43971ecea35cc519bb
+)
+```
+

data/docs/OrderResponseCustomerInfo.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::OrderResponseCustomerInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_custom_reference** | **String** | Custom reference | [optional] |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **corporate** | **Boolean** |  | [optional][default to false] |
+| **object** | **String** |  | [optional] |
+| **customer_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderResponseCustomerInfo.new(
+  customer_custom_reference: custom_reference,
+  name: DevTest,
+  email: test@femsa.com,
+  phone: 5522997233,
+  corporate: null,
+  object: customer_info,
+  customer_id: cus_23874283647
+)
+```
+

data/docs/OrderResponseDiscountLines.md

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

data/docs/OrderResponseProducts.md

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

@@ -0,0 +1,38 @@
+# DigitalFemsa::OrderResponseShippingContact
+
+## 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::OrderResponseShippingContact.new(
+  phone: +525511223344,
+  receiver: Marvin Fuller,
+  between_streets: Ackerman Crescent,
+  address: null,
+  parent_id: null,
+  default: false,
+  id: null,
+  created_at: null,
+  metadata: null,
+  object: null,
+  deleted: false
+)
+```
+

data/docs/OrderTaxRequest.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::OrderTaxRequest
+
+## 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] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderTaxRequest.new(
+  amount: 100,
+  description: testing,
+  metadata: {"key":"value"}
+)
+```
+

data/docs/OrderUpdateFiscalEntityRequest.md

@@ -0,0 +1,28 @@
+# DigitalFemsa::OrderUpdateFiscalEntityRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address** | [**FiscalEntityAddress**](FiscalEntityAddress.md) |  |  |
+| **email** | **String** | Email of the fiscal entity | [optional] |
+| **name** | **String** | Name of the fiscal entity | [optional] |
+| **metadata** | **Hash<String, Object>** | Metadata associated with the fiscal entity | [optional] |
+| **phone** | **String** | Phone of the fiscal entity | [optional] |
+| **tax_id** | **String** | Tax ID of the fiscal entity | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderUpdateFiscalEntityRequest.new(
+  address: null,
+  email: test@gmail.com,
+  name: Femsa Inc,
+  metadata: null,
+  phone: +525511223344,
+  tax_id: AAA010101AAA
+)
+```
+

data/docs/OrderUpdateRequest.md

@@ -0,0 +1,40 @@
+# DigitalFemsa::OrderUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charges** | [**Array<ChargeRequest>**](ChargeRequest.md) |  | [optional] |
+| **checkout** | [**CheckoutRequest**](CheckoutRequest.md) |  | [optional] |
+| **currency** | **String** | Currency with which the payment will be made. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | [optional] |
+| **customer_info** | [**OrderUpdateRequestCustomerInfo**](OrderUpdateRequestCustomerInfo.md) |  | [optional] |
+| **discount_lines** | [**Array<OrderDiscountLinesRequest>**](OrderDiscountLinesRequest.md) | List of [discounts](https://developers.femsa.com/v2.1.0/reference/orderscreatediscountline) that are applied to the order. You must have at least one discount. | [optional] |
+| **fiscal_entity** | [**OrderUpdateFiscalEntityRequest**](OrderUpdateFiscalEntityRequest.md) |  | [optional] |
+| **line_items** | [**Array<Product>**](Product.md) | List of [products](https://developers.femsa.com/v2.1.0/reference/orderscreateproduct) that are sold in the order. You must have at least one product. | [optional] |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+| **pre_authorize** | **Boolean** | Indicates whether the order charges must be preauthorized | [optional][default to false] |
+| **shipping_contact** | [**CustomerShippingContacts**](CustomerShippingContacts.md) |  | [optional] |
+| **shipping_lines** | [**Array<ShippingRequest>**](ShippingRequest.md) | List of [shipping costs](https://developers.femsa.com/v2.1.0/reference/orderscreateshipping). If the online store offers digital products. | [optional] |
+| **tax_lines** | [**Array<OrderTaxRequest>**](OrderTaxRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::OrderUpdateRequest.new(
+  charges: null,
+  checkout: null,
+  currency: MXN,
+  customer_info: null,
+  discount_lines: null,
+  fiscal_entity: null,
+  line_items: null,
+  metadata: null,
+  pre_authorize: null,
+  shipping_contact: null,
+  shipping_lines: null,
+  tax_lines: null
+)
+```
+

data/docs/OrderUpdateRequestCustomerInfo.md

@@ -0,0 +1,49 @@
+# DigitalFemsa::OrderUpdateRequestCustomerInfo
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::OrderUpdateRequestCustomerInfo.openapi_one_of
+# =>
+# [
+#   :'CustomerInfo',
+#   :'CustomerInfoJustCustomerId'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'digital_femsa'
+
+DigitalFemsa::OrderUpdateRequestCustomerInfo.build(data)
+# => #<CustomerInfo:0x00007fdd4aab02a0>
+
+DigitalFemsa::OrderUpdateRequestCustomerInfo.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `CustomerInfo`
+- `CustomerInfoJustCustomerId`
+- `nil` (if no type matches)
+