talon_one 9.0.0 → 10.0.0

data/docs/CartItem.md

@@ -19,7 +19,12 @@ Name | Type | Description | Notes
 **position** | **Float** | Position of the Cart Item in the Cart (calculated internally). | [optional] 
 **attributes** | [**Object**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item.  Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property.  **Note:** Any previously defined attributes that you do not include in the array will be removed.  | [optional] 
 **additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).  | [optional] 
-**catalog_item_id** | **Integer** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional] 
+**catalog_item_id** | **Integer** | The catalog item ID. | [optional] 
+**selected_price_type** | **String** | The selected price type for this cart item (e.g. the price for members only). | [optional] 
+**adjustment_reference_id** | **String** | The reference ID of the selected price adjustment for this cart item. Only returned if the selected price resulted from a price adjustment. | [optional] 
+**adjustment_effective_from** | **DateTime** | The date and time from which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] 
+**adjustment_effective_until** | **DateTime** | The date and time until which the price adjustment is effective. Only returned if the selected price resulted from a price adjustment that contains this field. | [optional] 
+**prices** | [**Hash<String, PriceDetail>**](PriceDetail.md) | A map of keys and values representing the price types and related price adjustment details for this cart item. The keys correspond to the `priceType` names.  | [optional] 
 
 ## Code Sample
 
@@ -41,7 +46,12 @@ instance = TalonOne::CartItem.new(name: Air Glide,
                                  position: null,
                                  attributes: {"image":"11.jpeg","material":"leather"},
                                  additional_costs: {"shipping":{"price":9}},
-                                 catalog_item_id: null)
+                                 catalog_item_id: null,
+                                 selected_price_type: member,
+                                 adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
+                                 adjustment_effective_from: 2021-09-12T10:12:42Z,
+                                 adjustment_effective_until: 2021-09-12T10:12:42Z,
+                                 prices: {"member":{"price":90,"adjustmentReferenceId":"68851723-e6fa-488f-ace9-112581e6c19b","effectiveFrom":"2025-05-25T00:00:00Z","effectiveUntil":"2025-05-30T00:00:00Z"},"base":{"price":100}})
 ```
 
 

data/docs/Catalog.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/CatalogItem.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. | 
 **sku** | **String** | The stock keeping unit of the item. | 
 **price** | **Float** | Price of the item. | [optional] 

data/docs/Change.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. | 
 **application_id** | **Integer** | ID of application associated with change. | [optional] 

data/docs/Collection.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/CollectionWithoutPayload.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/Coupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/CouponCreationJob.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. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **application_id** | **Integer** | The ID of the Application that owns this entity. | 

data/docs/CouponDeletionJob.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/CouponEntity.md

@@ -0,0 +1,19 @@
+# TalonOne::CouponEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CouponEntity.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z)
+```
+
+

data/docs/CreateAchievement.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | 
 **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/CustomEffect.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **modified** | **DateTime** | The time this entity was last modified. | 

data/docs/CustomerProfile.md

@@ -4,12 +4,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
+**id** | **Integer** | The internal ID of the customer profile. | 
 **created** | **DateTime** | The time this entity was created. | 
 **integration_id** | **String** | The integration ID set by your integration layer. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. | 
-**closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
+**closed_sessions** | **Integer** | The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). | 
 **total_sales** | **Float** | The total amount of money spent by the customer **before** discounts are applied.  The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items.  | 
 **loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | **DEPRECATED** A list of loyalty programs joined by the customer.  | [optional] 
 **audience_memberships** | [**Array<AudienceMembership>**](AudienceMembership.md) | The audiences the customer belongs to. | [optional] 

data/docs/CustomerProfileEntity.md

