Class: SquareConnect::Shift

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/shift.rb

Overview

A record of the hourly rate, start, and end times for a single work shift for an employee. May include a record of the start and end times for breaks taken during the shift.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Shift

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/square_connect/models/shift.rb', line 111

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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'employee_id')
    self.employee_id = attributes[:'employee_id']
  end

  if attributes.has_key?(:'location_id')
    self.location_id = attributes[:'location_id']
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'start_at')
    self.start_at = attributes[:'start_at']
  end

  if attributes.has_key?(:'end_at')
    self.end_at = attributes[:'end_at']
  end

  if attributes.has_key?(:'wage')
    self.wage = attributes[:'wage']
  end

  if attributes.has_key?(:'breaks')
    if (value = attributes[:'breaks']).is_a?(Array)
      self.breaks = value
    end
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.has_key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

end

Instance Attribute Details

#breaks ⇒ Object

A list of any paid or unpaid breaks that were taken during this shift.



37
38
39
 
# File 'lib/square_connect/models/shift.rb', line 37

def breaks
  @breaks
end

#created_at ⇒ Object

A read-only timestamp in RFC 3339 format; presented in UTC.



46
47
48
 
# File 'lib/square_connect/models/shift.rb', line 46

def created_at
  @created_at
end

#employee_id ⇒ Object

The ID of the employee this shift belongs to.



19
20
21
 
# File 'lib/square_connect/models/shift.rb', line 19

def employee_id
  @employee_id
end

#end_at ⇒ Object

RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The ‘end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am).



31
32
33
 
# File 'lib/square_connect/models/shift.rb', line 31

def end_at
  @end_at
end

#id ⇒ Object

UUID for this object



16
17
18
 
# File 'lib/square_connect/models/shift.rb', line 16

def id
  @id
end

#location_id ⇒ Object

The ID of the location this shift occurred at. Should be based on where the employee clocked in.



22
23
24
 
# File 'lib/square_connect/models/shift.rb', line 22

def location_id
  @location_id
end

#start_at ⇒ Object

RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated.



28
29
30
 
# File 'lib/square_connect/models/shift.rb', line 28

def start_at
  @start_at
end

#status ⇒ Object

Describes working state of the current ‘Shift`. See [ShiftStatus](#type-shiftstatus) for possible values



40
41
42
 
# File 'lib/square_connect/models/shift.rb', line 40

def status
  @status
end

#timezone ⇒ Object

Read-only convenience value that is calculated from the location based on ‘location_id`. Format: the IANA Timezone Database identifier for the location timezone.



25
26
27
 
# File 'lib/square_connect/models/shift.rb', line 25

def timezone
  @timezone
end

#updated_at ⇒ Object

A read-only timestamp in RFC 3339 format; presented in UTC.



49
50
51
 
# File 'lib/square_connect/models/shift.rb', line 49

def updated_at
  @updated_at
end

#version ⇒ Object

Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.



43
44
45
 
# File 'lib/square_connect/models/shift.rb', line 43

def version
  @version
end

#wage ⇒ Object

Job and pay related information.



34
35
36
 
# File 'lib/square_connect/models/shift.rb', line 34

def wage
  @wage
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/square_connect/models/shift.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'employee_id' => :'employee_id',
    :'location_id' => :'location_id',
    :'timezone' => :'timezone',
    :'start_at' => :'start_at',
    :'end_at' => :'end_at',
    :'wage' => :'wage',
    :'breaks' => :'breaks',
    :'status' => :'status',
    :'version' => :'version',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/square_connect/models/shift.rb', line 92

def self.swagger_types
  {
    :'id' => :'String',
    :'employee_id' => :'String',
    :'location_id' => :'String',
    :'timezone' => :'String',
    :'start_at' => :'String',
    :'end_at' => :'String',
    :'wage' => :'ShiftWage',
    :'breaks' => :'Array<ModelBreak>',
    :'status' => :'String',
    :'version' => :'Integer',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/square_connect/models/shift.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      employee_id == o.employee_id &&
      location_id == o.location_id &&
      timezone == o.timezone &&
      start_at == o.start_at &&
      end_at == o.end_at &&
      wage == o.wage &&
      breaks == o.breaks &&
      status == o.status &&
      version == o.version &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/square_connect/models/shift.rb', line 313

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/square_connect/models/shift.rb', line 379

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/square_connect/models/shift.rb', line 292

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


279
280
281
 
# File 'lib/square_connect/models/shift.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



285
286
287
 
# File 'lib/square_connect/models/shift.rb', line 285

def hash
  [id, employee_id, location_id, timezone, start_at, end_at, wage, breaks, status, version, created_at, updated_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/square_connect/models/shift.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  if !@id.nil? && @id.to_s.length > 255
    invalid_properties.push("invalid value for 'id', the character length must be smaller than or equal to 255.")
  end

  if @employee_id.nil?
    invalid_properties.push("invalid value for 'employee_id', employee_id cannot be nil.")
  end

  if @employee_id.to_s.length < 1
    invalid_properties.push("invalid value for 'employee_id', the character length must be great than or equal to 1.")
  end

  if @start_at.nil?
    invalid_properties.push("invalid value for 'start_at', start_at cannot be nil.")
  end

  if @start_at.to_s.length < 1
    invalid_properties.push("invalid value for 'start_at', the character length must be great than or equal to 1.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



359
360
361
 
# File 'lib/square_connect/models/shift.rb', line 359

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



365
366
367
368
369
370
371
372
373
 
# File 'lib/square_connect/models/shift.rb', line 365

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

Returns:

  • (String) —

    String presentation of the object



353
354
355
 
# File 'lib/square_connect/models/shift.rb', line 353

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/square_connect/models/shift.rb', line 198

def valid?
  return false if !@id.nil? && @id.to_s.length > 255
  return false if @employee_id.nil?
  return false if @employee_id.to_s.length < 1
  return false if @start_at.nil?
  return false if @start_at.to_s.length < 1
  status_validator = EnumAttributeValidator.new('String', ["OPEN", "CLOSED"])
  return false unless status_validator.valid?(@status)
  return true
end