talon_one 2.3.0 → 2.5.1

data/spec/api/integration_api_spec.rb

@@ -1,7 +1,7 @@
 =begin
 #Talon.One API
 
-#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns.  ### Where is the API?  The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id`  [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put 
+#Use the Talon.One API to integrate with your application and to manage applications and campaigns:  - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns.  ## Determining the base URL of the endpoints  The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}` 
 
 The version of the OpenAPI document: 1.0.0
 
@@ -32,9 +32,21 @@ describe 'IntegrationApi' do
     end
   end
 
+  # unit tests for create_audience_v2
+  # Create audience
+  # Create an audience. The audience can be created directly from scratch or can come from third party platforms.  To create an audience from an existing audience in mParticle or Segment: 1. Set the `integration` property to `mparticle` or `segment` depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform.  To create an audience from an existing audience in another platform than mParticle: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform.  To create an audience from scratch: 1. Only set the `name` property.  Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder. 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Audience]
+  describe 'create_audience_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for create_coupon_reservation
-  # Create a new coupon reservation
-  # Creates a coupon reservation for all passed customer profiles on this couponID 
+  # Create coupon reservation
+  # Create a coupon reservation for specified customer profiles on the specified coupon.  Reserving a coupon allows you to associate a coupon code to a given customer(s). You can then list the reserved coupons of a given customer with the [List customer data endpoint](/integration-api/#operation/getCustomerInventory).  If a coupon gets created for a specific user, it will automatically show up in their coupons.  When a user redeems a coupon, a reservation is automatically created after the redemption and the used coupon will be returned in the [List customer data endpoint](/integration-api/#operation/getCustomerInventory).  **Important:** - This endpoint creates a **soft** reservation. _Any_ customer   can use a reserved coupon code and proceed to checkout. - To create a hard reservation, use the   [Create coupons](/management-api/#operation/createCoupons) or   [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints   setting the `recipientsIntegrationId` property.  For example, you can use this endpoint and `List customer data` to create a \"coupon wallet\" by reserving coupon codes for a customer, and then displaying their \"coupon wallet\" when they visit your store. 
   # @param coupon_value The value of a coupon
   # @param body 
   # @param [Hash] opts the optional parameters
@@ -46,7 +58,7 @@ describe 'IntegrationApi' do
   end
 
   # unit tests for create_referral
-  # Create a referral code for an advocate
+  # Create referral code for an advocate
   # Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
   # @param body 
   # @param [Hash] opts the optional parameters
@@ -57,9 +69,46 @@ describe 'IntegrationApi' do
     end
   end
 
+  # unit tests for create_referrals_for_multiple_advocates
+  # Create referral codes for multiple advocates
+  # Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. 
+  # @return [InlineResponse201]
+  describe 'create_referrals_for_multiple_advocates test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_audience_memberships_v2
+  # Delete audience memberships
+  # Remove all members from this audience. 
+  # @param audience_id The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_audience_memberships_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_audience_v2
+  # Delete audience
+  # Delete an audience created by a third-party integration.  **Warning:** This endpoint also removes any associations recorded between a customer profile and this audience. 
+  # @param audience_id The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_audience_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for delete_coupon_reservation
   # Delete coupon reservations
-  # Removes all passed customer profiles reservation from this coupon 
+  # Remove all passed customer profiles reservation from this coupon. 
   # @param coupon_value The value of a coupon
   # @param body 
   # @param [Hash] opts the optional parameters
@@ -71,9 +120,9 @@ describe 'IntegrationApi' do
   end
 
   # unit tests for delete_customer_data
-  # 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 The custom identifier for this profile, must be unique within the account.
+  # Delete customer's personal data
+  # Delete all attributes on the customer profile and on entities that reference this customer profile.  **Important:** To preserve performance, we recommend avoiding deleting customer data during peak-traffic hours. 
+  # @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). 
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_customer_data test' do
@@ -83,14 +132,16 @@ describe 'IntegrationApi' do
   end
 
   # unit tests for get_customer_inventory
