digital_femsa 1.0.0 → 1.1.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.
Files changed (166) hide show
  1. checksums.yaml +4 -4
  2. data/Makefile +14 -0
  3. data/README.md +28 -33
  4. data/VERSION +1 -1
  5. data/config-ruby.json +1 -1
  6. data/docs/ApiKeyCreateResponse.md +1 -1
  7. data/docs/ApiKeyRequest.md +2 -2
  8. data/docs/ApiKeyResponseOnDelete.md +2 -2
  9. data/docs/ApiKeysApi.md +10 -10
  10. data/docs/BalanceResponse.md +8 -8
  11. data/docs/BalancesApi.md +1 -1
  12. data/docs/ChargeOrderResponse.md +1 -1
  13. data/docs/ChargeOrderResponseChannel.md +24 -0
  14. data/docs/ChargeRequest.md +1 -1
  15. data/docs/ChargeRequestPaymentMethod.md +3 -3
  16. data/docs/ChargeResponse.md +9 -7
  17. data/docs/ChargeResponseChannel.md +3 -3
  18. data/docs/ChargeResponseRefundsData.md +5 -1
  19. data/docs/ChargesApi.md +16 -12
  20. data/docs/ChargesDataResponse.md +9 -7
  21. data/docs/Checkout.md +17 -15
  22. data/docs/CheckoutOrderTemplate.md +3 -3
  23. data/docs/CheckoutResponse.md +1 -1
  24. data/docs/CreateCustomerFiscalEntitiesResponse.md +2 -2
  25. data/docs/Customer.md +13 -19
  26. data/docs/CustomerAddress.md +2 -2
  27. data/docs/CustomerFiscalEntitiesDataResponse.md +2 -2
  28. data/docs/CustomerFiscalEntitiesRequest.md +3 -3
  29. data/docs/CustomerInfo.md +4 -4
  30. data/docs/CustomerPaymentMethodRequest.md +1 -1
  31. data/docs/CustomerResponse.md +17 -21
  32. data/docs/CustomerShippingContactsResponse.md +5 -5
  33. data/docs/CustomersApi.md +15 -15
  34. data/docs/CustomersResponse.md +1 -1
  35. data/docs/DeleteApiKeysResponse.md +1 -1
  36. data/docs/DiscountsApi.md +9 -9
  37. data/docs/EventsApi.md +2 -2
  38. data/docs/EventsResendResponse.md +1 -1
  39. data/docs/GetChargesResponse.md +4 -4
  40. data/docs/GetTransactionsResponse.md +1 -1
  41. data/docs/LogsApi.md +1 -1
  42. data/docs/OrderFiscalEntityRequest.md +4 -4
  43. data/docs/OrderRefundRequest.md +7 -5
  44. data/docs/OrderRequest.md +17 -19
  45. data/docs/OrderResponse.md +37 -35
  46. data/docs/OrderResponseChannel.md +24 -0
  47. data/docs/OrderResponseShippingContact.md +4 -4
  48. data/docs/OrderUpdateFiscalEntityRequest.md +1 -1
  49. data/docs/OrderUpdateRequest.md +19 -15
  50. data/docs/OrdersApi.md +16 -16
  51. data/docs/PaymentLinkApi.md +12 -82
  52. data/docs/PaymentMethodCash.md +4 -4
  53. data/docs/PaymentMethodCashRequest.md +2 -2
  54. data/docs/PaymentMethodsApi.md +5 -5
  55. data/docs/Product.md +10 -12
  56. data/docs/ProductDataResponse.md +9 -11
  57. data/docs/ProductOrderResponse.md +9 -11
  58. data/docs/ProductsApi.md +7 -7
  59. data/docs/ShippingContactsApi.md +9 -9
  60. data/docs/ShippingOrderResponse.md +5 -3
  61. data/docs/ShippingRequest.md +2 -0
  62. data/docs/ShippingsApi.md +7 -7
  63. data/docs/TaxesApi.md +7 -7
  64. data/docs/TransactionResponse.md +20 -14
  65. data/docs/TransactionsApi.md +6 -6
  66. data/docs/TransfersApi.md +10 -10
  67. data/docs/UpdateCustomer.md +17 -21
  68. data/docs/UpdateCustomerFiscalEntitiesResponse.md +2 -2
  69. data/docs/UpdateOrderTaxRequest.md +2 -2
  70. data/docs/UpdateProduct.md +7 -9
  71. data/docs/WebhookKeysApi.md +18 -14
  72. data/docs/WebhooksApi.md +28 -22
  73. data/lib/digital_femsa/api/api_keys_api.rb +8 -8
  74. data/lib/digital_femsa/api/balances_api.rb +2 -2
  75. data/lib/digital_femsa/api/charges_api.rb +13 -9
  76. data/lib/digital_femsa/api/customers_api.rb +12 -12
  77. data/lib/digital_femsa/api/discounts_api.rb +12 -12
  78. data/lib/digital_femsa/api/events_api.rb +4 -4
  79. data/lib/digital_femsa/api/logs_api.rb +2 -2
  80. data/lib/digital_femsa/api/orders_api.rb +20 -20
  81. data/lib/digital_femsa/api/payment_link_api.rb +10 -86
  82. data/lib/digital_femsa/api/payment_methods_api.rb +8 -8
  83. data/lib/digital_femsa/api/products_api.rb +10 -10
  84. data/lib/digital_femsa/api/shipping_contacts_api.rb +8 -8
  85. data/lib/digital_femsa/api/shippings_api.rb +10 -10
  86. data/lib/digital_femsa/api/taxes_api.rb +10 -10
  87. data/lib/digital_femsa/api/transactions_api.rb +6 -6
  88. data/lib/digital_femsa/api/transfers_api.rb +8 -8
  89. data/lib/digital_femsa/api/webhook_keys_api.rb +14 -10
  90. data/lib/digital_femsa/api/webhooks_api.rb +23 -16
  91. data/lib/digital_femsa/api_client.rb +9 -5
  92. data/lib/digital_femsa/models/api_key_create_response.rb +1 -1
  93. data/lib/digital_femsa/models/api_key_request.rb +36 -1
  94. data/lib/digital_femsa/models/balance_response.rb +9 -9
  95. data/lib/digital_femsa/models/charge_order_response.rb +1 -1
  96. data/lib/digital_femsa/models/{order_next_action_response.rb → charge_order_response_channel.rb} +34 -18
  97. data/lib/digital_femsa/models/charge_request_payment_method.rb +3 -2
  98. data/lib/digital_femsa/models/charge_response.rb +15 -4
  99. data/lib/digital_femsa/models/charge_response_refunds_data.rb +23 -4
  100. data/lib/digital_femsa/models/charge_update_request.rb +1 -1
  101. data/lib/digital_femsa/models/charges_data_response.rb +15 -4
  102. data/lib/digital_femsa/models/checkout.rb +97 -81
  103. data/lib/digital_femsa/models/checkout_order_template.rb +4 -4
  104. data/lib/digital_femsa/models/checkout_order_template_customer_info.rb +1 -1
  105. data/lib/digital_femsa/models/checkout_request.rb +1 -1
  106. data/lib/digital_femsa/models/checkout_response.rb +1 -1
  107. data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb +10 -10
  108. data/lib/digital_femsa/models/customer.rb +57 -95
  109. data/lib/digital_femsa/models/customer_address.rb +7 -0
  110. data/lib/digital_femsa/models/customer_fiscal_entities_data_response.rb +10 -10
  111. data/lib/digital_femsa/models/customer_fiscal_entities_request.rb +13 -13
  112. data/lib/digital_femsa/models/customer_info.rb +13 -20
  113. data/lib/digital_femsa/models/customer_payment_method_request.rb +2 -2
  114. data/lib/digital_femsa/models/customer_payment_sources_inner.rb +104 -0
  115. data/lib/digital_femsa/models/customer_response.rb +122 -113
  116. data/lib/digital_femsa/models/customer_shipping_contacts_response.rb +2 -0
  117. data/lib/digital_femsa/models/customers_response.rb +1 -0
  118. data/lib/digital_femsa/models/events_resend_response.rb +1 -1
  119. data/lib/digital_femsa/models/get_charges_response.rb +21 -21
  120. data/lib/digital_femsa/models/get_transactions_response.rb +1 -1
  121. data/lib/digital_femsa/models/log_response.rb +1 -1
  122. data/lib/digital_femsa/models/logs_response.rb +1 -1
  123. data/lib/digital_femsa/models/order_fiscal_entity_response.rb +1 -1
  124. data/lib/digital_femsa/models/order_refund_request.rb +59 -11
  125. data/lib/digital_femsa/models/order_request.rb +69 -79
  126. data/lib/digital_femsa/models/order_response.rb +187 -119
  127. data/lib/digital_femsa/models/{order_next_action_response_redirect_to_url.rb → order_response_channel.rb} +35 -19
  128. data/lib/digital_femsa/models/order_response_charges.rb +1 -1
  129. data/lib/digital_femsa/models/order_response_checkout.rb +1 -0
  130. data/lib/digital_femsa/models/order_response_customer_info.rb +1 -0
  131. data/lib/digital_femsa/models/order_response_shipping_contact.rb +3 -0
  132. data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb +1 -1
  133. data/lib/digital_femsa/models/order_update_request.rb +106 -65
  134. data/lib/digital_femsa/models/payment_method_cash.rb +1 -1
  135. data/lib/digital_femsa/models/payment_method_cash_request.rb +2 -1
  136. data/lib/digital_femsa/models/product.rb +103 -95
  137. data/lib/digital_femsa/models/product_data_response.rb +103 -95
  138. data/lib/digital_femsa/models/product_order_response.rb +103 -95
  139. data/lib/digital_femsa/models/shipping_order_response.rb +11 -1
  140. data/lib/digital_femsa/models/shipping_request.rb +12 -1
  141. data/lib/digital_femsa/models/transaction_response.rb +172 -99
  142. data/lib/digital_femsa/models/transfers_response.rb +1 -1
  143. data/lib/digital_femsa/models/transfers_response_destination.rb +312 -0
  144. data/lib/digital_femsa/models/update_customer.rb +42 -85
  145. data/lib/digital_femsa/models/update_customer_fiscal_entities_response.rb +10 -10
  146. data/lib/digital_femsa/models/update_order_discount_lines_request.rb +34 -0
  147. data/lib/digital_femsa/models/update_order_tax_request.rb +2 -2
  148. data/lib/digital_femsa/models/update_payment_methods_amount.rb +105 -0
  149. data/lib/digital_femsa/models/update_payment_methods_expires_at.rb +105 -0
  150. data/lib/digital_femsa/models/update_product.rb +85 -58
  151. data/lib/digital_femsa/models/webhook_key_delete_response.rb +1 -1
  152. data/lib/digital_femsa/models/webhook_key_request.rb +1 -0
  153. data/lib/digital_femsa/models/webhook_key_response.rb +1 -1
  154. data/lib/digital_femsa/models/webhook_request.rb +1 -1
  155. data/lib/digital_femsa/models/webhook_response.rb +1 -1
  156. data/lib/digital_femsa/models/webhook_update_request.rb +1 -1
  157. data/lib/digital_femsa/version.rb +1 -1
  158. data/lib/digital_femsa.rb +2 -6
  159. data/templates/ruby/api_client.mustache +8 -4
  160. metadata +26 -26
  161. data/docs/CustomerAntifraudInfo.md +0 -20
  162. data/docs/CustomerAntifraudInfoResponse.md +0 -20
  163. data/docs/OrderNextActionResponse.md +0 -20
  164. data/docs/OrderNextActionResponseRedirectToUrl.md +0 -20
  165. data/docs/SmsCheckoutRequest.md +0 -18
  166. data/docs/UpdateCustomerAntifraudInfo.md +0 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3f99b6ab0fac8e9d787c5eb1b55bb747b831a49e3049d2d024e3ad556ff378fe
