Class: SquareConnect::V1ListTimecardsRequest
- Inherits:
-
Object
- Object
- SquareConnect::V1ListTimecardsRequest
- Defined in:
- lib/square_connect/models/v1_list_timecards_request.rb
Instance Attribute Summary collapse
-
#batch_token ⇒ Object
A pagination cursor to retrieve the next set of results for your original query to the endpoint.
-
#begin_clockin_time ⇒ Object
If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
-
#begin_clockout_time ⇒ Object
If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
-
#begin_updated_at ⇒ Object
If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
-
#deleted ⇒ Object
If true, only deleted timecards are returned.
-
#employee_id ⇒ Object
If provided, the endpoint returns only timecards for the employee with the specified ID.
-
#end_clockin_time ⇒ Object
If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
-
#end_clockout_time ⇒ Object
If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
-
#end_updated_at ⇒ Object
If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
-
#limit ⇒ Object
The maximum integer number of employee entities to return in a single response.
-
#order ⇒ Object
The order in which timecards are listed in the response, based on their created_at field.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ V1ListTimecardsRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ V1ListTimecardsRequest
Initializes the object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# 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 |
Instance Attribute Details
#batch_token ⇒ Object
A pagination cursor to retrieve the next set of results for your original query to the endpoint.
46 47 48 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 46 def batch_token @batch_token end |
#begin_clockin_time ⇒ Object
If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
22 23 24 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 22 def begin_clockin_time @begin_clockin_time end |
#begin_clockout_time ⇒ Object
If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
28 29 30 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 28 def begin_clockout_time @begin_clockout_time end |
#begin_updated_at ⇒ Object
If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
34 35 36 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 34 def begin_updated_at @begin_updated_at end |
#deleted ⇒ Object
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.
40 41 42 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 40 def deleted @deleted end |
#employee_id ⇒ Object
If provided, the endpoint returns only timecards for the employee with the specified ID.
19 20 21 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 19 def employee_id @employee_id end |
#end_clockin_time ⇒ Object
If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
25 26 27 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 25 def end_clockin_time @end_clockin_time end |
#end_clockout_time ⇒ Object
If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
31 32 33 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 31 def end_clockout_time @end_clockout_time end |
#end_updated_at ⇒ Object
If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
37 38 39 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 37 def end_updated_at @end_updated_at end |
#limit ⇒ Object
The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
43 44 45 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 43 def limit @limit end |
#order ⇒ Object
The order in which timecards are listed in the response, based on their created_at field. See [SortOrder](#type-sortorder) for possible values
16 17 18 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 16 def order @order end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
270 271 272 273 274 275 276 277 278 279 280 281 282 |
# 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# 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 |
#eql?(o) ⇒ Boolean
170 171 172 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 170 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
176 177 178 |
# 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
139 140 141 142 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 139 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
250 251 252 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 250 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
256 257 258 259 260 261 262 263 264 |
# 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 |
#to_s ⇒ String
Returns the string representation of the object
244 245 246 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 244 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
146 147 148 |
# File 'lib/square_connect/models/v1_list_timecards_request.rb', line 146 def valid? return true end |