voucherify 5.0.1 → 6.0.0

data/docs/CampaignsUpdateResponseBody.md

@@ -4,34 +4,36 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique campaign ID, assigned by Voucherify. |  |
-| **name** | **String** | Campaign name. |  |
+| **id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] |
+| **name** | **String** | Campaign name. | [optional] |
 | **description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] |
-| **campaign_type** | **String** | Type of campaign. |  |
-| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published |  |
+| **campaign_type** | **String** | Type of campaign. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria     -  `STATIC`: vouchers need to be manually published | [optional] |
 | **voucher** | [**CampaignVoucher**](CampaignVoucher.md) |  | [optional] |
-| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. |  |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. |  |
-| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. |  |
-| **validity_timeframe** | [**CampaignBaseValidityTimeframe**](CampaignBaseValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the campaign is valid.  - `0`  Sunday   - `1`  Monday   - `2`  Tuesday   - `3`  Wednesday   - `4`  Thursday   - `5`  Friday   - `6`  Saturday   | [optional] |
-| **activity_duration_after_publishing** | **String** | Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a `duration` of `P24D` will be valid for a duration of 24 days. | [optional] |
+| **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **use_voucher_metadata_schema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **activity_duration_after_publishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] |
 | **vouchers_count** | **Integer** | Total number of unique vouchers in campaign. | [optional] |
 | **start_date** | **Time** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] |
 | **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] |
 | **active** | **Boolean** | A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was updated in ISO 8601 format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the campaign was last updated in ISO 8601 format. | [optional] |
 | **category** | **String** | Unique category name. | [optional] |
-| **creation_status** | **String** | Indicates the status of the campaign creation. |  |
-| **vouchers_generation_status** | **String** | Indicates the status of the campaign's vouchers. |  |
-| **protected** | **Boolean** | Indicates whether the resource can be deleted. |  |
-| **category_id** | **String** | Unique category ID that this campaign belongs to. |  |
-| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. |  |
-| **object** | **String** | The type of object represented by JSON. This object stores information about the campaign. | [default to 'campaign'] |
+| **creation_status** | **String** | Indicates the status of the campaign creation. | [optional] |
+| **vouchers_generation_status** | **String** | Indicates the status of the campaign's voucher generation. | [optional] |
+| **protected** | **Boolean** | Indicates whether the resource can be deleted. | [optional] |
+| **category_id** | **String** | Unique category ID that this campaign belongs to. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about the campaign. | [optional][default to 'campaign'] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **loyalty_tiers_expiration** | [**LoyaltyTiersExpirationAll**](LoyaltyTiersExpirationAll.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignsVouchersCreateCombinedResponseBody.md

@@ -0,0 +1,37 @@
+# VoucherifySdk::CampaignsVouchersCreateCombinedResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Assigned by the Voucherify API, identifies the voucher. | [optional] |
+| **code** | **String** | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] |
+| **campaign** | **String** | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
+| **campaign_id** | **String** | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
+| **category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] |
+| **category_id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **type** | **String** | Defines the type of the voucher.  | [optional] |
+| **discount** | [**Discount**](Discount.md) |  | [optional] |
+| **gift** | [**CampaignsVouchersCreateCombinedResponseBodyGift**](CampaignsVouchersCreateCombinedResponseBodyGift.md) |  | [optional] |
+| **loyalty_card** | [**CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard**](CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.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] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] |
+| **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
+| **assets** | [**VoucherAssets**](VoucherAssets.md) |  | [optional] |
+| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
+| **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 referring person. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
+| **publish** | [**CampaignsVouchersCreateCombinedResponseBodyPublish**](CampaignsVouchersCreateCombinedResponseBodyPublish.md) |  | [optional] |
+| **redemption** | [**CampaignsVouchersCreateCombinedResponseBodyRedemption**](CampaignsVouchersCreateCombinedResponseBodyRedemption.md) |  | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
+| **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
+| **async_action_id** | **String** | The ID of the scheduled asynchronous action. | [optional] |
+

