class SquareConnect::SearchOrdersFilter
Filter options to use for a query. Multiple filters will be ANDed together.
Attributes
Filter by customers associated with the order.
Filter for results within a time range.
Filter by fulfillment type or state.
Filter by source of order.
Filter by [`OrderState`](type-orderstate).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/search_orders_filter.rb, line 32 def self.attribute_map { :'state_filter' => :'state_filter', :'date_time_filter' => :'date_time_filter', :'fulfillment_filter' => :'fulfillment_filter', :'source_filter' => :'source_filter', :'customer_filter' => :'customer_filter' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/search_orders_filter.rb, line 55 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?(:'state_filter') self.state_filter = attributes[:'state_filter'] end if attributes.has_key?(:'date_time_filter') self.date_time_filter = attributes[:'date_time_filter'] end if attributes.has_key?(:'fulfillment_filter') self.fulfillment_filter = attributes[:'fulfillment_filter'] end if attributes.has_key?(:'source_filter') self.source_filter = attributes[:'source_filter'] end if attributes.has_key?(:'customer_filter') self.customer_filter = attributes[:'customer_filter'] end end
Attribute type mapping.
# File lib/square_connect/models/search_orders_filter.rb, line 43 def self.swagger_types { :'state_filter' => :'SearchOrdersStateFilter', :'date_time_filter' => :'SearchOrdersDateTimeFilter', :'fulfillment_filter' => :'SearchOrdersFulfillmentFilter', :'source_filter' => :'SearchOrdersSourceFilter', :'customer_filter' => :'SearchOrdersCustomerFilter' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/search_orders_filter.rb, line 98 def ==(o) return true if self.equal?(o) self.class == o.class && state_filter == o.state_filter && date_time_filter == o.date_time_filter && fulfillment_filter == o.fulfillment_filter && source_filter == o.source_filter && customer_filter == o.customer_filter end
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_orders_filter.rb, line 144 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
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_orders_filter.rb, line 210 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
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_orders_filter.rb, line 123 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/search_orders_filter.rb, line 110 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/search_orders_filter.rb, line 116 def hash [state_filter, date_time_filter, fulfillment_filter, source_filter, customer_filter].hash end
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_orders_filter.rb, line 85 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/search_orders_filter.rb, line 196 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/search_orders_filter.rb, line 184 def to_s to_hash.to_s end
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_orders_filter.rb, line 92 def valid? return true end