@voucherify/sdk 2.9.4 → 3.0.0

package/docs/ManagementProjectsStackingRulesCreateResponseBody.md

@@ -0,0 +1,95 @@
+# Voucherify.ManagementProjectsStackingRulesCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the stacking rules. | [optional] 
+**exclusiveCategories** | **[String]** | Lists the IDs of 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] 
+**jointCategories** | **[String]** | Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. | [optional] 
+**redeemablesLimit** | **Number** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] 
+**applicableRedeemablesLimit** | **Number** | Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesCategoryLimits** | **{String: Number}** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] 
+**applicableExclusiveRedeemablesLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableExclusiveRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. The number must be less than or equal to `applicable_exclusive_redeemables_limit`. | [optional] 
+**discountCalculationMode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] 
+**initialAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] 
+**discountedAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] 
+**redeemablesApplicationMode** | **String** | Defines the application mode for redeemables. `\"ALL\"` means that all redeemables must be validated for the redemption to be successful. `\"PARTIAL\"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped. | [optional] 
+**redeemablesSortingRule** | **String** | Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request. | [optional] 
+**redeemablesProductsApplicationMode** | **String** | Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product. | [optional] 
+**redeemablesNoEffectRule** | **String** | Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated. | [optional] 
+**noEffectSkipCategories** | **[String]** | Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`. | [optional] 
+**noEffectRedeemAnywayCategories** | **[String]** | Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`. | [optional] 
+**redeemablesRollbackOrderMode** | **String** | Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the stacking rules were created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the stacking rules were updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: DiscountCalculationModeEnum
+
+
+* `INITIAL_AMOUNT` (value: `"INITIAL_AMOUNT"`)
+
+* `DISCOUNTED_AMOUNT` (value: `"DISCOUNTED_AMOUNT"`)
+
+
+
+
+
+## Enum: RedeemablesApplicationModeEnum
+
+
+* `ALL` (value: `"ALL"`)
+
+* `PARTIAL` (value: `"PARTIAL"`)
+
+
+
+
+
+## Enum: RedeemablesSortingRuleEnum
+
+
+* `CATEGORY_HIERARCHY` (value: `"CATEGORY_HIERARCHY"`)
+
+* `REQUESTED_ORDER` (value: `"REQUESTED_ORDER"`)
+
+
+
+
+
+## Enum: RedeemablesProductsApplicationModeEnum
+
+
+* `STACK` (value: `"STACK"`)
+
+* `ONCE` (value: `"ONCE"`)
+
+
+
+
+
+## Enum: RedeemablesNoEffectRuleEnum
+
+
+* `REDEEM_ANYWAY` (value: `"REDEEM_ANYWAY"`)
+
+* `SKIP` (value: `"SKIP"`)
+
+
+
+
+
+## Enum: RedeemablesRollbackOrderModeEnum
+
+
+* `WITH_ORDER` (value: `"WITH_ORDER"`)
+
+* `WITHOUT_ORDER` (value: `"WITHOUT_ORDER"`)
+
+
+
+

package/docs/ManagementProjectsStackingRulesGetResponseBody.md

@@ -0,0 +1,95 @@
+# Voucherify.ManagementProjectsStackingRulesGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the stacking rules. | [optional] 
+**exclusiveCategories** | **[String]** | Lists the IDs of 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] 
+**jointCategories** | **[String]** | Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. | [optional] 
+**redeemablesLimit** | **Number** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] 
+**applicableRedeemablesLimit** | **Number** | Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesCategoryLimits** | **{String: Number}** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] 
+**applicableExclusiveRedeemablesLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableExclusiveRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. The number must be less than or equal to `applicable_exclusive_redeemables_limit`. | [optional] 
+**discountCalculationMode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] 
+**initialAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] 
+**discountedAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] 
+**redeemablesApplicationMode** | **String** | Defines the application mode for redeemables. `\"ALL\"` means that all redeemables must be validated for the redemption to be successful. `\"PARTIAL\"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped. | [optional] 
+**redeemablesSortingRule** | **String** | Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request. | [optional] 
+**redeemablesProductsApplicationMode** | **String** | Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product. | [optional] 
+**redeemablesNoEffectRule** | **String** | Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated. | [optional] 
+**noEffectSkipCategories** | **[String]** | Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`. | [optional] 
+**noEffectRedeemAnywayCategories** | **[String]** | Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`. | [optional] 
+**redeemablesRollbackOrderMode** | **String** | Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the stacking rules were created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the stacking rules were updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: DiscountCalculationModeEnum
+
+
+* `INITIAL_AMOUNT` (value: `"INITIAL_AMOUNT"`)
+
+* `DISCOUNTED_AMOUNT` (value: `"DISCOUNTED_AMOUNT"`)
+
+
+
+
+
+## Enum: RedeemablesApplicationModeEnum
+
+
+* `ALL` (value: `"ALL"`)
+
+* `PARTIAL` (value: `"PARTIAL"`)
+
+
+
+
+
+## Enum: RedeemablesSortingRuleEnum
+
+
+* `CATEGORY_HIERARCHY` (value: `"CATEGORY_HIERARCHY"`)
+
+* `REQUESTED_ORDER` (value: `"REQUESTED_ORDER"`)
+
+
+
+
+
+## Enum: RedeemablesProductsApplicationModeEnum
+
+
+* `STACK` (value: `"STACK"`)
+
+* `ONCE` (value: `"ONCE"`)
+
+
+
+
+
+## Enum: RedeemablesNoEffectRuleEnum
+
+
+* `REDEEM_ANYWAY` (value: `"REDEEM_ANYWAY"`)
+
+* `SKIP` (value: `"SKIP"`)
+
+
+
+
+
+## Enum: RedeemablesRollbackOrderModeEnum
+
+
+* `WITH_ORDER` (value: `"WITH_ORDER"`)
+
+* `WITHOUT_ORDER` (value: `"WITHOUT_ORDER"`)
+
+
+
+

