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.
- checksums.yaml +4 -4
- data/Makefile +14 -0
- data/README.md +28 -33
- data/VERSION +1 -1
- data/config-ruby.json +1 -1
- data/docs/ApiKeyCreateResponse.md +1 -1
- data/docs/ApiKeyRequest.md +2 -2
- data/docs/ApiKeyResponseOnDelete.md +2 -2
- data/docs/ApiKeysApi.md +10 -10
- data/docs/BalanceResponse.md +8 -8
- data/docs/BalancesApi.md +1 -1
- data/docs/ChargeOrderResponse.md +1 -1
- data/docs/ChargeOrderResponseChannel.md +24 -0
- data/docs/ChargeRequest.md +1 -1
- data/docs/ChargeRequestPaymentMethod.md +3 -3
- data/docs/ChargeResponse.md +9 -7
- data/docs/ChargeResponseChannel.md +3 -3
- data/docs/ChargeResponseRefundsData.md +5 -1
- data/docs/ChargesApi.md +16 -12
- data/docs/ChargesDataResponse.md +9 -7
- data/docs/Checkout.md +17 -15
- data/docs/CheckoutOrderTemplate.md +3 -3
- data/docs/CheckoutResponse.md +1 -1
- data/docs/CreateCustomerFiscalEntitiesResponse.md +2 -2
- data/docs/Customer.md +13 -19
- data/docs/CustomerAddress.md +2 -2
- data/docs/CustomerFiscalEntitiesDataResponse.md +2 -2
- data/docs/CustomerFiscalEntitiesRequest.md +3 -3
- data/docs/CustomerInfo.md +4 -4
- data/docs/CustomerPaymentMethodRequest.md +1 -1
- data/docs/CustomerResponse.md +17 -21
- data/docs/CustomerShippingContactsResponse.md +5 -5
- data/docs/CustomersApi.md +15 -15
- data/docs/CustomersResponse.md +1 -1
- data/docs/DeleteApiKeysResponse.md +1 -1
- data/docs/DiscountsApi.md +9 -9
- data/docs/EventsApi.md +2 -2
- data/docs/EventsResendResponse.md +1 -1
- data/docs/GetChargesResponse.md +4 -4
- data/docs/GetTransactionsResponse.md +1 -1
- data/docs/LogsApi.md +1 -1
- data/docs/OrderFiscalEntityRequest.md +4 -4
- data/docs/OrderRefundRequest.md +7 -5
- data/docs/OrderRequest.md +17 -19
- data/docs/OrderResponse.md +37 -35
- data/docs/OrderResponseChannel.md +24 -0
- data/docs/OrderResponseShippingContact.md +4 -4
- data/docs/OrderUpdateFiscalEntityRequest.md +1 -1
- data/docs/OrderUpdateRequest.md +19 -15
- data/docs/OrdersApi.md +16 -16
- data/docs/PaymentLinkApi.md +12 -82
- data/docs/PaymentMethodCash.md +4 -4
- data/docs/PaymentMethodCashRequest.md +2 -2
- data/docs/PaymentMethodsApi.md +5 -5
- data/docs/Product.md +10 -12
- data/docs/ProductDataResponse.md +9 -11
- data/docs/ProductOrderResponse.md +9 -11
- data/docs/ProductsApi.md +7 -7
- data/docs/ShippingContactsApi.md +9 -9
- data/docs/ShippingOrderResponse.md +5 -3
- data/docs/ShippingRequest.md +2 -0
- data/docs/ShippingsApi.md +7 -7
- data/docs/TaxesApi.md +7 -7
- data/docs/TransactionResponse.md +20 -14
- data/docs/TransactionsApi.md +6 -6
- data/docs/TransfersApi.md +10 -10
- data/docs/UpdateCustomer.md +17 -21
- data/docs/UpdateCustomerFiscalEntitiesResponse.md +2 -2
- data/docs/UpdateOrderTaxRequest.md +2 -2
- data/docs/UpdateProduct.md +7 -9
- data/docs/WebhookKeysApi.md +18 -14
- data/docs/WebhooksApi.md +28 -22
- data/lib/digital_femsa/api/api_keys_api.rb +8 -8
- data/lib/digital_femsa/api/balances_api.rb +2 -2
- data/lib/digital_femsa/api/charges_api.rb +13 -9
- data/lib/digital_femsa/api/customers_api.rb +12 -12
- data/lib/digital_femsa/api/discounts_api.rb +12 -12
- data/lib/digital_femsa/api/events_api.rb +4 -4
- data/lib/digital_femsa/api/logs_api.rb +2 -2
- data/lib/digital_femsa/api/orders_api.rb +20 -20
- data/lib/digital_femsa/api/payment_link_api.rb +10 -86
- data/lib/digital_femsa/api/payment_methods_api.rb +8 -8
- data/lib/digital_femsa/api/products_api.rb +10 -10
- data/lib/digital_femsa/api/shipping_contacts_api.rb +8 -8
- data/lib/digital_femsa/api/shippings_api.rb +10 -10
- data/lib/digital_femsa/api/taxes_api.rb +10 -10
- data/lib/digital_femsa/api/transactions_api.rb +6 -6
- data/lib/digital_femsa/api/transfers_api.rb +8 -8
- data/lib/digital_femsa/api/webhook_keys_api.rb +14 -10
- data/lib/digital_femsa/api/webhooks_api.rb +23 -16
- data/lib/digital_femsa/api_client.rb +9 -5
- data/lib/digital_femsa/models/api_key_create_response.rb +1 -1
- data/lib/digital_femsa/models/api_key_request.rb +36 -1
- data/lib/digital_femsa/models/balance_response.rb +9 -9
- data/lib/digital_femsa/models/charge_order_response.rb +1 -1
- data/lib/digital_femsa/models/{order_next_action_response.rb → charge_order_response_channel.rb} +34 -18
- data/lib/digital_femsa/models/charge_request_payment_method.rb +3 -2
- data/lib/digital_femsa/models/charge_response.rb +15 -4
- data/lib/digital_femsa/models/charge_response_refunds_data.rb +23 -4
- data/lib/digital_femsa/models/charge_update_request.rb +1 -1
- data/lib/digital_femsa/models/charges_data_response.rb +15 -4
- data/lib/digital_femsa/models/checkout.rb +97 -81
- data/lib/digital_femsa/models/checkout_order_template.rb +4 -4
- data/lib/digital_femsa/models/checkout_order_template_customer_info.rb +1 -1
- data/lib/digital_femsa/models/checkout_request.rb +1 -1
- data/lib/digital_femsa/models/checkout_response.rb +1 -1
- data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb +10 -10
- data/lib/digital_femsa/models/customer.rb +57 -95
- data/lib/digital_femsa/models/customer_address.rb +7 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_data_response.rb +10 -10
- data/lib/digital_femsa/models/customer_fiscal_entities_request.rb +13 -13
- data/lib/digital_femsa/models/customer_info.rb +13 -20
- data/lib/digital_femsa/models/customer_payment_method_request.rb +2 -2
- data/lib/digital_femsa/models/customer_payment_sources_inner.rb +104 -0
- data/lib/digital_femsa/models/customer_response.rb +122 -113
- data/lib/digital_femsa/models/customer_shipping_contacts_response.rb +2 -0
- data/lib/digital_femsa/models/customers_response.rb +1 -0
- data/lib/digital_femsa/models/events_resend_response.rb +1 -1
- data/lib/digital_femsa/models/get_charges_response.rb +21 -21
- data/lib/digital_femsa/models/get_transactions_response.rb +1 -1
- data/lib/digital_femsa/models/log_response.rb +1 -1
- data/lib/digital_femsa/models/logs_response.rb +1 -1
- data/lib/digital_femsa/models/order_fiscal_entity_response.rb +1 -1
- data/lib/digital_femsa/models/order_refund_request.rb +59 -11
- data/lib/digital_femsa/models/order_request.rb +69 -79
- data/lib/digital_femsa/models/order_response.rb +187 -119
- data/lib/digital_femsa/models/{order_next_action_response_redirect_to_url.rb → order_response_channel.rb} +35 -19
- data/lib/digital_femsa/models/order_response_charges.rb +1 -1
- data/lib/digital_femsa/models/order_response_checkout.rb +1 -0
- data/lib/digital_femsa/models/order_response_customer_info.rb +1 -0
- data/lib/digital_femsa/models/order_response_shipping_contact.rb +3 -0
- data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb +1 -1
- data/lib/digital_femsa/models/order_update_request.rb +106 -65
- data/lib/digital_femsa/models/payment_method_cash.rb +1 -1
- data/lib/digital_femsa/models/payment_method_cash_request.rb +2 -1
- data/lib/digital_femsa/models/product.rb +103 -95
- data/lib/digital_femsa/models/product_data_response.rb +103 -95
- data/lib/digital_femsa/models/product_order_response.rb +103 -95
- data/lib/digital_femsa/models/shipping_order_response.rb +11 -1
- data/lib/digital_femsa/models/shipping_request.rb +12 -1
- data/lib/digital_femsa/models/transaction_response.rb +172 -99
- data/lib/digital_femsa/models/transfers_response.rb +1 -1
- data/lib/digital_femsa/models/transfers_response_destination.rb +312 -0
- data/lib/digital_femsa/models/update_customer.rb +42 -85
- data/lib/digital_femsa/models/update_customer_fiscal_entities_response.rb +10 -10
- data/lib/digital_femsa/models/update_order_discount_lines_request.rb +34 -0
- data/lib/digital_femsa/models/update_order_tax_request.rb +2 -2
- data/lib/digital_femsa/models/update_payment_methods_amount.rb +105 -0
- data/lib/digital_femsa/models/update_payment_methods_expires_at.rb +105 -0
- data/lib/digital_femsa/models/update_product.rb +85 -58
- data/lib/digital_femsa/models/webhook_key_delete_response.rb +1 -1
- data/lib/digital_femsa/models/webhook_key_request.rb +1 -0
- data/lib/digital_femsa/models/webhook_key_response.rb +1 -1
- data/lib/digital_femsa/models/webhook_request.rb +1 -1
- data/lib/digital_femsa/models/webhook_response.rb +1 -1
- data/lib/digital_femsa/models/webhook_update_request.rb +1 -1
- data/lib/digital_femsa/version.rb +1 -1
- data/lib/digital_femsa.rb +2 -6
- data/templates/ruby/api_client.mustache +8 -4
- metadata +26 -26
- data/docs/CustomerAntifraudInfo.md +0 -20
- data/docs/CustomerAntifraudInfoResponse.md +0 -20
- data/docs/OrderNextActionResponse.md +0 -20
- data/docs/OrderNextActionResponseRedirectToUrl.md +0 -20
- data/docs/SmsCheckoutRequest.md +0 -18
- data/docs/UpdateCustomerAntifraudInfo.md +0 -20
data/docs/TaxesApi.md
CHANGED
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
15
15
|
|
|
16
16
|
Create Tax
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Creates a new tax line for an existing order. The tax line is added to the order identified by `id`. The response returns the created tax line.
|
|
19
19
|
|
|
20
20
|
### Examples
|
|
21
21
|
|
|
@@ -30,7 +30,7 @@ end
|
|
|
30
30
|
|
|
31
31
|
api_instance = DigitalFemsa::TaxesApi.new
|
|
32
32
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
33
|
-
order_tax_request = DigitalFemsa::OrderTaxRequest.new({amount: 100, description: 'testing'}) # OrderTaxRequest |
|
|
33
|
+
order_tax_request = DigitalFemsa::OrderTaxRequest.new({amount: 100, description: 'testing'}) # OrderTaxRequest | Request body for creating a tax 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
|
-
| **order_tax_request** | [**OrderTaxRequest**](OrderTaxRequest.md) |
|
|
71
|
+
| **order_tax_request** | [**OrderTaxRequest**](OrderTaxRequest.md) | Request body for creating a tax line. | |
|
|
72
72
|
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
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 Tax
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
Deletes an existing tax line from an order. The tax line identified by `tax_id` belongs to the order identified by `id`. The response includes the deleted resource with `deleted: true`.
|
|
96
96
|
|
|
97
97
|
### Examples
|
|
98
98
|
|
|
@@ -169,7 +169,7 @@ end
|
|
|
169
169
|
|
|
170
170
|
Update Tax
|
|
171
171
|
|
|
172
|
-
|
|
172
|
+
Updates an existing tax line for an order. The tax line identified by `tax_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::TaxesApi.new
|
|
186
186
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
187
187
|
tax_id = 'tax_lin_2tQ974hSHcsdeSZHG' # String | identifier
|
|
188
|
-
update_order_tax_request = DigitalFemsa::UpdateOrderTaxRequest.new # UpdateOrderTaxRequest |
|
|
188
|
+
update_order_tax_request = DigitalFemsa::UpdateOrderTaxRequest.new # UpdateOrderTaxRequest | Request body for updating a tax 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
|
| **tax_id** | **String** | identifier | |
|
|
227
|
-
| **update_order_tax_request** | [**UpdateOrderTaxRequest**](UpdateOrderTaxRequest.md) |
|
|
227
|
+
| **update_order_tax_request** | [**UpdateOrderTaxRequest**](UpdateOrderTaxRequest.md) | Request body for updating a tax line. | |
|
|
228
228
|
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
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/TransactionResponse.md
CHANGED
|
@@ -4,17 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier of the transaction. | |
|
|
8
|
+
| **object** | **String** | Object name, which is transaction. | |
|
|
7
9
|
| **amount** | **Integer** | The amount of the transaction. | |
|
|
8
|
-
| **charge** | **String** | Randomly assigned unique order identifier associated with the charge. | |
|
|
9
|
-
| **created_at** | **Integer** | Date and time of creation of the transaction in Unix format. | |
|
|
10
|
-
| **currency** | **String** | The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](https://es.wikipedia.org/wiki/ISO_4217) | |
|
|
11
10
|
| **fee** | **Integer** | The amount to be deducted for taxes and commissions. | |
|
|
12
|
-
| **id** | **String** | Unique identifier of the transaction. | |
|
|
13
|
-
| **livemode** | **Boolean** | Indicates whether the transaction was created in live mode or test mode. | |
|
|
14
11
|
| **net** | **Integer** | The net amount after deducting commissions and taxes. | |
|
|
15
|
-
| **
|
|
12
|
+
| **currency** | **String** | The currency of the transaction. It uses the 3-letter code of ISO 4217. | |
|
|
16
13
|
| **status** | **String** | Code indicating transaction status. | |
|
|
17
|
-
| **type** | **String** | Transaction
|
|
14
|
+
| **type** | **String** | Transaction type. | |
|
|
15
|
+
| **created_at** | **Integer** | Date and time of creation of the transaction in Unix format. | |
|
|
16
|
+
| **livemode** | **Boolean** | Indicates whether the transaction was created in live mode or test mode. | |
|
|
17
|
+
| **charge** | **String** | Charge ID associated with the transaction (present only if the transaction belongs to a charge). | [optional] |
|
|
18
|
+
| **transfer** | **String** | Transfer ID associated with the transaction (present only if the transaction belongs to a transfer). | [optional] |
|
|
19
|
+
| **transferred_at** | **Integer** | Date and time when the transaction was transferred, in Unix format. | [optional] |
|
|
20
|
+
| **formula** | **String** | Transaction fee formula identifier (if available). | [optional] |
|
|
18
21
|
|
|
19
22
|
## Example
|
|
20
23
|
|
|
@@ -22,17 +25,20 @@
|
|
|
22
25
|
require 'digital_femsa'
|
|
23
26
|
|
|
24
27
|
instance = DigitalFemsa::TransactionResponse.new(
|
|
28
|
+
id: 5ee7ec5b8dea41085erb7f9e,
|
|
29
|
+
object: transaction,
|
|
25
30
|
amount: 1000,
|
|
26
|
-
charge: 5ee7ec58885a45585e6d9f8m,
|
|
27
|
-
created_at: 1553273553,
|
|
28
|
-
currency: MXN,
|
|
29
31
|
fee: 560,
|
|
30
|
-
id: 5ee7ec5b8dea41085erb7f9e,
|
|
31
|
-
livemode: true,
|
|
32
32
|
net: 440,
|
|
33
|
-
|
|
33
|
+
currency: MXN,
|
|
34
34
|
status: pending,
|
|
35
|
-
type: capture
|
|
35
|
+
type: capture,
|
|
36
|
+
created_at: 1553273553,
|
|
37
|
+
livemode: true,
|
|
38
|
+
charge: 5ee7ec58885a45585e6d9f8m,
|
|
39
|
+
transfer: trf_2tPAmKCEJqh8RE6nY,
|
|
40
|
+
transferred_at: 1553273999,
|
|
41
|
+
formula: null
|
|
36
42
|
)
|
|
37
43
|
```
|
|
38
44
|
|
data/docs/TransactionsApi.md
CHANGED
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /transactions/{id} | Get transaction |
|
|
8
|
-
| [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /transactions |
|
|
8
|
+
| [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /transactions | List transactions |
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
## get_transaction
|
|
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
14
14
|
|
|
15
15
|
Get transaction
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Retrieves the details of a transaction by its ID.
|
|
18
18
|
|
|
19
19
|
### Examples
|
|
20
20
|
|
|
@@ -87,9 +87,9 @@ end
|
|
|
87
87
|
|
|
88
88
|
> <GetTransactionsResponse> get_transactions(opts)
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
List transactions
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
Returns a paginated list of transactions (ledger movements). A transaction is a movement that represents the financial impact of payment operations, including amounts, fees, and net values. Transactions can be linked to a charge and may be linked to a transfer (payout) when they are included in a payout. If you need payout-level information (destination, statement reference/description, payout status), use GET /transfers.
|
|
93
93
|
|
|
94
94
|
### Examples
|
|
95
95
|
|
|
@@ -116,7 +116,7 @@ opts = {
|
|
|
116
116
|
}
|
|
117
117
|
|
|
118
118
|
begin
|
|
119
|
-
#
|
|
119
|
+
# List transactions
|
|
120
120
|
result = api_instance.get_transactions(opts)
|
|
121
121
|
p result
|
|
122
122
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -132,7 +132,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
132
132
|
|
|
133
133
|
```ruby
|
|
134
134
|
begin
|
|
135
|
-
#
|
|
135
|
+
# List transactions
|
|
136
136
|
data, status_code, headers = api_instance.get_transactions_with_http_info(opts)
|
|
137
137
|
p status_code # => 2xx
|
|
138
138
|
p headers # => { ... }
|
data/docs/TransfersApi.md
CHANGED
|
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**get_transfer**](TransfersApi.md#get_transfer) | **GET** /transfers/{id} | Get
|
|
8
|
-
| [**get_transfers**](TransfersApi.md#get_transfers) | **GET** /transfers |
|
|
7
|
+
| [**get_transfer**](TransfersApi.md#get_transfer) | **GET** /transfers/{id} | Get transfer |
|
|
8
|
+
| [**get_transfers**](TransfersApi.md#get_transfers) | **GET** /transfers | List transfers |
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
## get_transfer
|
|
12
12
|
|
|
13
13
|
> <TransferResponse> get_transfer(id, opts)
|
|
14
14
|
|
|
15
|
-
Get
|
|
15
|
+
Get transfer
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Retrieves the details of a transfer by its ID.
|
|
18
18
|
|
|
19
19
|
### Examples
|
|
20
20
|
|
|
@@ -35,7 +35,7 @@ opts = {
|
|
|
35
35
|
}
|
|
36
36
|
|
|
37
37
|
begin
|
|
38
|
-
# Get
|
|
38
|
+
# Get transfer
|
|
39
39
|
result = api_instance.get_transfer(id, opts)
|
|
40
40
|
p result
|
|
41
41
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -51,7 +51,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
51
51
|
|
|
52
52
|
```ruby
|
|
53
53
|
begin
|
|
54
|
-
# Get
|
|
54
|
+
# Get transfer
|
|
55
55
|
data, status_code, headers = api_instance.get_transfer_with_http_info(id, opts)
|
|
56
56
|
p status_code # => 2xx
|
|
57
57
|
p headers # => { ... }
|
|
@@ -87,9 +87,9 @@ end
|
|
|
87
87
|
|
|
88
88
|
> <GetTransfersResponse> get_transfers(opts)
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
List transfers
|
|
91
91
|
|
|
92
|
-
|
|
92
|
+
Returns a paginated list of transfers (payouts/dispersions). A transfer represents a payout of funds to the merchant (where the money is sent and the payout status). Transfers typically aggregate multiple transactions. If you need movement-level details (amount/fee/net per operation) or to reconcile charges, use GET /transactions.
|
|
93
93
|
|
|
94
94
|
### Examples
|
|
95
95
|
|
|
@@ -113,7 +113,7 @@ opts = {
|
|
|
113
113
|
}
|
|
114
114
|
|
|
115
115
|
begin
|
|
116
|
-
#
|
|
116
|
+
# List transfers
|
|
117
117
|
result = api_instance.get_transfers(opts)
|
|
118
118
|
p result
|
|
119
119
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -129,7 +129,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
129
129
|
|
|
130
130
|
```ruby
|
|
131
131
|
begin
|
|
132
|
-
#
|
|
132
|
+
# List transfers
|
|
133
133
|
data, status_code, headers = api_instance.get_transfers_with_http_info(opts)
|
|
134
134
|
p status_code # => 2xx
|
|
135
135
|
p headers # => { ... }
|
data/docs/UpdateCustomer.md
CHANGED
|
@@ -4,18 +4,16 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Femsa | [optional] |
|
|
18
|
-
| **shipping_contacts** | [**Array<CustomerShippingContacts>**](CustomerShippingContacts.md) | Contains the detail of the shipping addresses that the client has active or has used in Femsa | [optional] |
|
|
7
|
+
| **name** | **String** | Customer's name. | [optional] |
|
|
8
|
+
| **email** | **String** | Customer email address. | [optional] |
|
|
9
|
+
| **phone** | **String** | Customer phone number. | [optional] |
|
|
10
|
+
| **corporate** | **Boolean** | True if the customer represents a company. | [optional] |
|
|
11
|
+
| **custom_reference** | **String** | Merchant-defined reference used to identify the customer in your system. | [optional] |
|
|
12
|
+
| **metadata** | **Hash<String, Object>** | Arbitrary metadata associated with the customer. | [optional] |
|
|
13
|
+
| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Customer payment sources to create/attach (offline recurrent references). | [optional] |
|
|
14
|
+
| **default_payment_source_id** | **String** | Sets the default payment source for the customer (must be an existing payment source on the customer). | [optional] |
|
|
15
|
+
| **default_fiscal_entity_id** | **String** | Sets the default fiscal entity for the customer (must be an existing fiscal entity on the customer). | [optional] |
|
|
16
|
+
| **default_shipping_contact_id** | **String** | Sets the default shipping contact for the customer (must be an existing shipping contact on the customer). | [optional] |
|
|
19
17
|
|
|
20
18
|
## Example
|
|
21
19
|
|
|
@@ -23,18 +21,16 @@
|
|
|
23
21
|
require 'digital_femsa'
|
|
24
22
|
|
|
25
23
|
instance = DigitalFemsa::UpdateCustomer.new(
|
|
26
|
-
|
|
27
|
-
default_payment_source_id: src_1a2b3c4d5e6f7g8h,
|
|
24
|
+
name: Miguel,
|
|
28
25
|
email: miguel@gmail.com,
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
corporate: false,
|
|
33
|
-
custom_reference: null,
|
|
34
|
-
fiscal_entities: null,
|
|
26
|
+
phone: 5215555555555,
|
|
27
|
+
corporate: null,
|
|
28
|
+
custom_reference: customer_123,
|
|
35
29
|
metadata: null,
|
|
36
30
|
payment_sources: null,
|
|
37
|
-
|
|
31
|
+
default_payment_source_id: null,
|
|
32
|
+
default_fiscal_entity_id: null,
|
|
33
|
+
default_shipping_contact_id: null
|
|
38
34
|
)
|
|
39
35
|
```
|
|
40
36
|
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **address** | [**CustomerAddress**](CustomerAddress.md) | | |
|
|
8
8
|
| **tax_id** | **String** | | [optional] |
|
|
9
|
+
| **name** | **String** | | [optional] |
|
|
9
10
|
| **email** | **String** | | [optional] |
|
|
10
11
|
| **phone** | **String** | | [optional] |
|
|
11
12
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
12
|
-
| **company_name** | **String** | | [optional] |
|
|
13
13
|
| **id** | **String** | | |
|
|
14
14
|
| **object** | **String** | | |
|
|
15
15
|
| **created_at** | **Integer** | | |
|
|
@@ -24,10 +24,10 @@ require 'digital_femsa'
|
|
|
24
24
|
instance = DigitalFemsa::UpdateCustomerFiscalEntitiesResponse.new(
|
|
25
25
|
address: null,
|
|
26
26
|
tax_id: null,
|
|
27
|
+
name: Femsa,
|
|
27
28
|
email: null,
|
|
28
29
|
phone: null,
|
|
29
30
|
metadata: null,
|
|
30
|
-
company_name: Femsa,
|
|
31
31
|
id: fis_ent_2tKZsTYcsryyu7Ah8,
|
|
32
32
|
object: fiscal_entities,
|
|
33
33
|
created_at: 1675715413,
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **amount** | **Integer** | The amount to be collected for tax in cents | [optional] |
|
|
8
|
-
| **description** | **String** |
|
|
8
|
+
| **description** | **String** | Description or tax name | [optional] |
|
|
9
9
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -15,7 +15,7 @@ require 'digital_femsa'
|
|
|
15
15
|
|
|
16
16
|
instance = DigitalFemsa::UpdateOrderTaxRequest.new(
|
|
17
17
|
amount: 100,
|
|
18
|
-
description:
|
|
18
|
+
description: VAT,
|
|
19
19
|
metadata: null
|
|
20
20
|
)
|
|
21
21
|
```
|
data/docs/UpdateProduct.md
CHANGED
|
@@ -4,15 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **antifraud_info** | **Hash<String, Object>** | | [optional] |
|
|
8
|
-
| **description** | **String** | | [optional] |
|
|
9
|
-
| **sku** | **String** | | [optional] |
|
|
10
7
|
| **name** | **String** | | [optional] |
|
|
11
8
|
| **unit_price** | **Integer** | | [optional] |
|
|
12
9
|
| **quantity** | **Integer** | | [optional] |
|
|
13
|
-
| **
|
|
10
|
+
| **sku** | **String** | | [optional] |
|
|
14
11
|
| **brand** | **String** | | [optional] |
|
|
15
|
-
| **
|
|
12
|
+
| **description** | **String** | | [optional] |
|
|
13
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
14
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
16
15
|
|
|
17
16
|
## Example
|
|
18
17
|
|
|
@@ -20,14 +19,13 @@
|
|
|
20
19
|
require 'digital_femsa'
|
|
21
20
|
|
|
22
21
|
instance = DigitalFemsa::UpdateProduct.new(
|
|
23
|
-
antifraud_info: null,
|
|
24
|
-
description: null,
|
|
25
|
-
sku: null,
|
|
26
22
|
name: Box of Cohiba S1s,
|
|
27
23
|
unit_price: 20000,
|
|
28
24
|
quantity: 1,
|
|
29
|
-
|
|
25
|
+
sku: null,
|
|
30
26
|
brand: null,
|
|
27
|
+
description: null,
|
|
28
|
+
tags: null,
|
|
31
29
|
metadata: null
|
|
32
30
|
)
|
|
33
31
|
```
|
data/docs/WebhookKeysApi.md
CHANGED
|
@@ -5,10 +5,10 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_webhook_key**](WebhookKeysApi.md#create_webhook_key) | **POST** /webhook_keys | Create Webhook Key |
|
|
8
|
-
| [**delete_webhook_key**](WebhookKeysApi.md#delete_webhook_key) | **DELETE** /webhook_keys/{id} | Delete
|
|
9
|
-
| [**get_webhook_key**](WebhookKeysApi.md#get_webhook_key) | **GET** /webhook_keys/{id} | Get
|
|
8
|
+
| [**delete_webhook_key**](WebhookKeysApi.md#delete_webhook_key) | **DELETE** /webhook_keys/{id} | Delete webhook key |
|
|
9
|
+
| [**get_webhook_key**](WebhookKeysApi.md#get_webhook_key) | **GET** /webhook_keys/{id} | Get webhook key |
|
|
10
10
|
| [**get_webhook_keys**](WebhookKeysApi.md#get_webhook_keys) | **GET** /webhook_keys | Get List of Webhook Keys |
|
|
11
|
-
| [**update_webhook_key**](WebhookKeysApi.md#update_webhook_key) | **PUT** /webhook_keys/{id} | Update
|
|
11
|
+
| [**update_webhook_key**](WebhookKeysApi.md#update_webhook_key) | **PUT** /webhook_keys/{id} | Update webhook key |
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
## create_webhook_key
|
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
17
17
|
|
|
18
18
|
Create Webhook Key
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Creates a new webhook signing key for the current company.
|
|
21
21
|
|
|
22
22
|
### Examples
|
|
23
23
|
|
|
@@ -88,7 +88,9 @@ end
|
|
|
88
88
|
|
|
89
89
|
> <WebhookKeyDeleteResponse> delete_webhook_key(id, opts)
|
|
90
90
|
|
|
91
|
-
Delete
|
|
91
|
+
Delete webhook key
|
|
92
|
+
|
|
93
|
+
Deletes a webhook signing key.
|
|
92
94
|
|
|
93
95
|
### Examples
|
|
94
96
|
|
|
@@ -108,7 +110,7 @@ opts = {
|
|
|
108
110
|
}
|
|
109
111
|
|
|
110
112
|
begin
|
|
111
|
-
# Delete
|
|
113
|
+
# Delete webhook key
|
|
112
114
|
result = api_instance.delete_webhook_key(id, opts)
|
|
113
115
|
p result
|
|
114
116
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -124,7 +126,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
124
126
|
|
|
125
127
|
```ruby
|
|
126
128
|
begin
|
|
127
|
-
# Delete
|
|
129
|
+
# Delete webhook key
|
|
128
130
|
data, status_code, headers = api_instance.delete_webhook_key_with_http_info(id, opts)
|
|
129
131
|
p status_code # => 2xx
|
|
130
132
|
p headers # => { ... }
|
|
@@ -159,7 +161,9 @@ end
|
|
|
159
161
|
|
|
160
162
|
> <WebhookKeyResponse> get_webhook_key(id, opts)
|
|
161
163
|
|
|
162
|
-
Get
|
|
164
|
+
Get webhook key
|
|
165
|
+
|
|
166
|
+
Retrieves the details of a webhook signing key by its ID.
|
|
163
167
|
|
|
164
168
|
### Examples
|
|
165
169
|
|
|
@@ -180,7 +184,7 @@ opts = {
|
|
|
180
184
|
}
|
|
181
185
|
|
|
182
186
|
begin
|
|
183
|
-
# Get
|
|
187
|
+
# Get webhook key
|
|
184
188
|
result = api_instance.get_webhook_key(id, opts)
|
|
185
189
|
p result
|
|
186
190
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -196,7 +200,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
196
200
|
|
|
197
201
|
```ruby
|
|
198
202
|
begin
|
|
199
|
-
# Get
|
|
203
|
+
# Get webhook key
|
|
200
204
|
data, status_code, headers = api_instance.get_webhook_key_with_http_info(id, opts)
|
|
201
205
|
p status_code # => 2xx
|
|
202
206
|
p headers # => { ... }
|
|
@@ -313,9 +317,9 @@ end
|
|
|
313
317
|
|
|
314
318
|
> <WebhookKeyResponse> update_webhook_key(id, opts)
|
|
315
319
|
|
|
316
|
-
Update
|
|
320
|
+
Update webhook key
|
|
317
321
|
|
|
318
|
-
|
|
322
|
+
Activates or deactivates an existing webhook signing key.
|
|
319
323
|
|
|
320
324
|
### Examples
|
|
321
325
|
|
|
@@ -336,7 +340,7 @@ opts = {
|
|
|
336
340
|
}
|
|
337
341
|
|
|
338
342
|
begin
|
|
339
|
-
# Update
|
|
343
|
+
# Update webhook key
|
|
340
344
|
result = api_instance.update_webhook_key(id, opts)
|
|
341
345
|
p result
|
|
342
346
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -352,7 +356,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
352
356
|
|
|
353
357
|
```ruby
|
|
354
358
|
begin
|
|
355
|
-
# Update
|
|
359
|
+
# Update webhook key
|
|
356
360
|
data, status_code, headers = api_instance.update_webhook_key_with_http_info(id, opts)
|
|
357
361
|
p status_code # => 2xx
|
|
358
362
|
p headers # => { ... }
|
data/docs/WebhooksApi.md
CHANGED
|
@@ -5,11 +5,11 @@ All URIs are relative to *https://api.digitalfemsa.io*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /webhooks | Create Webhook |
|
|
8
|
-
| [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete
|
|
9
|
-
| [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{id} | Get
|
|
8
|
+
| [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete webhook |
|
|
9
|
+
| [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{id} | Get webhook |
|
|
10
10
|
| [**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get List of Webhooks |
|
|
11
|
-
| [**test_webhook**](WebhooksApi.md#test_webhook) | **POST** /webhooks/{id}/test | Test
|
|
12
|
-
| [**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks/{id} | Update
|
|
11
|
+
| [**test_webhook**](WebhooksApi.md#test_webhook) | **POST** /webhooks/{id}/test | Test webhook |
|
|
12
|
+
| [**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks/{id} | Update webhook |
|
|
13
13
|
|
|
14
14
|
|
|
15
15
|
## create_webhook
|
|
@@ -32,7 +32,7 @@ DigitalFemsa.configure do |config|
|
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
api_instance = DigitalFemsa::WebhooksApi.new
|
|
35
|
-
webhook_request = DigitalFemsa::WebhookRequest.new({url: 'https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8', synchronous: false}) # WebhookRequest |
|
|
35
|
+
webhook_request = DigitalFemsa::WebhookRequest.new({url: 'https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8', synchronous: false}) # WebhookRequest | Webhook creation/update request payload.
|
|
36
36
|
opts = {
|
|
37
37
|
accept_language: 'es' # String | Use for knowing which language to use
|
|
38
38
|
}
|
|
@@ -68,7 +68,7 @@ end
|
|
|
68
68
|
|
|
69
69
|
| Name | Type | Description | Notes |
|
|
70
70
|
| ---- | ---- | ----------- | ----- |
|
|
71
|
-
| **webhook_request** | [**WebhookRequest**](WebhookRequest.md) |
|
|
71
|
+
| **webhook_request** | [**WebhookRequest**](WebhookRequest.md) | Webhook creation/update request payload. | |
|
|
72
72
|
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
73
73
|
|
|
74
74
|
### Return type
|
|
@@ -89,7 +89,9 @@ end
|
|
|
89
89
|
|
|
90
90
|
> <WebhookResponse> delete_webhook(id, opts)
|
|
91
91
|
|
|
92
|
-
Delete
|
|
92
|
+
Delete webhook
|
|
93
|
+
|
|
94
|
+
Deletes a webhook.
|
|
93
95
|
|
|
94
96
|
### Examples
|
|
95
97
|
|
|
@@ -109,7 +111,7 @@ opts = {
|
|
|
109
111
|
}
|
|
110
112
|
|
|
111
113
|
begin
|
|
112
|
-
# Delete
|
|
114
|
+
# Delete webhook
|
|
113
115
|
result = api_instance.delete_webhook(id, opts)
|
|
114
116
|
p result
|
|
115
117
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -125,7 +127,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
125
127
|
|
|
126
128
|
```ruby
|
|
127
129
|
begin
|
|
128
|
-
# Delete
|
|
130
|
+
# Delete webhook
|
|
129
131
|
data, status_code, headers = api_instance.delete_webhook_with_http_info(id, opts)
|
|
130
132
|
p status_code # => 2xx
|
|
131
133
|
p headers # => { ... }
|
|
@@ -160,7 +162,9 @@ end
|
|
|
160
162
|
|
|
161
163
|
> <WebhookResponse> get_webhook(id, opts)
|
|
162
164
|
|
|
163
|
-
Get
|
|
165
|
+
Get webhook
|
|
166
|
+
|
|
167
|
+
Retrieves the details of a webhook by its ID.
|
|
164
168
|
|
|
165
169
|
### Examples
|
|
166
170
|
|
|
@@ -181,7 +185,7 @@ opts = {
|
|
|
181
185
|
}
|
|
182
186
|
|
|
183
187
|
begin
|
|
184
|
-
# Get
|
|
188
|
+
# Get webhook
|
|
185
189
|
result = api_instance.get_webhook(id, opts)
|
|
186
190
|
p result
|
|
187
191
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -197,7 +201,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
197
201
|
|
|
198
202
|
```ruby
|
|
199
203
|
begin
|
|
200
|
-
# Get
|
|
204
|
+
# Get webhook
|
|
201
205
|
data, status_code, headers = api_instance.get_webhook_with_http_info(id, opts)
|
|
202
206
|
p status_code # => 2xx
|
|
203
207
|
p headers # => { ... }
|
|
@@ -254,6 +258,7 @@ opts = {
|
|
|
254
258
|
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.
|
|
255
259
|
limit: 56, # Integer | The numbers of items to return, the maximum value is 250
|
|
256
260
|
search: 'search_example', # String | General order search, e.g. by mail, reference etc.
|
|
261
|
+
url: 'https://api.digitalfemsa.io/webhook', # String | url for webhook filter
|
|
257
262
|
_next: '_next_example', # String | next page
|
|
258
263
|
previous: 'previous_example' # String | previous page
|
|
259
264
|
}
|
|
@@ -293,6 +298,7 @@ end
|
|
|
293
298
|
| **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] |
|
|
294
299
|
| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
|
|
295
300
|
| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
|
|
301
|
+
| **url** | **String** | url for webhook filter | [optional] |
|
|
296
302
|
| **_next** | **String** | next page | [optional] |
|
|
297
303
|
| **previous** | **String** | previous page | [optional] |
|
|
298
304
|
|
|
@@ -314,9 +320,9 @@ end
|
|
|
314
320
|
|
|
315
321
|
> <WebhookResponse> test_webhook(id, opts)
|
|
316
322
|
|
|
317
|
-
Test
|
|
323
|
+
Test webhook
|
|
318
324
|
|
|
319
|
-
|
|
325
|
+
Sends a test event to the specified webhook to verify it can receive events.
|
|
320
326
|
|
|
321
327
|
### Examples
|
|
322
328
|
|
|
@@ -336,7 +342,7 @@ opts = {
|
|
|
336
342
|
}
|
|
337
343
|
|
|
338
344
|
begin
|
|
339
|
-
# Test
|
|
345
|
+
# Test webhook
|
|
340
346
|
result = api_instance.test_webhook(id, opts)
|
|
341
347
|
p result
|
|
342
348
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -352,7 +358,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
352
358
|
|
|
353
359
|
```ruby
|
|
354
360
|
begin
|
|
355
|
-
# Test
|
|
361
|
+
# Test webhook
|
|
356
362
|
data, status_code, headers = api_instance.test_webhook_with_http_info(id, opts)
|
|
357
363
|
p status_code # => 2xx
|
|
358
364
|
p headers # => { ... }
|
|
@@ -387,9 +393,9 @@ end
|
|
|
387
393
|
|
|
388
394
|
> <WebhookResponse> update_webhook(id, webhook_update_request, opts)
|
|
389
395
|
|
|
390
|
-
Update
|
|
396
|
+
Update webhook
|
|
391
397
|
|
|
392
|
-
|
|
398
|
+
Updates an existing webhook.
|
|
393
399
|
|
|
394
400
|
### Examples
|
|
395
401
|
|
|
@@ -404,14 +410,14 @@ end
|
|
|
404
410
|
|
|
405
411
|
api_instance = DigitalFemsa::WebhooksApi.new
|
|
406
412
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
407
|
-
webhook_update_request = DigitalFemsa::WebhookUpdateRequest.new({url: 'https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8'}) # WebhookUpdateRequest |
|
|
413
|
+
webhook_update_request = DigitalFemsa::WebhookUpdateRequest.new({url: 'https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8'}) # WebhookUpdateRequest | Webhook update request payload.
|
|
408
414
|
opts = {
|
|
409
415
|
accept_language: 'es', # String | Use for knowing which language to use
|
|
410
416
|
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.
|
|
411
417
|
}
|
|
412
418
|
|
|
413
419
|
begin
|
|
414
|
-
# Update
|
|
420
|
+
# Update webhook
|
|
415
421
|
result = api_instance.update_webhook(id, webhook_update_request, opts)
|
|
416
422
|
p result
|
|
417
423
|
rescue DigitalFemsa::ApiError => e
|
|
@@ -427,7 +433,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
427
433
|
|
|
428
434
|
```ruby
|
|
429
435
|
begin
|
|
430
|
-
# Update
|
|
436
|
+
# Update webhook
|
|
431
437
|
data, status_code, headers = api_instance.update_webhook_with_http_info(id, webhook_update_request, opts)
|
|
432
438
|
p status_code # => 2xx
|
|
433
439
|
p headers # => { ... }
|
|
@@ -442,7 +448,7 @@ end
|
|
|
442
448
|
| Name | Type | Description | Notes |
|
|
443
449
|
| ---- | ---- | ----------- | ----- |
|
|
444
450
|
| **id** | **String** | Identifier of the resource | |
|
|
445
|
-
| **webhook_update_request** | [**WebhookUpdateRequest**](WebhookUpdateRequest.md) |
|
|
451
|
+
| **webhook_update_request** | [**WebhookUpdateRequest**](WebhookUpdateRequest.md) | Webhook update request payload. | |
|
|
446
452
|
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
447
453
|
| **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] |
|
|
448
454
|
|