Class: DocuSign_eSign::AccountInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/account_information.rb

Overview

Contains account Information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
346
# File 'lib/docusign_esign/models/account_information.rb', line 201

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'dssValues')
    if (value = attributes[:'dssValues']).is_a?(Hash)
      self.dss_values = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id_guidObject

The GUID associated with the account ID.


19
20
21
# File 'lib/docusign_esign/models/account_information.rb', line 19

def 
  @account_id_guid
end

#account_nameObject

The name of the current account.


22
23
24
# File 'lib/docusign_esign/models/account_information.rb', line 22

def 
  @account_name
end

#account_settingsObject

Returns the value of attribute account_settings


24
25
26
# File 'lib/docusign_esign/models/account_information.rb', line 24

def 
  @account_settings
end

#allow_transaction_roomsObject

When set to *true*, the transaction rooms feature exposed through the Workspaces API is enabled.


27
28
29
# File 'lib/docusign_esign/models/account_information.rb', line 27

def allow_transaction_rooms
  @allow_transaction_rooms
end

#billing_period_days_remainingObject

Reserved: TBD


30
31
32
# File 'lib/docusign_esign/models/account_information.rb', line 30

def billing_period_days_remaining
  @billing_period_days_remaining
end

#billing_period_end_dateObject

Reserved: TBD


33
34
35
# File 'lib/docusign_esign/models/account_information.rb', line 33

def billing_period_end_date
  @billing_period_end_date
end

#billing_period_envelopes_allowedObject

Reserved: TBD


36
37
38
# File 'lib/docusign_esign/models/account_information.rb', line 36

def billing_period_envelopes_allowed
  @billing_period_envelopes_allowed
end

#billing_period_envelopes_sentObject

Reserved: TBD


39
40
41
# File 'lib/docusign_esign/models/account_information.rb', line 39

def billing_period_envelopes_sent
  @billing_period_envelopes_sent
end

#billing_period_start_dateObject

Reserved: TBD


42
43
44
# File 'lib/docusign_esign/models/account_information.rb', line 42

def billing_period_start_date
  @billing_period_start_date
end

#billing_profileObject

Reserved: TBD


45
46
47
# File 'lib/docusign_esign/models/account_information.rb', line 45

def billing_profile
  @billing_profile
end

#can_upgradeObject

When set to *true*, specifies that you can upgrade the account through the API.


48
49
50
# File 'lib/docusign_esign/models/account_information.rb', line 48

def can_upgrade
  @can_upgrade
end

#connect_permissionObject

Returns the value of attribute connect_permission


51
52
53
# File 'lib/docusign_esign/models/account_information.rb', line 51

def connect_permission
  @connect_permission
end

#created_dateObject

Returns the value of attribute created_date


54
55
56
# File 'lib/docusign_esign/models/account_information.rb', line 54

def created_date
  @created_date
end

#currency_codeObject

Specifies the ISO currency code for the account.


57
58
59
# File 'lib/docusign_esign/models/account_information.rb', line 57

def currency_code
  @currency_code
end

#current_plan_idObject

Identifies the plan that was used create this account.


60
61
62
# File 'lib/docusign_esign/models/account_information.rb', line 60

def current_plan_id
  @current_plan_id
end

#distributor_codeObject

The code that identifies the billing plan groups and plans for the new account.


63
64
65
# File 'lib/docusign_esign/models/account_information.rb', line 63

def distributor_code
  @distributor_code
end

#docu_sign_landing_urlObject

Returns the value of attribute docu_sign_landing_url


66
67
68
# File 'lib/docusign_esign/models/account_information.rb', line 66

def docu_sign_landing_url
  @docu_sign_landing_url
end

#dss_valuesObject

Returns the value of attribute dss_values


69
70
71
# File 'lib/docusign_esign/models/account_information.rb', line 69

def dss_values
  @dss_values
end

#envelope_sending_blockedObject

Returns the value of attribute envelope_sending_blocked


72
73
74
# File 'lib/docusign_esign/models/account_information.rb', line 72

def envelope_sending_blocked
  @envelope_sending_blocked
end

#envelope_unit_priceObject

Returns the value of attribute envelope_unit_price


75
76
77
# File 'lib/docusign_esign/models/account_information.rb', line 75

def envelope_unit_price
  @envelope_unit_price
end

#external_account_idObject

Returns the value of attribute external_account_id


78
79
80
# File 'lib/docusign_esign/models/account_information.rb', line 78

def 
  @external_account_id
end

#forgotten_password_questions_countObject

A complex element that contains up to four Question/Answer pairs for forgotten password information for a user.


81
82
83
# File 'lib/docusign_esign/models/account_information.rb', line 81

