talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/new_customer_session_v2.rb

@@ -18,6 +18,9 @@ module TalonOne
     # 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`. 
     attr_accessor :profile_id
 
+    # The integration ID of the store. You choose this ID when you create a store.
+    attr_accessor :store_integration_id
+
     # 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. 
     attr_accessor :evaluable_campaign_ids
 
@@ -27,13 +30,13 @@ module TalonOne
     # Any referral code entered.  **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. 
     attr_accessor :referral_code
 
-    # Any loyalty cards used.
+    # Identifier of a loyalty card.
     attr_accessor :loyalty_cards
 
-    # 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. Either:    - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or    - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems))    - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled`  For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities#customer-session). 
+    # 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. Either:    - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or    - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems))    - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled`  For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). 
     attr_accessor :state
 
-    # The items to add to this sessions. - If cart item flattening is disabled: **Do not exceed 1000 items** (regardless of their `quantity`) per request. - If cart item flattening is enabled: **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. 
+    # The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. 
     attr_accessor :cart_items
 
     # Use this property to set a value for the additional costs of this session, 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). 
@@ -71,6 +74,7 @@ module TalonOne
     def self.attribute_map
       {
         :'profile_id' => :'profileId',
+        :'store_integration_id' => :'storeIntegrationId',
         :'evaluable_campaign_ids' => :'evaluableCampaignIds',
         :'coupon_codes' => :'couponCodes',
         :'referral_code' => :'referralCode',
@@ -87,6 +91,7 @@ module TalonOne
     def self.openapi_types
       {
         :'profile_id' => :'String',
+        :'store_integration_id' => :'String',
         :'evaluable_campaign_ids' => :'Array<Integer>',
         :'coupon_codes' => :'Array<String>',
         :'referral_code' => :'String',
@@ -124,6 +129,10 @@ module TalonOne
         self.profile_id = attributes[:'profile_id']
       end
 
+      if attributes.key?(:'store_integration_id')
+        self.store_integration_id = attributes[:'store_integration_id']
+      end
+
       if attributes.key?(:'evaluable_campaign_ids')
         if (value = attributes[:'evaluable_campaign_ids']).is_a?(Array)
           self.evaluable_campaign_ids = value
@@ -179,6 +188,14 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be great than or equal to 1.')
+      end
+
       if !@referral_code.nil? && @referral_code.to_s.length > 100
         invalid_properties.push('invalid value for "referral_code", the character length must be smaller than or equal to 100.')
       end
@@ -189,12 +206,28 @@ 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 !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+      return false if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
       return false if !@referral_code.nil? && @referral_code.to_s.length > 100
       state_validator = EnumAttributeValidator.new('String', ["open", "closed", "partially_returned", "cancelled"])
       return false unless state_validator.valid?(@state)
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] store_integration_id Value to be assigned
+    def store_integration_id=(store_integration_id)
+      if !store_integration_id.nil? && store_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !store_integration_id.nil? && store_integration_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be great than or equal to 1.'
+      end
+
+      @store_integration_id = store_integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] referral_code Value to be assigned
     def referral_code=(referral_code)
@@ -221,6 +254,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           profile_id == o.profile_id &&
+          store_integration_id == o.store_integration_id &&
           evaluable_campaign_ids == o.evaluable_campaign_ids &&
           coupon_codes == o.coupon_codes &&
           referral_code == o.referral_code &&
@@ -241,7 +275,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, evaluable_campaign_ids, coupon_codes, referral_code, loyalty_cards, state, cart_items, additional_costs, identifiers, attributes].hash
+      [profile_id, store_integration_id, evaluable_campaign_ids, coupon_codes, referral_code, loyalty_cards, state, cart_items, additional_costs, identifiers, attributes].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_event.rb

@@ -18,6 +18,9 @@ module TalonOne
     # 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`. 
     attr_accessor :profile_id
 
+    # The integration ID of the store. You choose this ID when you create a store.
+    attr_accessor :store_integration_id
+
     # A string representing the event. Must not be a reserved event name.
     attr_accessor :type
 
@@ -31,6 +34,7 @@ module TalonOne
     def self.attribute_map
       {
         :'profile_id' => :'profileId',
+        :'store_integration_id' => :'storeIntegrationId',
         :'type' => :'type',
         :'attributes' => :'attributes',
         :'session_id' => :'sessionId'
@@ -41,6 +45,7 @@ module TalonOne
     def self.openapi_types
       {
         :'profile_id' => :'String',
+        :'store_integration_id' => :'String',
         :'type' => :'String',
         :'attributes' => :'Object',
         :'session_id' => :'String'
@@ -72,6 +77,10 @@ module TalonOne
         self.profile_id = attributes[:'profile_id']
       end
 
+      if attributes.key?(:'store_integration_id')
+        self.store_integration_id = attributes[:'store_integration_id']
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
@@ -89,6 +98,14 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
+        invalid_properties.push('invalid value for "store_integration_id", the character length must be great than or equal to 1.')
+      end
+
       if @type.nil?
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
@@ -115,6 +132,8 @@ 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 !@store_integration_id.nil? && @store_integration_id.to_s.length > 1000
+      return false if !@store_integration_id.nil? && @store_integration_id.to_s.length < 1
       return false if @type.nil?
       return false if @type.to_s.length < 1
       return false if @attributes.nil?
@@ -123,6 +142,20 @@ module TalonOne
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] store_integration_id Value to be assigned
+    def store_integration_id=(store_integration_id)
+      if !store_integration_id.nil? && store_integration_id.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !store_integration_id.nil? && store_integration_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "store_integration_id", the character length must be great than or equal to 1.'
+      end
+
+      @store_integration_id = store_integration_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] type Value to be assigned
     def type=(type)
