talon_one 2.2.0 → 2.3.0

data/docs/NewApplication.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
 **campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] 
 **exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] 
+**default_discount_scope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] 
 **enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
 **enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
 **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
@@ -33,6 +34,7 @@ instance = TalonOne::NewApplication.new(name: null,
                                  limits: null,
                                  campaign_priority: null,
                                  exclusive_campaigns_strategy: null,
+                                 default_discount_scope: null,
                                  enable_cascading_discounts: null,
                                  enable_flattened_cart_items: null,
                                  attributes_settings: null,

data/docs/NewCoupons.md

@@ -8,12 +8,12 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The amount of discounts that can be given with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
-**valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | 
-**coupon_pattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | 
 **number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. Must be at least 1. | 
 **unique_prefix** | **String** | A unique prefix to prepend to all generated coupons. | [optional] 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
 **recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional] 
+**valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] 
+**coupon_pattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | [optional] 
 
 ## Code Sample
 
@@ -24,12 +24,12 @@ instance = TalonOne::NewCoupons.new(usage_limit: null,
                                  discount_limit: null,
                                  start_date: null,
                                  expiry_date: null,
-                                 valid_characters: null,
-                                 coupon_pattern: null,
                                  number_of_coupons: null,
                                  unique_prefix: null,
                                  attributes: null,
-                                 recipient_integration_id: null)
+                                 recipient_integration_id: null,
+                                 valid_characters: null,
+                                 coupon_pattern: null)
 ```
 
 

data/docs/NewCouponsForMultipleRecipients.md

@@ -0,0 +1,31 @@
+# TalonOne::NewCouponsForMultipleRecipients
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usage_limit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | 
+**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code.  | [optional] 
+**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
+**expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+**recipients_integration_ids** | **Array<String>** | The integration IDs for recipients | 
+**valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | [optional] 
+**coupon_pattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 attributes: null,
+                                 recipients_integration_ids: null,
+                                 valid_characters: null,
+                                 coupon_pattern: null)
+```
+
+

data/docs/ProfileAudiencesChanges.md

@@ -0,0 +1,19 @@
+# TalonOne::ProfileAudiencesChanges
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**adds** | **Array<Integer>** | The IDs of the audiences for the customer to join. | 
+**deletes** | **Array<Integer>** | The IDs of the audiences for the customer to leave. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ProfileAudiencesChanges.new(adds: null,
+                                 deletes: null)
+```
+
+

data/docs/RejectCouponEffectProps.md

@@ -6,6 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **String** | The coupon code that was rejected | 
 **rejection_reason** | **String** | The reason why this coupon was rejected | 
+**condition_index** | **Integer** | The index of the condition that caused the rejection of the coupon | [optional] 
+**effect_index** | **Integer** | The index of the effect that caused the rejection of the coupon | [optional] 
+**details** | **String** | More details about the failure | [optional] 
 
 ## Code Sample
 
@@ -13,7 +16,10 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::RejectCouponEffectProps.new(value: null,
-                                 rejection_reason: null)
+                                 rejection_reason: null,
+                                 condition_index: null,
+                                 effect_index: null,
+                                 details: null)
 ```
 
 

data/docs/RejectReferralEffectProps.md

@@ -6,6 +6,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **String** | The referral code that was rejected | 
 **rejection_reason** | **String** | The reason why this referral code was rejected | 
+**condition_index** | **Integer** | The index of the condition that caused the rejection of the referral | [optional] 
+**effect_index** | **Integer** | The index of the effect that caused the rejection of the referral | [optional] 
+**details** | **String** | More details about the failure | [optional] 
 
 ## Code Sample
 
