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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 3f99b6ab0fac8e9d787c5eb1b55bb747b831a49e3049d2d024e3ad556ff378fe
|
4
|
+
data.tar.gz: b6e01d9ca7c4aba00273954981873cee6fb3cc89991ac8f408ffc1817cc4e07a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 124a8c312ad81aee66520226247d9259e97451371672615a801dfe00f91cbe2bb593ef92ec251967a64e963ff2f8b19d9df92965a82b1bca31c0ad44ccf7999b
|
7
|
+
data.tar.gz: 2de98fdd69c6f4f0d2702f89b2e0ab66badfc23fffad150ef8ddb5fa5f2083dd1649cfce5f2b38dd8880f9f1359fe1188084c7fa767214b4715ddf47936a5dfb
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to make participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
9
|
+
level of experience, education, socio-economic status, nationality, personal
|
10
|
+
appearance, race, religion, or sexual identity and orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies within all project spaces, and it also applies when
|
49
|
+
an individual is representing the project or its community in public spaces.
|
50
|
+
Examples of representing a project or community include using an official
|
51
|
+
project e-mail address, posting via an official social media account, or acting
|
52
|
+
as an appointed representative at an online or offline event. Representation of
|
53
|
+
a project may be further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at engineering@digitalfemsa.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
72
|
+
|
73
|
+
[homepage]: https://www.contributor-covenant.org
|
74
|
+
|
75
|
+
For answers to common questions about this code of conduct, see
|
76
|
+
https://www.contributor-covenant.org/faq
|
77
|
+
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# Contribution guidelines
|
2
|
+
|
3
|
+
## How to contribute step-by-step
|
4
|
+
|
5
|
+
1. Fork the `digitalfemsa/#$repo repository.
|
6
|
+
2. Create a new branch from `main` in your fork. This makes it easier for you to keep track of your changes.
|
7
|
+
3. Make the desired changes to the code.
|
8
|
+
* If you are adding new functionality or fixing a bug, we recommend you add unit tests that cover it.
|
9
|
+
4. Push the changes to your fork.
|
10
|
+
5. Create a pull request to the `digitalfemsa/#$repo` repository.
|
11
|
+
6. In your pull request, please describe in detail:
|
12
|
+
* What problem you’re solving
|
13
|
+
* Your approach to fixing the problem
|
14
|
+
* Any tests you wrote
|
15
|
+
7. Check Allow edits from maintainers.
|
16
|
+
8. Create the pull request.
|
17
|
+
9. Ensure that all checks have passed.
|
18
|
+
|
19
|
+
After you create your pull request, one of the code owners will review your code. We aim to review your request within 2-3 business days.
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2014 - DigitalFemsa, Inc. (https://www.digitalfemsa.io)
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/Makefile
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
ci-test:
|
2
|
+
bundle exec rspec
|
3
|
+
ruby:
|
4
|
+
rm -rf docs && rm -rf lib/models && \
|
5
|
+
docker run --rm \
|
6
|
+
-v ${PWD}:/local openapitools/openapi-generator-cli:v7.5.0 generate \
|
7
|
+
-i https://raw.githubusercontent.com/digitalfemsa/openapi/main/_build/api.yaml \
|
8
|
+
-g ruby \
|
9
|
+
-o /local \
|
10
|
+
-c /local/config-ruby.json \
|
11
|
+
--global-property modelTests=false
|
data/README.md
ADDED
@@ -0,0 +1,320 @@
|
|
1
|
+
# digital_femsa
|
2
|
+
|
3
|
+
DigitalFemsa - the Ruby gem for the Femsa API
|
4
|
+
|
5
|
+
Femsa sdk
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 2.1.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build date: 2024-05-17T18:56:22.613554008Z[Etc/UTC]
|
12
|
+
- Generator version: 7.5.0
|
13
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
14
|
+
For more information, please visit [https://github.com/digitalfemsa/openapi/issues](https://github.com/digitalfemsa/openapi/issues)
|
15
|
+
|
16
|
+
## Installation
|
17
|
+
|
18
|
+
### Build a gem
|
19
|
+
|
20
|
+
To build the Ruby code into a gem:
|
21
|
+
|
22
|
+
```shell
|
23
|
+
gem build digital_femsa.gemspec
|
24
|
+
```
|
25
|
+
|
26
|
+
Then either install the gem locally:
|
27
|
+
|
28
|
+
```shell
|
29
|
+
gem install ./digital_femsa-1.0.0.gem
|
30
|
+
```
|
31
|
+
|
32
|
+
(for development, run `gem install --dev ./digital_femsa-1.0.0.gem` to install the development dependencies)
|
33
|
+
|
34
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
|
+
|
36
|
+
Finally add this to the Gemfile:
|
37
|
+
|
38
|
+
gem 'digital_femsa', '~> 1.0.0'
|
39
|
+
|
40
|
+
### Install from Git
|
41
|
+
|
42
|
+
If the Ruby gem is hosted at a git repository: https://github.com/digitalfemsa/digitalfemsa-ruby, then add the following in the Gemfile:
|
43
|
+
|
44
|
+
gem 'digital_femsa', :git => 'https://github.com/digitalfemsa/digitalfemsa-ruby.git'
|
45
|
+
|
46
|
+
### Include the Ruby code directly
|
47
|
+
|
48
|
+
Include the Ruby code directly using `-I` as follows:
|
49
|
+
|
50
|
+
```shell
|
51
|
+
ruby -Ilib script.rb
|
52
|
+
```
|
53
|
+
|
54
|
+
## Getting Started
|
55
|
+
|
56
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
# Load the gem
|
60
|
+
require 'digital_femsa'
|
61
|
+
|
62
|
+
# Setup authorization
|
63
|
+
DigitalFemsa.configure do |config|
|
64
|
+
# Configure Bearer authorization: bearerAuth
|
65
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
66
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
67
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
68
|
+
# Configure faraday connection
|
69
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
70
|
+
end
|
71
|
+
|
72
|
+
api_instance = DigitalFemsa::ApiKeysApi.new
|
73
|
+
api_key_request = DigitalFemsa::ApiKeyRequest.new({role: 'private'}) # ApiKeyRequest | requested field for a api keys
|
74
|
+
opts = {
|
75
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
76
|
+
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.
|
77
|
+
}
|
78
|
+
|
79
|
+
begin
|
80
|
+
#Create Api Key
|
81
|
+
result = api_instance.create_api_key(api_key_request, opts)
|
82
|
+
p result
|
83
|
+
rescue DigitalFemsa::ApiError => e
|
84
|
+
puts "Exception when calling ApiKeysApi->create_api_key: #{e}"
|
85
|
+
end
|
86
|
+
|
87
|
+
```
|
88
|
+
|
89
|
+
## Documentation for API Endpoints
|
90
|
+
|
91
|
+
All URIs are relative to *https://api.digitalfemsa.io*
|
92
|
+
|
93
|
+
Class | Method | HTTP request | Description
|
94
|
+
------------ | ------------- | ------------- | -------------
|
95
|
+
*DigitalFemsa::ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create Api Key
|
96
|
+
*DigitalFemsa::ApiKeysApi* | [**delete_api_key**](docs/ApiKeysApi.md#delete_api_key) | **DELETE** /api_keys/{id} | Delete Api Key
|
97
|
+
*DigitalFemsa::ApiKeysApi* | [**get_api_key**](docs/ApiKeysApi.md#get_api_key) | **GET** /api_keys/{id} | Get Api Key
|
98
|
+
*DigitalFemsa::ApiKeysApi* | [**get_api_keys**](docs/ApiKeysApi.md#get_api_keys) | **GET** /api_keys | Get list of Api Keys
|
99
|
+
*DigitalFemsa::ApiKeysApi* | [**update_api_key**](docs/ApiKeysApi.md#update_api_key) | **PUT** /api_keys/{id} | Update Api Key
|
100
|
+
*DigitalFemsa::BalancesApi* | [**get_balance**](docs/BalancesApi.md#get_balance) | **GET** /balance | Get a company's balance
|
101
|
+
*DigitalFemsa::ChargesApi* | [**get_charges**](docs/ChargesApi.md#get_charges) | **GET** /charges | Get A List of Charges
|
102
|
+
*DigitalFemsa::ChargesApi* | [**orders_create_charge**](docs/ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge
|
103
|
+
*DigitalFemsa::ChargesApi* | [**update_charge**](docs/ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge
|
104
|
+
*DigitalFemsa::CompaniesApi* | [**get_companies**](docs/CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies
|
105
|
+
*DigitalFemsa::CompaniesApi* | [**get_company**](docs/CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company
|
106
|
+
*DigitalFemsa::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create customer
|
107
|
+
*DigitalFemsa::CustomersApi* | [**create_customer_fiscal_entities**](docs/CustomersApi.md#create_customer_fiscal_entities) | **POST** /customers/{id}/fiscal_entities | Create Fiscal Entity
|
108
|
+
*DigitalFemsa::CustomersApi* | [**delete_customer_by_id**](docs/CustomersApi.md#delete_customer_by_id) | **DELETE** /customers/{id} | Delete Customer
|
109
|
+
*DigitalFemsa::CustomersApi* | [**get_customer_by_id**](docs/CustomersApi.md#get_customer_by_id) | **GET** /customers/{id} | Get Customer
|
110
|
+
*DigitalFemsa::CustomersApi* | [**get_customers**](docs/CustomersApi.md#get_customers) | **GET** /customers | Get a list of customers
|
111
|
+
*DigitalFemsa::CustomersApi* | [**update_customer**](docs/CustomersApi.md#update_customer) | **PUT** /customers/{id} | Update customer
|
112
|
+
*DigitalFemsa::CustomersApi* | [**update_customer_fiscal_entities**](docs/CustomersApi.md#update_customer_fiscal_entities) | **PUT** /customers/{id}/fiscal_entities/{fiscal_entities_id} | Update Fiscal Entity
|
113
|
+
*DigitalFemsa::DiscountsApi* | [**orders_create_discount_line**](docs/DiscountsApi.md#orders_create_discount_line) | **POST** /orders/{id}/discount_lines | Create Discount
|
114
|
+
*DigitalFemsa::DiscountsApi* | [**orders_delete_discount_lines**](docs/DiscountsApi.md#orders_delete_discount_lines) | **DELETE** /orders/{id}/discount_lines/{discount_lines_id} | Delete Discount
|
115
|
+
*DigitalFemsa::DiscountsApi* | [**orders_get_discount_line**](docs/DiscountsApi.md#orders_get_discount_line) | **GET** /orders/{id}/discount_lines/{discount_lines_id} | Get Discount
|
116
|
+
*DigitalFemsa::DiscountsApi* | [**orders_get_discount_lines**](docs/DiscountsApi.md#orders_get_discount_lines) | **GET** /orders/{id}/discount_lines | Get a List of Discount
|
117
|
+
*DigitalFemsa::DiscountsApi* | [**orders_update_discount_lines**](docs/DiscountsApi.md#orders_update_discount_lines) | **PUT** /orders/{id}/discount_lines/{discount_lines_id} | Update Discount
|
118
|
+
*DigitalFemsa::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} | Get Event
|
119
|
+
*DigitalFemsa::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events | Get list of Events
|
120
|
+
*DigitalFemsa::EventsApi* | [**resend_event**](docs/EventsApi.md#resend_event) | **POST** /events/{event_id}/webhook_logs/{webhook_log_id}/resend | Resend Event
|
121
|
+
*DigitalFemsa::LogsApi* | [**get_log_by_id**](docs/LogsApi.md#get_log_by_id) | **GET** /logs/{id} | Get Log
|
122
|
+
*DigitalFemsa::LogsApi* | [**get_logs**](docs/LogsApi.md#get_logs) | **GET** /logs | Get List Of Logs
|
123
|
+
*DigitalFemsa::OrdersApi* | [**cancel_order**](docs/OrdersApi.md#cancel_order) | **POST** /orders/{id}/cancel | Cancel Order
|
124
|
+
*DigitalFemsa::OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /orders | Create order
|
125
|
+
*DigitalFemsa::OrdersApi* | [**get_order_by_id**](docs/OrdersApi.md#get_order_by_id) | **GET** /orders/{id} | Get Order
|
126
|
+
*DigitalFemsa::OrdersApi* | [**get_orders**](docs/OrdersApi.md#get_orders) | **GET** /orders | Get a list of Orders
|
127
|
+
*DigitalFemsa::OrdersApi* | [**order_cancel_refund**](docs/OrdersApi.md#order_cancel_refund) | **DELETE** /orders/{id}/refunds/{refund_id} | Cancel Refund
|
128
|
+
*DigitalFemsa::OrdersApi* | [**order_refund**](docs/OrdersApi.md#order_refund) | **POST** /orders/{id}/refunds | Refund Order
|
129
|
+
*DigitalFemsa::OrdersApi* | [**orders_create_capture**](docs/OrdersApi.md#orders_create_capture) | **POST** /orders/{id}/capture | Capture Order
|
130
|
+
*DigitalFemsa::OrdersApi* | [**update_order**](docs/OrdersApi.md#update_order) | **PUT** /orders/{id} | Update Order
|
131
|
+
*DigitalFemsa::PaymentLinkApi* | [**cancel_checkout**](docs/PaymentLinkApi.md#cancel_checkout) | **PUT** /checkouts/{id}/cancel | Cancel Payment Link
|
132
|
+
*DigitalFemsa::PaymentLinkApi* | [**create_checkout**](docs/PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Unique Payment Link
|
133
|
+
*DigitalFemsa::PaymentLinkApi* | [**email_checkout**](docs/PaymentLinkApi.md#email_checkout) | **POST** /checkouts/{id}/email | Send an email
|
134
|
+
*DigitalFemsa::PaymentLinkApi* | [**get_checkout**](docs/PaymentLinkApi.md#get_checkout) | **GET** /checkouts/{id} | Get a payment link by ID
|
135
|
+
*DigitalFemsa::PaymentLinkApi* | [**get_checkouts**](docs/PaymentLinkApi.md#get_checkouts) | **GET** /checkouts | Get a list of payment links
|
136
|
+
*DigitalFemsa::PaymentLinkApi* | [**sms_checkout**](docs/PaymentLinkApi.md#sms_checkout) | **POST** /checkouts/{id}/sms | Send an sms
|
137
|
+
*DigitalFemsa::PaymentMethodsApi* | [**create_customer_payment_methods**](docs/PaymentMethodsApi.md#create_customer_payment_methods) | **POST** /customers/{id}/payment_sources | Create Payment Method
|
138
|
+
*DigitalFemsa::PaymentMethodsApi* | [**delete_customer_payment_methods**](docs/PaymentMethodsApi.md#delete_customer_payment_methods) | **DELETE** /customers/{id}/payment_sources/{payment_method_id} | Delete Payment Method
|
139
|
+
*DigitalFemsa::PaymentMethodsApi* | [**get_customer_payment_methods**](docs/PaymentMethodsApi.md#get_customer_payment_methods) | **GET** /customers/{id}/payment_sources | Get Payment Methods
|
140
|
+
*DigitalFemsa::PaymentMethodsApi* | [**update_customer_payment_methods**](docs/PaymentMethodsApi.md#update_customer_payment_methods) | **PUT** /customers/{id}/payment_sources/{payment_method_id} | Update Payment Method
|
141
|
+
*DigitalFemsa::ProductsApi* | [**orders_create_product**](docs/ProductsApi.md#orders_create_product) | **POST** /orders/{id}/line_items | Create Product
|
142
|
+
*DigitalFemsa::ProductsApi* | [**orders_delete_product**](docs/ProductsApi.md#orders_delete_product) | **DELETE** /orders/{id}/line_items/{line_item_id} | Delete Product
|
143
|
+
*DigitalFemsa::ProductsApi* | [**orders_update_product**](docs/ProductsApi.md#orders_update_product) | **PUT** /orders/{id}/line_items/{line_item_id} | Update Product
|
144
|
+
*DigitalFemsa::ShippingContactsApi* | [**create_customer_shipping_contacts**](docs/ShippingContactsApi.md#create_customer_shipping_contacts) | **POST** /customers/{id}/shipping_contacts | Create a shipping contacts
|
145
|
+
*DigitalFemsa::ShippingContactsApi* | [**delete_customer_shipping_contacts**](docs/ShippingContactsApi.md#delete_customer_shipping_contacts) | **DELETE** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Delete shipping contacts
|
146
|
+
*DigitalFemsa::ShippingContactsApi* | [**update_customer_shipping_contacts**](docs/ShippingContactsApi.md#update_customer_shipping_contacts) | **PUT** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Update shipping contacts
|
147
|
+
*DigitalFemsa::ShippingsApi* | [**orders_create_shipping**](docs/ShippingsApi.md#orders_create_shipping) | **POST** /orders/{id}/shipping_lines | Create Shipping
|
148
|
+
*DigitalFemsa::ShippingsApi* | [**orders_delete_shipping**](docs/ShippingsApi.md#orders_delete_shipping) | **DELETE** /orders/{id}/shipping_lines/{shipping_id} | Delete Shipping
|
149
|
+
*DigitalFemsa::ShippingsApi* | [**orders_update_shipping**](docs/ShippingsApi.md#orders_update_shipping) | **PUT** /orders/{id}/shipping_lines/{shipping_id} | Update Shipping
|
150
|
+
*DigitalFemsa::TaxesApi* | [**orders_create_taxes**](docs/TaxesApi.md#orders_create_taxes) | **POST** /orders/{id}/tax_lines | Create Tax
|
151
|
+
*DigitalFemsa::TaxesApi* | [**orders_delete_taxes**](docs/TaxesApi.md#orders_delete_taxes) | **DELETE** /orders/{id}/tax_lines/{tax_id} | Delete Tax
|
152
|
+
*DigitalFemsa::TaxesApi* | [**orders_update_taxes**](docs/TaxesApi.md#orders_update_taxes) | **PUT** /orders/{id}/tax_lines/{tax_id} | Update Tax
|
153
|
+
*DigitalFemsa::TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **GET** /transactions/{id} | Get transaction
|
154
|
+
*DigitalFemsa::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | Get List transactions
|
155
|
+
*DigitalFemsa::TransfersApi* | [**get_transfer**](docs/TransfersApi.md#get_transfer) | **GET** /transfers/{id} | Get Transfer
|
156
|
+
*DigitalFemsa::TransfersApi* | [**get_transfers**](docs/TransfersApi.md#get_transfers) | **GET** /transfers | Get a list of transfers
|
157
|
+
*DigitalFemsa::WebhookKeysApi* | [**create_webhook_key**](docs/WebhookKeysApi.md#create_webhook_key) | **POST** /webhook_keys | Create Webhook Key
|
158
|
+
*DigitalFemsa::WebhookKeysApi* | [**delete_webhook_key**](docs/WebhookKeysApi.md#delete_webhook_key) | **DELETE** /webhook_keys/{id} | Delete Webhook key
|
159
|
+
*DigitalFemsa::WebhookKeysApi* | [**get_webhook_key**](docs/WebhookKeysApi.md#get_webhook_key) | **GET** /webhook_keys/{id} | Get Webhook Key
|
160
|
+
*DigitalFemsa::WebhookKeysApi* | [**get_webhook_keys**](docs/WebhookKeysApi.md#get_webhook_keys) | **GET** /webhook_keys | Get List of Webhook Keys
|
161
|
+
*DigitalFemsa::WebhookKeysApi* | [**update_webhook_key**](docs/WebhookKeysApi.md#update_webhook_key) | **PUT** /webhook_keys/{id} | Update Webhook Key
|
162
|
+
*DigitalFemsa::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create Webhook
|
163
|
+
*DigitalFemsa::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete Webhook
|
164
|
+
*DigitalFemsa::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{id} | Get Webhook
|
165
|
+
*DigitalFemsa::WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get List of Webhooks
|
166
|
+
*DigitalFemsa::WebhooksApi* | [**test_webhook**](docs/WebhooksApi.md#test_webhook) | **POST** /webhooks/{id}/test | Test Webhook
|
167
|
+
*DigitalFemsa::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks/{id} | Update Webhook
|
168
|
+
|
169
|
+
|
170
|
+
## Documentation for Models
|
171
|
+
|
172
|
+
- [DigitalFemsa::ApiKeyCreateResponse](docs/ApiKeyCreateResponse.md)
|
173
|
+
- [DigitalFemsa::ApiKeyRequest](docs/ApiKeyRequest.md)
|
174
|
+
- [DigitalFemsa::ApiKeyResponse](docs/ApiKeyResponse.md)
|
175
|
+
- [DigitalFemsa::ApiKeyResponseOnDelete](docs/ApiKeyResponseOnDelete.md)
|
176
|
+
- [DigitalFemsa::ApiKeyUpdateRequest](docs/ApiKeyUpdateRequest.md)
|
177
|
+
- [DigitalFemsa::BalanceCommonField](docs/BalanceCommonField.md)
|
178
|
+
- [DigitalFemsa::BalanceResponse](docs/BalanceResponse.md)
|
179
|
+
- [DigitalFemsa::ChargeOrderResponse](docs/ChargeOrderResponse.md)
|
180
|
+
- [DigitalFemsa::ChargeOrderResponsePaymentMethod](docs/ChargeOrderResponsePaymentMethod.md)
|
181
|
+
- [DigitalFemsa::ChargeRequest](docs/ChargeRequest.md)
|
182
|
+
- [DigitalFemsa::ChargeRequestPaymentMethod](docs/ChargeRequestPaymentMethod.md)
|
183
|
+
- [DigitalFemsa::ChargeResponse](docs/ChargeResponse.md)
|
184
|
+
- [DigitalFemsa::ChargeResponseChannel](docs/ChargeResponseChannel.md)
|
185
|
+
- [DigitalFemsa::ChargeResponsePaymentMethod](docs/ChargeResponsePaymentMethod.md)
|
186
|
+
- [DigitalFemsa::ChargeResponseRefunds](docs/ChargeResponseRefunds.md)
|
187
|
+
- [DigitalFemsa::ChargeResponseRefundsData](docs/ChargeResponseRefundsData.md)
|
188
|
+
- [DigitalFemsa::ChargeUpdateRequest](docs/ChargeUpdateRequest.md)
|
189
|
+
- [DigitalFemsa::ChargesDataResponse](docs/ChargesDataResponse.md)
|
190
|
+
- [DigitalFemsa::Checkout](docs/Checkout.md)
|
191
|
+
- [DigitalFemsa::CheckoutOrderTemplate](docs/CheckoutOrderTemplate.md)
|
192
|
+
- [DigitalFemsa::CheckoutOrderTemplateCustomerInfo](docs/CheckoutOrderTemplateCustomerInfo.md)
|
193
|
+
- [DigitalFemsa::CheckoutRequest](docs/CheckoutRequest.md)
|
194
|
+
- [DigitalFemsa::CheckoutResponse](docs/CheckoutResponse.md)
|
195
|
+
- [DigitalFemsa::CheckoutsResponse](docs/CheckoutsResponse.md)
|
196
|
+
- [DigitalFemsa::CompanyFiscalInfoAddressResponse](docs/CompanyFiscalInfoAddressResponse.md)
|
197
|
+
- [DigitalFemsa::CompanyFiscalInfoResponse](docs/CompanyFiscalInfoResponse.md)
|
198
|
+
- [DigitalFemsa::CompanyPayoutDestinationResponse](docs/CompanyPayoutDestinationResponse.md)
|
199
|
+
- [DigitalFemsa::CompanyResponse](docs/CompanyResponse.md)
|
200
|
+
- [DigitalFemsa::CreateCustomerFiscalEntitiesResponse](docs/CreateCustomerFiscalEntitiesResponse.md)
|
201
|
+
- [DigitalFemsa::CreateCustomerPaymentMethodsRequest](docs/CreateCustomerPaymentMethodsRequest.md)
|
202
|
+
- [DigitalFemsa::CreateCustomerPaymentMethodsResponse](docs/CreateCustomerPaymentMethodsResponse.md)
|
203
|
+
- [DigitalFemsa::Customer](docs/Customer.md)
|
204
|
+
- [DigitalFemsa::CustomerAddress](docs/CustomerAddress.md)
|
205
|
+
- [DigitalFemsa::CustomerAntifraudInfo](docs/CustomerAntifraudInfo.md)
|
206
|
+
- [DigitalFemsa::CustomerAntifraudInfoResponse](docs/CustomerAntifraudInfoResponse.md)
|
207
|
+
- [DigitalFemsa::CustomerFiscalEntitiesDataResponse](docs/CustomerFiscalEntitiesDataResponse.md)
|
208
|
+
- [DigitalFemsa::CustomerFiscalEntitiesRequest](docs/CustomerFiscalEntitiesRequest.md)
|
209
|
+
- [DigitalFemsa::CustomerFiscalEntitiesResponse](docs/CustomerFiscalEntitiesResponse.md)
|
210
|
+
- [DigitalFemsa::CustomerInfo](docs/CustomerInfo.md)
|
211
|
+
- [DigitalFemsa::CustomerInfoJustCustomerId](docs/CustomerInfoJustCustomerId.md)
|
212
|
+
- [DigitalFemsa::CustomerInfoJustCustomerIdResponse](docs/CustomerInfoJustCustomerIdResponse.md)
|
213
|
+
- [DigitalFemsa::CustomerPaymentMethodRequest](docs/CustomerPaymentMethodRequest.md)
|
214
|
+
- [DigitalFemsa::CustomerPaymentMethodsData](docs/CustomerPaymentMethodsData.md)
|
215
|
+
- [DigitalFemsa::CustomerPaymentMethodsRequest](docs/CustomerPaymentMethodsRequest.md)
|
216
|
+
- [DigitalFemsa::CustomerPaymentMethodsResponse](docs/CustomerPaymentMethodsResponse.md)
|
217
|
+
- [DigitalFemsa::CustomerResponse](docs/CustomerResponse.md)
|
218
|
+
- [DigitalFemsa::CustomerResponseShippingContacts](docs/CustomerResponseShippingContacts.md)
|
219
|
+
- [DigitalFemsa::CustomerShippingContacts](docs/CustomerShippingContacts.md)
|
220
|
+
- [DigitalFemsa::CustomerShippingContactsAddress](docs/CustomerShippingContactsAddress.md)
|
221
|
+
- [DigitalFemsa::CustomerShippingContactsDataResponse](docs/CustomerShippingContactsDataResponse.md)
|
222
|
+
- [DigitalFemsa::CustomerShippingContactsResponse](docs/CustomerShippingContactsResponse.md)
|
223
|
+
- [DigitalFemsa::CustomerShippingContactsResponseAddress](docs/CustomerShippingContactsResponseAddress.md)
|
224
|
+
- [DigitalFemsa::CustomerUpdateFiscalEntitiesRequest](docs/CustomerUpdateFiscalEntitiesRequest.md)
|
225
|
+
- [DigitalFemsa::CustomerUpdateShippingContacts](docs/CustomerUpdateShippingContacts.md)
|
226
|
+
- [DigitalFemsa::CustomersResponse](docs/CustomersResponse.md)
|
227
|
+
- [DigitalFemsa::DeleteApiKeysResponse](docs/DeleteApiKeysResponse.md)
|
228
|
+
- [DigitalFemsa::Details](docs/Details.md)
|
229
|
+
- [DigitalFemsa::DetailsError](docs/DetailsError.md)
|
230
|
+
- [DigitalFemsa::DiscountLinesDataResponse](docs/DiscountLinesDataResponse.md)
|
231
|
+
- [DigitalFemsa::DiscountLinesResponse](docs/DiscountLinesResponse.md)
|
232
|
+
- [DigitalFemsa::EmailCheckoutRequest](docs/EmailCheckoutRequest.md)
|
233
|
+
- [DigitalFemsa::Error](docs/Error.md)
|
234
|
+
- [DigitalFemsa::EventResponse](docs/EventResponse.md)
|
235
|
+
- [DigitalFemsa::EventsResendResponse](docs/EventsResendResponse.md)
|
236
|
+
- [DigitalFemsa::FiscalEntityAddress](docs/FiscalEntityAddress.md)
|
237
|
+
- [DigitalFemsa::GetApiKeysResponse](docs/GetApiKeysResponse.md)
|
238
|
+
- [DigitalFemsa::GetChargesResponse](docs/GetChargesResponse.md)
|
239
|
+
- [DigitalFemsa::GetCompaniesResponse](docs/GetCompaniesResponse.md)
|
240
|
+
- [DigitalFemsa::GetCustomerPaymentMethodDataResponse](docs/GetCustomerPaymentMethodDataResponse.md)
|
241
|
+
- [DigitalFemsa::GetEventsResponse](docs/GetEventsResponse.md)
|
242
|
+
- [DigitalFemsa::GetOrderDiscountLinesResponse](docs/GetOrderDiscountLinesResponse.md)
|
243
|
+
- [DigitalFemsa::GetOrdersResponse](docs/GetOrdersResponse.md)
|
244
|
+
- [DigitalFemsa::GetPaymentMethodResponse](docs/GetPaymentMethodResponse.md)
|
245
|
+
- [DigitalFemsa::GetTransactionsResponse](docs/GetTransactionsResponse.md)
|
246
|
+
- [DigitalFemsa::GetTransfersResponse](docs/GetTransfersResponse.md)
|
247
|
+
- [DigitalFemsa::GetWebhookKeysResponse](docs/GetWebhookKeysResponse.md)
|
248
|
+
- [DigitalFemsa::GetWebhooksResponse](docs/GetWebhooksResponse.md)
|
249
|
+
- [DigitalFemsa::LogResponse](docs/LogResponse.md)
|
250
|
+
- [DigitalFemsa::LogsResponse](docs/LogsResponse.md)
|
251
|
+
- [DigitalFemsa::LogsResponseData](docs/LogsResponseData.md)
|
252
|
+
- [DigitalFemsa::OrderCaptureRequest](docs/OrderCaptureRequest.md)
|
253
|
+
- [DigitalFemsa::OrderCustomerInfoResponse](docs/OrderCustomerInfoResponse.md)
|
254
|
+
- [DigitalFemsa::OrderDiscountLinesRequest](docs/OrderDiscountLinesRequest.md)
|
255
|
+
- [DigitalFemsa::OrderFiscalEntityAddressResponse](docs/OrderFiscalEntityAddressResponse.md)
|
256
|
+
- [DigitalFemsa::OrderFiscalEntityRequest](docs/OrderFiscalEntityRequest.md)
|
257
|
+
- [DigitalFemsa::OrderFiscalEntityResponse](docs/OrderFiscalEntityResponse.md)
|
258
|
+
- [DigitalFemsa::OrderNextActionResponse](docs/OrderNextActionResponse.md)
|
259
|
+
- [DigitalFemsa::OrderNextActionResponseRedirectToUrl](docs/OrderNextActionResponseRedirectToUrl.md)
|
260
|
+
- [DigitalFemsa::OrderRefundRequest](docs/OrderRefundRequest.md)
|
261
|
+
- [DigitalFemsa::OrderRequest](docs/OrderRequest.md)
|
262
|
+
- [DigitalFemsa::OrderRequestCustomerInfo](docs/OrderRequestCustomerInfo.md)
|
263
|
+
- [DigitalFemsa::OrderResponse](docs/OrderResponse.md)
|
264
|
+
- [DigitalFemsa::OrderResponseCharges](docs/OrderResponseCharges.md)
|
265
|
+
- [DigitalFemsa::OrderResponseCheckout](docs/OrderResponseCheckout.md)
|
266
|
+
- [DigitalFemsa::OrderResponseCustomerInfo](docs/OrderResponseCustomerInfo.md)
|
267
|
+
- [DigitalFemsa::OrderResponseDiscountLines](docs/OrderResponseDiscountLines.md)
|
268
|
+
- [DigitalFemsa::OrderResponseProducts](docs/OrderResponseProducts.md)
|
269
|
+
- [DigitalFemsa::OrderResponseShippingContact](docs/OrderResponseShippingContact.md)
|
270
|
+
- [DigitalFemsa::OrderTaxRequest](docs/OrderTaxRequest.md)
|
271
|
+
- [DigitalFemsa::OrderUpdateFiscalEntityRequest](docs/OrderUpdateFiscalEntityRequest.md)
|
272
|
+
- [DigitalFemsa::OrderUpdateRequest](docs/OrderUpdateRequest.md)
|
273
|
+
- [DigitalFemsa::OrderUpdateRequestCustomerInfo](docs/OrderUpdateRequestCustomerInfo.md)
|
274
|
+
- [DigitalFemsa::OrdersResponse](docs/OrdersResponse.md)
|
275
|
+
- [DigitalFemsa::Page](docs/Page.md)
|
276
|
+
- [DigitalFemsa::Pagination](docs/Pagination.md)
|
277
|
+
- [DigitalFemsa::PaymentMethod](docs/PaymentMethod.md)
|
278
|
+
- [DigitalFemsa::PaymentMethodCash](docs/PaymentMethodCash.md)
|
279
|
+
- [DigitalFemsa::PaymentMethodCashRequest](docs/PaymentMethodCashRequest.md)
|
280
|
+
- [DigitalFemsa::PaymentMethodCashResponse](docs/PaymentMethodCashResponse.md)
|
281
|
+
- [DigitalFemsa::PaymentMethodResponse](docs/PaymentMethodResponse.md)
|
282
|
+
- [DigitalFemsa::Product](docs/Product.md)
|
283
|
+
- [DigitalFemsa::ProductDataResponse](docs/ProductDataResponse.md)
|
284
|
+
- [DigitalFemsa::ProductOrderResponse](docs/ProductOrderResponse.md)
|
285
|
+
- [DigitalFemsa::ShippingOrderResponse](docs/ShippingOrderResponse.md)
|
286
|
+
- [DigitalFemsa::ShippingRequest](docs/ShippingRequest.md)
|
287
|
+
- [DigitalFemsa::SmsCheckoutRequest](docs/SmsCheckoutRequest.md)
|
288
|
+
- [DigitalFemsa::TransactionResponse](docs/TransactionResponse.md)
|
289
|
+
- [DigitalFemsa::TransferDestinationResponse](docs/TransferDestinationResponse.md)
|
290
|
+
- [DigitalFemsa::TransferMethodResponse](docs/TransferMethodResponse.md)
|
291
|
+
- [DigitalFemsa::TransferResponse](docs/TransferResponse.md)
|
292
|
+
- [DigitalFemsa::TransfersResponse](docs/TransfersResponse.md)
|
293
|
+
- [DigitalFemsa::UpdateCustomer](docs/UpdateCustomer.md)
|
294
|
+
- [DigitalFemsa::UpdateCustomerAntifraudInfo](docs/UpdateCustomerAntifraudInfo.md)
|
295
|
+
- [DigitalFemsa::UpdateCustomerFiscalEntitiesResponse](docs/UpdateCustomerFiscalEntitiesResponse.md)
|
296
|
+
- [DigitalFemsa::UpdateCustomerPaymentMethodsResponse](docs/UpdateCustomerPaymentMethodsResponse.md)
|
297
|
+
- [DigitalFemsa::UpdateOrderDiscountLinesRequest](docs/UpdateOrderDiscountLinesRequest.md)
|
298
|
+
- [DigitalFemsa::UpdateOrderTaxRequest](docs/UpdateOrderTaxRequest.md)
|
299
|
+
- [DigitalFemsa::UpdateOrderTaxResponse](docs/UpdateOrderTaxResponse.md)
|
300
|
+
- [DigitalFemsa::UpdatePaymentMethods](docs/UpdatePaymentMethods.md)
|
301
|
+
- [DigitalFemsa::UpdateProduct](docs/UpdateProduct.md)
|
302
|
+
- [DigitalFemsa::WebhookKeyCreateResponse](docs/WebhookKeyCreateResponse.md)
|
303
|
+
- [DigitalFemsa::WebhookKeyDeleteResponse](docs/WebhookKeyDeleteResponse.md)
|
304
|
+
- [DigitalFemsa::WebhookKeyRequest](docs/WebhookKeyRequest.md)
|
305
|
+
- [DigitalFemsa::WebhookKeyResponse](docs/WebhookKeyResponse.md)
|
306
|
+
- [DigitalFemsa::WebhookKeyUpdateRequest](docs/WebhookKeyUpdateRequest.md)
|
307
|
+
- [DigitalFemsa::WebhookLog](docs/WebhookLog.md)
|
308
|
+
- [DigitalFemsa::WebhookRequest](docs/WebhookRequest.md)
|
309
|
+
- [DigitalFemsa::WebhookResponse](docs/WebhookResponse.md)
|
310
|
+
- [DigitalFemsa::WebhookUpdateRequest](docs/WebhookUpdateRequest.md)
|
311
|
+
|
312
|
+
|
313
|
+
## Documentation for Authorization
|
314
|
+
|
315
|
+
|
316
|
+
Authentication schemes defined for the API:
|
317
|
+
### bearerAuth
|
318
|
+
|
319
|
+
- **Type**: Bearer authentication
|
320
|
+
|
data/Rakefile
ADDED
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.0
|
data/config-ruby.json
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
{
|
2
|
+
"gemAuthorEmail" : "core@digitalfemsa.com",
|
3
|
+
"gemAuthor": "DigitalFemsa",
|
4
|
+
"gemName" : "digital_femsa",
|
5
|
+
"gemLicense": "MIT",
|
6
|
+
"gemVersion": "1.0.0",
|
7
|
+
"hideGenerationTimestamp": false,
|
8
|
+
"moduleName": "DigitalFemsa",
|
9
|
+
"gemSummary" : "This library provides https://api.digitalfemsa.io operations",
|
10
|
+
"gemHomepage" : "https://www.digitalfemsa.com",
|
11
|
+
"gemDescription" : "Ruby library for https://api.digitalfemsa.io",
|
12
|
+
"library": "faraday",
|
13
|
+
"httpUserAgent": "App/v2 RubyBindings/#{DigitalFemsa::VERSION}",
|
14
|
+
"gemRequiredRubyVersion" : ">= 2.6",
|
15
|
+
"templateDir": "local/templates/ruby",
|
16
|
+
"gitUserId" : "digitalfemsa",
|
17
|
+
"gitRepoId" : "digitalfemsa-ruby",
|
18
|
+
"files": {
|
19
|
+
"/local/CODE_OF_CONDUCT.md": {},
|
20
|
+
"/local/CONTRIBUTING.md": {},
|
21
|
+
"/local/LICENSE": {},
|
22
|
+
"/local/ssl_data/ca_bundle.crt": {
|
23
|
+
"destinationFilename": "lib/ssl_data/ca_bundle.crt"
|
24
|
+
},
|
25
|
+
"CUSTOM_VERSION.mustache": {
|
26
|
+
"templateType": "SupportingFiles",
|
27
|
+
"destinationFilename": "VERSION"
|
28
|
+
}
|
29
|
+
}
|
30
|
+
}
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#Femsa API
|
5
|
+
|
6
|
+
#Femsa sdk
|
7
|
+
|
8
|
+
The version of the OpenAPI document: 2.1.0
|
9
|
+
Contact: engineering@femsa.com
|
10
|
+
Generated by: https://openapi-generator.tech
|
11
|
+
Generator version: 7.5.0
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "digital_femsa/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "digital_femsa"
|
20
|
+
s.version = DigitalFemsa::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["DigitalFemsa"]
|
23
|
+
s.email = ["core@digitalfemsa.com"]
|
24
|
+
s.homepage = "https://www.digitalfemsa.com"
|
25
|
+
s.summary = "This library provides https://api.digitalfemsa.io operations"
|
26
|
+
s.description = "Ruby library for https://api.digitalfemsa.io"
|
27
|
+
s.license = "MIT"
|
28
|
+
s.required_ruby_version = ">= 2.6"
|
29
|
+
s.metadata = {}
|
30
|
+
|
31
|
+
s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
|
32
|
+
s.add_runtime_dependency 'faraday-multipart'
|
33
|
+
s.add_runtime_dependency 'marcel'
|
34
|
+
|
35
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
36
|
+
|
37
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
38
|
+
s.test_files = `find spec/*`.split("\n")
|
39
|
+
s.executables = []
|
40
|
+
s.require_paths = ["lib"]
|
41
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# DigitalFemsa::ApiKeyCreateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active** | **Boolean** | Indicates if the api key is active | [optional] |
|
8
|
+
| **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] |
|
9
|
+
| **updated_at** | **Integer** | Unix timestamp in seconds of when the api key was last updated | [optional] |
|
10
|
+
| **deactivated_at** | **Integer** | Unix timestamp in seconds of when the api key was deleted | [optional] |
|
11
|
+
| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
|
12
|
+
| **id** | **String** | Unique identifier of the api key | [optional] |
|
13
|
+
| **livemode** | **Boolean** | Indicates if the api key is in production | [optional] |
|
14
|
+
| **deleted** | **Boolean** | Indicates if the api key was deleted | [optional] |
|
15
|
+
| **object** | **String** | Object name, value is 'api_key' | [optional] |
|
16
|
+
| **prefix** | **String** | The first few characters of the authentication_token | [optional] |
|
17
|
+
| **role** | **String** | Indicates if the api key is private or public | [optional] |
|
18
|
+
| **authentication_token** | **String** | It is occupied as a user when authenticated with basic authentication, with a blank password. This value will only appear once, in the request to create a new key. Copy and save it in a safe place. | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'digital_femsa'
|
24
|
+
|
25
|
+
instance = DigitalFemsa::ApiKeyCreateResponse.new(
|
26
|
+
active: true,
|
27
|
+
created_at: 1684167881,
|
28
|
+
updated_at: 1684167923,
|
29
|
+
deactivated_at: null,
|
30
|
+
description: online store,
|
31
|
+
id: 64625cc9f3e02c00163f5e4d,
|
32
|
+
livemode: false,
|
33
|
+
deleted: false,
|
34
|
+
object: api_key,
|
35
|
+
prefix: key_rp,
|
36
|
+
role: private,
|
37
|
+
authentication_token: key_rpHzxufNgjFCdprEEFZRTKi
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DigitalFemsa::ApiKeyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
|
8
|
+
| **role** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'digital_femsa'
|
14
|
+
|
15
|
+
instance = DigitalFemsa::ApiKeyRequest.new(
|
16
|
+
description: online store,
|
17
|
+
role: private
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|