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
@@ -19,8 +19,8 @@ module DigitalFemsa
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create Api Key
23
- # Create a api key
22
+ # Create API key
23
+ # Creates a new API key. The response includes an `authentication_token` that is shown only once (at creation time). Copy and store it securely.
24
24
  # @param api_key_request [ApiKeyRequest] requested field for a api keys
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -31,8 +31,8 @@ module DigitalFemsa
31
31
  data
32
32
  end
33
33
 
34
- # Create Api Key
35
- # Create a api key
34
+ # Create API key
35
+ # Creates a new API key. The response includes an `authentication_token` that is shown only once (at creation time). Copy and store it securely.
36
36
  # @param api_key_request [ApiKeyRequest] requested field for a api keys
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -240,8 +240,8 @@ module DigitalFemsa
240
240
  return data, status_code, headers
241
241
  end
242
242
 
243
- # Get list of Api Keys
244
- # Consume the list of api keys you have
243
+ # List API keys
244
+ # 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).
245
245
  # @param [Hash] opts the optional parameters
246
246
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
247
247
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -255,8 +255,8 @@ module DigitalFemsa
255
255
  data
256
256
  end
257
257
 
258
- # Get list of Api Keys
259
- # Consume the list of api keys you have
258
+ # List API keys
259
+ # 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).
260
260
  # @param [Hash] opts the optional parameters
261
261
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
262
262
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -20,7 +20,7 @@ module DigitalFemsa
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get a company's balance
23
- # Get a company's balance
23
+ # Retrieves the current balance information for the authenticated company. Monetary fields are returned as arrays of amounts grouped by currency.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
26
26
  # @return [BalanceResponse]
@@ -30,7 +30,7 @@ module DigitalFemsa
30
30
  end
31
31
 
32
32
  # Get a company's balance
33
- # Get a company's balance
33
+ # Retrieves the current balance information for the authenticated company. Monetary fields are returned as arrays of amounts grouped by currency.
34
34
  # @param [Hash] opts the optional parameters
35
35
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
36
36
  # @return [Array<(BalanceResponse, Integer, Hash)>] BalanceResponse data, response status code and response headers
@@ -19,28 +19,30 @@ module DigitalFemsa
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get A List of Charges
22
+ # List charges
23
+ # 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).
23
24
  # @param [Hash] opts the optional parameters
24
25
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
25
26
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
26
27
  # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
27
- # @option opts [String] :search General order search, e.g. by mail, reference etc.
28
28
  # @option opts [String] :_next next page
29
29
  # @option opts [String] :previous previous page
30
+ # @option opts [String] :search General order search, e.g. by mail, reference etc.
30
31
  # @return [GetChargesResponse]
31
32
  def get_charges(opts = {})
32
33
  data, _status_code, _headers = get_charges_with_http_info(opts)
33
34
  data
34
35
  end
35
36
 
36
- # Get A List of Charges
37
+ # List charges
38
+ # Retrieves a paginated list of charges for the authenticated account. Use the pagination parameters (&#x60;limit&#x60;, &#x60;next_page&#x60;, &#x60;previous_page&#x60;) to navigate through results. Use &#x60;search&#x60; to filter charges (for example by id or reference).
37
39
  # @param [Hash] opts the optional parameters
38
40
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
39
41
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
40
42
  # @option opts [Integer] :limit The numbers of items to return, the maximum value is 250 (default to 20)
41
- # @option opts [String] :search General order search, e.g. by mail, reference etc.
42
43
  # @option opts [String] :_next next page
43
44
  # @option opts [String] :previous previous page
45
+ # @option opts [String] :search General order search, e.g. by mail, reference etc.
44
46
  # @return [Array<(GetChargesResponse, Integer, Hash)>] GetChargesResponse data, response status code and response headers
45
47
  def get_charges_with_http_info(opts = {})
46
48
  if @api_client.config.debugging
