class SquareConnect::SearchCatalogObjectsRequest

Attributes

begin_time[RW]

Return objects modified after this [timestamp](workingwithdates), in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". The timestamp is exclusive - objects with a timestamp equal to `begin_time` will not be included in the response.

cursor[RW]

The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.

include_deleted_objects[RW]

If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.

limit[RW]

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

object_types[RW]

The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](type-catalogobjecttype) enumeration, namely `"ITEM"`, `"ITEM_VARIATION"`, `"CATEGORY"`, `"DISCOUNT"`, `"TAX"`, `"MODIFIER"`, or `"MODIFIER_LIST"`. See [CatalogObjectType](type-catalogobjecttype) for possible values

query[RW]

A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/square_connect/models/search_catalog_objects_request.rb, line 38
def self.attribute_map
  {
    :'cursor' => :'cursor',
    :'object_types' => :'object_types',
    :'include_deleted_objects' => :'include_deleted_objects',
    :'include_related_objects' => :'include_related_objects',
    :'begin_time' => :'begin_time',
    :'query' => :'query',
    :'limit' => :'limit'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/square_connect/models/search_catalog_objects_request.rb, line 65
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?(:'cursor')
    self.cursor = attributes[:'cursor']
  end

  if attributes.has_key?(:'object_types')
    if (value = attributes[:'object_types']).is_a?(Array)
      self.object_types = value
    end
  end

  if attributes.has_key?(:'include_deleted_objects')
    self.include_deleted_objects = attributes[:'include_deleted_objects']
  end

  if attributes.has_key?(:'include_related_objects')
    self.include_related_objects = attributes[:'include_related_objects']
  end

  if attributes.has_key?(:'begin_time')
    self.begin_time = attributes[:'begin_time']
  end

  if attributes.has_key?(:'query')
    self.query = attributes[:'query']
  end

  if attributes.has_key?(:'limit')
    self.limit = attributes[:'limit']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/search_catalog_objects_request.rb, line 51
def self.swagger_types
  {
    :'cursor' => :'String',
    :'object_types' => :'Array<String>',
    :'include_deleted_objects' => :'BOOLEAN',
    :'include_related_objects' => :'BOOLEAN',
    :'begin_time' => :'String',
    :'query' => :'CatalogQuery',
    :'limit' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/square_connect/models/search_catalog_objects_request.rb, line 118
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cursor == o.cursor &&
      object_types == o.object_types &&
      include_deleted_objects == o.include_deleted_objects &&
      include_related_objects == o.include_related_objects &&
      begin_time == o.begin_time &&
      query == o.query &&
      limit == o.limit
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/square_connect/models/search_catalog_objects_request.rb, line 166
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 = SquareConnect.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/square_connect/models/search_catalog_objects_request.rb, line 232
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/square_connect/models/search_catalog_objects_request.rb, line 145
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/square_connect/models/search_catalog_objects_request.rb, line 132
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/square_connect/models/search_catalog_objects_request.rb, line 138
def hash
  [cursor, object_types, include_deleted_objects, include_related_objects, begin_time, query, limit].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/square_connect/models/search_catalog_objects_request.rb, line 105
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/search_catalog_objects_request.rb, line 212
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/square_connect/models/search_catalog_objects_request.rb, line 218
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/square_connect/models/search_catalog_objects_request.rb, line 206
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/square_connect/models/search_catalog_objects_request.rb, line 112
def valid?
  return true
end