Class: KoronaCloudClient::Cashier

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/models/cashier.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Cashier

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
241
242
243
244
245
246
247
248
249
# File 'lib/korona-cloud-client/models/cashier.rb', line 153

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KoronaCloudClient::Cashier` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `KoronaCloudClient::Cashier`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'revision')
    self.revision = attributes[:'revision']
  end

  if attributes.key?(:'number')
    self.number = attributes[:'number']
  end

  if attributes.key?(:'_alias')
    self._alias = attributes[:'_alias']
  end

  if attributes.key?(:'deactivated')
    self.deactivated = attributes[:'deactivated']
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'firstname')
    self.firstname = attributes[:'firstname']
  end

  if attributes.key?(:'surname')
    self.surname = attributes[:'surname']
  end

  if attributes.key?(:'gender')
    self.gender = attributes[:'gender']
  end

  if attributes.key?(:'login_code')
    self. = attributes[:'login_code']
  end

  if attributes.key?(:'login_password')
    self. = attributes[:'login_password']
  end

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

  if attributes.key?(:'role')
    self.role = attributes[:'role']
  end

  if attributes.key?(:'bonus_points')
    self.bonus_points = attributes[:'bonus_points']
  end

  if attributes.key?(:'background_color')
    self.background_color = attributes[:'background_color']
  end

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

  if attributes.key?(:'cashier_role')
    self.cashier_role = attributes[:'cashier_role']
  end

  if attributes.key?(:'create_time')
    self.create_time = attributes[:'create_time']
  end

  if attributes.key?(:'last_receipt_time')
    self.last_receipt_time = attributes[:'last_receipt_time']
  end
end

Instance Attribute Details

#_aliasObject

Returns the value of attribute _alias.



30
31
32
# File 'lib/korona-cloud-client/models/cashier.rb', line 30

def _alias
  @_alias
end

#activeObject

indicates whether the object is active for use or not



19
20
21
# File 'lib/korona-cloud-client/models/cashier.rb', line 19

def active
  @active
end

#background_colorObject

Returns the value of attribute background_color.



54
55
56
# File 'lib/korona-cloud-client/models/cashier.rb', line 54

def background_color
  @background_color
end

#bonus_pointsObject

Returns the value of attribute bonus_points.



52
53
54
# File 'lib/korona-cloud-client/models/cashier.rb', line 52

def bonus_points
  @bonus_points
end

#cashier_roleObject

Returns the value of attribute cashier_role.



58
59
60
# File 'lib/korona-cloud-client/models/cashier.rb', line 58

def cashier_role
  @cashier_role
end

#create_timeObject

Format: yyyy-MM-dd



61
62
63
# File 'lib/korona-cloud-client/models/cashier.rb', line 61

def create_time
  @create_time
end

#deactivatedObject

Returns the value of attribute deactivated.



32
33
34
# File 'lib/korona-cloud-client/models/cashier.rb', line 32

def deactivated
  @deactivated
end

#emailObject

Returns the value of attribute email.



34
35
36
# File 'lib/korona-cloud-client/models/cashier.rb', line 34

def email
  @email
end

#firstnameObject

Returns the value of attribute firstname.



36
37
38
# File 'lib/korona-cloud-client/models/cashier.rb', line 36

def firstname
  @firstname
end

#genderObject

Returns the value of attribute gender.



40
41
42
# File 'lib/korona-cloud-client/models/cashier.rb', line 40

def gender
  @gender
end

#idObject

global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)



22
23
24
# File 'lib/korona-cloud-client/models/cashier.rb', line 22

def id
  @id
end

#last_receipt_timeObject

Format: yyyy-MM-dd



64
65
66
# File 'lib/korona-cloud-client/models/cashier.rb', line 64

def last_receipt_time
  @last_receipt_time
end

#login_codeObject

by default, the md5 hash of the cashiers login code. on GET requests this can be changed via the ‘displayCashierCredentials=(HASH|PLAIN|NONE)` parameter, on POST and PATCH it is always assumed to be `PLAIN` text.



43
44
45
# File 'lib/korona-cloud-client/models/cashier.rb', line 43

def 
  @login_code
end

#login_passwordObject

