Class: SquareConnect::ModelBreak

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

Overview

A record of an employee’s break during a shift.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelBreak

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/square_connect/models/model_break.rb', line 65

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

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

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

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

end

Instance Attribute Details

#break_type_id ⇒ Object

The ‘BreakType` this `Break` was templated on.



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

def break_type_id
  @break_type_id
end

#end_at ⇒ Object

RFC 3339; follows same timezone info as ‘Shift`. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the break length is calculated. For example, a break from `00:00` to `00:11` is considered a 10 minute break (midnight to 10 minutes after midnight).



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

def end_at
  @end_at
end

#expected_duration ⇒ Object

Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]MS. The expected length of the break.



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

def expected_duration
  @expected_duration
end

#id ⇒ Object

UUID for this object



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

def id
  @id
end

#is_paid ⇒ Object

Whether this break counts towards time worked for compensation purposes.



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

def is_paid
  @is_paid
end

#name ⇒ Object

A human-readable name.



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

def name
  @name
end

#start_at ⇒ Object

RFC 3339; follows same timezone info as ‘Shift`. Precision up to the minute is respected; seconds are truncated.



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

def start_at
  @start_at
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/square_connect/models/model_break.rb', line 38

def self.attribute_map
  {
    :'id' => :'id',
    :'start_at' => :'start_at',
    :'end_at' => :'end_at',
    :'break_type_id' => :'break_type_id',
    :'name' => :'name',
    :'expected_duration' => :'expected_duration',
    :'is_paid' => :'is_paid'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/square_connect/models/model_break.rb', line 51

def self.swagger_types
  {
    :'id' => :'String',
    :'start_at' => :'String',
    :'end_at' => :'String',
    :'break_type_id' => :'String',
    :'name' => :'String',
    :'expected_duration' => :'String',
    :'is_paid' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/square_connect/models/model_break.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      start_at == o.start_at &&
      end_at == o.end_at &&
      break_type_id == o.break_type_id &&
      name == o.name &&
      expected_duration == o.expected_duration &&
      is_paid == o.is_paid
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/square_connect/models/model_break.rb', line 265

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/square_connect/models/model_break.rb', line 331

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/square_connect/models/model_break.rb', line 244

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


231
232
233
 
# File 'lib/square_connect/models/model_break.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/square_connect/models/model_break.rb', line 237

def hash
  [id, start_at, end_at, break_type_id, name, expected_duration, is_paid].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



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
136
137
138
139
140
141
142
 
# File 'lib/square_connect/models/model_break.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  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

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

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

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

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

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

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

  if @is_paid.nil?
    invalid_properties.push("invalid value for 'is_paid', is_paid cannot be nil.")
  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



311
312
313
 
# File 'lib/square_connect/models/model_break.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/square_connect/models/model_break.rb', line 317

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



305
306
307
 
# File 'lib/square_connect/models/model_break.rb', line 305

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



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/square_connect/models/model_break.rb', line 146

def valid?
  return false if @start_at.nil?
  return false if @start_at.to_s.length < 1
  return false if @break_type_id.nil?
  return false if @break_type_id.to_s.length < 1
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @expected_duration.nil?
  return false if @expected_duration.to_s.length < 1
  return false if @is_paid.nil?
  return true
end