class SwaggerClient::GetTimeClockRequest
Attributes
The end of the date range for the time card information to be returned. If you do not supply an `EndDateTime`, data returns for the seven days prior to today’s date. Classes that begin before the `EndDateTime` are included in the response, regardless of the time that the class ends. The maximum allowed date range is 14 days.<br /> Default: **Today’s date**
When `true`, payroll information returns for both active and inactive staff members.<br /> Default: false
Number of results to include, defaults to 100
Page offset, defaults to 0.
The staff ID for whom you want to retrieve time card information. If you do not supply a `StaffId`, all active staff members return, ordered by staff ID.
The beginning of the date range for the time card information to be returned. If you do not supply a `StartDateTime`, data returns for the seven days prior to the `EndDateTime` that you supply. The maximum allowed date range is 14 days.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/swagger_client/models/get_time_clock_request.rb, line 36 def self.attribute_map { :'staff_id' => :'StaffId', :'start_date_time' => :'StartDateTime', :'end_date_time' => :'EndDateTime', :'include_inactive_staff' => :'IncludeInactiveStaff', :'limit' => :'Limit', :'offset' => :'Offset' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/swagger_client/models/get_time_clock_request.rb, line 61 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?(:'StaffId') self.staff_id = attributes[:'StaffId'] end if attributes.has_key?(:'StartDateTime') self.start_date_time = attributes[:'StartDateTime'] end if attributes.has_key?(:'EndDateTime') self.end_date_time = attributes[:'EndDateTime'] end if attributes.has_key?(:'IncludeInactiveStaff') self.include_inactive_staff = attributes[:'IncludeInactiveStaff'] end if attributes.has_key?(:'Limit') self.limit = attributes[:'Limit'] end if attributes.has_key?(:'Offset') self.offset = attributes[:'Offset'] end end
Attribute type mapping.
# File lib/swagger_client/models/get_time_clock_request.rb, line 48 def self.swagger_types { :'staff_id' => :'Integer', :'start_date_time' => :'DateTime', :'end_date_time' => :'DateTime', :'include_inactive_staff' => :'BOOLEAN', :'limit' => :'Integer', :'offset' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/swagger_client/models/get_time_clock_request.rb, line 107 def ==(o) return true if self.equal?(o) self.class == o.class && staff_id == o.staff_id && start_date_time == o.start_date_time && end_date_time == o.end_date_time && include_inactive_staff == o.include_inactive_staff && limit == o.limit && offset == o.offset 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/swagger_client/models/get_time_clock_request.rb, line 154 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 = SwaggerClient.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/swagger_client/models/get_time_clock_request.rb, line 220 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/swagger_client/models/get_time_clock_request.rb, line 133 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/swagger_client/models/get_time_clock_request.rb, line 120 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/swagger_client/models/get_time_clock_request.rb, line 126 def hash [staff_id, start_date_time, end_date_time, include_inactive_staff, limit, offset].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/swagger_client/models/get_time_clock_request.rb, line 94 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/swagger_client/models/get_time_clock_request.rb, line 206 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/swagger_client/models/get_time_clock_request.rb, line 194 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/swagger_client/models/get_time_clock_request.rb, line 101 def valid? true end