talon_one 9.0.0 → 10.0.0

data/docs/ModelReturn.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 

data/docs/MultipleAudiencesItem.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **name** | **String** | The human-friendly display name for this audience. | 
 **integration_id** | **String** | The ID of this audience in the third-party integration. | 

data/docs/NewPriceAdjustment.md

@@ -0,0 +1,27 @@
+# TalonOne::NewPriceAdjustment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_type** | **String** | The price type (e.g. the price for members only) to apply to a given SKU. | 
+**price** | **Float** | The value of the price type applied to the SKU. When set to `null`, the defined price type no longer applies to the SKU. | [optional] 
+**reference_id** | **String** | A unique reference identifier, e.g. a UUID. | 
+**calculated_at** | **DateTime** | The time at which this price was calculated. If provided, this is used to determine the most recent price adjustment to choose if price adjustments overlap. Defaults to internal creation time if not provided. | [optional] 
+**effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional] 
+**effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewPriceAdjustment.new(price_type: member,
+                                 price: 100.0,
+                                 reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
+                                 calculated_at: 2021-09-12T10:12:42Z,
+                                 effective_from: 2021-09-12T10:12:42Z,
+                                 effective_until: 2021-09-12T10:12:42Z)
+```
+
+

data/docs/NewPriceType.md

@@ -0,0 +1,23 @@
+# TalonOne::NewPriceType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The API name of the price type. This is an immutable value. | 
+**title** | **String** | The title of the price type. | 
+**description** | **String** | The description of the price type. | [optional] 
+**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences that are targeted by this price type. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewPriceType.new(name: member,
+                                 title: Member Price,
+                                 description: Price available exclusively to members.,
+                                 targeted_audiences_ids: [1, 2, 3])
+```
+
+

data/docs/NewWebhook.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`.  | 
 **title** | **String** | Name or title for this webhook. | 
 **description** | **String** | A description of the webhook. | [optional] 
+**draft** | **Boolean** | Indicates if the webhook is a draft. | 
 **verb** | **String** | API method for this webhook. | 
 **url** | **String** | API URL (supports templating using parameters) for this webhook. | 
 **headers** | **Array<String>** | List of API HTTP headers for this webhook. | 
@@ -22,6 +23,7 @@ require 'TalonOne'
 instance = TalonOne::NewWebhook.new(application_ids: null,
                                  title: Send message,
                                  description: A webhook to send a coupon to the user.,
+                                 draft: false,
                                  verb: POST,
                                  url: www.my-company.com/my-endpoint-name,
                                  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],

data/docs/Picklist.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **type** | **String** | The type of allowed values in the picklist. If the type `time` is chosen, it must be an RFC3339 timestamp string. | 
 **values** | **Array<String>** | The list of allowed values provided by this picklist. | 

data/docs/PriceDetail.md

@@ -0,0 +1,23 @@
+# TalonOne::PriceDetail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price** | **Float** | The value of this price type. | [optional] 
+**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. | [optional] 
+**adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. | [optional] 
+**adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::PriceDetail.new(price: 90.0,
+                                 adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
+                                 adjustment_effective_from: 2025-05-25T00:00Z,
+                                 adjustment_effective_until: 2025-05-30T00:00Z)
+```
+
+

data/docs/PriceType.md

@@ -0,0 +1,33 @@
+# TalonOne::PriceType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**account_id** | **Integer** | The ID of the account that owns this price type. | [optional] 
+**name** | **String** | The API name of the price type. This is an immutable value. | 
+**title** | **String** | The title of the price type. | 
+**description** | **String** | The description of the price type. | [optional] 
+**modified** | **DateTime** | The date and time when the price type was last modified. | 
+**subscribed_catalogs_ids** | **Array<Integer>** | A list of the IDs of the catalogs that are subscribed to this price type. | 
+**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences that are targeted by this price type. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::PriceType.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 account_id: 1,
+                                 name: member,
+                                 title: Member Price,
+                                 description: Price available exclusively to members.,
+                                 modified: 2021-09-12T10:12:42Z,
+                                 subscribed_catalogs_ids: [1, 2, 3],
+                                 targeted_audiences_ids: [1, 2, 3])
+```
+
+

data/docs/Referral.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 

data/docs/RevisionActivationRequest.md

@@ -0,0 +1,19 @@
+# TalonOne::RevisionActivationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_ids** | **Array<Integer>** | The list of IDs of the users who will receive the activation request. | 
+**activate_at** | **DateTime** | Time when the revisions are finalized after the `activate_revision` operation. The current time is used when left blank.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RevisionActivationRequest.new(user_ids: [1, 2, 3],
+                                 activate_at: null)
+```
+
+