-  # 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 The custom identifier for this profile, must be unique within the account.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :profile optional flag to decide if you would like customer profile information in the response
-  # @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
-  # @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
-  # @option opts [Boolean] :loyalty optional flag to decide if you would like loyalty information in the response
+  # List customer data
+  # Return the customer inventory regarding entities referencing this customer profile's `integrationId`.  Typical entities returned are: customer profile information, referral codes, loyalty points and reserved coupons. Reserved coupons also include redeemed coupons.  You can also use this endpoint to get the projected loyalty balances in order to notify your customers about points that are about to expire, or to remind them how many points they have. 
+  # @param integration_id The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration Id with the [Update customer session endpoint](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2). - The Management API with the [List application's customers endpoint](https://docs.talon.one/management-api/#operation/getApplicationCustomers). 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :profile Set to `true` to include customer profile information in the response.
+  # @option opts [Boolean] :referrals Set to `true` to include referral information in the response.
+  # @option opts [Boolean] :coupons Set to `true` to include coupon information in the response.
+  # @option opts [Boolean] :loyalty Set to `true` to include loyalty information in the response.
+  # @option opts [Boolean] :giveaways Set to `true` to include giveaways information in the response.
+  # @option opts [DateTime] :loyalty_projection_end_date Set an end date to query the projected loyalty balances. You can project results up to 31 days from today.
   # @return [CustomerInventory]
   describe 'get_customer_inventory test' do
     it 'should work' do
@@ -98,9 +149,21 @@ describe 'IntegrationApi' do
     end
   end
 
+  # unit tests for get_customer_session
+  # Get customer session
+  # Get customer session data. 
+  # @param customer_session_id The `integration ID` 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's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). 
+  # @param [Hash] opts the optional parameters
+  # @return [IntegrationCustomerSessionResponse]
+  describe 'get_customer_session test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_reserved_customers
-  # Get the users that have this coupon reserved
-  # Returns all users that have this coupon marked as reserved 
+  # List customers that have this coupon reserved
+  # Return all customers that have this coupon marked as reserved.  Coupons are reserved in the following ways: - To create a soft reservation (any customer can use the coupon), use the [Create coupon reservation](#operation/createCouponReservation) endpoint. - To create a hard reservation (only the given customer can use the coupon), create a coupon in the Campaign Manager for a given `recipientIntegrationId` or use the [Create coupons](/management-api/#operation/createCoupons) or [Create coupons for multiple recipients](/management-api/#operation/createCouponsForMultipleRecipients) endpoints. 
   # @param coupon_value The value of a coupon
   # @param [Hash] opts the optional parameters
   # @return [InlineResponse200]
@@ -110,12 +173,26 @@ describe 'IntegrationApi' do
     end
   end
 
+  # unit tests for return_cart_items
+  # Return cart items
+  # Create a new return request for the specified cart items.  This endpoint automatically changes the session state from `closed` to `partially returned`.  Its behavior depends on whether [cart item flattening](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items) is enabled for the campaign.  **Note:** This will roll back any effects associated with these cart items. For more information, see [our documentation on session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session-states) and [this tutorial](https://docs.talon.one/docs/dev/tutorials/partially-returning-a-session). 
+  # @param customer_session_id The `integration ID` 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's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
+  # @return [IntegrationStateV2]
+  describe 'return_cart_items test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for track_event
-  # Track an Event
-  # 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. 
+  # Track event
+  # **Important:** This endpoint is **DEPRECATED**. Use [Track Event V2](https://docs.talon.one/integration-api/#tag/Events/operation/trackEventV2) instead.  > Triggers a custom event in a customer session. You can then check this event in your rules. **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/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 user updates their payment information.  > Before using this endpoint, create your event as a custom attribute of type `event`.  See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event).  > An event is always part of a session. If either the profile or the session does not exist, a new empty profile/session is created. If the specified session already exists, it must belong to the same `profileId` or an error will be returned. 
   # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
+  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
   # @return [IntegrationState]
   describe 'track_event test' do
     it 'should work' do
@@ -123,23 +200,49 @@ describe 'IntegrationApi' do
     end
   end
 
