talon_one 4.0.0 → 6.0.0

data/lib/talon_one/models/application.rb

@@ -71,6 +71,12 @@ module TalonOne
     # The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign.
     attr_accessor :default_evaluation_group_id
 
+    # The ID of the default Cart-Item-Filter for this application.
+    attr_accessor :default_cart_item_filter_id
+
+    # Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled. 
+    attr_accessor :enable_campaign_state_management
+
     # An array containing all the loyalty programs to which this application is subscribed.
     attr_accessor :loyalty_programs
 
@@ -118,6 +124,8 @@ module TalonOne
         :'enable_partial_discounts' => :'enablePartialDiscounts',
         :'default_discount_additional_cost_per_item_scope' => :'defaultDiscountAdditionalCostPerItemScope',
         :'default_evaluation_group_id' => :'defaultEvaluationGroupId',
+        :'default_cart_item_filter_id' => :'defaultCartItemFilterId',
+        :'enable_campaign_state_management' => :'enableCampaignStateManagement',
         :'loyalty_programs' => :'loyaltyPrograms'
       }
     end
@@ -144,6 +152,8 @@ module TalonOne
         :'enable_partial_discounts' => :'Boolean',
         :'default_discount_additional_cost_per_item_scope' => :'String',
         :'default_evaluation_group_id' => :'Integer',
+        :'default_cart_item_filter_id' => :'Integer',
+        :'enable_campaign_state_management' => :'Boolean',
         :'loyalty_programs' => :'Array<LoyaltyProgram>'
       }
     end
@@ -247,6 +257,14 @@ module TalonOne
         self.default_evaluation_group_id = attributes[:'default_evaluation_group_id']
       end
 
+      if attributes.key?(:'default_cart_item_filter_id')
+        self.default_cart_item_filter_id = attributes[:'default_cart_item_filter_id']
+      end
+
+      if attributes.key?(:'enable_campaign_state_management')
+        self.enable_campaign_state_management = attributes[:'enable_campaign_state_management']
+      end
+
       if attributes.key?(:'loyalty_programs')
         if (value = attributes[:'loyalty_programs']).is_a?(Array)
           self.loyalty_programs = value
@@ -424,6 +442,8 @@ module TalonOne
           enable_partial_discounts == o.enable_partial_discounts &&
           default_discount_additional_cost_per_item_scope == o.default_discount_additional_cost_per_item_scope &&
           default_evaluation_group_id == o.default_evaluation_group_id &&
+          default_cart_item_filter_id == o.default_cart_item_filter_id &&
+          enable_campaign_state_management == o.enable_campaign_state_management &&
           loyalty_programs == o.loyalty_programs
     end
 
@@ -436,7 +456,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created, modified, account_id, name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id, loyalty_programs].hash
+      [id, created, modified, account_id, name, description, timezone, currency, case_sensitivity, attributes, limits, default_discount_scope, enable_cascading_discounts, enable_flattened_cart_items, attributes_settings, sandbox, enable_partial_discounts, default_discount_additional_cost_per_item_scope, default_evaluation_group_id, default_cart_item_filter_id, enable_campaign_state_management, loyalty_programs].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_analytics_data_point.rb

@@ -53,10 +53,10 @@ module TalonOne
       {
         :'start_time' => :'DateTime',
         :'end_time' => :'DateTime',
-        :'total_revenue' => :'ApplicationAnalyticsDataPointTotalRevenue',
-        :'sessions_count' => :'ApplicationAnalyticsDataPointSessionsCount',
-        :'avg_items_per_session' => :'ApplicationAnalyticsDataPointAvgItemsPerSession',
-        :'avg_session_value' => :'ApplicationAnalyticsDataPointAvgSessionValue',
+        :'total_revenue' => :'AnalyticsDataPoint',
+        :'sessions_count' => :'AnalyticsDataPoint',
+        :'avg_items_per_session' => :'AnalyticsDataPoint',
+        :'avg_session_value' => :'AnalyticsDataPoint',
         :'total_discounts' => :'Float',
         :'coupons_count' => :'Float'
       }
@@ -120,12 +120,22 @@ 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
+
       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?
       true
     end
 

data/lib/talon_one/models/application_campaign_analytics.rb

@@ -32,15 +32,6 @@ module TalonOne
     # The state of the campaign.  **Note:** A disabled or archived campaign is not evaluated for rules or coupons. 
     attr_accessor :campaign_state
 
-    # The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. 
-    attr_accessor :campaign_active_ruleset_id
-
-    # Date and time when the campaign becomes active.
-    attr_accessor :campaign_start_time
-
-    # Date and time when the campaign becomes inactive.
-    attr_accessor :campaign_end_time
-
     attr_accessor :total_revenue
 
     attr_accessor :sessions_count
