@voucherify/sdk 2.9.3 → 3.0.0

package/docs/ManagementProjectsGetResponseBody.md

@@ -0,0 +1,49 @@
+# Voucherify.ManagementProjectsGetResponseBody
+
+## 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** | [**ManagementProjectsGetResponseBodyWebhooksCalloutNotifications**](ManagementProjectsGetResponseBodyWebhooksCalloutNotifications.md) |  | [optional] 
+**apiUsageNotifications** | [**ManagementProjectsGetResponseBodyApiUsageNotifications**](ManagementProjectsGetResponseBodyApiUsageNotifications.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** | [**ManagementProjectsGetResponseBodyDefaultCodeConfig**](ManagementProjectsGetResponseBodyDefaultCodeConfig.md) |  | [optional] 
+**limits** | [**ManagementProjectsGetResponseBodyLimits**](ManagementProjectsGetResponseBodyLimits.md) |  | [optional] 
+
+
+
+## Enum: WebhookVersionEnum
+
+
+* `v2024-01-01` (value: `"v2024-01-01"`)
+
+
+
+
+
+## Enum: ApiVersionEnum
+
+
+* `v2018-08-01` (value: `"v2018-08-01"`)
+
+
+
+

package/docs/ManagementProjectsGetResponseBodyApiUsageNotifications.md

@@ -0,0 +1,14 @@
+# Voucherify.ManagementProjectsGetResponseBodyApiUsageNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**UsageNotifications**](UsageNotifications.md) |  | [optional] 
+**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/ManagementProjectsGetResponseBodyDefaultCodeConfig.md

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

package/docs/ManagementProjectsGetResponseBodyLimits.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsGetResponseBodyLimits
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apiCalls** | [**[ManagementProjectsGetResponseBodyLimitsApiCallsItem]**](ManagementProjectsGetResponseBodyLimitsApiCallsItem.md) |  | [optional] 
+**bulkApiCalls** | [**[ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem]**](ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem.md) |  | [optional] 
+
+

package/docs/ManagementProjectsGetResponseBodyLimitsApiCallsItem.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsGetResponseBodyLimitsApiCallsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** | Determines the maximum number of API calls per time set in `\"duration\"`. | [optional] 
+**duration** | **String** | Determines the amount of time during which the calls up to the number specified in the `value` can be made. The duration is presented in the ISO 8601 format, e.g. `PT1H` means one hour. | [optional] 
+
+

package/docs/ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsGetResponseBodyLimitsBulkApiCallsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Number** | Determines the maximum number of API calls per time set in `\"duration\"`. | [optional] 
+**duration** | **String** | Determines the amount of time during which the calls up to the number specified in the `value` can be made. The duration is presented in the ISO 8601 format, e.g. `PT1H` means one hour. | [optional] 
+
+

package/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotifications.md

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

package/docs/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsDistributions.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsDistributions
+
+## 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/ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsWebhooks.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsGetResponseBodyWebhooksCalloutNotificationsWebhooks
+
+## 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/ManagementProjectsListResponseBody.md

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

package/docs/ManagementProjectsMetadataSchema.md

@@ -0,0 +1,15 @@
+# Voucherify.ManagementProjectsMetadataSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the metadata schema. | [optional] 
+**relatedObject** | **String** | The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type. The standard metadata schemas are: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`. | [optional] 
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. | [optional] 
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the metadata schema. | [optional] [default to 'metadata_schema']
+
+

package/docs/ManagementProjectsMetadataSchemaDefinition.md

@@ -0,0 +1,45 @@
+# Voucherify.ManagementProjectsMetadataSchemaDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Indicates the type of metadata. Note that `\"geopoint\"` type is a paid feature. | [optional] 
+**optional** | **Boolean** | Indicates if this definition is optional or not for the resource. | [optional] 
+**array** | **Boolean** | Indicates if the definition is an array. | [optional] 
+**deleted** | **Boolean** | Indicates if the definition has been deleted from the schema. | [optional] 
+**objectType** | **String** | The name of the custom resource (i.e. a nested object) if the resource has been previously defined. Otherwise, it is `null` for other types. | [optional] 
+**minLength** | **Number** | Value indicating the minimum length. Available only for the `string` type. | [optional] 
+**maxLength** | **Number** | Value indicating the maximum length. Available only for the `string` type. | [optional] 
+**exactLength** | **Number** | Value indicating the exact length. Available only for the `string` type. | [optional] 
+**eq** | **[Object]** |  | [optional] 
+**ne** | **[Number]** | Array of values that are not allowed. Available only for the `number` type. | [optional] 
+**lt** | **Number** | A property of the `number` type must have `less than` this value. The value should be up to two decimal places. | [optional] 
+**lte** | **Number** | A property of the `number` type must be `less than or equal` to this value. The value should be up to two decimal places. | [optional] 
+**gt** | **Number** | A property of `number` type must be `greater than` this value. The value should be up to two decimal places. | [optional] 
+**gte** | **Number** | A property of `number` type must be `greater than or equal` to this value. The value should be up to two decimal places. | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `string` (value: `"string"`)
+
+* `number` (value: `"number"`)
+
+* `object` (value: `"object"`)
+
+* `date` (value: `"date"`)
+
+* `datetime` (value: `"datetime"`)
+
+* `geopoint` (value: `"geopoint"`)
+
+* `boolean` (value: `"boolean"`)
+
+* `image_url` (value: `"image_url"`)
+
+
+
+

package/docs/ManagementProjectsMetadataSchemasCreateRequestBody.md

@@ -0,0 +1,11 @@
+# Voucherify.ManagementProjectsMetadataSchemasCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**relatedObject** | **String** | The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type, or you can use standard resource types: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`. | [optional] 
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.  | [optional] [default to false]
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. There can be many properties within this object.  Only the properties sent in the request will be created. | [optional] 
+
+

package/docs/ManagementProjectsMetadataSchemasCreateResponseBody.md

@@ -0,0 +1,15 @@
+# Voucherify.ManagementProjectsMetadataSchemasCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the metadata schema. | [optional] 
+**relatedObject** | **String** | The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type. The standard metadata schemas are: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`. | [optional] 
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. | [optional] 
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the metadata schema. | [optional] [default to 'metadata_schema']
+
+

package/docs/ManagementProjectsMetadataSchemasGetResponseBody.md

@@ -0,0 +1,15 @@
+# Voucherify.ManagementProjectsMetadataSchemasGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the metadata schema. | [optional] 
+**relatedObject** | **String** | The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type. The standard metadata schemas are: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`. | [optional] 
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. | [optional] 
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the metadata schema. | [optional] [default to 'metadata_schema']
+
+

package/docs/ManagementProjectsMetadataSchemasListResponseBody.md

@@ -0,0 +1,30 @@
+# Voucherify.ManagementProjectsMetadataSchemasListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about the metadata schemas in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of metadata schema objects. | [optional] [default to 'data']
+**data** | [**[ManagementProjectsMetadataSchema]**](ManagementProjectsMetadataSchema.md) | Array of metadata schema objects. The metadata schemas are listed by related object properties. | [optional] 
+**total** | **Number** | The total number of metadata schema objects. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/ManagementProjectsMetadataSchemasUpdateRequestBody.md

@@ -0,0 +1,10 @@
+# Voucherify.ManagementProjectsMetadataSchemasUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. In other words, it indicates whether or not you are allowed to create new metadata definitions; for example, in the campaign manager or publication manager. If it is set to true, then only the defined fields will be available for assigning values.  | [optional] 
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. There can be many properties within this object.  Only the properties sent in the request will be updated. However, if you send a property, all its key-value pairs must be provided - otherwise, they will be overwritten to new values.  You cannot change the `\"type\"` property. However, it is required, so you need to add it to the request. | [optional] 
+
+

package/docs/ManagementProjectsMetadataSchemasUpdateResponseBody.md

@@ -0,0 +1,15 @@
+# Voucherify.ManagementProjectsMetadataSchemasUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the metadata schema. | [optional] 
+**relatedObject** | **String** | The resource type. You can define custom metadata schemas, which have a custom `\"related_object\"` resource type. The standard metadata schemas are: `\"campaign\"`, `\"customer\"`, `\"earning_rule\"`, `\"loyalty_tier\"`, `\"order\"`, `\"order_item\"`, `\"product\"`, `\"promotion_tier\"`, `\"publication\"`, `\"redemption\"`, `\"reward\"`, `\"voucher\"`. | [optional] 
+**properties** | [**{String: ManagementProjectsMetadataSchemaDefinition}**](ManagementProjectsMetadataSchemaDefinition.md) | Contains metadata definitions. | [optional] 
+**allowDefinedOnly** | **Boolean** | Restricts the creation of metadata fields when set to `true`. It indicates whether or not you can create new metadata definitions, e.g. in the campaign or publication manager. If set to `true`, then only the defined fields are available for assigning values. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the metadata schema was created. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the metadata schema was updated. The value for this parameter is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the metadata schema. | [optional] [default to 'metadata_schema']
+
+

package/docs/ManagementProjectsStackingRules.md

@@ -0,0 +1,95 @@
+# Voucherify.ManagementProjectsStackingRules
+
+## 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/ManagementProjectsStackingRulesCreateRequestBody.md

@@ -0,0 +1,92 @@
+# Voucherify.ManagementProjectsStackingRulesCreateRequestBody
+
+## 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"`)
+
+
+
+