data/docs/Role.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 

data/docs/RoleV2.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 

data/docs/Ruleset.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 
 **rules** | [**Array<Rule>**](Rule.md) | Set of rules to apply. | 

data/docs/SamlConnection.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **sign_out_url** | **String** | Single Sign-Out URL. | [optional] 
 **metadata_url** | **String** | Metadata URL. | [optional] 
 **audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.  | 
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 
 ## Code Sample

data/docs/ScimBaseGroup.md

@@ -0,0 +1,19 @@
+# TalonOne::ScimBaseGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | Display name of the group (Talon.One role). | [optional] 
+**members** | [**Array<ScimGroupMember>**](ScimGroupMember.md) | List of members to assign to the new Talon.One role. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ScimBaseGroup.new(display_name: Manager,
+                                 members: null)
+```
+
+

data/docs/ScimGroup.md

@@ -0,0 +1,21 @@
+# TalonOne::ScimGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | Display name of the group (Talon.One role). | [optional] 
+**members** | [**Array<ScimGroupMember>**](ScimGroupMember.md) | List of members to assign to the new Talon.One role. | [optional] 
+**id** | **String** | ID of the group. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ScimGroup.new(display_name: Manager,
+                                 members: null,
+                                 id: 359)
+```
+
+

data/docs/ScimGroupMember.md

@@ -0,0 +1,19 @@
+# TalonOne::ScimGroupMember
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Unique identifier of the member. | [optional] 
+**display** | **String** | Identifier of the user. This is usually an email address. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ScimGroupMember.new(value: 258,
+                                 display: john.doe@example.com)
+```
+
+

data/docs/ScimGroupsListResponse.md

@@ -0,0 +1,21 @@
+# TalonOne::ScimGroupsListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resources** | [**Array<ScimGroup>**](ScimGroup.md) |  | 
+**schemas** | **Array<String>** | SCIM schema for the given resource. | [optional] 
+**total_results** | **Integer** | Number of results in the response. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ScimGroupsListResponse.new(resources: null,
+                                 schemas: null,
+                                 total_results: null)
+```
+
+

data/docs/Store.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **name** | **String** | The name of the store. | 
 **description** | **String** | The description of the store. | 

data/docs/TemplateDef.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **application_id** | **Integer** | The ID of the Application that owns this entity. | 
 **title** | **String** | Campaigner-friendly name for the template that will be shown in the rule editor. | 

data/docs/UpdateAchievement.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 
 **period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period.  | [optional] 
 **period_end_override** | [**TimePoint**](TimePoint.md) |  | [optional] 
-**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again.  | [optional] 
+**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.  | [optional] 
 **activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.  | [optional] 
 **fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 
 **end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date.  **Note:** It must be an RFC3339 timestamp string.  | [optional] 

data/docs/User.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **email** | **String** | The email address associated with the user profile. | 

data/docs/Webhook.md

@@ -4,12 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`.  | 
 **title** | **String** | Name or title for this webhook. | 
 **description** | **String** | A description of the webhook. | [optional] 
+**draft** | **Boolean** | Indicates if the webhook is a draft. | 
 **verb** | **String** | API method for this webhook. | 
 **url** | **String** | API URL (supports templating using parameters) for this webhook. | 
 **headers** | **Array<String>** | List of API HTTP headers for this webhook. | 
@@ -28,6 +29,7 @@ instance = TalonOne::Webhook.new(id: 6,
                                  application_ids: null,
                                  title: Send message,
                                  description: A webhook to send a coupon to the user.,
+                                 draft: false,
                                  verb: POST,
                                  url: www.my-company.com/my-endpoint-name,
                                  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],

data/docs/WebhookAuthentication.md

@@ -0,0 +1,33 @@
+# TalonOne::WebhookAuthentication
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_by** | **String** | The name of the user who created the webhook authentication. | 
+**modified_by** | **String** | The name of the user who last modified the webhook authentication. | 
+**webhooks** | [**Array<WebhookAuthenticationWebhookRef>**](WebhookAuthenticationWebhookRef.md) |  | 
+**name** | **String** | The name of the webhook authentication. | 
+**type** | **String** |  | 
+**data** | [**Object**](.md) |  | 
+**id** | **Integer** | The internal ID of this entity. | 
+**created** | **DateTime** | The time this entity was created. | 
+**modified** | **DateTime** | The time this entity was last modified. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookAuthentication.new(created_by: null,
+                                 modified_by: null,
+                                 webhooks: null,
+                                 name: My basic auth,
+                                 type: null,
+                                 data: null,
+                                 id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z,
+                                 modified: 2021-09-12T10:12:42Z)
+```
+
+