@@ -64,9 +66,9 @@ module DigitalFemsa
64
66
  # query parameters
65
67
  query_params = opts[:query_params] || {}
66
68
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
67
- query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
68
69
  query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil?
69
70
  query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil?
71
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
70
72
 
71
73
  # header parameters
72
74
  header_params = opts[:header_params] || {}
@@ -104,8 +106,8 @@ module DigitalFemsa
104
106
  return data, status_code, headers
105
107
  end
106
108
 
107
- # Create charge
108
- # Create charge for an existing orden
109
+ # Create a charge for an order
110
+ # 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**.
109
111
  # @param id [String] Identifier of the resource
110
112
  # @param charge_request [ChargeRequest] requested field for a charge
111
113
  # @param [Hash] opts the optional parameters
@@ -117,8 +119,8 @@ module DigitalFemsa
117
119
  data
118
120
  end
119
121
 
120
- # Create charge
121
- # Create charge for an existing orden
122
+ # Create a charge for an order
123
+ # Creates a new charge associated with an existing order. Notes: - The charge is created for the order identified by the path parameter &#x60;id&#x60;. - 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**.
122
124
  # @param id [String] Identifier of the resource
123
125
  # @param charge_request [ChargeRequest] requested field for a charge
124
126
  # @param [Hash] opts the optional parameters
@@ -189,6 +191,7 @@ module DigitalFemsa
189
191
  end
190
192
 
191
193
  # Update a charge
194
+ # Updates an existing charge. Only `reference_id` can be updated.
192
195
  # @param id [String] Identifier of the resource
193
196
  # @param charge_update_request [ChargeUpdateRequest] requested field for update a charge
194
197
  # @param [Hash] opts the optional parameters
@@ -201,6 +204,7 @@ module DigitalFemsa
201
204
  end
202
205
 
203
206
  # Update a charge
207
+ # Updates an existing charge. Only &#x60;reference_id&#x60; can be updated.
204
208
  # @param id [String] Identifier of the resource
205
209
  # @param charge_update_request [ChargeUpdateRequest] requested field for update a charge
206
210
  # @param [Hash] opts the optional parameters
@@ -19,8 +19,8 @@ module DigitalFemsa
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create customer
23
- # The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer.
22
+ # Create a customer
23
+ # Creates a new customer for the authenticated company. Use customers to store and reuse buyer information (for example name, email, phone, and addresses). The created customer can be referenced later when creating orders and other resources.
24
24
  # @param customer [Customer] requested field for customer
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -31,8 +31,8 @@ module DigitalFemsa
31
31
  data
32
32
  end
33
33
 
34
- # Create customer
35
- # The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer.
34
+ # Create a customer
35
+ # Creates a new customer for the authenticated company. Use customers to store and reuse buyer information (for example name, email, phone, and addresses). The created customer can be referenced later when creating orders and other resources.
36
36
  # @param customer [Customer] requested field for customer
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -98,7 +98,7 @@ module DigitalFemsa
98
98
  end
99
99
 
100
100
  # Create Fiscal Entity
101
- # Create Fiscal entity resource that corresponds to a customer ID.
101
+ # Create a fiscal entity resource for a given customer ID.
102
102
  # @param id [String] Identifier of the resource
103
103
  # @param customer_fiscal_entities_request [CustomerFiscalEntitiesRequest] requested field for customer fiscal entities
104
104
  # @param [Hash] opts the optional parameters
@@ -111,7 +111,7 @@ module DigitalFemsa
111
111
  end
112
112
 
113
113
  # Create Fiscal Entity
114
- # Create Fiscal entity resource that corresponds to a customer ID.
114
+ # Create a fiscal entity resource for a given customer ID.
115
115
  # @param id [String] Identifier of the resource
116
116
  # @param customer_fiscal_entities_request [CustomerFiscalEntitiesRequest] requested field for customer fiscal entities
117
117
  # @param [Hash] opts the optional parameters
