talon_one 2.4.0 → 2.5.1

data/lib/talon_one/models/customer_profile.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
 
@@ -15,12 +15,15 @@ require 'date'
 module TalonOne
   # 
   class CustomerProfile
-    # The integration ID for this entity sent to and used in the Talon.One system.
-    attr_accessor :integration_id
+    # Unique ID for this entity.
+    attr_accessor :id
 
-    # The exact moment this entity was created.
+    # The exact moment this entity was created. The exact moment this entity was created.
     attr_accessor :created
 
+    # The integration ID for this entity sent to and used in the Talon.One system.
+    attr_accessor :integration_id
+
     # Arbitrary properties associated with this item
     attr_accessor :attributes
 
@@ -33,20 +36,21 @@ module TalonOne
     # Sum of all purchases made by this customer
     attr_accessor :total_sales
 
-    # A list of loyalty programs joined by the customer
+    # **DEPRECATED** A list of loyalty programs joined by the customer. 
     attr_accessor :loyalty_memberships
 
     # A list of audiences the customer belongs to
     attr_accessor :audience_memberships
 
-    # Timestamp of the most recent event received from this customer
+    # Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field. 
     attr_accessor :last_activity
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'integration_id' => :'integrationId',
+        :'id' => :'id',
         :'created' => :'created',
+        :'integration_id' => :'integrationId',
         :'attributes' => :'attributes',
         :'account_id' => :'accountId',
         :'closed_sessions' => :'closedSessions',
@@ -60,8 +64,9 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'integration_id' => :'String',
+        :'id' => :'Integer',
         :'created' => :'DateTime',
+        :'integration_id' => :'String',
         :'attributes' => :'Object',
         :'account_id' => :'Integer',
         :'closed_sessions' => :'Integer',
@@ -93,14 +98,18 @@ module TalonOne
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'integration_id')
-        self.integration_id = attributes[:'integration_id']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
       if attributes.key?(:'created')
         self.created = attributes[:'created']
       end
 
+      if attributes.key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
       if attributes.key?(:'attributes')
         self.attributes = attributes[:'attributes']
       end
@@ -138,14 +147,22 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @integration_id.nil?
-        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
       if @created.nil?
         invalid_properties.push('invalid value for "created", created cannot be nil.')
       end
 
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @attributes.nil?
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
@@ -172,8 +189,10 @@ module TalonOne
     # 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 @integration_id.nil?
+      return false if @id.nil?
       return false if @created.nil?
+      return false if @integration_id.nil?
+      return false if @integration_id.to_s.length > 1000
       return false if @attributes.nil?
       return false if @account_id.nil?
       return false if @closed_sessions.nil?
@@ -182,13 +201,28 @@ module TalonOne
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] integration_id Value to be assigned
+    def integration_id=(integration_id)
+      if integration_id.nil?
+        fail ArgumentError, 'integration_id cannot be nil'
+      end
+
+      if integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @integration_id = integration_id
+    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 &&
-          integration_id == o.integration_id &&
+          id == o.id &&
           created == o.created &&
+          integration_id == o.integration_id &&
           attributes == o.attributes &&
           account_id == o.account_id &&
           closed_sessions == o.closed_sessions &&
@@ -207,7 +241,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [integration_id, created, attributes, account_id, closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity].hash
+      [id, created, integration_id, attributes, account_id, closed_sessions, total_sales, loyalty_memberships, audience_memberships, last_activity].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/customer_profile_audience_request.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
 

data/lib/talon_one/models/customer_profile_audience_request_item.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
 
@@ -14,10 +14,13 @@ require 'date'
 
 module TalonOne
   class CustomerProfileAudienceRequestItem
+    # Defines the action to perform: - `add`: Adds the customer profile to the audience. - `delete`: Removes the customer profile from the audience. 
     attr_accessor :action
 
+    # The ID of this customer profile in the third-party integration.
     attr_accessor :profile_integration_id
 
+    # The ID of the audience. You get it via the `id` property when [creating an audience](#operation/createAudienceV2).
     attr_accessor :audience_id
 
     class EnumAttributeValidator
@@ -106,6 +109,10 @@ module TalonOne
         invalid_properties.push('invalid value for "profile_integration_id", profile_integration_id cannot be nil.')
       end
 
+      if @profile_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "profile_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @audience_id.nil?
         invalid_properties.push('invalid value for "audience_id", audience_id cannot be nil.')
       end
@@ -120,6 +127,7 @@ module TalonOne
       action_validator = EnumAttributeValidator.new('String', ["add", "delete"])
       return false unless action_validator.valid?(@action)
       return false if @profile_integration_id.nil?
+      return false if @profile_integration_id.to_s.length > 1000
       return false if @audience_id.nil?
       true
     end
@@ -134,6 +142,20 @@ module TalonOne
       @action = action
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] profile_integration_id Value to be assigned
+    def profile_integration_id=(profile_integration_id)
+      if profile_integration_id.nil?
+        fail ArgumentError, 'profile_integration_id cannot be nil'
+      end
+
+      if profile_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "profile_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @profile_integration_id = profile_integration_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/talon_one/models/customer_profile_integration_request_v2.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
 