@@ -157,6 +190,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           profile_id == o.profile_id &&
+          store_integration_id == o.store_integration_id &&
           type == o.type &&
           attributes == o.attributes &&
           session_id == o.session_id
@@ -171,7 +205,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile_id, type, attributes, session_id].hash
+      [profile_id, store_integration_id, type, attributes, session_id].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_invitation.rb

@@ -15,24 +15,29 @@ require 'date'
 module TalonOne
   # Parameters for inviting a new user.
   class NewInvitation
-    # Name of the user being invited.
+    # Name of the user.
     attr_accessor :name
 
+    # Email address of the user.
     attr_accessor :email
 
-    # The `Access Control List` json defining the role of the user.  This represents the access control on the user level. Use one of the following: - normal user: `{\"Role\": 0}` - admin: `{\"Role\": 127}` 
-    attr_accessor :acl
+    # Indicates whether the user is an `admin`.
+    attr_accessor :is_admin
 
-    # An array of roleIDs to assign the new user to.
+    # A list of the IDs of the roles assigned to the user.
     attr_accessor :roles
 
+    # Indicates the access level of the user.
+    attr_accessor :acl
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'email' => :'email',
-        :'acl' => :'acl',
-        :'roles' => :'roles'
+        :'is_admin' => :'isAdmin',
+        :'roles' => :'roles',
+        :'acl' => :'acl'
       }
     end
 
@@ -41,8 +46,9 @@ module TalonOne
       {
         :'name' => :'String',
         :'email' => :'String',
-        :'acl' => :'String',
-        :'roles' => :'Array<Integer>'
+        :'is_admin' => :'Boolean',
+        :'roles' => :'Array<Integer>',
+        :'acl' => :'String'
       }
     end
 
@@ -75,8 +81,8 @@ module TalonOne
         self.email = attributes[:'email']
       end
 
-      if attributes.key?(:'acl')
-        self.acl = attributes[:'acl']
+      if attributes.key?(:'is_admin')
+        self.is_admin = attributes[:'is_admin']
       end
 
       if attributes.key?(:'roles')
@@ -84,6 +90,10 @@ module TalonOne
           self.roles = value
         end
       end
+
+      if attributes.key?(:'acl')
+        self.acl = attributes[:'acl']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -94,10 +104,6 @@ module TalonOne
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @acl.nil?
-        invalid_properties.push('invalid value for "acl", acl cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -105,7 +111,6 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @email.nil?
-      return false if @acl.nil?
       true
     end
 
@@ -116,8 +121,9 @@ module TalonOne
       self.class == o.class &&
           name == o.name &&
           email == o.email &&
-          acl == o.acl &&
-          roles == o.roles
+          is_admin == o.is_admin &&
+          roles == o.roles &&
+          acl == o.acl
     end
 
     # @see the `==` method
@@ -129,7 +135,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, email, acl, roles].hash
+      [name, email, is_admin, roles, acl].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/new_invite_email.rb

@@ -14,8 +14,10 @@ require 'date'
 
 module TalonOne
   class NewInviteEmail
+    # Email address of the user.
     attr_accessor :email
 
+    # Invitation token of the user.
     attr_accessor :token
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -72,18 +74,10 @@ module TalonOne
         invalid_properties.push('invalid value for "email", email cannot be nil.')
       end
 
-      if @email.to_s.length < 1
-        invalid_properties.push('invalid value for "email", the character length must be great than or equal to 1.')
-      end
-
       if @token.nil?
         invalid_properties.push('invalid value for "token", token cannot be nil.')
       end
 
-      if @token.to_s.length < 1
-        invalid_properties.push('invalid value for "token", the character length must be great than or equal to 1.')
-      end
-
       invalid_properties
     end
 
@@ -91,40 +85,10 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @email.nil?
-      return false if @email.to_s.length < 1
       return false if @token.nil?
-      return false if @token.to_s.length < 1
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] email Value to be assigned
-    def email=(email)
-      if email.nil?
-        fail ArgumentError, 'email cannot be nil'
-      end
-
-      if email.to_s.length < 1
-        fail ArgumentError, 'invalid value for "email", the character length must be great than or equal to 1.'
-      end
-
-      @email = email
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] token Value to be assigned
-    def token=(token)
-      if token.nil?
-        fail ArgumentError, 'token cannot be nil'
-      end
-
-      if token.to_s.length < 1
-        fail ArgumentError, 'invalid value for "token", the character length must be great than or equal to 1.'
-      end
-
-      @token = token
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/talon_one/models/new_loyalty_program.rb