def forgotten_password_questions_count
  @forgotten_password_questions_count
end

#is_downgradeObject

Returns the value of attribute is_downgrade


84
85
86
# File 'lib/docusign_esign/models/account_information.rb', line 84

def is_downgrade
  @is_downgrade
end

#payment_methodObject

Returns the value of attribute payment_method


87
88
89
# File 'lib/docusign_esign/models/account_information.rb', line 87

def payment_method
  @payment_method
end

#plan_classificationObject

Identifies the type of plan. Examples include Business, Corporate, Enterprise, Free.


90
91
92
# File 'lib/docusign_esign/models/account_information.rb', line 90

def plan_classification
  @plan_classification
end

#plan_end_dateObject

The date that the current plan will end.


93
94
95
# File 'lib/docusign_esign/models/account_information.rb', line 93

def plan_end_date
  @plan_end_date
end

#plan_nameObject

The name of the Billing Plan.


96
97
98
# File 'lib/docusign_esign/models/account_information.rb', line 96

def plan_name
  @plan_name
end

#plan_start_dateObject

The date that the Account started using the current plan.


99
100
101
# File 'lib/docusign_esign/models/account_information.rb', line 99

def plan_start_date
  @plan_start_date
end

#recipient_domainsObject

Returns the value of attribute recipient_domains


102
103
104
# File 'lib/docusign_esign/models/account_information.rb', line 102

def recipient_domains
  @recipient_domains
end

#seats_allowedObject

Returns the value of attribute seats_allowed


105
106
107
# File 'lib/docusign_esign/models/account_information.rb', line 105

def seats_allowed
  @seats_allowed
end

#seats_in_useObject

Returns the value of attribute seats_in_use


108
109
110
# File 'lib/docusign_esign/models/account_information.rb', line 108

def seats_in_use
  @seats_in_use
end

#status21_cfr_part11Object

Returns the value of attribute status21_cfr_part11


111
112
113
# File 'lib/docusign_esign/models/account_information.rb', line 111

def status21_cfr_part11
  @status21_cfr_part11
end

#suspension_dateObject

Returns the value of attribute suspension_date


114
115
116
# File 'lib/docusign_esign/models/account_information.rb', line 114

def suspension_date
  @suspension_date
end

#suspension_statusObject

Returns the value of attribute suspension_status


117
118
119
# File 'lib/docusign_esign/models/account_information.rb', line 117

def suspension_status
  @suspension_status
end

Class Method Details

.attribute_mapObject

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


120
121
122
123
124
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
# File 'lib/docusign_esign/models/account_information.rb', line 120

def self.attribute_map
  {
    :'account_id_guid' => :'accountIdGuid',
    :'account_name' => :'accountName',
    :'account_settings' => :'accountSettings',
    :'allow_transaction_rooms' => :'allowTransactionRooms',
    :'billing_period_days_remaining' => :'billingPeriodDaysRemaining',
    :'billing_period_end_date' => :'billingPeriodEndDate',
    :'billing_period_envelopes_allowed' => :'billingPeriodEnvelopesAllowed',
    :'billing_period_envelopes_sent' => :'billingPeriodEnvelopesSent',
    :'billing_period_start_date' => :'billingPeriodStartDate',
    :'billing_profile' => :'billingProfile',
    :'can_upgrade' => :'canUpgrade',
    :'connect_permission' => :'connectPermission',
    :'created_date' => :'createdDate',
    :'currency_code' => :'currencyCode',
    :'current_plan_id' => :'currentPlanId',
    :'distributor_code' => :'distributorCode',
    :'docu_sign_landing_url' => :'docuSignLandingUrl',
    :'dss_values' => :'dssValues',
    :'envelope_sending_blocked' => :'envelopeSendingBlocked',
    :'envelope_unit_price' => :'envelopeUnitPrice',
    :'external_account_id' => :'externalAccountId',
    :'forgotten_password_questions_count' => :'forgottenPasswordQuestionsCount',
    :'is_downgrade' => :'isDowngrade',
    :'payment_method' => :'paymentMethod',
    :'plan_classification' => :'planClassification',
    :'plan_end_date' => :'planEndDate',
    :'plan_name' => :'planName',
    :'plan_start_date' => :'planStartDate',
    :'recipient_domains' => :'recipientDomains',
    :'seats_allowed' => :'seatsAllowed',
    :'seats_in_use' => :'seatsInUse',
    :'status21_cfr_part11' => :'status21CFRPart11',
    :'suspension_date' => :'suspensionDate',
    :'suspension_status' => :'suspensionStatus'
  }
end

.swagger_typesObject

