talon_one 3.0.1 → 4.0.0

data/lib/talon_one/models/application_campaign_analytics.rb

@@ -0,0 +1,379 @@
+=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 ApplicationCampaignAnalytics
+    # 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
+
+    # The ID of the campaign.
+    attr_accessor :campaign_id
+
+    # The name of the campaign.
+    attr_accessor :campaign_name
+
+    # A list of tags for the campaign.
+    attr_accessor :campaign_tags
+
+    # 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
+
+    attr_accessor :avg_items_per_session
+
+    attr_accessor :avg_session_value
+
+    attr_accessor :total_discounts
+
+    attr_accessor :coupons_count
+
+    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
+      {
+        :'start_time' => :'startTime',
+        :'end_time' => :'endTime',
+        :'campaign_id' => :'campaignId',
+        :'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',
+        :'avg_session_value' => :'avgSessionValue',
+        :'total_discounts' => :'totalDiscounts',
+        :'coupons_count' => :'couponsCount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start_time' => :'DateTime',
+        :'end_time' => :'DateTime',
+        :'campaign_id' => :'Integer',
+        :'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'
+      }
+    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::ApplicationCampaignAnalytics` 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::ApplicationCampaignAnalytics`. 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?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
+      if attributes.key?(:'campaign_name')
+        self.campaign_name = attributes[:'campaign_name']
+      end
+
+      if attributes.key?(:'campaign_tags')
+        if (value = attributes[:'campaign_tags']).is_a?(Array)
+          self.campaign_tags = value
+        end
+      end
+
+      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')
+        self.total_revenue = attributes[:'total_revenue']
+      end
+
+      if attributes.key?(:'sessions_count')
+        self.sessions_count = attributes[:'sessions_count']
+      end
+
+      if attributes.key?(:'avg_items_per_session')
+        self.avg_items_per_session = attributes[:'avg_items_per_session']
+      end
+
+      if attributes.key?(:'avg_session_value')
+        self.avg_session_value = attributes[:'avg_session_value']
+      end
+
+      if attributes.key?(:'total_discounts')
+        self.total_discounts = attributes[:'total_discounts']
+      end
+
+      if attributes.key?(:'coupons_count')
+        self.coupons_count = attributes[:'coupons_count']
+      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
+      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 unless campaign_state_validator.valid?(@campaign_state)
+      true
+    end
+
+    # 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"])
+      unless validator.valid?(campaign_state)
+        fail ArgumentError, "invalid value for \"campaign_state\", must be one of #{validator.allowable_values}."
+      end
+      @campaign_state = campaign_state
+    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 &&
+          campaign_id == o.campaign_id &&
+          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 &&
+          avg_session_value == o.avg_session_value &&
+          total_discounts == o.total_discounts &&
+          coupons_count == o.coupons_count
+    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, 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
+    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/application_campaign_analytics_avg_items_per_session.rb

@@ -0,0 +1,225 @@
+=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
+  # The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+  class ApplicationCampaignAnalyticsAvgItemsPerSession
+    attr_accessor :value
+
+    attr_accessor :uplift
+
+    attr_accessor :trend
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'value' => :'value',
+        :'uplift' => :'uplift',
+        :'trend' => :'trend'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'value' => :'Float',
+        :'uplift' => :'Float',
+        :'trend' => :'Float'
+      }
+    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::ApplicationCampaignAnalyticsAvgItemsPerSession` 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::ApplicationCampaignAnalyticsAvgItemsPerSession`. 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?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'uplift')
+        self.uplift = attributes[:'uplift']
+      end
+
+      if attributes.key?(:'trend')
+        self.trend = attributes[:'trend']
+      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
+      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?
+      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 &&
+          value == o.value &&
+          uplift == o.uplift &&
+          trend == o.trend
+    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
+      [value, uplift, trend].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