digital_femsa 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CODE_OF_CONDUCT.md +77 -0
- data/CONTRIBUTING.md +19 -0
- data/Gemfile +9 -0
- data/LICENSE +22 -0
- data/Makefile +11 -0
- data/README.md +320 -0
- data/Rakefile +10 -0
- data/VERSION +1 -0
- data/config-ruby.json +30 -0
- data/digital_femsa.gemspec +41 -0
- data/docs/ApiKeyCreateResponse.md +40 -0
- data/docs/ApiKeyRequest.md +20 -0
- data/docs/ApiKeyResponse.md +38 -0
- data/docs/ApiKeyResponseOnDelete.md +34 -0
- data/docs/ApiKeyUpdateRequest.md +20 -0
- data/docs/ApiKeysApi.md +391 -0
- data/docs/BalanceCommonField.md +20 -0
- data/docs/BalanceResponse.md +36 -0
- data/docs/BalancesApi.md +79 -0
- data/docs/ChargeOrderResponse.md +52 -0
- data/docs/ChargeOrderResponsePaymentMethod.md +76 -0
- data/docs/ChargeRequest.md +22 -0
- data/docs/ChargeRequestPaymentMethod.md +22 -0
- data/docs/ChargeResponse.md +52 -0
- data/docs/ChargeResponseChannel.md +24 -0
- data/docs/ChargeResponsePaymentMethod.md +76 -0
- data/docs/ChargeResponseRefunds.md +26 -0
- data/docs/ChargeResponseRefundsData.md +30 -0
- data/docs/ChargeUpdateRequest.md +18 -0
- data/docs/ChargesApi.md +241 -0
- data/docs/ChargesDataResponse.md +52 -0
- data/docs/Checkout.md +34 -0
- data/docs/CheckoutOrderTemplate.md +24 -0
- data/docs/CheckoutOrderTemplateCustomerInfo.md +49 -0
- data/docs/CheckoutRequest.md +30 -0
- data/docs/CheckoutResponse.md +58 -0
- data/docs/CheckoutsResponse.md +26 -0
- data/docs/CompaniesApi.md +159 -0
- data/docs/CompanyFiscalInfoAddressResponse.md +34 -0
- data/docs/CompanyFiscalInfoResponse.md +30 -0
- data/docs/CompanyPayoutDestinationResponse.md +28 -0
- data/docs/CompanyResponse.md +32 -0
- data/docs/CreateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/CreateCustomerPaymentMethodsRequest.md +47 -0
- data/docs/CreateCustomerPaymentMethodsResponse.md +77 -0
- data/docs/Customer.md +40 -0
- data/docs/CustomerAddress.md +32 -0
- data/docs/CustomerAntifraudInfo.md +20 -0
- data/docs/CustomerAntifraudInfoResponse.md +20 -0
- data/docs/CustomerFiscalEntitiesDataResponse.md +38 -0
- data/docs/CustomerFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerFiscalEntitiesResponse.md +22 -0
- data/docs/CustomerInfo.md +26 -0
- data/docs/CustomerInfoJustCustomerId.md +18 -0
- data/docs/CustomerInfoJustCustomerIdResponse.md +18 -0
- data/docs/CustomerPaymentMethodRequest.md +18 -0
- data/docs/CustomerPaymentMethodsData.md +77 -0
- data/docs/CustomerPaymentMethodsRequest.md +47 -0
- data/docs/CustomerPaymentMethodsResponse.md +26 -0
- data/docs/CustomerResponse.md +50 -0
- data/docs/CustomerResponseShippingContacts.md +22 -0
- data/docs/CustomerShippingContacts.md +32 -0
- data/docs/CustomerShippingContactsAddress.md +30 -0
- data/docs/CustomerShippingContactsDataResponse.md +38 -0
- data/docs/CustomerShippingContactsResponse.md +38 -0
- data/docs/CustomerShippingContactsResponseAddress.md +32 -0
- data/docs/CustomerUpdateFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerUpdateShippingContacts.md +30 -0
- data/docs/CustomersApi.md +553 -0
- data/docs/CustomersResponse.md +26 -0
- data/docs/DeleteApiKeysResponse.md +34 -0
- data/docs/Details.md +18 -0
- data/docs/DetailsError.md +24 -0
- data/docs/DiscountLinesDataResponse.md +28 -0
- data/docs/DiscountLinesResponse.md +28 -0
- data/docs/DiscountsApi.md +405 -0
- data/docs/EmailCheckoutRequest.md +18 -0
- data/docs/Error.md +24 -0
- data/docs/EventResponse.md +32 -0
- data/docs/EventsApi.md +239 -0
- data/docs/EventsResendResponse.md +28 -0
- data/docs/FiscalEntityAddress.md +30 -0
- data/docs/GetApiKeysResponse.md +26 -0
- data/docs/GetChargesResponse.md +26 -0
- data/docs/GetCompaniesResponse.md +26 -0
- data/docs/GetCustomerPaymentMethodDataResponse.md +77 -0
- data/docs/GetEventsResponse.md +26 -0
- data/docs/GetOrderDiscountLinesResponse.md +26 -0
- data/docs/GetOrdersResponse.md +26 -0
- data/docs/GetPaymentMethodResponse.md +26 -0
- data/docs/GetTransactionsResponse.md +26 -0
- data/docs/GetTransfersResponse.md +26 -0
- data/docs/GetWebhookKeysResponse.md +26 -0
- data/docs/GetWebhooksResponse.md +26 -0
- data/docs/LogResponse.md +56 -0
- data/docs/LogsApi.md +165 -0
- data/docs/LogsResponse.md +26 -0
- data/docs/LogsResponseData.md +56 -0
- data/docs/OrderCaptureRequest.md +18 -0
- data/docs/OrderCustomerInfoResponse.md +28 -0
- data/docs/OrderDiscountLinesRequest.md +22 -0
- data/docs/OrderFiscalEntityAddressResponse.md +32 -0
- data/docs/OrderFiscalEntityRequest.md +28 -0
- data/docs/OrderFiscalEntityResponse.md +34 -0
- data/docs/OrderNextActionResponse.md +20 -0
- data/docs/OrderNextActionResponseRedirectToUrl.md +20 -0
- data/docs/OrderRefundRequest.md +22 -0
- data/docs/OrderRequest.md +44 -0
- data/docs/OrderRequestCustomerInfo.md +49 -0
- data/docs/OrderResponse.md +58 -0
- data/docs/OrderResponseCharges.md +22 -0
- data/docs/OrderResponseCheckout.md +58 -0
- data/docs/OrderResponseCustomerInfo.md +30 -0
- data/docs/OrderResponseDiscountLines.md +22 -0
- data/docs/OrderResponseProducts.md +26 -0
- data/docs/OrderResponseShippingContact.md +38 -0
- data/docs/OrderTaxRequest.md +22 -0
- data/docs/OrderUpdateFiscalEntityRequest.md +28 -0
- data/docs/OrderUpdateRequest.md +40 -0
- data/docs/OrderUpdateRequestCustomerInfo.md +49 -0
- data/docs/OrdersApi.md +627 -0
- data/docs/OrdersResponse.md +18 -0
- data/docs/Page.md +20 -0
- data/docs/Pagination.md +20 -0
- data/docs/PaymentLinkApi.md +463 -0
- data/docs/PaymentMethod.md +20 -0
- data/docs/PaymentMethodCash.md +36 -0
- data/docs/PaymentMethodCashRequest.md +20 -0
- data/docs/PaymentMethodCashResponse.md +36 -0
- data/docs/PaymentMethodResponse.md +26 -0
- data/docs/PaymentMethodsApi.md +327 -0
- data/docs/Product.md +34 -0
- data/docs/ProductDataResponse.md +40 -0
- data/docs/ProductOrderResponse.md +40 -0
- data/docs/ProductsApi.md +243 -0
- data/docs/ShippingContactsApi.md +243 -0
- data/docs/ShippingOrderResponse.md +32 -0
- data/docs/ShippingRequest.md +26 -0
- data/docs/ShippingsApi.md +243 -0
- data/docs/SmsCheckoutRequest.md +18 -0
- data/docs/TaxesApi.md +243 -0
- data/docs/TransactionResponse.md +38 -0
- data/docs/TransactionsApi.md +171 -0
- data/docs/TransferDestinationResponse.md +32 -0
- data/docs/TransferMethodResponse.md +32 -0
- data/docs/TransferResponse.md +36 -0
- data/docs/TransfersApi.md +165 -0
- data/docs/TransfersResponse.md +36 -0
- data/docs/UpdateCustomer.md +40 -0
- data/docs/UpdateCustomerAntifraudInfo.md +20 -0
- data/docs/UpdateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/UpdateCustomerPaymentMethodsResponse.md +77 -0
- data/docs/UpdateOrderDiscountLinesRequest.md +22 -0
- data/docs/UpdateOrderTaxRequest.md +22 -0
- data/docs/UpdateOrderTaxResponse.md +28 -0
- data/docs/UpdatePaymentMethods.md +18 -0
- data/docs/UpdateProduct.md +34 -0
- data/docs/WebhookKeyCreateResponse.md +28 -0
- data/docs/WebhookKeyDeleteResponse.md +28 -0
- data/docs/WebhookKeyRequest.md +18 -0
- data/docs/WebhookKeyResponse.md +30 -0
- data/docs/WebhookKeyUpdateRequest.md +18 -0
- data/docs/WebhookKeysApi.md +385 -0
- data/docs/WebhookLog.md +30 -0
- data/docs/WebhookRequest.md +20 -0
- data/docs/WebhookResponse.md +36 -0
- data/docs/WebhookUpdateRequest.md +22 -0
- data/docs/WebhooksApi.md +461 -0
- data/gitleaks.toml +0 -0
- data/lib/digital_femsa/api/api_keys_api.rb +407 -0
- data/lib/digital_femsa/api/balances_api.rb +86 -0
- data/lib/digital_femsa/api/charges_api.rb +273 -0
- data/lib/digital_femsa/api/companies_api.rb +174 -0
- data/lib/digital_femsa/api/customers_api.rb +591 -0
- data/lib/digital_femsa/api/discounts_api.rb +447 -0
- data/lib/digital_femsa/api/events_api.rb +256 -0
- data/lib/digital_femsa/api/logs_api.rb +182 -0
- data/lib/digital_femsa/api/orders_api.rb +657 -0
- data/lib/digital_femsa/api/payment_link_api.rb +491 -0
- data/lib/digital_femsa/api/payment_methods_api.rb +368 -0
- data/lib/digital_femsa/api/products_api.rb +275 -0
- data/lib/digital_femsa/api/shipping_contacts_api.rb +275 -0
- data/lib/digital_femsa/api/shippings_api.rb +275 -0
- data/lib/digital_femsa/api/taxes_api.rb +275 -0
- data/lib/digital_femsa/api/transactions_api.rb +191 -0
- data/lib/digital_femsa/api/transfers_api.rb +182 -0
- data/lib/digital_femsa/api/webhook_keys_api.rb +396 -0
- data/lib/digital_femsa/api/webhooks_api.rb +477 -0
- data/lib/digital_femsa/api_client.rb +442 -0
- data/lib/digital_femsa/api_error.rb +58 -0
- data/lib/digital_femsa/configuration.rb +382 -0
- data/lib/digital_femsa/models/api_key_create_response.rb +333 -0
- data/lib/digital_femsa/models/api_key_request.rb +231 -0
- data/lib/digital_femsa/models/api_key_response.rb +317 -0
- data/lib/digital_femsa/models/api_key_response_on_delete.rb +296 -0
- data/lib/digital_femsa/models/api_key_update_request.rb +225 -0
- data/lib/digital_femsa/models/balance_common_field.rb +226 -0
- data/lib/digital_femsa/models/balance_response.rb +324 -0
- data/lib/digital_femsa/models/charge_order_response.rb +373 -0
- data/lib/digital_femsa/models/charge_order_response_payment_method.rb +53 -0
- data/lib/digital_femsa/models/charge_request.rb +241 -0
- data/lib/digital_femsa/models/charge_request_payment_method.rb +241 -0
- data/lib/digital_femsa/models/charge_response.rb +371 -0
- data/lib/digital_femsa/models/charge_response_channel.rb +241 -0
- data/lib/digital_femsa/models/charge_response_payment_method.rb +53 -0
- data/lib/digital_femsa/models/charge_response_refunds.rb +281 -0
- data/lib/digital_femsa/models/charge_response_refunds_data.rb +298 -0
- data/lib/digital_femsa/models/charge_update_request.rb +216 -0
- data/lib/digital_femsa/models/charges_data_response.rb +378 -0
- data/lib/digital_femsa/models/checkout.rb +340 -0
- data/lib/digital_femsa/models/checkout_order_template.rb +301 -0
- data/lib/digital_femsa/models/checkout_order_template_customer_info.rb +106 -0
- data/lib/digital_femsa/models/checkout_request.rb +284 -0
- data/lib/digital_femsa/models/checkout_response.rb +429 -0
- data/lib/digital_femsa/models/checkouts_response.rb +280 -0
- data/lib/digital_femsa/models/company_fiscal_info_address_response.rb +330 -0
- data/lib/digital_femsa/models/company_fiscal_info_response.rb +309 -0
- data/lib/digital_femsa/models/company_payout_destination_response.rb +312 -0
- data/lib/digital_femsa/models/company_response.rb +318 -0
- data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb +341 -0
- data/lib/digital_femsa/models/create_customer_payment_methods_request.rb +105 -0
- data/lib/digital_femsa/models/create_customer_payment_methods_response.rb +54 -0
- data/lib/digital_femsa/models/customer.rb +374 -0
- data/lib/digital_femsa/models/customer_address.rb +301 -0
- data/lib/digital_femsa/models/customer_antifraud_info.rb +223 -0
- data/lib/digital_femsa/models/customer_antifraud_info_response.rb +223 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_data_response.rb +341 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_request.rb +268 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_response.rb +257 -0
- data/lib/digital_femsa/models/customer_info.rb +271 -0
- data/lib/digital_femsa/models/customer_info_just_customer_id.rb +221 -0
- data/lib/digital_femsa/models/customer_info_just_customer_id_response.rb +214 -0
- data/lib/digital_femsa/models/customer_payment_method_request.rb +223 -0
- data/lib/digital_femsa/models/customer_payment_methods_data.rb +54 -0
- data/lib/digital_femsa/models/customer_payment_methods_request.rb +104 -0
- data/lib/digital_femsa/models/customer_payment_methods_response.rb +280 -0
- data/lib/digital_femsa/models/customer_response.rb +425 -0
- data/lib/digital_femsa/models/customer_response_shipping_contacts.rb +257 -0
- data/lib/digital_femsa/models/customer_shipping_contacts.rb +312 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_address.rb +271 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_data_response.rb +366 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_response.rb +328 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_response_address.rb +278 -0
- data/lib/digital_femsa/models/customer_update_fiscal_entities_request.rb +261 -0
- data/lib/digital_femsa/models/customer_update_shipping_contacts.rb +274 -0
- data/lib/digital_femsa/models/customers_response.rb +280 -0
- data/lib/digital_femsa/models/delete_api_keys_response.rb +301 -0
- data/lib/digital_femsa/models/details.rb +216 -0
- data/lib/digital_femsa/models/details_error.rb +242 -0
- data/lib/digital_femsa/models/discount_lines_data_response.rb +333 -0
- data/lib/digital_femsa/models/discount_lines_response.rb +333 -0
- data/lib/digital_femsa/models/email_checkout_request.rb +221 -0
- data/lib/digital_femsa/models/error.rb +253 -0
- data/lib/digital_femsa/models/event_response.rb +301 -0
- data/lib/digital_femsa/models/events_resend_response.rb +281 -0
- data/lib/digital_femsa/models/fiscal_entity_address.rb +312 -0
- data/lib/digital_femsa/models/get_api_keys_response.rb +280 -0
- data/lib/digital_femsa/models/get_charges_response.rb +280 -0
- data/lib/digital_femsa/models/get_companies_response.rb +280 -0
- data/lib/digital_femsa/models/get_customer_payment_method_data_response.rb +54 -0
- data/lib/digital_femsa/models/get_events_response.rb +280 -0
- data/lib/digital_femsa/models/get_order_discount_lines_response.rb +280 -0
- data/lib/digital_femsa/models/get_orders_response.rb +288 -0
- data/lib/digital_femsa/models/get_payment_method_response.rb +280 -0
- data/lib/digital_femsa/models/get_transactions_response.rb +281 -0
- data/lib/digital_femsa/models/get_transfers_response.rb +281 -0
- data/lib/digital_femsa/models/get_webhook_keys_response.rb +280 -0
- data/lib/digital_femsa/models/get_webhooks_response.rb +280 -0
- data/lib/digital_femsa/models/log_response.rb +418 -0
- data/lib/digital_femsa/models/logs_response.rb +261 -0
- data/lib/digital_femsa/models/logs_response_data.rb +396 -0
- data/lib/digital_femsa/models/order_capture_request.rb +241 -0
- data/lib/digital_femsa/models/order_customer_info_response.rb +263 -0
- data/lib/digital_femsa/models/order_discount_lines_request.rb +276 -0
- data/lib/digital_femsa/models/order_fiscal_entity_address_response.rb +328 -0
- data/lib/digital_femsa/models/order_fiscal_entity_request.rb +295 -0
- data/lib/digital_femsa/models/order_fiscal_entity_response.rb +347 -0
- data/lib/digital_femsa/models/order_next_action_response.rb +225 -0
- data/lib/digital_femsa/models/order_next_action_response_redirect_to_url.rb +226 -0
- data/lib/digital_femsa/models/order_refund_request.rb +247 -0
- data/lib/digital_femsa/models/order_request.rb +413 -0
- data/lib/digital_femsa/models/order_request_customer_info.rb +106 -0
- data/lib/digital_femsa/models/order_response.rb +427 -0
- data/lib/digital_femsa/models/order_response_charges.rb +258 -0
- data/lib/digital_femsa/models/order_response_checkout.rb +418 -0
- data/lib/digital_femsa/models/order_response_customer_info.rb +280 -0
- data/lib/digital_femsa/models/order_response_discount_lines.rb +257 -0
- data/lib/digital_femsa/models/order_response_products.rb +280 -0
- data/lib/digital_femsa/models/order_response_shipping_contact.rb +334 -0
- data/lib/digital_femsa/models/order_tax_request.rb +308 -0
- data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb +295 -0
- data/lib/digital_femsa/models/order_update_request.rb +352 -0
- data/lib/digital_femsa/models/order_update_request_customer_info.rb +105 -0
- data/lib/digital_femsa/models/orders_response.rb +223 -0
- data/lib/digital_femsa/models/page.rb +228 -0
- data/lib/digital_femsa/models/pagination.rb +240 -0
- data/lib/digital_femsa/models/payment_method.rb +230 -0
- data/lib/digital_femsa/models/payment_method_cash.rb +312 -0
- data/lib/digital_femsa/models/payment_method_cash_request.rb +238 -0
- data/lib/digital_femsa/models/payment_method_cash_response.rb +330 -0
- data/lib/digital_femsa/models/payment_method_response.rb +278 -0
- data/lib/digital_femsa/models/product.rb +397 -0
- data/lib/digital_femsa/models/product_data_response.rb +431 -0
- data/lib/digital_femsa/models/product_order_response.rb +431 -0
- data/lib/digital_femsa/models/shipping_order_response.rb +336 -0
- data/lib/digital_femsa/models/shipping_request.rb +302 -0
- data/lib/digital_femsa/models/sms_checkout_request.rb +221 -0
- data/lib/digital_femsa/models/transaction_response.rb +412 -0
- data/lib/digital_femsa/models/transfer_destination_response.rb +286 -0
- data/lib/digital_femsa/models/transfer_method_response.rb +286 -0
- data/lib/digital_femsa/models/transfer_response.rb +324 -0
- data/lib/digital_femsa/models/transfers_response.rb +324 -0
- data/lib/digital_femsa/models/update_customer.rb +353 -0
- data/lib/digital_femsa/models/update_customer_antifraud_info.rb +223 -0
- data/lib/digital_femsa/models/update_customer_fiscal_entities_response.rb +341 -0
- data/lib/digital_femsa/models/update_customer_payment_methods_response.rb +54 -0
- data/lib/digital_femsa/models/update_order_discount_lines_request.rb +253 -0
- data/lib/digital_femsa/models/update_order_tax_request.rb +294 -0
- data/lib/digital_femsa/models/update_order_tax_response.rb +349 -0
- data/lib/digital_femsa/models/update_payment_methods.rb +214 -0
- data/lib/digital_femsa/models/update_product.rb +349 -0
- data/lib/digital_femsa/models/webhook_key_create_response.rb +266 -0
- data/lib/digital_femsa/models/webhook_key_delete_response.rb +266 -0
- data/lib/digital_femsa/models/webhook_key_request.rb +217 -0
- data/lib/digital_femsa/models/webhook_key_response.rb +277 -0
- data/lib/digital_femsa/models/webhook_key_update_request.rb +217 -0
- data/lib/digital_femsa/models/webhook_log.rb +289 -0
- data/lib/digital_femsa/models/webhook_request.rb +261 -0
- data/lib/digital_femsa/models/webhook_response.rb +299 -0
- data/lib/digital_femsa/models/webhook_update_request.rb +267 -0
- data/lib/digital_femsa/version.rb +15 -0
- data/lib/digital_femsa.rb +197 -0
- data/lib/ssl_data/ca_bundle.crt +4039 -0
- data/spec/api/api_keys_api_spec.rb +107 -0
- data/spec/api/balances_api_spec.rb +47 -0
- data/spec/api/charges_api_spec.rb +80 -0
- data/spec/api/companies_api_spec.rb +63 -0
- data/spec/api/customers_api_spec.rb +140 -0
- data/spec/api/discounts_api_spec.rb +114 -0
- data/spec/api/events_api_spec.rb +79 -0
- data/spec/api/logs_api_spec.rb +66 -0
- data/spec/api/orders_api_spec.rb +153 -0
- data/spec/api/payment_link_api_spec.rb +119 -0
- data/spec/api/payment_methods_api_spec.rb +99 -0
- data/spec/api/products_api_spec.rb +81 -0
- data/spec/api/shipping_contacts_api_spec.rb +81 -0
- data/spec/api/shippings_api_spec.rb +81 -0
- data/spec/api/taxes_api_spec.rb +81 -0
- data/spec/api/transactions_api_spec.rb +69 -0
- data/spec/api/transfers_api_spec.rb +66 -0
- data/spec/api/webhook_keys_api_spec.rb +104 -0
- data/spec/api/webhooks_api_spec.rb +118 -0
- data/spec/spec_helper.rb +111 -0
- data/ssl_data/ca_bundle.crt +4039 -0
- data/templates/ruby/CUSTOM_VERSION.mustache +1 -0
- data/templates/ruby/api_client.mustache +257 -0
- data/templates/ruby/configuration.mustache +481 -0
- metadata +488 -0
@@ -0,0 +1,24 @@
|
|
1
|
+
# DigitalFemsa::CheckoutOrderTemplate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **currency** | **String** | It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. | |
|
8
|
+
| **customer_info** | [**CheckoutOrderTemplateCustomerInfo**](CheckoutOrderTemplateCustomerInfo.md) | | [optional] |
|
9
|
+
| **line_items** | [**Array<Product>**](Product.md) | They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order. | |
|
10
|
+
| **metadata** | **Hash<String, Object>** | It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'digital_femsa'
|
16
|
+
|
17
|
+
instance = DigitalFemsa::CheckoutOrderTemplate.new(
|
18
|
+
currency: MXN,
|
19
|
+
customer_info: null,
|
20
|
+
line_items: null,
|
21
|
+
metadata: {"key":"value"}
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# DigitalFemsa::CheckoutOrderTemplateCustomerInfo
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'digital_femsa'
|
13
|
+
|
14
|
+
DigitalFemsa::CheckoutOrderTemplateCustomerInfo.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'CustomerInfo',
|
18
|
+
# :'CustomerInfoJustCustomerId'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'digital_femsa'
|
30
|
+
|
31
|
+
DigitalFemsa::CheckoutOrderTemplateCustomerInfo.build(data)
|
32
|
+
# => #<CustomerInfo:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
DigitalFemsa::CheckoutOrderTemplateCustomerInfo.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `CustomerInfo`
|
47
|
+
- `CustomerInfoJustCustomerId`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DigitalFemsa::CheckoutRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link | |
|
8
|
+
| **expires_at** | **Integer** | Unix timestamp of checkout expiration | [optional] |
|
9
|
+
| **failure_url** | **String** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] |
|
10
|
+
| **name** | **String** | Reason for payment | [optional] |
|
11
|
+
| **on_demand_enabled** | **Boolean** | | [optional] |
|
12
|
+
| **success_url** | **String** | Redirection url back to the site in case of successful payment, applies only to HostedPayment | [optional] |
|
13
|
+
| **type** | **String** | This field represents the type of checkout | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'digital_femsa'
|
19
|
+
|
20
|
+
instance = DigitalFemsa::CheckoutRequest.new(
|
21
|
+
allowed_payment_methods: ["cash"],
|
22
|
+
expires_at: null,
|
23
|
+
failure_url: null,
|
24
|
+
name: null,
|
25
|
+
on_demand_enabled: true,
|
26
|
+
success_url: null,
|
27
|
+
type: Integration
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# DigitalFemsa::CheckoutResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **allowed_payment_methods** | **Array<String>** | | [optional] |
|
8
|
+
| **can_not_expire** | **Boolean** | | [optional] |
|
9
|
+
| **emails_sent** | **Integer** | | [optional] |
|
10
|
+
| **expires_at** | **Integer** | | [optional] |
|
11
|
+
| **failure_url** | **String** | | [optional] |
|
12
|
+
| **id** | **String** | | |
|
13
|
+
| **livemode** | **Boolean** | | |
|
14
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
15
|
+
| **name** | **String** | Reason for charge | |
|
16
|
+
| **needs_shipping_contact** | **Boolean** | | [optional] |
|
17
|
+
| **object** | **String** | | |
|
18
|
+
| **paid_payments_count** | **Integer** | | [optional] |
|
19
|
+
| **payments_limit_count** | **Integer** | | [optional] |
|
20
|
+
| **recurrent** | **Boolean** | | [optional] |
|
21
|
+
| **slug** | **String** | | [optional] |
|
22
|
+
| **sms_sent** | **Integer** | | [optional] |
|
23
|
+
| **starts_at** | **Integer** | | [optional] |
|
24
|
+
| **status** | **String** | | [optional] |
|
25
|
+
| **success_url** | **String** | | [optional] |
|
26
|
+
| **type** | **String** | | [optional] |
|
27
|
+
| **url** | **String** | | [optional] |
|
28
|
+
|
29
|
+
## Example
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'digital_femsa'
|
33
|
+
|
34
|
+
instance = DigitalFemsa::CheckoutResponse.new(
|
35
|
+
allowed_payment_methods: ["cash"],
|
36
|
+
can_not_expire: false,
|
37
|
+
emails_sent: 0,
|
38
|
+
expires_at: 1680397724,
|
39
|
+
failure_url: https://pay.femsa.com/failure,
|
40
|
+
id: b0bf16c4-18b9-445e-ba24-01604f329dbf,
|
41
|
+
livemode: true,
|
42
|
+
metadata: {"key":"value"},
|
43
|
+
name: Payment Link Name 1594138857,
|
44
|
+
needs_shipping_contact: false,
|
45
|
+
object: checkout,
|
46
|
+
paid_payments_count: 0,
|
47
|
+
payments_limit_count: 5,
|
48
|
+
recurrent: false,
|
49
|
+
slug: b0bf16c418b9445eba2401604f329dbf,
|
50
|
+
sms_sent: 0,
|
51
|
+
starts_at: 1677650400,
|
52
|
+
status: Issued,
|
53
|
+
success_url: https://pay.femsa.com/success,
|
54
|
+
type: PaymentLink,
|
55
|
+
url: https://pay.femsa.com/link/b0bf16c418b9445eba2401604f329dbf
|
56
|
+
)
|
57
|
+
```
|
58
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DigitalFemsa::CheckoutsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **has_more** | **Boolean** | Indicates if there are more pages to be requested | |
|
8
|
+
| **object** | **String** | Object type, in this case is list | |
|
9
|
+
| **next_page_url** | **String** | URL of the next page. | [optional] |
|
10
|
+
| **previous_page_url** | **String** | Url of the previous page. | [optional] |
|
11
|
+
| **data** | [**Array<CheckoutResponse>**](CheckoutResponse.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'digital_femsa'
|
17
|
+
|
18
|
+
instance = DigitalFemsa::CheckoutsResponse.new(
|
19
|
+
has_more: false,
|
20
|
+
object: list,
|
21
|
+
next_page_url: https://api.femsa.io/resources?limit=10&next=chrg_1,
|
22
|
+
previous_page_url: https://api.femsa.io/resources?limit=10&previous=chrg_1,
|
23
|
+
data: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,159 @@
|
|
1
|
+
# DigitalFemsa::CompaniesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.digitalfemsa.io*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_companies**](CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies |
|
8
|
+
| [**get_company**](CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company |
|
9
|
+
|
10
|
+
|
11
|
+
## get_companies
|
12
|
+
|
13
|
+
> <GetCompaniesResponse> get_companies(opts)
|
14
|
+
|
15
|
+
Get List of Companies
|
16
|
+
|
17
|
+
Consume the list of child companies. This is used for holding companies with several child entities.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'digital_femsa'
|
24
|
+
# setup authorization
|
25
|
+
DigitalFemsa.configure do |config|
|
26
|
+
# Configure Bearer authorization: bearerAuth
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = DigitalFemsa::CompaniesApi.new
|
31
|
+
opts = {
|
32
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
33
|
+
limit: 56, # Integer | The numbers of items to return, the maximum value is 250
|
34
|
+
search: 'search_example', # String | General order search, e.g. by mail, reference etc.
|
35
|
+
_next: '_next_example', # String | next page
|
36
|
+
previous: 'previous_example' # String | previous page
|
37
|
+
}
|
38
|
+
|
39
|
+
begin
|
40
|
+
# Get List of Companies
|
41
|
+
result = api_instance.get_companies(opts)
|
42
|
+
p result
|
43
|
+
rescue DigitalFemsa::ApiError => e
|
44
|
+
puts "Error when calling CompaniesApi->get_companies: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
#### Using the get_companies_with_http_info variant
|
49
|
+
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
51
|
+
|
52
|
+
> <Array(<GetCompaniesResponse>, Integer, Hash)> get_companies_with_http_info(opts)
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
begin
|
56
|
+
# Get List of Companies
|
57
|
+
data, status_code, headers = api_instance.get_companies_with_http_info(opts)
|
58
|
+
p status_code # => 2xx
|
59
|
+
p headers # => { ... }
|
60
|
+
p data # => <GetCompaniesResponse>
|
61
|
+
rescue DigitalFemsa::ApiError => e
|
62
|
+
puts "Error when calling CompaniesApi->get_companies_with_http_info: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
| Name | Type | Description | Notes |
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
70
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
71
|
+
| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
|
72
|
+
| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
|
73
|
+
| **_next** | **String** | next page | [optional] |
|
74
|
+
| **previous** | **String** | previous page | [optional] |
|
75
|
+
|
76
|
+
### Return type
|
77
|
+
|
78
|
+
[**GetCompaniesResponse**](GetCompaniesResponse.md)
|
79
|
+
|
80
|
+
### Authorization
|
81
|
+
|
82
|
+
[bearerAuth](../README.md#bearerAuth)
|
83
|
+
|
84
|
+
### HTTP request headers
|
85
|
+
|
86
|
+
- **Content-Type**: Not defined
|
87
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
88
|
+
|
89
|
+
|
90
|
+
## get_company
|
91
|
+
|
92
|
+
> <CompanyResponse> get_company(id, opts)
|
93
|
+
|
94
|
+
Get Company
|
95
|
+
|
96
|
+
### Examples
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require 'time'
|
100
|
+
require 'digital_femsa'
|
101
|
+
# setup authorization
|
102
|
+
DigitalFemsa.configure do |config|
|
103
|
+
# Configure Bearer authorization: bearerAuth
|
104
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = DigitalFemsa::CompaniesApi.new
|
108
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
109
|
+
opts = {
|
110
|
+
accept_language: 'es' # String | Use for knowing which language to use
|
111
|
+
}
|
112
|
+
|
113
|
+
begin
|
114
|
+
# Get Company
|
115
|
+
result = api_instance.get_company(id, opts)
|
116
|
+
p result
|
117
|
+
rescue DigitalFemsa::ApiError => e
|
118
|
+
puts "Error when calling CompaniesApi->get_company: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
#### Using the get_company_with_http_info variant
|
123
|
+
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
125
|
+
|
126
|
+
> <Array(<CompanyResponse>, Integer, Hash)> get_company_with_http_info(id, opts)
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
# Get Company
|
131
|
+
data, status_code, headers = api_instance.get_company_with_http_info(id, opts)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <CompanyResponse>
|
135
|
+
rescue DigitalFemsa::ApiError => e
|
136
|
+
puts "Error when calling CompaniesApi->get_company_with_http_info: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
### Parameters
|
141
|
+
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **id** | **String** | Identifier of the resource | |
|
145
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
146
|
+
|
147
|
+
### Return type
|
148
|
+
|
149
|
+
[**CompanyResponse**](CompanyResponse.md)
|
150
|
+
|
151
|
+
### Authorization
|
152
|
+
|
153
|
+
[bearerAuth](../README.md#bearerAuth)
|
154
|
+
|
155
|
+
### HTTP request headers
|
156
|
+
|
157
|
+
- **Content-Type**: Not defined
|
158
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
159
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# DigitalFemsa::CompanyFiscalInfoAddressResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | The resource's type | [optional] |
|
8
|
+
| **street1** | **String** | Street Address | [optional] |
|
9
|
+
| **street2** | **String** | Colonia | [optional] |
|
10
|
+
| **city** | **String** | City | [optional] |
|
11
|
+
| **state** | **String** | State | [optional] |
|
12
|
+
| **country** | **String** | Country | [optional] |
|
13
|
+
| **postal_code** | **String** | Postal code | [optional] |
|
14
|
+
| **external_number** | **String** | Street number | [optional] |
|
15
|
+
| **internal_number** | **String** | Unit / apartment number | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'digital_femsa'
|
21
|
+
|
22
|
+
instance = DigitalFemsa::CompanyFiscalInfoAddressResponse.new(
|
23
|
+
object: null,
|
24
|
+
street1: Calle 13,
|
25
|
+
street2: Navarte,
|
26
|
+
city: Cuauhtémoc,
|
27
|
+
state: Ciudad de México,
|
28
|
+
country: MX,
|
29
|
+
postal_code: 3072,
|
30
|
+
external_number: 123,
|
31
|
+
internal_number: 123
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DigitalFemsa::CompanyFiscalInfoResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | The resource's type | [optional] |
|
8
|
+
| **tax_id** | **String** | Tax ID of the company | [optional] |
|
9
|
+
| **legal_entity_name** | **String** | Legal name of the company | [optional] |
|
10
|
+
| **business_type** | **String** | Business type of the company | [optional] |
|
11
|
+
| **phone** | **String** | Phone number of the company | [optional] |
|
12
|
+
| **physical_person_business_type** | **String** | Business type if 'persona_fisica' | [optional] |
|
13
|
+
| **address** | [**CompanyFiscalInfoAddressResponse**](CompanyFiscalInfoAddressResponse.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'digital_femsa'
|
19
|
+
|
20
|
+
instance = DigitalFemsa::CompanyFiscalInfoResponse.new(
|
21
|
+
object: null,
|
22
|
+
tax_id: XAXX010101000,
|
23
|
+
legal_entity_name: Child Company A,
|
24
|
+
business_type: persona_moral,
|
25
|
+
phone: 5555555555,
|
26
|
+
physical_person_business_type: null,
|
27
|
+
address: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# DigitalFemsa::CompanyPayoutDestinationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | The resource's type | [optional] |
|
8
|
+
| **currency** | **String** | currency of the receiving account | [optional] |
|
9
|
+
| **account_holder_name** | **String** | Name of the account holder | [optional] |
|
10
|
+
| **bank** | **String** | Name of the bank | [optional] |
|
11
|
+
| **type** | **String** | Type of the payout destination | [optional] |
|
12
|
+
| **account_number** | **String** | Account number of the receiving account | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'digital_femsa'
|
18
|
+
|
19
|
+
instance = DigitalFemsa::CompanyPayoutDestinationResponse.new(
|
20
|
+
object: null,
|
21
|
+
currency: MXN,
|
22
|
+
account_holder_name: Child Company A,
|
23
|
+
bank: BBVA,
|
24
|
+
type: null,
|
25
|
+
account_number: 123456789012345678
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# DigitalFemsa::CompanyResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The child company's unique identifier | [optional] |
|
8
|
+
| **created_at** | **Integer** | The resource's creation date (unix timestamp) | [optional] |
|
9
|
+
| **name** | **String** | The child company's name | [optional] |
|
10
|
+
| **object** | **String** | The resource's type | [optional] |
|
11
|
+
| **parent_company_id** | **String** | Id of the parent company | [optional] |
|
12
|
+
| **use_parent_fiscal_data** | **Boolean** | Whether the parent company's fiscal data is to be used for liquidation and tax purposes | [optional] |
|
13
|
+
| **payout_destination** | [**CompanyPayoutDestinationResponse**](CompanyPayoutDestinationResponse.md) | | [optional] |
|
14
|
+
| **fiscal_info** | [**CompanyFiscalInfoResponse**](CompanyFiscalInfoResponse.md) | | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'digital_femsa'
|
20
|
+
|
21
|
+
instance = DigitalFemsa::CompanyResponse.new(
|
22
|
+
id: 6441bb27659a060465da7335,
|
23
|
+
created_at: 1680397724,
|
24
|
+
name: Child Company A,
|
25
|
+
object: null,
|
26
|
+
parent_company_id: 6441bb3c62db5812e7920c31,
|
27
|
+
use_parent_fiscal_data: false,
|
28
|
+
payout_destination: null,
|
29
|
+
fiscal_info: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# DigitalFemsa::CreateCustomerFiscalEntitiesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **address** | [**CustomerAddress**](CustomerAddress.md) | | |
|
8
|
+
| **tax_id** | **String** | | [optional] |
|
9
|
+
| **email** | **String** | | [optional] |
|
10
|
+
| **phone** | **String** | | [optional] |
|
11
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
12
|
+
| **company_name** | **String** | | [optional] |
|
13
|
+
| **id** | **String** | | |
|
14
|
+
| **object** | **String** | | |
|
15
|
+
| **created_at** | **Integer** | | |
|
16
|
+
| **parent_id** | **String** | | [optional] |
|
17
|
+
| **default** | **Boolean** | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'digital_femsa'
|
23
|
+
|
24
|
+
instance = DigitalFemsa::CreateCustomerFiscalEntitiesResponse.new(
|
25
|
+
address: null,
|
26
|
+
tax_id: null,
|
27
|
+
email: null,
|
28
|
+
phone: null,
|
29
|
+
metadata: null,
|
30
|
+
company_name: Femsa,
|
31
|
+
id: ship_cont_2tKZsTYcsryyu7Ah8,
|
32
|
+
object: shipping_contact,
|
33
|
+
created_at: 1675715413,
|
34
|
+
parent_id: cus_2tKcHxhTz7xU5SymF,
|
35
|
+
default: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# DigitalFemsa::CreateCustomerPaymentMethodsRequest
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'digital_femsa'
|
13
|
+
|
14
|
+
DigitalFemsa::CreateCustomerPaymentMethodsRequest.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'PaymentMethodCashRequest'
|
18
|
+
# ]
|
19
|
+
```
|
20
|
+
|
21
|
+
### build
|
22
|
+
|
23
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
24
|
+
|
25
|
+
#### Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'digital_femsa'
|
29
|
+
|
30
|
+
DigitalFemsa::CreateCustomerPaymentMethodsRequest.build(data)
|
31
|
+
# => #<PaymentMethodCashRequest:0x00007fdd4aab02a0>
|
32
|
+
|
33
|
+
DigitalFemsa::CreateCustomerPaymentMethodsRequest.build(data_that_doesnt_match)
|
34
|
+
# => nil
|
35
|
+
```
|
36
|
+
|
37
|
+
#### Parameters
|
38
|
+
|
39
|
+
| Name | Type | Description |
|
40
|
+
| ---- | ---- | ----------- |
|
41
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
42
|
+
|
43
|
+
#### Return type
|
44
|
+
|
45
|
+
- `PaymentMethodCashRequest`
|
46
|
+
- `nil` (if no type matches)
|
47
|
+
|
@@ -0,0 +1,77 @@
|
|
1
|
+
# DigitalFemsa::CreateCustomerPaymentMethodsResponse
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'digital_femsa'
|
13
|
+
|
14
|
+
DigitalFemsa::CreateCustomerPaymentMethodsResponse.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'PaymentMethodCashResponse'
|
18
|
+
# ]
|
19
|
+
```
|
20
|
+
|
21
|
+
### `openapi_discriminator_name`
|
22
|
+
|
23
|
+
Returns the discriminator's property name.
|
24
|
+
|
25
|
+
#### Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'digital_femsa'
|
29
|
+
|
30
|
+
DigitalFemsa::CreateCustomerPaymentMethodsResponse.openapi_discriminator_name
|
31
|
+
# => :'type'
|
32
|
+
```
|
33
|
+
|
34
|
+
### `openapi_discriminator_name`
|
35
|
+
|
36
|
+
Returns the discriminator's mapping.
|
37
|
+
|
38
|
+
#### Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
require 'digital_femsa'
|
42
|
+
|
43
|
+
DigitalFemsa::CreateCustomerPaymentMethodsResponse.openapi_discriminator_mapping
|
44
|
+
# =>
|
45
|
+
# {
|
46
|
+
# :'cash' => :'PaymentMethodCashResponse',
|
47
|
+
# :'oxxo_recurrent' => :'PaymentMethodCashResponse'
|
48
|
+
# }
|
49
|
+
```
|
50
|
+
|
51
|
+
### build
|
52
|
+
|
53
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
54
|
+
|
55
|
+
#### Example
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
require 'digital_femsa'
|
59
|
+
|
60
|
+
DigitalFemsa::CreateCustomerPaymentMethodsResponse.build(data)
|
61
|
+
# => #<PaymentMethodCashResponse:0x00007fdd4aab02a0>
|
62
|
+
|
63
|
+
DigitalFemsa::CreateCustomerPaymentMethodsResponse.build(data_that_doesnt_match)
|
64
|
+
# => nil
|
65
|
+
```
|
66
|
+
|
67
|
+
#### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description |
|
70
|
+
| ---- | ---- | ----------- |
|
71
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
72
|
+
|
73
|
+
#### Return type
|
74
|
+
|
75
|
+
- `PaymentMethodCashResponse`
|
76
|
+
- `nil` (if no type matches)
|
77
|
+
|
data/docs/Customer.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# DigitalFemsa::Customer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **antifraud_info** | [**CustomerAntifraudInfo**](CustomerAntifraudInfo.md) | | [optional] |
|
8
|
+
| **corporate** | **Boolean** | It is a value that allows identifying if the email is corporate or not. | [optional][default to false] |
|
9
|
+
| **custom_reference** | **String** | It is an undefined value. | [optional] |
|
10
|
+
| **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). | |
|
11
|
+
| **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] |
|
12
|
+
| **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] |
|
13
|
+
| **fiscal_entities** | [**Array<CustomerFiscalEntitiesRequest>**](CustomerFiscalEntitiesRequest.md) | | [optional] |
|
14
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
15
|
+
| **name** | **String** | Client's name | |
|
16
|
+
| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Femsa | [optional] |
|
17
|
+
| **phone** | **String** | Is the customer's phone number | |
|
18
|
+
| **shipping_contacts** | [**Array<CustomerShippingContacts>**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Femsa | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'digital_femsa'
|
24
|
+
|
25
|
+
instance = DigitalFemsa::Customer.new(
|
26
|
+
antifraud_info: null,
|
27
|
+
corporate: false,
|
28
|
+
custom_reference: null,
|
29
|
+
email: miguel@gmail.com,
|
30
|
+
default_payment_source_id: src_1a2b3c4d5e6f7g8h,
|
31
|
+
default_shipping_contact_id: ship_cont_1a2b3c4d5e6f7g8h,
|
32
|
+
fiscal_entities: null,
|
33
|
+
metadata: null,
|
34
|
+
name: miguel,
|
35
|
+
payment_sources: null,
|
36
|
+
phone: +5215555555555,
|
37
|
+
shipping_contacts: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|