@@ -13,7 +16,10 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::RejectReferralEffectProps.new(value: null,
-                                 rejection_reason: null)
+                                 rejection_reason: null,
+                                 condition_index: null,
+                                 effect_index: null,
+                                 details: null)
 ```
 
 

data/docs/RollbackAddedLoyaltyPointsEffectProps.md

@@ -0,0 +1,25 @@
+# TalonOne::RollbackAddedLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**program_id** | **Integer** | The ID of the loyalty program where the points were originally added | 
+**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were originally added | 
+**value** | **Float** | The amount of points that were rolled back | 
+**recipient_integration_id** | **String** | The user for whom these points were originally added | 
+**transaction_uuid** | **String** | The identifier of 'deduction' entry added to the ledger as the `addLoyaltyPoints` effect is rolled back. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RollbackAddedLoyaltyPointsEffectProps.new(program_id: null,
+                                 sub_ledger_id: null,
+                                 value: null,
+                                 recipient_integration_id: null,
+                                 transaction_uuid: null)
+```
+
+

data/docs/RollbackDeductedLoyaltyPointsEffectProps.md

@@ -0,0 +1,29 @@
+# TalonOne::RollbackDeductedLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**program_id** | **Integer** | The ID of the loyalty program where these points were reimbursed | 
+**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were reimbursed | 
+**value** | **Float** | The amount of reimbursed points that were added | 
+**recipient_integration_id** | **String** | The user for whom these points were reimbursed | 
+**start_date** | **DateTime** | Date after which the reimbursed points will be valid | [optional] 
+**expiry_date** | **DateTime** | Date after which the reimbursed points will expire | [optional] 
+**transaction_uuid** | **String** | The identifier of 'addition' entries added to the ledger as the `deductLoyaltyPoints` effect is rolled back | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RollbackDeductedLoyaltyPointsEffectProps.new(program_id: null,
+                                 sub_ledger_id: null,
+                                 value: null,
+                                 recipient_integration_id: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 transaction_uuid: null)
+```
+
+

data/docs/RollbackReferralEffectProps.md

@@ -0,0 +1,17 @@
+# TalonOne::RollbackReferralEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The referral code whose usage has been rolled back | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RollbackReferralEffectProps.new(value: null)
+```
+
+

data/docs/RuleFailureReason.md

