digital_femsa 1.0.0

data/docs/WebhookKeysApi.md

@@ -0,0 +1,385 @@
+# DigitalFemsa::WebhookKeysApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook_key**](WebhookKeysApi.md#create_webhook_key) | **POST** /webhook_keys | Create Webhook Key |
+| [**delete_webhook_key**](WebhookKeysApi.md#delete_webhook_key) | **DELETE** /webhook_keys/{id} | Delete Webhook key |
+| [**get_webhook_key**](WebhookKeysApi.md#get_webhook_key) | **GET** /webhook_keys/{id} | Get Webhook Key |
+| [**get_webhook_keys**](WebhookKeysApi.md#get_webhook_keys) | **GET** /webhook_keys | Get List of Webhook Keys |
+| [**update_webhook_key**](WebhookKeysApi.md#update_webhook_key) | **PUT** /webhook_keys/{id} | Update Webhook Key |
+
+
+## create_webhook_key
+
+> <WebhookKeyCreateResponse> create_webhook_key(opts)
+
+Create Webhook Key
+
+Create a webhook key
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::WebhookKeysApi.new
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  webhook_key_request: DigitalFemsa::WebhookKeyRequest.new # WebhookKeyRequest | 
+}
+
+begin
+  # Create Webhook Key
+  result = api_instance.create_webhook_key(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->create_webhook_key: #{e}"
+end
+```
+
+#### Using the create_webhook_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookKeyCreateResponse>, Integer, Hash)> create_webhook_key_with_http_info(opts)
+
+```ruby
+begin
+  # Create Webhook Key
+  data, status_code, headers = api_instance.create_webhook_key_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookKeyCreateResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->create_webhook_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+| **webhook_key_request** | [**WebhookKeyRequest**](WebhookKeyRequest.md) |  | [optional] |
+
+### Return type
+
+[**WebhookKeyCreateResponse**](WebhookKeyCreateResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## delete_webhook_key
+
+> <WebhookKeyDeleteResponse> delete_webhook_key(id, opts)
+
+Delete Webhook key
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::WebhookKeysApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es' # String | Use for knowing which language to use
+}
+
+begin
+  # Delete Webhook key
+  result = api_instance.delete_webhook_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->delete_webhook_key: #{e}"
+end
+```
+
+#### Using the delete_webhook_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookKeyDeleteResponse>, Integer, Hash)> delete_webhook_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Delete Webhook key
+  data, status_code, headers = api_instance.delete_webhook_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookKeyDeleteResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->delete_webhook_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+
+### Return type
+
+[**WebhookKeyDeleteResponse**](WebhookKeyDeleteResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_webhook_key
+
+> <WebhookKeyResponse> get_webhook_key(id, opts)
+
+Get Webhook Key
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::WebhookKeysApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  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.
+}
+
+begin
+  # Get Webhook Key
+  result = api_instance.get_webhook_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->get_webhook_key: #{e}"
+end
+```
+
+#### Using the get_webhook_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookKeyResponse>, Integer, Hash)> get_webhook_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Webhook Key
+  data, status_code, headers = api_instance.get_webhook_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookKeyResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->get_webhook_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+| **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] |
+
+### Return type
+
+[**WebhookKeyResponse**](WebhookKeyResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## get_webhook_keys
+
+> <GetWebhookKeysResponse> get_webhook_keys(opts)
+
+Get List of Webhook Keys
+
+Consume the list of webhook keys you have
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::WebhookKeysApi.new
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  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.
+  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
+  search: 'search_example', # String | General order search, e.g. by mail, reference etc.
+  _next: '_next_example', # String | next page
+  previous: 'previous_example' # String | previous page
+}
+
+begin
+  # Get List of Webhook Keys
+  result = api_instance.get_webhook_keys(opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->get_webhook_keys: #{e}"
+end
+```
+
+#### Using the get_webhook_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhookKeysResponse>, Integer, Hash)> get_webhook_keys_with_http_info(opts)
+
+```ruby
+begin
+  # Get List of Webhook Keys
+  data, status_code, headers = api_instance.get_webhook_keys_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhookKeysResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->get_webhook_keys_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+| **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] |
+| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
+| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
+| **_next** | **String** | next page | [optional] |
+| **previous** | **String** | previous page | [optional] |
+
+### Return type
+
+[**GetWebhookKeysResponse**](GetWebhookKeysResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## update_webhook_key
+
+> <WebhookKeyResponse> update_webhook_key(id, opts)
+
+Update Webhook Key
+
+updates an existing webhook key
+
+### Examples
+
+```ruby
+require 'time'
+require 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::WebhookKeysApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+opts = {
+  accept_language: 'es', # String | Use for knowing which language to use
+  webhook_key_update_request: DigitalFemsa::WebhookKeyUpdateRequest.new # WebhookKeyUpdateRequest | 
+}
+
+begin
+  # Update Webhook Key
+  result = api_instance.update_webhook_key(id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->update_webhook_key: #{e}"
+end
+```
+
+#### Using the update_webhook_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookKeyResponse>, Integer, Hash)> update_webhook_key_with_http_info(id, opts)
+
+```ruby
+begin
+  # Update Webhook Key
+  data, status_code, headers = api_instance.update_webhook_key_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookKeyResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling WebhookKeysApi->update_webhook_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **accept_language** | **String** | Use for knowing which language to use | [optional][default to &#39;es&#39;] |
+| **webhook_key_update_request** | [**WebhookKeyUpdateRequest**](WebhookKeyUpdateRequest.md) |  | [optional] |
+
+### Return type
+
+[**WebhookKeyResponse**](WebhookKeyResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/WebhookLog.md

@@ -0,0 +1,30 @@
+# DigitalFemsa::WebhookLog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **failed_attempts** | **Integer** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **last_attempted_at** | **Integer** |  | [optional] |
+| **last_http_response_status** | **Integer** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **response_data** | **Hash<String, Object>** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookLog.new(
+  failed_attempts: 10,
+  id: webhl_2svd2sh6GbqzyWBNZ,
+  last_attempted_at: 1669651274,
+  last_http_response_status: 200,
+  object: webhook_log,
+  response_data: {"amount":3000,"payable":true},
+  url: https://username:password@mockoon.stg.femsa.io/payments-api/cash/merchant_approval
+)
+```
+

data/docs/WebhookRequest.md

@@ -0,0 +1,20 @@
+# DigitalFemsa::WebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. |  |
+| **synchronous** | **Boolean** | It is a value that allows to decide if the events will be synchronous or asynchronous. We recommend asynchronous = false | [default to false] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookRequest.new(
+  url: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8,
+  synchronous: false
+)
+```
+

data/docs/WebhookResponse.md

@@ -0,0 +1,36 @@
+# DigitalFemsa::WebhookResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  | [optional] |
+| **development_enabled** | **Boolean** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **livemode** | **Boolean** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **production_enabled** | **Boolean** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **subscribed_events** | **Array<String>** |  | [optional] |
+| **synchronous** | **Boolean** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookResponse.new(
+  deleted: false,
+  development_enabled: false,
+  id: 6307a60c41de27127515a575,
+  livemode: true,
+  object: event,
+  production_enabled: true,
+  status: listening,
+  subscribed_events: ["charge.created","charge.paid","charge.under_fraud_review","charge.fraudulent","charge.refunded","charge.preauthorized","charge.declined","charge.canceled","charge.reversed","charge.pending_confirmation"],
+  synchronous: false,
+  url: https://username:password@mockoon.stg.femsa.io/payments-api/cash/merchant_approval
+)
+```
+

data/docs/WebhookUpdateRequest.md

@@ -0,0 +1,22 @@
+# DigitalFemsa::WebhookUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Here you must place the URL of your Webhook remember that you must program what you will do with the events received. Also do not forget to handle the HTTPS protocol for greater security. |  |
+| **synchronous** | **Boolean** | It is a value that allows to decide if the events will be synchronous or asynchronous. We recommend asynchronous = false | [optional][default to false] |
+| **events** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::WebhookUpdateRequest.new(
+  url: https://webhook.site/89277eaa-a8e4-4306-8dc5-f55c80703dc8,
+  synchronous: false,
+  events: customer.created
+)
+```
+