Class: DocuSign_eSign::UserInformation

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

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



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

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

  if attributes.has_key?(:'activationAccessCode')
    self.activation_access_code = attributes[:'activationAccessCode']
  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?(:'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?(:'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?(:'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?(:'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?(:'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')
    if (value = attributes[:'userSettings']).is_a?(Array)
      self. = value
    end
  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

#account_management_granularObject

Returns the value of attribute account_management_granular.



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

def 
  @account_management_granular
end

#activation_access_codeObject

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



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

def activation_access_code
  @activation_access_code
end

#country_codeObject

Returns the value of attribute country_code.



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

def country_code
  @country_code
end

#created_date_timeObject

Indicates the date and time the item was created.



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

def created_date_time
  @created_date_time
end

#custom_settingsObject

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



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

def custom_settings
  @custom_settings
end

#emailObject

Returns the value of attribute email.



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

def email
  @email
end

#enable_connect_for_userObject

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



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

def enable_connect_for_user
  @enable_connect_for_user
end

#error_detailsObject

Returns the value of attribute error_details.



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

def error_details
  @error_details
end

#first_nameObject

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



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

def first_name
  @first_name
end

#forgotten_password_infoObject

Returns the value of attribute forgotten_password_info.



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

def forgotten_password_info
  @forgotten_password_info
end

#group_listObject

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.



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

def group_list
  @group_list
end

#home_addressObject

Returns the value of attribute home_address.



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

def home_address
  @home_address
end

#initials_image_uriObject

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



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

def initials_image_uri
  @initials_image_uri
end

#is_adminObject

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



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

def is_admin
  @is_admin
end

#job_titleObject

Returns the value of attribute job_title.



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

def job_title
  @job_title
end

#last_loginObject

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



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

def 
  @last_login
end

#last_nameObject

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



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

def last_name
  @last_name
end

#login_statusObject

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



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

def 
  @login_status
end

#middle_nameObject

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



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

def middle_name
  @middle_name
end

#passwordObject

Returns the value of attribute password.



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

def password
  @password
end

#password_expirationObject

Returns the value of attribute password_expiration.



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

def password_expiration
  @password_expiration
end

#permission_profile_idObject

Returns the value of attribute permission_profile_id.



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

def permission_profile_id
  @permission_profile_id
end

#permission_profile_nameObject

Returns the value of attribute permission_profile_name.



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

def permission_profile_name
  @permission_profile_name
end

#profile_image_uriObject

Returns the value of attribute profile_image_uri.



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

def profile_image_uri
  @profile_image_uri
end

#send_activation_emailObject

Returns the value of attribute send_activation_email.



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

def send_activation_email
  @send_activation_email
end

#send_activation_on_invalid_loginObject

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.



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

def 
  @send_activation_on_invalid_login
end

#signature_image_uriObject

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



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

def signature_image_uri
  @signature_image_uri
end

#subscribeObject

Returns the value of attribute subscribe.



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

def subscribe
  @subscribe
end

#suffix_nameObject

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



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

def suffix_name
  @suffix_name
end

#titleObject

The title of the user.



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

def title
  @title
end

#uriObject

Returns the value of attribute uri.



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

def uri
  @uri
end

#user_idObject

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

#user_nameObject

Returns the value of attribute user_name.



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

def user_name
  @user_name
end

#user_profile_last_modified_dateObject

Returns the value of attribute user_profile_last_modified_date.



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

def 
  @user_profile_last_modified_date
end

#user_settingsObject

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.



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

def 
  @user_settings
end

#user_statusObject

Returns the value of attribute user_status.



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

def user_status
  @user_status
end

#user_typeObject

Returns the value of attribute user_type.



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

def user_type
  @user_type
end

#work_addressObject

Returns the value of attribute work_address.



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

def work_address
  @work_address
end

Class Method Details

.attribute_mapObject

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



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
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/docusign_esign/models/user_information.rb', line 128

def self.attribute_map
  {
    :'account_management_granular' => :'accountManagementGranular',
    :'activation_access_code' => :'activationAccessCode',
    :'country_code' => :'countryCode',
    :'created_date_time' => :'createdDateTime',
    :'custom_settings' => :'customSettings',
    :'email' => :'email',
    :'enable_connect_for_user' => :'enableConnectForUser',
    :'error_details' => :'errorDetails',
    :'first_name' => :'firstName',
    :'forgotten_password_info' => :'forgottenPasswordInfo',
    :'group_list' => :'groupList',
    :'home_address' => :'homeAddress',
    :'initials_image_uri' => :'initialsImageUri',
    :'is_admin' => :'isAdmin',
    :'job_title' => :'jobTitle',
    :'last_login' => :'lastLogin',
    :'last_name' => :'lastName',
    :'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_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_typesObject

Attribute type mapping.



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 172

def self.swagger_types
  {
    :'account_management_granular' => :'UserAccountManagementGranularInformation',
    :'activation_access_code' => :'String',
    :'country_code' => :'String',
    :'created_date_time' => :'String',
    :'custom_settings' => :'Array<NameValue>',
    :'email' => :'String',
    :'enable_connect_for_user' => :'String',
    :'error_details' => :'ErrorDetails',
    :'first_name' => :'String',
    :'forgotten_password_info' => :'ForgottenPasswordInformation',
    :'group_list' => :'Array<Group>',
    :'home_address' => :'AddressInformationV2',
    :'initials_image_uri' => :'String',
    :'is_admin' => :'String',
    :'job_title' => :'String',
    :'last_login' => :'String',
    :'last_name' => :'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_id' => :'String',
    :'user_name' => :'String',
    :'user_profile_last_modified_date' => :'String',
    :'user_settings' => :'Array<NameValue>',
    :'user_status' => :'String',
    :'user_type' => :'String',
    :'work_address' => :'AddressInformationV2'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      activation_access_code == o.activation_access_code &&
      country_code == o.country_code &&
      created_date_time == o.created_date_time &&
      custom_settings == o.custom_settings &&
      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 &&
      home_address == o.home_address &&
      initials_image_uri == o.initials_image_uri &&
      is_admin == o.is_admin &&
      job_title == o.job_title &&
       == o. &&
      last_name == o.last_name &&
       == 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 &&
      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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'lib/docusign_esign/models/user_information.rb', line 477

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



543
544
545
546
547
548
549
550
551
552
553
554
555
# File 'lib/docusign_esign/models/user_information.rb', line 543

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



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
# File 'lib/docusign_esign/models/user_information.rb', line 456

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


443
444
445
# File 'lib/docusign_esign/models/user_information.rb', line 443

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



449
450
451
# File 'lib/docusign_esign/models/user_information.rb', line 449

def hash
  [, activation_access_code, country_code, created_date_time, custom_settings, email, enable_connect_for_user, error_details, first_name, forgotten_password_info, group_list, home_address, initials_image_uri, is_admin, job_title, , last_name, , 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_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



385
386
387
388
# File 'lib/docusign_esign/models/user_information.rb', line 385

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



523
524
525
# File 'lib/docusign_esign/models/user_information.rb', line 523

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



529
530
531
532
533
534
535
536
537
# File 'lib/docusign_esign/models/user_information.rb', line 529

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



517
518
519
# File 'lib/docusign_esign/models/user_information.rb', line 517

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



392
393
394
# File 'lib/docusign_esign/models/user_information.rb', line 392

def valid?
  return true
end