aliseeks_api 1.0.4

data/lib/aliseeks_api/models/search_price_option.rb

@@ -0,0 +1,203 @@
+=begin
+#Aliseeks API
+
+#AliExpress product searching and product details retrieval API. 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module AliseeksApi
+  # Price option for the search item 
+  class SearchPriceOption
+    # The type of the price, either pc_price or app_price 
+    attr_accessor :type
+
+    attr_accessor :original_amount
+
+    attr_accessor :amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'original_amount' => :'originalAmount',
+        :'amount' => :'amount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'original_amount' => :'Amount',
+        :'amount' => :'Amount'
+      }
+    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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'originalAmount')
+        self.original_amount = attributes[:'originalAmount']
+      end
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      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 &&
+          type == o.type &&
+          original_amount == o.original_amount &&
+          amount == o.amount
+    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
+      [type, original_amount, amount].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.openapi_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 = AliseeksApi.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

data/lib/aliseeks_api/models/search_request.rb

@@ -0,0 +1,441 @@
+=begin
+#Aliseeks API
+
+#AliExpress product searching and product details retrieval API. 
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module AliseeksApi
+  # Non realtime search request body 
+  class SearchRequest
+    # The search query 
+    attr_accessor :text
+
+    attr_accessor :sort
+
+    attr_accessor :currency
+
+    # The AliExpress category to search in 
+    attr_accessor :category
+
+    # When this flag is set to `true` the `category` field will be expanded so that all items in sub-categories will be included 
+    attr_accessor :include_subcategories
+
+    # The direction to sort the results by. Only valid for certain `sort` values 
+    attr_accessor :sort_direction
+
+    attr_accessor :ratings_range
+
+    attr_accessor :quantity_range
+
+    attr_accessor :price_range
+
+    attr_accessor :unit_price_range
+
+    attr_accessor :order_range
+
+    attr_accessor :item_id_range
+
+    # Filter by freight types 
+    attr_accessor :freight_types
+
+    # Skip a number of items, if you need to skip more than 10000 items then use the scroll feature 
+    attr_accessor :skip
+
+    # Limit the request to a number of items 
+    attr_accessor :limit
+
+    # When this value is `true` then you will receive a scroll identifier which you can use to request the next page of results. The scroll identifier is good for 60 seconds. 
+    attr_accessor :scroll_pagination
+
+    # The scroll identifier which can be retrieved by sending an initial search request with `scrollPagination` set to `true`. Scroll identifiers are good for 60 seconds. 
+    attr_accessor :scroll_identifier
+
+    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
+      {
+        :'text' => :'text',
+        :'sort' => :'sort',
+        :'currency' => :'currency',
+        :'category' => :'category',
+        :'include_subcategories' => :'includeSubcategories',
+        :'sort_direction' => :'sortDirection',
+        :'ratings_range' => :'ratingsRange',
+        :'quantity_range' => :'quantityRange',
+        :'price_range' => :'priceRange',
+        :'unit_price_range' => :'unitPriceRange',
+        :'order_range' => :'orderRange',
+        :'item_id_range' => :'itemIdRange',
+        :'freight_types' => :'freightTypes',
+        :'skip' => :'skip',
+        :'limit' => :'limit',
+        :'scroll_pagination' => :'scrollPagination',
+        :'scroll_identifier' => :'scrollIdentifier'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'text' => :'String',
+        :'sort' => :'String',
+        :'currency' => :'NonRealtimeCurrency',
+        :'category' => :'Integer',
+        :'include_subcategories' => :'BOOLEAN',
+        :'sort_direction' => :'String',
+        :'ratings_range' => :'DoubleRange',
+        :'quantity_range' => :'IntegerRange',
+        :'price_range' => :'DoubleRange',
+        :'unit_price_range' => :'DoubleRange',
+        :'order_range' => :'IntegerRange',
+        :'item_id_range' => :'StringRange',
+        :'freight_types' => :'Array<String>',
+        :'skip' => :'Integer',
+        :'limit' => :'Integer',
+        :'scroll_pagination' => :'BOOLEAN',
+        :'scroll_identifier' => :'String'
+      }
+    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?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.has_key?(:'sort')
+        self.sort = attributes[:'sort']
+      else
+        self.sort = 'BEST_MATCH'
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.has_key?(:'includeSubcategories')
+        self.include_subcategories = attributes[:'includeSubcategories']
+      else
+        self.include_subcategories = false
+      end
+
+      if attributes.has_key?(:'sortDirection')
+        self.sort_direction = attributes[:'sortDirection']
+      else
+        self.sort_direction = 'ASC'
+      end
+
+      if attributes.has_key?(:'ratingsRange')
+        self.ratings_range = attributes[:'ratingsRange']
+      end
+
+      if attributes.has_key?(:'quantityRange')
+        self.quantity_range = attributes[:'quantityRange']
+      end
+
+      if attributes.has_key?(:'priceRange')
+        self.price_range = attributes[:'priceRange']
+      end
+
+      if attributes.has_key?(:'unitPriceRange')
+        self.unit_price_range = attributes[:'unitPriceRange']
+      end
+
+      if attributes.has_key?(:'orderRange')
+        self.order_range = attributes[:'orderRange']
+      end
+
+      if attributes.has_key?(:'itemIdRange')
+        self.item_id_range = attributes[:'itemIdRange']
+      end
+
+      if attributes.has_key?(:'freightTypes')
+        if (value = attributes[:'freightTypes']).is_a?(Array)
+          self.freight_types = value
+        end
+      end
+
+      if attributes.has_key?(:'skip')
+        self.skip = attributes[:'skip']
+      end
+
+      if attributes.has_key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.has_key?(:'scrollPagination')
+        self.scroll_pagination = attributes[:'scrollPagination']
+      else
+        self.scroll_pagination = false
+      end
+
+      if attributes.has_key?(:'scrollIdentifier')
+        self.scroll_identifier = attributes[:'scrollIdentifier']
+      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 !@skip.nil? && @skip > 10000
+        invalid_properties.push('invalid value for "skip", must be smaller than or equal to 10000.')
+      end
+
+      if !@skip.nil? && @skip < 0
+        invalid_properties.push('invalid value for "skip", must be greater than or equal to 0.')
+      end
+
+      if !@limit.nil? && @limit > 50
+        invalid_properties.push('invalid value for "limit", must be smaller than or equal to 50.')
+      end
+
+      if !@limit.nil? && @limit < 5
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 5.')
+      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?
+      sort_validator = EnumAttributeValidator.new('String', ['PRODUCT_ID', 'UPDATE_TIME', 'WHOLESALE_PRICE', 'ITEM_RATING', 'ORDERS', 'BEST_MATCH'])
+      return false unless sort_validator.valid?(@sort)
+      sort_direction_validator = EnumAttributeValidator.new('String', ['ASC', 'DESC'])
+      return false unless sort_direction_validator.valid?(@sort_direction)
+      return false if !@skip.nil? && @skip > 10000
+      return false if !@skip.nil? && @skip < 0
+      return false if !@limit.nil? && @limit > 50
+      return false if !@limit.nil? && @limit < 5
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort Object to be assigned
+    def sort=(sort)
+      validator = EnumAttributeValidator.new('String', ['PRODUCT_ID', 'UPDATE_TIME', 'WHOLESALE_PRICE', 'ITEM_RATING', 'ORDERS', 'BEST_MATCH'])
+      unless validator.valid?(sort)
+        fail ArgumentError, 'invalid value for "sort", must be one of #{validator.allowable_values}.'
+      end
+      @sort = sort
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort_direction Object to be assigned
+    def sort_direction=(sort_direction)
+      validator = EnumAttributeValidator.new('String', ['ASC', 'DESC'])
+      unless validator.valid?(sort_direction)
+        fail ArgumentError, 'invalid value for "sort_direction", must be one of #{validator.allowable_values}.'
+      end
+      @sort_direction = sort_direction
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] skip Value to be assigned
+    def skip=(skip)
+      if !skip.nil? && skip > 10000
+        fail ArgumentError, 'invalid value for "skip", must be smaller than or equal to 10000.'
+      end
+
+      if !skip.nil? && skip < 0
+        fail ArgumentError, 'invalid value for "skip", must be greater than or equal to 0.'
+      end
+
+      @skip = skip
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if !limit.nil? && limit > 50
+        fail ArgumentError, 'invalid value for "limit", must be smaller than or equal to 50.'
+      end
+
+      if !limit.nil? && limit < 5
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 5.'
+      end
+
+      @limit = limit
+    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 &&
+          text == o.text &&
+          sort == o.sort &&
+          currency == o.currency &&
+          category == o.category &&
+          include_subcategories == o.include_subcategories &&
+          sort_direction == o.sort_direction &&
+          ratings_range == o.ratings_range &&
+          quantity_range == o.quantity_range &&
+          price_range == o.price_range &&
+          unit_price_range == o.unit_price_range &&
+          order_range == o.order_range &&
+          item_id_range == o.item_id_range &&
+          freight_types == o.freight_types &&
+          skip == o.skip &&
+          limit == o.limit &&
+          scroll_pagination == o.scroll_pagination &&
+          scroll_identifier == o.scroll_identifier
+    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
+      [text, sort, currency, category, include_subcategories, sort_direction, ratings_range, quantity_range, price_range, unit_price_range, order_range, item_id_range, freight_types, skip, limit, scroll_pagination, scroll_identifier].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.openapi_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 = AliseeksApi.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