voucherify 8.0.1 → 8.0.3

data/docs/BinApi.md

@@ -94,8 +94,8 @@ end
 api_instance = VoucherifySdk::BinApi.new
 opts = {
   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.
-  order: VoucherifySdk::ParameterOrderListBin::ID, # ParameterOrderListBin | Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
-  starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
+  order: VoucherifySdk::ParameterOrderListBin::ID, # ParameterOrderListBin | Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order.
+  starting_after_id: 'starting_after_id_example', # String | A cursor for pagination. It retrieves the results starting after a result with the given ID.
   filters: VoucherifySdk::ParameterFiltersListBin.new # ParameterFiltersListBin | Filters for listing bin entries.
 }
 
@@ -113,8 +113,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **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] |
-| **order** | [**ParameterOrderListBin**](.md) | Orders the bin entries according the date and time when they were moved to the bin or according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
-| **starting_after_id** | **String** | A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] |
+| **order** | [**ParameterOrderListBin**](.md) | Orders the bin entries according to the bin entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] |
+| **starting_after_id** | **String** | A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] |
 | **filters** | [**ParameterFiltersListBin**](.md) | Filters for listing bin entries. | [optional] |
 
 ### Return type

data/docs/Campaign.md

@@ -8,10 +8,10 @@
 | **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. | [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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [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. | [optional] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [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] |
@@ -34,7 +34,7 @@
 | **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] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
-| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignBase.md

@@ -8,10 +8,10 @@
 | **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. | [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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [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. | [optional] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [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] |
@@ -34,4 +34,5 @@
 | **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] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignsApi.md

@@ -151,7 +151,7 @@ end
 
 Create Campaign
 
-Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.    📘 Global uniqueness  All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.    🚧 Code generation status  This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description.
+Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes.    📘 Global uniqueness  All campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.    🚧 Code generation status  This is an asynchronous action; you cant read or modify a newly created campaign until the code generation is completed. See the creation_status field in the campaign object description. 🚧 Standalone Vouchers and Campaigns In version [v20241004](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004), standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, you cannot create a standalone discount or gift voucher campaign with the type: STANDALONE through the API. Voucherify developers work on adding that feature. Follow the [Voucherify Release Notes](https://support.voucherify.io/article/23-whats-new-in-voucherify#v20241004) for more details about released features.
 
 ### Examples
 
@@ -596,7 +596,7 @@ opts = {
   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.
   campaign_type: VoucherifySdk::ParameterCampaignType::PROMOTION, # ParameterCampaignType | This attribute allows filtering by campaign type.
-  expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns | Include an expanded categories object in the response.
+  expand: VoucherifySdk::ParameterExpandListCampaigns::CATEGORY, # ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores.
   order: VoucherifySdk::ParameterOrderListCampaigns::CREATED_AT, # ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
   filters: VoucherifySdk::ParameterFiltersListCampaigns.new # ParameterFiltersListCampaigns | Filters the results by campaign status or whether the campaign is a referral campaign.
 }
@@ -617,7 +617,7 @@ end
 | **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] |
 | **campaign_type** | [**ParameterCampaignType**](.md) | This attribute allows filtering by campaign type. | [optional] |
-| **expand** | [**ParameterExpandListCampaigns**](.md) | Include an expanded categories object in the response. | [optional][default to 'category'] |
+| **expand** | [**ParameterExpandListCampaigns**](.md) | Includes an expanded categories object in the response. If the [Areas and Stores](https://support.voucherify.io/article/623-areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. | [optional] |
 | **order** | [**ParameterOrderListCampaigns**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
 | **filters** | [**ParameterFiltersListCampaigns**](.md) | Filters the results by campaign status or whether the campaign is a referral campaign. | [optional] |
 

data/docs/CampaignsCreateRequestBody.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
-| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  `STATIC`: vouchers need to be manually published. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published | [optional] |
 | **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
 | **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [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] |
@@ -20,6 +20,7 @@
 | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [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 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] |
+| **access_settings** | [**AccessSettings**](AccessSettings.md) |  | [optional] |
 | **validation_rules** | **Array<String>** | Array containing the ID of the validation rule associated with the promotion tier. | [optional] |
 | **campaign_type** | **String** |  | [optional] |
 | **voucher** | [**CampaignsCreateRequestBodyVoucher**](CampaignsCreateRequestBodyVoucher.md) |  | [optional] |

data/docs/CampaignsCreateResponseBody.md

@@ -8,10 +8,10 @@
 | **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. | [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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [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. | [optional] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [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] |
@@ -34,7 +34,7 @@
 | **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] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
-| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignsGetResponseBody.md

@@ -8,10 +8,10 @@
 | **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. | [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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [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. | [optional] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [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] |
@@ -34,7 +34,7 @@
 | **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] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
-| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignsUpdateRequestBody.md

@@ -14,10 +14,11 @@
 | **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] |
 | **unset_metadata_fields** | **Array<String>** | Determine which metadata should be removed from campaign. | [optional] |
 | **category_id** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] |
+| **access_settings** | [**AccessSettings**](AccessSettings.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] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [optional] |
 | **auto_join** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] |
-| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.      - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).     -  `STATIC`: vouchers need to be manually published. | [optional] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation.  - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). -  `STATIC`: vouchers need to be manually published.  If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`. | [optional] |
 | **discount** | [**Discount**](Discount.md) |  | [optional] |
 | **referral_program** | [**ReferralProgram**](ReferralProgram.md) |  | [optional] |
 | **gift** | [**Gift**](Gift.md) |  | [optional] |

data/docs/CampaignsUpdateResponseBody.md

@@ -8,10 +8,10 @@
 | **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. | [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] |
+| **type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers | [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. | [optional] |
-| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. | [optional] |
+| **join_once** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them. | [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] |
@@ -34,7 +34,7 @@
 | **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] |
+| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 | **promotion** | [**PromotionTiersList**](PromotionTiersList.md) |  | [optional] |
 | **validation_rules_assignments** | [**ValidationRulesAssignmentsList**](ValidationRulesAssignmentsList.md) |  | [optional] |
-| **access_settings_assignments** | [**AccessSettingsCampaignAssignmentsList**](AccessSettingsCampaignAssignmentsList.md) |  | [optional] |
 

data/docs/CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard.md

@@ -4,8 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
+| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [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] |
+| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
 

data/docs/CampaignsVouchersCreateResponseBodyLoyaltyCard.md

@@ -4,8 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
+| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card, minus the expired points. | [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] |
+| **pending_points** | **Integer** | Determines the number of pending points that will be added to the loyalty card after the predefined time. | [optional] |
 

data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md

@@ -13,6 +13,7 @@
 | **result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) |  | [optional] |
 | **metadata** | **Object** | The metadata object stores all custom attributes in the form of key/value pairs assigned to the redeemable. | [optional] |
 | **categories** | [**Array<CategoryWithStackingRulesType>**](CategoryWithStackingRulesType.md) |  | [optional] |
-| **campaign_name** | **String** | Campaign name | [optional] |
-| **campaign_id** | **String** | Unique campaign ID assigned by Voucherify. | [optional] |
+| **campaign_name** | **String** | Campaign name. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
+| **campaign_id** | **String** | Unique campaign ID assigned by Voucherify. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
+| **name** | **String** | Name of the promotion tier. Displayed only if the `options.expand` is passed with a `redeemable` value in the validation request body. | [optional] |
 

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md

@@ -11,7 +11,7 @@
 | **effect** | **String** |  | [optional] |
 | **is_dynamic** | **Boolean** | Flag indicating whether the discount was calculated using a formula. | [optional] |
 | **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
-| **unit_off_formula** | **String** |  | [optional] |
+| **unit_off_formula** | **String** | Formula used to calculate the number of units. | [optional] |
 | **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
 | **product** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md) |  | [optional] |
 | **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) |  | [optional] |

data/docs/CustomerLoyalty.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | Customer's loyalty points. | [optional] |
+| **points** | **Integer** | Customer's loyalty points minus expired for all loyalty cards which the customer has. | [optional] |
 | **referred_customers** | **Integer** | Total number of customers referred by the customer. | [optional] |
 | **campaigns** | [**Hash<String, CustomerLoyaltyCampaignsEntry>**](CustomerLoyaltyCampaignsEntry.md) | Contains campaigns with details about point balances and how many customers were referred by the customer. | [optional] |
 

data/docs/Discount.md

@@ -11,7 +11,7 @@
 | **effect** | **String** |  | [optional] |
 | **is_dynamic** | **Boolean** | Flag indicating whether the discount was calculated using a formula. | [optional] |
 | **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
-| **unit_off_formula** | **String** |  | [optional] |
+| **unit_off_formula** | **String** | Formula used to calculate the number of units. | [optional] |
 | **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
 | **product** | [**DiscountProduct**](DiscountProduct.md) |  | [optional] |
 | **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) |  | [optional] |

data/docs/DiscountUnitMultipleOneUnit.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **unit_off** | **Float** | Number of units to be granted a full value discount. | [optional] |
-| **unit_off_formula** | **String** |  | [optional] |
+| **unit_off_formula** | **String** | Formula used to calculate the number of units. | [optional] |
 | **effect** | **String** | Defines how the unit is added to the customer's order.   | [optional] |
 | **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
 | **product** | [**SimpleProductDiscountUnit**](SimpleProductDiscountUnit.md) |  | [optional] |

data/docs/EarningRule.md

@@ -11,6 +11,7 @@
 | **custom_event** | [**EarningRuleCustomEvent**](EarningRuleCustomEvent.md) |  | [optional] |
 | **segment** | [**EarningRuleSegment**](EarningRuleSegment.md) |  | [optional] |
 | **loyalty_tier** | [**EarningRuleLoyaltyTier**](EarningRuleLoyaltyTier.md) |  | [optional] |
+| **pending_points** | [**EarningRulePendingPoints**](EarningRulePendingPoints.md) |  | [optional] |
 | **source** | [**EarningRuleSource**](EarningRuleSource.md) |  | [optional] |
 | **object** | **String** | The type of the object represented by JSON. Default is earning_rule. | [optional][default to 'earning_rule'] |
 | **automation_id** | **String** | For internal use by Voucherify. | [optional] |

data/docs/EarningRulePendingPoints.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EarningRulePendingPoints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period_type** | **String** | Defines the type of the period during which the points are in the pending state. Currently, only `DAY` value is accepted. | [optional][default to 'DAY'] |
+| **period_value** | **Integer** | Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90. | [optional] |
+

data/docs/Error.md

@@ -11,4 +11,5 @@
 | **request_id** | **String** | This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team. | [optional] |
 | **resource_id** | **String** | Unique resource ID that can be used in another endpoint to get more details. | [optional] |
 | **resource_type** | **String** | The resource type. | [optional] |
+| **error** | [**ErrorError**](ErrorError.md) |  | [optional] |
 

data/docs/ErrorError.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ErrorError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The message configured by the user in a validation rule. | [optional] |
+

data/docs/EventSource.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::EventSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | **String** | Determines the channel that initiated the event. | [optional] |
+| **user** | [**EventSourceUser**](EventSourceUser.md) |  | [optional] |
+| **api_key** | [**EventSourceApiKey**](EventSourceApiKey.md) |  | [optional] |
+

data/docs/EventSourceApiKey.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::EventSourceApiKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Channel name in the application keys. | [optional] |
+| **app_id** | **String** | Contains the application ID from the Voucherify API key pair. | [optional] |
+

data/docs/EventSourceUser.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::EventSourceUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of the user. | [optional] |
+

data/docs/InapplicableTo.md

@@ -17,8 +17,9 @@
 | **aggregated_quantity_limit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
 | **amount_limit** | **Integer** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
 | **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] |
-| **order_item_indices** | **Array<Integer>** | Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`. | [optional] |
+| **order_item_indices** | **Array<Integer>** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional] |
+| **order_item_units** | [**Array<InapplicableToOrderItemUnitsItem>**](InapplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request. | [optional] |
 | **repeat** | **Integer** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] |
 | **skip_initially** | **Integer** | Determines how many items are skipped before the discount is applied. | [optional] |
-| **target** | **String** | Determines to which kinds of objects the discount is applicable. `\"ITEM\"` includes products and SKUs. | [optional] |
+| **target** | **String** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional] |
 

data/docs/InapplicableToOrderItemUnitsItem.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::InapplicableToOrderItemUnitsItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] |
+| **units** | **Array<Integer>** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. | [optional] |
+