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
|
@@ -20,6 +20,7 @@ module DigitalFemsa
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Cancel Payment Link
|
|
23
|
+
# 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.
|
|
23
24
|
# @param id [String] Identifier of the resource
|
|
24
25
|
# @param [Hash] opts the optional parameters
|
|
25
26
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -31,6 +32,7 @@ module DigitalFemsa
|
|
|
31
32
|
end
|
|
32
33
|
|
|
33
34
|
# Cancel Payment Link
|
|
35
|
+
# 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.
|
|
34
36
|
# @param id [String] Identifier of the resource
|
|
35
37
|
# @param [Hash] opts the optional parameters
|
|
36
38
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -90,7 +92,8 @@ module DigitalFemsa
|
|
|
90
92
|
return data, status_code, headers
|
|
91
93
|
end
|
|
92
94
|
|
|
93
|
-
# Create
|
|
95
|
+
# Create Payment Link
|
|
96
|
+
# 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).
|
|
94
97
|
# @param checkout [Checkout] requested field for checkout
|
|
95
98
|
# @param [Hash] opts the optional parameters
|
|
96
99
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -101,7 +104,8 @@ module DigitalFemsa
|
|
|
101
104
|
data
|
|
102
105
|
end
|
|
103
106
|
|
|
104
|
-
# Create
|
|
107
|
+
# Create Payment Link
|
|
108
|
+
# 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).
|
|
105
109
|
# @param checkout [Checkout] requested field for checkout
|
|
106
110
|
# @param [Hash] opts the optional parameters
|
|
107
111
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -249,6 +253,7 @@ module DigitalFemsa
|
|
|
249
253
|
end
|
|
250
254
|
|
|
251
255
|
# Get a payment link by ID
|
|
256
|
+
# Retrieves the details of a checkout by its ID.
|
|
252
257
|
# @param id [String] Identifier of the resource
|
|
253
258
|
# @param [Hash] opts the optional parameters
|
|
254
259
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -260,6 +265,7 @@ module DigitalFemsa
|
|
|
260
265
|
end
|
|
261
266
|
|
|
262
267
|
# Get a payment link by ID
|
|
268
|
+
# Retrieves the details of a checkout by its ID.
|
|
263
269
|
# @param id [String] Identifier of the resource
|
|
264
270
|
# @param [Hash] opts the optional parameters
|
|
265
271
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -320,7 +326,7 @@ module DigitalFemsa
|
|
|
320
326
|
end
|
|
321
327
|
|
|
322
328
|
# Get a list of payment links
|
|
323
|
-
# Returns a list of links
|
|
329
|
+
# Returns a paginated list of payment links created by the merchant. Results can be navigated using the pagination parameters.
|
|
324
330
|
# @param [Hash] opts the optional parameters
|
|
325
331
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
326
332
|
# @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.
|
|
@@ -335,7 +341,7 @@ module DigitalFemsa
|
|
|
335
341
|
end
|
|
336
342
|
|
|
337
343
|
# Get a list of payment links
|
|
338
|
-
# Returns a list of links
|
|
344
|
+
# Returns a paginated list of payment links created by the merchant. Results can be navigated using the pagination parameters.
|
|
339
345
|
# @param [Hash] opts the optional parameters
|
|
340
346
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
341
347
|
# @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.
|
|
@@ -405,87 +411,5 @@ module DigitalFemsa
|
|
|
405
411
|
end
|
|
406
412
|
return data, status_code, headers
|
|
407
413
|
end
|
|
408
|
-
|
|
409
|
-
# Send an sms
|
|
410
|
-
# @param id [String] Identifier of the resource
|
|
411
|
-
# @param sms_checkout_request [SmsCheckoutRequest] requested field for sms checkout
|
|
412
|
-
# @param [Hash] opts the optional parameters
|
|
413
|
-
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
414
|
-
# @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.
|
|
415
|
-
# @return [CheckoutResponse]
|
|
416
|
-
def sms_checkout(id, sms_checkout_request, opts = {})
|
|
417
|
-
data, _status_code, _headers = sms_checkout_with_http_info(id, sms_checkout_request, opts)
|
|
418
|
-
data
|
|
419
|
-
end
|
|
420
|
-
|
|
421
|
-
# Send an sms
|
|
422
|
-
# @param id [String] Identifier of the resource
|
|
423
|
-
# @param sms_checkout_request [SmsCheckoutRequest] requested field for sms checkout
|
|
424
|
-
# @param [Hash] opts the optional parameters
|
|
425
|
-
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
426
|
-
# @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.
|
|
427
|
-
# @return [Array<(CheckoutResponse, Integer, Hash)>] CheckoutResponse data, response status code and response headers
|
|
428
|
-
def sms_checkout_with_http_info(id, sms_checkout_request, opts = {})
|
|
429
|
-
if @api_client.config.debugging
|
|
430
|
-
@api_client.config.logger.debug 'Calling API: PaymentLinkApi.sms_checkout ...'
|
|
431
|
-
end
|
|
432
|
-
# verify the required parameter 'id' is set
|
|
433
|
-
if @api_client.config.client_side_validation && id.nil?
|
|
434
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling PaymentLinkApi.sms_checkout"
|
|
435
|
-
end
|
|
436
|
-
# verify the required parameter 'sms_checkout_request' is set
|
|
437
|
-
if @api_client.config.client_side_validation && sms_checkout_request.nil?
|
|
438
|
-
fail ArgumentError, "Missing the required parameter 'sms_checkout_request' when calling PaymentLinkApi.sms_checkout"
|
|
439
|
-
end
|
|
440
|
-
allowable_values = ["es", "en"]
|
|
441
|
-
if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
|
|
442
|
-
fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
|
|
443
|
-
end
|
|
444
|
-
# resource path
|
|
445
|
-
local_var_path = '/checkouts/{id}/sms'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
446
|
-
|
|
447
|
-
# query parameters
|
|
448
|
-
query_params = opts[:query_params] || {}
|
|
449
|
-
|
|
450
|
-
# header parameters
|
|
451
|
-
header_params = opts[:header_params] || {}
|
|
452
|
-
# HTTP header 'Accept' (if needed)
|
|
453
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.app-v2.1.0+json'])
|
|
454
|
-
# HTTP header 'Content-Type'
|
|
455
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
456
|
-
if !content_type.nil?
|
|
457
|
-
header_params['Content-Type'] = content_type
|
|
458
|
-
end
|
|
459
|
-
header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
|
|
460
|
-
header_params[:'X-Child-Company-Id'] = opts[:'x_child_company_id'] if !opts[:'x_child_company_id'].nil?
|
|
461
|
-
|
|
462
|
-
# form parameters
|
|
463
|
-
form_params = opts[:form_params] || {}
|
|
464
|
-
|
|
465
|
-
# http body (model)
|
|
466
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(sms_checkout_request)
|
|
467
|
-
|
|
468
|
-
# return_type
|
|
469
|
-
return_type = opts[:debug_return_type] || 'CheckoutResponse'
|
|
470
|
-
|
|
471
|
-
# auth_names
|
|
472
|
-
auth_names = opts[:debug_auth_names] || ['bearerAuth']
|
|
473
|
-
|
|
474
|
-
new_options = opts.merge(
|
|
475
|
-
:operation => :"PaymentLinkApi.sms_checkout",
|
|
476
|
-
:header_params => header_params,
|
|
477
|
-
:query_params => query_params,
|
|
478
|
-
:form_params => form_params,
|
|
479
|
-
:body => post_body,
|
|
480
|
-
:auth_names => auth_names,
|
|
481
|
-
:return_type => return_type
|
|
482
|
-
)
|
|
483
|
-
|
|
484
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
485
|
-
if @api_client.config.debugging
|
|
486
|
-
@api_client.config.logger.debug "API called: PaymentLinkApi#sms_checkout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
487
|
-
end
|
|
488
|
-
return data, status_code, headers
|
|
489
|
-
end
|
|
490
414
|
end
|
|
491
415
|
end
|
|
@@ -20,7 +20,7 @@ module DigitalFemsa
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Payment Method
|
|
23
|
-
#
|
|
23
|
+
# 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`.
|
|
24
24
|
# @param id [String] Identifier of the resource
|
|
25
25
|
# @param create_customer_payment_methods_request [CreateCustomerPaymentMethodsRequest] requested field for customer payment methods
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
@@ -33,7 +33,7 @@ module DigitalFemsa
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Create Payment Method
|
|
36
|
-
#
|
|
36
|
+
# 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`.
|
|
37
37
|
# @param id [String] Identifier of the resource
|
|
38
38
|
# @param create_customer_payment_methods_request [CreateCustomerPaymentMethodsRequest] requested field for customer payment methods
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
@@ -104,7 +104,7 @@ module DigitalFemsa
|
|
|
104
104
|
end
|
|
105
105
|
|
|
106
106
|
# Delete Payment Method
|
|
107
|
-
#
|
|
107
|
+
# Deletes a specific payment method of a customer. After deletion, the payment method can no longer be used for future payments.
|
|
108
108
|
# @param id [String] Identifier of the resource
|
|
109
109
|
# @param payment_method_id [String] Identifier of the payment method
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
@@ -117,7 +117,7 @@ module DigitalFemsa
|
|
|
117
117
|
end
|
|
118
118
|
|
|
119
119
|
# Delete Payment Method
|
|
120
|
-
#
|
|
120
|
+
# Deletes a specific payment method of a customer. After deletion, the payment method can no longer be used for future payments.
|
|
121
121
|
# @param id [String] Identifier of the resource
|
|
122
122
|
# @param payment_method_id [String] Identifier of the payment method
|
|
123
123
|
# @param [Hash] opts the optional parameters
|
|
@@ -276,10 +276,10 @@ module DigitalFemsa
|
|
|
276
276
|
end
|
|
277
277
|
|
|
278
278
|
# Update Payment Method
|
|
279
|
-
#
|
|
279
|
+
# 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`.
|
|
280
280
|
# @param id [String] Identifier of the resource
|
|
281
281
|
# @param payment_method_id [String] Identifier of the payment method
|
|
282
|
-
# @param update_payment_methods [UpdatePaymentMethods]
|
|
282
|
+
# @param update_payment_methods [UpdatePaymentMethods] Request body for updating a customer payment method.
|
|
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')
|
|
285
285
|
# @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.
|
|
@@ -290,10 +290,10 @@ module DigitalFemsa
|
|
|
290
290
|
end
|
|
291
291
|
|
|
292
292
|
# Update Payment Method
|
|
293
|
-
#
|
|
293
|
+
# 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`.
|
|
294
294
|
# @param id [String] Identifier of the resource
|
|
295
295
|
# @param payment_method_id [String] Identifier of the payment method
|
|
296
|
-
# @param update_payment_methods [UpdatePaymentMethods]
|
|
296
|
+
# @param update_payment_methods [UpdatePaymentMethods] Request body for updating a customer payment method.
|
|
297
297
|
# @param [Hash] opts the optional parameters
|
|
298
298
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
299
299
|
# @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,9 +20,9 @@ module DigitalFemsa
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Product
|
|
23
|
-
#
|
|
23
|
+
# 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.
|
|
24
24
|
# @param id [String] Identifier of the resource
|
|
25
|
-
# @param product [Product]
|
|
25
|
+
# @param product [Product] Fields required to create a new product (line item) for an existing order. This request adds a new item to the order.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
28
28
|
# @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.
|
|
@@ -33,9 +33,9 @@ module DigitalFemsa
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Create Product
|
|
36
|
-
#
|
|
36
|
+
# 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.
|
|
37
37
|
# @param id [String] Identifier of the resource
|
|
38
|
-
# @param product [Product]
|
|
38
|
+
# @param product [Product] Fields required to create a new product (line item) for an existing order. This request adds a new item to the order.
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
41
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.
|
|
@@ -104,7 +104,7 @@ module DigitalFemsa
|
|
|
104
104
|
end
|
|
105
105
|
|
|
106
106
|
# Delete Product
|
|
107
|
-
#
|
|
107
|
+
# Deletes a product (line item) from an existing order. The API will validate whether the order can be modified before removing the item.
|
|
108
108
|
# @param id [String] Identifier of the resource
|
|
109
109
|
# @param line_item_id [String] identifier
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
@@ -117,7 +117,7 @@ module DigitalFemsa
|
|
|
117
117
|
end
|
|
118
118
|
|
|
119
119
|
# Delete Product
|
|
120
|
-
#
|
|
120
|
+
# Deletes a product (line item) from an existing order. The API will validate whether the order can be modified before removing the item.
|
|
121
121
|
# @param id [String] Identifier of the resource
|
|
122
122
|
# @param line_item_id [String] identifier
|
|
123
123
|
# @param [Hash] opts the optional parameters
|
|
@@ -183,10 +183,10 @@ module DigitalFemsa
|
|
|
183
183
|
end
|
|
184
184
|
|
|
185
185
|
# Update Product
|
|
186
|
-
#
|
|
186
|
+
# 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.
|
|
187
187
|
# @param id [String] Identifier of the resource
|
|
188
188
|
# @param line_item_id [String] identifier
|
|
189
|
-
# @param update_product [UpdateProduct]
|
|
189
|
+
# @param update_product [UpdateProduct] Fields allowed to update an existing product (line item) in an order. All fields are optional; only the provided fields will be updated.
|
|
190
190
|
# @param [Hash] opts the optional parameters
|
|
191
191
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
192
192
|
# @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.
|
|
@@ -197,10 +197,10 @@ module DigitalFemsa
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
# Update Product
|
|
200
|
-
#
|
|
200
|
+
# 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.
|
|
201
201
|
# @param id [String] Identifier of the resource
|
|
202
202
|
# @param line_item_id [String] identifier
|
|
203
|
-
# @param update_product [UpdateProduct]
|
|
203
|
+
# @param update_product [UpdateProduct] Fields allowed to update an existing product (line item) in an order. All fields are optional; only the provided fields will be updated.
|
|
204
204
|
# @param [Hash] opts the optional parameters
|
|
205
205
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
206
206
|
# @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.
|
|
@@ -19,10 +19,10 @@ module DigitalFemsa
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Create a shipping
|
|
23
|
-
#
|
|
22
|
+
# Create a shipping contact
|
|
23
|
+
# Creates a new shipping contact for a customer. The shipping contact is associated with the customer identified by `id`.
|
|
24
24
|
# @param id [String] Identifier of the resource
|
|
25
|
-
# @param customer_shipping_contacts [CustomerShippingContacts]
|
|
25
|
+
# @param customer_shipping_contacts [CustomerShippingContacts] Request body for creating or updating a customer shipping contact.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
28
28
|
# @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.
|
|
@@ -32,10 +32,10 @@ module DigitalFemsa
|
|
|
32
32
|
data
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
-
# Create a shipping
|
|
36
|
-
#
|
|
35
|
+
# Create a shipping contact
|
|
36
|
+
# Creates a new shipping contact for a customer. The shipping contact is associated with the customer identified by `id`.
|
|
37
37
|
# @param id [String] Identifier of the resource
|
|
38
|
-
# @param customer_shipping_contacts [CustomerShippingContacts]
|
|
38
|
+
# @param customer_shipping_contacts [CustomerShippingContacts] Request body for creating or updating a customer shipping contact.
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
41
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.
|
|
@@ -186,7 +186,7 @@ module DigitalFemsa
|
|
|
186
186
|
# Update shipping contact that corresponds to a customer ID.
|
|
187
187
|
# @param id [String] Identifier of the resource
|
|
188
188
|
# @param shipping_contacts_id [String] identifier
|
|
189
|
-
# @param customer_update_shipping_contacts [CustomerUpdateShippingContacts]
|
|
189
|
+
# @param customer_update_shipping_contacts [CustomerUpdateShippingContacts] Request body for updating a customer shipping contact.
|
|
190
190
|
# @param [Hash] opts the optional parameters
|
|
191
191
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
192
192
|
# @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.
|
|
@@ -200,7 +200,7 @@ module DigitalFemsa
|
|
|
200
200
|
# Update shipping contact that corresponds to a customer ID.
|
|
201
201
|
# @param id [String] Identifier of the resource
|
|
202
202
|
# @param shipping_contacts_id [String] identifier
|
|
203
|
-
# @param customer_update_shipping_contacts [CustomerUpdateShippingContacts]
|
|
203
|
+
# @param customer_update_shipping_contacts [CustomerUpdateShippingContacts] Request body for updating a customer shipping contact.
|
|
204
204
|
# @param [Hash] opts the optional parameters
|
|
205
205
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
206
206
|
# @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,9 +20,9 @@ module DigitalFemsa
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Shipping
|
|
23
|
-
#
|
|
23
|
+
# 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.
|
|
24
24
|
# @param id [String] Identifier of the resource
|
|
25
|
-
# @param shipping_request [ShippingRequest]
|
|
25
|
+
# @param shipping_request [ShippingRequest] Request body for creating or updating a shipping line.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
28
28
|
# @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.
|
|
@@ -33,9 +33,9 @@ module DigitalFemsa
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Create Shipping
|
|
36
|
-
#
|
|
36
|
+
# 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.
|
|
37
37
|
# @param id [String] Identifier of the resource
|
|
38
|
-
# @param shipping_request [ShippingRequest]
|
|
38
|
+
# @param shipping_request [ShippingRequest] Request body for creating or updating a shipping line.
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
41
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.
|
|
@@ -104,7 +104,7 @@ module DigitalFemsa
|
|
|
104
104
|
end
|
|
105
105
|
|
|
106
106
|
# Delete Shipping
|
|
107
|
-
#
|
|
107
|
+
# Deletes an existing shipping line from an order. The shipping line identified by `shipping_id` belongs to the order identified by `id`.
|
|
108
108
|
# @param id [String] Identifier of the resource
|
|
109
109
|
# @param shipping_id [String] identifier
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
@@ -117,7 +117,7 @@ module DigitalFemsa
|
|
|
117
117
|
end
|
|
118
118
|
|
|
119
119
|
# Delete Shipping
|
|
120
|
-
#
|
|
120
|
+
# Deletes an existing shipping line from an order. The shipping line identified by `shipping_id` belongs to the order identified by `id`.
|
|
121
121
|
# @param id [String] Identifier of the resource
|
|
122
122
|
# @param shipping_id [String] identifier
|
|
123
123
|
# @param [Hash] opts the optional parameters
|
|
@@ -183,10 +183,10 @@ module DigitalFemsa
|
|
|
183
183
|
end
|
|
184
184
|
|
|
185
185
|
# Update Shipping
|
|
186
|
-
#
|
|
186
|
+
# 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.
|
|
187
187
|
# @param id [String] Identifier of the resource
|
|
188
188
|
# @param shipping_id [String] identifier
|
|
189
|
-
# @param shipping_request [ShippingRequest]
|
|
189
|
+
# @param shipping_request [ShippingRequest] Request body for creating or updating a shipping line.
|
|
190
190
|
# @param [Hash] opts the optional parameters
|
|
191
191
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
192
192
|
# @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.
|
|
@@ -197,10 +197,10 @@ module DigitalFemsa
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
# Update Shipping
|
|
200
|
-
#
|
|
200
|
+
# 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.
|
|
201
201
|
# @param id [String] Identifier of the resource
|
|
202
202
|
# @param shipping_id [String] identifier
|
|
203
|
-
# @param shipping_request [ShippingRequest]
|
|
203
|
+
# @param shipping_request [ShippingRequest] Request body for creating or updating a shipping line.
|
|
204
204
|
# @param [Hash] opts the optional parameters
|
|
205
205
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
206
206
|
# @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,9 +20,9 @@ module DigitalFemsa
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Tax
|
|
23
|
-
#
|
|
23
|
+
# 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.
|
|
24
24
|
# @param id [String] Identifier of the resource
|
|
25
|
-
# @param order_tax_request [OrderTaxRequest]
|
|
25
|
+
# @param order_tax_request [OrderTaxRequest] Request body for creating a tax line.
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
28
28
|
# @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.
|
|
@@ -33,9 +33,9 @@ module DigitalFemsa
|
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Create Tax
|
|
36
|
-
#
|
|
36
|
+
# 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.
|
|
37
37
|
# @param id [String] Identifier of the resource
|
|
38
|
-
# @param order_tax_request [OrderTaxRequest]
|
|
38
|
+
# @param order_tax_request [OrderTaxRequest] Request body for creating a tax line.
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
41
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.
|
|
@@ -104,7 +104,7 @@ module DigitalFemsa
|
|
|
104
104
|
end
|
|
105
105
|
|
|
106
106
|
# Delete Tax
|
|
107
|
-
#
|
|
107
|
+
# 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`.
|
|
108
108
|
# @param id [String] Identifier of the resource
|
|
109
109
|
# @param tax_id [String] identifier
|
|
110
110
|
# @param [Hash] opts the optional parameters
|
|
@@ -117,7 +117,7 @@ module DigitalFemsa
|
|
|
117
117
|
end
|
|
118
118
|
|
|
119
119
|
# Delete Tax
|
|
120
|
-
#
|
|
120
|
+
# 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`.
|
|
121
121
|
# @param id [String] Identifier of the resource
|
|
122
122
|
# @param tax_id [String] identifier
|
|
123
123
|
# @param [Hash] opts the optional parameters
|
|
@@ -183,10 +183,10 @@ module DigitalFemsa
|
|
|
183
183
|
end
|
|
184
184
|
|
|
185
185
|
# Update Tax
|
|
186
|
-
#
|
|
186
|
+
# 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.
|
|
187
187
|
# @param id [String] Identifier of the resource
|
|
188
188
|
# @param tax_id [String] identifier
|
|
189
|
-
# @param update_order_tax_request [UpdateOrderTaxRequest]
|
|
189
|
+
# @param update_order_tax_request [UpdateOrderTaxRequest] Request body for updating a tax line.
|
|
190
190
|
# @param [Hash] opts the optional parameters
|
|
191
191
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
192
192
|
# @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.
|
|
@@ -197,10 +197,10 @@ module DigitalFemsa
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
# Update Tax
|
|
200
|
-
#
|
|
200
|
+
# 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.
|
|
201
201
|
# @param id [String] Identifier of the resource
|
|
202
202
|
# @param tax_id [String] identifier
|
|
203
|
-
# @param update_order_tax_request [UpdateOrderTaxRequest]
|
|
203
|
+
# @param update_order_tax_request [UpdateOrderTaxRequest] Request body for updating a tax line.
|
|
204
204
|
# @param [Hash] opts the optional parameters
|
|
205
205
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
206
206
|
# @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 transaction
|
|
23
|
-
#
|
|
23
|
+
# Retrieves the details of a transaction by its ID.
|
|
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 transaction
|
|
35
|
-
#
|
|
35
|
+
# Retrieves the details of a transaction by its ID.
|
|
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')
|
|
@@ -92,8 +92,8 @@ module DigitalFemsa
|
|
|
92
92
|
return data, status_code, headers
|
|
93
93
|
end
|
|
94
94
|
|
|
95
|
-
#
|
|
96
|
-
#
|
|
95
|
+
# List transactions
|
|
96
|
+
# 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.
|
|
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.
|
|
@@ -110,8 +110,8 @@ module DigitalFemsa
|
|
|
110
110
|
data
|
|
111
111
|
end
|
|
112
112
|
|
|
113
|
-
#
|
|
114
|
-
#
|
|
113
|
+
# List transactions
|
|
114
|
+
# 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.
|
|
115
115
|
# @param [Hash] opts the optional parameters
|
|
116
116
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
117
117
|
# @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.
|
|
@@ -19,8 +19,8 @@ module DigitalFemsa
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Get
|
|
23
|
-
#
|
|
22
|
+
# Get transfer
|
|
23
|
+
# Retrieves the details of a transfer by its ID.
|
|
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')
|
|
@@ -31,8 +31,8 @@ module DigitalFemsa
|
|
|
31
31
|
data
|
|
32
32
|
end
|
|
33
33
|
|
|
34
|
-
# Get
|
|
35
|
-
#
|
|
34
|
+
# Get transfer
|
|
35
|
+
# Retrieves the details of a transfer by its ID.
|
|
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')
|
|
@@ -92,8 +92,8 @@ module DigitalFemsa
|
|
|
92
92
|
return data, status_code, headers
|
|
93
93
|
end
|
|
94
94
|
|
|
95
|
-
#
|
|
96
|
-
#
|
|
95
|
+
# List transfers
|
|
96
|
+
# 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.
|
|
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.
|
|
@@ -107,8 +107,8 @@ module DigitalFemsa
|
|
|
107
107
|
data
|
|
108
108
|
end
|
|
109
109
|
|
|
110
|
-
#
|
|
111
|
-
#
|
|
110
|
+
# List transfers
|
|
111
|
+
# 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.
|
|
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
|
# Create Webhook Key
|
|
23
|
-
#
|
|
23
|
+
# Creates a new webhook signing key for the current company.
|
|
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
|
# @option opts [WebhookKeyRequest] :webhook_key_request
|
|
@@ -31,7 +31,7 @@ module DigitalFemsa
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Create Webhook Key
|
|
34
|
-
#
|
|
34
|
+
# Creates a new webhook signing key for the current company.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
37
37
|
# @option opts [WebhookKeyRequest] :webhook_key_request
|
|
@@ -90,7 +90,8 @@ module DigitalFemsa
|
|
|
90
90
|
return data, status_code, headers
|
|
91
91
|
end
|
|
92
92
|
|
|
93
|
-
# Delete
|
|
93
|
+
# Delete webhook key
|
|
94
|
+
# Deletes a webhook signing key.
|
|
94
95
|
# @param id [String] Identifier of the resource
|
|
95
96
|
# @param [Hash] opts the optional parameters
|
|
96
97
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -100,7 +101,8 @@ module DigitalFemsa
|
|
|
100
101
|
data
|
|
101
102
|
end
|
|
102
103
|
|
|
103
|
-
# Delete
|
|
104
|
+
# Delete webhook key
|
|
105
|
+
# Deletes a webhook signing key.
|
|
104
106
|
# @param id [String] Identifier of the resource
|
|
105
107
|
# @param [Hash] opts the optional parameters
|
|
106
108
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -158,7 +160,8 @@ module DigitalFemsa
|
|
|
158
160
|
return data, status_code, headers
|
|
159
161
|
end
|
|
160
162
|
|
|
161
|
-
# Get
|
|
163
|
+
# Get webhook key
|
|
164
|
+
# Retrieves the details of a webhook signing key by its ID.
|
|
162
165
|
# @param id [String] Identifier of the resource
|
|
163
166
|
# @param [Hash] opts the optional parameters
|
|
164
167
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -169,7 +172,8 @@ module DigitalFemsa
|
|
|
169
172
|
data
|
|
170
173
|
end
|
|
171
174
|
|
|
172
|
-
# Get
|
|
175
|
+
# Get webhook key
|
|
176
|
+
# Retrieves the details of a webhook signing key by its ID.
|
|
173
177
|
# @param id [String] Identifier of the resource
|
|
174
178
|
# @param [Hash] opts the optional parameters
|
|
175
179
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -316,8 +320,8 @@ module DigitalFemsa
|
|
|
316
320
|
return data, status_code, headers
|
|
317
321
|
end
|
|
318
322
|
|
|
319
|
-
# Update
|
|
320
|
-
#
|
|
323
|
+
# Update webhook key
|
|
324
|
+
# Activates or deactivates an existing webhook signing key.
|
|
321
325
|
# @param id [String] Identifier of the resource
|
|
322
326
|
# @param [Hash] opts the optional parameters
|
|
323
327
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|
|
@@ -328,8 +332,8 @@ module DigitalFemsa
|
|
|
328
332
|
data
|
|
329
333
|
end
|
|
330
334
|
|
|
331
|
-
# Update
|
|
332
|
-
#
|
|
335
|
+
# Update webhook key
|
|
336
|
+
# Activates or deactivates an existing webhook signing key.
|
|
333
337
|
# @param id [String] Identifier of the resource
|
|
334
338
|
# @param [Hash] opts the optional parameters
|
|
335
339
|
# @option opts [String] :accept_language Use for knowing which language to use (default to 'es')
|