conekta 2.6.0 → 6.0.0

data/docs/ProductsApi.md

@@ -0,0 +1,243 @@
+# Conekta::ProductsApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**orders_create_product**](ProductsApi.md#orders_create_product) | **POST** /orders/{id}/line_items | Create Product |
+| [**orders_delete_product**](ProductsApi.md#orders_delete_product) | **DELETE** /orders/{id}/line_items/{line_item_id} | Delete Product |
+| [**orders_update_product**](ProductsApi.md#orders_update_product) | **PUT** /orders/{id}/line_items/{line_item_id} | Update Product |
+
+
+## orders_create_product
+
+> <ProductOrderResponse> orders_create_product(id, product, opts)
+
+Create Product
+
+Create a new product for an existing order.
+
+### 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::ProductsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+product = Conekta::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000}) # Product | requested field for a product
+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 Product
+  result = api_instance.orders_create_product(id, product, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_create_product: #{e}"
+end
+```
+
+#### Using the orders_create_product_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProductOrderResponse>, Integer, Hash)> orders_create_product_with_http_info(id, product, opts)
+
+```ruby
+begin
+  # Create Product
+  data, status_code, headers = api_instance.orders_create_product_with_http_info(id, product, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductOrderResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_create_product_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **product** | [**Product**](Product.md) | requested field for a product |  |
+| **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
+
+[**ProductOrderResponse**](ProductOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## orders_delete_product
+
+> <ProductOrderResponse> orders_delete_product(id, line_item_id, opts)
+
+Delete Product
+
+Delete product for an existing orden
+
+### 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::ProductsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
+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 Product
+  result = api_instance.orders_delete_product(id, line_item_id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_delete_product: #{e}"
+end
+```
+
+#### Using the orders_delete_product_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProductOrderResponse>, Integer, Hash)> orders_delete_product_with_http_info(id, line_item_id, opts)
+
+```ruby
+begin
+  # Delete Product
+  data, status_code, headers = api_instance.orders_delete_product_with_http_info(id, line_item_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductOrderResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_delete_product_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **line_item_id** | **String** | identifier |  |
+| **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
+
+[**ProductOrderResponse**](ProductOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## orders_update_product
+
+> <ProductOrderResponse> orders_update_product(id, line_item_id, update_product, opts)
+
+Update Product
+
+Update an existing product for an existing orden
+
+### 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::ProductsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+line_item_id = 'line_item_2tQ8HkkfbauaKP9Ho' # String | identifier
+update_product = Conekta::UpdateProduct.new # UpdateProduct | requested field for products
+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 Product
+  result = api_instance.orders_update_product(id, line_item_id, update_product, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_update_product: #{e}"
+end
+```
+
+#### Using the orders_update_product_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProductOrderResponse>, Integer, Hash)> orders_update_product_with_http_info(id, line_item_id, update_product, opts)
+
+```ruby
+begin
+  # Update Product
+  data, status_code, headers = api_instance.orders_update_product_with_http_info(id, line_item_id, update_product, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductOrderResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ProductsApi->orders_update_product_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **line_item_id** | **String** | identifier |  |
+| **update_product** | [**UpdateProduct**](UpdateProduct.md) | requested field for products |  |
+| **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
+
+[**ProductOrderResponse**](ProductOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/RiskRules.md

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

data/docs/RiskRulesData.md

@@ -0,0 +1,30 @@
+# Conekta::RiskRulesData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | rule id | [optional] |
+| **field** | **String** | field to be used for the rule | [optional] |
+| **created_at** | **String** | rule creation date | [optional] |
+| **value** | **String** | value to be used for the rule | [optional] |
+| **is_global** | **Boolean** | if the rule is global | [optional] |
+| **is_test** | **Boolean** | if the rule is test | [optional] |
+| **description** | **String** | description of the rule | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::RiskRulesData.new(
+  id: 618c3f2fdb8b8da9be376af9,
+  field: email,
+  created_at: 2021-11-10T21:52:47.339Z,
+  value: email@example.com,
+  is_global: false,
+  is_test: false,
+  description: secure customer example@example.com
+)
+```
+

data/docs/RiskRulesList.md

@@ -0,0 +1,26 @@
+# Conekta::RiskRulesList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **data** | [**Array<RiskRulesData>**](RiskRulesData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::RiskRulesList.new(
+  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: null
+)
+```
+

data/docs/ShippingContactsApi.md

@@ -0,0 +1,243 @@
+# Conekta::ShippingContactsApi
+
+All URIs are relative to *https://api.conekta.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer_shipping_contacts**](ShippingContactsApi.md#create_customer_shipping_contacts) | **POST** /customers/{id}/shipping_contacts | Create a shipping contacts |
+| [**delete_customer_shipping_contacts**](ShippingContactsApi.md#delete_customer_shipping_contacts) | **DELETE** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Delete shipping contacts |
+| [**update_customer_shipping_contacts**](ShippingContactsApi.md#update_customer_shipping_contacts) | **PUT** /customers/{id}/shipping_contacts/{shipping_contacts_id} | Update shipping contacts |
+
+
+## create_customer_shipping_contacts
+
+> <CustomerShippingContactsResponse> create_customer_shipping_contacts(id, customer_shipping_contacts, opts)
+
+Create a shipping contacts
+
+Create a shipping contacts for a customer.
+
+### 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::ShippingContactsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+customer_shipping_contacts = Conekta::CustomerShippingContacts.new({address: Conekta::CustomerShippingContactsAddress.new}) # CustomerShippingContacts | requested field for customer shippings contacts
+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 a shipping contacts
+  result = api_instance.create_customer_shipping_contacts(id, customer_shipping_contacts, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->create_customer_shipping_contacts: #{e}"
+end
+```
+
+#### Using the create_customer_shipping_contacts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerShippingContactsResponse>, Integer, Hash)> create_customer_shipping_contacts_with_http_info(id, customer_shipping_contacts, opts)
+
+```ruby
+begin
+  # Create a shipping contacts
+  data, status_code, headers = api_instance.create_customer_shipping_contacts_with_http_info(id, customer_shipping_contacts, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerShippingContactsResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->create_customer_shipping_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **customer_shipping_contacts** | [**CustomerShippingContacts**](CustomerShippingContacts.md) | requested field for customer shippings contacts |  |
+| **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
+
+[**CustomerShippingContactsResponse**](CustomerShippingContactsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## delete_customer_shipping_contacts
+
+> <CustomerShippingContactsResponse> delete_customer_shipping_contacts(id, shipping_contacts_id, opts)
+
+Delete shipping contacts
+
+Delete shipping contact 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::ShippingContactsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_contacts_id = '6307a60c41de27127515a575' # String | identifier
+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 shipping contacts
+  result = api_instance.delete_customer_shipping_contacts(id, shipping_contacts_id, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->delete_customer_shipping_contacts: #{e}"
+end
+```
+
+#### Using the delete_customer_shipping_contacts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerShippingContactsResponse>, Integer, Hash)> delete_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, opts)
+
+```ruby
+begin
+  # Delete shipping contacts
+  data, status_code, headers = api_instance.delete_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerShippingContactsResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->delete_customer_shipping_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **shipping_contacts_id** | **String** | identifier |  |
+| **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
+
+[**CustomerShippingContactsResponse**](CustomerShippingContactsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.conekta-v2.1.0+json
+
+
+## update_customer_shipping_contacts
+
+> <CustomerShippingContactsResponse> update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, opts)
+
+Update shipping contacts
+
+Update shipping contact 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::ShippingContactsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_contacts_id = '6307a60c41de27127515a575' # String | identifier
+customer_update_shipping_contacts = Conekta::CustomerUpdateShippingContacts.new # CustomerUpdateShippingContacts | requested field for customer update shippings contacts
+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 shipping contacts
+  result = api_instance.update_customer_shipping_contacts(id, shipping_contacts_id, customer_update_shipping_contacts, opts)
+  p result
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->update_customer_shipping_contacts: #{e}"
+end
+```
+
+#### Using the update_customer_shipping_contacts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerShippingContactsResponse>, Integer, Hash)> update_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, customer_update_shipping_contacts, opts)
+
+```ruby
+begin
+  # Update shipping contacts
+  data, status_code, headers = api_instance.update_customer_shipping_contacts_with_http_info(id, shipping_contacts_id, customer_update_shipping_contacts, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerShippingContactsResponse>
+rescue Conekta::ApiError => e
+  puts "Error when calling ShippingContactsApi->update_customer_shipping_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **shipping_contacts_id** | **String** | identifier |  |
+| **customer_update_shipping_contacts** | [**CustomerUpdateShippingContacts**](CustomerUpdateShippingContacts.md) | requested field for customer update shippings contacts |  |
+| **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
+
+[**CustomerShippingContactsResponse**](CustomerShippingContactsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.conekta-v2.1.0+json
+

data/docs/ShippingOrderResponse.md

@@ -0,0 +1,32 @@
+# Conekta::ShippingOrderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Shipping amount in cents |  |
+| **carrier** | **String** | Carrier name for the shipment | [optional] |
+| **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] |
+| **method** | **String** | Method of shipment | [optional] |
+| **metadata** | **Hash<String, Object>** | Hash where the user can send additional information for each 'shipping'. | [optional] |
+| **id** | **String** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **parent_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::ShippingOrderResponse.new(
+  amount: 100,
+  carrier: FEDEX,
+  tracking_number: TRACK123,
+  method: Same day,
+  metadata: {key=value},
+  id: null,
+  object: null,
+  parent_id: null
+)
+```
+

data/docs/ShippingRequest.md

@@ -0,0 +1,26 @@
+# Conekta::ShippingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Shipping amount in cents |  |
+| **carrier** | **String** | Carrier name for the shipment | [optional] |
+| **tracking_number** | **String** | Tracking number can be used to track the shipment | [optional] |
+| **method** | **String** | Method of shipment | [optional] |
+| **metadata** | **Hash<String, Object>** | Hash where the user can send additional information for each 'shipping'. | [optional] |
+
+## Example
+
+```ruby
+require 'conekta'
+
+instance = Conekta::ShippingRequest.new(
+  amount: 100,
+  carrier: FEDEX,
+  tracking_number: TRACK123,
+  method: Same day,
+  metadata: {key=value}
+)
+```
+