Class: PureCloud::Account

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Returns a new instance of Account.



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
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
310
 
# File 'lib/purecloud/models/account.rb', line 171

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'orgLegalName']
    self.org_legal_name = attributes[:'orgLegalName']
  end
  
  if attributes[:'billingAddressLine1']
    self.billing_address_line1 = attributes[:'billingAddressLine1']
  end
  
  if attributes[:'billingAddressLine2']
    self.billing_address_line2 = attributes[:'billingAddressLine2']
  end
  
  if attributes[:'billingAddressCity']
    self.billing_address_city = attributes[:'billingAddressCity']
  end
  
  if attributes[:'billingAddressState']
    self.billing_address_state = attributes[:'billingAddressState']
  end
  
  if attributes[:'billingAddressZipCode']
    self.billing_address_zip_code = attributes[:'billingAddressZipCode']
  end
  
  if attributes[:'billingAddressCountry']
    self.billing_address_country = attributes[:'billingAddressCountry']
  end
  
  if attributes[:'legalAddressLine1']
    self.legal_address_line1 = attributes[:'legalAddressLine1']
  end
  
  if attributes[:'legalAddressLine2']
    self.legal_address_line2 = attributes[:'legalAddressLine2']
  end
  
  if attributes[:'legalAddressCity']
    self.legal_address_city = attributes[:'legalAddressCity']
  end
  
  if attributes[:'legalAddressState']
    self.legal_address_state = attributes[:'legalAddressState']
  end
  
  if attributes[:'legalAddressZipCode']
    self.legal_address_zip_code = attributes[:'legalAddressZipCode']
  end
  
  if attributes[:'legalAddressCountry']
    self.legal_address_country = attributes[:'legalAddressCountry']
  end
  
  if attributes[:'billingContactFirstName']
    self.billing_contact_first_name = attributes[:'billingContactFirstName']
  end
  
  if attributes[:'billingContactLastName']
    self.billing_contact_last_name = attributes[:'billingContactLastName']
  end
  
  if attributes[:'billingContactEmail']
    self.billing_contact_email = attributes[:'billingContactEmail']
  end
  
  if attributes[:'billingContactPhone']
    self.billing_contact_phone = attributes[:'billingContactPhone']
  end
  
  if attributes[:'purchaseOrderNumber']
    self.purchase_order_number = attributes[:'purchaseOrderNumber']
  end
  
  if attributes[:'isTaxExempt']
    self.is_tax_exempt = attributes[:'isTaxExempt']
  else
    self.is_tax_exempt = false
  end
  
  if attributes[:'currency']
    self.currency = attributes[:'currency']
  end
  
  if attributes[:'paymentTerm']
    self.payment_term = attributes[:'paymentTerm']
  end
  
  if attributes[:'contractTerm']
    self.contract_term = attributes[:'contractTerm']
  end
  
  if attributes[:'autoRenew']
    self.auto_renew = attributes[:'autoRenew']
  else
    self.auto_renew = false
  end
  
  if attributes[:'enabled']
    self.enabled = attributes[:'enabled']
  else
    self.enabled = false
  end
  
  if attributes[:'minCommitQuantities']
    if (value = attributes[:'minCommitQuantities']).is_a?(Array)
      self.min_commit_quantities = value
    end
  end
  
  if attributes[:'estimatedQuantities']
    if (value = attributes[:'estimatedQuantities']).is_a?(Array)
      self.estimated_quantities = value
    end
  end
  
  if attributes[:'oneTimeCharges']
    if (value = attributes[:'oneTimeCharges']).is_a?(Array)
      self.one_time_charges = value
    end
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#auto_renew ⇒ Object

Returns the value of attribute auto_renew.



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

def auto_renew
  @auto_renew
end

#billing_address_city ⇒ Object

Returns the value of attribute billing_address_city.



16
17
18
 
# File 'lib/purecloud/models/account.rb', line 16

def billing_address_city
  @billing_address_city
end

#billing_address_country ⇒ Object

Returns the value of attribute billing_address_country.



22
23
24
 
# File 'lib/purecloud/models/account.rb', line 22

def billing_address_country
  @billing_address_country
end

#billing_address_line1 ⇒ Object

Returns the value of attribute billing_address_line1.



12
13
14
 
# File 'lib/purecloud/models/account.rb', line 12

def billing_address_line1
  @billing_address_line1
end

#billing_address_line2 ⇒ Object

Returns the value of attribute billing_address_line2.



14
15
16
 
# File 'lib/purecloud/models/account.rb', line 14

def billing_address_line2
  @billing_address_line2
end

#billing_address_state ⇒ Object

Returns the value of attribute billing_address_state.



18
19
20
 
# File 'lib/purecloud/models/account.rb', line 18

def billing_address_state
  @billing_address_state
end

#billing_address_zip_code ⇒ Object

Returns the value of attribute billing_address_zip_code.



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

