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
data/docs/PaymentLinkApi.md CHANGED
@@ -5,11 +5,10 @@ All URIs are relative to *https://api.digitalfemsa.io*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**cancel_checkout**](PaymentLinkApi.md#cancel_checkout) | **PUT** /checkouts/{id}/cancel | Cancel Payment Link |
8
- | [**create_checkout**](PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Unique Payment Link |
8
+ | [**create_checkout**](PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Payment Link |
9
9
  | [**email_checkout**](PaymentLinkApi.md#email_checkout) | **POST** /checkouts/{id}/email | Send an email |
10
10
  | [**get_checkout**](PaymentLinkApi.md#get_checkout) | **GET** /checkouts/{id} | Get a payment link by ID |
11
11
  | [**get_checkouts**](PaymentLinkApi.md#get_checkouts) | **GET** /checkouts | Get a list of payment links |
12
- | [**sms_checkout**](PaymentLinkApi.md#sms_checkout) | **POST** /checkouts/{id}/sms | Send an sms |
13
12
 
14
13
 
15
14
  ## cancel_checkout
@@ -18,6 +17,8 @@ All URIs are relative to *https://api.digitalfemsa.io*
18
17
 
19
18
  Cancel Payment Link
20
19
 
20
+ Cancels an existing payment link. After cancellation, the link can no longer be used to generate new payments. This operation is idempotent: cancelling an already cancelled payment link returns the current resource representation.
21
+
21
22
  ### Examples
22
23
 
23
24
  ```ruby
@@ -89,7 +90,9 @@ end
89
90
 
90
91
  > <CheckoutResponse> create_checkout(checkout, opts)
91
92
 
92
- Create Unique Payment Link
93
+ Create Payment Link
94
+
95
+ Creates a Payment Link: a shareable URL that lets your customer pay without you building a custom checkout. Configure the link type, allowed payment methods, and expiration. The request also includes an order_template (currency and line items) used to generate an Order when the customer completes a payment. Use recurrent=false for a single-use link, or recurrent=true to allow multiple payments (limited by payments_limit_count).
93
96
 
94
97
  ### Examples
95
98
 
@@ -103,14 +106,14 @@ DigitalFemsa.configure do |config|
103
106
  end
104
107
 
105
108
  api_instance = DigitalFemsa::PaymentLinkApi.new
106
- checkout = DigitalFemsa::Checkout.new({allowed_payment_methods: ["cash"], expires_at: 1680397724, name: 'Payment Link Name 1594138857', order_template: DigitalFemsa::CheckoutOrderTemplate.new({currency: 'MXN', line_items: [DigitalFemsa::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000})]}), recurrent: false, type: 'PaymentLink'}) # Checkout | requested field for checkout
109
+ checkout = DigitalFemsa::Checkout.new({name: 'Payment Link Name', type: 'PaymentLink', recurrent: false, allowed_payment_methods: ["cash"], needs_shipping_contact: false, expires_at: 1680397724, order_template: DigitalFemsa::CheckoutOrderTemplate.new({currency: 'MXN', line_items: [DigitalFemsa::Product.new({name: 'Box of Cohiba', unit_price: 20000, quantity: 1})]})}) # Checkout | requested field for checkout
107
110
  opts = {
108
111
  accept_language: 'es', # String | Use for knowing which language to use
109
112
  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.
110
113
  }
111
114
 
112
115
  begin
113
- # Create Unique Payment Link
116
+ # Create Payment Link
114
117
  result = api_instance.create_checkout(checkout, opts)
115
118
  p result
116
119
  rescue DigitalFemsa::ApiError => e
@@ -126,7 +129,7 @@ This returns an Array which contains the response data, status code and headers.
126
129
 
127
130
  ```ruby
128
131
  begin
129
- # Create Unique Payment Link
132
+ # Create Payment Link
130
133
  data, status_code, headers = api_instance.create_checkout_with_http_info(checkout, opts)
131
134
  p status_code # => 2xx
132
135
  p headers # => { ... }
@@ -239,6 +242,8 @@ end
239
242
 
240
243
  Get a payment link by ID
241
244
 
245
+ Retrieves the details of a checkout by its ID.
246
+
242
247
  ### Examples
243
248
 
244
249
  ```ruby
@@ -312,7 +317,7 @@ end
312
317
 
313
318
  Get a list of payment links
314
319
 
315
- Returns a list of links generated by the merchant
320
+ Returns a paginated list of payment links created by the merchant. Results can be navigated using the pagination parameters.
316
321
 
317
322
  ### Examples
318
323
 
@@ -386,78 +391,3 @@ end
386
391
  - **Content-Type**: Not defined
387
392
  - **Accept**: application/vnd.app-v2.1.0+json
388
393
 
389
-
390
- ## sms_checkout
391
-
392
- > <CheckoutResponse> sms_checkout(id, sms_checkout_request, opts)
393
-
394
- Send an sms
395
-
396
- ### Examples
397
-
398
- ```ruby
399
- require 'time'
400
- require 'digital_femsa'
401
- # setup authorization
402
- DigitalFemsa.configure do |config|
403
- # Configure Bearer authorization: bearerAuth
404
- config.access_token = 'YOUR_BEARER_TOKEN'
405
- end
406
-
407
- api_instance = DigitalFemsa::PaymentLinkApi.new
408
- id = '6307a60c41de27127515a575' # String | Identifier of the resource
409
- sms_checkout_request = DigitalFemsa::SmsCheckoutRequest.new({phonenumber: '5566982090'}) # SmsCheckoutRequest | requested field for sms checkout
410
- opts = {
411
- accept_language: 'es', # String | Use for knowing which language to use
412
- 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.
413
- }
414
-
415
- begin
416
- # Send an sms
417
- result = api_instance.sms_checkout(id, sms_checkout_request, opts)
418
- p result
419
- rescue DigitalFemsa::ApiError => e
420
- puts "Error when calling PaymentLinkApi->sms_checkout: #{e}"
421
- end
422
- ```
423
-
424
- #### Using the sms_checkout_with_http_info variant
425
-
426
- This returns an Array which contains the response data, status code and headers.
427
-
428
- > <Array(<CheckoutResponse>, Integer, Hash)> sms_checkout_with_http_info(id, sms_checkout_request, opts)
429
-
430
- ```ruby
431
- begin
432
- # Send an sms
433
- data, status_code, headers = api_instance.sms_checkout_with_http_info(id, sms_checkout_request, opts)
434
- p status_code # => 2xx
435
- p headers # => { ... }
436
- p data # => <CheckoutResponse>
437
- rescue DigitalFemsa::ApiError => e
438
- puts "Error when calling PaymentLinkApi->sms_checkout_with_http_info: #{e}"
439
- end
440
- ```
441
-
442
- ### Parameters
443
-
444
- | Name | Type | Description | Notes |
445
- | ---- | ---- | ----------- | ----- |
446
- | **id** | **String** | Identifier of the resource | |
447
- | **sms_checkout_request** | [**SmsCheckoutRequest**](SmsCheckoutRequest.md) | requested field for sms checkout | |
448
- | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
449
- | **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] |
450
-
451
- ### Return type
452
-
453
- [**CheckoutResponse**](CheckoutResponse.md)
454
-
455
- ### Authorization
456
-
457
- [bearerAuth](../README.md#bearerAuth)
458
-
459
- ### HTTP request headers
460
-
461
- - **Content-Type**: application/json
462
- - **Accept**: application/vnd.app-v2.1.0+json
463
-
data/docs/PaymentMethodCash.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | | [optional] |
8
8
  | **object** | **String** | | |
9
- | **auth_code** | **Integer** | | [optional] |
9
+ | **auth_code** | **String** | | [optional] |
10
10
  | **cashier_id** | **String** | | [optional] |
11
11
  | **reference** | **String** | | [optional] |
12
12
  | **barcode_url** | **String** | | [optional] |
@@ -26,10 +26,10 @@ instance = DigitalFemsa::PaymentMethodCash.new(
26
26
  auth_code: 542563,
27
27
  cashier_id: OINM01010,
28
28
  reference: 93000262276908,
29
- barcode_url: https://pt-common-s3-stg.s3.amazonaws.com/644ebf80f2243197aad6cd8810375b905b613dbe.png?X-Amz-Algorithm&#x3D;AWS4-HMAC-SHA256&amp;X-Amz-Credential&#x3D;ASIA3UN6375MP4SLLCWV%2F20230203%2Fus-east-1%2Fs3%2Faws4_request&amp;X-Amz-Date&#x3D;20230203T215750Z&amp;X-Amz-Expires&#x3D;604800&amp;X-Amz-Security-Token&#x3D;IQoJb3JpZ2luX2VjEH4aCXVzLWVhc3QtMSJGMEQCICd79cu7DYu%2F4%2B3HnVVswydgU9yHcE9kmQIIk2TLoZJrAiBVZ0HxVSeboK5lhdQSqADjwQF62XX35jhC%2F2riB0M8uCqQBAj2%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDc5OTgwMTA4MTY4OCIMXWZds9ZI5hzUdbeGKuQDFreMyeWnWWPqDuGZ2%2BHk6usCr%2Fl096%2FNJh9xtf8htLu56K%2FhWUTx%2BjiqFWM2O%2FF5zTS%2BIV6TqkLDZ%2BQ5Jo1miQrRmR57YDz6uP2Yd1mNZ1ouq5ipnNjUuu5UWCCBAmqyZQsrVmeMQpSV2IB%2BTERCCcW2SukFEYU%2F20%2Fzy5orsoZ8DxOW460IymR3cWBk5u3Xh2cV6Y1RdPEwDEThhqYEF5w%2ByKbLENloMsI%2FUm6sG5PPrO3yQOAP9aK2muLJs9lXQRU%2FL%2FSsmS4FKSUFOqlN6YU%2Bi2Y%2FyGIKAJT2VDkngvz5Sl%2Fadj0j%2BPKftVRV5FcEhySB6Rl%2BSkPN7kVQMJp6pS8hMJ6JCyEA%2BA3eWYdIfKgQhWVXAR4oCBfJ62DH8FU3a7WfSjjpTwfVkiReWen3GGCYfUWETTVKp46MKnJ9PG0CD3KzxKV8VfmEGc5krK%2FI%2F%2BDV2wtSa%2F9qf1%2BK1YYJIK9qZGb25ljUiGhTB4T%2BMUOSQFjetiWUoOJc5Q3Jz%2FXJbiTAMTST39MhdbCgiMgfrc8OGKN5DOVbex33Z7dn0xf%2FOCkSqurhLaG08efKQBdhLNS0RlE9hbg9yZ2ywwtQIF39fI6A7eeH0T11a5HMlvm51u4rAffPHRuEJfwJoIuj%2F2s3QzDg7%2FWeBjqmAbnPOlGfysjrDdvHyG7HVnaX02kdG%2BI3Q4PFOO4Mjaa3ocpjcfPT70%2BZ5a%2FSv5vP0jDLGrLToeM9%2BAUlNepptICRu23a1tLGW4ri0twPA%2FZ4JDTtUUUgdblyG8bKpcUTNp4oOsdmLLBz3FVyr4c2xQbDZSu2zYOtoOxB18W0AC6kIbsMWVU55Bf0mBhPeBWxGrtM4Kw1SgHHlt%2F8vetQi2OwtUcg08c%3D&amp;X-Amz-SignedHeaders&#x3D;host&amp;X-Amz-Signature&#x3D;d06dfa41550003359f2aabc8006063a80dfd806a13a54d244024946a76aa9abc,
30
- expires_at: 0,
29
+ barcode_url: https://pt-common-s3-stg.s3.amazonaws.com/644ebf80f2243197aad6cd8810375b905b613dbe.png?X-Amz-Algorithm&#x3D;AWS4-HMAC-SHA256&amp;X-Amz-Credential&#x3D;ASIA3UN6375MP4SLLCWV%2F20230203%2Fus-east-1%2Fs3%2Faws4_request&amp;X-Amz-Date&#x3D;20230203T215750Z&amp;X-Amz-Expires&#x3D;604800&amp;X-Amz-Security-Token&#x3D;...&amp;X-Amz-SignedHeaders&#x3D;host&amp;X-Amz-Signature&#x3D;...,
30
+ expires_at: 1768802399,
31
31
  service_name: OxxoPay,
32
- store: 10MON50EDI,
32
+ store: null,
33
33
  store_name: OXXO
34
34
  )
35
35
  ```
data/docs/PaymentMethodCashRequest.md CHANGED
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | Type of payment method | |
8
- | **expires_at** | **Integer** | | [optional] |
7
+ | **type** | **String** | Type of payment method. | |
8
+ | **expires_at** | **Integer** | Expiration date as unix timestamp (seconds). | [optional] |
9
9
 
10
10
  ## Example
11
11
 
data/docs/PaymentMethodsApi.md CHANGED
@@ -16,7 +16,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
16
16
 
17
17
  Create Payment Method
18
18
 
19
- Create a payment method for a customer.
19
+ Creates a new payment method for a customer. The payment method is associated with the customer identified by `id`. The accepted fields depend on the payment method `type`.
20
20
 
21
21
  ### Examples
22
22
 
@@ -93,7 +93,7 @@ end
93
93
 
94
94
  Delete Payment Method
95
95
 
96
- Delete an existing payment method
96
+ Deletes a specific payment method of a customer. After deletion, the payment method can no longer be used for future payments.
97
97
 
98
98
  ### Examples
99
99
 
@@ -253,7 +253,7 @@ end
253
253
 
254
254
  Update Payment Method
255
255
 
256
- Gets a payment Method that corresponds to a customer ID.
256
+ Updates a specific payment method of a customer. Use this endpoint to modify the payment method identified by `payment_method_id` for the customer identified by `id`. The fields that can be updated depend on the payment method `type`.
257
257
 
258
258
  ### Examples
259
259
 
@@ -269,7 +269,7 @@ end
269
269
  api_instance = DigitalFemsa::PaymentMethodsApi.new
270
270
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
271
271
  payment_method_id = 'src_2tQ974hSHcsdeSZHG' # String | Identifier of the payment method
272
- update_payment_methods = DigitalFemsa::UpdatePaymentMethods.new # UpdatePaymentMethods | requested field for customer payment methods
272
+ update_payment_methods = DigitalFemsa::UpdatePaymentMethods.new # UpdatePaymentMethods | Request body for updating a customer payment method.
273
273
  opts = {
274
274
  accept_language: 'es', # String | Use for knowing which language to use
275
275
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -308,7 +308,7 @@ end
308
308
  | ---- | ---- | ----------- | ----- |
309
309
  | **id** | **String** | Identifier of the resource | |
310
310
  | **payment_method_id** | **String** | Identifier of the payment method | |
311
- | **update_payment_methods** | [**UpdatePaymentMethods**](UpdatePaymentMethods.md) | requested field for customer payment methods | |
311
+ | **update_payment_methods** | [**UpdatePaymentMethods**](UpdatePaymentMethods.md) | Request body for updating a customer payment method. | |
312
312
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
313
313
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
314
314
 
data/docs/Product.md CHANGED
@@ -4,15 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
- | **brand** | **String** | The brand of the item. | [optional] |
9
- | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
7
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
8
+ | **unit_price** | **Integer** | The price of the item in cents. | |
12
9
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
10
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
11
+ | **brand** | **String** | The brand of the item. | [optional] |
12
+ | **description** | **String** | Short description of the item | [optional] |
14
13
  | **tags** | **Array&lt;String&gt;** | List of tags for the item. It is used to identify the item in the order. | [optional] |
15
- | **unit_price** | **Integer** | The price of the item in cents. | |
14
+ | **metadata** | **Hash&lt;String, Object&gt;** | Arbitrary key-value data for your internal use. Keys should be strings; values can be any JSON value. | [optional] |
16
15
 
17
16
  ## Example
18
17
 
@@ -20,15 +19,14 @@
20
19
  require 'digital_femsa'
21
20
 
22
21
  instance = DigitalFemsa::Product.new(
23
- antifraud_info: {&quot;key&quot;:&quot;value&quot;},
24
- brand: Cohiba,
25
- description: Imported From Mex.,
26
- metadata: {&quot;key&quot;:&quot;value&quot;},
27
- name: Box of Cohiba S1s,
22
+ name: Box of Cohiba,
23
+ unit_price: 20000,
28
24
  quantity: 1,
29
25
  sku: XYZ12345,
30
- tags: [&quot;food&quot;,&quot;mexican food&quot;],
31
- unit_price: 20000
26
+ brand: Cohiba,
27
+ description: Imported From Mex.,
28
+ tags: null,
29
+ metadata: {&quot;key&quot;:&quot;value&quot;}
32
30
  )
33
31
  ```
34
32
 
data/docs/ProductDataResponse.md CHANGED
@@ -4,15 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
- | **brand** | **String** | The brand of the item. | [optional] |
9
- | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
7
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
8
+ | **unit_price** | **Integer** | The price of the item in cents. | |
12
9
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
10
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
11
+ | **brand** | **String** | The brand of the item. | [optional] |
12
+ | **description** | **String** | Short description of the item | [optional] |
14
13
  | **tags** | **Array&lt;String&gt;** | List of tags for the item. It is used to identify the item in the order. | [optional] |
15
- | **unit_price** | **Integer** | The price of the item in cents. | |
14
+ | **metadata** | **Hash&lt;String, Object&gt;** | Arbitrary key-value data for your internal use. Keys should be strings; values can be any JSON value. | [optional] |
16
15
  | **id** | **String** | | [optional] |
17
16
  | **object** | **String** | | [optional] |
18
17
  | **parent_id** | **String** | | [optional] |
@@ -23,15 +22,14 @@
23
22
  require 'digital_femsa'
24
23
 
25
24
  instance = DigitalFemsa::ProductDataResponse.new(
26
- antifraud_info: {key&#x3D;value},
25
+ name: Box of Cohiba,
26
+ unit_price: 20000,
27
+ quantity: 1,
28
+ sku: XYZ12345,
27
29
  brand: Cohiba,
28
30
  description: Imported From Mex.,
31
+ tags: null,
29
32
  metadata: {key&#x3D;value},
30
- name: Box of Cohiba S1s,
31
- quantity: 1,
32
- sku: XYZ12345,
33
- tags: [food, mexican food],
34
- unit_price: 20000,
35
33
  id: null,
36
34
  object: null,
37
35
  parent_id: null
data/docs/ProductOrderResponse.md CHANGED
@@ -4,15 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **antifraud_info** | **Hash&lt;String, Object&gt;** | | [optional] |
8
- | **brand** | **String** | The brand of the item. | [optional] |
9
- | **description** | **String** | Short description of the item | [optional] |
10
- | **metadata** | **Hash&lt;String, String&gt;** | It is a key/value hash that can hold custom fields. Maximum 100 elements and allows special characters. | [optional] |
11
7
  | **name** | **String** | The name of the item. It will be displayed in the order. | |
8
+ | **unit_price** | **Integer** | The price of the item in cents. | |
12
9
  | **quantity** | **Integer** | The quantity of the item in the order. | |
13
10
  | **sku** | **String** | The stock keeping unit for the item. It is used to identify the item in the order. | [optional] |
11
+ | **brand** | **String** | The brand of the item. | [optional] |
12
+ | **description** | **String** | Short description of the item | [optional] |
14
13
  | **tags** | **Array&lt;String&gt;** | List of tags for the item. It is used to identify the item in the order. | [optional] |
15
- | **unit_price** | **Integer** | The price of the item in cents. | |
14
+ | **metadata** | **Hash&lt;String, Object&gt;** | Arbitrary key-value data for your internal use. Keys should be strings; values can be any JSON value. | [optional] |
16
15
  | **id** | **String** | | [optional] |
17
16
  | **object** | **String** | | [optional] |
18
17
  | **parent_id** | **String** | | [optional] |
@@ -23,15 +22,14 @@
23
22
  require 'digital_femsa'
24
23
 
25
24
  instance = DigitalFemsa::ProductOrderResponse.new(
26
- antifraud_info: {key&#x3D;value},
25
+ name: Box of Cohiba,
26
+ unit_price: 20000,
27
+ quantity: 1,
28
+ sku: XYZ12345,
27
29
  brand: Cohiba,
28
30
  description: Imported From Mex.,
31
+ tags: null,
29
32
  metadata: {key&#x3D;value},
30
- name: Box of Cohiba S1s,
31
- quantity: 1,
32
- sku: XYZ12345,
33
- tags: [food, mexican food],
34
- unit_price: 20000,
35
33
  id: null,
36
34
  object: null,
37
35
  parent_id: null
data/docs/ProductsApi.md CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
15
15
 
16
16
  Create Product
17
17
 
18
- Create a new product for an existing order.
18
+ Creates a new product (line item) for an existing order. Use this endpoint to add an additional item to the order after it has been created.
19
19
 
20
20
  ### Examples
21
21
 
@@ -30,7 +30,7 @@ end
30
30
 
31
31
  api_instance = DigitalFemsa::ProductsApi.new
32
32
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
33
- product = DigitalFemsa::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000}) # Product | requested field for a product
33
+ product = DigitalFemsa::Product.new({name: 'Box of Cohiba', unit_price: 20000, quantity: 1}) # Product | Fields required to create a new product (line item) for an existing order. This request adds a new item to the order.
34
34
  opts = {
35
35
  accept_language: 'es', # String | Use for knowing which language to use
36
36
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -68,7 +68,7 @@ end
68
68
  | Name | Type | Description | Notes |
69
69
  | ---- | ---- | ----------- | ----- |
70
70
  | **id** | **String** | Identifier of the resource | |
71
- | **product** | [**Product**](Product.md) | requested field for a product | |
71
+ | **product** | [**Product**](Product.md) | Fields required to create a new product (line item) for an existing order. This request adds a new item to the order. | |
72
72
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
73
73
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
74
74
 
@@ -92,7 +92,7 @@ end
92
92
 
93
93
  Delete Product
94
94
 
95
- Delete product for an existing orden
95
+ Deletes a product (line item) from an existing order. The API will validate whether the order can be modified before removing the item.
96
96
 
97
97
  ### Examples
98
98
 
@@ -169,7 +169,7 @@ end
169
169
 
170
170
  Update Product
171
171
 
172
- Update an existing product for an existing orden
172
+ Updates an existing product (line item) for an existing order. Use this endpoint to modify the details of a specific line item in the order.
173
173
 
174
174
  ### Examples
175
175
 
@@ -185,7 +185,7 @@ end
185
185
  api_instance = DigitalFemsa::ProductsApi.new
186
186
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
187
187
  line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
188
- update_product = DigitalFemsa::UpdateProduct.new # UpdateProduct | requested field for products
188
+ update_product = DigitalFemsa::UpdateProduct.new # UpdateProduct | Fields allowed to update an existing product (line item) in an order. All fields are optional; only the provided fields will be updated.
189
189
  opts = {
190
190
  accept_language: 'es', # String | Use for knowing which language to use
191
191
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -224,7 +224,7 @@ end
224
224
  | ---- | ---- | ----------- | ----- |
225
225
  | **id** | **String** | Identifier of the resource | |
226
226
  | **line_item_id** | **String** | identifier | |
227
- | **update_product** | [**UpdateProduct**](UpdateProduct.md) | requested field for products | |
227
+ | **update_product** | [**UpdateProduct**](UpdateProduct.md) | Fields allowed to update an existing product (line item) in an order. All fields are optional; only the provided fields will be updated. | |
228
228
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
229
229
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
230
230
 
data/docs/ShippingContactsApi.md CHANGED
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_customer_shipping_contacts**](ShippingContactsApi.md#create_customer_shipping_contacts) | **POST** /customers/{id}/shipping_contacts | Create a shipping contacts |
7
+ | [**create_customer_shipping_contacts**](ShippingContactsApi.md#create_customer_shipping_contacts) | **POST** /customers/{id}/shipping_contacts | Create a shipping contact |
8
8
  | [**delete_customer_shipping_contacts**](ShippingContactsApi.md#delete_customer_shipping_contacts) | **DELETE** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Delete shipping contacts |
9
9
  | [**update_customer_shipping_contacts**](ShippingContactsApi.md#update_customer_shipping_contacts) | **PUT** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Update shipping contacts |
10
10
 
@@ -13,9 +13,9 @@ All URIs are relative to *https://api.digitalfemsa.io*
13
13
 
14
14
  > <CustomerShippingContactsResponse> create_customer_shipping_contacts(id, customer_shipping_contacts, opts)
15
15
 
16
- Create a shipping contacts
16
+ Create a shipping contact
17
17
 
18
- Create a shipping contacts for a customer.
18
+ Creates a new shipping contact for a customer. The shipping contact is associated with the customer identified by `id`.
19
19
 
20
20
  ### Examples
21
21
 
@@ -30,14 +30,14 @@ end
30
30
 
31
31
  api_instance = DigitalFemsa::ShippingContactsApi.new
32
32
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
33
- customer_shipping_contacts = DigitalFemsa::CustomerShippingContacts.new({address: DigitalFemsa::CustomerShippingContactsAddress.new}) # CustomerShippingContacts | requested field for customer shippings contacts
33
+ customer_shipping_contacts = DigitalFemsa::CustomerShippingContacts.new({address: DigitalFemsa::CustomerShippingContactsAddress.new}) # CustomerShippingContacts | Request body for creating or updating a customer shipping contact.
34
34
  opts = {
35
35
  accept_language: 'es', # String | Use for knowing which language to use
36
36
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
37
37
  }
38
38
 
39
39
  begin
40
- # Create a shipping contacts
40
+ # Create a shipping contact
41
41
  result = api_instance.create_customer_shipping_contacts(id, customer_shipping_contacts, opts)
42
42
  p result
43
43
  rescue DigitalFemsa::ApiError => e
@@ -53,7 +53,7 @@ This returns an Array which contains the response data, status code and headers.
53
53
 
54
54
  ```ruby
55
55
  begin
56
- # Create a shipping contacts
56
+ # Create a shipping contact
57
57
  data, status_code, headers = api_instance.create_customer_shipping_contacts_with_http_info(id, customer_shipping_contacts, opts)
58
58
  p status_code # => 2xx
59
59
  p headers # => { ... }
@@ -68,7 +68,7 @@ end
68
68
  | Name | Type | Description | Notes |
69
69
  | ---- | ---- | ----------- | ----- |
70
70
  | **id** | **String** | Identifier of the resource | |
71
- | **customer_shipping_contacts** | [**CustomerShippingContacts**](CustomerShippingContacts.md) | requested field for customer shippings contacts | |
71
+ | **customer_shipping_contacts** | [**CustomerShippingContacts**](CustomerShippingContacts.md) | Request body for creating or updating a customer shipping contact. | |
72
72
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
73
73
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
74
74
 
@@ -185,7 +185,7 @@ end
185
185
  api_instance = DigitalFemsa::ShippingContactsApi.new
186
186
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
187
187
  shipping_contacts_id = '6307a60c41de27127515a575' # String | identifier
188
- customer_update_shipping_contacts = DigitalFemsa::CustomerUpdateShippingContacts.new # CustomerUpdateShippingContacts | requested field for customer update shippings contacts
188
+ customer_update_shipping_contacts = DigitalFemsa::CustomerUpdateShippingContacts.new # CustomerUpdateShippingContacts | Request body for updating a customer shipping contact.
189
189
  opts = {
190
190
  accept_language: 'es', # String | Use for knowing which language to use
191
191
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -224,7 +224,7 @@ end
224
224
  | ---- | ---- | ----------- | ----- |
225
225
  | **id** | **String** | Identifier of the resource | |
226
226
  | **shipping_contacts_id** | **String** | identifier | |
227
- | **customer_update_shipping_contacts** | [**CustomerUpdateShippingContacts**](CustomerUpdateShippingContacts.md) | requested field for customer update shippings contacts | |
227
+ | **customer_update_shipping_contacts** | [**CustomerUpdateShippingContacts**](CustomerUpdateShippingContacts.md) | Request body for updating a customer shipping contact. | |
228
228
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
229
229
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
230
230
 
data/docs/ShippingOrderResponse.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **carrier** | **String** | Carrier name for the shipment | [optional] |
9
9
  | **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] |
10
10
  | **method** | **String** | Method of shipment | [optional] |
11
+ | **description** | **String** | Shipping line description | [optional] |
11
12
  | **metadata** | **Hash&lt;String, Object&gt;** | Hash where the user can send additional information for each &#39;shipping&#39;. | [optional] |
12
13
  | **id** | **String** | | [optional] |
13
14
  | **object** | **String** | | [optional] |
@@ -23,10 +24,11 @@ instance = DigitalFemsa::ShippingOrderResponse.new(
23
24
  carrier: FEDEX,
24
25
  tracking_number: TRACK123,
25
26
  method: Same day,
27
+ description: Shipping line,
26
28
  metadata: {key&#x3D;value},
27
- id: null,
28
- object: null,
29
- parent_id: null
29
+ id: ship_lin_2sLxi45ZFs1GHJmzx,
30
+ object: shipping_line,
31
+ parent_id: ord_2sLxi3MqYFJ1QfTmP
30
32
  )
31
33
  ```
32
34
 
data/docs/ShippingRequest.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **carrier** | **String** | Carrier name for the shipment | [optional] |
9
9
  | **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] |
10
10
  | **method** | **String** | Method of shipment | [optional] |
11
+ | **description** | **String** | Shipping line description | [optional] |
11
12
  | **metadata** | **Hash&lt;String, Object&gt;** | Hash where the user can send additional information for each &#39;shipping&#39;. | [optional] |
12
13
 
13
14
  ## Example
@@ -20,6 +21,7 @@ instance = DigitalFemsa::ShippingRequest.new(
20
21
  carrier: FEDEX,
21
22
  tracking_number: TRACK123,
22
23
  method: Same day,
24
+ description: Shipping line,
23
25
  metadata: {&quot;key&quot;:&quot;value&quot;}
24
26
  )
25
27
  ```
data/docs/ShippingsApi.md CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
15
15
 
16
16
  Create Shipping
17
17
 
18
- Create new shipping for an existing orden
18
+ Creates a new shipping line for an existing order. The shipping line is added to the order identified by `id`. The response returns the created shipping line.
19
19
 
20
20
  ### Examples
21
21
 
@@ -30,7 +30,7 @@ end
30
30
 
31
31
  api_instance = DigitalFemsa::ShippingsApi.new
32
32
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
33
- shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | requested field for a shipping
33
+ shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | Request body for creating or updating a shipping line.
34
34
  opts = {
35
35
  accept_language: 'es', # String | Use for knowing which language to use
36
36
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -68,7 +68,7 @@ end
68
68
  | Name | Type | Description | Notes |
69
69
  | ---- | ---- | ----------- | ----- |
70
70
  | **id** | **String** | Identifier of the resource | |
71
- | **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | requested field for a shipping | |
71
+ | **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | Request body for creating or updating a shipping line. | |
72
72
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
73
73
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
74
74
 
@@ -92,7 +92,7 @@ end
92
92
 
93
93
  Delete Shipping
94
94
 
95
- Delete shipping
95
+ Deletes an existing shipping line from an order. The shipping line identified by `shipping_id` belongs to the order identified by `id`.
96
96
 
97
97
  ### Examples
98
98
 
@@ -169,7 +169,7 @@ end
169
169
 
170
170
  Update Shipping
171
171
 
172
- Update existing shipping for an existing orden
172
+ Updates an existing shipping line for an order. The shipping line identified by `shipping_id` belongs to the order identified by `id`. Only the fields provided in the request body are updated.
173
173
 
174
174
  ### Examples
175
175
 
@@ -185,7 +185,7 @@ end
185
185
  api_instance = DigitalFemsa::ShippingsApi.new
186
186
  id = '6307a60c41de27127515a575' # String | Identifier of the resource
187
187
  shipping_id = 'ship_lin_2tQ974hSHcsdeSZHG' # String | identifier
188
- shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | requested field for a shipping
188
+ shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | Request body for creating or updating a shipping line.
189
189
  opts = {
190
190
  accept_language: 'es', # String | Use for knowing which language to use
191
191
  x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
@@ -224,7 +224,7 @@ end
224
224
  | ---- | ---- | ----------- | ----- |
225
225
  | **id** | **String** | Identifier of the resource | |
226
226
  | **shipping_id** | **String** | identifier | |
227
- | **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | requested field for a shipping | |
227
+ | **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | Request body for creating or updating a shipping line. | |
228
228
  | **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
229
229
  | **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
230
230