voucherify 5.0.1 → 6.0.0

data/docs/RewardsUpdateRequestBodyAttributes.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsUpdateRequestBodyAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | **String** | HTTPS URL pointing to a .png or .jpg file. | [optional] |
+| **description** | **String** | Description of a material reward. | [optional] |
+

data/docs/RewardsUpdateRequestBodyParameters.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RewardsUpdateRequestBodyParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign** | [**RewardsUpdateRequestBodyParametersCampaign**](RewardsUpdateRequestBodyParametersCampaign.md) |  | [optional] |
+| **product** | [**RewardsUpdateRequestBodyParametersProduct**](RewardsUpdateRequestBodyParametersProduct.md) |  | [optional] |
+| **coin** | [**RewardsUpdateRequestBodyParametersCoin**](RewardsUpdateRequestBodyParametersCoin.md) |  | [optional] |
+

data/docs/RewardsUpdateRequestBodyParametersCampaign.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsUpdateRequestBodyParametersCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **balance** | **Integer** | The incremental points to be added to the current balance on the loyalty card. and The incremental amount to be added to the current balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+

data/docs/RewardsUpdateRequestBodyParametersCoin.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsUpdateRequestBodyParametersCoin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exchange_ratio** | **String** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
+| **points_ratio** | **String** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] |
+

data/docs/RewardsUpdateRequestBodyParametersProduct.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsUpdateRequestBodyParametersProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique product ID, assigned by Voucherify, given as a reward. | [optional] |
+| **sku_id** | **String** | Unique SKU ID, assigned by Voucherify, of the SKU given as a reward. | [optional] |
+

data/docs/RewardsUpdateResponseBody.md

@@ -0,0 +1,18 @@
+# VoucherifySdk::RewardsUpdateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique reward ID, assigned by Voucherify. | [optional] |
+| **name** | **String** | Reward name. | [optional] |
+| **stock** | **Integer** | Configurable for **material rewards**. The number of units of the product that you want to share as reward. | [optional] |
+| **redeemed** | **Integer** | Defines the number of already invoked (successful) reward redemptions.  | [optional] |
+| **attributes** | [**RewardsUpdateResponseBodyAttributes**](RewardsUpdateResponseBodyAttributes.md) |  | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format. | [optional] |
+| **type** | **String** | Reward type. | [optional] |
+| **parameters** | [**RewardType**](RewardType.md) |  | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by the JSON. This object stores information about the reward. | [default to 'reward'] |
+

data/docs/RewardsUpdateResponseBodyAttributes.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsUpdateResponseBodyAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file. | [optional] |
+| **description** | **String** | An arbitrary string that you can attach to a material reward. | [optional] |
+

data/docs/SegmentsApi.md