def billing_address_zip_code
  @billing_address_zip_code
end

#billing_contact_email ⇒ Object

Returns the value of attribute billing_contact_email.



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

def billing_contact_email
  @billing_contact_email
end

#billing_contact_first_name ⇒ Object

Returns the value of attribute billing_contact_first_name.



36
37
38
 
# File 'lib/purecloud/models/account.rb', line 36

def billing_contact_first_name
  @billing_contact_first_name
end

#billing_contact_last_name ⇒ Object

Returns the value of attribute billing_contact_last_name.



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

def billing_contact_last_name
  @billing_contact_last_name
end

#billing_contact_phone ⇒ Object

Returns the value of attribute billing_contact_phone.



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

def billing_contact_phone
  @billing_contact_phone
end

#contract_term ⇒ Object

Returns the value of attribute contract_term.



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

def contract_term
  @contract_term
end

#currency ⇒ Object

Returns the value of attribute currency.



48
49
50
 
# File 'lib/purecloud/models/account.rb', line 48

def currency
  @currency
end

#enabled ⇒ Object

Returns the value of attribute enabled.



56
57
58
 
# File 'lib/purecloud/models/account.rb', line 56

def enabled
  @enabled
end

#estimated_quantities ⇒ Object

Returns the value of attribute estimated_quantities.



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

def estimated_quantities
  @estimated_quantities
end

#id ⇒ Object

The globally unique identifier for the object.



6
7
8
 
# File 'lib/purecloud/models/account.rb', line 6

def id
  @id
end

#is_tax_exempt ⇒ Object

Returns the value of attribute is_tax_exempt.



46
47
48
 
# File 'lib/purecloud/models/account.rb', line 46

def is_tax_exempt
  @is_tax_exempt
end

#legal_address_city ⇒ Object

Returns the value of attribute legal_address_city.



28
29
30
 
# File 'lib/purecloud/models/account.rb', line 28

def legal_address_city
  @legal_address_city
end

#legal_address_country ⇒ Object

Returns the value of attribute legal_address_country.



34
35
36
 
# File 'lib/purecloud/models/account.rb', line 34

def legal_address_country
  @legal_address_country
end

#legal_address_line1 ⇒ Object

Returns the value of attribute legal_address_line1.



24
25
26
 
# File 'lib/purecloud/models/account.rb', line 24

def legal_address_line1
  @legal_address_line1
end

#legal_address_line2 ⇒ Object

Returns the value of attribute legal_address_line2.



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

def legal_address_line2
  @legal_address_line2
end

#legal_address_state ⇒ Object

Returns the value of attribute legal_address_state.



30
31
32
 
# File 'lib/purecloud/models/account.rb', line 30

def legal_address_state
  @legal_address_state
end

#legal_address_zip_code ⇒ Object

Returns the value of attribute legal_address_zip_code.



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

def legal_address_zip_code
  @legal_address_zip_code
end

#min_commit_quantities ⇒ Object

Returns the value of attribute min_commit_quantities.



58
59
60
 
# File 'lib/purecloud/models/account.rb', line 58

def min_commit_quantities
  @min_commit_quantities
end

#name ⇒ Object

Returns the value of attribute name.



8
9
10
 
# File 'lib/purecloud/models/account.rb', line 8

def name
  @name
end

#one_time_charges ⇒ Object

Returns the value of attribute one_time_charges.



62
63
64
 
# File 'lib/purecloud/models/account.rb', line 62

def one_time_charges
  @one_time_charges
end

#org_legal_name ⇒ Object

Returns the value of attribute org_legal_name.



10
11
12
 
# File 'lib/purecloud/models/account.rb', line 10

def org_legal_name
  @org_legal_name
end

#payment_term ⇒ Object

Returns the value of attribute payment_term.



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

def payment_term
  @payment_term
end

#purchase_order_number ⇒ Object

Returns the value of attribute purchase_order_number.



44
45
46
 
# File 'lib/purecloud/models/account.rb', line 44

def purchase_order_number
  @purchase_order_number
end

#self_uri ⇒ Object

The URI for this object



65
66
67
 
# File 'lib/purecloud/models/account.rb', line 65

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



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
100
101
102
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
 
