RubyGems - voucherify - Versions diffs - 5.0.1 → 6.0.0 - Mend

voucherify 5.0.1 → 6.0.0

Files changed (2465) hide show

data/docs/Order.md CHANGED Viewed

@@ -4,16 +4,12 @@
 | 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&#39; amounts.   | [optional] |
-| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [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&#39; 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&#39; amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
 | **items** | [**Array&lt;OrderItem&gt;**](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] |
-| **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] |

data/docs/OrderCalculated.md CHANGED Viewed

@@ -5,9 +5,7 @@
 | 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] |
+| **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&#39; 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&#39; amounts. | [optional] |
@@ -18,12 +16,14 @@
 | **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.   &#x60;sum(items, i &#x3D;&gt; i.applied_discount_amount)&#x60; | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   &#x60;total_applied_discount_amount&#x60; &#x3D; &#x60;applied_discount_amount&#x60; + &#x60;items_applied_discount_amount&#x60; | [optional] |
-| **items** | [**Array&lt;OrderItemCalculated&gt;**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **items** | [**Array&lt;OrderCalculatedItem&gt;**](OrderCalculatedItem.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 &#39;order&#39;] |
-| **redemptions** | [**Hash&lt;String, OrderRedemptions&gt;**](OrderRedemptions.md) |  | [optional] |
-| **customer** | [**OrderCalculatedCustomer**](OrderCalculatedCustomer.md) |  | [optional] |
-| **referrer** | [**OrderCalculatedReferrer**](OrderCalculatedReferrer.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;order&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **customer** | [**CustomerId**](CustomerId.md) |  | [optional] |
+| **referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] |
+| **redemptions** | [**Hash&lt;String, OrderRedemptionsEntry&gt;**](OrderRedemptionsEntry.md) |  | [optional] |

data/docs/OrderCalculatedItem.md ADDED Viewed

@@ -0,0 +1,28 @@
+# VoucherifySdk::OrderCalculatedItem
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the order line item. | [optional] |
+| **sku_id** | **String** | Unique identifier of the SKU. It is assigned by Voucherify. | [optional] |
+| **product_id** | **String** | Unique identifier of the product. It is assigned by Voucherify. | [optional] |
+| **related_object** | **String** | Used along with the source_id property, can be set to either sku or product. | [optional] |
+| **source_id** | **String** | The merchant&#39;s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. | [optional] |
+| **quantity** | **Integer** | The quantity of the particular item in the cart. | [optional] |
+| **discount_quantity** | **Integer** | Number of dicounted items. | [optional] |
+| **initial_quantity** | **Integer** | A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items&#39; quantity. | [optional] |
+| **amount** | **Integer** | The total amount of the order item (price * quantity). | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-item-level discounts applied to the order. | [optional] |
+| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
+| **applied_discount_quantity** | **Integer** | Number of the discounted items applied in the transaction. | [optional] |
+| **applied_quantity** | **Integer** | Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | [optional] |
+| **applied_quantity_amount** | **Integer** | Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced. | [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&#39; amounts. | [optional] |
+| **price** | **Integer** | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example &#x60;10000 cents&#x60; for &#x60;$100.00&#x60;. | [optional] |
+| **subtotal_amount** | **Integer** | Final order item amount after the applied item-level discount.  If there are no item-level discounts applied, this item is equal to the &#x60;amount&#x60;.    &#x60;subtotal_amount&#x60;&#x3D;&#x60;amount&#x60;-&#x60;applied_discount_amount&#x60; | [optional] |
+| **product** | [**OrderCalculatedItemProduct**](OrderCalculatedItemProduct.md) |  | [optional] |
+| **sku** | [**OrderCalculatedItemSku**](OrderCalculatedItemSku.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;order_item&#39;] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. | [optional] |

data/docs/OrderCalculatedItemProduct.md ADDED Viewed

@@ -0,0 +1,13 @@
+# VoucherifySdk::OrderCalculatedItemProduct
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier that represents the product and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | The merchant&#39;s product ID (if it is different than Voucherify&#39;s product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
+| **override** | **Boolean** | The override set to &#x60;true&#x60; is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] |
+| **name** | **String** | Product name. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. | [optional] |
+| **price** | **Float** | Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |

data/docs/OrderCalculatedItemSku.md ADDED Viewed

@@ -0,0 +1,12 @@
+# VoucherifySdk::OrderCalculatedItemSku
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | The merchant&#39;s SKU ID (if it is different than Voucherify&#39;s SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
+| **override** | **Boolean** | The override set to &#x60;true&#x60; is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] |
+| **sku** | **String** | The SKU name. | [optional] |
+| **price** | **Float** | SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |

data/docs/OrderItem.md CHANGED Viewed

@@ -4,18 +4,18 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **sku_id** | **String** | A unique SKU ID assigned by Voucherify. | [optional] |
-| **product_id** | **String** | A unique product ID assigned by Voucherify. | [optional] |
+| **sku_id** | **String** | Unique identifier of the SKU. It is assigned by Voucherify. | [optional] |
+| **product_id** | **String** | Unique identifier of the product. It is assigned by Voucherify. | [optional] |
 | **related_object** | **String** | Used along with the source_id property, can be set to either sku or product. | [optional] |
-| **source_id** | **String** | The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. | [optional] |
+| **source_id** | **String** | The merchant&#39;s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service. | [optional] |
 | **quantity** | **Integer** | The quantity of the particular item in the cart. | [optional] |
 | **discount_quantity** | **Integer** | Number of dicounted items. | [optional] |
 | **initial_quantity** | **Integer** | A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items&#39; quantity. | [optional] |
 | **amount** | **Integer** | The total amount of the order item (price * quantity). | [optional] |
-| **discount_amount** | **Integer** |  Sum of all order-item-level discounts applied to the order. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-item-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&#39; amounts. | [optional] |
 | **price** | **Integer** | Unit price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example &#x60;10000 cents&#x60; for &#x60;$100.00&#x60;. | [optional] |
 | **product** | [**OrderItemProduct**](OrderItemProduct.md) |  | [optional] |
 | **sku** | [**OrderItemSku**](OrderItemSku.md) |  | [optional] |
-| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. | [optional] |

data/docs/OrderItemProduct.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique identifier that represents the product and is assigned by Voucherify. | [optional] |
-| **source_id** | **String** | The merchant’s product ID (if it is different than Voucherify&#39;s product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
+| **source_id** | **String** | The merchant&#39;s product ID (if it is different than Voucherify&#39;s product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
 | **override** | **Boolean** | The override set to &#x60;true&#x60; is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] |
 | **name** | **String** | Product name. | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. | [optional] |

data/docs/OrderItemSku.md CHANGED Viewed

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
-| **source_id** | **String** | The merchant’s SKU ID (if it is different than Voucherify&#39;s SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
+| **source_id** | **String** | The merchant&#39;s SKU ID (if it is different than Voucherify&#39;s SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. | [optional] |
 | **override** | **Boolean** | The override set to &#x60;true&#x60; is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. | [optional] |
 | **sku** | **String** | The SKU name. | [optional] |
 | **price** | **Float** | SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |

data/docs/OrderRedemptionsEntry.md ADDED Viewed

@@ -0,0 +1,15 @@
+# VoucherifySdk::OrderRedemptionsEntry
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Time** | Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format. | [optional] |
+| **rollback_id** | **String** | Unique ID of the redemption rollback. | [optional] |
+| **rollback_date** | **Time** | Timestamp representing the date and tiem when the redemption rollback was created. The value is shown in the ISO 8601 format. | [optional] |
+| **related_object_type** | **String** | The source of the incentive. | [optional][default to &#39;redemption&#39;] |
+| **related_object_id** | **String** | Unique ID of the parent redemption. | [optional] |
+| **related_object_parent_id** | **String** | Represent&#39;s the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier&#39;s parent campaign. | [optional] |
+| **stacked** | **Array&lt;String&gt;** | Contains a list of unique IDs of child redemptions, which belong to the stacked incentives. | [optional] |
+| **rollback_stacked** | **Array&lt;String&gt;** | Lists the rollback redemption IDs of the particular child redemptions. | [optional] |

data/docs/OrdersApi.md CHANGED Viewed

@@ -278,8 +278,8 @@ 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.
+  limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
+  page: 56, # Integer | Which page of results to return. The lowest value is 1.
   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.
 }
@@ -296,8 +296,8 @@ end
 | 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] |
+| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] |
+| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [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

data/docs/OrdersCreateRequestBody.md CHANGED Viewed

@@ -7,13 +7,13 @@
 | **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&#39; amounts.   | [optional] |
-| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [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&#39; 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&#39; amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
 | **items** | [**Array&lt;OrderItem&gt;**](OrderItem.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] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [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 CHANGED Viewed

@@ -5,9 +5,7 @@
 | 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] |
+| **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&#39; 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&#39; amounts. | [optional] |
@@ -18,12 +16,14 @@
 | **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.   &#x60;sum(items, i &#x3D;&gt; i.applied_discount_amount)&#x60; | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   &#x60;total_applied_discount_amount&#x60; &#x3D; &#x60;applied_discount_amount&#x60; + &#x60;items_applied_discount_amount&#x60; | [optional] |
-| **items** | [**Array&lt;OrderItemCalculated&gt;**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **items** | [**Array&lt;OrderCalculatedItem&gt;**](OrderCalculatedItem.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 &#39;order&#39;] |
-| **redemptions** | [**Hash&lt;String, OrderRedemptions&gt;**](OrderRedemptions.md) |  | [optional] |
-| **customer** | [**OrderCalculatedCustomer**](OrderCalculatedCustomer.md) |  | [optional] |
-| **referrer** | [**OrderCalculatedReferrer**](OrderCalculatedReferrer.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;order&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **customer** | [**CustomerId**](CustomerId.md) |  | [optional] |
+| **referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] |
+| **redemptions** | [**Hash&lt;String, OrderRedemptionsEntry&gt;**](OrderRedemptionsEntry.md) |  | [optional] |

data/docs/OrdersExportCreateResponseBody.md CHANGED Viewed

@@ -4,13 +4,13 @@
 | 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 &#39;export&#39;] |
-| **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 &#39;SCHEDULED&#39;] |
+| **id** | **String** | Unique export ID. | [optional] |
+| **object** | **String** | The type of object being represented. This object stores information about the export. | [optional][default to &#39;export&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. | [optional] |
+| **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. | [optional][default to &#39;SCHEDULED&#39;] |
 | **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 &#39;order&#39;] |
-| **parameters** | [**OrdersExportCreateRequestBodyParameters**](OrdersExportCreateRequestBodyParameters.md) |  | [optional] |
+| **result** | **Object** | Contains the URL of the CSV file. | [optional] |
+| **user_id** | **String** | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. | [optional] |
+| **exported_object** | **String** | The type of object to be exported. | [optional][default to &#39;order&#39;] |
+| **parameters** | [**OrdersExportCreateResponseBodyParameters**](OrdersExportCreateResponseBodyParameters.md) |  | [optional] |

data/docs/OrdersExportCreateResponseBodyParameters.md ADDED Viewed

@@ -0,0 +1,10 @@
+# VoucherifySdk::OrdersExportCreateResponseBodyParameters
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order** | [**ExportOrderOrder**](ExportOrderOrder.md) |  | [optional] |
+| **fields** | [**Array&lt;ExportOrderFields&gt;**](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 \&quot;metadata.\&quot; | [optional] |

data/docs/OrdersGetResponseBody.md CHANGED Viewed

@@ -5,9 +5,7 @@
 | 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] |
+| **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&#39; 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&#39; amounts. | [optional] |
@@ -18,12 +16,14 @@
 | **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.   &#x60;sum(items, i &#x3D;&gt; i.applied_discount_amount)&#x60; | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   &#x60;total_applied_discount_amount&#x60; &#x3D; &#x60;applied_discount_amount&#x60; + &#x60;items_applied_discount_amount&#x60; | [optional] |
-| **items** | [**Array&lt;OrderItemCalculated&gt;**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **items** | [**Array&lt;OrderCalculatedItem&gt;**](OrderCalculatedItem.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 &#39;order&#39;] |
-| **redemptions** | [**Hash&lt;String, OrderRedemptions&gt;**](OrderRedemptions.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;order&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
 | **customer** | [**CustomerId**](CustomerId.md) |  | [optional] |
 | **referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] |
+| **redemptions** | [**Hash&lt;String, OrderRedemptionsEntry&gt;**](OrderRedemptionsEntry.md) |  | [optional] |

data/docs/OrdersImportCreateRequestBodyItem.md CHANGED Viewed

@@ -4,15 +4,16 @@
 | 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&#39; amounts.   | [optional] |
-| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [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&#39; 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&#39; amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
 | **items** | [**Array&lt;OrderItem&gt;**](OrderItem.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] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [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 CHANGED Viewed

@@ -4,5 +4,5 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **async_action_id** | **String** | The ID of the scheduled asynchronous action. |  |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |

data/docs/OrdersListResponseBody.md CHANGED Viewed

@@ -4,8 +4,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about orders in a dictionary. | [default to &#39;list&#39;] |
-| **data_ref** | **String** | Identifies the name of the attribute that contains the array of order objects. | [default to &#39;orders&#39;] |
-| **orders** | [**Array&lt;OrderCalculatedNoCustomerData&gt;**](OrderCalculatedNoCustomerData.md) | Contains array of order objects. |  |
-| **total** | **Integer** | Total number of orders. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about orders in a dictionary. | [optional][default to &#39;list&#39;] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of order objects. | [optional][default to &#39;orders&#39;] |
+| **orders** | [**Array&lt;OrderCalculated&gt;**](OrderCalculated.md) | Contains array of order objects. | [optional] |
+| **total** | **Integer** | Total number of orders. | [optional] |

data/docs/OrdersUpdateRequestBody.md CHANGED Viewed

@@ -4,14 +4,15 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **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&#39; amounts.   | [optional] |
-| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [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&#39; 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&#39; amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
 | **items** | [**Array&lt;OrderItem&gt;**](OrderItem.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] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [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 CHANGED Viewed

@@ -5,9 +5,7 @@
 | 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] |
+| **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&#39; 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&#39; amounts. | [optional] |
@@ -18,12 +16,14 @@
 | **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.   &#x60;sum(items, i &#x3D;&gt; i.applied_discount_amount)&#x60; | [optional] |
 | **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   &#x60;total_applied_discount_amount&#x60; &#x3D; &#x60;applied_discount_amount&#x60; + &#x60;items_applied_discount_amount&#x60; | [optional] |
-| **items** | [**Array&lt;OrderItemCalculated&gt;**](OrderItemCalculated.md) | Array of items applied to the order. | [optional] |
+| **items** | [**Array&lt;OrderCalculatedItem&gt;**](OrderCalculatedItem.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 &#39;order&#39;] |
-| **redemptions** | [**Hash&lt;String, OrderRedemptions&gt;**](OrderRedemptions.md) |  | [optional] |
-| **customer** | [**OrderCalculatedCustomer**](OrderCalculatedCustomer.md) |  | [optional] |
-| **referrer** | [**OrderCalculatedReferrer**](OrderCalculatedReferrer.md) |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to &#39;order&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **customer** | [**CustomerId**](CustomerId.md) |  | [optional] |
+| **referrer** | [**ReferrerId**](ReferrerId.md) |  | [optional] |
+| **redemptions** | [**Hash&lt;String, OrderRedemptionsEntry&gt;**](OrderRedemptionsEntry.md) |  | [optional] |

data/docs/ParameterActivityCategory.md ADDED Viewed

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

data/docs/ParameterCreatedBeforeAfter.md CHANGED Viewed

@@ -4,6 +4,6 @@
 | 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] |
+| **before** | **Time** | Timestamp representing the date and time before the voucher was created. The value is shown in the ISO 8601 format. | [optional] |
+| **after** | **Time** | Timestamp representing the date and time after the voucher was created. The value is shown in the ISO 8601 format. | [optional] |

data/docs/ParameterFiltersListCustomerRedeemables.md ADDED Viewed

@@ -0,0 +1,15 @@
+# VoucherifySdk::ParameterFiltersListCustomerRedeemables
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**ParameterFiltersListCustomerRedeemablesId**](ParameterFiltersListCustomerRedeemablesId.md) |  | [optional] |
+| **created_at** | [**ParameterFiltersListCustomerRedeemablesCreatedAt**](ParameterFiltersListCustomerRedeemablesCreatedAt.md) |  | [optional] |
+| **redeemable_id** | [**ParameterFiltersListCustomerRedeemablesRedeemableId**](ParameterFiltersListCustomerRedeemablesRedeemableId.md) |  | [optional] |
+| **redeemable_object** | [**ParameterFiltersListCustomerRedeemablesRedeemableObject**](ParameterFiltersListCustomerRedeemablesRedeemableObject.md) |  | [optional] |
+| **holder_role** | [**ParameterFiltersListCustomerRedeemablesHolderRole**](ParameterFiltersListCustomerRedeemablesHolderRole.md) |  | [optional] |
+| **campaign_id** | [**ParameterFiltersListCustomerRedeemablesCampaignId**](ParameterFiltersListCustomerRedeemablesCampaignId.md) |  | [optional] |
+| **campaign_type** | [**ParameterFiltersListCustomerRedeemablesCampaignType**](ParameterFiltersListCustomerRedeemablesCampaignType.md) |  | [optional] |
+| **voucher_type** | [**ParameterFiltersListCustomerRedeemablesVoucherType**](ParameterFiltersListCustomerRedeemablesVoucherType.md) |  | [optional] |

data/docs/ParameterFiltersListCustomerRedeemablesCampaignId.md ADDED Viewed

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

data/docs/ParameterFiltersListCustomerRedeemablesCampaignType.md ADDED Viewed

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

data/docs/ParameterFiltersListCustomerRedeemablesCampaignTypeConditions.md ADDED Viewed

@@ -0,0 +1,15 @@
+# VoucherifySdk::ParameterFiltersListCustomerRedeemablesCampaignTypeConditions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_in** | **Array&lt;String&gt;** | Array of resource values that should be included in the results (multiple values). | [optional] |
+| **not_in** | **Array&lt;String&gt;** | Array of resource values that should be included in the results (multiple values). | [optional] |
+| **is** | **String** | Value is exactly this value (single value). | [optional] |
+| **is_not** | **String** | Results omit this value (single value). | [optional] |
+| **has_value** | **String** | Value is NOT null. The value for this parameter is an empty string. | [optional] |
+| **is_unknown** | **String** | Value is null. The value for this parameter is an empty string. | [optional] |
+| **starts_with** | **String** | Value starts with the specified string. | [optional] |
+| **ends_with** | **String** | Value ends with the specified string. | [optional] |

data/docs/ParameterFiltersListCustomerRedeemablesCreatedAt.md ADDED Viewed

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

data/docs/ParameterFiltersListCustomerRedeemablesCreatedAtConditions.md ADDED Viewed

@@ -0,0 +1,13 @@
+# VoucherifySdk::ParameterFiltersListCustomerRedeemablesCreatedAtConditions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **after** | **Time** | Value is after this date. The value for this parameter is shown in the ISO 8601 format. | [optional] |
+| **before** | **Time** | Value is before this date. The value for this parameter is shown in the ISO 8601 format. | [optional] |
+| **has_value** | **String** | Value is NOT null. The value for this parameter is an empty string. | [optional] |
+| **is_unknown** | **String** | Value is null. The value for this parameter is an empty string. | [optional] |
+| **more_than** | **Integer** | Value is more days ago before the current date and time, e.g. more than &#x60;10&#x60; days ago. | [optional] |
+| **less_than** | **Integer** | Value is less days before the current date and time, e.g. less than &#x60;10&#x60; days ago. | [optional] |

data/docs/ParameterFiltersListCustomerRedeemablesHolderRole.md ADDED Viewed

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

data/docs/ParameterFiltersListCustomerRedeemablesHolderRoleConditions.md ADDED Viewed

@@ -0,0 +1,15 @@
+# VoucherifySdk::ParameterFiltersListCustomerRedeemablesHolderRoleConditions
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_in** | **Array&lt;String&gt;** | Array of resource values that should be included in the results (multiple values). | [optional] |
+| **not_in** | **Array&lt;String&gt;** | Array of resource values that should be included in the results (multiple values). | [optional] |
+| **is** | **String** | Value is exactly this value (single value). | [optional] |
+| **is_not** | **String** | Results omit this value (single value). | [optional] |
+| **has_value** | **String** | Value is NOT null. The value for this parameter is an empty string. | [optional] |
+| **is_unknown** | **String** | Value is null. The value for this parameter is an empty string. | [optional] |
+| **starts_with** | **String** | Value starts with the specified string. | [optional] |
+| **ends_with** | **String** | Value ends with the specified string. | [optional] |

data/docs/ParameterFiltersListCustomerRedeemablesId.md ADDED Viewed

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

data/docs/ParameterFiltersListCustomerRedeemablesRedeemableId.md ADDED Viewed

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