Attribute type mapping.


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
# File 'lib/docusign_esign/models/account_information.rb', line 160

def self.swagger_types
  {
    :'account_id_guid' => :'String',
    :'account_name' => :'String',
    :'account_settings' => :'AccountSettingsInformation',
    :'allow_transaction_rooms' => :'String',
    :'billing_period_days_remaining' => :'String',
    :'billing_period_end_date' => :'String',
    :'billing_period_envelopes_allowed' => :'String',
    :'billing_period_envelopes_sent' => :'String',
    :'billing_period_start_date' => :'String',
    :'billing_profile' => :'String',
    :'can_upgrade' => :'String',
    :'connect_permission' => :'String',
    :'created_date' => :'String',
    :'currency_code' => :'String',
    :'current_plan_id' => :'String',
    :'distributor_code' => :'String',
    :'docu_sign_landing_url' => :'String',
    :'dss_values' => :'Hash<String, String>',
    :'envelope_sending_blocked' => :'String',
    :'envelope_unit_price' => :'String',
    :'external_account_id' => :'String',
    :'forgotten_password_questions_count' => :'String',
    :'is_downgrade' => :'String',
    :'payment_method' => :'String',
    :'plan_classification' => :'String',
    :'plan_end_date' => :'String',
    :'plan_name' => :'String',
    :'plan_start_date' => :'String',
    :'recipient_domains' => :'Array<RecipientDomain>',
    :'seats_allowed' => :'String',
    :'seats_in_use' => :'String',
    :'status21_cfr_part11' => :'String',
    :'suspension_date' => :'String',
    :'suspension_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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
393
394
395
396
397
398
399
400
# File 'lib/docusign_esign/models/account_information.rb', line 363

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
       == o. &&
      allow_transaction_rooms == o.allow_transaction_rooms &&
      billing_period_days_remaining == o.billing_period_days_remaining &&
      billing_period_end_date == o.billing_period_end_date &&
      billing_period_envelopes_allowed == o.billing_period_envelopes_allowed &&
      billing_period_envelopes_sent == o.billing_period_envelopes_sent &&
      billing_period_start_date == o.billing_period_start_date &&
      billing_profile == o.billing_profile &&
      can_upgrade == o.can_upgrade &&
      connect_permission == o.connect_permission &&
      created_date == o.created_date &&
      currency_code == o.currency_code &&
      current_plan_id == o.current_plan_id &&
      distributor_code == o.distributor_code &&
      docu_sign_landing_url == o.docu_sign_landing_url &&
      dss_values == o.dss_values &&
      envelope_sending_blocked == o.envelope_sending_blocked &&
      envelope_unit_price == o.envelope_unit_price &&
       == o. &&
      forgotten_password_questions_count == o.forgotten_password_questions_count &&
      is_downgrade == o.is_downgrade &&
      payment_method == o.payment_method &&
      plan_classification == o.plan_classification &&
      plan_end_date == o.plan_end_date &&
      plan_name == o.plan_name &&
      plan_start_date == o.plan_start_date &&
      recipient_domains == o.recipient_domains &&
      seats_allowed == o.seats_allowed &&
      seats_in_use == o.seats_in_use &&
      status21_cfr_part11 == o.status21_cfr_part11 &&
      suspension_date == o.suspension_date &&
      suspension_status == o.suspension_status
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


438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
# File 'lib/docusign_esign/models/account_information.rb', line 438

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 = DocuSign_eSign.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


504
505
506
507
508
509
510
511
512
513
514
515
516
# File 'lib/docusign_esign/models/account_information.rb', line 504

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


417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
# File 'lib/docusign_esign/models/account_information.rb', line 417

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

404
405
406
# File 'lib/docusign_esign/models/account_information.rb', line 404

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


410
411
412
# File 'lib/docusign_esign/models/account_information.rb', line 410

def hash
  [, , , allow_transaction_rooms, billing_period_days_remaining, billing_period_end_date, billing_period_envelopes_allowed, billing_period_envelopes_sent, billing_period_start_date, billing_profile, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, distributor_code, docu_sign_landing_url, dss_values, envelope_sending_blocked, envelope_unit_price, , forgotten_password_questions_count, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, recipient_domains, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


350
351
352
353
# File 'lib/docusign_esign/models/account_information.rb', line 350

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


484
485
486
# File 'lib/docusign_esign/models/account_information.rb', line 484

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


490
491
492
493
494
495
496
497
498
# File 'lib/docusign_esign/models/account_information.rb', line 490

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


478
479
480
# File 'lib/docusign_esign/models/account_information.rb', line 478

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


357
358
359
# File 'lib/docusign_esign/models/account_information.rb', line 357

def valid?
  true
end