@@ -20,7 +20,7 @@ module TalonOne
 
     attr_accessor :audiences_changes
 
-    # Optional list of requested information to be present on the response related to the customer profile update. Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\". 
+    # Optional list of requested information to be present on the response related to the customer profile update.  Currently supported: \"customerProfile\", \"triggeredCampaigns\", \"loyalty\", \"event\", \"awardedGiveaways\", \"ruleFailureReasons\".  **Note:** `ruleFailureReasons` is always part of the response when the Application type is `sandbox`. 
     attr_accessor :response_content
 
     class EnumAttributeValidator

data/lib/talon_one/models/customer_profile_search_query.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
 
@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class CustomerProfileSearchQuery
-    # Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes
+    # Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes.
     attr_accessor :attributes
 
     attr_accessor :integration_i_ds

data/lib/talon_one/models/customer_session.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
 
@@ -24,7 +24,7 @@ module TalonOne
     # The ID of the application that owns this entity.
     attr_accessor :application_id
 
-    # ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID.
+    # ID of the customers profile as used within this Talon.One account.  **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. 
     attr_accessor :profile_id
 
     # Any coupon code entered.
@@ -33,13 +33,13 @@ module TalonOne
     # Any referral code entered.
     attr_accessor :referral
 
-    # Indicates the current state of the session. All sessions must start in the \"open\" state, after which valid transitions are...  1. open -> closed 2. open -> cancelled 3. closed -> cancelled 
+    # Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are:  1. `open` → `closed` 2. `open` → `cancelled` 3. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled`  For more information, see [Entities](/docs/dev/concepts/entities#customer-session). 
     attr_accessor :state
 
     # Serialized JSON representation.
     attr_accessor :cart_items
 
-    # Identifiers for the customer, this can be used for limits on values such as device ID.
+    # Session custom identifiers that you can set limits on or use inside your rules.  For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers/). 
     attr_accessor :identifiers
 
     # The total sum of the cart in one session.
@@ -54,6 +54,9 @@ module TalonOne
     # A map of labelled discount values, values will be in the same currency as the application associated with the session.
     attr_accessor :discounts
 
+    # Timestamp of the most recent event received on this session
+    attr_accessor :updated
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -91,7 +94,8 @@ module TalonOne
         :'total' => :'total',
         :'attributes' => :'attributes',
         :'first_session' => :'firstSession',
-        :'discounts' => :'discounts'
+        :'discounts' => :'discounts',
+        :'updated' => :'updated'
       }
     end
 
@@ -110,7 +114,8 @@ module TalonOne
         :'total' => :'Float',
         :'attributes' => :'Object',
         :'first_session' => :'Boolean',
-        :'discounts' => :'Hash<String, Float>'
+        :'discounts' => :'Hash<String, Float>',
+        :'updated' => :'DateTime'
       }
     end
 
@@ -194,6 +199,10 @@ module TalonOne
           self.discounts = value
         end
       end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -204,6 +213,10 @@ module TalonOne
         invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
       end
 
+      if @integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
       if @created.nil?
         invalid_properties.push('invalid value for "created", created cannot be nil.')
       end
@@ -256,6 +269,10 @@ module TalonOne
         invalid_properties.push('invalid value for "discounts", discounts cannot be nil.')
       end
 
+      if @updated.nil?
+        invalid_properties.push('invalid value for "updated", updated cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -263,6 +280,7 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @integration_id.nil?
+      return false if @integration_id.to_s.length > 1000
       return false if @created.nil?
       return false if @application_id.nil?
       return false if @profile_id.nil?
@@ -271,16 +289,31 @@ module TalonOne
       return false if @referral.nil?
       return false if @referral.to_s.length > 100
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"])
+      state_validator = EnumAttributeValidator.new('String', ["open", "closed", "partially_returned", "cancelled"])
       return false unless state_validator.valid?(@state)
       return false if @cart_items.nil?
       return false if @total.nil?
       return false if @attributes.nil?
       return false if @first_session.nil?
       return false if @discounts.nil?
+      return false if @updated.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] integration_id Value to be assigned
+    def integration_id=(integration_id)
+      if integration_id.nil?
+        fail ArgumentError, 'integration_id cannot be nil'
+      end
+
+      if integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      @integration_id = integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] coupon Value to be assigned
     def coupon=(coupon)
@@ -312,7 +345,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["open", "closed", "cancelled"])
+      validator = EnumAttributeValidator.new('String', ["open", "closed", "partially_returned", "cancelled"])
       unless validator.valid?(state)
         fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
       end
@@ -336,7 +369,8 @@ module TalonOne
           total == o.total &&
           attributes == o.attributes &&
           first_session == o.first_session &&
-          discounts == o.discounts
+          discounts == o.discounts &&
+          updated == o.updated
     end
 
     # @see the `==` method
@@ -348,7 +382,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [integration_id, created, application_id, profile_id, coupon, referral, state, cart_items, identifiers, total, attributes, first_session, discounts].hash
+      [integration_id, created, application_id, profile_id, coupon, referral, state, cart_items, identifiers, total, attributes, first_session, discounts, updated].hash
     end
 
     # Builds the object from hash