talon_one 8.0.0 → 10.0.0

data/lib/talon_one/models/sku_unit_analytics.rb

@@ -0,0 +1,227 @@
+=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 SkuUnitAnalytics
+    attr_accessor :data
+
+    attr_accessor :totals
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'totals' => :'totals'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'Array<SkuUnitAnalyticsDataPoint>',
+        :'totals' => :'ProductUnitAnalyticsTotals'
+      }
+    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::SkuUnitAnalytics` 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::SkuUnitAnalytics`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'totals')
+        self.totals = attributes[:'totals']
+      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 @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @totals.nil?
+        invalid_properties.push('invalid value for "totals", totals 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 @data.nil?
+      return false if @totals.nil?
+      true
+    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 &&
+          data == o.data &&
+          totals == o.totals
+    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
+      [data, totals].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/sku_unit_analytics_data_point.rb

@@ -0,0 +1,256 @@
+=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 SkuUnitAnalyticsDataPoint
+    # The start of the aggregation time frame in UTC.
+    attr_accessor :start_time
+
+    # The end of the aggregation time frame in UTC.
+    attr_accessor :end_time
+
+    attr_accessor :units_sold
+
+    # The SKU linked to the application.
+    attr_accessor :sku
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_time' => :'startTime',
+        :'end_time' => :'endTime',
+        :'units_sold' => :'unitsSold',
+        :'sku' => :'sku'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start_time' => :'DateTime',
+        :'end_time' => :'DateTime',
+        :'units_sold' => :'AnalyticsDataPointWithTrend',
+        :'sku' => :'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::SkuUnitAnalyticsDataPoint` 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::SkuUnitAnalyticsDataPoint`. 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?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
+
+      if attributes.key?(:'units_sold')
+        self.units_sold = attributes[:'units_sold']
+      end
+
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
+      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 @start_time.nil?
+        invalid_properties.push('invalid value for "start_time", start_time cannot be nil.')
+      end
+
+      if @end_time.nil?
+        invalid_properties.push('invalid value for "end_time", end_time cannot be nil.')
+      end
+
+      if @units_sold.nil?
+        invalid_properties.push('invalid value for "units_sold", units_sold cannot be nil.')
+      end
+
+      if @sku.nil?
+        invalid_properties.push('invalid value for "sku", sku 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 @start_time.nil?
+      return false if @end_time.nil?
+      return false if @units_sold.nil?
+      return false if @sku.nil?
+      true
+    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 &&
+          start_time == o.start_time &&
+          end_time == o.end_time &&
+          units_sold == o.units_sold &&
+          sku == o.sku
+    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
+      [start_time, end_time, units_sold, sku].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/store.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class Store
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/strikethrough_labeling_notification.rb

@@ -18,6 +18,9 @@ module TalonOne
     # The version of the strikethrough pricing notification.
     attr_accessor :version
 
+    # Timestamp at which the strikethrough pricing update becomes valid. Set for **scheduled** strikethrough pricing updates (version: v2) only. 
+    attr_accessor :valid_from
+
     # The ID of the Application to which the catalog items labels belongs.
     attr_accessor :application_id
 
@@ -57,6 +60,7 @@ module TalonOne
     def self.attribute_map
       {
         :'version' => :'version',
+        :'valid_from' => :'validFrom',
         :'application_id' => :'applicationId',
         :'current_batch' => :'currentBatch',
         :'total_batches' => :'totalBatches',
@@ -69,6 +73,7 @@ module TalonOne
     def self.openapi_types
       {
         :'version' => :'String',
+        :'valid_from' => :'DateTime',
         :'application_id' => :'Integer',
         :'current_batch' => :'Integer',
         :'total_batches' => :'Integer',
@@ -102,6 +107,10 @@ module TalonOne
         self.version = attributes[:'version']
       end
 
+      if attributes.key?(:'valid_from')
+        self.valid_from = attributes[:'valid_from']
+      end
+
       if attributes.key?(:'application_id')
         self.application_id = attributes[:'application_id']
       end
@@ -181,6 +190,7 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           version == o.version &&
+          valid_from == o.valid_from &&
           application_id == o.application_id &&
           current_batch == o.current_batch &&
           total_batches == o.total_batches &&
@@ -197,7 +207,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [version, application_id, current_batch, total_batches, trigger, changed_items].hash
+      [version, valid_from, application_id, current_batch, total_batches, trigger, changed_items].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/template_def.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class TemplateDef
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.

data/lib/talon_one/models/update_achievement.rb

@@ -31,7 +31,7 @@ module TalonOne
 
     attr_accessor :period_end_override
 
-    # The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. 
+    # The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. 
     attr_accessor :recurrence_policy
 
     # The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. 
@@ -185,7 +185,7 @@ module TalonOne
       return false if !@name.nil? && @name.to_s.length > 1000
       return false if !@name.nil? && @name.to_s.length < 1
       return false if !@name.nil? && @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
-      recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
       return false unless recurrence_policy_validator.valid?(@recurrence_policy)
       activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
       return false unless activation_policy_validator.valid?(@activation_policy)
@@ -214,7 +214,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] recurrence_policy Object to be assigned
     def recurrence_policy=(recurrence_policy)
-      validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
+      validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
       unless validator.valid?(recurrence_policy)
         fail ArgumentError, "invalid value for \"recurrence_policy\", must be one of #{validator.allowable_values}."
       end

data/lib/talon_one/models/update_coupon.rb

@@ -154,8 +154,8 @@ module TalonOne
         invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
       end
 
-      if !@discount_limit.nil? && @discount_limit > 999999
-        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -182,7 +182,7 @@ module TalonOne
     def valid?
       return false if !@usage_limit.nil? && @usage_limit > 999999
       return false if !@usage_limit.nil? && @usage_limit < 0
-      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -207,8 +207,8 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] discount_limit Value to be assigned
     def discount_limit=(discount_limit)
-      if !discount_limit.nil? && discount_limit > 999999
-        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/update_coupon_batch.rb

@@ -123,8 +123,8 @@ module TalonOne
         invalid_properties.push('invalid value for "usage_limit", must be greater than or equal to 0.')
       end
 
-      if !@discount_limit.nil? && @discount_limit > 999999
-        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 999999.')
+      if !@discount_limit.nil? && @discount_limit > 1E+15
+        invalid_properties.push('invalid value for "discount_limit", must be smaller than or equal to 1E+15.')
       end
 
       if !@discount_limit.nil? && @discount_limit < 0
@@ -147,7 +147,7 @@ module TalonOne
     def valid?
       return false if !@usage_limit.nil? && @usage_limit > 999999
       return false if !@usage_limit.nil? && @usage_limit < 0
-      return false if !@discount_limit.nil? && @discount_limit > 999999
+      return false if !@discount_limit.nil? && @discount_limit > 1E+15
       return false if !@discount_limit.nil? && @discount_limit < 0
       return false if !@reservation_limit.nil? && @reservation_limit > 999999
       return false if !@reservation_limit.nil? && @reservation_limit < 0
@@ -171,8 +171,8 @@ module TalonOne
     # Custom attribute writer method with validation
     # @param [Object] discount_limit Value to be assigned
     def discount_limit=(discount_limit)
-      if !discount_limit.nil? && discount_limit > 999999
-        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 999999.'
+      if !discount_limit.nil? && discount_limit > 1E+15
+        fail ArgumentError, 'invalid value for "discount_limit", must be smaller than or equal to 1E+15.'
       end
 
       if !discount_limit.nil? && discount_limit < 0

data/lib/talon_one/models/user.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class User
-    # Internal ID of this entity.
+    # The internal ID of this entity.
     attr_accessor :id
 
     # The time this entity was created.