voucherify 8.0.2 → 8.1.0

data/docs/ManagementApi.md

@@ -174,7 +174,7 @@ end
 
 Create Custom Event Schema
 
-Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata).  📘 Custom Event Documentation  Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.
+Creates a custom event schema. The properties object is required, but it can be empty, however. This object is for optional custom properties (metadata).  📘 Custom Event Documentation  Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
 
 ### Examples
 
@@ -236,7 +236,7 @@ end
 
 Create Metadata Schema
 
-Creates a new metadata (custom attribute) schema. The schema consists of a set of key-value pairs to customize Voucherify resources.  You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cannot include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward  📘 Metadata Documentation  Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.
+Creates a new metadata (custom attribute) schema for a given resource. The schema consists of a set of key-value pairs to customize Voucherify resources.  You can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object cant include another nested object. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward Use this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given related_object, use the PUT [Update metadata schema](/api-reference/management/update-metadata-schema) endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for related_object: campaign for the first time. If you want define a new metadata property for campaign, use the [PUT Update metadata schema](/api-reference/management/update-metadata-schema) endpoint.  📘 Metadata Documentation  Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
 
 ### Examples
 
@@ -358,7 +358,7 @@ end
 
 Create Stacking Rules
 
-Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use Update Stacking Rules endpoint to change the rules.  📘 Stacking Rules Documentation  Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
+Overwrites the default stacking rules. If new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use [Update stacking rules](/api-reference/management/update-stacking-rules) endpoint to change the rules.  📘 Stacking rules documentation  Read [the Stacking rules article]/orchestrate/stacking-rules to learn how they work.
 
 ### Examples
 
@@ -420,7 +420,7 @@ end
 
 Create Webhook
 
