talon_one 7.0.0 → 8.0.0

data/lib/talon_one/models/product.rb

@@ -66,10 +66,6 @@ module TalonOne
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
-      if @name.to_s.length > 50
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
-      end
-
       invalid_properties
     end
 
@@ -77,24 +73,9 @@ module TalonOne
     # @return true if the model is valid
     def valid?
       return false if @name.nil?
-      return false if @name.to_s.length > 50
       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 > 50
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.'
-      end
-
-      @name = name
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/talon_one/models/product_search_match.rb

@@ -20,7 +20,7 @@ module TalonOne
     # The string matching the given value. Either a product name or SKU.
     attr_accessor :value
 
-    # The ID of the SKU linked to a product. If empty, this is an analytics-level product.
+    # The ID of the SKU linked to a product. If empty, this is an product.
     attr_accessor :product_sku_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -79,10 +79,6 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @product_id.nil?
-        invalid_properties.push('invalid value for "product_id", product_id cannot be nil.')
-      end
-
       if @value.nil?
         invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
@@ -93,7 +89,6 @@ 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 @product_id.nil?
       return false if @value.nil?
       true
     end

data/lib/talon_one/models/product_unit_analytics.rb

@@ -14,39 +14,23 @@ require 'date'
 
 module TalonOne
   class ProductUnitAnalytics
-    # The start of the aggregation time frame in UTC.
-    attr_accessor :start_time
+    attr_accessor :data
 
-    # The end of the aggregation time frame in UTC.
-    attr_accessor :end_time
-
-    attr_accessor :purchased_units
-
-    # The ID of the analytics-level product.
-    attr_accessor :product_id
-
-    # The name of the analytics-level product.
-    attr_accessor :product_name
+    attr_accessor :totals
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'start_time' => :'startTime',
-        :'end_time' => :'endTime',
-        :'purchased_units' => :'purchasedUnits',
-        :'product_id' => :'productId',
-        :'product_name' => :'productName'
+        :'data' => :'data',
+        :'totals' => :'totals'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'start_time' => :'DateTime',
-        :'end_time' => :'DateTime',
-        :'purchased_units' => :'AnalyticsDataPointWithTrend',
-        :'product_id' => :'Integer',
-        :'product_name' => :'String'
+        :'data' => :'Array<ProductUnitAnalyticsDataPoint>',
+        :'totals' => :'ProductUnitAnalyticsTotals'
       }
     end
 
@@ -71,24 +55,14 @@ module TalonOne
         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?(:'purchased_units')
-        self.purchased_units = attributes[:'purchased_units']
-      end
-
-      if attributes.key?(:'product_id')
-        self.product_id = attributes[:'product_id']
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
       end
 
-      if attributes.key?(:'product_name')
-        self.product_name = attributes[:'product_name']
+      if attributes.key?(:'totals')
+        self.totals = attributes[:'totals']
       end
     end
 
@@ -96,24 +70,12 @@ module TalonOne
     # @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 @purchased_units.nil?
-        invalid_properties.push('invalid value for "purchased_units", purchased_units cannot be nil.')
-      end
-
-      if @product_id.nil?
-        invalid_properties.push('invalid value for "product_id", product_id cannot be nil.')
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
       end
 
-      if @product_name.nil?
-        invalid_properties.push('invalid value for "product_name", product_name cannot be nil.')
+      if @totals.nil?
+        invalid_properties.push('invalid value for "totals", totals cannot be nil.')
       end
 
       invalid_properties
@@ -122,11 +84,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 @start_time.nil?
-      return false if @end_time.nil?
-      return false if @purchased_units.nil?
-      return false if @product_id.nil?
-      return false if @product_name.nil?
+      return false if @data.nil?
+      return false if @totals.nil?
       true
     end
 
@@ -135,11 +94,8 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          start_time == o.start_time &&
-          end_time == o.end_time &&
-          purchased_units == o.purchased_units &&
-          product_id == o.product_id &&
-          product_name == o.product_name
+          data == o.data &&
+          totals == o.totals
     end
 
     # @see the `==` method
@@ -151,7 +107,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [start_time, end_time, purchased_units, product_id, product_name].hash
+      [data, totals].hash
     end
 
     # Builds the object from hash

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,10 @@ 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
+
+    # 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 +31,32 @@ 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',
         :'application_id' => :'applicationId',
         :'current_batch' => :'currentBatch',
         :'total_batches' => :'totalBatches',
@@ -42,6 +68,7 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'version' => :'String',
         :'application_id' => :'Integer',
         :'current_batch' => :'Integer',
         :'total_batches' => :'Integer',
@@ -71,6 +98,10 @@ module TalonOne
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+
       if attributes.key?(:'application_id')
         self.application_id = attributes[:'application_id']
       end
@@ -124,6 +155,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 +165,22 @@ 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 &&
           application_id == o.application_id &&
           current_batch == o.current_batch &&
           total_batches == o.total_batches &&
@@ -153,7 +197,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, 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

data/lib/talon_one/models/update_achievement.rb

@@ -14,7 +14,7 @@ require 'date'
 
 module TalonOne
   class UpdateAchievement
-    # The internal name of the achievement used in API requests. 
+    # 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.
@@ -26,7 +26,7 @@ module TalonOne
     # 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. 
+    # 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

data/lib/talon_one/models/update_loyalty_program.rb

@@ -56,7 +56,7 @@ module TalonOne
 
     attr_accessor :card_code_settings
 
-    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. 
+    # The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit. 
     attr_accessor :return_policy
 
     # The tiers in this loyalty program.
@@ -239,7 +239,7 @@ module TalonOne
       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)
-      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       return false unless return_policy_validator.valid?(@return_policy)
       true
     end
@@ -287,7 +287,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] return_policy Object to be assigned
     def return_policy=(return_policy)
-      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance"])
+      validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
       unless validator.valid?(return_policy)
         fail ArgumentError, "invalid value for \"return_policy\", must be one of #{validator.allowable_values}."
       end