voucherify 8.0.3 → 8.1.1

data/lib/VoucherifySdk/api/referrals_api.rb

@@ -20,7 +20,7 @@ module VoucherifySdk
       @api_client = api_client
     end
     # Add Referral Code Holders
-    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referer, use the Create Publication endpoint.  📘 Alternative endpoint This endpoint is an alternative to the Add Referral Code Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) <Tip> To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. </Tip> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to the [Add Referral Code Holders endpoint](/api-reference/referrals/add-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. </Note>
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [ReferralsMembersHoldersCreateInBulkRequestBody] :referrals_members_holders_create_in_bulk_request_body Specify the customer data to be upserted as redeemable holders.
@@ -31,7 +31,7 @@ module VoucherifySdk
     end
 
     # Add Referral Code Holders
-    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referer, use the Create Publication endpoint.  📘 Alternative endpoint This endpoint is an alternative to the Add Referral Code Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) &lt;Tip&gt; To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. &lt;/Tip&gt; &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to the [Add Referral Code Holders endpoint](/api-reference/referrals/add-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. &lt;/Note&gt;
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [ReferralsMembersHoldersCreateInBulkRequestBody] :referrals_members_holders_create_in_bulk_request_body Specify the customer data to be upserted as redeemable holders.
@@ -85,8 +85,8 @@ module VoucherifySdk
       return data, status_code, headers
     end
 
-    # Add Referral Code Holders
-    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referer, use the Create Publication endpoint.
+    # Add Referral Code Holders with Campaign ID
+    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) <Tip> To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. </Tip>
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
@@ -97,8 +97,8 @@ module VoucherifySdk
       data
     end
 
-    # Add Referral Code Holders
-    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referer, use the Create Publication endpoint.
+    # Add Referral Code Holders with Campaign ID
+    # Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) &lt;Tip&gt; To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. &lt;/Tip&gt;
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
@@ -153,7 +153,7 @@ module VoucherifySdk
       return data, status_code, headers
     end
 
-    # List Referral Code Holders
+    # List Referral Code Holders with campaign ID
     # Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.
@@ -168,7 +168,7 @@ module VoucherifySdk
       data
     end
 
-    # List Referral Code Holders
+    # List Referral Code Holders with campaign ID
     # Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.
@@ -227,7 +227,7 @@ module VoucherifySdk
     end
 
     # List Referral Code Holders
-    # Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)  📘 Alternative endpoint This endpoint is an alternative to the List Member Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read) <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. </Note>
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
@@ -241,7 +241,7 @@ module VoucherifySdk
     end
 
     # List Referral Code Holders
-    # Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)  📘 Alternative endpoint This endpoint is an alternative to the List Member Holders endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read) &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. &lt;/Note&gt;
     # @param member_id [String] Unique referral code or its identifier.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
@@ -298,7 +298,7 @@ module VoucherifySdk
     end
 
     # Remove Referral Card Holder
-    # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  📘 Alternative endpoint This endpoint is an alternative to the Remove Referral Card Holder endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to the [Remove Referral Card Holder endpoint](/api-reference/referrals/remove-referral-card-holder-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. </Note>
     # @param member_id [String] Unique referral code or its identifier.
     # @param holder_id [String] Unique identifier of a redeemable holder.
     # @param [Hash] opts the optional parameters
@@ -309,7 +309,7 @@ module VoucherifySdk
     end
 
     # Remove Referral Card Holder
-    # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  📘 Alternative endpoint This endpoint is an alternative to the Remove Referral Card Holder endpoint. The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+    # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish) &lt;Note&gt; &lt;Badge color blue&gt;Alternative endpoint&lt;/Badge&gt; This endpoint is an alternative to the [Remove Referral Card Holder endpoint](/api-reference/referrals/remove-referral-card-holder-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter. &lt;/Note&gt;
     # @param member_id [String] Unique referral code or its identifier.
     # @param holder_id [String] Unique identifier of a redeemable holder.
     # @param [Hash] opts the optional parameters
@@ -356,7 +356,7 @@ module VoucherifySdk
       return data, status_code, headers
     end
 
