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



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
311
312
313
314
315
316
317
 
# File 'lib/docusign_esign/models/account_information.rb', line 187

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

  if attributes.has_key?(:'envelopeUnitPrice')
    self.envelope_unit_price = attributes[:'envelopeUnitPrice']
  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?(:'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_guid ⇒ Object

The GUID associated with the account ID.



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

def 
  @account_id_guid
end

#account_name ⇒ Object

The name of the current account.



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

def 
  @account_name
end

#allow_transaction_rooms ⇒ Object

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



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

def allow_transaction_rooms
  @allow_transaction_rooms
end

#billing_period_days_remaining ⇒ Object

Reserved: TBD



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

def billing_period_days_remaining
  @billing_period_days_remaining
end

#billing_period_end_date ⇒ Object

Reserved: TBD



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

def billing_period_end_date
  @billing_period_end_date
end

#billing_period_envelopes_allowed ⇒ Object

Reserved: TBD



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

def billing_period_envelopes_allowed
  @billing_period_envelopes_allowed
end

#billing_period_envelopes_sent ⇒ Object

Reserved: TBD



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

def billing_period_envelopes_sent
  @billing_period_envelopes_sent
end

#billing_period_start_date ⇒ Object

Reserved: TBD



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

def billing_period_start_date
  @billing_period_start_date
end

#billing_profile ⇒ Object

Reserved: TBD



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

def billing_profile
  @billing_profile
end

#can_cancel_renewal ⇒ Object

Reserved: TBD



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

def can_cancel_renewal
  @can_cancel_renewal
end

#can_upgrade ⇒ Object

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

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

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

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

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

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

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

#envelope_sending_blocked ⇒ Object

Returns the value of attribute envelope_sending_blocked.



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

def envelope_sending_blocked
  @envelope_sending_blocked
end

#envelope_unit_price ⇒ Object

Returns the value of attribute envelope_unit_price.



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

def envelope_unit_price
  @envelope_unit_price
end

#forgotten_password_questions_count ⇒ Object

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



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

def forgotten_password_questions_count
  @forgotten_password_questions_count
end

#is_downgrade ⇒ Object

Returns the value of attribute is_downgrade.



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

def is_downgrade
  @is_downgrade
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



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

def payment_method
  @payment_method
end

#plan_classification ⇒ Object

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



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

def plan_classification
  @plan_classification
end

#plan_end_date ⇒ Object

The date that the current plan will end.



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

def plan_end_date
  @plan_end_date
end

#plan_name ⇒ Object

The name of the Billing Plan.



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

def plan_name
  @plan_name
end

#plan_start_date ⇒ Object

The date that the Account started using the current plan.



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

def plan_start_date
  @plan_start_date
end

#seats_allowed ⇒ Object

Returns the value of attribute seats_allowed.



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

def seats_allowed
  @seats_allowed
end

#seats_in_use ⇒ Object

Returns the value of attribute seats_in_use.



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

def seats_in_use
  @seats_in_use
end

#status21_cfr_part11 ⇒ Object

Returns the value of attribute status21_cfr_part11.



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

def status21_cfr_part11
  @status21_cfr_part11
end

#suspension_date ⇒ Object

Returns the value of attribute suspension_date.



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

def suspension_date
  @suspension_date
end

#suspension_status ⇒ Object

Returns the value of attribute suspension_status.



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

def suspension_status
  @suspension_status
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
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
 
# File 'lib/docusign_esign/models/account_information.rb', line 112

def self.attribute_map
  {
    :'account_id_guid' => :'accountIdGuid',
    :'account_name' => :'accountName',
    :'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_cancel_renewal' => :'canCancelRenewal',
    :'can_upgrade' => :'canUpgrade',
    :'connect_permission' => :'connectPermission',
    :'created_date' => :'createdDate',
    :'currency_code' => :'currencyCode',
    :'current_plan_id' => :'currentPlanId',
    :'distributor_code' => :'distributorCode',
    :'docu_sign_landing_url' => :'docuSignLandingUrl',
    :'envelope_sending_blocked' => :'envelopeSendingBlocked',
    :'envelope_unit_price' => :'envelopeUnitPrice',
    :'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',
    :'seats_allowed' => :'seatsAllowed',
    :'seats_in_use' => :'seatsInUse',
    :'status21_cfr_part11' => :'status21CFRPart11',
    :'suspension_date' => :'suspensionDate',
    :'suspension_status' => :'suspensionStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'account_id_guid' => :'String',
    :'account_name' => :'String',
    :'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_cancel_renewal' => :'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',
    :'envelope_sending_blocked' => :'String',
    :'envelope_unit_price' => :'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',
    :'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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/docusign_esign/models/account_information.rb', line 334

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == 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_cancel_renewal == o.can_cancel_renewal &&
      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 &&
      envelope_sending_blocked == o.envelope_sending_blocked &&
      envelope_unit_price == o.envelope_unit_price &&
      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 &&
      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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/docusign_esign/models/account_information.rb', line 406

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



472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/docusign_esign/models/account_information.rb', line 472

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



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 385

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


372
373
374
 
# File 'lib/docusign_esign/models/account_information.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



378
379
380
 
# File 'lib/docusign_esign/models/account_information.rb', line 378

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_cancel_renewal, can_upgrade, connect_permission, created_date, currency_code, current_plan_id, distributor_code, docu_sign_landing_url, envelope_sending_blocked, envelope_unit_price, forgotten_password_questions_count, is_downgrade, payment_method, plan_classification, plan_end_date, plan_name, plan_start_date, seats_allowed, seats_in_use, status21_cfr_part11, suspension_date, suspension_status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



321
322
323
324
 
# File 'lib/docusign_esign/models/account_information.rb', line 321

def list_invalid_properties
  invalid_properties = Array.new
  return 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



452
453
454
 
# File 'lib/docusign_esign/models/account_information.rb', line 452

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



458
459
460
461
462
463
464
465
466
 
# File 'lib/docusign_esign/models/account_information.rb', line 458

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



446
447
448
 
# File 'lib/docusign_esign/models/account_information.rb', line 446

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



328
329
330
 
# File 'lib/docusign_esign/models/account_information.rb', line 328

def valid?
  return true
end