talon_one 9.0.0 → 10.0.0

data/lib/talon_one/models/webhook_authentication_webhook_ref.rb

@@ -0,0 +1,258 @@
+=begin
+#Talon.One API
+
+#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 access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` 
+
+The version of the OpenAPI document: 
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module TalonOne
+  class WebhookAuthenticationWebhookRef
+    # The internal ID of this entity.
+    attr_accessor :id
+
+    # The title of the webhook authentication.
+    attr_accessor :title
+
+    # A description of the webhook authentication.
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'title' => :'title',
+        :'description' => :'description'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'title' => :'String',
+        :'description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::WebhookAuthenticationWebhookRef` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::WebhookAuthenticationWebhookRef`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
+      if @title !~ pattern
+        invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @title.nil?
+      return false if @title !~ Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
+      if title !~ pattern
+        fail ArgumentError, "invalid value for \"title\", must conform to the pattern #{pattern}."
+      end
+
+      @title = title
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          title == o.title &&
+          description == o.description
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, title, description].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TalonOne.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class WebhookWithOutgoingIntegrationDetails
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.
@@ -32,6 +32,9 @@ module TalonOne
     # A description of the webhook.
     attr_accessor :description
 
+    # Indicates if the webhook is a draft.
+    attr_accessor :draft
+
     # API method for this webhook.
     attr_accessor :verb
 
@@ -90,6 +93,7 @@ module TalonOne
         :'application_ids' => :'applicationIds',
         :'title' => :'title',
         :'description' => :'description',
+        :'draft' => :'draft',
         :'verb' => :'verb',
         :'url' => :'url',
         :'headers' => :'headers',
@@ -111,6 +115,7 @@ module TalonOne
         :'application_ids' => :'Array<Integer>',
         :'title' => :'String',
         :'description' => :'String',
+        :'draft' => :'Boolean',
         :'verb' => :'String',
         :'url' => :'String',
         :'headers' => :'Array<String>',
@@ -170,6 +175,10 @@ module TalonOne
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'draft')
+        self.draft = attributes[:'draft']
+      end
+
       if attributes.key?(:'verb')
         self.verb = attributes[:'verb']
       end
@@ -240,6 +249,10 @@ module TalonOne
         invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
       end
 
+      if @draft.nil?
+        invalid_properties.push('invalid value for "draft", draft cannot be nil.')
+      end
+
       if @verb.nil?
         invalid_properties.push('invalid value for "verb", verb cannot be nil.')
       end
@@ -272,6 +285,7 @@ module TalonOne
       return false if @application_ids.nil?
       return false if @title.nil?
       return false if @title !~ Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/)
+      return false if @draft.nil?
       return false if @verb.nil?
       verb_validator = EnumAttributeValidator.new('String', ["POST", "PUT", "GET", "DELETE", "PATCH"])
       return false unless verb_validator.valid?(@verb)
@@ -318,6 +332,7 @@ module TalonOne
           application_ids == o.application_ids &&
           title == o.title &&
           description == o.description &&
+          draft == o.draft &&
           verb == o.verb &&
           url == o.url &&
           headers == o.headers &&
@@ -338,7 +353,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, modified, application_ids, title, description, verb, url, headers, payload, params, enabled, outgoing_integration_template_id, outgoing_integration_type_id, outgoing_integration_type_name].hash
+      [id, created, modified, application_ids, title, description, draft, verb, url, headers, payload, params, enabled, outgoing_integration_template_id, outgoing_integration_type_id, outgoing_integration_type_name].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module TalonOne
-  VERSION = '9.0.0'
+  VERSION = '10.0.0'
 end

data/lib/talon_one.rb

@@ -42,7 +42,9 @@ require 'talon_one/models/add_free_item_effect_props'
 require 'talon_one/models/add_item_catalog_action'
 require 'talon_one/models/add_loyalty_points'
 require 'talon_one/models/add_loyalty_points_effect_props'
+require 'talon_one/models/add_price_adjustment_catalog_action'
 require 'talon_one/models/add_to_audience_effect_props'
+require 'talon_one/models/added_deducted_points_balances_notification_policy'
 require 'talon_one/models/added_deducted_points_notification_policy'
 require 'talon_one/models/additional_campaign_properties'
 require 'talon_one/models/additional_cost'
@@ -101,6 +103,7 @@ require 'talon_one/models/campaign_collection_edited_notification'
 require 'talon_one/models/campaign_collection_without_payload'
 require 'talon_one/models/campaign_copy'
 require 'talon_one/models/campaign_created_notification'
+require 'talon_one/models/campaign_deactivation_request'
 require 'talon_one/models/campaign_deleted_notification'
 require 'talon_one/models/campaign_detail'
 require 'talon_one/models/campaign_edited_notification'
@@ -126,6 +129,7 @@ require 'talon_one/models/campaign_template_collection'
 require 'talon_one/models/campaign_template_coupon_reservation_settings'
 require 'talon_one/models/campaign_template_params'
 require 'talon_one/models/campaign_versions'
+require 'talon_one/models/card_added_deducted_points_balances_notification_policy'
 require 'talon_one/models/card_added_deducted_points_notification_policy'
 require 'talon_one/models/card_expiring_points_notification_policy'
 require 'talon_one/models/card_expiring_points_notification_trigger'