data/docs/CampaignsVouchersCreateCombinedResponseBodyGift.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CampaignsVouchersCreateCombinedResponseBodyGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **balance** | **Integer** | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
+

data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard
+
+## 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** | **Date** | 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/CampaignsVouchersCreateCombinedResponseBodyPublish.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CampaignsVouchersCreateCombinedResponseBodyPublish
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional][default to 'list'] |
+| **count** | **Integer** | Publication events counter. | [optional] |
+| **url** | **String** | The endpoint where this list of publications can be accessed using a GET method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
+

data/docs/CampaignsVouchersCreateCombinedResponseBodyRedemption.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::CampaignsVouchersCreateCombinedResponseBodyRedemption
+
+## 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] |
+| **redeemed_points** | **Integer** | Total loyalty points redeemed. | [optional] |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional][default to 'list'] |
+| **url** | **String** | The endpoint where this list of redemptions can be accessed using a GET method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
+

data/docs/CampaignsVouchersCreateInBulkRequestBody.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **code** | **String** | Unique voucher code. | [optional] |
+| **code_config** | [**CodeConfig**](CodeConfig.md) |  | [optional] |
 | **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the voucher. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
-| **redemption** | [**CampaignsImportVoucherItemRedemption**](CampaignsImportVoucherItemRedemption.md) |  | [optional] |
+| **redemption** | [**CampaignsVouchersCreateInBulkRequestBodyRedemption**](CampaignsVouchersCreateInBulkRequestBodyRedemption.md) |  | [optional] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
 | **start_date** | **Time** | Activation timestamp defines when the voucher starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] |
 | **expiration_date** | **Time** | Expiration timestamp defines when the voucher expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] |
-| **code** | **String** | Unique voucher code. | [optional] |
-| **code_config** | [**CodeConfig**](CodeConfig.md) |  | [optional] |
 

data/docs/CampaignsVouchersCreateInBulkRequestBodyRedemption.md

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

data/docs/CampaignsVouchersCreateRequestBody.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the voucher. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
-| **redemption** | [**CampaignsImportVoucherItemRedemption**](CampaignsImportVoucherItemRedemption.md) |  | [optional] |
+| **redemption** | [**CampaignsVouchersCreateRequestBodyRedemption**](CampaignsVouchersCreateRequestBodyRedemption.md) |  | [optional] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
 | **start_date** | **Time** | Activation timestamp defines when the voucher starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] |
 | **expiration_date** | **Time** | Expiration timestamp defines when the voucher expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] |

data/docs/CampaignsVouchersCreateRequestBodyRedemption.md

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

data/docs/CampaignsVouchersCreateResponseBody.md

@@ -10,28 +10,27 @@
 | **campaign_id** | **String** | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
 | **category** | **String** | Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. | [optional] |
 | **category_id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
-| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
 | **type** | **String** | Defines the type of the voucher.  | [optional] |
 | **discount** | [**Discount**](Discount.md) |  | [optional] |
