Class: DocuSign_eSign::UserInformation

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

Overview

User information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
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
401
402
403
404
405
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
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/user_information.rb', line 271

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#activation_access_code ⇒ Object

The activation code the new user must enter when activating their account.



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

def activation_access_code
  @activation_access_code
end

#company ⇒ Object

Returns the value of attribute company.



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

def company
  @company
end

#connect_configurations ⇒ Object

Returns the value of attribute connect_configurations.



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

def connect_configurations
  @connect_configurations
end

#country_code ⇒ Object

Returns the value of attribute country_code.



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

def country_code
  @country_code
end

#created_date_time ⇒ Object

Indicates the date and time the item was created.



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

def created_date_time
  @created_date_time
end

#custom_settings ⇒ Object

The name/value pair information for the user custom setting.



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

def custom_settings
  @custom_settings
end

#default_account_id ⇒ Object

Returns the value of attribute default_account_id.



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

def 
  @default_account_id
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#enable_connect_for_user ⇒ Object

Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.



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

def enable_connect_for_user
  @enable_connect_for_user
end

#error_details ⇒ Object

Array or errors.



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

def error_details
  @error_details
end

#first_name ⇒ Object

The user’s first name. Maximum Length: 50 characters.



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

def first_name
  @first_name
end

#forgotten_password_info ⇒ Object

A complex element containing up to four Question/Answer pairs for forgotten password information.



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

def forgotten_password_info
  @forgotten_password_info
end

#group_list ⇒ Object

A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type.



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

def group_list
  @group_list
end

#has_remote_notary ⇒ Object

Returns the value of attribute has_remote_notary.



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

def has_remote_notary
  @has_remote_notary
end

#home_address ⇒ Object

Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.



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

def home_address
  @home_address
end

#initials_image_uri ⇒ Object

Contains the URI for an endpoint that you can use to retrieve the initials image.



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

def initials_image_uri
  @initials_image_uri
end

#is_admin ⇒ Object

Determines if the feature set is actively set as part of the plan.



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

def is_admin
  @is_admin
end

#is_alternate_admin ⇒ Object

Returns the value of attribute is_alternate_admin.



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

def is_alternate_admin
  @is_alternate_admin
end

#is_managed_by_scim ⇒ Object

Returns the value of attribute is_managed_by_scim.



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

def is_managed_by_scim
  @is_managed_by_scim
end

#is_membership_managed_by_scim ⇒ Object

Returns the value of attribute is_membership_managed_by_scim.



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

def is_membership_managed_by_scim
  @is_membership_managed_by_scim
end

#is_nar_enabled ⇒ Object

Returns the value of attribute is_nar_enabled.



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

def is_nar_enabled
  @is_nar_enabled
end

#job_title ⇒ Object

Returns the value of attribute job_title.



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

def job_title
  @job_title
end

#last_login ⇒ Object

Shows the date-time when the user last logged on to the system.



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

def 
  @last_login
end

#last_name ⇒ Object

The user’s last name. Maximum Length: 50 characters.



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

def last_name
  @last_name
end

#license_status ⇒ Object

Returns the value of attribute license_status.



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

def license_status
  @license_status
end

#license_type ⇒ Object

Returns the value of attribute license_type.



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

def license_type
  @license_type
end

#login_status ⇒ Object

Shows the current status of the user’s password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed



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

def 
  @login_status
end

#middle_name ⇒ Object

The user’s middle name. Maximum Length: 50 characters.



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

def middle_name
  @middle_name
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#password_expiration ⇒ Object

Returns the value of attribute password_expiration.



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

def password_expiration
  @password_expiration
end

#permission_profile_id ⇒ Object

Returns the value of attribute permission_profile_id.



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

def permission_profile_id
  @permission_profile_id
end

#permission_profile_name ⇒ Object

Returns the value of attribute permission_profile_name.



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

def permission_profile_name
  @permission_profile_name
end

#profile_image_uri ⇒ Object

Returns the value of attribute profile_image_uri.



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

def profile_image_uri
  @profile_image_uri
end

#send_activation_email ⇒ Object

Returns the value of attribute send_activation_email.



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

def send_activation_email
  @send_activation_email
end

#send_activation_on_invalid_login ⇒ Object

When set to true, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.



120
121
122
 
# File 'lib/docusign_esign/models/user_information.rb', line 120

def 
  @send_activation_on_invalid_login
end

#signature_image_uri ⇒ Object

Contains the URI for an endpoint that you can use to retrieve the signature image.



123
124
125
 
# File 'lib/docusign_esign/models/user_information.rb', line 123

def signature_image_uri
  @signature_image_uri
end

#subscribe ⇒ Object

Returns the value of attribute subscribe.



126
127
128
 
# File 'lib/docusign_esign/models/user_information.rb', line 126

def subscribe
  @subscribe
end

#suffix_name ⇒ Object

The suffix for the user’s name. Maximum Length: 50 characters.



