Class: TogaiClient::Account

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/account.rb

Overview

Structure of an account

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



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
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
 
# File 'lib/togai_client/models/account.rb', line 141

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

  if attributes.key?(:'togai_account_id')
    self. = attributes[:'togai_account_id']
  else
    self. = nil
  end

  if attributes.key?(:'togai_customer_id')
    self.togai_customer_id = attributes[:'togai_customer_id']
  else
    self.togai_customer_id = nil
  end

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

  if attributes.key?(:'customer_id')
    self.customer_id = attributes[:'customer_id']
  else
    self.customer_id = nil
  end

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

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

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

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



42
43
44
 
# File 'lib/togai_client/models/account.rb', line 42

def address
  @address
end

#aliases ⇒ Object

list of aliases of the account



38
39
40
 
# File 'lib/togai_client/models/account.rb', line 38

def aliases
  @aliases
end

#billing_information ⇒ Object

Returns the value of attribute billing_information.



47
48
49
 
# File 'lib/togai_client/models/account.rb', line 47

def billing_information
  @billing_information
end

#customer_id ⇒ Object

Identifier of the customer



32
33
34
 
# File 'lib/togai_client/models/account.rb', line 32

def customer_id
  @customer_id
end

#id ⇒ Object

Identifier of the account



20
21
22
 
# File 'lib/togai_client/models/account.rb', line 20

def id
  @id
end

#invoice_currency ⇒ Object

[ISO_4217](en.wikipedia.org/wiki/ISO_4217) code of the currency in which the account must be invoiced Defaults to Base currency.



35
36
37
 
# File 'lib/togai_client/models/account.rb', line 35

def invoice_currency
  @invoice_currency
end

#invoice_group_details ⇒ Object

Returns the value of attribute invoice_group_details.



54
55
56
 
# File 'lib/togai_client/models/account.rb', line 54

def invoice_group_details
  @invoice_group_details
end

#metadata ⇒ Object

Additional information associated with the account. Example: GSTN, VATN



57
58
59
 
# File 'lib/togai_client/models/account.rb', line 57

def metadata
  @metadata
end

#name ⇒ Object

Name of the Account



29
30
31
 
# File 'lib/togai_client/models/account.rb', line 29

def name
  @name
end

#net_term_days ⇒ Object

Returns the value of attribute net_term_days.



40
41
42
 
# File 'lib/togai_client/models/account.rb', line 40

def net_term_days
  @net_term_days
end

#primary_email ⇒ Object

Primary email of the customer



45
46
47
 
# File 'lib/togai_client/models/account.rb', line 45

def primary_email
  @primary_email
end

#settings ⇒ Object

Returns the value of attribute settings.



52
53
54
 
# File 'lib/togai_client/models/account.rb', line 52

def settings
  @settings
end

#status ⇒ Object

Status of the account



50
51
52
 
# File 'lib/togai_client/models/account.rb', line 50

def status
  @status
end

#tags ⇒ Object

Tag for accounts are stored in lowercase



60
61
62
 
# File 'lib/togai_client/models/account.rb', line 60

def tags
  @tags
end

#togai_account_id ⇒ Object

Unique identifier of the account



23
24
25
 
# File 'lib/togai_client/models/account.rb', line 23

def 
  @togai_account_id
end

#togai_customer_id ⇒ Object

Unique identifier of the customer



26
27
28
 
# File 'lib/togai_client/models/account.rb', line 26

def togai_customer_id
  @togai_customer_id
end

Class Method Details

._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



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/togai_client/models/account.rb', line 518

def self._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 = TogaiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/togai_client/models/account.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/togai_client/models/account.rb', line 85

def self.attribute_map
  {
    :'id' => :'id',
    :'togai_account_id' => :'togaiAccountId',
    :'togai_customer_id' => :'togaiCustomerId',
    :'name' => :'name',
    :'customer_id' => :'customerId',
    :'invoice_currency' => :'invoiceCurrency',
    :'aliases' => :'aliases',
    :'net_term_days' => :'netTermDays',
    :'address' => :'address',
    :'primary_email' => :'primaryEmail',
    :'billing_information' => :'billingInformation',
    :'status' => :'status',
    :'settings' => :'settings',
    :'invoice_group_details' => :'invoiceGroupDetails',
    :'metadata' => :'metadata',
    :'tags' => :'tags'
  }
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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/togai_client/models/account.rb', line 494

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/togai_client/models/account.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/togai_client/models/account.rb', line 112

