talon_one 7.0.0 → 9.0.0

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

@@ -32,7 +32,7 @@ module TalonOne
     # The integration ID of the store. You choose this ID when you create a store.  **Note**: You cannot edit the `integrationId` after the store has been created. 
     attr_accessor :integration_id
 
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # Timestamp of the most recent update on this entity.

data/lib/talon_one/models/strikethrough_effect.rb

@@ -32,6 +32,12 @@ module TalonOne
 
     attr_accessor :props
 
+    # The start of the time frame where the effect is active in UTC.
+    attr_accessor :start_time
+
+    # The end of the time frame where the effect is active in UTC.
+    attr_accessor :end_time
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -40,7 +46,9 @@ module TalonOne
         :'rule_index' => :'ruleIndex',
         :'rule_name' => :'ruleName',
         :'type' => :'type',
-        :'props' => :'props'
+        :'props' => :'props',
+        :'start_time' => :'startTime',
+        :'end_time' => :'endTime'
       }
     end
 
@@ -52,7 +60,9 @@ module TalonOne
         :'rule_index' => :'Integer',
         :'rule_name' => :'String',
         :'type' => :'String',
-        :'props' => :'Object'
+        :'props' => :'Object',
+        :'start_time' => :'DateTime',
+        :'end_time' => :'DateTime'
       }
     end
 
@@ -100,6 +110,14 @@ module TalonOne
       if attributes.key?(:'props')
         self.props = attributes[:'props']
       end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -155,7 +173,9 @@ module TalonOne
           rule_index == o.rule_index &&
           rule_name == o.rule_name &&
           type == o.type &&
-          props == o.props
+          props == o.props &&
+          start_time == o.start_time &&
+          end_time == o.end_time
     end
 
     # @see the `==` method
@@ -167,7 +187,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [campaign_id, ruleset_id, rule_index, rule_name, type, props].hash
+      [campaign_id, ruleset_id, rule_index, rule_name, type, props, start_time, end_time].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/strikethrough_labeling_notification.rb

@@ -15,7 +15,13 @@ require 'date'
 module TalonOne
   # The strikethrough labels notification for an application.
   class StrikethroughLabelingNotification
-    # The ID of the application that catalog items labels belongs to.
+    # 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
 
     # The batch number of the notification. Notifications might be sent in different batches.
@@ -28,9 +34,33 @@ module TalonOne
 
     attr_accessor :changed_items
 
+    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
       {
+        :'version' => :'version',
+        :'valid_from' => :'validFrom',
         :'application_id' => :'applicationId',
         :'current_batch' => :'currentBatch',
         :'total_batches' => :'totalBatches',
@@ -42,6 +72,8 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'version' => :'String',
+        :'valid_from' => :'DateTime',
         :'application_id' => :'Integer',
         :'current_batch' => :'Integer',
         :'total_batches' => :'Integer',
@@ -71,6 +103,14 @@ module TalonOne
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'version')
+        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
@@ -124,6 +164,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?
+      version_validator = EnumAttributeValidator.new('String', ["v2"])
+      return false unless version_validator.valid?(@version)
       return false if @application_id.nil?
       return false if @current_batch.nil?
       return false if @total_batches.nil?
@@ -132,11 +174,23 @@ module TalonOne
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] version Object to be assigned
+    def version=(version)
+      validator = EnumAttributeValidator.new('String', ["v2"])
+      unless validator.valid?(version)
+        fail ArgumentError, "invalid value for \"version\", must be one of #{validator.allowable_values}."
+      end
+      @version = version
+    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 &&
+          version == o.version &&
+          valid_from == o.valid_from &&
           application_id == o.application_id &&
           current_batch == o.current_batch &&
           total_batches == o.total_batches &&
@@ -153,7 +207,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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/summary_campaign_store_budget.rb

@@ -20,6 +20,8 @@ module TalonOne
 
     attr_accessor :store_count
 
+    attr_accessor :imported
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -47,7 +49,8 @@ module TalonOne
       {
         :'action' => :'action',
         :'period' => :'period',
-        :'store_count' => :'storeCount'
+        :'store_count' => :'storeCount',
+        :'imported' => :'imported'
       }
     end
 
@@ -56,7 +59,8 @@ module TalonOne
       {
         :'action' => :'String',
         :'period' => :'String',
-        :'store_count' => :'Integer'
+        :'store_count' => :'Integer',
+        :'imported' => :'Boolean'
       }
     end
 