129
130
131
 
# File 'lib/docusign_esign/models/user_information.rb', line 129

def suffix_name
  @suffix_name
end

#title ⇒ Object

The title of the user.



132
133
134
 
# File 'lib/docusign_esign/models/user_information.rb', line 132

def title
  @title
end

#uri ⇒ Object

Returns the value of attribute uri.



135
136
137
 
# File 'lib/docusign_esign/models/user_information.rb', line 135

def uri
  @uri
end

#user_added_to_account_date_time ⇒ Object

Returns the value of attribute user_added_to_account_date_time.



138
139
140
 
# File 'lib/docusign_esign/models/user_information.rb', line 138

def 
  @user_added_to_account_date_time
end

#user_id ⇒ Object

Returns the value of attribute user_id.



141
142
143
 
# File 'lib/docusign_esign/models/user_information.rb', line 141

def user_id
  @user_id
end

#user_name ⇒ Object

Returns the value of attribute user_name.



144
145
146
 
# File 'lib/docusign_esign/models/user_information.rb', line 144

def user_name
  @user_name
end

#user_profile_last_modified_date ⇒ Object

Returns the value of attribute user_profile_last_modified_date.



147
148
149
 
# File 'lib/docusign_esign/models/user_information.rb', line 147

def 
  @user_profile_last_modified_date
end

#user_settings ⇒ Object