@@ -152,6 +156,7 @@ require 'talon_one/models/coupon_created_effect_props'
 require 'talon_one/models/coupon_creation_job'
 require 'talon_one/models/coupon_deletion_filters'
 require 'talon_one/models/coupon_deletion_job'
+require 'talon_one/models/coupon_entity'
 require 'talon_one/models/coupon_limit_configs'
 require 'talon_one/models/coupon_rejection_reason'
 require 'talon_one/models/coupon_reservations'
@@ -171,6 +176,7 @@ require 'talon_one/models/customer_inventory'
 require 'talon_one/models/customer_profile'
 require 'talon_one/models/customer_profile_audience_request'
 require 'talon_one/models/customer_profile_audience_request_item'
+require 'talon_one/models/customer_profile_entity'
 require 'talon_one/models/customer_profile_integration_request_v2'
 require 'talon_one/models/customer_profile_integration_response_v2'
 require 'talon_one/models/customer_profile_search_query'
@@ -200,6 +206,7 @@ require 'talon_one/models/expiring_coupons_notification_trigger'
 require 'talon_one/models/expiring_points_notification_policy'
 require 'talon_one/models/expiring_points_notification_trigger'
 require 'talon_one/models/export'
+require 'talon_one/models/extend_loyalty_points_expiry_date_effect_props'
 require 'talon_one/models/feature_flag'
 require 'talon_one/models/features_feed'
 require 'talon_one/models/func_arg_def'
@@ -264,12 +271,16 @@ require 'talon_one/models/inline_response20047'
 require 'talon_one/models/inline_response20048'
 require 'talon_one/models/inline_response20049'
 require 'talon_one/models/inline_response2005'
+require 'talon_one/models/inline_response20050'
+require 'talon_one/models/inline_response20051'
 require 'talon_one/models/inline_response2006'
 require 'talon_one/models/inline_response2007'
 require 'talon_one/models/inline_response2008'
 require 'talon_one/models/inline_response2009'
 require 'talon_one/models/inline_response201'
 require 'talon_one/models/integration_coupon'
+require 'talon_one/models/integration_customer_profile_audience_request'
+require 'talon_one/models/integration_customer_profile_audience_request_item'
 require 'talon_one/models/integration_customer_session_response'
 require 'talon_one/models/integration_entity'
 require 'talon_one/models/integration_event'
@@ -382,6 +393,8 @@ require 'talon_one/models/new_outgoing_integration_webhook'
 require 'talon_one/models/new_password'
 require 'talon_one/models/new_password_email'
 require 'talon_one/models/new_picklist'
+require 'talon_one/models/new_price_adjustment'
+require 'talon_one/models/new_price_type'
 require 'talon_one/models/new_referral'
 require 'talon_one/models/new_referrals_for_multiple_advocates'
 require 'talon_one/models/new_return'
@@ -416,6 +429,8 @@ require 'talon_one/models/patch_item_catalog_action'
 require 'talon_one/models/patch_many_items_catalog_action'
 require 'talon_one/models/pending_points_notification_policy'
 require 'talon_one/models/picklist'
+require 'talon_one/models/price_detail'
+require 'talon_one/models/price_type'
 require 'talon_one/models/product'
 require 'talon_one/models/product_search_match'
 require 'talon_one/models/product_unit_analytics'
@@ -464,8 +479,12 @@ require 'talon_one/models/saml_connection'
 require 'talon_one/models/saml_connection_internal'
 require 'talon_one/models/saml_connection_metadata'
 require 'talon_one/models/saml_login_endpoint'
+require 'talon_one/models/scim_base_group'
 require 'talon_one/models/scim_base_user'
 require 'talon_one/models/scim_base_user_name'
+require 'talon_one/models/scim_group'
+require 'talon_one/models/scim_group_member'
+require 'talon_one/models/scim_groups_list_response'
 require 'talon_one/models/scim_new_user'
 require 'talon_one/models/scim_patch_operation'
 require 'talon_one/models/scim_patch_request'
@@ -545,6 +564,11 @@ require 'talon_one/models/user_entity'
 require 'talon_one/models/value_map'
 require 'talon_one/models/webhook'
 require 'talon_one/models/webhook_activation_log_entry'
+require 'talon_one/models/webhook_authentication'
+require 'talon_one/models/webhook_authentication_base'
+require 'talon_one/models/webhook_authentication_data_basic'
+require 'talon_one/models/webhook_authentication_data_custom'
+require 'talon_one/models/webhook_authentication_webhook_ref'
 require 'talon_one/models/webhook_log_entry'
 require 'talon_one/models/webhook_with_outgoing_integration_details'
 require 'talon_one/models/will_award_giveaway_effect_props'

data/spec/api/integration_api_spec.rb

@@ -381,7 +381,7 @@ describe 'IntegrationApi' do
 
   # unit tests for track_event_v2
   # 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 body
   # @param [Hash] opts the optional parameters
   # @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. 
@@ -434,7 +434,7 @@ describe 'IntegrationApi' do
 
   # unit tests for update_customer_profile_v2
   # 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 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 body
   # @param [Hash] opts the optional parameters
@@ -462,7 +462,7 @@ describe 'IntegrationApi' do
 
   # unit tests for update_customer_session_v2
   # 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 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](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint. 
   # @param body body
   # @param [Hash] opts the optional parameters