boxx_loki 1.5.0

data/lib/boxx_loki/models/recommendation_request_data_query.rb

@@ -0,0 +1,520 @@
+=begin
+#Recommendation API 2
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.5.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module BoxxLoki
+
+  class RecommendationRequestDataQuery
+    attr_accessor :userid
+
+    attr_accessor :boxx_token_id
+
+    attr_accessor :get_product_properties
+
+    attr_accessor :num
+
+    attr_accessor :user_attribute_weight
+
+    attr_accessor :transaction_weight
+
+    attr_accessor :group_by_attribute
+
+    attr_accessor :location
+
+    attr_accessor :radius
+
+    attr_accessor :item_filters
+
+    attr_accessor :recent_actions
+
+    attr_accessor :repeat
+
+    attr_accessor :exclude
+
+    attr_accessor :num_out_of
+
+    attr_accessor :offset
+
+    attr_accessor :random
+
+    attr_accessor :related_products
+
+    attr_accessor :related_action_type
+
+    attr_accessor :dont_repeat_transaction_types
+
+    attr_accessor :product_ids
+
+    attr_accessor :page_num
+
+    attr_accessor :maximize
+
+    attr_accessor :latest_transactions
+
+    attr_accessor :ignore_filters
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'userid' => :'userid',
+        :'boxx_token_id' => :'boxx_token_id',
+        :'get_product_properties' => :'get_product_properties',
+        :'num' => :'num',
+        :'user_attribute_weight' => :'user_attribute_weight',
+        :'transaction_weight' => :'transaction_weight',
+        :'group_by_attribute' => :'group_by_attribute',
+        :'location' => :'location',
+        :'radius' => :'radius',
+        :'item_filters' => :'item_filters',
+        :'recent_actions' => :'recent_actions',
+        :'repeat' => :'repeat',
+        :'exclude' => :'exclude',
+        :'num_out_of' => :'num_out_of',
+        :'offset' => :'offset',
+        :'random' => :'random',
+        :'related_products' => :'related_products',
+        :'related_action_type' => :'related_action_type',
+        :'dont_repeat_transaction_types' => :'dont_repeat_transaction_types',
+        :'product_ids' => :'product_ids',
+        :'page_num' => :'page_num',
+        :'maximize' => :'maximize',
+        :'latest_transactions' => :'latest_transactions',
+        :'ignore_filters' => :'ignore_filters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'userid' => :'String',
+        :'boxx_token_id' => :'String',
+        :'get_product_properties' => :'BOOLEAN',
+        :'num' => :'Integer',
+        :'user_attribute_weight' => :'Float',
+        :'transaction_weight' => :'Float',
+        :'group_by_attribute' => :'BOOLEAN',
+        :'location' => :'Array<Float>',
+        :'radius' => :'Integer',
+        :'item_filters' => :'Object',
+        :'recent_actions' => :'Object',
+        :'repeat' => :'BOOLEAN',
+        :'exclude' => :'Array<String>',
+        :'num_out_of' => :'Float',
+        :'offset' => :'Float',
+        :'random' => :'Float',
+        :'related_products' => :'Array<String>',
+        :'related_action_type' => :'String',
+        :'dont_repeat_transaction_types' => :'Array<String>',
+        :'product_ids' => :'Array<String>',
+        :'page_num' => :'Float',
+        :'maximize' => :'String',
+        :'latest_transactions' => :'BOOLEAN',
+        :'ignore_filters' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'userid')
+        self.userid = attributes[:'userid']
+      end
+
+      if attributes.has_key?(:'boxx_token_id')
+        self.boxx_token_id = attributes[:'boxx_token_id']
+      end
+
+      if attributes.has_key?(:'get_product_properties')
+        self.get_product_properties = attributes[:'get_product_properties']
+      else
+        self.get_product_properties = false
+      end
+
+      if attributes.has_key?(:'num')
+        self.num = attributes[:'num']
+      end
+
+      if attributes.has_key?(:'user_attribute_weight')
+        self.user_attribute_weight = attributes[:'user_attribute_weight']
+      end
+
+      if attributes.has_key?(:'transaction_weight')
+        self.transaction_weight = attributes[:'transaction_weight']
+      end
+
+      if attributes.has_key?(:'group_by_attribute')
+        self.group_by_attribute = attributes[:'group_by_attribute']
+      end
+
+      if attributes.has_key?(:'location')
+        if (value = attributes[:'location']).is_a?(Array)
+          self.location = value
+        end
+      end
+
+      if attributes.has_key?(:'radius')
+        self.radius = attributes[:'radius']
+      end
+
+      if attributes.has_key?(:'item_filters')
+        self.item_filters = attributes[:'item_filters']
+      end
+
+      if attributes.has_key?(:'recent_actions')
+        self.recent_actions = attributes[:'recent_actions']
+      end
+
+      if attributes.has_key?(:'repeat')
+        self.repeat = attributes[:'repeat']
+      else
+        self.repeat = true
+      end
+
+      if attributes.has_key?(:'exclude')
+        if (value = attributes[:'exclude']).is_a?(Array)
+          self.exclude = value
+        end
+      end
+
+      if attributes.has_key?(:'num_out_of')
+        self.num_out_of = attributes[:'num_out_of']
+      end
+
+      if attributes.has_key?(:'offset')
+        self.offset = attributes[:'offset']
+      end
+
+      if attributes.has_key?(:'random')
+        self.random = attributes[:'random']
+      end
+
+      if attributes.has_key?(:'related_products')
+        if (value = attributes[:'related_products']).is_a?(Array)
+          self.related_products = value
+        end
+      end
+
+      if attributes.has_key?(:'related_action_type')
+        self.related_action_type = attributes[:'related_action_type']
+      end
+
+      if attributes.has_key?(:'dont_repeat_transaction_types')
+        if (value = attributes[:'dont_repeat_transaction_types']).is_a?(Array)
+          self.dont_repeat_transaction_types = value
+        end
+      end
+
+      if attributes.has_key?(:'product_ids')
+        if (value = attributes[:'product_ids']).is_a?(Array)
+          self.product_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'page_num')
+        self.page_num = attributes[:'page_num']
+      end
+
+      if attributes.has_key?(:'maximize')
+        self.maximize = attributes[:'maximize']
+      end
+
+      if attributes.has_key?(:'latest_transactions')
+        self.latest_transactions = attributes[:'latest_transactions']
+      else
+        self.latest_transactions = false
+      end
+
+      if attributes.has_key?(:'ignore_filters')
+        self.ignore_filters = attributes[:'ignore_filters']
+      else
+        self.ignore_filters = false
+      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 !@num.nil? && @num < 0
+        invalid_properties.push("invalid value for 'num', must be greater than or equal to 0.")
+      end
+
+      if !@user_attribute_weight.nil? && @user_attribute_weight > 1
+        invalid_properties.push("invalid value for 'user_attribute_weight', must be smaller than or equal to 1.")
+      end
+
+      if !@user_attribute_weight.nil? && @user_attribute_weight < 0
+        invalid_properties.push("invalid value for 'user_attribute_weight', must be greater than or equal to 0.")
+      end
+
+      if !@transaction_weight.nil? && @transaction_weight > 1
+        invalid_properties.push("invalid value for 'transaction_weight', must be smaller than or equal to 1.")
+      end
+
+      if !@transaction_weight.nil? && @transaction_weight < 0
+        invalid_properties.push("invalid value for 'transaction_weight', must be greater than or equal to 0.")
+      end
+
+      if !@random.nil? && @random > 1
+        invalid_properties.push("invalid value for 'random', must be smaller than or equal to 1.")
+      end
+
+      if !@random.nil? && @random < 0
+        invalid_properties.push("invalid value for 'random', must be greater than or equal to 0.")
+      end
+
+      if !@page_num.nil? && @page_num < 1
+        invalid_properties.push("invalid value for 'page_num', must be greater than or equal to 1.")
+      end
+
+      return 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 !@num.nil? && @num < 0
+      return false if !@user_attribute_weight.nil? && @user_attribute_weight > 1
+      return false if !@user_attribute_weight.nil? && @user_attribute_weight < 0
+      return false if !@transaction_weight.nil? && @transaction_weight > 1
+      return false if !@transaction_weight.nil? && @transaction_weight < 0
+      return false if !@random.nil? && @random > 1
+      return false if !@random.nil? && @random < 0
+      return false if !@page_num.nil? && @page_num < 1
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] num Value to be assigned
+    def num=(num)
+
+      if !num.nil? && num < 0
+        fail ArgumentError, "invalid value for 'num', must be greater than or equal to 0."
+      end
+
+      @num = num
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_attribute_weight Value to be assigned
+    def user_attribute_weight=(user_attribute_weight)
+
+      if !user_attribute_weight.nil? && user_attribute_weight > 1
+        fail ArgumentError, "invalid value for 'user_attribute_weight', must be smaller than or equal to 1."
+      end
+
+      if !user_attribute_weight.nil? && user_attribute_weight < 0
+        fail ArgumentError, "invalid value for 'user_attribute_weight', must be greater than or equal to 0."
+      end
+
+      @user_attribute_weight = user_attribute_weight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] transaction_weight Value to be assigned
+    def transaction_weight=(transaction_weight)
+
+      if !transaction_weight.nil? && transaction_weight > 1
+        fail ArgumentError, "invalid value for 'transaction_weight', must be smaller than or equal to 1."
+      end
+
+      if !transaction_weight.nil? && transaction_weight < 0
+        fail ArgumentError, "invalid value for 'transaction_weight', must be greater than or equal to 0."
+      end
+
+      @transaction_weight = transaction_weight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] random Value to be assigned
+    def random=(random)
+
+      if !random.nil? && random > 1
+        fail ArgumentError, "invalid value for 'random', must be smaller than or equal to 1."
+      end
+
+      if !random.nil? && random < 0
+        fail ArgumentError, "invalid value for 'random', must be greater than or equal to 0."
+      end
+
+      @random = random
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_num Value to be assigned
+    def page_num=(page_num)
+
+      if !page_num.nil? && page_num < 1
+        fail ArgumentError, "invalid value for 'page_num', must be greater than or equal to 1."
+      end
+
+      @page_num = page_num
+    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 &&
+          userid == o.userid &&
+          boxx_token_id == o.boxx_token_id &&
+          get_product_properties == o.get_product_properties &&
+          num == o.num &&
+          user_attribute_weight == o.user_attribute_weight &&
+          transaction_weight == o.transaction_weight &&
+          group_by_attribute == o.group_by_attribute &&
+          location == o.location &&
+          radius == o.radius &&
+          item_filters == o.item_filters &&
+          recent_actions == o.recent_actions &&
+          repeat == o.repeat &&
+          exclude == o.exclude &&
+          num_out_of == o.num_out_of &&
+          offset == o.offset &&
+          random == o.random &&
+          related_products == o.related_products &&
+          related_action_type == o.related_action_type &&
+          dont_repeat_transaction_types == o.dont_repeat_transaction_types &&
+          product_ids == o.product_ids &&
+          page_num == o.page_num &&
+          maximize == o.maximize &&
+          latest_transactions == o.latest_transactions &&
+          ignore_filters == o.ignore_filters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [userid, boxx_token_id, get_product_properties, num, user_attribute_weight, transaction_weight, group_by_attribute, location, radius, item_filters, recent_actions, repeat, exclude, num_out_of, offset, random, related_products, related_action_type, dont_repeat_transaction_types, product_ids, page_num, maximize, latest_transactions, ignore_filters].hash
+    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.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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
+        temp_model = BoxxLoki.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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