@@ -84,9 +75,6 @@ module TalonOne
         :'campaign_name' => :'campaignName',
         :'campaign_tags' => :'campaignTags',
         :'campaign_state' => :'campaignState',
-        :'campaign_active_ruleset_id' => :'campaignActiveRulesetId',
-        :'campaign_start_time' => :'campaignStartTime',
-        :'campaign_end_time' => :'campaignEndTime',
         :'total_revenue' => :'totalRevenue',
         :'sessions_count' => :'sessionsCount',
         :'avg_items_per_session' => :'avgItemsPerSession',
@@ -105,15 +93,12 @@ module TalonOne
         :'campaign_name' => :'String',
         :'campaign_tags' => :'Array<String>',
         :'campaign_state' => :'String',
-        :'campaign_active_ruleset_id' => :'Integer',
-        :'campaign_start_time' => :'DateTime',
-        :'campaign_end_time' => :'DateTime',
-        :'total_revenue' => :'ApplicationCampaignAnalyticsTotalRevenue',
-        :'sessions_count' => :'ApplicationCampaignAnalyticsSessionsCount',
-        :'avg_items_per_session' => :'ApplicationCampaignAnalyticsAvgItemsPerSession',
-        :'avg_session_value' => :'ApplicationCampaignAnalyticsAvgSessionValue',
-        :'total_discounts' => :'ApplicationCampaignAnalyticsTotalDiscounts',
-        :'coupons_count' => :'ApplicationCampaignAnalyticsCouponsCount'
+        :'total_revenue' => :'AnalyticsDataPointWithTrendAndInfluencedRate',
+        :'sessions_count' => :'AnalyticsDataPointWithTrendAndInfluencedRate',
+        :'avg_items_per_session' => :'AnalyticsDataPointWithTrendAndUplift',
+        :'avg_session_value' => :'AnalyticsDataPointWithTrendAndUplift',
+        :'total_discounts' => :'AnalyticsDataPointWithTrend',
+        :'coupons_count' => :'AnalyticsDataPointWithTrend'
       }
     end
 
@@ -162,20 +147,6 @@ module TalonOne
 
       if attributes.key?(:'campaign_state')
         self.campaign_state = attributes[:'campaign_state']
-      else
-        self.campaign_state = 'enabled'
-      end
-
-      if attributes.key?(:'campaign_active_ruleset_id')
-        self.campaign_active_ruleset_id = attributes[:'campaign_active_ruleset_id']
-      end
-
-      if attributes.key?(:'campaign_start_time')
-        self.campaign_start_time = attributes[:'campaign_start_time']
-      end
-
-      if attributes.key?(:'campaign_end_time')
-        self.campaign_end_time = attributes[:'campaign_end_time']
       end
 
       if attributes.key?(:'total_revenue')
@@ -207,13 +178,43 @@ 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 @campaign_id.nil?
+        invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
+      end
+
+      if @campaign_name.nil?
+        invalid_properties.push('invalid value for "campaign_name", campaign_name cannot be nil.')
+      end
+
+      if @campaign_tags.nil?
+        invalid_properties.push('invalid value for "campaign_tags", campaign_tags cannot be nil.')
+      end
+
+      if @campaign_state.nil?
+        invalid_properties.push('invalid value for "campaign_state", campaign_state 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?
-      campaign_state_validator = EnumAttributeValidator.new('String', ["enabled", "disabled", "archived"])
+      return false if @start_time.nil?
+      return false if @end_time.nil?
+      return false if @campaign_id.nil?
+      return false if @campaign_name.nil?
+      return false if @campaign_tags.nil?
+      return false if @campaign_state.nil?
+      campaign_state_validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived"])
       return false unless campaign_state_validator.valid?(@campaign_state)
       true
     end
@@ -221,7 +222,7 @@ module TalonOne
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] campaign_state Object to be assigned
     def campaign_state=(campaign_state)
-      validator = EnumAttributeValidator.new('String', ["enabled", "disabled", "archived"])
+      validator = EnumAttributeValidator.new('String', ["expired", "scheduled", "running", "disabled", "archived"])
       unless validator.valid?(campaign_state)
         fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{validator.allowable_values}."
       end
@@ -239,9 +240,6 @@ module TalonOne
           campaign_name == o.campaign_name &&
           campaign_tags == o.campaign_tags &&
           campaign_state == o.campaign_state &&
-          campaign_active_ruleset_id == o.campaign_active_ruleset_id &&
-          campaign_start_time == o.campaign_start_time &&
-          campaign_end_time == o.campaign_end_time &&
           total_revenue == o.total_revenue &&
           sessions_count == o.sessions_count &&
           avg_items_per_session == o.avg_items_per_session &&
