class SquareConnect::V1ListTimecardsRequest
Attributes
A pagination cursor to retrieve the next set of results for your original query to the endpoint.
If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
If provided, the endpoint returns only timecards for the employee with the specified ID.
If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
The order in which timecards are listed in the response, based on their created_at field. See [SortOrder](type-sortorder) for possible values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/v1_list_timecards_request.rb, line 50 def self.attribute_map { :'order' => :'order', :'employee_id' => :'employee_id', :'begin_clockin_time' => :'begin_clockin_time', :'end_clockin_time' => :'end_clockin_time', :'begin_clockout_time' => :'begin_clockout_time', :'end_clockout_time' => :'end_clockout_time', :'begin_updated_at' => :'begin_updated_at', :'end_updated_at' => :'end_updated_at', :'deleted' => :'deleted', :'limit' => :'limit', :'batch_token' => :'batch_token' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/v1_list_timecards_request.rb, line 85 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?(:'order') self.order = attributes[:'order'] end if attributes.has_key?(:'employee_id') self.employee_id = attributes[:'employee_id'] end if attributes.has_key?(:'begin_clockin_time') self.begin_clockin_time = attributes[:'begin_clockin_time'] end if attributes.has_key?(:'end_clockin_time') self.end_clockin_time = attributes[:'end_clockin_time'] end if attributes.has_key?(:'begin_clockout_time') self.begin_clockout_time = attributes[:'begin_clockout_time'] end if attributes.has_key?(:'end_clockout_time') self.end_clockout_time = attributes[:'end_clockout_time'] end if attributes.has_key?(:'begin_updated_at') self.begin_updated_at = attributes[:'begin_updated_at'] end if attributes.has_key?(:'end_updated_at') self.end_updated_at = attributes[:'end_updated_at'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'limit') self.limit = attributes[:'limit'] end if attributes.has_key?(:'batch_token') self.batch_token = attributes[:'batch_token'] end end
Attribute type mapping.
# File lib/square_connect/models/v1_list_timecards_request.rb, line 67 def self.swagger_types { :'order' => :'String', :'employee_id' => :'String', :'begin_clockin_time' => :'String', :'end_clockin_time' => :'String', :'begin_clockout_time' => :'String', :'end_clockout_time' => :'String', :'begin_updated_at' => :'String', :'end_updated_at' => :'String', :'deleted' => :'BOOLEAN', :'limit' => :'Integer', :'batch_token' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/v1_list_timecards_request.rb, line 152 def ==(o) return true if self.equal?(o) self.class == o.class && order == o.order && employee_id == o.employee_id && begin_clockin_time == o.begin_clockin_time && end_clockin_time == o.end_clockin_time && begin_clockout_time == o.begin_clockout_time && end_clockout_time == o.end_clockout_time && begin_updated_at == o.begin_updated_at && end_updated_at == o.end_updated_at && deleted == o.deleted && limit == o.limit && batch_token == o.batch_token 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/v1_list_timecards_request.rb, line 204 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/v1_list_timecards_request.rb, line 270 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/v1_list_timecards_request.rb, line 183 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/v1_list_timecards_request.rb, line 170 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/v1_list_timecards_request.rb, line 176 def hash [order, employee_id, begin_clockin_time, end_clockin_time, begin_clockout_time, end_clockout_time, begin_updated_at, end_updated_at, deleted, limit, batch_token].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/v1_list_timecards_request.rb, line 139 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/v1_list_timecards_request.rb, line 256 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/v1_list_timecards_request.rb, line 244 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/v1_list_timecards_request.rb, line 146 def valid? return true end