def self.openapi_types
  {
    :'id' => :'String',
    :'togai_account_id' => :'String',
    :'togai_customer_id' => :'String',
    :'name' => :'String',
    :'customer_id' => :'String',
    :'invoice_currency' => :'String',
    :'aliases' => :'Array<AccountAliases>',
    :'net_term_days' => :'Integer',
    :'address' => :'Address',
    :'primary_email' => :'String',
    :'billing_information' => :'AccountsBillingInformation',
    :'status' => :'String',
    :'settings' => :'Array<CreateEntitySetting>',
    :'invoice_group_details' => :'InvoiceGroupDetails',
    :'metadata' => :'Hash<String, String>',
    :'tags' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/togai_client/models/account.rb', line 458

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      togai_customer_id == o.togai_customer_id &&
      name == o.name &&
      customer_id == o.customer_id &&
      invoice_currency == o.invoice_currency &&
      aliases == o.aliases &&
      net_term_days == o.net_term_days &&
      address == o.address &&
      primary_email == o.primary_email &&
      billing_information == o.billing_information &&
      status == o.status &&
      settings == o.settings &&
      invoice_group_details == o.invoice_group_details &&
      metadata == o.metadata &&
      tags == o.tags
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



589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/togai_client/models/account.rb', line 589

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


481
482
483
 
# File 'lib/togai_client/models/account.rb', line 481

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



487
488
489
 
# File 'lib/togai_client/models/account.rb', line 487

def hash
  [id, , togai_customer_id, name, customer_id, invoice_currency, aliases, net_term_days, address, primary_email, billing_information, status, settings, invoice_group_details, metadata, tags].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
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
302
303
304
305
306
307
308
309
 
# File 'lib/togai_client/models/account.rb', line 241

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @id.to_s.length > 50
    invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
  end

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

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

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

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

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

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

  if !@invoice_currency.nil? && @invoice_currency.to_s.length > 3
    invalid_properties.push('invalid value for "invoice_currency", the character length must be smaller than or equal to 3.')
  end

  if !@invoice_currency.nil? && @invoice_currency.to_s.length < 3
    invalid_properties.push('invalid value for "invoice_currency", the character length must be great than or equal to 3.')
  end

  if !@aliases.nil? && @aliases.length > 10
    invalid_properties.push('invalid value for "aliases", number of items must be less than or equal to 10.')
  end

  if !@aliases.nil? && @aliases.length < 0
    invalid_properties.push('invalid value for "aliases", number of items must be greater than or equal to 0.')
  end

  if !@primary_email.nil? && @primary_email.to_s.length > 320
    invalid_properties.push('invalid value for "primary_email", the character length must be smaller than or equal to 320.')
  end

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

  if !@settings.nil? && @settings.length > 10
    invalid_properties.push('invalid value for "settings", number of items must be less than or equal to 10.')
  end

  if !@settings.nil? && @settings.length < 0
    invalid_properties.push('invalid value for "settings", number of items must be greater than or equal to 0.')
  end

  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



565
566
567
 
# File 'lib/togai_client/models/account.rb', line 565

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



571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/togai_client/models/account.rb', line 571

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



559
560
561
 
# File 'lib/togai_client/models/account.rb', line 559

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/togai_client/models/account.rb', line 313

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @id.to_s.length > 50
  return false if @togai_account_id.nil?
  return false if @togai_customer_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 3
  return false if @customer_id.nil?
  return false if !@invoice_currency.nil? && @invoice_currency.to_s.length > 3
  return false if !@invoice_currency.nil? && @invoice_currency.to_s.length < 3
  return false if !@aliases.nil? && @aliases.length > 10
  return false if !@aliases.nil? && @aliases.length < 0
  return false if !@primary_email.nil? && @primary_email.to_s.length > 320
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "DRAFT", "ARCHIVED"])
  return false unless status_validator.valid?(@status)
  return false if !@settings.nil? && @settings.length > 10
  return false if !@settings.nil? && @settings.length < 0
  true
end