@@ -4,7 +4,69 @@ All URIs are relative to *https://api.voucherify.io*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_segment**](SegmentsApi.md#create_segment) | **POST** /v1/segments | Create Segment |
 | [**delete_segment**](SegmentsApi.md#delete_segment) | **DELETE** /v1/segments/{segmentId} | Delete Segment |
+| [**get_segment**](SegmentsApi.md#get_segment) | **GET** /v1/segments/{segmentId} | Get Segment |
+
+
+## create_segment
+
+> <SegmentsCreateResponseBody> create_segment(opts)
+
+Create Segment
+
+Create a customer segment.  🚧 Limit on Static Segments  There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.
+
+### 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::SegmentsApi.new
+opts = {
+  segments_create_request_body: VoucherifySdk::SegmentsCreateRequestBody.new # SegmentsCreateRequestBody | Specify the boundary conditions for the customer segment.
+}
+
+begin
+  # Create Segment
+  result = api_instance.create_segment(opts)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling SegmentsApi->create_segment: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **segments_create_request_body** | [**SegmentsCreateRequestBody**](SegmentsCreateRequestBody.md) | Specify the boundary conditions for the customer segment. | [optional] |
+
+### Return type
+
+[**SegmentsCreateResponseBody**](SegmentsCreateResponseBody.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
 
 
 ## delete_segment
@@ -63,3 +125,61 @@ nil (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: Not defined
 
+
+## get_segment
+
+> <SegmentsGetResponseBody> get_segment(segment_id)
+
+Get Segment
+
+Retrieves the segment with given segment ID.
+
+### 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::SegmentsApi.new
+segment_id = 'segment_id_example' # String | A unique customer segment ID.
+
+begin
+  # Get Segment
+  result = api_instance.get_segment(segment_id)
+  p result
+rescue VoucherifySdk::ApiError => e
+  puts "Error when calling SegmentsApi->get_segment: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **segment_id** | **String** | A unique customer segment ID. |  |
+
+### Return type
+
+[**SegmentsGetResponseBody**](SegmentsGetResponseBody.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
+

data/docs/SegmentsCreateRequestBody.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::SegmentsCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Segment name. | [optional] |
+| **type** | **String** |  | [optional] |
+| **customers** | **Array<String>** | Array of customer IDs. | [optional] |
+| **filter** | **Object** | Defines a set of criteria for an `auto-update` segment type. | [optional] |
+

data/docs/SegmentsCreateResponseBody.md

@@ -0,0 +1,14 @@
+# VoucherifySdk::SegmentsCreateResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique segment ID. | [optional] |
+| **name** | **String** | Segment name. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] |
+| **type** | **String** | Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers). | [optional] |
+| **filter** | **Object** | Defines a set of criteria for an `auto-update` segment type.   | [optional] |
+| **initial_sync_status** | **String** |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional][default to 'segment'] |
+

data/docs/SegmentsGetResponseBody.md

@@ -0,0 +1,14 @@
+# VoucherifySdk::SegmentsGetResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique segment ID. | [optional] |
+| **name** | **String** | Segment name. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format. | [optional] |
+| **type** | **String** | Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers). | [optional] |
+| **filter** | **Object** | Defines a set of criteria for an `auto-update` segment type.   | [optional] |
+| **initial_sync_status** | **String** |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the customer segment. | [optional][default to 'segment'] |
+

data/docs/Session.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **key** | **String** | The session unique ID assigned by Voucherify or your own unique session ID. Sending an existing ID will result in overwriting an existing session. If no session key is provided, then a new ID will be generated. | [optional][default to 'LOCK'] |
-| **type** | **String** | This parameter is required to establish a new session. The session locks the redemption quantity by 1. | [optional][default to 'LOCK'] |
+| **key** | **String** | The session unique ID assigned by Voucherify or your own unique session ID. Sending an existing ID will result in overwriting an existing session. If no session key is provided, then a new ID will be generated. | [optional] |
+| **type** | **String** | This parameter is required to establish a new session. | [optional][default to 'LOCK'] |
 | **ttl** | **Float** | Value for the period of time that the session is active. Units for this parameter are defined by the session.ttl_unit parameter. | [optional] |
 | **ttl_unit** | **String** | Defines the type of unit in which the session time is counted. | [optional] |
 

data/docs/SimpleCustomer.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of an existing customer that will be linked to redemption in this request. | [optional] |
-| **source_id** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] |
+| **id** | **String** | Unique identifier of an existing customer. It is assigned by Voucherify. | [optional] |
 | **name** | **String** | Customer's first and last name. | [optional] |
 | **email** | **String** | Customer's email address. | [optional] |
-| **metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] |
-| **object** | **String** | The type of object represented by JSON. | [optional][default to 'customer'] |
+| **source_id** | **String** | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'customer'] |
 

data/docs/SimpleCustomerRequiredObjectType.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique ID of a customer that is assigned by Voucherify. | [optional] |
-| **source_id** | **String** | The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service. | [optional] |
+| **source_id** | **String** | The merchant's customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service. | [optional] |
 | **name** | **String** | Customer's first and last name. | [optional] |
 | **email** | **String** | Customer's email address. | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.  | [optional] |
