digital_femsa 1.0.0

data/docs/ShippingContactsApi.md

@@ -0,0 +1,243 @@
+# DigitalFemsa::ShippingContactsApi
+
+All URIs are relative to *https://api.digitalfemsa.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 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::ShippingContactsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+customer_shipping_contacts = DigitalFemsa::CustomerShippingContacts.new({address: DigitalFemsa::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 DigitalFemsa::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 DigitalFemsa::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.app-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 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::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 DigitalFemsa::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 DigitalFemsa::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.app-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 'digital_femsa'
+# setup authorization
+DigitalFemsa.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = DigitalFemsa::ShippingContactsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_contacts_id = '6307a60c41de27127515a575' # String | identifier
+customer_update_shipping_contacts = DigitalFemsa::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 DigitalFemsa::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 DigitalFemsa::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.app-v2.1.0+json
+

data/docs/ShippingOrderResponse.md

@@ -0,0 +1,32 @@
+# DigitalFemsa::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 'digital_femsa'
+
+instance = DigitalFemsa::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 @@
+# DigitalFemsa::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 'digital_femsa'
+
+instance = DigitalFemsa::ShippingRequest.new(
+  amount: 100,
+  carrier: FEDEX,
+  tracking_number: TRACK123,
+  method: Same day,
+  metadata: {"key":"value"}
+)
+```
+

data/docs/ShippingsApi.md

@@ -0,0 +1,243 @@
+# DigitalFemsa::ShippingsApi
+
+All URIs are relative to *https://api.digitalfemsa.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**orders_create_shipping**](ShippingsApi.md#orders_create_shipping) | **POST** /orders/{id}/shipping_lines | Create Shipping |
+| [**orders_delete_shipping**](ShippingsApi.md#orders_delete_shipping) | **DELETE** /orders/{id}/shipping_lines/{shipping_id} | Delete Shipping |
+| [**orders_update_shipping**](ShippingsApi.md#orders_update_shipping) | **PUT** /orders/{id}/shipping_lines/{shipping_id} | Update Shipping |
+
+
+## orders_create_shipping
+
+> <ShippingOrderResponse> orders_create_shipping(id, shipping_request, opts)
+
+Create Shipping
+
+Create new shipping for an existing orden
+
+### 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::ShippingsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | requested field for a shipping
+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 Shipping
+  result = api_instance.orders_create_shipping(id, shipping_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_create_shipping: #{e}"
+end
+```
+
+#### Using the orders_create_shipping_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ShippingOrderResponse>, Integer, Hash)> orders_create_shipping_with_http_info(id, shipping_request, opts)
+
+```ruby
+begin
+  # Create Shipping
+  data, status_code, headers = api_instance.orders_create_shipping_with_http_info(id, shipping_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ShippingOrderResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_create_shipping_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | requested field for a shipping |  |
+| **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
+
+[**ShippingOrderResponse**](ShippingOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## orders_delete_shipping
+
+> <ShippingOrderResponse> orders_delete_shipping(id, shipping_id, opts)
+
+Delete Shipping
+
+Delete shipping
+
+### 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::ShippingsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_id = 'ship_lin_2tQ974hSHcsdeSZHG' # 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
+  result = api_instance.orders_delete_shipping(id, shipping_id, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_delete_shipping: #{e}"
+end
+```
+
+#### Using the orders_delete_shipping_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ShippingOrderResponse>, Integer, Hash)> orders_delete_shipping_with_http_info(id, shipping_id, opts)
+
+```ruby
+begin
+  # Delete Shipping
+  data, status_code, headers = api_instance.orders_delete_shipping_with_http_info(id, shipping_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ShippingOrderResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_delete_shipping_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **shipping_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
+
+[**ShippingOrderResponse**](ShippingOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.app-v2.1.0+json
+
+
+## orders_update_shipping
+
+> <ShippingOrderResponse> orders_update_shipping(id, shipping_id, shipping_request, opts)
+
+Update Shipping
+
+Update existing shipping for an existing orden
+
+### 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::ShippingsApi.new
+id = '6307a60c41de27127515a575' # String | Identifier of the resource
+shipping_id = 'ship_lin_2tQ974hSHcsdeSZHG' # String | identifier
+shipping_request = DigitalFemsa::ShippingRequest.new({amount: 100}) # ShippingRequest | requested field for a shipping
+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
+  result = api_instance.orders_update_shipping(id, shipping_id, shipping_request, opts)
+  p result
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_update_shipping: #{e}"
+end
+```
+
+#### Using the orders_update_shipping_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ShippingOrderResponse>, Integer, Hash)> orders_update_shipping_with_http_info(id, shipping_id, shipping_request, opts)
+
+```ruby
+begin
+  # Update Shipping
+  data, status_code, headers = api_instance.orders_update_shipping_with_http_info(id, shipping_id, shipping_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ShippingOrderResponse>
+rescue DigitalFemsa::ApiError => e
+  puts "Error when calling ShippingsApi->orders_update_shipping_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifier of the resource |  |
+| **shipping_id** | **String** | identifier |  |
+| **shipping_request** | [**ShippingRequest**](ShippingRequest.md) | requested field for a shipping |  |
+| **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
+
+[**ShippingOrderResponse**](ShippingOrderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.app-v2.1.0+json
+

data/docs/SmsCheckoutRequest.md

@@ -0,0 +1,18 @@
+# DigitalFemsa::SmsCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phonenumber** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'digital_femsa'
+
+instance = DigitalFemsa::SmsCheckoutRequest.new(
+  phonenumber: 5566982090
+)
+```
+