-  # unit tests for update_customer_profile
-  # 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, 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 The custom identifier for this profile, must be unique within the account.
+  # unit tests for track_event_v2
+  # Track event V2
+  # Triggers a custom event. You can then check this event in your rules.  **Important:** Talon.One offers a set of [built-in events](/docs/dev/concepts/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 user updates their payment information.  Before using this endpoint, create your event as a custom attribute of type `event`. See the [Developer docs](/docs/dev/concepts/events/#creating-a-custom-event).  **Important:** `profileId` is required. An event V2 is associated with a customer profile. 
   # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
-  # @return [IntegrationState]
-  describe 'update_customer_profile test' do
+  # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. 
+  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
+  # @return [IntegrationStateV2]
+  describe 'track_event_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_audience_customers_attributes
+  # Update profile attributes for all customers in audience
+  # Update the specified profile attributes to the provided values for all customers in the specified audience. 
+  # @param audience_id The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_audience_customers_attributes test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_audience_v2
+  # Update audience
+  # Update an Audience created by a third-party integration. 
+  # @param audience_id The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Audience]
+  describe 'update_audience_v2 test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
   # unit tests for update_customer_profile_audiences
-  # Update a Customer Profile Audiences
-  # Update one ore multiple Customer Profiles with the specified Audiences 
+  # Update multiple customer profiles' audiences
+  # Update the specified customer profiles with the specified audiences. Use this endpoint when customers join or leave audiences.  The limit of customer profiles per request is 1000. 
   # @param body 
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -150,13 +253,13 @@ describe 'IntegrationApi' do
   end
 
   # unit tests for update_customer_profile_v2
-  # Update a Customer Profile
-  # 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 The custom identifier for this profile. Must be unique within the account.
+  # Update customer profile
+  # Update (or create) a [Customer Profile](/docs/dev/concepts/entities#customer-profile).  **Performance tips**  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.  You can also set `runRuleEngine` to `false` to prevent unwanted rule executions. This allows you to improve response times.  If `runRuleEngine` is set to `true`, the response includes:  - The effects generated by the triggered campaigns. - The created coupons and referral objects. 
+  # @param integration_id 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 
   # @param [Hash] opts the optional parameters
-  # @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 `true`. Only used when `runRuleEngine` is set to `true`. 
+  # @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine. Setting this property to `false` improves response times.
+  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`. Only used when `runRuleEngine` is set to `true`. 
   # @return [IntegrationStateV2]
   describe 'update_customer_profile_v2 test' do
     it 'should work' do
@@ -165,11 +268,11 @@ describe 'IntegrationApi' do
   end
 
   # unit tests for update_customer_profiles_v2
-  # Update multiple Customer Profiles
-  # 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). 
+  # Update multiple customer profiles
+  # Update (or create) up to 1000 [customer profiles](/docs/dev/concepts/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](/integration-api/#tag/Customer-sessions). 
   # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
+  # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains essential data such as the updated customer profiles and session-related information. 
   # @return [MultipleCustomerProfileIntegrationResponseV2]
   describe 'update_customer_profiles_v2 test' do
     it 'should work' do
@@ -177,27 +280,13 @@ describe 'IntegrationApi' do
     end
   end
 
-  # unit tests for update_customer_session
-  # 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, 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 The custom identifier for this session, must be unique within the account.
-  # @param body 
-  # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
-  # @return [IntegrationState]
-  describe 'update_customer_session test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for update_customer_session_v2
-  # Update a 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 The custom identifier for this session, must be unique within the account.
+  # Update customer session
+  # Update or create a [customer session](/docs/dev/concepts/entities#customer-session). For example, use this endpoint to share the content of a customer's cart with Talon.One and to check which promotion rules apply.  **Note:** The currency for the session and the cart items in the session is the same as the Application that owns this session.  **Session management**  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.  See more information and tips about session management in the [documentation](/docs/dev/concepts/entities#customer-session).  **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.  **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically.  **Performance tips**  Updating a customer session 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.  For more information, see the [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one). 
+  # @param customer_session_id The `integration ID` 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's **Sessions** menu, or via the [List Application session endpoint](https://docs.talon.one/management-api/#operation/getApplicationSessions). 
   # @param body 
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
+  # @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
   # @return [IntegrationStateV2]
   describe 'update_customer_session_v2 test' do
     it 'should work' do