-Creates a new webhook configuration.  📘 Webhook Documentation  Read Webhooks v2024-01-01 article to learn how webhooks work in Voucherify.
+Creates a new webhook configuration.  📘 Webhook Documentation  Read [Webhooks v2024-01-01](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
 
 ### Examples
 
@@ -541,7 +541,7 @@ nil (empty response body)
 
 Delete Custom Event Schema
 
-Deletes permanently the custom event schema with its custom properties (metadata).  📘 Custom Event Documentation  Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.
+Deletes permanently the custom event schema with its custom properties (metadata).  📘 Custom Event Documentation  Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
 
 ### Examples
 
@@ -600,7 +600,7 @@ nil (empty response body)
 
 Delete Metadata Schema
 
-Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the Update Metadata Schema endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the Create Metadata Schema endpoint.  🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the Update Metadata Schema endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify.  📘 Metadata Documentation  Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.
+Deletes permanently the metadata schema. In standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are: - Campaign - Voucher - Publication - Redemption - Product - Customer - Order - Order line item - Loyalty Tier - Promotion Tier - Earning rule - Reward If you want to delete only one definition, use the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. In the request, provide the deleted: true pair in the definition object. This definition will be moved to Removed definitions. If you want to create a new standard metadata schema, use the [Create Metadata Schema](/api-reference/management/create-metadata-schema) endpoint.  🚧 Metadata Purging This endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain. If you want to purge metadata from the entities: 1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. 2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema. 3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities. Note: - This is an asynchronous action. You will be notified when it has been completed. - You cannot purge metadata for the Redemption and Publication schemas. 4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify.  📘 Metadata Documentation  Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
 
 ### Examples
 
@@ -716,7 +716,7 @@ nil (empty response body)
 
 Delete Stacking Rules
 
-Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values.  📘 Stacking Rules Documentation  Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
+Deletes permanently the current settings for the stacking rules. The stacking rules are restored to default values.  📘 Stacking Rules Documentation  Read [the Stacking Rules article]/orchestrate/stacking-rules to learn how they work.
 
 ### Examples
 
@@ -775,7 +775,7 @@ nil (empty response body)
 
 Delete Webhook
 
-Deletes a webhook configuration.  📘 Webhook Documentation  Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.
+Deletes a webhook configuration.  📘 Webhook Documentation  Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
 
 ### Examples
 
@@ -894,7 +894,7 @@ end
 
 Get Custom Event Schema
 
-Retrieves a custom event schema.  📘 Custom Event Documentation  Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.
+Retrieves a custom event schema.  📘 Custom Event Documentation  Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
 
 ### Examples
 
@@ -954,7 +954,7 @@ end
 
 Get Metadata Schema
 
-Retrieves a metadata schema.  📘 Metadata Documentation  Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.
+Retrieves a metadata schema.  📘 Metadata Documentation  Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
 
 ### Examples
 
@@ -1072,7 +1072,7 @@ end
 
 Get Stacking Rules
 
-Retrieves the stacking rules for the project.  📘 Stacking Rules Documentation  Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
+Retrieves the stacking rules for the project.  📘 Stacking Rules Documentation  Read [the Stacking Rules article]/orchestrate/stacking-rules to learn how they work.
 
 ### Examples
 
@@ -1192,7 +1192,7 @@ end
 
 Get Webhook
 
-Retrieves a webhook configuration.  📘 Webhook Documentation  Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.
+Retrieves a webhook configuration.  📘 Webhook Documentation  Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
 
 ### Examples
 
@@ -1369,7 +1369,7 @@ end
 
 List Custom Event Schemas
 
-Lists all custom event schemas available in the project.  📘 Custom Event Documentation  Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.
+Lists all custom event schemas available in the project.  📘 Custom Event Documentation  Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
 
 ### Examples
 
@@ -1427,7 +1427,7 @@ end
 
 List Metadata Schemas
 
-Lists all metadata schemas available in the project.  📘 Metadata Documentation  Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.
+Lists all metadata schemas available in the project.  📘 Metadata Documentation  Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
 
 ### Examples
 
@@ -1540,7 +1540,7 @@ This endpoint does not need any parameter.
 
 List Stacking Rules
 
-Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the Get Stacking Rules or Update Stacking Rules endpoints.  📘 Stacking Rules Documentation  Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
+Lists all stacking rules. Returns always a list with one item. This endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the [Get Stacking Rules](/api-reference/management/get-stacking-rules) or [Update Stacking Rules](/api-reference/management/update-stacking-rules) endpoints.  📘 Stacking Rules Documentation  Read [the Stacking Rules article]/orchestrate/stacking-rules to learn how they work.
 
 ### Examples
 
@@ -1656,7 +1656,7 @@ end
 
 List Webhooks
 
-Lists all webhook configurations for the project.  📘 Webhook Documentation  Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.
+Lists all webhook configurations for the project.  📘 Webhook Documentation  Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
 
 ### Examples
 
@@ -1714,7 +1714,7 @@ end
 
 Copy Campaign Template to a Project
 
-Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+Copies a campaign template to another project. The resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.
 
 ### Examples
 
@@ -1778,7 +1778,7 @@ end
 
 List Campaign Templates
 
-Lists all campaign templates available in the project.  👍 List Campaign Templates  This endpoint works in the same way as the List Campaign Templates endpoint.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+Lists all campaign templates available in the project.  👍 List Campaign Templates  This endpoint works in the same way as the [List Campaign Templates endpoint](/api-reference/templates/list-campaign-templates).  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.
 
 ### Examples
 
@@ -1971,7 +1971,7 @@ end
 
 Update Custom Event Schema
 
-Updates a custom event schema. With this request, you can: - Add a non-existing property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged.  👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint.  📘 Custom Event Documentation  Read [Custom Events](https://support.voucherify.io/article/111-custom-events) article to learn how custom events work in Voucherify. Read also the details about the Track Custom Event endpoint and the Custom Event Object.
+Updates a custom event schema. With this request, you can: - Add a nonexistent property to a custom event schema. - Update an existing property. In the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged.  👍 Additional Notes - You can change the type of an existing property, e.g. from string to number. - You can remove a custom property with this endpoint by providing deleted: true in the request. However, you cannot permanently remove an event definition or its property with this endpoint.  📘 Custom Event Documentation  Read [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify. Read also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).
 
 ### Examples
 
@@ -2035,7 +2035,7 @@ end
 
 Update Metadata Schema
 
-Updates a metadata schema. With this request, you can: - Add a non-existing attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted.  👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint.  📘 Metadata Documentation  Read the Getting Started with Metadata articles to learn how metadata work in Voucherify.
+Updates a metadata schema. With this request, you can: - Add a nonexistent attribute definition to the metadata schema. - Update an existing attribute definition by overwriting its current values. In the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged. However, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted.  👍 Additional Notes - You cannot change the type of an existing schema, e.g. from string to number. - You can remove a definition with this endpoint by providing deleted: true in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint.  📘 Metadata Documentation  Read [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.
 
 ### Examples
 
@@ -2161,7 +2161,7 @@ end
 
 Update Stacking Rules
 
-Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request.  📘 Stacking Rules Documentation  Read [the Stacking Rules article](https://support.voucherify.io/article/604-stacking-rules) to learn how they work.
+Updates the stacking rules. Only the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request.  📘 Stacking Rules Documentation  Read [the Stacking Rules article]/orchestrate/stacking-rules to learn how they work.
 
 ### Examples
 
@@ -2289,7 +2289,7 @@ end
 
 Update Webhook
 
-Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.  📘 Webhook Documentation  Read Webhooks v2024-01-1 article to learn how webhooks work in Voucherify.
+Updates a webhook configuration. The events listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.  📘 Webhook Documentation  Read [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.
 
 ### Examples
 

data/docs/ManagementProjectsStackingRules.md

@@ -5,18 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique identifier of the stacking rules. | [optional] |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 | **created_at** | **Time** | 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] |
 | **updated_at** | **Time** | 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] |
 

data/docs/ManagementProjectsStackingRulesCreateRequestBody.md

@@ -4,16 +4,22 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 

data/docs/ManagementProjectsStackingRulesCreateResponseBody.md

@@ -5,18 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique identifier of the stacking rules. | [optional] |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 | **created_at** | **Time** | 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] |
 | **updated_at** | **Time** | 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] |
 

data/docs/ManagementProjectsStackingRulesGetResponseBody.md

@@ -5,18 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique identifier of the stacking rules. | [optional] |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 | **created_at** | **Time** | 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] |
 | **updated_at** | **Time** | 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] |
 