@@ -328,7 +328,7 @@ module DigitalFemsa
328
328
  end
329
329
 
330
330
  # Get a list of customers
331
- # The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.
331
+ # Returns a paginated list of customers for the authenticated company. Use the [search] parameter to filter results.
332
332
  # @param [Hash] opts the optional parameters
333
333
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
334
334
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -343,7 +343,7 @@ module DigitalFemsa
343
343
  end
344
344
 
345
345
  # Get a list of customers
346
- # The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.
346
+ # Returns a paginated list of customers for the authenticated company. Use the [search] parameter to filter results.
347
347
  # @param [Hash] opts the optional parameters
348
348
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
349
349
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -498,11 +498,11 @@ module DigitalFemsa
498
498
  return data, status_code, headers
499
499
  end
500
500
 
501
- # Update Fiscal Entity
501
+ # Update Fiscal Entity
502
502
  # Update Fiscal Entity resource that corresponds to a customer ID.
503
503
  # @param id [String] Identifier of the resource
504
504
  # @param fiscal_entities_id [String] identifier
505
- # @param customer_update_fiscal_entities_request [CustomerUpdateFiscalEntitiesRequest] requested field for customer update fiscal entities
505
+ # @param customer_update_fiscal_entities_request [CustomerUpdateFiscalEntitiesRequest] Request body for updating a customer fiscal entity.
506
506
  # @param [Hash] opts the optional parameters
507
507
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
508
508
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -512,11 +512,11 @@ module DigitalFemsa
512
512
  data
513
513
  end
514
514
 
515
- # Update Fiscal Entity
515
+ # Update Fiscal Entity
516
516
  # Update Fiscal Entity resource that corresponds to a customer ID.
517
517
  # @param id [String] Identifier of the resource
518
518
  # @param fiscal_entities_id [String] identifier
519
- # @param customer_update_fiscal_entities_request [CustomerUpdateFiscalEntitiesRequest] requested field for customer update fiscal entities
519
+ # @param customer_update_fiscal_entities_request [CustomerUpdateFiscalEntitiesRequest] Request body for updating a customer fiscal entity.
520
520
  # @param [Hash] opts the optional parameters
521
521
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
522
522
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -20,7 +20,7 @@ module DigitalFemsa
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Discount
23
- # Create discount lines for an existing orden
23
+ # Create discount lines for an existing order
24
24
  # @param id [String] Identifier of the resource
25
25
  # @param order_discount_lines_request [OrderDiscountLinesRequest] requested field for a discount lines
26
26
  # @param [Hash] opts the optional parameters
@@ -33,7 +33,7 @@ module DigitalFemsa
33
33
  end
34
34
 
35
35
  # Create Discount
36
- # Create discount lines for an existing orden
36
+ # Create discount lines for an existing order
37
37
  # @param id [String] Identifier of the resource
38
38
  # @param order_discount_lines_request [OrderDiscountLinesRequest] requested field for a discount lines
39
39
  # @param [Hash] opts the optional parameters
@@ -104,7 +104,7 @@ module DigitalFemsa
104
104
  end
105
105
 
106
106
  # Delete Discount
107
- # Delete an existing discount lines for an existing orden
107
+ # Delete an existing discount line for an existing order
108
108
  # @param id [String] Identifier of the resource
109
109
  # @param discount_lines_id [String] discount line id identifier
110
110
  # @param [Hash] opts the optional parameters
@@ -117,7 +117,7 @@ module DigitalFemsa
117
117
  end
118
118
 
119
119
  # Delete Discount
120
- # Delete an existing discount lines for an existing orden
120
+ # Delete an existing discount line for an existing order
121
121
  # @param id [String] Identifier of the resource
122
122
  # @param discount_lines_id [String] discount line id identifier
123
123
  # @param [Hash] opts the optional parameters
@@ -183,7 +183,7 @@ module DigitalFemsa
183
183
  end