-    # Remove Referral Card Holder
+    # Remove Referral Card Holder with campaign ID
     # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.
@@ -368,7 +368,7 @@ module VoucherifySdk
       nil
     end
 
-    # Remove Referral Card Holder
+    # Remove Referral Card Holder with campaign ID
     # Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)
     # @param campaign_id [String] Unique identifier of a referral program campaign.
     # @param member_id [String] Unique referral code or its identifier.

data/lib/VoucherifySdk/api/segments_api.rb

@@ -20,7 +20,7 @@ module VoucherifySdk
       @api_client = api_client
     end
     # Create Segment
-    # Create a customer segment.  🚧 Limit on Static Segments  There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.
+    # Create a customer segment. <Warning> <Badge color yellow>Limit on static segments</Badge> There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. </Warning> <Warning> <Badge color yellow>Limit on Active and Passive segments</Badge> You can create a maximum of 100 passive and active segments. </Warning>
     # @param [Hash] opts the optional parameters
     # @option opts [SegmentsCreateRequestBody] :segments_create_request_body Specify the boundary conditions for the customer segment.
     # @return [SegmentsCreateResponseBody]
@@ -30,7 +30,7 @@ module VoucherifySdk
     end
 
     # Create Segment
-    # Create a customer segment.  🚧 Limit on Static Segments  There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.
+    # Create a customer segment. &lt;Warning&gt; &lt;Badge color yellow&gt;Limit on static segments&lt;/Badge&gt; There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. &lt;/Warning&gt; &lt;Warning&gt; &lt;Badge color yellow&gt;Limit on Active and Passive segments&lt;/Badge&gt; You can create a maximum of 100 passive and active segments. &lt;/Warning&gt;
     # @param [Hash] opts the optional parameters
     # @option opts [SegmentsCreateRequestBody] :segments_create_request_body Specify the boundary conditions for the customer segment.
     # @return [Array<(SegmentsCreateResponseBody, Integer, Hash)>] SegmentsCreateResponseBody data, response status code and response headers
@@ -141,7 +141,7 @@ module VoucherifySdk
     end
 
     # Get Segment
-    # Retrieves the segment with given segment ID.
+    # Retrieves the segment with a given segment ID. This method doesnt return the customers that belong to the segment. To return a list of customers who belong to a segment, use [GET List customers](/api-reference/customers/list-customers) endpoint with the segment_id query parameter.
     # @param segment_id [String] A unique customer segment ID.
     # @param [Hash] opts the optional parameters
     # @return [SegmentsGetResponseBody]
@@ -151,7 +151,7 @@ module VoucherifySdk
     end
 
     # Get Segment
-    # Retrieves the segment with given segment ID.
+    # Retrieves the segment with a given segment ID. This method doesnt return the customers that belong to the segment. To return a list of customers who belong to a segment, use [GET List customers](/api-reference/customers/list-customers) endpoint with the segment_id query parameter.
     # @param segment_id [String] A unique customer segment ID.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SegmentsGetResponseBody, Integer, Hash)>] SegmentsGetResponseBody data, response status code and response headers

data/lib/VoucherifySdk/api/templates_api.rb

@@ -20,7 +20,7 @@ module VoucherifySdk
       @api_client = api_client
     end
     # Add Promotion Tier From Template
-    # Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule.  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsTierSetupCreateRequestBody] :templates_campaigns_tier_setup_create_request_body Only name and campaign_id are required. The rest of the fields will overwrite the template configuration.
@@ -31,7 +31,7 @@ module VoucherifySdk
     end
 
     # Add Promotion Tier From Template
-    # Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule.  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment). &lt;Tip&gt; &lt;Badge color green&gt;Promotion Tiers and Campaign Templates&lt;/Badge&gt; You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) &lt;/Tip&gt; &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsTierSetupCreateRequestBody] :templates_campaigns_tier_setup_create_request_body Only name and campaign_id are required. The rest of the fields will overwrite the template configuration.
@@ -86,7 +86,7 @@ module VoucherifySdk
     end
 
     # Create Campaign From Template