4
- data.tar.gz: b6e01d9ca7c4aba00273954981873cee6fb3cc89991ac8f408ffc1817cc4e07a
3
+ metadata.gz: 95505b447016a0b25cb0fd3ffcc692f5dd7218e88166d818d68ef521d3cf0b6e
4
+ data.tar.gz: 63803ed21b19398750bd0f281f77c1688b4ea9077b5e7d8115e83f9f238919cb
5
5
  SHA512:
6
- metadata.gz: 124a8c312ad81aee66520226247d9259e97451371672615a801dfe00f91cbe2bb593ef92ec251967a64e963ff2f8b19d9df92965a82b1bca31c0ad44ccf7999b
7
- data.tar.gz: 2de98fdd69c6f4f0d2702f89b2e0ab66badfc23fffad150ef8ddb5fa5f2083dd1649cfce5f2b38dd8880f9f1359fe1188084c7fa767214b4715ddf47936a5dfb
6
+ metadata.gz: fd7e0e06fb721dd63255e72ceec83fb8c4c7fb6187ff07512c2a5a82dd1c58c1af24bab8a272c1608f233cf8d6df115d43e21807db3fe2ba3fa2f6dc0a41c561
7
+ data.tar.gz: f219280b929af93bfac269dd3f368a7a1123427d1e4da32ab2c299d6982201c6ade80f38c59b2622898ee138086e31f5c536170ff6e123d70b86080425be6597
data/Makefile CHANGED
@@ -9,3 +9,17 @@ ruby:
9
9
  -o /local \
