class SquareConnect::ShiftFilter
Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified.
Attributes
Fetch the `Shift`s that end in the time range - Inclusive.
Fetch shifts for the specified employee.
Fetch shifts for the specified location.
Fetch `Shift`s that start in the time range - Inclusive.
Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](type-shiftfilterstatus) for possible values
Fetch the `Shift`s based on workday date range.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/shift_filter.rb, line 35 def self.attribute_map { :'location_id' => :'location_id', :'employee_id' => :'employee_id', :'status' => :'status', :'start' => :'start', :'_end' => :'end', :'workday' => :'workday' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/shift_filter.rb, line 60 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?(:'location_id') if (value = attributes[:'location_id']).is_a?(Array) self.location_id = value end end if attributes.has_key?(:'employee_id') if (value = attributes[:'employee_id']).is_a?(Array) self.employee_id = value end end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'start') self.start = attributes[:'start'] end if attributes.has_key?(:'end') self._end = attributes[:'end'] end if attributes.has_key?(:'workday') self.workday = attributes[:'workday'] end end
Attribute type mapping.
# File lib/square_connect/models/shift_filter.rb, line 47 def self.swagger_types { :'location_id' => :'Array<String>', :'employee_id' => :'Array<String>', :'status' => :'String', :'start' => :'TimeRange', :'_end' => :'TimeRange', :'workday' => :'ShiftWorkday' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/shift_filter.rb, line 111 def ==(o) return true if self.equal?(o) self.class == o.class && location_id == o.location_id && employee_id == o.employee_id && status == o.status && start == o.start && _end == o._end && workday == o.workday 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/shift_filter.rb, line 158 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/shift_filter.rb, line 224 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/shift_filter.rb, line 137 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/shift_filter.rb, line 124 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/shift_filter.rb, line 130 def hash [location_id, employee_id, status, start, _end, workday].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/shift_filter.rb, line 98 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/shift_filter.rb, line 210 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/shift_filter.rb, line 198 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/shift_filter.rb, line 105 def valid? return true end