voucherify 4.1.0 → 5.0.0

data/docs/OrdersApi.md

@@ -0,0 +1,377 @@
+# VoucherifySdk::OrdersApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_order**](OrdersApi.md#create_order) | **POST** /v1/orders | Create Order |
+| [**create_order_export**](OrdersApi.md#create_order_export) | **POST** /v1/orders/export | Create Orders Export |
+| [**get_order**](OrdersApi.md#get_order) | **GET** /v1/orders/{orderId} | Get Order |
+| [**import_orders**](OrdersApi.md#import_orders) | **POST** /v1/orders/import | Import Orders |
+| [**list_orders**](OrdersApi.md#list_orders) | **GET** /v1/orders | List Orders |
+| [**update_order**](OrdersApi.md#update_order) | **PUT** /v1/orders/{orderId} | Update Order |
+
+
+## create_order
+
+> <OrdersCreateResponseBody> create_order(opts)
+
+Create Order
+
+Creates an order object and triggers an order creation event.  📘 Upsert Mode  If you pass an id or a source_id that already exists in the order database, Voucherify will return a related order object with updated fields.
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+opts = {
+  orders_create_request_body: VoucherifySdk::OrdersCreateRequestBody.new # OrdersCreateRequestBody | Specify the order parameters.
+}
+
+begin
+  # Create Order
+  result = api_instance.create_order(opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->create_order: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **orders_create_request_body** | [**OrdersCreateRequestBody**](OrdersCreateRequestBody.md) | Specify the order parameters. | [optional] |
+
+### Return type
+
+[**OrdersCreateResponseBody**](OrdersCreateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_order_export
+
+> <OrdersExportCreateResponseBody> create_order_export(opts)
+
+Create Orders Export
+
+Creates a downloadable CSV file containing a list of orders. The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the parameters.fields object in the request body. The available filters are all order object attributes. Additionally, any metadata defined in the metadata schema can be exported. Passing an empty JSON will generate a file containing three default fields: id, source_id, and status. The fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:    
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+opts = {
+  orders_export_create_request_body: VoucherifySdk::OrdersExportCreateRequestBody.new # OrdersExportCreateRequestBody | Specify which order parameters you would like to export.
+}
+
+begin
+  # Create Orders Export
+  result = api_instance.create_order_export(opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->create_order_export: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **orders_export_create_request_body** | [**OrdersExportCreateRequestBody**](OrdersExportCreateRequestBody.md) | Specify which order parameters you would like to export. | [optional] |
+
+### Return type
+
+[**OrdersExportCreateResponseBody**](OrdersExportCreateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_order
+
+> <OrdersGetResponseBody> get_order(order_id)
+
+Get Order
+
+Retrieve an order.
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+order_id = 'order_id_example' # String | Unique Voucherify order ID or order source ID.
+
+begin
+  # Get Order
+  result = api_instance.get_order(order_id)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->get_order: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | Unique Voucherify order ID or order source ID. |  |
+
+### Return type
+
+[**OrdersGetResponseBody**](OrdersGetResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## import_orders
+
+> <OrdersImportCreateResponseBody> import_orders(opts)
+
+Import Orders
+
+  🚧 Historical orders  This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the create order and update order endpoints should be used. This is critical because this endpoint does not store events or launch distributions. # Limitations ## Import volume There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one.   ## Maximum count of orders in single import There is a 2000 limit but we might decide to change it to a lower / higher value at any given time depending if we find this value is too high or too low with time. # Notifications There are no notifications on the Dashboard because this import is launched via the API. # Triggered actions    If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segments summary. Consequently, this update will trigger  - **customers entering into segments**  - **distributions** based on any rules tied to customer entering segment(s) - **earning rules** based on the customer entering segment(s) # What is not triggered 1. No webhooks are triggered during the import of orders - for both orders and upserted products / skus.   2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered.     3. No events are created during the import of orders - for both orders and upserted products / skus. In other words you wont see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / skus, then you wont see the Product created events listed, etc.    4. Earning rules based on Order Paid wont be triggered. This API request starts a process that affects Voucherify data in bulk.  In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.  The result will return the async ID. You can verify the status of your request via this API request.
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+opts = {
+  orders_import_create_request_body_item: [VoucherifySdk::OrdersImportCreateRequestBodyItem.new] # Array<OrdersImportCreateRequestBodyItem> | The request body is sent in the form of an array of order objects.
+}
+
+begin
+  # Import Orders
+  result = api_instance.import_orders(opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->import_orders: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **orders_import_create_request_body_item** | [**Array&lt;OrdersImportCreateRequestBodyItem&gt;**](OrdersImportCreateRequestBodyItem.md) | The request body is sent in the form of an array of order objects. | [optional] |
+
+### Return type
+
+[**OrdersImportCreateResponseBody**](OrdersImportCreateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_orders
+
+> <OrdersListResponseBody> list_orders(opts)
+
+List Orders
+
+Returns a list of orders. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+opts = {
+  limit: 56, # Integer | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
+  page: 56, # Integer | Which page of results to return.
+  order: VoucherifySdk::ParameterOrderListOrders::CREATED_AT # ParameterOrderListOrders | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+}
+
+begin
+  # List Orders
+  result = api_instance.list_orders(opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->list_orders: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | A limit on the number of objects to be returned. Limit can range between 1 and 100 items. | [optional] |
+| **page** | **Integer** | Which page of results to return. | [optional] |
+| **order** | [**ParameterOrderListOrders**](.md) | This is a property that controls the sorting direction of the results. Sort the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
+
+### Return type
+
+[**OrdersListResponseBody**](OrdersListResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_order
+
+> <OrdersUpdateResponseBody> update_order(order_id, opts)
+
+Update Order
+
+Updates the specified order by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.
+
+### Examples
+
+```ruby
+require 'time'
+require 'VoucherifySdk'
+# setup authorization
+VoucherifySdk.configure do |config|
+  # Configure API key authorization: X-App-Id
+  config.api_key['X-App-Id'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Id'] = 'Bearer'
+
+  # Configure API key authorization: X-App-Token
+  config.api_key['X-App-Token'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-App-Token'] = 'Bearer'
+end
+
+api_instance = VoucherifySdk::OrdersApi.new
+order_id = 'order_id_example' # String | Unique Voucherify order ID or order source ID.
+opts = {
+  orders_update_request_body: VoucherifySdk::OrdersUpdateRequestBody.new # OrdersUpdateRequestBody | Specify the parameters of the order that are to be updated.
+}
+
+begin
+  # Update Order
+  result = api_instance.update_order(order_id, opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling OrdersApi->update_order: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | Unique Voucherify order ID or order source ID. |  |
+| **orders_update_request_body** | [**OrdersUpdateRequestBody**](OrdersUpdateRequestBody.md) | Specify the parameters of the order that are to be updated. | [optional] |
+
+### Return type
+
+[**OrdersUpdateResponseBody**](OrdersUpdateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OrdersCreateRequestBody.md

@@ -0,0 +1,19 @@
+# VoucherifySdk::OrdersCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.   | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. | [optional] |
+| **customer** | [**Customer**](Customer.md) |  | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer** | [**Referrer**](Referrer.md) |  | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+

data/docs/OrdersCreateResponseBody.md

@@ -0,0 +1,29 @@
+# VoucherifySdk::OrdersCreateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. |  |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created in ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
+| **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
+| **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
+| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
+| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
+| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
+| **items** | [**Array<OrderItemCalculated>**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. |  |
+| **referrer_id** | **String** | Unique referrer ID. |  |
+| **object** | **String** | The type of object represented by JSON. | [default to 'order'] |
+| **redemptions** | [**Hash<String, OrderRedemptions>**](OrderRedemptions.md) |  | [optional] |
+| **customer** | [**OrderCalculatedCustomer**](OrderCalculatedCustomer.md) |  | [optional] |
+| **referrer** | [**OrderCalculatedReferrer**](OrderCalculatedReferrer.md) |  | [optional] |
+

data/docs/OrdersExportCreateRequestBody.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::OrdersExportCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parameters** | [**OrdersExportCreateRequestBodyParameters**](OrdersExportCreateRequestBodyParameters.md) |  | [optional] |
+

data/docs/OrdersExportCreateRequestBodyParameters.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::OrdersExportCreateRequestBodyParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | [**ExportOrderOrder**](ExportOrderOrder.md) |  | [optional] |
+| **fields** | [**Array<ExportOrderFields>**](ExportOrderFields.md) | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] |
+| **filters** | **Object** | Allowed additional properties must start with \"metadata.\" | [optional] |
+

data/docs/OrdersExportCreateResponseBody.md

@@ -0,0 +1,16 @@
+# VoucherifySdk::OrdersExportCreateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique export ID. |  |
+| **object** | **String** | The type of object being represented. This object stores information about the export. | [default to 'export'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. |  |
+| **status** | **String** | Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated. | [default to 'SCHEDULED'] |
+| **channel** | **String** | The channel through which the export was triggered. | [optional] |
+| **result** | **Object** | Contains the URL of the CSV file. |  |
+| **user_id** | **String** | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. |  |
+| **exported_object** | **String** | The type of object to be exported. | [default to 'order'] |
+| **parameters** | [**OrdersExportCreateRequestBodyParameters**](OrdersExportCreateRequestBodyParameters.md) |  | [optional] |
+

data/docs/OrdersGetResponseBody.md

@@ -0,0 +1,29 @@
+# VoucherifySdk::OrdersGetResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. |  |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created in ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
+| **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
+| **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
+| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
+| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
+| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
+| **items** | [**Array<OrderItemCalculated>**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. |  |
+| **referrer_id** | **String** | Unique referrer ID. |  |
+| **object** | **String** | The type of object represented by JSON. | [default to 'order'] |
+| **redemptions** | [**Hash<String, OrderRedemptions>**](OrderRedemptions.md) |  | [optional] |
+| **customer** | [**CustomerId**](CustomerId.md) |  | [optional] |
+| **referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] |
+

data/docs/OrdersImportCreateRequestBodyItem.md

@@ -0,0 +1,18 @@
+# VoucherifySdk::OrdersImportCreateRequestBodyItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.   | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. | [optional] |
+| **customer** | [**Customer**](Customer.md) |  | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer** | [**Referrer**](Referrer.md) |  | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
+

data/docs/OrdersImportCreateResponseBody.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::OrdersImportCreateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+

data/docs/OrdersListResponseBody.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::OrdersListResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The type of object represented by JSON. This object stores information about orders in a dictionary. | [default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of order objects. | [default to 'orders'] |
+| **orders** | [**Array<OrderCalculatedNoCustomerData>**](OrderCalculatedNoCustomerData.md) | Contains array of order objects. |  |
+| **total** | **Integer** | Total number of orders. |  |
+

data/docs/OrdersUpdateRequestBody.md

@@ -0,0 +1,17 @@
+# VoucherifySdk::OrdersUpdateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.   | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. | [optional] |
+| **customer** | [**Customer**](Customer.md) |  | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer** | [**Referrer**](Referrer.md) |  | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+

data/docs/OrdersUpdateResponseBody.md

@@ -0,0 +1,29 @@
+# VoucherifySdk::OrdersUpdateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. |  |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created in ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
+| **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
+| **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
+| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
+| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
+| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
+| **items** | [**Array<OrderItemCalculated>**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. |  |
+| **referrer_id** | **String** | Unique referrer ID. |  |
+| **object** | **String** | The type of object represented by JSON. | [default to 'order'] |
+| **redemptions** | [**Hash<String, OrderRedemptions>**](OrderRedemptions.md) |  | [optional] |
+| **customer** | [**OrderCalculatedCustomer**](OrderCalculatedCustomer.md) |  | [optional] |
+| **referrer** | [**OrderCalculatedReferrer**](OrderCalculatedReferrer.md) |  | [optional] |
+

data/docs/ParameterCampaignType.md

@@ -0,0 +1,7 @@
+# VoucherifySdk::ParameterCampaignType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/ParameterCreatedBeforeAfter.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::ParameterCreatedBeforeAfter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **before** | **Time** | Timestamp representing the date and time before the voucher was created in ISO 8601 format. | [optional] |
+| **after** | **Time** | Timestamp representing the date and time after the voucher was created in ISO 8601 format. | [optional] |
+

data/docs/ParameterExpandListCampaigns.md

@@ -0,0 +1,7 @@
+# VoucherifySdk::ParameterExpandListCampaigns
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/ParameterFiltersListRedemptions.md

@@ -0,0 +1,17 @@
+# VoucherifySdk::ParameterFiltersListRedemptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **voucher_code** | [**ParameterFiltersListRedemptionsVoucherCode**](ParameterFiltersListRedemptionsVoucherCode.md) |  | [optional] |
+| **related_object_id** | [**ParameterFiltersListRedemptionsRelatedObjectId**](ParameterFiltersListRedemptionsRelatedObjectId.md) |  | [optional] |
+| **related_object_parent_id** | [**ParameterFiltersListRedemptionsRelatedObjectParentId**](ParameterFiltersListRedemptionsRelatedObjectParentId.md) |  | [optional] |
+| **parent_redemption_id** | [**ParameterFiltersListRedemptionsParentRedemptionId**](ParameterFiltersListRedemptionsParentRedemptionId.md) |  | [optional] |
+| **failure_code** | [**ParameterFiltersListRedemptionsFailureCode**](ParameterFiltersListRedemptionsFailureCode.md) |  | [optional] |
+| **result** | [**ParameterFiltersListRedemptionsResult**](ParameterFiltersListRedemptionsResult.md) |  | [optional] |
+| **object** | [**ParameterFiltersListRedemptionsObject**](ParameterFiltersListRedemptionsObject.md) |  | [optional] |
+| **customer_id** | [**ParameterFiltersListRedemptionsCustomerId**](ParameterFiltersListRedemptionsCustomerId.md) |  | [optional] |
+| **campaign_name** | [**ParameterFiltersListRedemptionsCampaignName**](ParameterFiltersListRedemptionsCampaignName.md) |  | [optional] |
+| **user_login** | [**ParameterFiltersListRedemptionsUserLogin**](ParameterFiltersListRedemptionsUserLogin.md) |  | [optional] |
+

data/docs/ParameterFiltersListRedemptionsCampaignName.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::ParameterFiltersListRedemptionsCampaignName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**FilterConditionsString**](FilterConditionsString.md) |  | [optional] |
+| **junction** | [**Junction**](Junction.md) |  | [optional] |
+