by default, the md5 hash of the cashiers login password. on GET requests this can be changed via the ‘displayCashierCredentials=(HASH|PLAIN|NONE)` parameter, on POST and PATCH it is always assumed to be `PLAIN` text.



46
47
48
# File 'lib/korona-cloud-client/models/cashier.rb', line 46

def 
  @login_password
end

#numberObject

number of the object, like it is set in backoffice; will be removed when active=false



28
29
30
# File 'lib/korona-cloud-client/models/cashier.rb', line 28

def number
  @number
end

#organizational_unitsObject

Returns the value of attribute organizational_units.



56
57
58
# File 'lib/korona-cloud-client/models/cashier.rb', line 56

def organizational_units
  @organizational_units
end

#permissionsObject

Returns the value of attribute permissions.



48
49
50
# File 'lib/korona-cloud-client/models/cashier.rb', line 48

def permissions
  @permissions
end

#revisionObject

the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.



25
26
27
# File 'lib/korona-cloud-client/models/cashier.rb', line 25

def revision
  @revision
end

#roleObject

Returns the value of attribute role.



50
51
52
# File 'lib/korona-cloud-client/models/cashier.rb', line 50

def role
  @role
end

#surnameObject

Returns the value of attribute surname.



38
39
40
# File 'lib/korona-cloud-client/models/cashier.rb', line 38

def surname
  @surname
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



115
116
117
# File 'lib/korona-cloud-client/models/cashier.rb', line 115

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/korona-cloud-client/models/cashier.rb', line 89

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'_alias' => :'alias',
    :'deactivated' => :'deactivated',
    :'email' => :'email',
    :'firstname' => :'firstname',
    :'surname' => :'surname',
    :'gender' => :'gender',
    :'login_code' => :'loginCode',
    :'login_password' => :'loginPassword',
    :'permissions' => :'permissions',
    :'role' => :'role',
    :'bonus_points' => :'bonusPoints',
    :'background_color' => :'backgroundColor',
    :'organizational_units' => :'organizationalUnits',
    :'cashier_role' => :'cashierRole',
    :'create_time' => :'createTime',
    :'last_receipt_time' => :'lastReceiptTime'
  }
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



324
325
326
# File 'lib/korona-cloud-client/models/cashier.rb', line 324

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullableObject

List of attributes with nullable: true



146
147
148
149
# File 'lib/korona-cloud-client/models/cashier.rb', line 146

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/korona-cloud-client/models/cashier.rb', line 120

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'_alias' => :'String',
    :'deactivated' => :'Boolean',
    :'email' => :'String',
    :'firstname' => :'String',
    :'surname' => :'String',
    :'gender' => :'String',
    :'login_code' => :'String',
    :'login_password' => :'String',
    :'permissions' => :'Array<String>',
    :'role' => :'String',
    :'bonus_points' => :'Integer',
    :'background_color' => :'Integer',
    :'organizational_units' => :'Array<ModelReference>',
    :'cashier_role' => :'ModelReference',
    :'create_time' => :'Date',
    :'last_receipt_time' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# File 'lib/korona-cloud-client/models/cashier.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      _alias == o._alias &&
      deactivated == o.deactivated &&
      email == o.email &&
      firstname == o.firstname &&
      surname == o.surname &&
      gender == o.gender &&
       == o. &&
       == o. &&
      permissions == o.permissions &&
      role == o.role &&
      bonus_points == o.bonus_points &&
      background_color == o.background_color &&
      organizational_units == o.organizational_units &&
      cashier_role == o.cashier_role &&
      create_time == o.create_time &&
      last_receipt_time == o.last_receipt_time
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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/korona-cloud-client/models/cashier.rb', line 355

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = KoronaCloudClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



426
427
428
429
430
431
432
433
434
435
436
437
438
# File 'lib/korona-cloud-client/models/cashier.rb', line 426

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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/korona-cloud-client/models/cashier.rb', line 331

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
# File 'lib/korona-cloud-client/models/cashier.rb', line 311

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



317
318
319
# File 'lib/korona-cloud-client/models/cashier.rb', line 317

def hash
  [active, id, revision, number, _alias, deactivated, email, firstname, surname, gender, , , permissions, role, bonus_points, background_color, organizational_units, cashier_role, create_time, last_receipt_time].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



253
254
255
256
# File 'lib/korona-cloud-client/models/cashier.rb', line 253

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



402
403
404
# File 'lib/korona-cloud-client/models/cashier.rb', line 402

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'lib/korona-cloud-client/models/cashier.rb', line 408

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



396
397
398
# File 'lib/korona-cloud-client/models/cashier.rb', line 396

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



260
261
262
263
264
# File 'lib/korona-cloud-client/models/cashier.rb', line 260

def valid?
  gender_validator = EnumAttributeValidator.new('String', ["MALE", "FEMALE"])
  return false unless gender_validator.valid?(@gender)
  true
end