@@ -0,0 +1,19 @@
+# TalonOne::CustomerProfileEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The internal ID of the customer profile. | 
+**created** | **DateTime** | The time the customer profile was created. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerProfileEntity.new(id: 6,
+                                 created: 2020-06-10T09:05:27.993483Z)
+```
+
+

data/docs/CustomerSessionV2.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. | 
 **integration_id** | **String** | The integration ID set by your integration layer. | 
 **application_id** | **Integer** | The ID of the Application that owns this entity. | 

data/docs/Effect.md

@@ -16,6 +16,9 @@ Name | Type | Description | Notes
 **evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
 **campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional] 
 **campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional] 
+**selected_price_type** | **String** | The selected price type for the SKU targeted by this effect. | [optional] 
+**selected_price** | **Float** | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional] 
+**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional] 
 **props** | [**Object**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | 
 
 ## Code Sample
@@ -35,6 +38,9 @@ instance = TalonOne::Effect.new(campaign_id: 244,
                                  evaluation_group_mode: stackable,
                                  campaign_revision_id: 1,
                                  campaign_revision_version_id: 5,
+                                 selected_price_type: member,
+                                 selected_price: 100.0,
+                                 adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b,
                                  props: null)
 ```
 

data/docs/EffectEntity.md

@@ -16,6 +16,9 @@ Name | Type | Description | Notes
 **evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] 
 **campaign_revision_id** | **Integer** | The revision ID of the campaign that was used when triggering the effect. | [optional] 
 **campaign_revision_version_id** | **Integer** | The revision version ID of the campaign that was used when triggering the effect. | [optional] 
+**selected_price_type** | **String** | The selected price type for the SKU targeted by this effect. | [optional] 
+**selected_price** | **Float** | The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. | [optional] 
+**adjustment_reference_id** | **String** | The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. | [optional] 
 
 ## Code Sample
 
@@ -33,7 +36,10 @@ instance = TalonOne::EffectEntity.new(campaign_id: 244,
                                  evaluation_group_id: 3,
                                  evaluation_group_mode: stackable,
                                  campaign_revision_id: 1,
-                                 campaign_revision_version_id: 5)
+                                 campaign_revision_version_id: 5,
+                                 selected_price_type: member,
+                                 selected_price: 100.0,
+                                 adjustment_reference_id: 68851723-e6fa-488f-ace9-112581e6c19b)
 ```
 
 

data/docs/Entity.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. | 
 
 ## Code Sample

data/docs/Environment.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. | 
 **slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. | 
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **audiences** | [**Array<Audience>**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] 
 **collections** | [**Array<Collection>**](Collection.md) | The account-level collections that the application is subscribed to. | [optional] 
 **application_cart_item_filters** | [**Array<ApplicationCIF>**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional] 
+**price_types** | [**Array<PriceType>**](PriceType.md) | The price types that this Application can use. | [optional] 
 
 ## Code Sample
 
@@ -39,7 +40,8 @@ instance = TalonOne::Environment.new(id: 6,
                                  additional_costs: null,
                                  audiences: null,
                                  collections: null,
-                                 application_cart_item_filters: null)
+                                 application_cart_item_filters: null,
+                                 price_types: null)
 ```
 
 

data/docs/Event.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. | 
 **profile_id** | **String** | ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.  | [optional] 

data/docs/EventType.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. | 
 **title** | **String** | The human-friendly name for this event type. | 
 **name** | **String** | The integration name for this event type. This will be used in URLs and cannot be changed after an event type has been created. | 

data/docs/Export.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 

data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md

@@ -0,0 +1,25 @@
+# TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**program_id** | **Integer** | ID of the loyalty program that contains these points. | 
+**sub_ledger_id** | **String** | API name of the loyalty program subledger that contains these points. added. | 
+**extension_duration** | **String** | Time frame by which the expiry date extends.  The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit.  Examples: `immediate`, `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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | 
+**transaction_uui_ds** | **Array<String>** | The list of identifiers of transactions affected affected by the extension. | [optional] 
+**previous_expiration_date** | **DateTime** | Expiry date before applying the extension. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps.new(program_id: null,
+                                 sub_ledger_id: null,
+                                 extension_duration: 12h,
+                                 transaction_uui_ds: null,
+                                 previous_expiration_date: null)
+```
+
+

data/docs/Giveaway.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. | 
 **code** | **String** | The code value of this giveaway. | 
 **pool_id** | **Integer** | The ID of the pool to return giveaway codes from. | 

data/docs/GiveawaysPool.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **name** | **String** | The name of this giveaways pool. | 

data/docs/Import.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. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **user_id** | **Integer** | The ID of the user associated with this entity. | 

data/docs/InlineResponse20048.md