184
184
 
185
185
  # Get Discount
186
- # Get an existing discount lines for an existing orden
186
+ # Get an existing discount line for an existing order
187
187
  # @param id [String] Identifier of the resource
188
188
  # @param discount_lines_id [String] discount line id identifier
189
189
  # @param [Hash] opts the optional parameters
@@ -196,7 +196,7 @@ module DigitalFemsa
196
196
  end
197
197
 
198
198
  # Get Discount
199
- # Get an existing discount lines for an existing orden
199
+ # Get an existing discount line for an existing order
200
200
  # @param id [String] Identifier of the resource
201
201
  # @param discount_lines_id [String] discount line id identifier
202
202
  # @param [Hash] opts the optional parameters
@@ -261,8 +261,8 @@ module DigitalFemsa
261
261
  return data, status_code, headers
262
262
  end
263
263
 
264
- # Get a List of Discount
265
- # Get discount lines for an existing orden
264
+ # Get a List of Discounts
265
+ # Get discount lines for an existing order
266
266
  # @param id [String] Identifier of the resource
267
267
  # @param [Hash] opts the optional parameters
268
268
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -277,8 +277,8 @@ module DigitalFemsa
277
277
  data
278
278
  end
279
279
 
280
- # Get a List of Discount
281
- # Get discount lines for an existing orden
280
+ # Get a List of Discounts
281
+ # Get discount lines for an existing order
282
282
  # @param id [String] Identifier of the resource
283
283
  # @param [Hash] opts the optional parameters
284
284
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -355,7 +355,7 @@ module DigitalFemsa
355
355
  end
356
356
 
357
357
  # Update Discount
358
- # Update an existing discount lines for an existing orden
358
+ # Update an existing discount line for an existing order
359
359
  # @param id [String] Identifier of the resource
360
360
  # @param discount_lines_id [String] discount line id identifier
361
361
  # @param update_order_discount_lines_request [UpdateOrderDiscountLinesRequest] requested field for a discount lines
@@ -369,7 +369,7 @@ module DigitalFemsa
369
369
  end
370
370
 
371
371
  # Update Discount
372
- # Update an existing discount lines for an existing orden
372
+ # Update an existing discount line for an existing order
373
373
  # @param id [String] Identifier of the resource
374
374
  # @param discount_lines_id [String] discount line id identifier
375
375
  # @param update_order_discount_lines_request [UpdateOrderDiscountLinesRequest] requested field for a discount lines
@@ -20,7 +20,7 @@ module DigitalFemsa
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get Event
23
- # Returns a single event
23
+ # Returns a single event by its ID, including its payload (`data`) and webhook delivery information. The `webhook_status` indicates whether webhook notifications were applicable and their overall status. The [webhook_logs]) array contains delivery attempts (it can be empty when webhook notifications are not applicable or no attempts were created).
24
24
  # @param id [String] Identifier of the resource
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -32,7 +32,7 @@ module DigitalFemsa
32
32
  end
33
33
 
34
34
  # Get Event
35
- # Returns a single event
35
+ # Returns a single event by its ID, including its payload (&#x60;data&#x60;) and webhook delivery information. The &#x60;webhook_status&#x60; indicates whether webhook notifications were applicable and their overall status. The [webhook_logs]) array contains delivery attempts (it can be empty when webhook notifications are not applicable or no attempts were created).
36
36
  # @param id [String] Identifier of the resource
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -178,7 +178,7 @@ module DigitalFemsa
178
178
  end
179
179
 
180
180
  # Resend Event
181
- # Try to send an event
181
+ # Triggers a new delivery attempt for a specific webhook log associated with the given event. Use this endpoint to retry failed webhook deliveries (for example, non-2xx responses or timeouts). The response returns the updated webhook log with the latest attempt metadata.
182
182
  # @param event_id [String] event identifier
183
183
  # @param webhook_log_id [String] webhook log identifier