@@ -92,6 +96,10 @@ module TalonOne
       if attributes.key?(:'store_count')
         self.store_count = attributes[:'store_count']
       end
+
+      if attributes.key?(:'imported')
+        self.imported = attributes[:'imported']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -106,6 +114,10 @@ module TalonOne
         invalid_properties.push('invalid value for "store_count", store_count cannot be nil.')
       end
 
+      if @imported.nil?
+        invalid_properties.push('invalid value for "imported", imported cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -118,6 +130,7 @@ module TalonOne
       period_validator = EnumAttributeValidator.new('String', ["overall", "daily", "weekly", "monthly", "yearly"])
       return false unless period_validator.valid?(@period)
       return false if @store_count.nil?
+      return false if @imported.nil?
       true
     end
 
@@ -148,7 +161,8 @@ module TalonOne
       self.class == o.class &&
           action == o.action &&
           period == o.period &&
-          store_count == o.store_count
+          store_count == o.store_count &&
+          imported == o.imported
     end
 
     # @see the `==` method
@@ -160,7 +174,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, period, store_count].hash
+      [action, period, store_count, imported].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/template_def.rb

@@ -20,7 +20,7 @@ module TalonOne
     # The time this entity was created.
     attr_accessor :created
 
-    # The ID of the application that owns this entity.
+    # The ID of the Application that owns this entity.
     attr_accessor :application_id
 
     # Campaigner-friendly name for the template that will be shown in the rule editor.

data/lib/talon_one/models/tier_downgrade_notification_policy.rb

@@ -20,11 +20,15 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'batching_enabled' => :'batchingEnabled'
+        :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize'
       }
     end
 
@@ -32,7 +36,8 @@ module TalonOne
     def self.openapi_types
       {
         :'name' => :'String',
-        :'batching_enabled' => :'Boolean'
+        :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer'
       }
     end
 
@@ -66,6 +71,10 @@ module TalonOne
       else
         self.batching_enabled = true
       end
+
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +120,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          batching_enabled == o.batching_enabled
+          batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size
     end
 
     # @see the `==` method
@@ -123,7 +133,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled].hash
+      [name, batching_enabled, batch_size].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/tier_upgrade_notification_policy.rb

@@ -20,11 +20,15 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
-        :'batching_enabled' => :'batchingEnabled'
+        :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize'
       }
     end
 
@@ -32,7 +36,8 @@ module TalonOne
     def self.openapi_types
       {
         :'name' => :'String',
-        :'batching_enabled' => :'Boolean'
+        :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer'
       }
     end
 
@@ -66,6 +71,10 @@ module TalonOne
       else
         self.batching_enabled = true
       end
+
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,7 +120,8 @@ module TalonOne
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
-          batching_enabled == o.batching_enabled
+          batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size
     end
 
     # @see the `==` method
@@ -123,7 +133,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled].hash
+      [name, batching_enabled, batch_size].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb

@@ -20,6 +20,9 @@ module TalonOne
     # Indicates whether batching is activated.
     attr_accessor :batching_enabled
 
+    # The required size of each batch of data. This value applies only when `batchingEnabled` is `true`.
+    attr_accessor :batch_size
+
     attr_accessor :triggers
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -27,6 +30,7 @@ module TalonOne
       {
         :'name' => :'name',
         :'batching_enabled' => :'batchingEnabled',
+        :'batch_size' => :'batchSize',
         :'triggers' => :'triggers'
       }
     end
@@ -36,6 +40,7 @@ module TalonOne
       {
         :'name' => :'String',
         :'batching_enabled' => :'Boolean',
+        :'batch_size' => :'Integer',
         :'triggers' => :'Array<TierWillDowngradeNotificationTrigger>'
       }
     end
@@ -71,6 +76,10 @@ module TalonOne
         self.batching_enabled = true
       end
 
+      if attributes.key?(:'batch_size')
+        self.batch_size = attributes[:'batch_size']
+      end
+
       if attributes.key?(:'triggers')
         if (value = attributes[:'triggers']).is_a?(Array)
           self.triggers = value
@@ -127,6 +136,7 @@ module TalonOne
       self.class == o.class &&
           name == o.name &&
           batching_enabled == o.batching_enabled &&
+          batch_size == o.batch_size &&
           triggers == o.triggers
     end
 
@@ -139,7 +149,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, batching_enabled, triggers].hash
+      [name, batching_enabled, batch_size, triggers].hash
     end
 
     # Builds the object from hash