-| **gift** | [**VoucherGift**](VoucherGift.md) |  | [optional] |
-| **loyalty_card** | [**VoucherLoyaltyCard**](VoucherLoyaltyCard.md) |  | [optional] |
+| **gift** | [**CampaignsVouchersCreateResponseBodyGift**](CampaignsVouchersCreateResponseBodyGift.md) |  | [optional] |
+| **loyalty_card** | [**CampaignsVouchersCreateResponseBodyLoyaltyCard**](CampaignsVouchersCreateResponseBodyLoyaltyCard.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] |
-| **validity_timeframe** | [**VoucherValidityTimeframe**](VoucherValidityTimeframe.md) |  | [optional] |
-| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0`  Sunday   - `1`  Monday   - `2`  Tuesday   - `3`  Wednesday   - `4`  Thursday   - `5`  Friday   - `6`  Saturday   | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
 | **active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] |
 | **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
 | **assets** | [**VoucherAssets**](VoucherAssets.md) |  | [optional] |
 | **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the voucher was created in ISO 8601 format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |
 | **updated_at** | **Time** | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
-| **holder_id** | **String** | Unique customer ID of voucher owner. | [optional] |
-| **holder** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] |
-| **object** | **String** | The type of object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
-| **distributions** | **Array<Object>** |  | [optional] |
-| **deleted** | **Boolean** | Flag indicating whether this voucher is deleted. | [optional] |
+| **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 referring person. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
+| **publish** | [**CampaignsVouchersCreateResponseBodyPublish**](CampaignsVouchersCreateResponseBodyPublish.md) |  | [optional] |
+| **redemption** | [**CampaignsVouchersCreateResponseBodyRedemption**](CampaignsVouchersCreateResponseBodyRedemption.md) |  | [optional] |
+| **categories** | [**Array<Category>**](Category.md) | Contains details about the category. | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
-| **publish** | [**VoucherPublish**](VoucherPublish.md) |  | [optional] |
-| **redemption** | [**VoucherRedemption**](VoucherRedemption.md) |  | [optional] |
 

data/docs/CampaignsVouchersCreateResponseBodyGift.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CampaignsVouchersCreateResponseBodyGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **balance** | **Integer** | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
+

data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::CampaignsVouchersCreateResponseBodyLoyaltyCard
+
+## 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** | **Date** | 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/CampaignsVouchersCreateResponseBodyPublish.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CampaignsVouchersCreateResponseBodyPublish
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional][default to 'list'] |
+| **count** | **Integer** | Publication events counter. | [optional] |
+| **url** | **String** | The endpoint where this list of publications can be accessed using a GET method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
+

data/docs/CampaignsVouchersCreateResponseBodyRedemption.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::CampaignsVouchersCreateResponseBodyRedemption
+
+## 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] |
+| **redeemed_points** | **Integer** | Total loyalty points redeemed. | [optional] |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional][default to 'list'] |
+| **url** | **String** | The endpoint where this list of redemptions can be accessed using a GET method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
+

data/docs/CategoriesApi.md

@@ -39,7 +39,7 @@ end
 
 api_instance = VoucherifySdk::CategoriesApi.new
 opts = {
-  categories_create_request_body: VoucherifySdk::CategoriesCreateRequestBody.new({name: 'name_example', hierarchy: 37}) # CategoriesCreateRequestBody | Specify the details of the category that you would like to create.
+  categories_create_request_body: VoucherifySdk::CategoriesCreateRequestBody.new # CategoriesCreateRequestBody | Specify the details of the category that you would like to create.
 }
 
 begin
@@ -270,7 +270,7 @@ end
 api_instance = VoucherifySdk::CategoriesApi.new
 category_id = 'category_id_example' # String | Unique category ID assigned by Voucherify.
 opts = {
-  categories_update_request_body: VoucherifySdk::CategoriesUpdateRequestBody.new({name: 'name_example', hierarchy: 37}) # CategoriesUpdateRequestBody | Specify the details of the category that you would like to update.
+  categories_update_request_body: VoucherifySdk::CategoriesUpdateRequestBody.new # CategoriesUpdateRequestBody | Specify the details of the category that you would like to update.
 }
 
 begin

data/docs/CategoriesCreateRequestBody.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
 

data/docs/CategoriesCreateResponseBody.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique category ID assigned by Voucherify. |  |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
-| **object** | **String** |  | [default to 'category'] |
-| **created_at** | **Time** | Timestamp representing the date and time when the category was created in ISO 8601 format. |  |
+| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
+| **object** | **String** |  | [optional][default to 'category'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
 

data/docs/CategoriesGetResponseBody.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique category ID assigned by Voucherify. |  |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
-| **object** | **String** | The type of object represented by the JSON. This object stores information about the category. | [default to 'category'] |
-| **created_at** | **Time** | Timestamp representing the date and time when the category was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated in ISO 8601 format. | [optional] |
+| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
+| **object** | **String** | The type of the object represented by the JSON. This object stores information about the category. | [optional][default to 'category'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
 | **stacking_rules_type** | **String** | The type of the stacking rule eligibility. | [optional] |
 

data/docs/CategoriesListResponseBody.md

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

data/docs/CategoriesUpdateRequestBody.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
 

data/docs/CategoriesUpdateResponseBody.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique category ID assigned by Voucherify. |  |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
-| **object** | **String** |  | [default to 'category'] |
-| **created_at** | **Time** | Timestamp representing the date and time when the category was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated in ISO 8601 format. |  |
+| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
+| **object** | **String** |  | [optional][default to 'category'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
 

data/docs/Category.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique category ID assigned by Voucherify. |  |
-| **name** | **String** | Category name. |  |
-| **hierarchy** | **Integer** | Category hierarchy. |  |
-| **object** | **String** | The type of object represented by the JSON. This object stores information about the category. | [default to 'category'] |
-| **created_at** | **Time** | Timestamp representing the date and time when the category was created in ISO 8601 format. |  |
-| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated in ISO 8601 format. | [optional] |
+| **id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **name** | **String** | Category name. | [optional] |
+| **hierarchy** | **Integer** | Category hierarchy. | [optional] |
+| **object** | **String** | The type of the object represented by the JSON. This object stores information about the category. | [optional][default to 'category'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format. | [optional] |
 | **stacking_rules_type** | **String** | The type of the stacking rule eligibility. | [optional] |
 

data/docs/ClientEventsCreateRequestBody.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **event** | **String** | Event name. This is the same name that you used to define a custom event in the **Dashboard** > **Project Settings** > **Event Schema**. |  |
+| **event** | **String** | Event name. This is the same name that you used to define a custom event in the **Dashboard** > **Project Settings** > **Event Schema**. | [optional] |
 | **customer** | [**Customer**](Customer.md) |  |  |
 | **referral** | [**ClientEventsCreateRequestBodyReferral**](ClientEventsCreateRequestBodyReferral.md) |  | [optional] |
 | **loyalty** | [**ClientEventsCreateRequestBodyLoyalty**](ClientEventsCreateRequestBodyLoyalty.md) |  | [optional] |

data/docs/ClientEventsCreateRequestBodyLoyalty.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | Code of the loyalty card to receive points based on the calculation method defined in the related earning rule. An earning rule is triggered for the loyalty card when the event passed in the `event` parameter of the request payload gets sent along with this loyalty card code. |  |
+| **code** | **String** | Code of the loyalty card to receive points based on the calculation method defined in the related earning rule. An earning rule is triggered for the loyalty card when the event passed in the `event` parameter of the request payload gets sent along with this loyalty card code. | [optional] |
 

data/docs/ClientEventsCreateRequestBodyReferral.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | **String** | A code through which a new visitor has been referred to a service. |  |
+| **code** | **String** | A code through which a new visitor has been referred to a service. | [optional] |
 | **referrer_id** | **String** | Unique ID of the referring person - it is optional and not required if the referral **code** is provided. | [optional] |
 

data/docs/ClientEventsCreateResponseBody.md

@@ -4,9 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The object represented is an `event`. | [default to 'event'] |
-| **type** | **String** | The event name. |  |
+| **object** | **String** | The object represented is an `event`. | [optional][default to 'event'] |
+| **type** | **String** | The event name. | [optional] |
 | **customer** | [**SimpleCustomerRequiredObjectType**](SimpleCustomerRequiredObjectType.md) |  |  |
-| **referral** | **Object** | A `null` referral object. |  |
-| **loyalty** | **Object** | A `null` loyalty object. |  |
+| **referral** | **Object** | A `null` referral object. | [optional] |
+| **loyalty** | **Object** | A `null` loyalty object. | [optional] |
+| **metadata** | **Object** |  | [optional] |
 

data/docs/ClientPromotionsTiersListResponseBody.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::ClientPromotionsTiersListResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of promotion tier objects. | [optional][default to 'tiers'] |
+| **tiers** | [**Array<PromotionTier>**](PromotionTier.md) | Contains array of promotion tier objects. | [optional] |
+| **total** | **Integer** | Total number of promotion tiers. | [optional] |
+| **has_more** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different page or a different start date filter) to get more records returned in the results. | [optional] |
+

data/docs/ClientQualificationsCheckEligibilityRequestBody.md

@@ -6,9 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **customer** | [**Customer**](Customer.md) |  | [optional] |
 | **order** | [**Order**](Order.md) |  | [optional] |
-| **mode** | **String** | Defines which resources Voucherify will use. The `ADVANCED` mode is available after purchase only. | [optional] |
 | **tracking_id** | **String** | Is correspondent to Customer's source_id | [optional] |
-| **scenario** | **String** | Defines the scenario Voucherify should consider during the qualification process.  - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer’s cart based on the vouchers assigned to the customer’s profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s). | [optional] |
+| **scenario** | **String** | Defines the scenario Voucherify should consider during the qualification process.  - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s). | [optional] |
 | **options** | [**QualificationsOption**](QualificationsOption.md) |  | [optional] |
 | **metadata** | **Object** | A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!-- [Create Validation Rules](https://docs.voucherify.io/reference/create-validation-rules) -->[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ → _Advanced_ → _Redemption metadata satisfy_ or _Basic Builder_ → _Attributes match_ → _REDEMPTION METADATA_. [Read more](https://support.voucherify.io/article/148-how-to-build-a-rule). | [optional] |
 

data/docs/ClientRedemptionsRedeemRequestBody.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redeemables** | [**Array<StackableValidateRedeemBaseRedeemablesItem>**](StackableValidateRedeemBaseRedeemablesItem.md) | An array of redeemables. You can combine `voucher`(s) and `promotion_tier`(s). Alternatively, send one unique`promotion_stack` in the array. |  |
+| **options** | [**ClientRedemptionsRedeemRequestBodyOptions**](ClientRedemptionsRedeemRequestBodyOptions.md) |  | [optional] |
+| **redeemables** | [**Array<ClientRedemptionsRedeemRequestBodyRedeemablesItem>**](ClientRedemptionsRedeemRequestBodyRedeemablesItem.md) |  | [optional] |
 | **order** | [**Order**](Order.md) |  | [optional] |
 | **customer** | [**Customer**](Customer.md) |  | [optional] |
 | **session** | [**Session**](Session.md) |  | [optional] |
 | **tracking_id** | **String** | Is correspondent to Customer's source_id | [optional] |
 | **metadata** | **Object** | A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format. | [optional] |
-| **options** | [**ClientRedemptionsRedeemRequestBodyAllOfOptions**](ClientRedemptionsRedeemRequestBodyAllOfOptions.md) |  | [optional] |
 

data/docs/ClientRedemptionsRedeemRequestBodyOptions.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientRedemptionsRedeemRequestBodyOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expand** | **Array<String>** | Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details.   | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br>- Order data with calculated discounts are listed in each child redeemable object.<br>- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br>- Includes `metadata` for each discount type. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br>- Returns redemption object `metadata`.<br>- Returns an expanded `categories` object, showing details about the category. | | [optional] |
+

data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItem.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ClientRedemptionsRedeemRequestBodyRedeemablesItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **gift** | [**ClientRedemptionsRedeemRequestBodyRedeemablesItemGift**](ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md) |  | [optional] |
+| **reward** | [**ClientRedemptionsRedeemRequestBodyRedeemablesItemReward**](ClientRedemptionsRedeemRequestBodyRedeemablesItemReward.md) |  | [optional] |
+

data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemGift.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientRedemptionsRedeemRequestBodyRedeemablesItemGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credits** | **Integer** | The number of credits that the user wants to use from the gift card to fulfill the order. The value of credits cannot be higher than the current balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
+

data/docs/ClientRedemptionsRedeemRequestBodyRedeemablesItemReward.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::ClientRedemptionsRedeemRequestBodyRedeemablesItemReward
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique reward ID assigned by Voucherify. The reward must be assigned to the campaign in order for the user to be able to use the reward. | [optional] |
+| **points** | **Integer** | The number of loyalty points that the user wants to spend in order to fulfill the order using a **pay with points** reward. The number of points cannot be higher than the current balance on the loyalty card. | [optional] |
+