-    # Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule.  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments). <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsCampaignSetupCreateRequestBody] :templates_campaigns_campaign_setup_create_request_body Only name is required. The rest of the fields will overwrite the template configuration.
@@ -97,7 +97,7 @@ module VoucherifySdk
     end
 
     # Create Campaign From Template
-    # Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - Update the validation rule, - Unassign the validation rule, - Assign an existing validation rule.  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign - Promotion tier  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments). &lt;Tip&gt; &lt;Badge color green&gt;Promotion Tiers and Campaign Templates&lt;/Badge&gt; You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template) &lt;/Tip&gt; &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsCampaignSetupCreateRequestBody] :templates_campaigns_campaign_setup_create_request_body Only name is required. The rest of the fields will overwrite the template configuration.
@@ -152,7 +152,7 @@ module VoucherifySdk
     end
 
     # Create Campaign Template
-    # Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign, - Promotion tier.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments <Tip> <Badge color green>Promotion Tiers and Campaign Templates</Badge> You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). </Tip> <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsCreateRequestBody] :templates_campaigns_create_request_body Provide details for a campaign template
     # @return [TemplatesCampaignsCreateTemplateResponseBody]
@@ -162,7 +162,7 @@ module VoucherifySdk
     end
 
     # Create Campaign Template
-    # Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - Discount campaign, - Promotion tier.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments &lt;Tip&gt; &lt;Badge color green&gt;Promotion Tiers and Campaign Templates&lt;/Badge&gt; You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template). &lt;/Tip&gt; &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsCreateRequestBody] :templates_campaigns_create_request_body Provide details for a campaign template
     # @return [Array<(TemplatesCampaignsCreateTemplateResponseBody, Integer, Hash)>] TemplatesCampaignsCreateTemplateResponseBody data, response status code and response headers
@@ -216,7 +216,7 @@ module VoucherifySdk
     end
 
     # Delete Campaign Template
-    # Deletes the campaign template permanently.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Deletes the campaign template permanently. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -226,7 +226,7 @@ module VoucherifySdk
     end
 
     # Delete Campaign Template
-    # Deletes the campaign template permanently.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Deletes the campaign template permanently. &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -273,7 +273,7 @@ module VoucherifySdk
     end
 
     # Get Campaign Template
-    # Retrieves a campaign template available in the project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Retrieves a campaign template available in the project. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @return [TemplatesCampaignsGetResponseBody]
@@ -283,7 +283,7 @@ module VoucherifySdk
     end
 
     # Get Campaign Template
-    # Retrieves a campaign template available in the project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Retrieves a campaign template available in the project. &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplatesCampaignsGetResponseBody, Integer, Hash)>] TemplatesCampaignsGetResponseBody data, response status code and response headers
@@ -332,7 +332,7 @@ module VoucherifySdk
     end
 
     # List Campaign Templates
-    # Lists all campaign templates available in the project.  📘 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. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
     # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
@@ -346,7 +346,7 @@ module VoucherifySdk
     end
 
     # List Campaign Templates
-    # Lists all campaign templates available in the project.  📘 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. &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
     # @option opts [String] :starting_after_id A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
@@ -404,7 +404,7 @@ module VoucherifySdk
     end
 
     # Update Campaign Template
-    # Updates the name or description of the campaign template.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Updates the name or description of the campaign template. <Note> <Badge color blue>Campaign Templates – Documentation</Badge> Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. </Note>
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsUpdateRequestBody] :templates_campaigns_update_request_body Provide the new name or description for the campaign template
@@ -415,7 +415,7 @@ module VoucherifySdk
     end
 
     # Update Campaign Template
-    # Updates the name or description of the campaign template.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+    # Updates the name or description of the campaign template. &lt;Note&gt; &lt;Badge color blue&gt;Campaign Templates – Documentation&lt;/Badge&gt; Read the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature. &lt;/Note&gt;
     # @param campaign_template_id [String] Pass the campaign template ID that was assigned by Voucherify.
     # @param [Hash] opts the optional parameters
     # @option opts [TemplatesCampaignsUpdateRequestBody] :templates_campaigns_update_request_body Provide the new name or description for the campaign template