data/docs/WebhookAuthenticationBase.md

@@ -0,0 +1,21 @@
+# TalonOne::WebhookAuthenticationBase
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the webhook authentication. | 
+**type** | **String** |  | 
+**data** | [**Object**](.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookAuthenticationBase.new(name: My basic auth,
+                                 type: null,
+                                 data: null)
+```
+
+

data/docs/WebhookAuthenticationDataBasic.md

@@ -0,0 +1,19 @@
+# TalonOne::WebhookAuthenticationDataBasic
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | The Basic HTTP username. | 
+**password** | **String** | The Basic HTTP password. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookAuthenticationDataBasic.new(username: null,
+                                 password: null)
+```
+
+

data/docs/WebhookAuthenticationDataCustom.md

@@ -0,0 +1,17 @@
+# TalonOne::WebhookAuthenticationDataCustom
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**headers** | **Hash<String, String>** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookAuthenticationDataCustom.new(headers: null)
+```
+
+

data/docs/WebhookAuthenticationWebhookRef.md

@@ -0,0 +1,21 @@
+# TalonOne::WebhookAuthenticationWebhookRef
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of this entity. | 
+**title** | **String** | The title of the webhook authentication. | 
+**description** | **String** | A description of the webhook authentication. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookAuthenticationWebhookRef.new(id: 6,
+                                 title: Send message,
+                                 description: A webhook to send a coupon to the user.)
+```
+
+

data/docs/WebhookWithOutgoingIntegrationDetails.md

@@ -4,12 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **modified** | **DateTime** | The time this entity was last modified. | 
 **application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`.  | 
 **title** | **String** | Name or title for this webhook. | 
 **description** | **String** | A description of the webhook. | [optional] 
+**draft** | **Boolean** | Indicates if the webhook is a draft. | 
 **verb** | **String** | API method for this webhook. | 
 **url** | **String** | API URL (supports templating using parameters) for this webhook. | 
 **headers** | **Array<String>** | List of API HTTP headers for this webhook. | 
@@ -31,6 +32,7 @@ instance = TalonOne::WebhookWithOutgoingIntegrationDetails.new(id: 6,
                                  application_ids: null,
                                  title: Send message,
                                  description: A webhook to send a coupon to the user.,
+                                 draft: false,
                                  verb: POST,
                                  url: www.my-company.com/my-endpoint-name,
                                  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],

data/lib/talon_one/api/integration_api.rb

@@ -1837,7 +1837,7 @@ module TalonOne
     end
 
     # Track event
-    # Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  <div class=\"redoc-section\">    <p class=\"title\">Important</p>    1. `profileId` is required even though the schema does not say it.   1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).  </div> 
+    # Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  <div class=\"redoc-section\">    <p class=\"title\">Important</p>    1. `profileId` is required even though the schema does not specify it.   1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).   1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.  </div> 
     # @param body [IntegrationEventV2Request] body
     # @param [Hash] opts the optional parameters
     # @option opts [String] :silent Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles.  (default to 'yes')
@@ -1850,7 +1850,7 @@ module TalonOne
     end
 
     # Track event
-    # Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;    &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt;    1. &#x60;profileId&#x60; is required even though the schema does not say it.   1. If the customer profile ID is new, a new profile is automatically created but the &#x60;customer_profile_created&#x60; [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).  &lt;/div&gt; 
+    # Triggers a custom event.  To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager.  Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event.  For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing).  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;    &lt;p class&#x3D;\&quot;title\&quot;&gt;Important&lt;/p&gt;    1. &#x60;profileId&#x60; is required even though the schema does not specify it.   1. If the customer profile ID is new, a new profile is automatically created but the &#x60;customer_profile_created&#x60; [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered.   1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests).   1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation.  &lt;/div&gt; 
     # @param body [IntegrationEventV2Request] body
     # @param [Hash] opts the optional parameters
     # @option opts [String] :silent Possible values: &#x60;yes&#x60; or &#x60;no&#x60;. - &#x60;yes&#x60;: Increases the performance of the API call by returning a 204 response. - &#x60;no&#x60;: Returns a 200 response that contains the updated customer profiles. 
@@ -2114,7 +2114,7 @@ module TalonOne
     end
 
     # Update customer profile
-    # Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer profile returns a response with the requested integration state.   - You can use the `responseContent` property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> 
+    # Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer profile returns a response with the requested integration state.   - You can use the `responseContent` property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> 
     # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
     # @param body [CustomerProfileIntegrationRequestV2] body
     # @param [Hash] opts the optional parameters
@@ -2127,7 +2127,7 @@ module TalonOne
     end
 
     # Update customer profile
-    # Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;   &lt;p class&#x3D;\&quot;title\&quot;&gt;Performance tips&lt;/p&gt;    - Updating a customer profile returns a response with the requested integration state.   - You can use the &#x60;responseContent&#x60; property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). &lt;/div&gt; 
+    # Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder.  You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when &#x60;runRuleEngine&#x60; is &#x60;true&#x60;. &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;   &lt;p class&#x3D;\&quot;title\&quot;&gt;Performance tips&lt;/p&gt;    - Updating a customer profile returns a response with the requested integration state.   - You can use the &#x60;responseContent&#x60; property to save yourself extra API calls. For example, you can get     the customer profile details directly without extra requests.   - We recommend sending requests sequentially.     See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). &lt;/div&gt; 
     # @param integration_id [String] The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
     # @param body [CustomerProfileIntegrationRequestV2] body
     # @param [Hash] opts the optional parameters
@@ -2257,7 +2257,7 @@ module TalonOne
     end
 
     # Update customer session
-    # Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One.  **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
+    # Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One.  **Note:**  - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  <div class=\"redoc-section\">   <p class=\"title\">Performance tips</p>    - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
     # @param customer_session_id [String] The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session.  You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. 
     # @param body [IntegrationRequest] body
     # @param [Hash] opts the optional parameters
@@ -2270,7 +2270,7 @@ module TalonOne
     end
 
     # Update customer session
-    # Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer&#39;s cart with Talon.One.  **Note:** The currency for the session and the cart items in the session is the currency set for the Application that owns this session.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the &#x60;state&#x60; parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - 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;. - While you can create an anonymous session with &#x60;profileId&#x3D;\&quot;\&quot;&#x60;, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;   &lt;p class&#x3D;\&quot;title\&quot;&gt;Performance tips&lt;/p&gt;    - Updating a customer session returns a response with the new integration state. Use the &#x60;responseContent&#x60; property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). &lt;/div&gt;  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
+    # Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer&#39;s cart with Talon.One.  **Note:**  - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation.  ### Session management  To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the &#x60;state&#x60; parameter documentation the request body schema docs below.  ### Sessions and customer profiles  - 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;. - While you can create an anonymous session with &#x60;profileId&#x3D;\&quot;\&quot;&#x60;, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either:   - Use unique session integration IDs or,   - Use the same session integration ID across all of the Applications.  **Note:** If the specified profile does not exist, an empty profile is **created automatically**.   You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2).  &lt;div class&#x3D;\&quot;redoc-section\&quot;&gt;   &lt;p class&#x3D;\&quot;title\&quot;&gt;Performance tips&lt;/p&gt;    - Updating a customer session returns a response with the new integration state. Use the &#x60;responseContent&#x60; property to save yourself extra API calls.     For example, you can get the customer profile details directly without extra requests.   - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). &lt;/div&gt;  For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
     # @param customer_session_id [String] The &#x60;integration ID&#x60; of the customer session. You set this ID when you create a customer session.  You can see existing customer session integration IDs in the Campaign Manager&#39;s **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. 
     # @param body [IntegrationRequest] body
     # @param [Hash] opts the optional parameters