184
184
  # @param [Hash] opts the optional parameters
@@ -190,7 +190,7 @@ module DigitalFemsa
190
190
  end
191
191
 
192
192
  # Resend Event
193
- # Try to send an event
193
+ # Triggers a new delivery attempt for a specific webhook log associated with the given event. Use this endpoint to retry failed webhook deliveries (for example, non-2xx responses or timeouts). The response returns the updated webhook log with the latest attempt metadata.
194
194
  # @param event_id [String] event identifier
195
195
  # @param webhook_log_id [String] webhook log identifier
196
196
  # @param [Hash] opts the optional parameters
@@ -93,7 +93,7 @@ module DigitalFemsa
93
93
  end
94
94
 
95
95
  # Get List Of Logs
96
- # Get log details in the form of a list
96
+ # Returns a paginated list of logs generated by the platform. Logs can be used for troubleshooting and auditing requests and internal operations. Use pagination parameters to navigate through results, and `search` to filter by supported criteria.
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
99
99
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -108,7 +108,7 @@ module DigitalFemsa
108
108
  end
109
109
 
110
110
  # Get List Of Logs
111
- # Get log details in the form of a list
111
+ # Returns a paginated list of logs generated by the platform. Logs can be used for troubleshooting and auditing requests and internal operations. Use pagination parameters to navigate through results, and &#x60;search&#x60; to filter by supported criteria.
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
114
114
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -20,7 +20,7 @@ module DigitalFemsa
20
20
  @api_client = api_client
21
21
  end
22
22
  # Cancel Order
23
- # Cancel an order that has been previously created.
23
+ # Cancels an existing order. This operation marks the order as cancelled and prevents further processing depending on its current state. If the order cannot be cancelled (for example, due to its status or related charge constraints), the API returns an error response.
24
24
  # @param id [String] Identifier of the resource
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -32,7 +32,7 @@ module DigitalFemsa
32
32
  end
33
33
 
34
34
  # Cancel Order
35
- # Cancel an order that has been previously created.
35
+ # Cancels an existing order. This operation marks the order as cancelled and prevents further processing depending on its current state. If the order cannot be cancelled (for example, due to its status or related charge constraints), the API returns an error response.
36
36
  # @param id [String] Identifier of the resource
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -93,7 +93,7 @@ module DigitalFemsa
93
93
  end
94
94
 
95
95
  # Create order
96
- # Create a new order.
96
+ # Creates a new order (products + amounts + customer data). Minimum required fields: - `currency` - `line_items` - `customer_info` About `customer_info`: - You can reference an existing customer using `customer_info.customer_id`, or - You can provide customer details at minimum `customer_info.name` and `customer_info.email` to create the order with customer context. How to create the order: - Create an order only (no payment): send only the order data. - Create an order and create the first payment charge: include `charges`. - Create an order with a checkout configuration (for a hosted payment flow): include `checkout`. Important rules: - You cannot send `charges` and `checkout` in the same request (they are mutually exclusive). - If you send `shipping_contact_id` and/or `fiscal_entity_id`, you must also send `customer_info.customer_id` so the API can validate those IDs against that customer.
97
97
  # @param order_request [OrderRequest] requested field for order
98
98
  # @param [Hash] opts the optional parameters
99
99
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -105,7 +105,7 @@ module DigitalFemsa
105
105
  end
106
106
 
107
107
  # Create order
