talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/create_achievement.rb

@@ -0,0 +1,320 @@
+=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 CreateAchievement
+    # The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created. 
+    attr_accessor :name
+
+    # The display name for the achievement in the Campaign Manager.
+    attr_accessor :title
+
+    # A description of the achievement.
+    attr_accessor :description
+
+    # The required number of actions or the transactional milestone to complete the achievement.
+    attr_accessor :target
+
+    # The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The `period` does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U`  **Note**: You can either use the round down and round up option or set an absolute period. 
+    attr_accessor :period
+
+    attr_accessor :period_end_override
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'title' => :'title',
+        :'description' => :'description',
+        :'target' => :'target',
+        :'period' => :'period',
+        :'period_end_override' => :'periodEndOverride'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'title' => :'String',
+        :'description' => :'String',
+        :'target' => :'Float',
+        :'period' => :'String',
+        :'period_end_override' => :'TimePoint'
+      }
+    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::CreateAchievement` 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::CreateAchievement`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      end
+
+      if attributes.key?(:'period_end_override')
+        self.period_end_override = attributes[:'period_end_override']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 1000
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      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 @name.nil?
+      return false if @name.to_s.length > 1000
+      return false if @name.to_s.length < 1
+      return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
+      return false if @title.nil?
+      return false if @description.nil?
+      return false if @target.nil?
+      return false if @period.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 1000.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z]\w+$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    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 &&
+          name == o.name &&
+          title == o.title &&
+          description == o.description &&
+          target == o.target &&
+          period == o.period &&
+          period_end_override == o.period_end_override
+    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
+      [name, title, description, target, period, period_end_override].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/create_application_api_key.rb

@@ -14,15 +14,21 @@ require 'date'
 
 module TalonOne
   class CreateApplicationAPIKey
-    # Title for API Key.
+    # Title of the API key.
     attr_accessor :title
 
-    # The date the API key expired.
+    # The date the API key expires.
     attr_accessor :expires
 
     # The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own integration layer. 
     attr_accessor :platform
 
+    # The API key type. Can be empty or `staging`.  Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.  When using the _Update customer profile_ endpoint with a staging API key, the query parameter `runRuleEngine` must be `true`. 
+    attr_accessor :type
+
+    # A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date. 
+    attr_accessor :time_offset
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,7 +56,9 @@ module TalonOne
       {
         :'title' => :'title',
         :'expires' => :'expires',
-        :'platform' => :'platform'
+        :'platform' => :'platform',
+        :'type' => :'type',
+        :'time_offset' => :'timeOffset'
       }
     end
 
@@ -59,7 +67,9 @@ module TalonOne
       {
         :'title' => :'String',
         :'expires' => :'DateTime',
-        :'platform' => :'String'
+        :'platform' => :'String',
+        :'type' => :'String',
+        :'time_offset' => :'Integer'
       }
     end
 
@@ -95,6 +105,14 @@ module TalonOne
       if attributes.key?(:'platform')
         self.platform = attributes[:'platform']
       end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'time_offset')
+        self.time_offset = attributes[:'time_offset']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,21 +135,33 @@ module TalonOne
     def valid?
       return false if @title.nil?
       return false if @expires.nil?
-      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
+      platform_validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
       return false unless platform_validator.valid?(@platform)
+      type_validator = EnumAttributeValidator.new('String', ["staging"])
+      return false unless type_validator.valid?(@type)
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] platform Object to be assigned
     def platform=(platform)
-      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce"])
+      validator = EnumAttributeValidator.new('String', ["none", "segment", "braze", "mparticle", "selligent", "iterable", "customer_engagement", "customer_data", "salesforce", "emarsys"])
       unless validator.valid?(platform)
         fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
       end
       @platform = platform
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["staging"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -139,7 +169,9 @@ module TalonOne
       self.class == o.class &&
           title == o.title &&
           expires == o.expires &&
-          platform == o.platform
+          platform == o.platform &&
+          type == o.type &&
+          time_offset == o.time_offset
     end
 
     # @see the `==` method
@@ -151,7 +183,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, expires, platform].hash
+      [title, expires, platform, type, time_offset].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/create_template_campaign.rb

@@ -32,12 +32,18 @@ module TalonOne
     # Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden.
     attr_accessor :limit_overrides
 
-    # The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. 
+    # The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. 
     attr_accessor :campaign_groups
 
     # A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list.
     attr_accessor :tags
 
+    # The ID of the campaign evaluation group the campaign belongs to.
+    attr_accessor :evaluation_group_id
+
+    # A list of store IDs that are linked to the campaign.  **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. 
+    attr_accessor :linked_store_ids
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +54,9 @@ module TalonOne
         :'template_param_values' => :'templateParamValues',
         :'limit_overrides' => :'limitOverrides',
         :'campaign_groups' => :'campaignGroups',