10
10
  -c /local/config-ruby.json \
11
11
  --global-property modelTests=false
12
+
13
+ update-version:
14
+ @if [ -z "$(VERSION)" ]; then \
15
+ echo "Usage: make update-version VERSION=1.0.1"; \
16
+ exit 1; \
17
+ fi
18
+ @echo "Updating version to $(VERSION)..."
19
+ @echo "$(VERSION)" > VERSION
20
+ @sed -i '' "s/VERSION = '[^']*'/VERSION = '$(VERSION)'/" lib/digital_femsa/version.rb
21
+ @sed -i '' "s/\"gemVersion\": \"[^\"]*\"/\"gemVersion\": \"$(VERSION)\"/" config-ruby.json
22
+ @sed -i '' "s/- Package version: .*/- Package version: $(VERSION)/" README.md
23
+ @sed -i '' "s/digital_femsa-[0-9.]*\.gem/digital_femsa-$(VERSION).gem/g" README.md
24
+ @sed -i '' "s/gem 'digital_femsa', '~> [^']*'/gem 'digital_femsa', '~> $(VERSION)'/" README.md
25
+ @echo "✨ Version updated to $(VERSION) successfully!"
data/README.md CHANGED
@@ -7,8 +7,8 @@ Femsa sdk
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.1.0
10
- - Package version: 1.0.0
11
- - Build date: 2024-05-17T18:56:22.613554008Z[Etc/UTC]
10
+ - Package version: 1.1.0
11
+ - Build date: 2026-03-26T20:52:06.650476795Z[Etc/UTC]
12
12
  - Generator version: 7.5.0