@@ -4,16 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**has_more** | **Boolean** |  | [optional] 
-**data** | [**Array<Achievement>**](Achievement.md) |  | 
+**data** | [**Array<ListCampaignStoreBudgets>**](ListCampaignStoreBudgets.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::InlineResponse20048.new(has_more: null,
-                                 data: null)
+instance = TalonOne::InlineResponse20048.new(data: null)
 ```
 
 

data/docs/InlineResponse20049.md

@@ -4,16 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**has_more** | **Boolean** |  | 
-**data** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) |  | 
+**data** | [**Array<SummaryCampaignStoreBudget>**](SummaryCampaignStoreBudget.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::InlineResponse20049.new(has_more: true,
-                                 data: null)
+instance = TalonOne::InlineResponse20049.new(data: null)
 ```
 
 

data/docs/InlineResponse20050.md

@@ -0,0 +1,19 @@
+# TalonOne::InlineResponse20050
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **Boolean** |  | [optional] 
+**data** | [**Array<Achievement>**](Achievement.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::InlineResponse20050.new(has_more: null,
+                                 data: null)
+```
+
+

data/docs/InlineResponse20051.md

@@ -0,0 +1,19 @@
+# TalonOne::InlineResponse20051
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **Boolean** |  | 
+**data** | [**Array<AchievementProgressWithDefinition>**](AchievementProgressWithDefinition.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::InlineResponse20051.new(has_more: true,
+                                 data: null)
+```
+
+

data/docs/IntegrationApi.md

@@ -1476,7 +1476,7 @@ Name | Type | Description  | Notes
 
 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> 
 
 ### Example
 
@@ -1702,7 +1702,7 @@ nil (empty response body)
 
 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> 
 
 ### Example
 
@@ -1822,7 +1822,7 @@ Name | Type | Description  | Notes
 
 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). 
 
 ### Example
 

data/docs/IntegrationCoupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/IntegrationCustomerProfileAudienceRequest.md

@@ -0,0 +1,17 @@
+# TalonOne::IntegrationCustomerProfileAudienceRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<IntegrationCustomerProfileAudienceRequestItem>**](IntegrationCustomerProfileAudienceRequestItem.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationCustomerProfileAudienceRequest.new(data: null)
+```
+
+

data/docs/IntegrationCustomerProfileAudienceRequestItem.md

@@ -0,0 +1,21 @@
+# TalonOne::IntegrationCustomerProfileAudienceRequestItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | Defines the action to perform: - `add`: Adds the customer profile to the audience.    **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application   until a session or profile update is received for that profile. - `delete`: Removes the customer profile from the audience.  | 
+**profile_integration_id** | **String** | The ID of this customer profile in the third-party integration. | 
+**integration_id** | **String** | The ID of this audience in the third-party integration. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationCustomerProfileAudienceRequestItem.new(action: add,
+                                 profile_integration_id: R195412,
+                                 integration_id: 382370BKDB946)
+```
+
+

data/docs/IntegrationEventV2Request.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.  These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.  | [optional] 
 **type** | **String** | A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.  | 
 **attributes** | [**Object**](.md) | Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute). | [optional] 
+**loyalty_cards** | **Array<String>** | Identifier of the loyalty card used during this event. | [optional] 
 **response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the tracking custom event.  | [optional] 
 
 ## Code Sample
@@ -21,6 +22,7 @@ instance = TalonOne::IntegrationEventV2Request.new(profile_id: URNGV8294NV,
                                  evaluable_campaign_ids: [10, 12],
                                  type: pageViewed,
                                  attributes: {"myAttribute":"myValue"},
+                                 loyalty_cards: [loyalty-card-1],
                                  response_content: [triggeredCampaigns, customerProfile])
 ```
 

data/docs/InventoryCoupon.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Internal ID of this entity. | 
-**created** | **DateTime** | The time this entity was created. | 
+**id** | **Integer** | The internal ID of the coupon. | 
+**created** | **DateTime** | The time the coupon was created. | 
 **campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
 **value** | **String** | The coupon code. | 
 **usage_limit** | **Integer** | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.  | 

data/docs/InventoryReferral.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/LedgerEntry.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. | 
 **profile_id** | **String** | ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.  | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. |