conekta 2.5.0 → 6.0.0

data/docs/CustomersApi.md

@@ -0,0 +1,553 @@
+# Conekta::CustomersApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer**](CustomersApi.md#create_customer) | **POST** /customers | Create customer |
+| [**create_customer_fiscal_entities**](CustomersApi.md#create_customer_fiscal_entities) | **POST** /customers/{id}/fiscal_entities | Create Fiscal Entity |
+| [**delete_customer_by_id**](CustomersApi.md#delete_customer_by_id) | **DELETE** /customers/{id} | Delete Customer |
+| [**get_customer_by_id**](CustomersApi.md#get_customer_by_id) | **GET** /customers/{id} | Get Customer |
+| [**get_customers**](CustomersApi.md#get_customers) | **GET** /customers | Get a list of customers |
+| [**update_customer**](CustomersApi.md#update_customer) | **PUT** /customers/{id} | Update customer |
+| [**update_customer_fiscal_entities**](CustomersApi.md#update_customer_fiscal_entities) | **PUT** /customers/{id}/fiscal_entities/{fiscal_entities_id} | Update  Fiscal Entity |
+
+
+## create_customer
+
+> <CustomerResponse> create_customer(customer, opts)
+
+Create customer
+
+The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. Remember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer) 
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.new
+customer = Conekta::Customer.new({email: 'miguel@gmail.com', name: 'miguel', phone: '+5215555555555'}) # Customer | requested field for customer
+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
+  # Create customer
+  result = api_instance.create_customer(customer, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->create_customer: #{e}"
+end
+```
+
+#### Using the create_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponse>, Integer, Hash)> create_customer_with_http_info(customer, opts)
+
+```ruby
+begin
+  # Create customer
+  data, status_code, headers = api_instance.create_customer_with_http_info(customer, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer** | [**Customer**](Customer.md) | requested field for customer |  |
+| **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
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## create_customer_fiscal_entities
+
+> <CreateCustomerFiscalEntitiesResponse> create_customer_fiscal_entities(id, customer_fiscal_entities_request, opts)
+
+Create Fiscal Entity
+
+Create Fiscal entity resource that corresponds to a customer ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+customer_fiscal_entities_request = Conekta::CustomerFiscalEntitiesRequest.new({address: Conekta::CustomerFiscalEntitiesRequestAddress.new({street1: 'avenida siempre viva', postal_code: '06100', city: 'Ciudad de Mexico'})}) # CustomerFiscalEntitiesRequest | requested field for customer fiscal entities
+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
+  # Create Fiscal Entity
+  result = api_instance.create_customer_fiscal_entities(id, customer_fiscal_entities_request, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_fiscal_entities: #{e}"
+end
+```
+
+#### Using the create_customer_fiscal_entities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCustomerFiscalEntitiesResponse>, Integer, Hash)> create_customer_fiscal_entities_with_http_info(id, customer_fiscal_entities_request, opts)
+
+```ruby
+begin
+  # Create Fiscal Entity
+  data, status_code, headers = api_instance.create_customer_fiscal_entities_with_http_info(id, customer_fiscal_entities_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCustomerFiscalEntitiesResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_fiscal_entities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **customer_fiscal_entities_request** | [**CustomerFiscalEntitiesRequest**](CustomerFiscalEntitiesRequest.md) | requested field for customer fiscal entities |  |
+| **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
+
+[**CreateCustomerFiscalEntitiesResponse**](CreateCustomerFiscalEntitiesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## delete_customer_by_id
+
+> <CustomerResponse> delete_customer_by_id(id, opts)
+
+Delete Customer
+
+Deleted a customer resource that corresponds to a customer ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.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
+  # Delete Customer
+  result = api_instance.delete_customer_by_id(id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer_by_id: #{e}"
+end
+```
+
+#### Using the delete_customer_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponse>, Integer, Hash)> delete_customer_by_id_with_http_info(id, opts)
+
+```ruby
+begin
+  # Delete Customer
+  data, status_code, headers = api_instance.delete_customer_by_id_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->delete_customer_by_id_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
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## get_customer_by_id
+
+> <CustomerResponse> get_customer_by_id(id, opts)
+
+Get Customer
+
+Gets a customer resource that corresponds to a customer ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.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 Customer
+  result = api_instance.get_customer_by_id(id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_by_id: #{e}"
+end
+```
+
+#### Using the get_customer_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponse>, Integer, Hash)> get_customer_by_id_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Customer
+  data, status_code, headers = api_instance.get_customer_by_id_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->get_customer_by_id_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
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## get_customers
+
+> <CustomersResponse> get_customers(opts)
+
+Get a list of customers
+
+The purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged.
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.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 a list of customers
+  result = api_instance.get_customers(opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->get_customers: #{e}"
+end
+```
+
+#### Using the get_customers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomersResponse>, Integer, Hash)> get_customers_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of customers
+  data, status_code, headers = api_instance.get_customers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomersResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->get_customers_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
+
+[**CustomersResponse**](CustomersResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## update_customer
+
+> <CustomerResponse> update_customer(id, update_customer, opts)
+
+Update customer
+
+You can update customer-related data
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+update_customer = Conekta::UpdateCustomer.new # UpdateCustomer | requested field for customer
+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
+  # Update customer
+  result = api_instance.update_customer(id, update_customer, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->update_customer: #{e}"
+end
+```
+
+#### Using the update_customer_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponse>, Integer, Hash)> update_customer_with_http_info(id, update_customer, opts)
+
+```ruby
+begin
+  # Update customer
+  data, status_code, headers = api_instance.update_customer_with_http_info(id, update_customer, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->update_customer_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **update_customer** | [**UpdateCustomer**](UpdateCustomer.md) | requested field for customer |  |
+| **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
+
+[**CustomerResponse**](CustomerResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## update_customer_fiscal_entities
+
+> <UpdateCustomerFiscalEntitiesResponse> update_customer_fiscal_entities(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts)
+
+Update  Fiscal Entity
+
+Update Fiscal Entity resource that corresponds to a customer ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'conekta'
+# setup authorization
+Conekta.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Conekta::CustomersApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+fiscal_entities_id = 'fis_ent_2tQ8HkkfbauaKP9Ho' # String | identifier
+customer_update_fiscal_entities_request = Conekta::CustomerUpdateFiscalEntitiesRequest.new # CustomerUpdateFiscalEntitiesRequest | requested field for customer update fiscal entities
+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
+  # Update  Fiscal Entity
+  result = api_instance.update_customer_fiscal_entities(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->update_customer_fiscal_entities: #{e}"
+end
+```
+
+#### Using the update_customer_fiscal_entities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateCustomerFiscalEntitiesResponse>, Integer, Hash)> update_customer_fiscal_entities_with_http_info(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts)
+
+```ruby
+begin
+  # Update  Fiscal Entity
+  data, status_code, headers = api_instance.update_customer_fiscal_entities_with_http_info(id, fiscal_entities_id, customer_update_fiscal_entities_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateCustomerFiscalEntitiesResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling CustomersApi->update_customer_fiscal_entities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **fiscal_entities_id** | **String** | identifier |  |
+| **customer_update_fiscal_entities_request** | [**CustomerUpdateFiscalEntitiesRequest**](CustomerUpdateFiscalEntitiesRequest.md) | requested field for customer update fiscal entities |  |
+| **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
+
+[**UpdateCustomerFiscalEntitiesResponse**](UpdateCustomerFiscalEntitiesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/CustomersResponse.md

@@ -0,0 +1,26 @@
+# Conekta::CustomersResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CustomerResponse>**](CustomerResponse.md) |  | [optional] |
+| **has_more** | **Boolean** | Indicates if there are more pages to be requested |  |
+| **object** | **String** | Object type, in this case is list |  |
+| **next_page_url** | **String** | URL of the next page. | [optional] |
+| **previous_page_url** | **String** | Url of the previous page. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomersResponse.new(
+  data: null,
+  has_more: false,
+  object: list,
+  next_page_url: https://api.conekta.io/resources?limit=10&next=chrg_1,
+  previous_page_url: https://api.conekta.io/resources?limit=10&previous=chrg_1
+)
+```
+

data/docs/CustomersResponseAllOf.md

@@ -0,0 +1,18 @@
+# Conekta::CustomersResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CustomerResponse>**](CustomerResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::CustomersResponseAllOf.new(
+  data: null
+)
+```
+

data/docs/DeleteApiKeysResponse.md

@@ -0,0 +1,34 @@
+# Conekta::DeleteApiKeysResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Indicates if the api key is active | [optional] |
+| **created_at** | **Integer** | Unix timestamp in seconds of when the api key was created | [optional] |
+| **description** | **String** | A name or brief explanation of what this api key is used for | [optional] |
+| **livemode** | **Boolean** | Indicates if the api key is in production | [optional] |
+| **prefix** | **String** | The first few characters of the authentication_token | [optional] |
+| **id** | **String** | Unique identifier of the api key | [optional] |
+| **object** | **String** | Object name, value is 'api_key' | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+| **role** | **String** | Indicates if the api key is private or public | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::DeleteApiKeysResponse.new(
+  active: true,
+  created_at: 1684167881,
+  description: online store,
+  livemode: false,
+  prefix: key_rp,
+  id: 64625cc9f3e02c00163f5e4d,
+  object: api_key,
+  deleted: true,
+  role: private
+)
+```
+

data/docs/DeleteApiKeysResponseAllOf.md

@@ -0,0 +1,18 @@
+# Conekta::DeleteApiKeysResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deleted** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::DeleteApiKeysResponseAllOf.new(
+  deleted: true
+)
+```
+

data/docs/DeletedBlacklistRuleResponse.md

@@ -0,0 +1,24 @@
+# Conekta::DeletedBlacklistRuleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Blacklist rule id | [optional] |
+| **field** | **String** | field used for blacklists rule deleted | [optional] |
+| **value** | **String** | value used for blacklists rule deleted | [optional] |
+| **description** | **String** | use an description for blacklisted rule | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::DeletedBlacklistRuleResponse.new(
+  id: 2fw8EWJusiRrxdPzT,
+  field: email,
+  value: email@example.com,
+  description: banned customer example@example.com
+)
+```
+

data/docs/DeletedWhitelistRuleResponse.md

@@ -0,0 +1,24 @@
+# Conekta::DeletedWhitelistRuleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Whitelist rule id | [optional] |
+| **field** | **String** | field used for whitelists rule deleted | [optional] |
+| **value** | **String** | value used for whitelists rule deleted | [optional] |
+| **description** | **String** | use an description for whitelisted rule | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::DeletedWhitelistRuleResponse.new(
+  id: 2fw8EWJusiRrxdPzT,
+  field: email,
+  value: email@example.com,
+  description: secure customer example@example.com
+)
+```
+