-| **object** | **String** | The type of object represented by the JSON. This object stores information about the customer. | [default to 'customer'] |
+| **object** | **String** | The type of the object represented by the JSON. This object stores information about the customer. | [optional][default to 'customer'] |
 

data/docs/SimpleLoyaltyCard.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::SimpleLoyaltyCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
+| **balance** | **Integer** | Points available for reward redemption. | [optional] |
+| **next_expiration_date** | **String** | The next closest date when the next set of points are due to expire. | [optional] |
+| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
+

data/docs/SimpleProductDiscountUnit.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique product ID, assigned by Voucherify. |  |
+| **id** | **String** | Unique product ID, assigned by Voucherify. | [optional] |
 | **source_id** | **String** | Product's source ID. | [optional] |
-| **name** | **String** | Product name. |  |
+| **name** | **String** | Product name. | [optional] |
 

data/docs/SimpleSegment.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique segment ID. |  |
-| **name** | **String** | Segment name. |  |
-| **object** | **String** | The type of object represented by the ID. | [default to 'segment'] |
+| **id** | **String** | Unique segment ID. | [optional] |
+| **name** | **String** | Segment name. | [optional] |
+| **object** | **String** | The type of the object represented by the ID. | [optional][default to 'segment'] |
 

data/docs/SimpleSkuDiscountUnit.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique SKU ID, assigned by Voucherify. |  |
+| **id** | **String** | Unique SKU ID, assigned by Voucherify. | [optional] |
 | **source_id** | **String** | Product variant's source ID. | [optional] |
-| **name** | **String** | Sku name |  |
+| **name** | **String** | Sku name | [optional] |
 

data/docs/SimpleVoucher.md

@@ -5,16 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | A unique identifier that represents the voucher assigned by Voucherify. | [optional] |
-| **code** | **String** | Voucher code. |  |
+| **code** | **String** | Voucher code. | [optional] |
 | **gift** | [**Gift**](Gift.md) |  | [optional] |
 | **discount** | [**Discount**](Discount.md) |  | [optional] |
-| **loyalty_card** | **Object** | Defines the loyalty card details. | [optional] |
-| **type** | **String** | Type of the object. | [optional][default to 'voucher'] |
-| **campaign** | **Object** | Campaign object | [optional] |
+| **loyalty_card** | [**SimpleLoyaltyCard**](SimpleLoyaltyCard.md) |  | [optional] |
+| **type** | **String** | Type of the voucher. | [optional] |
+| **campaign** | **String** | Campaign name. | [optional] |
 | **campaign_id** | **String** | Campaign unique ID. | [optional] |
 | **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
-| **holder_id** | **String** | Unique customer ID of campaign owner. | [optional] |
-| **referrer_id** | **String** | Unique referrer ID. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the order was created in ISO 8601 format. | [optional] |
-| **object** | **String** | The type of object represented by JSON. | [optional][default to 'voucher'] |
+| **holder_id** | **String** | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] |
+| **referrer_id** | **String** | Unique identifier of the referrer assigned by Voucherify. | [optional] |
+| **category_id** | **String** | Unique identifier of the category that this voucher belongs to. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
+| **active** | **Boolean** | Shows whether the voucher is on or off. `true` indicates an *active* voucher and `false` indicates an *inactive* voucher. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **redemption** | [**SimpleVoucherRedemption**](SimpleVoucherRedemption.md) |  | [optional] |
+| **start_date** | **Time** | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date. | [optional] |
+| **expiration_date** | **Time** | Expiration timestamp defines when the code expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] |
+| **metadata** | **Object** | A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'voucher'] |
 

data/docs/SimpleVoucherRedemption.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::SimpleVoucherRedemption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **quantity** | **Integer** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] |
+| **redeemed_quantity** | **Integer** | How many times a voucher has already been redeemed. | [optional] |
+