-        :'tags' => :'tags'
+        :'tags' => :'tags',
+        :'evaluation_group_id' => :'evaluationGroupId',
+        :'linked_store_ids' => :'linkedStoreIds'
       }
     end
 
@@ -62,7 +70,9 @@ module TalonOne
         :'template_param_values' => :'Array<Binding>',
         :'limit_overrides' => :'Array<LimitConfig>',
         :'campaign_groups' => :'Array<Integer>',
-        :'tags' => :'Array<String>'
+        :'tags' => :'Array<String>',
+        :'evaluation_group_id' => :'Integer',
+        :'linked_store_ids' => :'Array<Integer>'
       }
     end
 
@@ -126,6 +136,16 @@ module TalonOne
           self.tags = value
         end
       end
+
+      if attributes.key?(:'evaluation_group_id')
+        self.evaluation_group_id = attributes[:'evaluation_group_id']
+      end
+
+      if attributes.key?(:'linked_store_ids')
+        if (value = attributes[:'linked_store_ids']).is_a?(Array)
+          self.linked_store_ids = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -182,7 +202,9 @@ module TalonOne
           template_param_values == o.template_param_values &&
           limit_overrides == o.limit_overrides &&
           campaign_groups == o.campaign_groups &&
-          tags == o.tags
+          tags == o.tags &&
+          evaluation_group_id == o.evaluation_group_id &&
+          linked_store_ids == o.linked_store_ids
     end
 
     # @see the `==` method
@@ -194,7 +216,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, template_id, campaign_attributes_overrides, template_param_values, limit_overrides, campaign_groups, tags].hash
+      [name, description, template_id, campaign_attributes_overrides, template_param_values, limit_overrides, campaign_groups, tags, evaluation_group_id, linked_store_ids].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/custom_effect_props.rb

@@ -24,7 +24,7 @@ module TalonOne
     # The index of the item in the cart item list to which the custom effect is applied.
     attr_accessor :cart_item_position
 
-    # When cart item flattening is enabled, the sub position indicates to which item unit the custom effect is applied, for cart items with quantity > 1. 
+    # For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. 
     attr_accessor :cart_item_sub_position
 
     # The position of the bundle in a list of item bundles created from the same bundle definition.

data/lib/talon_one/models/customer_inventory.rb

@@ -25,6 +25,8 @@ module TalonOne
 
     attr_accessor :giveaways
 
+    attr_accessor :achievements
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -32,7 +34,8 @@ module TalonOne
         :'loyalty' => :'loyalty',
         :'referrals' => :'referrals',
         :'coupons' => :'coupons',
-        :'giveaways' => :'giveaways'
+        :'giveaways' => :'giveaways',
+        :'achievements' => :'achievements'
       }
     end
 
@@ -43,7 +46,8 @@ module TalonOne
         :'loyalty' => :'Loyalty',
         :'referrals' => :'Array<InventoryReferral>',
         :'coupons' => :'Array<InventoryCoupon>',
-        :'giveaways' => :'Array<Giveaway>'
+        :'giveaways' => :'Array<Giveaway>',
+        :'achievements' => :'Array<AchievementProgress>'
       }
     end
 
@@ -93,6 +97,12 @@ module TalonOne
           self.giveaways = value
         end
       end
+
+      if attributes.key?(:'achievements')
+        if (value = attributes[:'achievements']).is_a?(Array)
+          self.achievements = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +127,8 @@ module TalonOne
           loyalty == o.loyalty &&
           referrals == o.referrals &&
           coupons == o.coupons &&
-          giveaways == o.giveaways
+          giveaways == o.giveaways &&
+          achievements == o.achievements
     end
 
     # @see the `==` method
@@ -129,7 +140,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profile, loyalty, referrals, coupons, giveaways].hash
+      [profile, loyalty, referrals, coupons, giveaways, achievements].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/customer_profile.rb

@@ -42,10 +42,10 @@ module TalonOne
     # The audiences the customer belongs to.
     attr_accessor :audience_memberships
 
-    # 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. 
+    # 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
 
-    # Shows whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). 
+    # An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments). 
     attr_accessor :sandbox
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/talon_one/models/customer_profile_audience_request_item.rb

@@ -14,7 +14,7 @@ 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. 
+    # Defines the action to perform: - `add`: Adds the customer profile to the audience. If the customer profile does not exist, it will be created. - `delete`: Removes the customer profile from the audience. 
     attr_accessor :action
 
     # The ID of this customer profile in the third-party integration.