Class: SquareConnect::V1CashDrawerShift

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

Overview

Contains details for a single cash drawer shift.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1CashDrawerShift

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#cash_paid_in_money ⇒ Object

The amount of money added to the cash drawer for reasons other than cash payments.



55
56
57
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 55

def cash_paid_in_money
  @cash_paid_in_money
end

#cash_paid_out_money ⇒ Object

The amount of money removed from the cash drawer for reasons other than cash refunds.



58
59
60
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 58

def cash_paid_out_money
  @cash_paid_out_money
end

#cash_payment_money ⇒ Object

The amount of money added to the cash drawer from cash payments.



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

def cash_payment_money
  @cash_payment_money
end

#cash_refunds_money ⇒ Object

The amount of money removed from the cash drawer from cash refunds. This value is always negative or zero.



52
53
54
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 52

def cash_refunds_money
  @cash_refunds_money
end

#closed_at ⇒ Object

The time when the shift was closed, in ISO 8601 format.



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

def closed_at
  @closed_at
end

#closed_cash_money ⇒ Object

The amount of money found in the cash drawer at the end of the shift by an auditing employee.



64
65
66
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 64

def closed_cash_money
  @closed_cash_money
end

#closing_employee_id ⇒ Object

The ID of the employee that closed the cash drawer shift by auditing the cash drawer’s contents.



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

def closing_employee_id
  @closing_employee_id
end

#description ⇒ Object

A description of the cash drawer shift.



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

def description
  @description
end

#device ⇒ Object

The device running Square Register that was connected to the cash drawer.



67
68
69
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 67

def device
  @device
end

#employee_ids ⇒ Object

The IDs of all employees that were logged into Square Register at some point during the cash drawer shift.



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

def employee_ids
  @employee_ids
end

#ended_at ⇒ Object

The time when the shift ended, in ISO 8601 format.



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

def ended_at
  @ended_at
end

#ending_employee_id ⇒ Object

The ID of the employee that ended the cash drawer shift.



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

def ending_employee_id
  @ending_employee_id
end

#event_type ⇒ Object

The shift’s current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values



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

def event_type
  @event_type
end

#events ⇒ Object

All of the events (payments, refunds, and so on) that involved the cash drawer during the shift.



70
71
72
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 70

def events
  @events
end

#expected_cash_money ⇒ Object

The amount of money that should be in the cash drawer at the end of the shift, based on the shift’s other money amounts.



61
62
63
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 61

def expected_cash_money
  @expected_cash_money
end

#id ⇒ Object

The shift’s unique ID.



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

def id
  @id
end

#opened_at ⇒ Object

The time when the shift began, in ISO 8601 format.



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

def opened_at
  @opened_at
end

#opening_employee_id ⇒ Object

The ID of the employee that started the cash drawer shift.



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

def opening_employee_id
  @opening_employee_id
end

#starting_cash_money ⇒ Object

The amount of money in the cash drawer at the start of the shift.



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

def starting_cash_money
  @starting_cash_money
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
90
91
92
93
94
95
96
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'event_type' => :'event_type',
    :'opened_at' => :'opened_at',
    :'ended_at' => :'ended_at',
    :'closed_at' => :'closed_at',
    :'employee_ids' => :'employee_ids',
    :'opening_employee_id' => :'opening_employee_id',
    :'ending_employee_id' => :'ending_employee_id',
    :'closing_employee_id' => :'closing_employee_id',
    :'description' => :'description',
    :'starting_cash_money' => :'starting_cash_money',
    :'cash_payment_money' => :'cash_payment_money',
    :'cash_refunds_money' => :'cash_refunds_money',
    :'cash_paid_in_money' => :'cash_paid_in_money',
    :'cash_paid_out_money' => :'cash_paid_out_money',
    :'expected_cash_money' => :'expected_cash_money',
    :'closed_cash_money' => :'closed_cash_money',
    :'device' => :'device',
    :'events' => :'events'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 99

def self.swagger_types
  {
    :'id' => :'String',
    :'event_type' => :'String',
    :'opened_at' => :'String',
    :'ended_at' => :'String',
    :'closed_at' => :'String',
    :'employee_ids' => :'Array<String>',
    :'opening_employee_id' => :'String',
    :'ending_employee_id' => :'String',
    :'closing_employee_id' => :'String',
    :'description' => :'String',
    :'starting_cash_money' => :'V1Money',
    :'cash_payment_money' => :'V1Money',
    :'cash_refunds_money' => :'V1Money',
    :'cash_paid_in_money' => :'V1Money',
    :'cash_paid_out_money' => :'V1Money',
    :'expected_cash_money' => :'V1Money',
    :'closed_cash_money' => :'V1Money',
    :'device' => :'Device',
    :'events' => :'Array<V1CashDrawerEvent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      event_type == o.event_type &&
      opened_at == o.opened_at &&
      ended_at == o.ended_at &&
      closed_at == o.closed_at &&
      employee_ids == o.employee_ids &&
      opening_employee_id == o.opening_employee_id &&
      ending_employee_id == o.ending_employee_id &&
      closing_employee_id == o.closing_employee_id &&
      description == o.description &&
      starting_cash_money == o.starting_cash_money &&
      cash_payment_money == o.cash_payment_money &&
      cash_refunds_money == o.cash_refunds_money &&
      cash_paid_in_money == o.cash_paid_in_money &&
      cash_paid_out_money == o.cash_paid_out_money &&
      expected_cash_money == o.expected_cash_money &&
      closed_cash_money == o.closed_cash_money &&
      device == o.device &&
      events == o.events
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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 288

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 354

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 267

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


254
255
256
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



260
261
262
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 260

def hash
  [id, event_type, opened_at, ended_at, closed_at, employee_ids, opening_employee_id, ending_employee_id, closing_employee_id, description, starting_cash_money, cash_payment_money, cash_refunds_money, cash_paid_in_money, cash_paid_out_money, expected_cash_money, closed_cash_money, device, events].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



215
216
217
218
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 215

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 334

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



340
341
342
343
344
345
346
347
348
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 340

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



328
329
330
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 328

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



222
223
224
 
# File 'lib/square_connect/models/v1_cash_drawer_shift.rb', line 222

def valid?
  return true
end