data/docs/Sku.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. |  |
-| **source_id** | **String** | A unique SKU identifier from your inventory system. |  |
-| **product_id** | **String** | The parent product's unique ID. |  |
-| **sku** | **String** | Unique user-defined SKU name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
+| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | A unique SKU identifier from your inventory system. | [optional] |
+| **product_id** | **String** | The parent product's unique ID. | [optional] |
+| **sku** | **String** | Unique user-defined SKU name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
 | **currency** | **String** | SKU price currency. | [optional] |
-| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |  |
-| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated in ISO 8601 format. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the `SKU`. | [default to 'sku'] |
+| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] |
+| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional][default to 'sku'] |
 

data/docs/SkusGetResponseBody.md

@@ -4,16 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. |  |
-| **source_id** | **String** | A unique SKU identifier from your inventory system. |  |
-| **product_id** | **String** | The parent product's unique ID. |  |
-| **sku** | **String** | Unique user-defined SKU name. |  |
-| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. |  |
+| **id** | **String** | A unique identifier that represents the SKU and is assigned by Voucherify. | [optional] |
+| **source_id** | **String** | A unique SKU identifier from your inventory system. | [optional] |
+| **product_id** | **String** | The parent product's unique ID. | [optional] |
+| **sku** | **String** | Unique user-defined SKU name. | [optional] |
+| **price** | **Integer** | Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$100.00` being expressed as `10000`. | [optional] |
 | **currency** | **String** | SKU price currency. | [optional] |
-| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. |  |
-| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated in ISO 8601 format. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the `SKU`. | [default to 'sku'] |
+| **attributes** | **Object** | The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family. | [optional] |
+| **image_url** | **String** | The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the `SKU`. | [optional][default to 'sku'] |
 

data/docs/SkusImportCsvCreateResponseBody.md

@@ -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/SkusListForProduct.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about SKUs. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of SKUs. | [default to 'data'] |
-| **data** | [**Array<Sku>**](Sku.md) | A dictionary that contains an array of SKUs. |  |
-| **total** | **Integer** | Total number of SKUs in the product. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about SKUs. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of SKUs. | [optional][default to 'data'] |
+| **data** | [**Array<Sku>**](Sku.md) | A dictionary that contains an array of SKUs. | [optional] |
+| **total** | **Integer** | Total number of SKUs in the product. | [optional] |
 

data/docs/StackingRules.md

@@ -4,12 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one stacking request (note: more redeemables means more processing time!). | [default to 30] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many of the sent redeemables will be applied to the order. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be labelled as SKIPPED. | [default to 5] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an exclusive category can be applied in one request. | [default to 1] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one stacking request (note: more redeemables means more processing time!). | [optional][default to 30] |
+| **applicable_redeemables_limit** | **Integer** | Defines how many of the sent redeemables will be applied to the order. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be labelled as SKIPPED. | [optional][default to 5] |
 | **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables per category can be applied in one request. | [optional][default to 1] |
-| **exclusive_categories** | **Array<String>** | Lists all exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint. |  |
-| **joint_categories** | **Array<String>** | Lists all joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. |  |
+| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an exclusive category can be applied in one request. | [optional][default to 1] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with an exclusive category per category in stacking rules can be applied in one request. | [optional][default to 1] |
+| **exclusive_categories** | **Array<String>** | Lists all exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint. | [optional] |
+| **joint_categories** | **Array<String>** | Lists all joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. | [optional] |
 | **redeemables_application_mode** | **String** | Defines redeemables application mode. | [optional] |
 | **redeemables_sorting_rule** | **String** | Defines redeemables sorting rule. | [optional][default to 'REQUESTED_ORDER'] |
+| **redeemables_products_application_mode** | **String** | Defines redeemables products application mode. | [optional] |
+| **redeemables_no_effect_rule** | **String** | Defines redeemables no effect rule. | [optional] |
 

data/docs/ValidationRule.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Custom, unique name for set of validation rules. |  |
-| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. |  |
-| **error** | [**ValidationRuleBaseError**](ValidationRuleBaseError.md) |  | [optional] |
-| **applicable_to** | [**ValidationRuleBaseApplicableTo**](ValidationRuleBaseApplicableTo.md) |  |  |
-| **type** | **String** | Type of validation rule. | [default to 'expression'] |
-| **context_type** | **String** | Validation rule context type.    | **Context Type** | **Definition** | |:---|:---| | earning_rule.order.paid |  | | earning_rule.custom_event |  | | earning_rule.customer.segment.entered |  | | campaign.discount_coupons |  | | campaign.discount_coupons.discount.apply_to_order |  | | campaign.discount_coupons.discount.apply_to_items |  | | campaign.discount_coupons.discount.apply_to_items_proportionally |  | | campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity |  | | campaign.discount_coupons.discount.fixed.apply_to_items |  | | campaign.gift_vouchers |  | | campaign.gift_vouchers.gift.apply_to_order |  | | campaign.gift_vouchers.gift.apply_to_items |  | | campaign.referral_program |  | | campaign.referral_program.discount.apply_to_order |  | | campaign.referral_program.discount.apply_to_items |  | | campaign.referral_program.discount.apply_to_items_proportionally |  | | campaign.referral_program.discount.apply_to_items_proportionally_by_quantity |  | | campaign.referral_program.discount.fixed.apply_to_items |  | | campaign.promotion |  | | campaign.promotion.discount.apply_to_order |  | | campaign.promotion.discount.apply_to_items |  | | campaign.promotion.discount.apply_to_items_proportionally |  | | campaign.promotion.discount.apply_to_items_proportionally_by_quantity |  | | campaign.promotion.discount.fixed.apply_to_items |  | | campaign.loyalty_program |  | | campaign.lucky_draw |  | | voucher.discount_voucher |  | | voucher.discount_voucher.discount.apply_to_order |  | | voucher.discount_voucher.discount.apply_to_items |  | | voucher.discount_voucher.discount.apply_to_items_proportionally |  | | voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity |  | | voucher.discount_voucher.discount.fixed.apply_to_items |  | | voucher.gift_voucher |  | | voucher.gift_voucher.gift.apply_to_order |  | | voucher.gift_voucher.gift.apply_to_items |  | | voucher.loyalty_card |  | | voucher.lucky_draw_code |  | | distribution.custom_event |  | | reward_assignment.pay_with_points |  | | global |  | | [default to 'global'] |
-| **id** | **String** | Unique validation rule ID. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the validation rule was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the validation rule was updated in ISO 8601 format. | [optional] |
+| **name** | **String** | Custom, unique name for set of validation rules. | [optional] |
+| **rules** | **Object** | Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from `1`. The values are objects containing the rule conditions. | [optional] |
+| **error** | [**ValidationRuleError**](ValidationRuleError.md) |  | [optional] |
+| **applicable_to** | [**ValidationRuleApplicableTo**](ValidationRuleApplicableTo.md) |  | [optional] |
+| **type** | **String** | Type of validation rule. | [optional][default to 'expression'] |
+| **context_type** | **String** | Validation rule context type.    | **Context Type** | **Definition** | |:---|:---| | earning_rule.order.paid |  | | earning_rule.custom_event |  | | earning_rule.customer.segment.entered |  | | campaign.discount_coupons |  | | campaign.discount_coupons.discount.apply_to_order |  | | campaign.discount_coupons.discount.apply_to_items |  | | campaign.discount_coupons.discount.apply_to_items_proportionally |  | | campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity |  | | campaign.discount_coupons.discount.fixed.apply_to_items |  | | campaign.gift_vouchers |  | | campaign.gift_vouchers.gift.apply_to_order |  | | campaign.gift_vouchers.gift.apply_to_items |  | | campaign.referral_program |  | | campaign.referral_program.discount.apply_to_order |  | | campaign.referral_program.discount.apply_to_items |  | | campaign.referral_program.discount.apply_to_items_proportionally |  | | campaign.referral_program.discount.apply_to_items_proportionally_by_quantity |  | | campaign.referral_program.discount.fixed.apply_to_items |  | | campaign.promotion |  | | campaign.promotion.discount.apply_to_order |  | | campaign.promotion.discount.apply_to_items |  | | campaign.promotion.discount.apply_to_items_proportionally |  | | campaign.promotion.discount.apply_to_items_proportionally_by_quantity |  | | campaign.promotion.discount.fixed.apply_to_items |  | | campaign.loyalty_program |  | | campaign.lucky_draw |  | | voucher.discount_voucher |  | | voucher.discount_voucher.discount.apply_to_order |  | | voucher.discount_voucher.discount.apply_to_items |  | | voucher.discount_voucher.discount.apply_to_items_proportionally |  | | voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity |  | | voucher.discount_voucher.discount.fixed.apply_to_items |  | | voucher.gift_voucher |  | | voucher.gift_voucher.gift.apply_to_order |  | | voucher.gift_voucher.gift.apply_to_items |  | | voucher.loyalty_card |  | | voucher.lucky_draw_code |  | | distribution.custom_event |  | | reward_assignment.pay_with_points |  | | global |  | | [optional][default to 'global'] |
+| **id** | **String** | Unique validation rule ID. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the validation rule was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the validation rule was updated. The value is shown in the ISO 8601 format. | [optional] |
 | **assignments_count** | **Integer** | The number of instances the validation rule has been assigned to different types of redeemables. | [optional] |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the validation rule. | [default to 'validation_rules'] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the validation rule. | [optional][default to 'validation_rules'] |
 

data/docs/ValidationRuleApplicableTo.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::ValidationRuleApplicableTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **excluded** | [**Array<ApplicableTo>**](ApplicableTo.md) | Defines which items are excluded from a discount. | [optional] |
+| **included** | [**Array<ApplicableTo>**](ApplicableTo.md) | Defines which items are included in a discount. | [optional] |
+| **included_all** | **Boolean** | Indicates whether all items are included in the discount. | [optional] |
+

data/docs/ValidationRuleAssignment.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Validation rule assignment ID. |  |
-| **rule_id** | **String** | Validation rule ID. |  |
-| **related_object_id** | **String** | The resource ID to which the validation rule was assigned. |  |
-| **related_object_type** | **String** | The type of resource to which the validation rule was assigned. |  |
-| **created_at** | **Time** | Timestamp representing the date and time when the validation rule assignment was created in ISO 8601 format. |  |
-| **object** | **String** | The type of object represented by the ID. | [default to 'validation_rules_assignment'] |
+| **id** | **String** | Validation rule assignment ID. | [optional] |
+| **rule_id** | **String** | Validation rule ID. | [optional] |
+| **related_object_id** | **String** | The resource ID to which the validation rule was assigned. | [optional] |
+| **related_object_type** | **String** | The type of resource to which the validation rule was assigned. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the validation rule assignment was created. The value is shown in the ISO 8601 format. | [optional] |
+| **object** | **String** | The type of the object represented by the ID. | [optional][default to 'validation_rules_assignment'] |
 

data/docs/ValidationRuleAssignmentsList.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about validation rule assignments. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of validation rule assignments. | [default to 'data'] |
-| **data** | [**Array<ValidationRuleAssignment>**](ValidationRuleAssignment.md) | A dictionary that contains an array of validation rule assignments. |  |
-| **total** | **Integer** | Total number of validation rule assignments. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about validation rule assignments. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the JSON property that contains the array of validation rule assignments. | [optional][default to 'data'] |
+| **data** | [**Array<ValidationRuleAssignment>**](ValidationRuleAssignment.md) | A dictionary that contains an array of validation rule assignments. | [optional] |
+| **total** | **Integer** | Total number of validation rule assignments. | [optional] |
 

data/docs/ValidationRuleError.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ValidationRuleError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The error message returned from API when validation / redemption fails to meet requirements of defined rules. | [optional] |
+