@@ -39,6 +39,18 @@ module TalonOne
     # Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.
     attr_accessor :sandbox
 
+    # The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. 
+    attr_accessor :tiers_expiration_policy
+
+    # The amount of time after which the tier expires.  The time format is an **integer** 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 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. 
+    attr_accessor :tiers_expire_in
+
+    # Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. 
+    attr_accessor :tiers_downgrade_policy
+
+    # The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. 
+    attr_accessor :program_join_policy
+
     # The internal name for the Loyalty Program. This is an immutable value.
     attr_accessor :name
 
@@ -51,6 +63,28 @@ module TalonOne
     # Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. 
     attr_accessor :card_based
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -62,6 +96,10 @@ module TalonOne
         :'allow_subledger' => :'allowSubledger',
         :'users_per_card_limit' => :'usersPerCardLimit',
         :'sandbox' => :'sandbox',
+        :'tiers_expiration_policy' => :'tiersExpirationPolicy',
+        :'tiers_expire_in' => :'tiersExpireIn',
+        :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
+        :'program_join_policy' => :'programJoinPolicy',
         :'name' => :'name',
         :'tiers' => :'tiers',
         :'timezone' => :'timezone',
@@ -80,6 +118,10 @@ module TalonOne
         :'allow_subledger' => :'Boolean',
         :'users_per_card_limit' => :'Integer',
         :'sandbox' => :'Boolean',
+        :'tiers_expiration_policy' => :'String',
+        :'tiers_expire_in' => :'String',
+        :'tiers_downgrade_policy' => :'String',
+        :'program_join_policy' => :'String',
         :'name' => :'String',
         :'tiers' => :'Array<NewLoyaltyTier>',
         :'timezone' => :'String',
@@ -142,6 +184,22 @@ module TalonOne
         self.sandbox = attributes[:'sandbox']
       end
 
+      if attributes.key?(:'tiers_expiration_policy')
+        self.tiers_expiration_policy = attributes[:'tiers_expiration_policy']
+      end
+
+      if attributes.key?(:'tiers_expire_in')
+        self.tiers_expire_in = attributes[:'tiers_expire_in']
+      end
+
+      if attributes.key?(:'tiers_downgrade_policy')
+        self.tiers_downgrade_policy = attributes[:'tiers_downgrade_policy']
+      end
+
+      if attributes.key?(:'program_join_policy')
+        self.program_join_policy = attributes[:'program_join_policy']
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -219,6 +277,12 @@ module TalonOne
       return false if @allow_subledger.nil?
       return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
       return false if @sandbox.nil?
+      tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
+      tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
+      program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      return false unless program_join_policy_validator.valid?(@program_join_policy)
       return false if @name.nil?
       return false if @timezone.nil?
       return false if @timezone.to_s.length < 1
@@ -236,6 +300,36 @@ module TalonOne
       @users_per_card_limit = users_per_card_limit
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tiers_expiration_policy Object to be assigned
+    def tiers_expiration_policy=(tiers_expiration_policy)
+      validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date"])
+      unless validator.valid?(tiers_expiration_policy)
+        fail ArgumentError, "invalid value for \"tiers_expiration_policy\", must be one of #{validator.allowable_values}."
+      end
+      @tiers_expiration_policy = tiers_expiration_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] tiers_downgrade_policy Object to be assigned
+    def tiers_downgrade_policy=(tiers_downgrade_policy)
+      validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
+      unless validator.valid?(tiers_downgrade_policy)
+        fail ArgumentError, "invalid value for \"tiers_downgrade_policy\", must be one of #{validator.allowable_values}."
+      end
+      @tiers_downgrade_policy = tiers_downgrade_policy
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] program_join_policy Object to be assigned
+    def program_join_policy=(program_join_policy)
+      validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
+      unless validator.valid?(program_join_policy)
+        fail ArgumentError, "invalid value for \"program_join_policy\", must be one of #{validator.allowable_values}."
+      end
+      @program_join_policy = program_join_policy
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] timezone Value to be assigned
     def timezone=(timezone)
@@ -263,6 +357,10 @@ module TalonOne
           allow_subledger == o.allow_subledger &&
           users_per_card_limit == o.users_per_card_limit &&
           sandbox == o.sandbox &&
+          tiers_expiration_policy == o.tiers_expiration_policy &&
+          tiers_expire_in == o.tiers_expire_in &&
+          tiers_downgrade_policy == o.tiers_downgrade_policy &&
+          program_join_policy == o.program_join_policy &&
           name == o.name &&
           tiers == o.tiers &&
           timezone == o.timezone &&
@@ -278,7 +376,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, name, tiers, timezone, card_based].hash
+      [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, tiers_expiration_policy, tiers_expire_in, tiers_downgrade_policy, program_join_policy, name, tiers, timezone, card_based].hash
     end
 
     # Builds the object from hash