Class: KoronaCloudClient::Account

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
# File 'lib/korona-cloud-client/models/account.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KoronaCloudClient::Account` 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::Account`. 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?(:'cash_journal_relevant')
    self.cash_journal_relevant = attributes[:'cash_journal_relevant']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activeObject

indicates whether the object is active for use or not



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

def active
  @active
end

#cash_journal_relevantObject

Returns the value of attribute cash_journal_relevant.



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

def cash_journal_relevant
  @cash_journal_relevant
end

#denomination_inputObject

Returns the value of attribute denomination_input.



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

def denomination_input
  @denomination_input
end

#exclusiveObject

Returns the value of attribute exclusive.



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

def exclusive
  @exclusive
end

#fiscal_export_business_caseObject

Returns the value of attribute fiscal_export_business_case.



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

def fiscal_export_business_case
  @fiscal_export_business_case
end

#idObject

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



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

def id
  @id
end

#invert_in_cash_journalObject

Returns the value of attribute invert_in_cash_journal.



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

def invert_in_cash_journal
  @invert_in_cash_journal
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
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/account.rb', line 28

def number
  @number
end

#producerObject

Returns the value of attribute producer.



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

def producer
  @producer
end

#requires_serial_numberObject

Returns the value of attribute requires_serial_number.



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

def requires_serial_number
  @requires_serial_number
end

#revenue_accountObject

Returns the value of attribute revenue_account.



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

def 
  @revenue_account
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/account.rb', line 25

def revision
  @revision
end

#show_transaction_on_customer_displayObject

Returns the value of attribute show_transaction_on_customer_display.



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

def show_transaction_on_customer_display
  @show_transaction_on_customer_display
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



96
97
98
# File 'lib/korona-cloud-client/models/account.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/korona-cloud-client/models/account.rb', line 75

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'cash_journal_relevant' => :'cashJournalRelevant',
    :'denomination_input' => :'denominationInput',
    :'exclusive' => :'exclusive',
    :'name' => :'name',
    :'producer' => :'producer',
    :'requires_serial_number' => :'requiresSerialNumber',
    :'revenue_account' => :'revenueAccount',
    :'type' => :'type',
    :'show_transaction_on_customer_display' => :'showTransactionOnCustomerDisplay',
    :'invert_in_cash_journal' => :'invertInCashJournal',
    :'fiscal_export_business_case' => :'fiscalExportBusinessCase'
  }
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



277
278
279
# File 'lib/korona-cloud-client/models/account.rb', line 277

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

.openapi_nullableObject

List of attributes with nullable: true



122
123
124
125
# File 'lib/korona-cloud-client/models/account.rb', line 122

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

.openapi_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/korona-cloud-client/models/account.rb', line 101

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'cash_journal_relevant' => :'Boolean',
    :'denomination_input' => :'Boolean',
    :'exclusive' => :'Boolean',
    :'name' => :'String',
    :'producer' => :'ModelReference',
    :'requires_serial_number' => :'Boolean',
    :'revenue_account' => :'ModelReference',
    :'type' => :'String',
    :'show_transaction_on_customer_display' => :'Boolean',
    :'invert_in_cash_journal' => :'Boolean',
    :'fiscal_export_business_case' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/korona-cloud-client/models/account.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      cash_journal_relevant == o.cash_journal_relevant &&
      denomination_input == o.denomination_input &&
      exclusive == o.exclusive &&
      name == o.name &&
      producer == o.producer &&
      requires_serial_number == o.requires_serial_number &&
       == o. &&
      type == o.type &&
      show_transaction_on_customer_display == o.show_transaction_on_customer_display &&
      invert_in_cash_journal == o.invert_in_cash_journal &&
      fiscal_export_business_case == o.fiscal_export_business_case
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



308
309
310
311
312
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
# File 'lib/korona-cloud-client/models/account.rb', line 308

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



379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/korona-cloud-client/models/account.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



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

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


264
265
266
# File 'lib/korona-cloud-client/models/account.rb', line 264

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



270
271
272
# File 'lib/korona-cloud-client/models/account.rb', line 270

def hash
  [active, id, revision, number, cash_journal_relevant, denomination_input, exclusive, name, producer, requires_serial_number, , type, show_transaction_on_customer_display, invert_in_cash_journal, fiscal_export_business_case].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



205
206
207
208
# File 'lib/korona-cloud-client/models/account.rb', line 205

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



355
356
357
# File 'lib/korona-cloud-client/models/account.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/korona-cloud-client/models/account.rb', line 361

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



349
350
351
# File 'lib/korona-cloud-client/models/account.rb', line 349

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



212
213
214
215
216
217
218
# File 'lib/korona-cloud-client/models/account.rb', line 212

def valid?
  type_validator = EnumAttributeValidator.new('String', ["DEPOSIT", "WITHDRAWAL"])
  return false unless type_validator.valid?(@type)
  fiscal_export_business_case_validator = EnumAttributeValidator.new('String', ["OPENING_BALANCE", "ADVANCE_PAYMENT_LIQUIDATION", "ADVANCE_PAYMENT_CESSATION", "SURCHARGE", "DISBURSEMENT", "DIFFERENCE_TARGET_ACTUAL", "PAYMENT", "SINGLE_USE_VOUCHER_PAYMENT", "SINGLE_USE_VOUCHER_PURCHASE", "CLAIM_REDEMPTION", "CLAIM_ORIGINATION", "MONEY_TRANSIT", "WAGE_PAYMENT", "VALUE_VOUCHER_PAYMENT", "VALUE_VOUCHER_PURCHASE", "DEPOSIT", "DEPOSIT_REFUND", "PRIVATE_INSERT", "PRIVATE_WITHDRAWEL", "DISCOUNT", "TIP_EMPLOYER", "TIP_EMPLOYEE", "REVENUE", "GRANT_REAL", "GRANT_UNREAL"])
  return false unless fiscal_export_business_case_validator.valid?(@fiscal_export_business_case)
  true
end