data/docs/ManagementProjectsStackingRulesUpdateRequestBody.md

@@ -4,16 +4,22 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 

data/docs/ManagementProjectsStackingRulesUpdateResponseBody.md

@@ -5,18 +5,24 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The unique identifier of the stacking rules. | [optional] |
-| **exclusive_categories** | **Array<String>** | Lists the IDs of the categories that are exclusive. | [optional] |
-| **joint_categories** | **Array<String>** | Lists the IDs of the categories that are joint. | [optional] |
-| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent to Voucherify for validation at the same time. | [optional] |
-| **applicable_redeemables_limit** | **Integer** | Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. | [optional] |
-| **applicable_redeemables_per_category_limit** | **Integer** | Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`. | [optional] |
-| **applicable_exclusive_redeemables_limit** | **Integer** | Defines how many redeemables with an assigned exclusive category can be applied at the same time. | [optional] |
-| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`. | [optional] |
+| **exclusive_categories** | **Array<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] |
+| **joint_categories** | **Array<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] |
+| **redeemables_limit** | **Integer** | Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time. | [optional] |
+| **applicable_redeemables_limit** | **Integer** | 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] |
+| **applicable_redeemables_per_category_limit** | **Integer** | 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] |
+| **applicable_redeemables_category_limits** | **Hash<String, Integer>** | Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category. | [optional] |
+| **applicable_exclusive_redeemables_limit** | **Integer** | 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] |
+| **applicable_exclusive_redeemables_per_category_limit** | **Integer** | 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] |
 | **discount_calculation_mode** | **String** | Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount. | [optional] |
 | **initial_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the initial amount. | [optional] |
 | **discounted_amount_mode_categories** | **Array<String>** | Lists the IDs of the categories that apply a discount based on the discounted amount. | [optional] |
 | **redeemables_application_mode** | **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] |
-| **redeemables_sorting_rule** | **String** | Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request. | [optional] |
+| **redeemables_sorting_rule** | **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] |
+| **redeemables_products_application_mode** | **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] |
+| **redeemables_no_effect_rule** | **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] |
+| **no_effect_skip_categories** | **Array<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] |
+| **no_effect_redeem_anyway_categories** | **Array<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] |
+| **redeemables_rollback_order_mode** | **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] |
 | **created_at** | **Time** | 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] |
 | **updated_at** | **Time** | 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] |
 

data/docs/ManagementProjectsUsersInviteCreateRequestBody.md

@@ -7,5 +7,5 @@
 | **email** | **String** | Email address to which the invitation will be sent. Must be a valid email address. | [optional] |
 | **first_name** | **String** | First name of the person who will receive the invitation. The name will be used in the user profile. | [optional] |
 | **last_name** | **String** | Last name of the person who will receive the invitation. The name will be used in the user profile. | [optional] |