13
13
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
14
14
  For more information, please visit [https://github.com/digitalfemsa/openapi/issues](https://github.com/digitalfemsa/openapi/issues)
@@ -26,16 +26,16 @@ gem build digital_femsa.gemspec
26
26
  Then either install the gem locally:
27
27
 
28
28
  ```shell
29
- gem install ./digital_femsa-1.0.0.gem
29
+ gem install ./digital_femsa-1.1.0.gem
30
30
  ```
31
31
 
32
- (for development, run `gem install --dev ./digital_femsa-1.0.0.gem` to install the development dependencies)
32
+ (for development, run `gem install --dev ./digital_femsa-1.1.0.gem` to install the development dependencies)
33
33
 
34
34
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
35
35
 
36
36
  Finally add this to the Gemfile:
37
37
 
38
- gem 'digital_femsa', '~> 1.0.0'
38
+ gem 'digital_femsa', '~> 1.1.0'
39
39
 
40
40
  ### Install from Git
41
41
 
@@ -77,7 +77,7 @@ opts = {
77
77
  }
78
78
 
79
79
  begin
80
- #Create Api Key
80
+ #Create API key
81
81
  result = api_instance.create_api_key(api_key_request, opts)
82
82
  p result
83
83
  rescue DigitalFemsa::ApiError => e
@@ -92,28 +92,28 @@ All URIs are relative to *https://api.digitalfemsa.io*
92
92
 
93
93
  Class | Method | HTTP request | Description
94
94
  ------------ | ------------- | ------------- | -------------
95
- *DigitalFemsa::ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create Api Key
95
+ *DigitalFemsa::ApiKeysApi* | [**create_api_key**](docs/ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create API key
96
96
  *DigitalFemsa::ApiKeysApi* | [**delete_api_key**](docs/ApiKeysApi.md#delete_api_key) | **DELETE** /api_keys/{id} | Delete Api Key
97
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
98
+ *DigitalFemsa::ApiKeysApi* | [**get_api_keys**](docs/ApiKeysApi.md#get_api_keys) | **GET** /api_keys | List API keys
99
99
  *DigitalFemsa::ApiKeysApi* | [**update_api_key**](docs/ApiKeysApi.md#update_api_key) | **PUT** /api_keys/{id} | Update Api Key
100
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
101
+ *DigitalFemsa::ChargesApi* | [**get_charges**](docs/ChargesApi.md#get_charges) | **GET** /charges | List charges
102
+ *DigitalFemsa::ChargesApi* | [**orders_create_charge**](docs/ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create a charge for an order
103
103
  *DigitalFemsa::ChargesApi* | [**update_charge**](docs/ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge
104
104
  *DigitalFemsa::CompaniesApi* | [**get_companies**](docs/CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies
105
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
106
+ *DigitalFemsa::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create a customer
107
107
  *DigitalFemsa::CustomersApi* | [**create_customer_fiscal_entities**](docs/CustomersApi.md#create_customer_fiscal_entities) | **POST** /customers/{id}/fiscal_entities | Create Fiscal Entity
108
108
  *DigitalFemsa::CustomersApi* | [**delete_customer_by_id**](docs/CustomersApi.md#delete_customer_by_id) | **DELETE** /customers/{id} | Delete Customer
109
109
  *DigitalFemsa::CustomersApi* | [**get_customer_by_id**](docs/CustomersApi.md#get_customer_by_id) | **GET** /customers/{id} | Get Customer
110
110
  *DigitalFemsa::CustomersApi* | [**get_customers**](docs/CustomersApi.md#get_customers) | **GET** /customers | Get a list of customers
111
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
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
113
  *DigitalFemsa::DiscountsApi* | [**orders_create_discount_line**](docs/DiscountsApi.md#orders_create_discount_line) | **POST** /orders/{id}/discount_lines | Create Discount
114
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
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
116
+ *DigitalFemsa::DiscountsApi* | [**orders_get_discount_lines**](docs/DiscountsApi.md#orders_get_discount_lines) | **GET** /orders/{id}/discount_lines | Get a List of Discounts
117
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
118
  *DigitalFemsa::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} | Get Event
119
119
  *DigitalFemsa::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events | Get list of Events
@@ -127,13 +127,12 @@ Class | Method | HTTP request | Description
127
127
  *DigitalFemsa::OrdersApi* | [**order_cancel_refund**](docs/OrdersApi.md#order_cancel_refund) | **DELETE** /orders/{id}/refunds/{refund_id} | Cancel Refund
128
128
  *DigitalFemsa::OrdersApi* | [**order_refund**](docs/OrdersApi.md#order_refund) | **POST** /orders/{id}/refunds | Refund Order
129
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
130
+ *DigitalFemsa::OrdersApi* | [**update_order**](docs/OrdersApi.md#update_order) | **PUT** /orders/{id} | Update order
131
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
132
+ *DigitalFemsa::PaymentLinkApi* | [**create_checkout**](docs/PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Payment Link
133
133
  *DigitalFemsa::PaymentLinkApi* | [**email_checkout**](docs/PaymentLinkApi.md#email_checkout) | **POST** /checkouts/{id}/email | Send an email
134
134
  *DigitalFemsa::PaymentLinkApi* | [**get_checkout**](docs/PaymentLinkApi.md#get_checkout) | **GET** /checkouts/{id} | Get a payment link by ID
135
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
136
  *DigitalFemsa::PaymentMethodsApi* | [**create_customer_payment_methods**](docs/PaymentMethodsApi.md#create_customer_payment_methods) | **POST** /customers/{id}/payment_sources | Create Payment Method
138
137
  *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
138
  *DigitalFemsa::PaymentMethodsApi* | [**get_customer_payment_methods**](docs/PaymentMethodsApi.md#get_customer_payment_methods) | **GET** /customers/{id}/payment_sources | Get Payment Methods
@@ -141,7 +140,7 @@ Class | Method | HTTP request | Description
141
140
  *DigitalFemsa::ProductsApi* | [**orders_create_product**](docs/ProductsApi.md#orders_create_product) | **POST** /orders/{id}/line_items | Create Product
142
141
  *DigitalFemsa::ProductsApi* | [**orders_delete_product**](docs/ProductsApi.md#orders_delete_product) | **DELETE** /orders/{id}/line_items/{line_item_id} | Delete Product
143
142
  *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
143
+ *DigitalFemsa::ShippingContactsApi* | [**create_customer_shipping_contacts**](docs/ShippingContactsApi.md#create_customer_shipping_contacts) | **POST** /customers/{id}/shipping_contacts | Create a shipping contact
145
144
  *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
145
  *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
146
  *DigitalFemsa::ShippingsApi* | [**orders_create_shipping**](docs/ShippingsApi.md#orders_create_shipping) | **POST** /orders/{id}/shipping_lines | Create Shipping
@@ -151,20 +150,20 @@ Class | Method | HTTP request | Description
151
150
  *DigitalFemsa::TaxesApi* | [**orders_delete_taxes**](docs/TaxesApi.md#orders_delete_taxes) | **DELETE** /orders/{id}/tax_lines/{tax_id} | Delete Tax
152
151
  *DigitalFemsa::TaxesApi* | [**orders_update_taxes**](docs/TaxesApi.md#orders_update_taxes) | **PUT** /orders/{id}/tax_lines/{tax_id} | Update Tax
153
152
  *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
153
+ *DigitalFemsa::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | List transactions
154
+ *DigitalFemsa::TransfersApi* | [**get_transfer**](docs/TransfersApi.md#get_transfer) | **GET** /transfers/{id} | Get transfer
155
+ *DigitalFemsa::TransfersApi* | [**get_transfers**](docs/TransfersApi.md#get_transfers) | **GET** /transfers | List transfers
157
156
  *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
157
+ *DigitalFemsa::WebhookKeysApi* | [**delete_webhook_key**](docs/WebhookKeysApi.md#delete_webhook_key) | **DELETE** /webhook_keys/{id} | Delete webhook key
158
+ *DigitalFemsa::WebhookKeysApi* | [**get_webhook_key**](docs/WebhookKeysApi.md#get_webhook_key) | **GET** /webhook_keys/{id} | Get webhook key
160
159
  *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
160
+ *DigitalFemsa::WebhookKeysApi* | [**update_webhook_key**](docs/WebhookKeysApi.md#update_webhook_key) | **PUT** /webhook_keys/{id} | Update webhook key
162
161
  *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
162
+ *DigitalFemsa::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete webhook
163
+ *DigitalFemsa::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{id} | Get webhook
165
164
  *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
165
+ *DigitalFemsa::WebhooksApi* | [**test_webhook**](docs/WebhooksApi.md#test_webhook) | **POST** /webhooks/{id}/test | Test webhook
166
+ *DigitalFemsa::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks/{id} | Update webhook
168
167
 
169
168
 
170
169
  ## Documentation for Models
@@ -177,6 +176,7 @@ Class | Method | HTTP request | Description
177
176
  - [DigitalFemsa::BalanceCommonField](docs/BalanceCommonField.md)
178
177
  - [DigitalFemsa::BalanceResponse](docs/BalanceResponse.md)
179
178
  - [DigitalFemsa::ChargeOrderResponse](docs/ChargeOrderResponse.md)
179
+ - [DigitalFemsa::ChargeOrderResponseChannel](docs/ChargeOrderResponseChannel.md)
180
180
  - [DigitalFemsa::ChargeOrderResponsePaymentMethod](docs/ChargeOrderResponsePaymentMethod.md)
181
181
  - [DigitalFemsa::ChargeRequest](docs/ChargeRequest.md)
182
182
  - [DigitalFemsa::ChargeRequestPaymentMethod](docs/ChargeRequestPaymentMethod.md)
@@ -202,8 +202,6 @@ Class | Method | HTTP request | Description
202
202
  - [DigitalFemsa::CreateCustomerPaymentMethodsResponse](docs/CreateCustomerPaymentMethodsResponse.md)
203
203
  - [DigitalFemsa::Customer](docs/Customer.md)
204
204
  - [DigitalFemsa::CustomerAddress](docs/CustomerAddress.md)
205
- - [DigitalFemsa::CustomerAntifraudInfo](docs/CustomerAntifraudInfo.md)
206
- - [DigitalFemsa::CustomerAntifraudInfoResponse](docs/CustomerAntifraudInfoResponse.md)
207
205
  - [DigitalFemsa::CustomerFiscalEntitiesDataResponse](docs/CustomerFiscalEntitiesDataResponse.md)
208
206
  - [DigitalFemsa::CustomerFiscalEntitiesRequest](docs/CustomerFiscalEntitiesRequest.md)
209
207
  - [DigitalFemsa::CustomerFiscalEntitiesResponse](docs/CustomerFiscalEntitiesResponse.md)
@@ -255,12 +253,11 @@ Class | Method | HTTP request | Description
255
253
  - [DigitalFemsa::OrderFiscalEntityAddressResponse](docs/OrderFiscalEntityAddressResponse.md)
256
254
  - [DigitalFemsa::OrderFiscalEntityRequest](docs/OrderFiscalEntityRequest.md)
257
255
  - [DigitalFemsa::OrderFiscalEntityResponse](docs/OrderFiscalEntityResponse.md)
258
- - [DigitalFemsa::OrderNextActionResponse](docs/OrderNextActionResponse.md)
259
- - [DigitalFemsa::OrderNextActionResponseRedirectToUrl](docs/OrderNextActionResponseRedirectToUrl.md)
260
256
  - [DigitalFemsa::OrderRefundRequest](docs/OrderRefundRequest.md)
261
257
  - [DigitalFemsa::OrderRequest](docs/OrderRequest.md)
262
258
  - [DigitalFemsa::OrderRequestCustomerInfo](docs/OrderRequestCustomerInfo.md)
263
259
  - [DigitalFemsa::OrderResponse](docs/OrderResponse.md)
260
+ - [DigitalFemsa::OrderResponseChannel](docs/OrderResponseChannel.md)
264
261
  - [DigitalFemsa::OrderResponseCharges](docs/OrderResponseCharges.md)
265
262
  - [DigitalFemsa::OrderResponseCheckout](docs/OrderResponseCheckout.md)
266
263
  - [DigitalFemsa::OrderResponseCustomerInfo](docs/OrderResponseCustomerInfo.md)
@@ -284,14 +281,12 @@ Class | Method | HTTP request | Description
284
281
  - [DigitalFemsa::ProductOrderResponse](docs/ProductOrderResponse.md)
285
282
  - [DigitalFemsa::ShippingOrderResponse](docs/ShippingOrderResponse.md)
286
283
  - [DigitalFemsa::ShippingRequest](docs/ShippingRequest.md)
287
- - [DigitalFemsa::SmsCheckoutRequest](docs/SmsCheckoutRequest.md)
288
284
  - [DigitalFemsa::TransactionResponse](docs/TransactionResponse.md)
289
285
  - [DigitalFemsa::TransferDestinationResponse](docs/TransferDestinationResponse.md)
290
286
  - [DigitalFemsa::TransferMethodResponse](docs/TransferMethodResponse.md)
291
287
  - [DigitalFemsa::TransferResponse](docs/TransferResponse.md)
292
288
  - [DigitalFemsa::TransfersResponse](docs/TransfersResponse.md)
293
289
  - [DigitalFemsa::UpdateCustomer](docs/UpdateCustomer.md)
294
- - [DigitalFemsa::UpdateCustomerAntifraudInfo](docs/UpdateCustomerAntifraudInfo.md)
295
290
  - [DigitalFemsa::UpdateCustomerFiscalEntitiesResponse](docs/UpdateCustomerFiscalEntitiesResponse.md)
296
291
  - [DigitalFemsa::UpdateCustomerPaymentMethodsResponse](docs/UpdateCustomerPaymentMethodsResponse.md)
297
292
  - [DigitalFemsa::UpdateOrderDiscountLinesRequest](docs/UpdateOrderDiscountLinesRequest.md)
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.0
1
+ 1.1.0
data/config-ruby.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "gemAuthor": "DigitalFemsa",
4
4
  "gemName" : "digital_femsa",
5
5
  "gemLicense": "MIT",
6
- "gemVersion": "1.0.0",
6
+ "gemVersion": "1.1.0",
7
7
  "hideGenerationTimestamp": false,
8
8
  "moduleName": "DigitalFemsa",
9
9
  "gemSummary" : "This library provides https://api.digitalfemsa.io operations",
@@ -15,7 +15,7 @@
15
15
  | **object** | **String** | Object name, value is 'api_key' | [optional] |
16
16
  | **prefix** | **String** | The first few characters of the authentication_token | [optional] |
17
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] |
18
+ | **authentication_token** | **String** | Used as the username for Basic Authentication, with a blank password. This value is shown only once (when the key is created). Copy and store it securely. | [optional] |
19
19
 
20
20
  ## Example
21
21
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
8
- | **role** | **String** | | |
7
+ | **description** | **String** | A name or brief explanation of what this API key is used for. | [optional] |
8
+ | **role** | **String** | Defines the type of API key to create. Only \"private\" is supported for creation. A \"public\" API key already exists by default per company/environment. | |
9
9
 
10
10
  ## Example
11
11
 
@@ -20,14 +20,14 @@
20
20
  require 'digital_femsa'
21
21
 
22
22
  instance = DigitalFemsa::ApiKeyResponseOnDelete.new(
23
- active: true,
23
+ active: false,
24
24
  created_at: 1684167881,
25
25
  description: online store,
26
26
  livemode: false,
27
27
  prefix: key_rp,
28
28
  id: 64625cc9f3e02c00163f5e4d,
29
29
  object: api_key,
30
- deleted: false,
30
+ deleted: true,
31
31
  role: private
32
32
  )
33
33
  ```
data/docs/ApiKeysApi.md CHANGED
@@ -4,10 +4,10 @@ All URIs are relative to *https://api.digitalfemsa.io*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_api_key**](ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create Api Key |
7
+ | [**create_api_key**](ApiKeysApi.md#create_api_key) | **POST** /api_keys | Create API key |
8
8
  | [**delete_api_key**](ApiKeysApi.md#delete_api_key) | **DELETE** /api_keys/{id} | Delete Api Key |
9
9
  | [**get_api_key**](ApiKeysApi.md#get_api_key) | **GET** /api_keys/{id} | Get Api Key |
10
- | [**get_api_keys**](ApiKeysApi.md#get_api_keys) | **GET** /api_keys | Get list of Api Keys |
10
+ | [**get_api_keys**](ApiKeysApi.md#get_api_keys) | **GET** /api_keys | List API keys |
11
11
  | [**update_api_key**](ApiKeysApi.md#update_api_key) | **PUT** /api_keys/{id} | Update Api Key |
12
12
 
13
13
 
@@ -15,9 +15,9 @@ All URIs are relative to *https://api.digitalfemsa.io*
15
15
 
16
16
  > <ApiKeyCreateResponse> create_api_key(api_key_request, opts)
17
17
 
18
- Create Api Key
18
+ Create API key
19
19
 
20
- Create a api key
20
+ Creates a new API key. The response includes an `authentication_token` that is shown only once (at creation time). Copy and store it securely.
21
21
 
22
22
  ### Examples
23
23
 
@@ -38,7 +38,7 @@ opts = {
38
38
  }
39
39
 
40
40
  begin
41
- # Create Api Key
41
+ # Create API key
42
42
  result = api_instance.create_api_key(api_key_request, opts)
43
43
  p result
44
44
  rescue DigitalFemsa::ApiError => e
@@ -54,7 +54,7 @@ This returns an Array which contains the response data, status code and headers.
54
54
 
55
55
  ```ruby
56
56
  begin
57
- # Create Api Key
57
+ # Create API key
58
58
  data, status_code, headers = api_instance.create_api_key_with_http_info(api_key_request, opts)
59
59
  p status_code # => 2xx
60
60
  p headers # => { ... }
@@ -238,9 +238,9 @@ end
238
238
 
239
239
  > <GetApiKeysResponse> get_api_keys(opts)
240
240
 
241
- Get list of Api Keys
241
+ List API keys
242
242
 
243
- Consume the list of api keys you have
243
+ Retrieves a paginated list of API keys for the authenticated account. Use the pagination parameters (`limit`, `next_page`, `previous_page`) to navigate through results. Use the `search` query parameter to perform a general search (for example by key `id` or description).
244
244
 
245
245
  ### Examples
246
246
 
@@ -264,7 +264,7 @@ opts = {
264
264
  }
265
265
 
266
266
  begin
267
- # Get list of Api Keys
267
+ # List API keys
268
268
  result = api_instance.get_api_keys(opts)
269
269
  p result
270
270
  rescue DigitalFemsa::ApiError => e
@@ -280,7 +280,7 @@ This returns an Array which contains the response data, status code and headers.
280
280
 
281
281
  ```ruby
282
282
  begin
283
- # Get list of Api Keys
283
+ # List API keys
284
284
  data, status_code, headers = api_instance.get_api_keys_with_http_info(opts)
285
285
  p status_code # => 2xx
286
286
  p headers # => { ... }
@@ -4,16 +4,16 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **available** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s available | [optional] |
7
+ | **available** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Amounts currently available, grouped by currency. | [optional] |
8
8
  | **cashout_retention_amount** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s cashout retention amount | [optional] |
9
9
  | **conekta_retention** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s Femsa retention | [optional] |
10
- | **gateway** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s gateway | [optional] |
11
- | **pending** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s pending | [optional] |
12
- | **retained** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s retained | [optional] |
13
- | **retention_amount** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s retention amount | [optional] |
14
- | **target_collateral_amount** | **Object** | The balance&#39;s target collateral amount | [optional] |
15
- | **target_retention_amount** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s target retention amount | [optional] |
16
- | **temporarily_retained** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | The balance&#39;s temporarily retained | [optional] |
10
+ | **gateway** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Gateway balance amounts, grouped by currency. | [optional] |
11
+ | **pending** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Amounts pending settlement, grouped by currency. | [optional] |
12
+ | **retained** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Amounts currently retained, grouped by currency. | [optional] |
13
+ | **retention_amount** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Retention amount applied, grouped by currency. | [optional] |
14
+ | **target_collateral_amount** | **Object** | Target collateral amount, grouped by currency. | [optional] |
15
+ | **target_retention_amount** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Target retention amount, grouped by currency. | [optional] |
16
+ | **temporarily_retained** | [**Array&lt;BalanceCommonField&gt;**](BalanceCommonField.md) | Amounts temporarily retained | [optional] |
17
17
 
18
18
  ## Example
19
19
 
data/docs/BalancesApi.md CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
13
13
 
14
14
  Get a company's balance
15
15
 
16
- Get a company's balance
16
+ Retrieves the current balance information for the authenticated company. Monetary fields are returned as arrays of amounts grouped by currency.
17
17
 
18
18
  ### Examples
19
19
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **amount** | **Integer** | | [optional] |
8
- | **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] |
8
+ | **channel** | [**ChargeOrderResponseChannel**](ChargeOrderResponseChannel.md) | | [optional] |
9
9
  | **created_at** | **Integer** | | [optional] |
10
10
  | **currency** | **String** | | [optional] |
11
11
  | **customer_id** | **String** | | [optional] |
@@ -0,0 +1,24 @@
1
+ # DigitalFemsa::ChargeOrderResponseChannel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **segment** | **String** | | [optional] |
8
+ | **checkout_request_id** | **String** | | [optional] |
9
+ | **checkout_request_type** | **String** | | [optional] |
10
+ | **id** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'digital_femsa'
16
+
17
+ instance = DigitalFemsa::ChargeOrderResponseChannel.new(
18
+ segment: Checkout,
19
+ checkout_request_id: 6fca054a-8519-4c43-971e-cea35cc519bb,
20
+ checkout_request_type: HostedPayment,
21
+ id: channel_2tNDzhA4Akmzj11AU
22
+ )
23
+ ```
24
+
@@ -16,7 +16,7 @@ require 'digital_femsa'
16
16
  instance = DigitalFemsa::ChargeRequest.new(
17
17
  amount: 40000,
18
18
  payment_method: null,
19
- reference_id: null
19
+ reference_id: ref_2tN73UdUSNrYRPD9r
20
20
  )
21
21
  ```
22
22
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **expires_at** | **Integer** | Method expiration date as unix timestamp | [optional] |
7
+ | **expires_at** | **Integer** | Method expiration date as unix timestamp (applies to some payment methods, e.g. cash). | [optional] |
8
8
  | **type** | **String** | | |
9
- | **payment_source_id** | **String** | | [optional] |
9
+ | **payment_source_id** | **String** | Identifier of a saved payment source to be used for this charge (if applicable). | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -14,7 +14,7 @@
14
14
  require 'digital_femsa'
15
15
 
16
16
  instance = DigitalFemsa::ChargeRequestPaymentMethod.new(
17
- expires_at: 1677196303,
17
+ expires_at: 1789928542,
18
18
  type: cash,
19
19
  payment_source_id: src_2tLkkyfMPh6v7pFry
20
20
  )
@@ -22,6 +22,7 @@
22
22
  | **reference_id** | **String** | Reference ID of the charge | [optional] |
23
23
  | **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] |
24
24
  | **status** | **String** | | [optional] |
25
+ | **is_refundable** | **Boolean** | | [optional] |
25
26
 
26
27
  ## Example
27
28
 
@@ -29,24 +30,25 @@
29
30
  require 'digital_femsa'
30
31
 
31
32
  instance = DigitalFemsa::ChargeResponse.new(
32
- amount: 4321,
33
+ amount: 600000,
33
34
  channel: null,
34
- created_at: 1676386026,
35
+ created_at: 1768581166,
35
36
  currency: MXN,
36
37
  customer_id: null,
37
38
  description: Payment from order,
38
39
  device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba,
39
40
  failure_code: suspected_fraud,
40
41
  failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
41
- id: 63efa757cf65380001aec040,
42
- livemode: null,
42
+ id: 696a682e1ef5ca00015698b7,
43
+ livemode: true,
43
44
  object: null,
44
- order_id: ord_2tN73UdUSNrYRPD9r,
45
- paid_at: 1676390742,
45
+ order_id: ord_2zNwzJrfNC24uQUzq,
46
+ paid_at: null,
46
47
  payment_method: null,
47
48
  reference_id: ref_2tN73UdUSNrYRPD9r,
48
49
  refunds: null,
49
- status: pending_payment
50
+ status: pending_payment,
51
+ is_refundable: false
50
52
  )
51
53
  ```
52
54
 
@@ -16,9 +16,9 @@ require 'digital_femsa'
16
16
 
17
17
  instance = DigitalFemsa::ChargeResponseChannel.new(
18
18
  segment: Checkout,
19
- checkout_request_id: 6fca054a-8519-4c43-971e-cea35cc519bb,
20
- checkout_request_type: HostedPayment,
21
- id: channel_2tNDzhA4Akmzj11AU
19
+ checkout_request_id: f3a5bfc1-ba1c-474f-9687-46d8b75ffc90,
20
+ checkout_request_type: Integration,
21
+ id: channel_2zNxD65G8MBNkYksy
22
22
  )
23
23
  ```
24
24
 
@@ -11,6 +11,8 @@
11
11
  | **id** | **String** | | |
12
12
  | **object** | **String** | | |
13
13
  | **status** | **String** | refund status | [optional] |
14
+ | **payout_id** | **String** | | [optional] |
15
+ | **reference** | **String** | payout reference for oxxo stores | [optional] |
14
16
 
15
17
  ## Example
16
18
 
@@ -24,7 +26,9 @@ instance = DigitalFemsa::ChargeResponseRefundsData.new(
24
26
  expires_at: 1678226878,
25
27
  id: 6407b5bee1329a000175ba11,
26
28
  object: refund,
27
- status: pending
29
+ status: pending,
30
+ payout_id: 6fca054a-8519-4c43-971e-cea35cc519bb,
31
+ reference: 12002000778626
28
32
  )
29
33
  ```
30
34
 
data/docs/ChargesApi.md CHANGED
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.digitalfemsa.io*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_charges**](ChargesApi.md#get_charges) | **GET** /charges | Get A List of Charges |
8
- | [**orders_create_charge**](ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge |
7
+ | [**get_charges**](ChargesApi.md#get_charges) | **GET** /charges | List charges |
8
+ | [**orders_create_charge**](ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create a charge for an order |
9
9
  | [**update_charge**](ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge |
10
10
 
11
11
 
@@ -13,7 +13,9 @@ All URIs are relative to *https://api.digitalfemsa.io*
13
13
 
14
14
  > <GetChargesResponse> get_charges(opts)
15
15
 
16
- Get A List of Charges
16
+ List charges
17
+
18
+ Retrieves a paginated list of charges for the authenticated account. Use the pagination parameters (`limit`, `next_page`, `previous_page`) to navigate through results. Use `search` to filter charges (for example by id or reference).
17
19
 
18
20
  ### Examples
19
21
 
@@ -31,13 +33,13 @@ opts = {
31
33
  accept_language: 'es', # String | Use for knowing which language to use
32
34
  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.
33
35
  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
34
- search: 'search_example', # String | General order search, e.g. by mail, reference etc.
35
36
  _next: '_next_example', # String | next page
36
- previous: 'previous_example' # String | previous page
37
+ previous: 'previous_example', # String | previous page
38
+ search: 'search_example' # String | General order search, e.g. by mail, reference etc.
37
39
  }
38
40
 
39
41
  begin
40
- # Get A List of Charges
42
+ # List charges
41
43
  result = api_instance.get_charges(opts)
42
44
  p result
43
45
  rescue DigitalFemsa::ApiError => e
@@ -53,7 +55,7 @@ This returns an Array which contains the response data, status code and headers.
53
55
 
54
56
  ```ruby
55
57
  begin
56
- # Get A List of Charges
58
+ # List charges
57
59
  data, status_code, headers = api_instance.get_charges_with_http_info(opts)
58
60
  p status_code # => 2xx
59
61
  p headers # => { ... }
@@ -70,9 +72,9 @@ end
70
72
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
71
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] |
72
74
  | **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
73
- | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
74
75
  | **_next** | **String** | next page | [optional] |
75
76
  | **previous** | **String** | previous page | [optional] |
77
+ | **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
76
78
 
77
79
  ### Return type
78
80
 
@@ -92,9 +94,9 @@ end
92
94
 
93
95
  > <ChargeOrderResponse> orders_create_charge(id, charge_request, opts)
94
96
 
95
- Create charge
97
+ Create a charge for an order
96
98
 
97
- Create charge for an existing orden
99
+ Creates a new charge associated with an existing order. Notes: - The charge is created for the order identified by the path parameter `id`. - Depending on the payment method, the charge may be created in a non-final status (for example, pending). - If the order does not meet the required conditions, the API may respond with **428 Precondition Required**.
98
100
 
99
101
  ### Examples
100
102
 
@@ -116,7 +118,7 @@ opts = {
116
118
  }
117
119
 
118
120
  begin
119
- # Create charge
121
+ # Create a charge for an order
120
122
  result = api_instance.orders_create_charge(id, charge_request, opts)
121
123
  p result
122
124
  rescue DigitalFemsa::ApiError => e
@@ -132,7 +134,7 @@ This returns an Array which contains the response data, status code and headers.
132
134
 
133
135
  ```ruby
134
136
  begin
135
- # Create charge
137
+ # Create a charge for an order
136
138
  data, status_code, headers = api_instance.orders_create_charge_with_http_info(id, charge_request, opts)
137
139
  p status_code # => 2xx
138
140
  p headers # => { ... }
@@ -171,6 +173,8 @@ end
171
173
 
172
174
  Update a charge
173
175
 
176
+ Updates an existing charge. Only `reference_id` can be updated.
177
+
174
178
  ### Examples
175
179
 
176
180
  ```ruby