digital_femsa 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,327 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethodsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.digitalfemsa.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_customer_payment_methods**](PaymentMethodsApi.md#create_customer_payment_methods) | **POST** /customers/{id}/payment_sources | Create Payment Method |
|
|
8
|
+
| [**delete_customer_payment_methods**](PaymentMethodsApi.md#delete_customer_payment_methods) | **DELETE** /customers/{id}/payment_sources/{payment_method_id} | Delete Payment Method |
|
|
9
|
+
| [**get_customer_payment_methods**](PaymentMethodsApi.md#get_customer_payment_methods) | **GET** /customers/{id}/payment_sources | Get Payment Methods |
|
|
10
|
+
| [**update_customer_payment_methods**](PaymentMethodsApi.md#update_customer_payment_methods) | **PUT** /customers/{id}/payment_sources/{payment_method_id} | Update Payment Method |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## create_customer_payment_methods
|
|
14
|
+
|
|
15
|
+
> <CreateCustomerPaymentMethodsResponse> create_customer_payment_methods(id, create_customer_payment_methods_request, opts)
|
|
16
|
+
|
|
17
|
+
Create Payment Method
|
|
18
|
+
|
|
19
|
+
Create a payment method for a customer.
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'digital_femsa'
|
|
26
|
+
# setup authorization
|
|
27
|
+
DigitalFemsa.configure do |config|
|
|
28
|
+
# Configure Bearer authorization: bearerAuth
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = DigitalFemsa::PaymentMethodsApi.new
|
|
33
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
34
|
+
create_customer_payment_methods_request = DigitalFemsa::PaymentMethodCashRequest.new({type: 'cash'}) # CreateCustomerPaymentMethodsRequest | requested field for customer payment methods
|
|
35
|
+
opts = {
|
|
36
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
37
|
+
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.
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Create Payment Method
|
|
42
|
+
result = api_instance.create_customer_payment_methods(id, create_customer_payment_methods_request, opts)
|
|
43
|
+
p result
|
|
44
|
+
rescue DigitalFemsa::ApiError => e
|
|
45
|
+
puts "Error when calling PaymentMethodsApi->create_customer_payment_methods: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Using the create_customer_payment_methods_with_http_info variant
|
|
50
|
+
|
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
|
52
|
+
|
|
53
|
+
> <Array(<CreateCustomerPaymentMethodsResponse>, Integer, Hash)> create_customer_payment_methods_with_http_info(id, create_customer_payment_methods_request, opts)
|
|
54
|
+
|
|
55
|
+
```ruby
|
|
56
|
+
begin
|
|
57
|
+
# Create Payment Method
|
|
58
|
+
data, status_code, headers = api_instance.create_customer_payment_methods_with_http_info(id, create_customer_payment_methods_request, opts)
|
|
59
|
+
p status_code # => 2xx
|
|
60
|
+
p headers # => { ... }
|
|
61
|
+
p data # => <CreateCustomerPaymentMethodsResponse>
|
|
62
|
+
rescue DigitalFemsa::ApiError => e
|
|
63
|
+
puts "Error when calling PaymentMethodsApi->create_customer_payment_methods_with_http_info: #{e}"
|
|
64
|
+
end
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
| Name | Type | Description | Notes |
|
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
|
71
|
+
| **id** | **String** | Identifier of the resource | |
|
|
72
|
+
| **create_customer_payment_methods_request** | [**CreateCustomerPaymentMethodsRequest**](CreateCustomerPaymentMethodsRequest.md) | requested field for customer payment methods | |
|
|
73
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
74
|
+
| **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] |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
[**CreateCustomerPaymentMethodsResponse**](CreateCustomerPaymentMethodsResponse.md)
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: application/json
|
|
87
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
## delete_customer_payment_methods
|
|
91
|
+
|
|
92
|
+
> <UpdateCustomerPaymentMethodsResponse> delete_customer_payment_methods(id, payment_method_id, opts)
|
|
93
|
+
|
|
94
|
+
Delete Payment Method
|
|
95
|
+
|
|
96
|
+
Delete an existing payment method
|
|
97
|
+
|
|
98
|
+
### Examples
|
|
99
|
+
|
|
100
|
+
```ruby
|
|
101
|
+
require 'time'
|
|
102
|
+
require 'digital_femsa'
|
|
103
|
+
# setup authorization
|
|
104
|
+
DigitalFemsa.configure do |config|
|
|
105
|
+
# Configure Bearer authorization: bearerAuth
|
|
106
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = DigitalFemsa::PaymentMethodsApi.new
|
|
110
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
111
|
+
payment_method_id = 'src_2tQ974hSHcsdeSZHG' # String | Identifier of the payment method
|
|
112
|
+
opts = {
|
|
113
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
114
|
+
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.
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
begin
|
|
118
|
+
# Delete Payment Method
|
|
119
|
+
result = api_instance.delete_customer_payment_methods(id, payment_method_id, opts)
|
|
120
|
+
p result
|
|
121
|
+
rescue DigitalFemsa::ApiError => e
|
|
122
|
+
puts "Error when calling PaymentMethodsApi->delete_customer_payment_methods: #{e}"
|
|
123
|
+
end
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
#### Using the delete_customer_payment_methods_with_http_info variant
|
|
127
|
+
|
|
128
|
+
This returns an Array which contains the response data, status code and headers.
|
|
129
|
+
|
|
130
|
+
> <Array(<UpdateCustomerPaymentMethodsResponse>, Integer, Hash)> delete_customer_payment_methods_with_http_info(id, payment_method_id, opts)
|
|
131
|
+
|
|
132
|
+
```ruby
|
|
133
|
+
begin
|
|
134
|
+
# Delete Payment Method
|
|
135
|
+
data, status_code, headers = api_instance.delete_customer_payment_methods_with_http_info(id, payment_method_id, opts)
|
|
136
|
+
p status_code # => 2xx
|
|
137
|
+
p headers # => { ... }
|
|
138
|
+
p data # => <UpdateCustomerPaymentMethodsResponse>
|
|
139
|
+
rescue DigitalFemsa::ApiError => e
|
|
140
|
+
puts "Error when calling PaymentMethodsApi->delete_customer_payment_methods_with_http_info: #{e}"
|
|
141
|
+
end
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
| Name | Type | Description | Notes |
|
|
147
|
+
| ---- | ---- | ----------- | ----- |
|
|
148
|
+
| **id** | **String** | Identifier of the resource | |
|
|
149
|
+
| **payment_method_id** | **String** | Identifier of the payment method | |
|
|
150
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
151
|
+
| **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] |
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
[**UpdateCustomerPaymentMethodsResponse**](UpdateCustomerPaymentMethodsResponse.md)
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: Not defined
|
|
164
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
## get_customer_payment_methods
|
|
168
|
+
|
|
169
|
+
> <GetPaymentMethodResponse> get_customer_payment_methods(id, opts)
|
|
170
|
+
|
|
171
|
+
Get Payment Methods
|
|
172
|
+
|
|
173
|
+
Get a list of Payment Methods
|
|
174
|
+
|
|
175
|
+
### Examples
|
|
176
|
+
|
|
177
|
+
```ruby
|
|
178
|
+
require 'time'
|
|
179
|
+
require 'digital_femsa'
|
|
180
|
+
# setup authorization
|
|
181
|
+
DigitalFemsa.configure do |config|
|
|
182
|
+
# Configure Bearer authorization: bearerAuth
|
|
183
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
api_instance = DigitalFemsa::PaymentMethodsApi.new
|
|
187
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
188
|
+
opts = {
|
|
189
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
190
|
+
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.
|
|
191
|
+
limit: 56, # Integer | The numbers of items to return, the maximum value is 250
|
|
192
|
+
_next: '_next_example', # String | next page
|
|
193
|
+
previous: 'previous_example', # String | previous page
|
|
194
|
+
search: 'search_example' # String | General order search, e.g. by mail, reference etc.
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
begin
|
|
198
|
+
# Get Payment Methods
|
|
199
|
+
result = api_instance.get_customer_payment_methods(id, opts)
|
|
200
|
+
p result
|
|
201
|
+
rescue DigitalFemsa::ApiError => e
|
|
202
|
+
puts "Error when calling PaymentMethodsApi->get_customer_payment_methods: #{e}"
|
|
203
|
+
end
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
#### Using the get_customer_payment_methods_with_http_info variant
|
|
207
|
+
|
|
208
|
+
This returns an Array which contains the response data, status code and headers.
|
|
209
|
+
|
|
210
|
+
> <Array(<GetPaymentMethodResponse>, Integer, Hash)> get_customer_payment_methods_with_http_info(id, opts)
|
|
211
|
+
|
|
212
|
+
```ruby
|
|
213
|
+
begin
|
|
214
|
+
# Get Payment Methods
|
|
215
|
+
data, status_code, headers = api_instance.get_customer_payment_methods_with_http_info(id, opts)
|
|
216
|
+
p status_code # => 2xx
|
|
217
|
+
p headers # => { ... }
|
|
218
|
+
p data # => <GetPaymentMethodResponse>
|
|
219
|
+
rescue DigitalFemsa::ApiError => e
|
|
220
|
+
puts "Error when calling PaymentMethodsApi->get_customer_payment_methods_with_http_info: #{e}"
|
|
221
|
+
end
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Parameters
|
|
225
|
+
|
|
226
|
+
| Name | Type | Description | Notes |
|
|
227
|
+
| ---- | ---- | ----------- | ----- |
|
|
228
|
+
| **id** | **String** | Identifier of the resource | |
|
|
229
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
230
|
+
| **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] |
|
|
231
|
+
| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
|
|
232
|
+
| **_next** | **String** | next page | [optional] |
|
|
233
|
+
| **previous** | **String** | previous page | [optional] |
|
|
234
|
+
| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
|
|
235
|
+
|
|
236
|
+
### Return type
|
|
237
|
+
|
|
238
|
+
[**GetPaymentMethodResponse**](GetPaymentMethodResponse.md)
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
243
|
+
|
|
244
|
+
### HTTP request headers
|
|
245
|
+
|
|
246
|
+
- **Content-Type**: Not defined
|
|
247
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
## update_customer_payment_methods
|
|
251
|
+
|
|
252
|
+
> <UpdateCustomerPaymentMethodsResponse> update_customer_payment_methods(id, payment_method_id, update_payment_methods, opts)
|
|
253
|
+
|
|
254
|
+
Update Payment Method
|
|
255
|
+
|
|
256
|
+
Gets a payment Method that corresponds to a customer ID.
|
|
257
|
+
|
|
258
|
+
### Examples
|
|
259
|
+
|
|
260
|
+
```ruby
|
|
261
|
+
require 'time'
|
|
262
|
+
require 'digital_femsa'
|
|
263
|
+
# setup authorization
|
|
264
|
+
DigitalFemsa.configure do |config|
|
|
265
|
+
# Configure Bearer authorization: bearerAuth
|
|
266
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
api_instance = DigitalFemsa::PaymentMethodsApi.new
|
|
270
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
271
|
+
payment_method_id = 'src_2tQ974hSHcsdeSZHG' # String | Identifier of the payment method
|
|
272
|
+
update_payment_methods = DigitalFemsa::UpdatePaymentMethods.new # UpdatePaymentMethods | requested field for customer payment methods
|
|
273
|
+
opts = {
|
|
274
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
275
|
+
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.
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
begin
|
|
279
|
+
# Update Payment Method
|
|
280
|
+
result = api_instance.update_customer_payment_methods(id, payment_method_id, update_payment_methods, opts)
|
|
281
|
+
p result
|
|
282
|
+
rescue DigitalFemsa::ApiError => e
|
|
283
|
+
puts "Error when calling PaymentMethodsApi->update_customer_payment_methods: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
#### Using the update_customer_payment_methods_with_http_info variant
|
|
288
|
+
|
|
289
|
+
This returns an Array which contains the response data, status code and headers.
|
|
290
|
+
|
|
291
|
+
> <Array(<UpdateCustomerPaymentMethodsResponse>, Integer, Hash)> update_customer_payment_methods_with_http_info(id, payment_method_id, update_payment_methods, opts)
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
begin
|
|
295
|
+
# Update Payment Method
|
|
296
|
+
data, status_code, headers = api_instance.update_customer_payment_methods_with_http_info(id, payment_method_id, update_payment_methods, opts)
|
|
297
|
+
p status_code # => 2xx
|
|
298
|
+
p headers # => { ... }
|
|
299
|
+
p data # => <UpdateCustomerPaymentMethodsResponse>
|
|
300
|
+
rescue DigitalFemsa::ApiError => e
|
|
301
|
+
puts "Error when calling PaymentMethodsApi->update_customer_payment_methods_with_http_info: #{e}"
|
|
302
|
+
end
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
### Parameters
|
|
306
|
+
|
|
307
|
+
| Name | Type | Description | Notes |
|
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
|
309
|
+
| **id** | **String** | Identifier of the resource | |
|
|
310
|
+
| **payment_method_id** | **String** | Identifier of the payment method | |
|
|
311
|
+
| **update_payment_methods** | [**UpdatePaymentMethods**](UpdatePaymentMethods.md) | requested field for customer payment methods | |
|
|
312
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
313
|
+
| **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] |
|
|
314
|
+
|
|
315
|
+
### Return type
|
|
316
|
+
|
|
317
|
+
[**UpdateCustomerPaymentMethodsResponse**](UpdateCustomerPaymentMethodsResponse.md)
|
|
318
|
+
|
|
319
|
+
### Authorization
|
|
320
|
+
|
|
321
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
322
|
+
|
|
323
|
+
### HTTP request headers
|
|
324
|
+
|
|
325
|
+
- **Content-Type**: application/json
|
|
326
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
327
|
+
|
data/docs/Product.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# DigitalFemsa::Product
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **antifraud_info** | **Hash<String, Object>** | | [optional] |
|
|
8
|
+
| **brand** | **String** | The brand of the item. | [optional] |
|
|
9
|
+
| **description** | **String** | Short description of the item | [optional] |
|
|
10
|
+
| **metadata** | **Hash<String, String>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the item. It will be displayed in the order. | |
|
|
12
|
+
| **quantity** | **Integer** | The quantity of the item in the order. | |
|
|
13
|
+
| **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
|
|
14
|
+
| **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] |
|
|
15
|
+
| **unit_price** | **Integer** | The price of the item in cents. | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'digital_femsa'
|
|
21
|
+
|
|
22
|
+
instance = DigitalFemsa::Product.new(
|
|
23
|
+
antifraud_info: {"key":"value"},
|
|
24
|
+
brand: Cohiba,
|
|
25
|
+
description: Imported From Mex.,
|
|
26
|
+
metadata: {"key":"value"},
|
|
27
|
+
name: Box of Cohiba S1s,
|
|
28
|
+
quantity: 1,
|
|
29
|
+
sku: XYZ12345,
|
|
30
|
+
tags: ["food","mexican food"],
|
|
31
|
+
unit_price: 20000
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# DigitalFemsa::ProductDataResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **antifraud_info** | **Hash<String, Object>** | | [optional] |
|
|
8
|
+
| **brand** | **String** | The brand of the item. | [optional] |
|
|
9
|
+
| **description** | **String** | Short description of the item | [optional] |
|
|
10
|
+
| **metadata** | **Hash<String, String>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the item. It will be displayed in the order. | |
|
|
12
|
+
| **quantity** | **Integer** | The quantity of the item in the order. | |
|
|
13
|
+
| **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
|
|
14
|
+
| **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] |
|
|
15
|
+
| **unit_price** | **Integer** | The price of the item in cents. | |
|
|
16
|
+
| **id** | **String** | | [optional] |
|
|
17
|
+
| **object** | **String** | | [optional] |
|
|
18
|
+
| **parent_id** | **String** | | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'digital_femsa'
|
|
24
|
+
|
|
25
|
+
instance = DigitalFemsa::ProductDataResponse.new(
|
|
26
|
+
antifraud_info: {key=value},
|
|
27
|
+
brand: Cohiba,
|
|
28
|
+
description: Imported From Mex.,
|
|
29
|
+
metadata: {key=value},
|
|
30
|
+
name: Box of Cohiba S1s,
|
|
31
|
+
quantity: 1,
|
|
32
|
+
sku: XYZ12345,
|
|
33
|
+
tags: [food, mexican food],
|
|
34
|
+
unit_price: 20000,
|
|
35
|
+
id: null,
|
|
36
|
+
object: null,
|
|
37
|
+
parent_id: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# DigitalFemsa::ProductOrderResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **antifraud_info** | **Hash<String, Object>** | | [optional] |
|
|
8
|
+
| **brand** | **String** | The brand of the item. | [optional] |
|
|
9
|
+
| **description** | **String** | Short description of the item | [optional] |
|
|
10
|
+
| **metadata** | **Hash<String, String>** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the item. It will be displayed in the order. | |
|
|
12
|
+
| **quantity** | **Integer** | The quantity of the item in the order. | |
|
|
13
|
+
| **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
|
|
14
|
+
| **tags** | **Array<String>** | List of tags for the item. It is used to identify the item in the order. | [optional] |
|
|
15
|
+
| **unit_price** | **Integer** | The price of the item in cents. | |
|
|
16
|
+
| **id** | **String** | | [optional] |
|
|
17
|
+
| **object** | **String** | | [optional] |
|
|
18
|
+
| **parent_id** | **String** | | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'digital_femsa'
|
|
24
|
+
|
|
25
|
+
instance = DigitalFemsa::ProductOrderResponse.new(
|
|
26
|
+
antifraud_info: {key=value},
|
|
27
|
+
brand: Cohiba,
|
|
28
|
+
description: Imported From Mex.,
|
|
29
|
+
metadata: {key=value},
|
|
30
|
+
name: Box of Cohiba S1s,
|
|
31
|
+
quantity: 1,
|
|
32
|
+
sku: XYZ12345,
|
|
33
|
+
tags: [food, mexican food],
|
|
34
|
+
unit_price: 20000,
|
|
35
|
+
id: null,
|
|
36
|
+
object: null,
|
|
37
|
+
parent_id: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
data/docs/ProductsApi.md
ADDED
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# DigitalFemsa::ProductsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.digitalfemsa.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**orders_create_product**](ProductsApi.md#orders_create_product) | **POST** /orders/{id}/line_items | Create Product |
|
|
8
|
+
| [**orders_delete_product**](ProductsApi.md#orders_delete_product) | **DELETE** /orders/{id}/line_items/{line_item_id} | Delete Product |
|
|
9
|
+
| [**orders_update_product**](ProductsApi.md#orders_update_product) | **PUT** /orders/{id}/line_items/{line_item_id} | Update Product |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## orders_create_product
|
|
13
|
+
|
|
14
|
+
> <ProductOrderResponse> orders_create_product(id, product, opts)
|
|
15
|
+
|
|
16
|
+
Create Product
|
|
17
|
+
|
|
18
|
+
Create a new product for an existing order.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'digital_femsa'
|
|
25
|
+
# setup authorization
|
|
26
|
+
DigitalFemsa.configure do |config|
|
|
27
|
+
# Configure Bearer authorization: bearerAuth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = DigitalFemsa::ProductsApi.new
|
|
32
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
33
|
+
product = DigitalFemsa::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000}) # Product | requested field for a product
|
|
34
|
+
opts = {
|
|
35
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
36
|
+
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.
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Create Product
|
|
41
|
+
result = api_instance.orders_create_product(id, product, opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue DigitalFemsa::ApiError => e
|
|
44
|
+
puts "Error when calling ProductsApi->orders_create_product: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the orders_create_product_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<ProductOrderResponse>, Integer, Hash)> orders_create_product_with_http_info(id, product, opts)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# Create Product
|
|
57
|
+
data, status_code, headers = api_instance.orders_create_product_with_http_info(id, product, opts)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <ProductOrderResponse>
|
|
61
|
+
rescue DigitalFemsa::ApiError => e
|
|
62
|
+
puts "Error when calling ProductsApi->orders_create_product_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **id** | **String** | Identifier of the resource | |
|
|
71
|
+
| **product** | [**Product**](Product.md) | requested field for a product | |
|
|
72
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
73
|
+
| **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] |
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
[**ProductOrderResponse**](ProductOrderResponse.md)
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## orders_delete_product
|
|
90
|
+
|
|
91
|
+
> <ProductOrderResponse> orders_delete_product(id, line_item_id, opts)
|
|
92
|
+
|
|
93
|
+
Delete Product
|
|
94
|
+
|
|
95
|
+
Delete product for an existing orden
|
|
96
|
+
|
|
97
|
+
### Examples
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
require 'time'
|
|
101
|
+
require 'digital_femsa'
|
|
102
|
+
# setup authorization
|
|
103
|
+
DigitalFemsa.configure do |config|
|
|
104
|
+
# Configure Bearer authorization: bearerAuth
|
|
105
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
api_instance = DigitalFemsa::ProductsApi.new
|
|
109
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
110
|
+
line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
|
|
111
|
+
opts = {
|
|
112
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
113
|
+
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.
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
# Delete Product
|
|
118
|
+
result = api_instance.orders_delete_product(id, line_item_id, opts)
|
|
119
|
+
p result
|
|
120
|
+
rescue DigitalFemsa::ApiError => e
|
|
121
|
+
puts "Error when calling ProductsApi->orders_delete_product: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### Using the orders_delete_product_with_http_info variant
|
|
126
|
+
|
|
127
|
+
This returns an Array which contains the response data, status code and headers.
|
|
128
|
+
|
|
129
|
+
> <Array(<ProductOrderResponse>, Integer, Hash)> orders_delete_product_with_http_info(id, line_item_id, opts)
|
|
130
|
+
|
|
131
|
+
```ruby
|
|
132
|
+
begin
|
|
133
|
+
# Delete Product
|
|
134
|
+
data, status_code, headers = api_instance.orders_delete_product_with_http_info(id, line_item_id, opts)
|
|
135
|
+
p status_code # => 2xx
|
|
136
|
+
p headers # => { ... }
|
|
137
|
+
p data # => <ProductOrderResponse>
|
|
138
|
+
rescue DigitalFemsa::ApiError => e
|
|
139
|
+
puts "Error when calling ProductsApi->orders_delete_product_with_http_info: #{e}"
|
|
140
|
+
end
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
| Name | Type | Description | Notes |
|
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
|
147
|
+
| **id** | **String** | Identifier of the resource | |
|
|
148
|
+
| **line_item_id** | **String** | identifier | |
|
|
149
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
150
|
+
| **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] |
|
|
151
|
+
|
|
152
|
+
### Return type
|
|
153
|
+
|
|
154
|
+
[**ProductOrderResponse**](ProductOrderResponse.md)
|
|
155
|
+
|
|
156
|
+
### Authorization
|
|
157
|
+
|
|
158
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
159
|
+
|
|
160
|
+
### HTTP request headers
|
|
161
|
+
|
|
162
|
+
- **Content-Type**: Not defined
|
|
163
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
## orders_update_product
|
|
167
|
+
|
|
168
|
+
> <ProductOrderResponse> orders_update_product(id, line_item_id, update_product, opts)
|
|
169
|
+
|
|
170
|
+
Update Product
|
|
171
|
+
|
|
172
|
+
Update an existing product for an existing orden
|
|
173
|
+
|
|
174
|
+
### Examples
|
|
175
|
+
|
|
176
|
+
```ruby
|
|
177
|
+
require 'time'
|
|
178
|
+
require 'digital_femsa'
|
|
179
|
+
# setup authorization
|
|
180
|
+
DigitalFemsa.configure do |config|
|
|
181
|
+
# Configure Bearer authorization: bearerAuth
|
|
182
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
api_instance = DigitalFemsa::ProductsApi.new
|
|
186
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
187
|
+
line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
|
|
188
|
+
update_product = DigitalFemsa::UpdateProduct.new # UpdateProduct | requested field for products
|
|
189
|
+
opts = {
|
|
190
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
191
|
+
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.
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
# Update Product
|
|
196
|
+
result = api_instance.orders_update_product(id, line_item_id, update_product, opts)
|
|
197
|
+
p result
|
|
198
|
+
rescue DigitalFemsa::ApiError => e
|
|
199
|
+
puts "Error when calling ProductsApi->orders_update_product: #{e}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
#### Using the orders_update_product_with_http_info variant
|
|
204
|
+
|
|
205
|
+
This returns an Array which contains the response data, status code and headers.
|
|
206
|
+
|
|
207
|
+
> <Array(<ProductOrderResponse>, Integer, Hash)> orders_update_product_with_http_info(id, line_item_id, update_product, opts)
|
|
208
|
+
|
|
209
|
+
```ruby
|
|
210
|
+
begin
|
|
211
|
+
# Update Product
|
|
212
|
+
data, status_code, headers = api_instance.orders_update_product_with_http_info(id, line_item_id, update_product, opts)
|
|
213
|
+
p status_code # => 2xx
|
|
214
|
+
p headers # => { ... }
|
|
215
|
+
p data # => <ProductOrderResponse>
|
|
216
|
+
rescue DigitalFemsa::ApiError => e
|
|
217
|
+
puts "Error when calling ProductsApi->orders_update_product_with_http_info: #{e}"
|
|
218
|
+
end
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Parameters
|
|
222
|
+
|
|
223
|
+
| Name | Type | Description | Notes |
|
|
224
|
+
| ---- | ---- | ----------- | ----- |
|
|
225
|
+
| **id** | **String** | Identifier of the resource | |
|
|
226
|
+
| **line_item_id** | **String** | identifier | |
|
|
227
|
+
| **update_product** | [**UpdateProduct**](UpdateProduct.md) | requested field for products | |
|
|
228
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
229
|
+
| **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] |
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
[**ProductOrderResponse**](ProductOrderResponse.md)
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: application/json
|
|
242
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
243
|
+
|