-| **projects** | **Hash<String, String>** | In the key, provide the project ID to which the new user will be assigned. In the value, provide the role which the user will have in the project. The predefined Voucherify roles are: `ADMIN`, `USER`, `VIEWER`, `MERCHANT`, `USER_RESTRICTED` (for the Areas and Stores, an Enterprise feature). Send a custom role ID (Enterprise feature) to assign a custom role. | [optional] |
+| **projects** | **Hash<String, String>** | In the key, provide the project ID to which the new user will be assigned. In the value, provide the role which the user will have in the project. The predefined Voucherify roles are: `ADMIN`, `USER`, `VIEWER`, `MERCHANT`, `USER_RESTRICTED` (for the Areas and Stores, an Enterprise feature). Send a custom role ID (Enterprise feature) to assign a custom role. To find the custom role ID: If you are an admin, go to Voucherify Dashboard, Team settings, and Roles tab. Click on a custom role. The custom role ID is in the URL in the format `role_XyZ7aB9cD2eF4gH1iJ0kL5mN6oP8qR3s`. | [optional] |
 

data/docs/ManagementProjectsUsersUpdateRoleRequestBody.md

@@ -4,5 +4,5 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **role** | **String** | The role of the user to be added. It can be a custom role or one of following predefined roles: `ADMIN`, `USER`, `VIEWER`, `MERCHANT` or an ID of a custom role.. | [optional] |
+| **role** | **String** | The role of the user to be added. It can be a custom role or one of following predefined roles: - `ADMIN`, `USER`, `VIEWER`, `MERCHANT` - or an ID of a custom role. | [optional] |
 

data/docs/MetadataSchemasApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://api.voucherify.io*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**get_metadata_schema**](MetadataSchemasApi.md#get_metadata_schema) | **GET** /v1/metadata-schemas/{resource} | Get Metadata Schema |
-| [**list_metadata_schemas**](MetadataSchemasApi.md#list_metadata_schemas) | **GET** /v1/metadata-schemas | List Metadata Schemas |
+| [**list_metadata_schemas**](MetadataSchemasApi.md#list_metadata_schemas) | **GET** /v1/metadata-schemas | List Metadata Schema Definitions |
 
 
 ## get_metadata_schema
@@ -14,7 +14,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Get Metadata Schema
 
-Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](https://support.voucherify.io/article/99-schema-validation-metadata#add-metadata), provide its name in the resource field to retrieve its details. 📘 Management API If you have Management API enabled, you can also use the Get Metadata Schemas endpoint to retrieve a metadata schema using its ID.
+Retrieves a metadata schema per resource type. # Resource types ## Standard You can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter. - campaign - customer - earning_rule - loyalty_tier - order - order_item - product - promotion_tier - publication - redemption - reward - voucher ## Custom If you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the resource field to retrieve its details. 📘 Management API If you have Management API enabled, you can also use the [Get Metadata Schemas](/api-reference/management/get-metadata-schema) endpoint to retrieve a metadata schema using its ID.
 
 ### Examples
 
@@ -70,9 +70,9 @@ end
 
 > <MetadataSchemasListResponseBody> list_metadata_schemas
 
-List Metadata Schemas
+List Metadata Schema Definitions
 
-Retrieve metadata schema definitions. 📘 Management API If you have Management API enabled, you can also use the List Metadata Schemas endpoint to list all metadata schemas.
+Retrieve metadata schema definitions. 📘 Management API If you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas.
 
 ### Examples
 
@@ -95,7 +95,7 @@ end
 api_instance = VoucherifySdk::MetadataSchemasApi.new
 
 begin
-  # List Metadata Schemas
+  # List Metadata Schema Definitions
   result = api_instance.list_metadata_schemas
   p result
 rescue VoucherifySdk::ApiError => e

data/docs/Order.md

@@ -5,11 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
-| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request.  For validation and redemption, if `source_id` is used with an existing order, the original order data will be used, like `items`, `amount`, and so on, not the one sent in the new request. | [optional] |
 | **status** | **String** | The order status. | [optional] |
 | **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
 | **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
-| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
-| **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up 500 items. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
+| **items** | [**Array<OrderItem>**](OrderItem.md) | Array of items applied to the order. It can include up to 500 items. | [optional] |
 | **metadata** | **Object** | A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas. | [optional] |