data/lib/VoucherifySdk/api/validation_rules_api.rb

@@ -89,7 +89,7 @@ module VoucherifySdk
     end
 
     # Create Validation Rules
-    # Create validation rules.
+    # Create a validation rule. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationRulesCreateRequestBody] :validation_rules_create_request_body Specify the validation rules parameters.
     # @return [ValidationRulesCreateResponseBody]
@@ -99,7 +99,7 @@ module VoucherifySdk
     end
 
     # Create Validation Rules
-    # Create validation rules.
+    # Create a validation rule. &lt;Warning&gt; &lt;Badge color yellow&gt;Managing validation rules&lt;/Badge&gt; It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. &lt;/Warning&gt;
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationRulesCreateRequestBody] :validation_rules_create_request_body Specify the validation rules parameters.
     # @return [Array<(ValidationRulesCreateResponseBody, Integer, Hash)>] ValidationRulesCreateResponseBody data, response status code and response headers
@@ -468,7 +468,7 @@ module VoucherifySdk
     end
 
     # List Validation Rules' Assignment(s)
-    # List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.  # How to retrieve specific validation rule assignments(s) ## Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier.    ## Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule.  
+    # List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :related_object_id The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution.
     # @option opts [String] :rule Validation rule ID.
@@ -482,7 +482,7 @@ module VoucherifySdk
     end
 
     # List Validation Rules&#39; Assignment(s)
-    # List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.  # How to retrieve specific validation rule assignments(s) ## Related object ID To find an assignment for a particular resource, you can use the ID of the object to which the validation rule was assigned. This could be, for example, an ID of a: voucher, campaign, distribution, reward assignment, earning rule, promotion tier.    ## Validation rule ID You can use the validation rule ID to find assignment(s) for a specific validation rule.  
+    # List all validation rules assignments or filter the results using the related object ID or the validation rule ID query parameters.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :related_object_id The resource ID to which the validation rule was assigned; this could be, for example, a resource ID of a voucher, campaign, earning rule, reward assignment, promotion tier, or distribution.
     # @option opts [String] :rule Validation rule ID.
@@ -540,7 +540,7 @@ module VoucherifySdk
     end
 
     # Update Validation Rule
-    # Update validation rule parameters.
+    # Update validation rule parameters. <Warning> <Badge color yellow>Managing validation rules</Badge> It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. </Warning>
     # @param validation_rule_id [String] A unique validation rule ID.
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationRulesUpdateRequestBody] :validation_rules_update_request_body Specify the parameters to be updated.
@@ -551,7 +551,7 @@ module VoucherifySdk
     end
 
     # Update Validation Rule
-    # Update validation rule parameters.
+    # Update validation rule parameters. &lt;Warning&gt; &lt;Badge color yellow&gt;Managing validation rules&lt;/Badge&gt; It is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules. &lt;/Warning&gt;
     # @param validation_rule_id [String] A unique validation rule ID.
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationRulesUpdateRequestBody] :validation_rules_update_request_body Specify the parameters to be updated.

data/lib/VoucherifySdk/api/validations_api.rb

@@ -20,7 +20,7 @@ module VoucherifySdk
       @api_client = api_client
     end
     # Validate Stackable Discounts
-    # Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys.
+    # Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint.
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationsValidateRequestBody] :validations_validate_request_body 
     # @return [ValidationsValidateResponseBody]
@@ -30,7 +30,7 @@ module VoucherifySdk
     end
 
     # Validate Stackable Discounts
-    # Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys.
+    # Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys. API keys with a Merchant role cant use this endpoint.
     # @param [Hash] opts the optional parameters
     # @option opts [ValidationsValidateRequestBody] :validations_validate_request_body 
     # @return [Array<(ValidationsValidateResponseBody, Integer, Hash)>] ValidationsValidateResponseBody data, response status code and response headers