package/docs/ManagementProjectsStackingRulesListResponseBody.md

@@ -0,0 +1,30 @@
+# Voucherify.ManagementProjectsStackingRulesListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about the stacking rules in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of stacking rule objects. | [optional] [default to 'data']
+**data** | [**[ManagementProjectsStackingRules]**](ManagementProjectsStackingRules.md) | Array of only one stacking rule object. | [optional] 
+**total** | **Number** | The total number of stacking rule objects. It is always 1. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/ManagementProjectsStackingRulesUpdateRequestBody.md

@@ -0,0 +1,92 @@
+# Voucherify.ManagementProjectsStackingRulesUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusiveCategories** | **[String]** | Lists the IDs of 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] 
+**jointCategories** | **[String]** | Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. | [optional] 
+**redeemablesLimit** | **Number** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] 
+**applicableRedeemablesLimit** | **Number** | Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesCategoryLimits** | **{String: Number}** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] 
+**applicableExclusiveRedeemablesLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableExclusiveRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. The number must be less than or equal to `applicable_exclusive_redeemables_limit`. | [optional] 
+**discountCalculationMode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] 
+**initialAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] 
+**discountedAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] 
+**redeemablesApplicationMode** | **String** | Defines the application mode for redeemables. `\"ALL\"` means that all redeemables must be validated for the redemption to be successful. `\"PARTIAL\"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped. | [optional] 
+**redeemablesSortingRule** | **String** | Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request. | [optional] 
+**redeemablesProductsApplicationMode** | **String** | Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product. | [optional] 
+**redeemablesNoEffectRule** | **String** | Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated. | [optional] 
+**noEffectSkipCategories** | **[String]** | Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`. | [optional] 
+**noEffectRedeemAnywayCategories** | **[String]** | Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`. | [optional] 
+**redeemablesRollbackOrderMode** | **String** | Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. | [optional] 
+
+
+
+## Enum: DiscountCalculationModeEnum
+
+
+* `INITIAL_AMOUNT` (value: `"INITIAL_AMOUNT"`)
+
+* `DISCOUNTED_AMOUNT` (value: `"DISCOUNTED_AMOUNT"`)
+
+
+
+
+
+## Enum: RedeemablesApplicationModeEnum
+
+
+* `ALL` (value: `"ALL"`)
+
+* `PARTIAL` (value: `"PARTIAL"`)
+
+
+
+
+
+## Enum: RedeemablesSortingRuleEnum
+
+
+* `CATEGORY_HIERARCHY` (value: `"CATEGORY_HIERARCHY"`)
+
+* `REQUESTED_ORDER` (value: `"REQUESTED_ORDER"`)
+
+
+
+
+
+## Enum: RedeemablesProductsApplicationModeEnum
+
+
+* `STACK` (value: `"STACK"`)
+
+* `ONCE` (value: `"ONCE"`)
+
+
+
+
+
+## Enum: RedeemablesNoEffectRuleEnum
+
+
+* `REDEEM_ANYWAY` (value: `"REDEEM_ANYWAY"`)
+
+* `SKIP` (value: `"SKIP"`)
+
+
+
+
+
+## Enum: RedeemablesRollbackOrderModeEnum
+
+
+* `WITH_ORDER` (value: `"WITH_ORDER"`)
+
+* `WITHOUT_ORDER` (value: `"WITHOUT_ORDER"`)
+
+
+
+

package/docs/ManagementProjectsStackingRulesUpdateResponseBody.md

@@ -0,0 +1,95 @@
+# Voucherify.ManagementProjectsStackingRulesUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique identifier of the stacking rules. | [optional] 
+**exclusiveCategories** | **[String]** | Lists the IDs of 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] 
+**jointCategories** | **[String]** | Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns. | [optional] 
+**redeemablesLimit** | **Number** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] 
+**applicableRedeemablesLimit** | **Number** | Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableRedeemablesCategoryLimits** | **{String: Number}** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] 
+**applicableExclusiveRedeemablesLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. | [optional] 
+**applicableExclusiveRedeemablesPerCategoryLimit** | **Number** | Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`. The number must be less than or equal to `applicable_exclusive_redeemables_limit`. | [optional] 
+**discountCalculationMode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] 
+**initialAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] 
+**discountedAmountModeCategories** | **[String]** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] 
+**redeemablesApplicationMode** | **String** | Defines the application mode for redeemables. `\"ALL\"` means that all redeemables must be validated for the redemption to be successful. `\"PARTIAL\"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped. | [optional] 
+**redeemablesSortingRule** | **String** | Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request. | [optional] 
+**redeemablesProductsApplicationMode** | **String** | Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product. | [optional] 
+**redeemablesNoEffectRule** | **String** | Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated. | [optional] 
+**noEffectSkipCategories** | **[String]** | Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`. | [optional] 
+**noEffectRedeemAnywayCategories** | **[String]** | Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`. | [optional] 
+**redeemablesRollbackOrderMode** | **String** | Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the stacking rules were created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the stacking rules were updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: DiscountCalculationModeEnum
+
+
+* `INITIAL_AMOUNT` (value: `"INITIAL_AMOUNT"`)
+
+* `DISCOUNTED_AMOUNT` (value: `"DISCOUNTED_AMOUNT"`)
+
+
+
+
+
+## Enum: RedeemablesApplicationModeEnum
+
+
+* `ALL` (value: `"ALL"`)
+
+* `PARTIAL` (value: `"PARTIAL"`)
+
+
+
+
+
+## Enum: RedeemablesSortingRuleEnum
+
+
+* `CATEGORY_HIERARCHY` (value: `"CATEGORY_HIERARCHY"`)
+
+* `REQUESTED_ORDER` (value: `"REQUESTED_ORDER"`)
+
+
+
+
+
+## Enum: RedeemablesProductsApplicationModeEnum
+
+
+* `STACK` (value: `"STACK"`)
+
+* `ONCE` (value: `"ONCE"`)
+
+
+
+
+
+## Enum: RedeemablesNoEffectRuleEnum
+
+
+* `REDEEM_ANYWAY` (value: `"REDEEM_ANYWAY"`)
+
+* `SKIP` (value: `"SKIP"`)
+
+
+
+
+
+## Enum: RedeemablesRollbackOrderModeEnum
+
+
+* `WITH_ORDER` (value: `"WITH_ORDER"`)
+
+* `WITHOUT_ORDER` (value: `"WITHOUT_ORDER"`)
+
+
+
+

package/docs/ManagementProjectsTemplatesCampaignsCopyCreateRequestBody.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsTemplatesCampaignsCopyCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | User-defined name of the campaign template. It must be unique. | [optional] 
+**description** | **String** | User-defined description of the campaign template. | [optional] 
+**destinationProjectId** | **String** | Unique identifier of the project to which the campaign template will be copied. | [optional] 
+
+

package/docs/ManagementProjectsTemplatesCampaignsCopyCreateResponseBody.md

@@ -0,0 +1,34 @@
+# Voucherify.ManagementProjectsTemplatesCampaignsCopyCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the campaign template. It is assigned by Voucherify. | [optional] 
+**name** | **String** | User-defined name of the campaign template. | [optional] 
+**description** | **String** | User-defined description of the campaign template. | [optional] 
+**campaignType** | **String** | Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to `DISCOUNT_COUPONS`. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign template was created. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'campaign_template']
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `campaign_template` (value: `"campaign_template"`)
+
+
+
+

package/docs/ManagementProjectsTemplatesCampaignsListResponseBody.md

@@ -0,0 +1,32 @@
+# Voucherify.ManagementProjectsTemplatesCampaignsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about campaign templates. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the JSON property that contains the array of campaign templates. | [optional] [default to 'data']
+**data** | [**[CampaignTemplate]**](CampaignTemplate.md) | Dictionary that contains an array of campaign templates. | [optional] 
+**total** | **Number** | Total number of templates, regardless of the applied query parameters. Displayed only if the `include_total` query paremeter is set to `true`. | [optional] 
+**hasMore** | **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 to get more records returned in the results. | [optional] 
+**moreStartingAfter** | **String** | Returns an ID that can be used to return another page of results. Use the template ID in the `starting_after_id` query parameter to display another page of the results starting after the template with that ID. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/ManagementProjectsUpdateRequestBody.md

@@ -0,0 +1,33 @@
+# Voucherify.ManagementProjectsUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the project. | [optional] 
+**description** | **String** | A user-defined description of the project, e.g. its purpose, scope, region. | [optional] 
+**timezone** | **String** | The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database. | [optional] 
+**currency** | **String** | The currency used in the project. It is equal to a 3-letter ISO 4217 code. | [optional] 
+**dialCode** | **String** | The country dial code for the project. It is equal to an ITU country code. | [optional] 
+**webhookVersion** | **String** | The webhook version used in the project. | [optional] [default to 'v2024-01-01']
+**clientTrustedDomains** | **[String]** | An array of URL addresses that allow client requests. | [optional] 
+**clientRedeemEnabled** | **Boolean** | Enables client-side redemption. | [optional] 
+**clientPublishEnabled** | **Boolean** | Enables client-side publication. | [optional] 
+**clientListVouchersEnabled** | **Boolean** | Enables client-side listing of vouchers. | [optional] 
+**clientCreateCustomerEnabled** | **Boolean** | Enables client-side creation of customers. | [optional] 
+**clientLoyaltyEventsEnabled** | **Boolean** | Enables client-side events for loyalty and referral programs. | [optional] 
+**clientSetVoucherExpirationDateEnabled** | **Boolean** | Enables client-side setting of voucher expiration date. | [optional] 
+**webhooksCalloutNotifications** | [**ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications**](ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications.md) |  | [optional] 
+**apiUsageNotifications** | [**ManagementProjectsUpdateRequestBodyApiUsageNotifications**](ManagementProjectsUpdateRequestBodyApiUsageNotifications.md) |  | [optional] 
+**defaultCodeConfig** | [**ManagementProjectsUpdateRequestBodyDefaultCodeConfig**](ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md) |  | [optional] 
+
+
+
+## Enum: WebhookVersionEnum
+
+
+* `v2024-01-01` (value: `"v2024-01-01"`)
+
+
+
+

package/docs/ManagementProjectsUpdateRequestBodyApiUsageNotifications.md

@@ -0,0 +1,13 @@
+# Voucherify.ManagementProjectsUpdateRequestBodyApiUsageNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**apiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**bulkApiCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**webhookCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**cycleCalls** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+
+

package/docs/ManagementProjectsUpdateRequestBodyDefaultCodeConfig.md

@@ -0,0 +1,9 @@
+# Voucherify.ManagementProjectsUpdateRequestBodyDefaultCodeConfig
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charset** | **String** | Lists all characters that are used as default for vouchers | [optional] 
+
+

package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsUpdateRequestBodyWebhooksCalloutNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**distributions** | [**ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions**](ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions.md) |  | [optional] 
+**webhooks** | [**ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks**](ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks.md) |  | [optional] 
+
+

package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsDistributions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsUpdateRequestBodyWebhooksCalloutNotificationsWebhooks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Boolean** | Enables the notification through an email. | [optional] 
+**inApp** | **Boolean** | Enables the notification through an email. | [optional] 
+**emails** | **[String]** | An array of email addresses which will receive the notification. | [optional] 
+
+

package/docs/ManagementProjectsUpdateResponseBody.md

@@ -0,0 +1,49 @@
+# Voucherify.ManagementProjectsUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the project. | [optional] 
+**name** | **String** | The name of the project. | [optional] 
+**description** | **String** | A user-defined description of the project, e.g. its purpose, scope, region. | [optional] 
+**timezone** | **String** | The time zone in which the project is established. It can be in the GMT format or in accordance with IANA time zone database. | [optional] 
+**currency** | **String** | The currency used in the project. It is equal to a 3-letter ISO 4217 code. | [optional] 
+**dialCode** | **String** | The country dial code for the project. It is equal to an ITU country code. | [optional] 
+**webhookVersion** | **String** | The webhook version used in the project. | [optional] [default to 'v2024-01-01']
+**clientTrustedDomains** | **[String]** | An array of URL addresses that allow client requests. | [optional] 
+**clientRedeemEnabled** | **Boolean** | Enables client-side redemption. | [optional] 
+**clientPublishEnabled** | **Boolean** | Enables client-side publication. | [optional] 
+**clientListVouchersEnabled** | **Boolean** | Enables client-side listing of vouchers. | [optional] 
+**clientCreateCustomerEnabled** | **Boolean** | Enables client-side creation of customers. | [optional] 
+**clientLoyaltyEventsEnabled** | **Boolean** | Enables client-side events for loyalty and referral programs. | [optional] 
+**clientSetVoucherExpirationDateEnabled** | **Boolean** | Enables client-side setting of voucher expiration date. | [optional] 
+**webhooksCalloutNotifications** | [**ManagementProjectsUpdateResponseBodyWebhooksCalloutNotifications**](ManagementProjectsUpdateResponseBodyWebhooksCalloutNotifications.md) |  | [optional] 
+**apiUsageNotifications** | [**ManagementProjectsUpdateResponseBodyApiUsageNotifications**](ManagementProjectsUpdateResponseBodyApiUsageNotifications.md) |  | [optional] 
+**clusterId** | **String** | The identifier of the cluster where the project will be created. | [optional] 
+**caseSensitiveCodes** | **Boolean** | Determines if the vouchers in the project will be: - case sensitive - if `true`, `C0dE-cfV` is **not** equal to `c0de-cfv`), - case insensitive - if `false`, `C0dE-cfV` is equal to `c0de-cfv`. | [optional] 
+**apiVersion** | **String** | The API version used in the project. Currently, the default and only value is `v2018-08-01`. | [optional] [default to 'v2018-08-01']
+**isSandbox** | **Boolean** | Determines if the project is a sandbox project. | [optional] 
+**webhookToken** | **String** | Webhook token used for authentication. | [optional] 
+**defaultCodeConfig** | [**ManagementProjectsUpdateResponseBodyDefaultCodeConfig**](ManagementProjectsUpdateResponseBodyDefaultCodeConfig.md) |  | [optional] 
+**limits** | [**ManagementProjectsUpdateResponseBodyLimits**](ManagementProjectsUpdateResponseBodyLimits.md) |  | [optional] 
+
+
+
+## Enum: WebhookVersionEnum
+
+
+* `v2024-01-01` (value: `"v2024-01-01"`)
+
+
+
+
+
+## Enum: ApiVersionEnum
+
+
+* `v2018-08-01` (value: `"v2018-08-01"`)
+
+
+
+