@@ -259,7 +257,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [start_time, end_time, campaign_id, campaign_name, campaign_tags, campaign_state, campaign_active_ruleset_id, campaign_start_time, campaign_end_time, total_revenue, sessions_count, avg_items_per_session, avg_session_value, total_discounts, coupons_count].hash
+      [start_time, end_time, campaign_id, campaign_name, campaign_tags, campaign_state, total_revenue, sessions_count, avg_items_per_session, avg_session_value, total_discounts, coupons_count].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_campaign_stats.rb

@@ -15,9 +15,6 @@ require 'date'
 module TalonOne
   # Provides statistics regarding an application's campaigns.
   class ApplicationCampaignStats
-    # Number of draft campaigns.
-    attr_accessor :draft
-
     # Number of disabled campaigns.
     attr_accessor :disabled
 
@@ -36,7 +33,6 @@ module TalonOne
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'draft' => :'draft',
         :'disabled' => :'disabled',
         :'scheduled' => :'scheduled',
         :'running' => :'running',
@@ -48,7 +44,6 @@ module TalonOne
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'draft' => :'Integer',
         :'disabled' => :'Integer',
         :'scheduled' => :'Integer',
         :'running' => :'Integer',
@@ -78,10 +73,6 @@ module TalonOne
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'draft')
-        self.draft = attributes[:'draft']
-      end
-
       if attributes.key?(:'disabled')
         self.disabled = attributes[:'disabled']
       end
@@ -107,10 +98,6 @@ module TalonOne
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @draft.nil?
-        invalid_properties.push('invalid value for "draft", draft cannot be nil.')
-      end
-
       if @disabled.nil?
         invalid_properties.push('invalid value for "disabled", disabled cannot be nil.')
       end
@@ -137,7 +124,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 @draft.nil?
       return false if @disabled.nil?
       return false if @scheduled.nil?
       return false if @running.nil?
@@ -151,7 +137,6 @@ module TalonOne
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          draft == o.draft &&
           disabled == o.disabled &&
           scheduled == o.scheduled &&
           running == o.running &&
@@ -168,7 +153,7 @@ module TalonOne
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [draft, disabled, scheduled, running, expired, archived].hash
+      [disabled, scheduled, running, expired, archived].hash
     end
 
     # Builds the object from hash

data/lib/talon_one/models/application_cif.rb

@@ -0,0 +1,308 @@
+=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 ApplicationCIF
+    # Internal ID of this entity.
+    attr_accessor :id
+
+    # The time this entity was created.
+    attr_accessor :created
+
+    # The name of the Application cart item filter used in API requests.
+    attr_accessor :name
+
+    # A short description of the Application cart item filter.
+    attr_accessor :description
+
+    # The ID of the expression that the Application cart item filter uses.
+    attr_accessor :active_expression_id
+
+    # The ID of the user who last updated the Application cart item filter.
+    attr_accessor :modified_by
+
+    # The ID of the user who created the Application cart item filter.
+    attr_accessor :created_by
+
+    # Timestamp of the most recent update to the Application cart item filter.
+    attr_accessor :modified
+
+    # The ID of the application that owns this entity.
+    attr_accessor :application_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'created' => :'created',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'active_expression_id' => :'activeExpressionId',
+        :'modified_by' => :'modifiedBy',
+        :'created_by' => :'createdBy',
+        :'modified' => :'modified',
+        :'application_id' => :'applicationId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'created' => :'DateTime',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'active_expression_id' => :'Integer',
+        :'modified_by' => :'Integer',
+        :'created_by' => :'Integer',
+        :'modified' => :'DateTime',
+        :'application_id' => :'Integer'
+      }
+    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::ApplicationCIF` 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::ApplicationCIF`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created')
+        self.created = attributes[:'created']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'active_expression_id')
+        self.active_expression_id = attributes[:'active_expression_id']
+      end
+
+      if attributes.key?(:'modified_by')
+        self.modified_by = attributes[:'modified_by']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'modified')
+        self.modified = attributes[:'modified']
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @created.nil?
+        invalid_properties.push('invalid value for "created", created cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id 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 @id.nil?
+      return false if @created.nil?
+      return false if @name.nil?
+      return false if @application_id.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 &&
+          id == o.id &&
+          created == o.created &&
+          name == o.name &&
+          description == o.description &&
+          active_expression_id == o.active_expression_id &&
+          modified_by == o.modified_by &&
+          created_by == o.created_by &&
+          modified == o.modified &&
+          application_id == o.application_id
+    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
+      [id, created, name, description, active_expression_id, modified_by, created_by, modified, application_id].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