108
- # Create a new order.
108
+ # Creates a new order (products + amounts + customer data). Minimum required fields: - &#x60;currency&#x60; - &#x60;line_items&#x60; - &#x60;customer_info&#x60; About &#x60;customer_info&#x60;: - You can reference an existing customer using &#x60;customer_info.customer_id&#x60;, or - You can provide customer details at minimum &#x60;customer_info.name&#x60; and &#x60;customer_info.email&#x60; to create the order with customer context. How to create the order: - Create an order only (no payment): send only the order data. - Create an order and create the first payment charge: include &#x60;charges&#x60;. - Create an order with a checkout configuration (for a hosted payment flow): include &#x60;checkout&#x60;. Important rules: - You cannot send &#x60;charges&#x60; and &#x60;checkout&#x60; in the same request (they are mutually exclusive). - If you send &#x60;shipping_contact_id&#x60; and/or &#x60;fiscal_entity_id&#x60;, you must also send &#x60;customer_info.customer_id&#x60; so the API can validate those IDs against that customer.
109
109
  # @param order_request [OrderRequest] requested field for order
110
110
  # @param [Hash] opts the optional parameters
111
111
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -171,7 +171,7 @@ module DigitalFemsa
171
171
  end
172
172
 
173
173
  # Get Order
174
- # Info for a specific order
174
+ # Returns the full details of an Order by its ID. The response follows the standard Order representation, including nested previews (for example `charges`, `line_items`, `shipping_lines`, `tax_lines`, and `discount_lines`) when available.
175
175
  # @param id [String] Identifier of the resource
176
176
  # @param [Hash] opts the optional parameters
177
177
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -183,7 +183,7 @@ module DigitalFemsa
183
183
  end
184
184
 
185
185
  # Get Order
186
- # Info for a specific order
186
+ # Returns the full details of an Order by its ID. The response follows the standard Order representation, including nested previews (for example &#x60;charges&#x60;, &#x60;line_items&#x60;, &#x60;shipping_lines&#x60;, &#x60;tax_lines&#x60;, and &#x60;discount_lines&#x60;) when available.
187
187
  # @param id [String] Identifier of the resource
188
188
  # @param [Hash] opts the optional parameters
189
189
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
@@ -244,7 +244,7 @@ module DigitalFemsa
244
244
  end
245
245
 
246
246
  # Get a list of Orders
247
- # Get order details in the form of a list
247
+ # Returns a paginated list of orders created in your account. Use pagination parameters to navigate through results, and `search` to filter by supported criteria.
248
248
  # @param [Hash] opts the optional parameters
249
249
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
250
250
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -259,7 +259,7 @@ module DigitalFemsa
259
259
  end
260
260
 
261
261
  # Get a list of Orders
262
- # Get order details in the form of a list
262
+ # Returns a paginated list of orders created in your account. Use pagination parameters to navigate through results, and &#x60;search&#x60; to filter by supported criteria.
263
263
  # @param [Hash] opts the optional parameters
264
264
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
265
265
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
@@ -331,7 +331,7 @@ module DigitalFemsa
331
331
  end
332
332
 
333
333
  # Cancel Refund
334
- # A refunded order describes the items, amount, and reason an order is being refunded.
334
+ # Cancels a refund previously created for an order. This operation is only available when the refund is still cancellable according to its current status and the payment method rules. If the refund cannot be cancelled, the API returns an error response.
335
335
  # @param id [String] Identifier of the resource
336
336
  # @param refund_id [String] refund identifier
337
337
  # @param [Hash] opts the optional parameters
@@ -344,7 +344,7 @@ module DigitalFemsa
344
344
  end
345
345
 
346
346
  # Cancel Refund
347
- # A refunded order describes the items, amount, and reason an order is being refunded.
347
+ # Cancels a refund previously created for an order. This operation is only available when the refund is still cancellable according to its current status and the payment method rules. If the refund cannot be cancelled, the API returns an error response.
348
348
  # @param id [String] Identifier of the resource
349
349
  # @param refund_id [String] refund identifier
350
350
  # @param [Hash] opts the optional parameters
@@ -410,7 +410,7 @@ module DigitalFemsa
410
410
  end
411
411
 
412
412
  # Refund Order
413
- # A refunded order describes the items, amount, and reason an order is being refunded.
413
+ # Creates a refund for an order. This operation is used to refund a previously paid order (fully or partially, depending on the request body). The API will validate the order and its related charges before processing the refund. If the refund cannot be created due to business rules or state, an error response is returned.
414
414
  # @param id [String] Identifier of the resource