# File 'lib/purecloud/models/account.rb', line 68

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'org_legal_name' => :'orgLegalName',
    
    :'billing_address_line1' => :'billingAddressLine1',
    
    :'billing_address_line2' => :'billingAddressLine2',
    
    :'billing_address_city' => :'billingAddressCity',
    
    :'billing_address_state' => :'billingAddressState',
    
    :'billing_address_zip_code' => :'billingAddressZipCode',
    
    :'billing_address_country' => :'billingAddressCountry',
    
    :'legal_address_line1' => :'legalAddressLine1',
    
    :'legal_address_line2' => :'legalAddressLine2',
    
    :'legal_address_city' => :'legalAddressCity',
    
    :'legal_address_state' => :'legalAddressState',
    
    :'legal_address_zip_code' => :'legalAddressZipCode',
    
    :'legal_address_country' => :'legalAddressCountry',
    
    :'billing_contact_first_name' => :'billingContactFirstName',
    
    :'billing_contact_last_name' => :'billingContactLastName',
    
    :'billing_contact_email' => :'billingContactEmail',
    
    :'billing_contact_phone' => :'billingContactPhone',
    
    :'purchase_order_number' => :'purchaseOrderNumber',
    
    :'is_tax_exempt' => :'isTaxExempt',
    
    :'currency' => :'currency',
    
    :'payment_term' => :'paymentTerm',
    
    :'contract_term' => :'contractTerm',
    
    :'auto_renew' => :'autoRenew',
    
    :'enabled' => :'enabled',
    
    :'min_commit_quantities' => :'minCommitQuantities',
    
    :'estimated_quantities' => :'estimatedQuantities',
    
    :'one_time_charges' => :'oneTimeCharges',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'org_legal_name' => :'String',
    :'billing_address_line1' => :'String',
    :'billing_address_line2' => :'String',
    :'billing_address_city' => :'String',
    :'billing_address_state' => :'String',
    :'billing_address_zip_code' => :'String',
    :'billing_address_country' => :'String',
    :'legal_address_line1' => :'String',
    :'legal_address_line2' => :'String',
    :'legal_address_city' => :'String',
    :'legal_address_state' => :'String',
    :'legal_address_zip_code' => :'String',
    :'legal_address_country' => :'String',
    :'billing_contact_first_name' => :'String',
    :'billing_contact_last_name' => :'String',
    :'billing_contact_email' => :'String',
    :'billing_contact_phone' => :'String',
    :'purchase_order_number' => :'String',
    :'is_tax_exempt' => :'BOOLEAN',
    :'currency' => :'String',
    :'payment_term' => :'String',
    :'contract_term' => :'Integer',
    :'auto_renew' => :'BOOLEAN',
    :'enabled' => :'BOOLEAN',
    :'min_commit_quantities' => :'Hash<String, Integer>',
    :'estimated_quantities' => :'Hash<String, Integer>',
    :'one_time_charges' => :'Array<String>',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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
346
 
# File 'lib/purecloud/models/account.rb', line 313

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      org_legal_name == o.org_legal_name &&
      billing_address_line1 == o.billing_address_line1 &&
      billing_address_line2 == o.billing_address_line2 &&
      billing_address_city == o.billing_address_city &&
      billing_address_state == o.billing_address_state &&
      billing_address_zip_code == o.billing_address_zip_code &&
      billing_address_country == o.billing_address_country &&
      legal_address_line1 == o.legal_address_line1 &&
      legal_address_line2 == o.legal_address_line2 &&
      legal_address_city == o.legal_address_city &&
      legal_address_state == o.legal_address_state &&
      legal_address_zip_code == o.legal_address_zip_code &&
      legal_address_country == o.legal_address_country &&
      billing_contact_first_name == o.billing_contact_first_name &&
      billing_contact_last_name == o.billing_contact_last_name &&
      billing_contact_email == o.billing_contact_email &&
      billing_contact_phone == o.billing_contact_phone &&
      purchase_order_number == o.purchase_order_number &&
      is_tax_exempt == o.is_tax_exempt &&
      currency == o.currency &&
      payment_term == o.payment_term &&
      contract_term == o.contract_term &&
      auto_renew == o.auto_renew &&
      enabled == o.enabled &&
      min_commit_quantities == o.min_commit_quantities &&
      estimated_quantities == o.estimated_quantities &&
      one_time_charges == o.one_time_charges &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/purecloud/models/account.rb', line 378

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/purecloud/models/account.rb', line 435

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

build the object from hash



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/purecloud/models/account.rb', line 359

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


349
350
351
 
# File 'lib/purecloud/models/account.rb', line 349

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



354
355
356
 
# File 'lib/purecloud/models/account.rb', line 354

def hash
  [id, name, org_legal_name, billing_address_line1, billing_address_line2, billing_address_city, billing_address_state, billing_address_zip_code, billing_address_country, legal_address_line1, legal_address_line2, legal_address_city, legal_address_state, legal_address_zip_code, legal_address_country, billing_contact_first_name, billing_contact_last_name, billing_contact_email, billing_contact_phone, purchase_order_number, is_tax_exempt, currency, payment_term, contract_term, auto_renew, enabled, min_commit_quantities, estimated_quantities, one_time_charges, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



418
419
420
 
# File 'lib/purecloud/models/account.rb', line 418

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



423
424
425
426
427
428
429
430
431
 
# File 'lib/purecloud/models/account.rb', line 423

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 ⇒ Object 



413
414
415
 
# File 'lib/purecloud/models/account.rb', line 413

def to_s
  to_hash.to_s
end