@@ -0,0 +1,39 @@
+# TalonOne::RuleFailureReason
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | The ID of the campaign that contains the rule that failed | 
+**campaign_name** | **String** | The name of the campaign that contains the rule that failed | 
+**ruleset_id** | **Integer** | The ID of the ruleset that contains the rule that failed | 
+**coupon_id** | **Integer** | The ID of the coupon that was being evaluated at the time of the rule failure | [optional] 
+**coupon_value** | **String** | The value of the coupon that was being evaluated at the time of the rule failure | [optional] 
+**referral_id** | **Integer** | The ID of the referral that was being evaluated at the time of the rule failure | [optional] 
+**referral_value** | **String** | The value of the referral that was being evaluated at the time of the rule failure | [optional] 
+**rule_index** | **Integer** | The index of the rule that failed within the ruleset | 
+**rule_name** | **String** | The name of the rule that failed within the ruleset | 
+**condition_index** | **Integer** | The index of the condition that failed | [optional] 
+**effect_index** | **Integer** | The index of the effect that failed | [optional] 
+**details** | **String** | More details about the failure | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RuleFailureReason.new(campaign_id: null,
+                                 campaign_name: null,
+                                 ruleset_id: null,
+                                 coupon_id: null,
+                                 coupon_value: null,
+                                 referral_id: null,
+                                 referral_value: null,
+                                 rule_index: null,
+                                 rule_name: null,
+                                 condition_index: null,
+                                 effect_index: null,
+                                 details: null)
+```
+
+

data/docs/UpdateApplication.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
 **campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] 
 **exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] 
+**default_discount_scope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] 
 **enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
 **enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
 **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
@@ -32,6 +33,7 @@ instance = TalonOne::UpdateApplication.new(name: null,
                                  limits: null,
                                  campaign_priority: null,
                                  exclusive_campaigns_strategy: null,
+                                 default_discount_scope: null,
                                  enable_cascading_discounts: null,
                                  enable_flattened_cart_items: null,
                                  attributes_settings: null,

data/lib/talon_one.rb

@@ -58,7 +58,6 @@ require 'talon_one/models/campaign_set_branch_node'
 require 'talon_one/models/campaign_set_leaf_node'
 require 'talon_one/models/campaign_set_node'
 require 'talon_one/models/cart_item'
-require 'talon_one/models/cart_item_adjustment'
 require 'talon_one/models/change'
 require 'talon_one/models/change_profile_password'
 require 'talon_one/models/code_generator_settings'
@@ -100,7 +99,6 @@ require 'talon_one/models/feed_notification'
 require 'talon_one/models/func_arg_def'
 require 'talon_one/models/function_def'
 require 'talon_one/models/import'
-require 'talon_one/models/import_coupons'
 require 'talon_one/models/inline_response200'
 require 'talon_one/models/inline_response2001'
 require 'talon_one/models/inline_response20010'
@@ -170,13 +168,13 @@ require 'talon_one/models/new_campaign'
 require 'talon_one/models/new_campaign_group'
 require 'talon_one/models/new_campaign_set'
 require 'talon_one/models/new_coupons'
+require 'talon_one/models/new_coupons_for_multiple_recipients'
 require 'talon_one/models/new_customer_profile'
 require 'talon_one/models/new_customer_session'
 require 'talon_one/models/new_customer_session_v2'
 require 'talon_one/models/new_event'
 require 'talon_one/models/new_event_type'
 require 'talon_one/models/new_feature_flags'
-require 'talon_one/models/new_import'
 require 'talon_one/models/new_invitation'
 require 'talon_one/models/new_invite_email'
 require 'talon_one/models/new_loyalty_program'
@@ -190,6 +188,7 @@ require 'talon_one/models/new_template_def'
 require 'talon_one/models/new_user'
 require 'talon_one/models/new_webhook'
 require 'talon_one/models/notification'
+require 'talon_one/models/profile_audiences_changes'
 require 'talon_one/models/redeem_referral_effect_props'
 require 'talon_one/models/referral'
 require 'talon_one/models/referral_created_effect_props'
@@ -199,9 +198,13 @@ require 'talon_one/models/reject_referral_effect_props'
 require 'talon_one/models/role'
 require 'talon_one/models/role_assign'
 require 'talon_one/models/role_membership'
+require 'talon_one/models/rollback_added_loyalty_points_effect_props'
 require 'talon_one/models/rollback_coupon_effect_props'
+require 'talon_one/models/rollback_deducted_loyalty_points_effect_props'
 require 'talon_one/models/rollback_discount_effect_props'
+require 'talon_one/models/rollback_referral_effect_props'
 require 'talon_one/models/rule'
+require 'talon_one/models/rule_failure_reason'
 require 'talon_one/models/ruleset'
 require 'talon_one/models/saml_connection'
 require 'talon_one/models/saml_connection_metadata'

data/lib/talon_one/api/integration_api.rb

@@ -221,7 +221,7 @@ module TalonOne
       return data, status_code, headers
     end
 
-    # Delete the personal data of a customer.
+    # Delete the personal data of a customer
     # Delete all attributes on the customer profile and on entities that reference that customer profile. 
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param [Hash] opts the optional parameters
@@ -231,7 +231,7 @@ module TalonOne
       nil
     end
 
-    # Delete the personal data of a customer.
+    # Delete the personal data of a customer
     # Delete all attributes on the customer profile and on entities that reference that customer profile. 
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param [Hash] opts the optional parameters
@@ -281,7 +281,7 @@ module TalonOne
       return data, status_code, headers
     end
 
-    # Get an inventory of all data associated with a specific customer profile.
+    # Get an inventory of all data associated with a specific customer profile
     # Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param [Hash] opts the optional parameters
@@ -295,7 +295,7 @@ module TalonOne
       data
     end
 
-    # Get an inventory of all data associated with a specific customer profile.
+    # Get an inventory of all data associated with a specific customer profile
     # Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param [Hash] opts the optional parameters
@@ -421,7 +421,7 @@ module TalonOne
     # Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information.  The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned.  As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. 
     # @param body [NewEvent] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
     # @return [IntegrationState]
     def track_event(body, opts = {})
       data, _status_code, _headers = track_event_with_http_info(body, opts)
@@ -432,7 +432,7 @@ module TalonOne
     # Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information.  The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned.  As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. 
     # @param body [NewEvent] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
     # @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
     def track_event_with_http_info(body, opts = {})
       if @api_client.config.debugging
@@ -485,11 +485,11 @@ module TalonOne
     end
 
     # Update a Customer Profile V1
-    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][].  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
+    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][].  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param body [NewCustomerProfile] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [IntegrationState]
     def update_customer_profile(integration_id, body, opts = {})
       data, _status_code, _headers = update_customer_profile_with_http_info(integration_id, body, opts)
@@ -497,11 +497,11 @@ module TalonOne
     end
 
     # Update a Customer Profile V1
-    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][].  The &#x60;integrationId&#x60; may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;t** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
+    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][].  The &#x60;integrationId&#x60; may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;t** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
     # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
     # @param body [NewCustomerProfile] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
     def update_customer_profile_with_http_info(integration_id, body, opts = {})
       if @api_client.config.debugging
@@ -620,12 +620,12 @@ module TalonOne
     end
 
     # Update a Customer Profile
-    # Update (or create) a [Customer Profile][].  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  [Customer Profile]: /Getting-Started/entities#customer-profile 
-    # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
+    # Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile).  The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes:  - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. 
+    # @param integration_id [String] The custom identifier for this profile. Must be unique within the account.
     # @param body [CustomerProfileIntegrationRequestV2] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :run_rule_engine Flag to indicate whether to run the rule engine (Defaults to false).
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;. Only used when &#39;runRuleEngine&#39; is set to &#39;true&#39;).
+    # @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine. (default to false)
+    # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are persisted with &#x60;true&#x60;. Only used when &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;. 
     # @return [IntegrationStateV2]
     def update_customer_profile_v2(integration_id, body, opts = {})
       data, _status_code, _headers = update_customer_profile_v2_with_http_info(integration_id, body, opts)
@@ -633,12 +633,12 @@ module TalonOne
     end
 
     # Update a Customer Profile
-    # Update (or create) a [Customer Profile][].  The &#x60;integrationId&#x60; may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;t** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  [Customer Profile]: /Getting-Started/entities#customer-profile 
-    # @param integration_id [String] The custom identifier for this profile, must be unique within the account.
+    # Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile).  The &#x60;integrationId&#x60; must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Updating a customer profile returns a response with the requested integration state. If &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;, the response includes:  - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the &#x60;responseContent&#x60; request parameter. 
+    # @param integration_id [String] The custom identifier for this profile. Must be unique within the account.
     # @param body [CustomerProfileIntegrationRequestV2] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :run_rule_engine Flag to indicate whether to run the rule engine (Defaults to false).
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;. Only used when &#39;runRuleEngine&#39; is set to &#39;true&#39;).
+    # @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine.
+    # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are persisted with &#x60;true&#x60;. Only used when &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;. 
     # @return [Array<(IntegrationStateV2, Integer, Hash)>] IntegrationStateV2 data, response status code and response headers
     def update_customer_profile_v2_with_http_info(integration_id, body, opts = {})
       if @api_client.config.debugging
@@ -696,10 +696,10 @@ module TalonOne
     end
 
     # Update multiple Customer Profiles
-    # Update (or create) up to 1000 [Customer Profiles][] in 1 request.  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  [Customer Profiles]: /Getting-Started/entities#customer-profile 
+    # Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request.  The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2). 
     # @param body [MultipleCustomerProfileIntegrationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :silent If set to &#39;yes&#39;, response will be an empty 204, otherwise a list of the IntegrationStateV2  generated.
+    # @option opts [String] :silent If set to &#x60;yes&#x60;, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
     # @return [MultipleCustomerProfileIntegrationResponseV2]
     def update_customer_profiles_v2(body, opts = {})
       data, _status_code, _headers = update_customer_profiles_v2_with_http_info(body, opts)
@@ -707,10 +707,10 @@ module TalonOne
     end
 
     # Update multiple Customer Profiles
-    # Update (or create) up to 1000 [Customer Profiles][] in 1 request.  The &#x60;integrationId&#x60; may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the &#x60;integrationId&#x60;. It is vital that this ID **not** change over time, so **don&#39;t** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  [Customer Profiles]: /Getting-Started/entities#customer-profile 
+    # Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request.  The &#x60;integrationId&#x60; must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2). 
     # @param body [MultipleCustomerProfileIntegrationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :silent If set to &#39;yes&#39;, response will be an empty 204, otherwise a list of the IntegrationStateV2  generated.
+    # @option opts [String] :silent If set to &#x60;yes&#x60;, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
     # @return [Array<(MultipleCustomerProfileIntegrationResponseV2, Integer, Hash)>] MultipleCustomerProfileIntegrationResponseV2 data, response status code and response headers
     def update_customer_profiles_v2_with_http_info(body, opts = {})
       if @api_client.config.debugging
@@ -763,11 +763,11 @@ module TalonOne
     end
 
     # Update a Customer Session V1
-    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's.  The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2).  Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart.  The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either:  - Track multiple independent sessions or, - Use the same session across all of them.  You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's.  To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically.  Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. 
     # @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
     # @param body [NewCustomerSession] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [IntegrationState]
     def update_customer_session(customer_session_id, body, opts = {})
       data, _status_code, _headers = update_customer_session_with_http_info(customer_session_id, body, opts)
@@ -775,11 +775,11 @@ module TalonOne
     end
 
     # Update a Customer Session V1
-    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, please migrate to [API V2.0](/Getting-Started/APIV2).  Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID&#39;s.  The &#x60;profileId&#x60; parameter in the request body should correspond to an &#x60;integrationId&#x60; for a customer profile, to track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+    # ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2).  Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer&#39;s cart.  The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either:  - Track multiple independent sessions or, - Use the same session across all of them.  You should share sessions when application access points share other state, such as the user&#39;s cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID&#39;s.  To link a session to a customer profile, set the &#x60;profileId&#x60; parameter in the request body to a customer profile&#39;s &#x60;integrationId&#x60;. To track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically.  Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. 
     # @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
     # @param body [NewCustomerSession] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [Array<(IntegrationState, Integer, Hash)>] IntegrationState data, response status code and response headers
     def update_customer_session_with_http_info(customer_session_id, body, opts = {})
       if @api_client.config.debugging
@@ -836,11 +836,11 @@ module TalonOne
     end
 
     # Update a Customer Session
-    # Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's.  The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\".  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+    # Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart.  The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either:  - Track multiple independent sessions or, - Use the same session across all of them.  You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's.  To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically.  Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes:  - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. 
     # @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
     # @param body [IntegrationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [IntegrationStateV2]
     def update_customer_session_v2(customer_session_id, body, opts = {})
       data, _status_code, _headers = update_customer_session_v2_with_http_info(customer_session_id, body, opts)
@@ -848,11 +848,11 @@ module TalonOne
     end
 
     # Update a Customer Session
-    # Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID&#39;s.  The &#x60;profileId&#x60; parameter in the request body should correspond to an &#x60;integrationId&#x60; for a customer profile, to track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \&quot;responseContent\&quot;.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+    # Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer&#39;s cart.  The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either:  - Track multiple independent sessions or, - Use the same session across all of them.  You should share sessions when application access points share other state, such as the user&#39;s cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID&#39;s.  To link a session to a customer profile, set the &#x60;profileId&#x60; parameter in the request body to a customer profile&#39;s &#x60;integrationId&#x60;. To track an anonymous session use the empty string (&#x60;\&quot;\&quot;&#x60;) as the &#x60;profileId&#x60;. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically.  Updating a customer session returns a response with the requested integration state. If &#x60;runRuleEngine&#x60; is set to &#x60;true&#x60;, the response includes:  - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the &#x60;responseContent&#x60; request parameter.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated. 
     # @param customer_session_id [String] The custom identifier for this session, must be unique within the account.
     # @param body [IntegrationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
+    # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to &#39;true&#39;).
     # @return [Array<(IntegrationStateV2, Integer, Hash)>] IntegrationStateV2 data, response status code and response headers
     def update_customer_session_v2_with_http_info(customer_session_id, body, opts = {})
       if @api_client.config.debugging