The name/value pair information for user settings. These determine the actions that a user can take in the account. The ‘[ML:userSettings]` are listed and described below.



150
151
152
 
# File 'lib/docusign_esign/models/user_information.rb', line 150

def 
  @user_settings
end

#user_status ⇒ Object

Returns the value of attribute user_status.



153
154
155
 
# File 'lib/docusign_esign/models/user_information.rb', line 153

def user_status
  @user_status
end

#user_type ⇒ Object

Returns the value of attribute user_type.



156
157
158
 
# File 'lib/docusign_esign/models/user_information.rb', line 156

def user_type
  @user_type
end

#work_address ⇒ Object

Returns the value of attribute work_address.



159
160
161
 
# File 'lib/docusign_esign/models/user_information.rb', line 159

def work_address
  @work_address
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'activation_access_code' => :'activationAccessCode',
    :'company' => :'company',
    :'connect_configurations' => :'connectConfigurations',
    :'country_code' => :'countryCode',
    :'created_date_time' => :'createdDateTime',
    :'custom_settings' => :'customSettings',
    :'default_account_id' => :'defaultAccountId',
    :'email' => :'email',
    :'enable_connect_for_user' => :'enableConnectForUser',
    :'error_details' => :'errorDetails',
    :'first_name' => :'firstName',
    :'forgotten_password_info' => :'forgottenPasswordInfo',
    :'group_list' => :'groupList',
    :'has_remote_notary' => :'hasRemoteNotary',
    :'home_address' => :'homeAddress',
    :'initials_image_uri' => :'initialsImageUri',
    :'is_admin' => :'isAdmin',
    :'is_alternate_admin' => :'isAlternateAdmin',
    :'is_managed_by_scim' => :'isManagedByScim',
    :'is_membership_managed_by_scim' => :'isMembershipManagedByScim',
    :'is_nar_enabled' => :'isNAREnabled',
    :'job_title' => :'jobTitle',
    :'last_login' => :'lastLogin',
    :'last_name' => :'lastName',
    :'license_status' => :'licenseStatus',
    :'license_type' => :'licenseType',
    :'login_status' => :'loginStatus',
    :'middle_name' => :'middleName',
    :'password' => :'password',
    :'password_expiration' => :'passwordExpiration',
    :'permission_profile_id' => :'permissionProfileId',
    :'permission_profile_name' => :'permissionProfileName',
    :'profile_image_uri' => :'profileImageUri',
    :'send_activation_email' => :'sendActivationEmail',
    :'send_activation_on_invalid_login' => :'sendActivationOnInvalidLogin',
    :'signature_image_uri' => :'signatureImageUri',
    :'subscribe' => :'subscribe',
    :'suffix_name' => :'suffixName',
    :'title' => :'title',
    :'uri' => :'uri',
    :'user_added_to_account_date_time' => :'userAddedToAccountDateTime',
    :'user_id' => :'userId',
    :'user_name' => :'userName',
    :'user_profile_last_modified_date' => :'userProfileLastModifiedDate',
    :'user_settings' => :'userSettings',
    :'user_status' => :'userStatus',
    :'user_type' => :'userType',
    :'work_address' => :'workAddress'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'activation_access_code' => :'String',
    :'company' => :'String',
    :'connect_configurations' => :'Array<ConnectUserObject>',
    :'country_code' => :'String',
    :'created_date_time' => :'String',
    :'custom_settings' => :'Array<NameValue>',
    :'default_account_id' => :'String',
    :'email' => :'String',
    :'enable_connect_for_user' => :'String',
    :'error_details' => :'ErrorDetails',
    :'first_name' => :'String',
    :'forgotten_password_info' => :'ForgottenPasswordInformation',
    :'group_list' => :'Array<Group>',
    :'has_remote_notary' => :'BOOLEAN',
    :'home_address' => :'AddressInformation',
    :'initials_image_uri' => :'String',
    :'is_admin' => :'String',
    :'is_alternate_admin' => :'String',
    :'is_managed_by_scim' => :'String',
    :'is_membership_managed_by_scim' => :'String',
    :'is_nar_enabled' => :'String',
    :'job_title' => :'String',
    :'last_login' => :'String',
    :'last_name' => :'String',
    :'license_status' => :'String',
    :'license_type' => :'String',
    :'login_status' => :'String',
    :'middle_name' => :'String',
    :'password' => :'String',
    :'password_expiration' => :'String',
    :'permission_profile_id' => :'String',
    :'permission_profile_name' => :'String',
    :'profile_image_uri' => :'String',
    :'send_activation_email' => :'String',
    :'send_activation_on_invalid_login' => :'String',
    :'signature_image_uri' => :'String',
    :'subscribe' => :'String',
    :'suffix_name' => :'String',
    :'title' => :'String',
    :'uri' => :'String',
    :'user_added_to_account_date_time' => :'String',
    :'user_id' => :'String',
    :'user_name' => :'String',
    :'user_profile_last_modified_date' => :'String',
    :'user_settings' => :'UserSettingsInformation',
    :'user_status' => :'String',
    :'user_type' => :'String',
    :'work_address' => :'AddressInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
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
 
# File 'lib/docusign_esign/models/user_information.rb', line 491

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activation_access_code == o.activation_access_code &&
      company == o.company &&
      connect_configurations == o.connect_configurations &&
      country_code == o.country_code &&
      created_date_time == o.created_date_time &&
      custom_settings == o.custom_settings &&
       == o. &&
      email == o.email &&
      enable_connect_for_user == o.enable_connect_for_user &&
      error_details == o.error_details &&
      first_name == o.first_name &&
      forgotten_password_info == o.forgotten_password_info &&
      group_list == o.group_list &&
      has_remote_notary == o.has_remote_notary &&
      home_address == o.home_address &&
      initials_image_uri == o.initials_image_uri &&
      is_admin == o.is_admin &&
      is_alternate_admin == o.is_alternate_admin &&
      is_managed_by_scim == o.is_managed_by_scim &&
      is_membership_managed_by_scim == o.is_membership_managed_by_scim &&
      is_nar_enabled == o.is_nar_enabled &&
      job_title == o.job_title &&
       == o. &&
      last_name == o.last_name &&
      license_status == o.license_status &&
      license_type == o.license_type &&
       == o. &&
      middle_name == o.middle_name &&
      password == o.password &&
      password_expiration == o.password_expiration &&
      permission_profile_id == o.permission_profile_id &&
      permission_profile_name == o.permission_profile_name &&
      profile_image_uri == o.profile_image_uri &&
      send_activation_email == o.send_activation_email &&
       == o. &&
      signature_image_uri == o.signature_image_uri &&
      subscribe == o.subscribe &&
      suffix_name == o.suffix_name &&
      title == o.title &&
      uri == o.uri &&
       == o. &&
      user_id == o.user_id &&
      user_name == o.user_name &&
       == o. &&
       == o. &&
      user_status == o.user_status &&
      user_type == o.user_type &&
      work_address == o.work_address
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



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/docusign_esign/models/user_information.rb', line 580

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



646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/docusign_esign/models/user_information.rb', line 646

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



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/docusign_esign/models/user_information.rb', line 559

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


546
547
548
 
# File 'lib/docusign_esign/models/user_information.rb', line 546

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



552
553
554
 
# File 'lib/docusign_esign/models/user_information.rb', line 552

def hash
  [activation_access_code, company, connect_configurations, country_code, created_date_time, custom_settings, , email, enable_connect_for_user, error_details, first_name, forgotten_password_info, group_list, has_remote_notary, home_address, initials_image_uri, is_admin, is_alternate_admin, is_managed_by_scim, is_membership_managed_by_scim, is_nar_enabled, job_title, , last_name, license_status, license_type, , middle_name, password, password_expiration, permission_profile_id, permission_profile_name, profile_image_uri, send_activation_email, , signature_image_uri, subscribe, suffix_name, title, uri, , user_id, user_name, , , user_status, user_type, work_address].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



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

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



626
627
628
 
# File 'lib/docusign_esign/models/user_information.rb', line 626

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



632
633
634
635
636
637
638
639
640
 
# File 'lib/docusign_esign/models/user_information.rb', line 632

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



620
621
622
 
# File 'lib/docusign_esign/models/user_information.rb', line 620

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



485
486
487
 
# File 'lib/docusign_esign/models/user_information.rb', line 485

def valid?
  true
end