415
415
  # @param order_refund_request [OrderRefundRequest] requested field for a refund
416
416
  # @param [Hash] opts the optional parameters
@@ -423,7 +423,7 @@ module DigitalFemsa
423
423
  end
424
424
 
425
425
  # Refund Order
426
- # A refunded order describes the items, amount, and reason an order is being refunded.
426
+ # Creates a refund for an order. This operation is used to refund a previously paid order (fully or partially, depending on the request body). The API will validate the order and its related charges before processing the refund. If the refund cannot be created due to business rules or state, an error response is returned.
427
427
  # @param id [String] Identifier of the resource
428
428
  # @param order_refund_request [OrderRefundRequest] requested field for a refund
429
429
  # @param [Hash] opts the optional parameters
@@ -494,12 +494,12 @@ module DigitalFemsa
494
494
  end
495
495
 
496
496
  # Capture Order
497
- # Processes an order that has been previously authorized.
497
+ # Captures (finalizes) an order that has been previously authorized. Use this endpoint to capture a specific amount. The captured amount must be greater than 0 and must comply with the order and charge constraints enforced by the API.
498
498
  # @param id [String] Identifier of the resource
499
499
  # @param [Hash] opts the optional parameters
500
500
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
501
501
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
502
- # @option opts [OrderCaptureRequest] :order_capture_request requested fields for capture order
502
+ # @option opts [OrderCaptureRequest] :order_capture_request Requested fields for capturing an order
503
503
  # @return [OrderResponse]
504
504
  def orders_create_capture(id, opts = {})
505
505
  data, _status_code, _headers = orders_create_capture_with_http_info(id, opts)
@@ -507,12 +507,12 @@ module DigitalFemsa
507
507
  end
508
508
 
509
509
  # Capture Order
510
- # Processes an order that has been previously authorized.
510
+ # Captures (finalizes) an order that has been previously authorized. Use this endpoint to capture a specific amount. The captured amount must be greater than 0 and must comply with the order and charge constraints enforced by the API.
511
511
  # @param id [String] Identifier of the resource
512
512
  # @param [Hash] opts the optional parameters
513
513
  # @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
514
514
  # @option opts [String] :x_child_company_id In the case of a holding company, the company id of the child company to which will process the request.
515
- # @option opts [OrderCaptureRequest] :order_capture_request requested fields for capture order
515
+ # @option opts [OrderCaptureRequest] :order_capture_request Requested fields for capturing an order
516
516
  # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
517
517
  def orders_create_capture_with_http_info(id, opts = {})
518
518
  if @api_client.config.debugging
@@ -573,8 +573,8 @@ module DigitalFemsa
573
573
  return data, status_code, headers
574
574
  end
575
575
 
576
- # Update Order
577
- # Update an existing Order.
576
+ # Update order
577
+ # Updates an existing order by its ID. Orders are the central resource in the API. Updating an order may also update related order sub-resources when they are included in the request payload, according to server-side validations. Only fields supported by the API can be modified.
578
578
  # @param id [String] Identifier of the resource
579
579
  # @param order_update_request [OrderUpdateRequest] requested field for an order
580
580
  # @param [Hash] opts the optional parameters
@@ -585,8 +585,8 @@ module DigitalFemsa
585
585
  data
586
586
  end
587
587
 
588
- # Update Order
589
- # Update an existing Order.
588
+ # Update order
589
+ # Updates an existing order by its ID. Orders are the central resource in the API. Updating an order may also update related order sub-resources when they are included in the request payload, according to server-side validations. Only fields supported by the API can be modified.
590
590
  # @param id [String] Identifier of the resource
591
591
  # @param order_update_request [OrderUpdateRequest] requested field for an order
592
592
  # @param [Hash] opts the optional parameters