Class: DocuSign_eSign::UserAccountManagementGranularInformation

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

Overview

Describes which account management capabilities a user has.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserAccountManagementGranularInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#can_manage_account_security_settingsObject

Returns the value of attribute can_manage_account_security_settings.



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

def 
  @can_manage_account_security_settings
end

#can_manage_account_security_settings_metadataObject

Returns the value of attribute can_manage_account_security_settings_metadata.



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

def 
  @can_manage_account_security_settings_metadata
end

#can_manage_account_settingsObject

Returns the value of attribute can_manage_account_settings.



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

def 
  @can_manage_account_settings
end

#can_manage_account_settings_metadataObject

Returns the value of attribute can_manage_account_settings_metadata.



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

def 
  @can_manage_account_settings_metadata
end

#can_manage_adminsObject

Returns the value of attribute can_manage_admins.



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

def can_manage_admins
  @can_manage_admins
end

#can_manage_admins_metadataObject

Metadata that indicates whether the ‘canManageAdmins` property is editable.



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

def 
  @can_manage_admins_metadata
end

#can_manage_connectObject

Returns the value of attribute can_manage_connect.



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

def can_manage_connect
  @can_manage_connect
end

#can_manage_connect_metadataObject

Returns the value of attribute can_manage_connect_metadata.



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

def 
  @can_manage_connect_metadata
end

#can_manage_document_retentionObject

Returns the value of attribute can_manage_document_retention.



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

def can_manage_document_retention
  @can_manage_document_retention
end

#can_manage_document_retention_metadataObject

Returns the value of attribute can_manage_document_retention_metadata.



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

def 
  @can_manage_document_retention_metadata
end

#can_manage_envelope_transferObject

Returns the value of attribute can_manage_envelope_transfer.



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

def can_manage_envelope_transfer
  @can_manage_envelope_transfer
end

#can_manage_envelope_transfer_metadataObject

Returns the value of attribute can_manage_envelope_transfer_metadata.



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

def 
  @can_manage_envelope_transfer_metadata
end

#can_manage_groups_but_not_usersObject

Returns the value of attribute can_manage_groups_but_not_users.



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

def can_manage_groups_but_not_users
  @can_manage_groups_but_not_users
end

#can_manage_groups_but_not_users_metadataObject

Returns the value of attribute can_manage_groups_but_not_users_metadata.



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

def 
  @can_manage_groups_but_not_users_metadata
end

#can_manage_joint_agreementsObject

Returns the value of attribute can_manage_joint_agreements.



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

def can_manage_joint_agreements
  @can_manage_joint_agreements
end

#can_manage_joint_agreements_metadataObject

Returns the value of attribute can_manage_joint_agreements_metadata.



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

def 
  @can_manage_joint_agreements_metadata
end

#can_manage_reportingObject

Returns the value of attribute can_manage_reporting.



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

def can_manage_reporting
  @can_manage_reporting
end

#can_manage_reporting_metadataObject

Returns the value of attribute can_manage_reporting_metadata.



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

def 
  @can_manage_reporting_metadata
end

#can_manage_sharingObject

Returns the value of attribute can_manage_sharing.



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

def can_manage_sharing
  @can_manage_sharing
end

#can_manage_sharing_metadataObject

Metadata that indicates whether the ‘canManageSharing` property is editable.



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

def 
  @can_manage_sharing_metadata
end

#can_manage_signing_groupsObject

Returns the value of attribute can_manage_signing_groups.



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

def can_manage_signing_groups
  @can_manage_signing_groups
end

#can_manage_signing_groups_metadataObject

Returns the value of attribute can_manage_signing_groups_metadata.



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

def 
  @can_manage_signing_groups_metadata
end

#can_manage_stampsObject

Returns the value of attribute can_manage_stamps.



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

def can_manage_stamps
  @can_manage_stamps
end

#can_manage_stamps_metadataObject

Returns the value of attribute can_manage_stamps_metadata.



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

def 
  @can_manage_stamps_metadata
end

#can_manage_usersObject

Returns the value of attribute can_manage_users.



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

def can_manage_users
  @can_manage_users
end

#can_manage_users_metadataObject

Metadata that indicates whether the ‘canManageUsers` property is editable.



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

def 
  @can_manage_users_metadata
end

#can_view_usersObject

Returns the value of attribute can_view_users.



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

def can_view_users
  @can_view_users
end

Class Method Details

.attribute_mapObject

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 99

def self.attribute_map
  {
    :'can_manage_account_security_settings' => :'canManageAccountSecuritySettings',
    :'can_manage_account_security_settings_metadata' => :'canManageAccountSecuritySettingsMetadata',
    :'can_manage_account_settings' => :'canManageAccountSettings',
    :'can_manage_account_settings_metadata' => :'canManageAccountSettingsMetadata',
    :'can_manage_admins' => :'canManageAdmins',
    :'can_manage_admins_metadata' => :'canManageAdminsMetadata',
    :'can_manage_connect' => :'canManageConnect',
    :'can_manage_connect_metadata' => :'canManageConnectMetadata',
    :'can_manage_document_retention' => :'canManageDocumentRetention',
    :'can_manage_document_retention_metadata' => :'canManageDocumentRetentionMetadata',
    :'can_manage_envelope_transfer' => :'canManageEnvelopeTransfer',
    :'can_manage_envelope_transfer_metadata' => :'canManageEnvelopeTransferMetadata',
    :'can_manage_groups_but_not_users' => :'canManageGroupsButNotUsers',
    :'can_manage_groups_but_not_users_metadata' => :'canManageGroupsButNotUsersMetadata',
    :'can_manage_joint_agreements' => :'canManageJointAgreements',
    :'can_manage_joint_agreements_metadata' => :'canManageJointAgreementsMetadata',
    :'can_manage_reporting' => :'canManageReporting',
    :'can_manage_reporting_metadata' => :'canManageReportingMetadata',
    :'can_manage_sharing' => :'canManageSharing',
    :'can_manage_sharing_metadata' => :'canManageSharingMetadata',
    :'can_manage_signing_groups' => :'canManageSigningGroups',
    :'can_manage_signing_groups_metadata' => :'canManageSigningGroupsMetadata',
    :'can_manage_stamps' => :'canManageStamps',
    :'can_manage_stamps_metadata' => :'canManageStampsMetadata',
    :'can_manage_users' => :'canManageUsers',
    :'can_manage_users_metadata' => :'canManageUsersMetadata',
    :'can_view_users' => :'canViewUsers'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'can_manage_account_security_settings' => :'String',
    :'can_manage_account_security_settings_metadata' => :'SettingsMetadata',
    :'can_manage_account_settings' => :'String',
    :'can_manage_account_settings_metadata' => :'SettingsMetadata',
    :'can_manage_admins' => :'String',
    :'can_manage_admins_metadata' => :'SettingsMetadata',
    :'can_manage_connect' => :'String',
    :'can_manage_connect_metadata' => :'SettingsMetadata',
    :'can_manage_document_retention' => :'String',
    :'can_manage_document_retention_metadata' => :'SettingsMetadata',
    :'can_manage_envelope_transfer' => :'String',
    :'can_manage_envelope_transfer_metadata' => :'SettingsMetadata',
    :'can_manage_groups_but_not_users' => :'String',
    :'can_manage_groups_but_not_users_metadata' => :'SettingsMetadata',
    :'can_manage_joint_agreements' => :'String',
    :'can_manage_joint_agreements_metadata' => :'SettingsMetadata',
    :'can_manage_reporting' => :'String',
    :'can_manage_reporting_metadata' => :'SettingsMetadata',
    :'can_manage_sharing' => :'String',
    :'can_manage_sharing_metadata' => :'SettingsMetadata',
    :'can_manage_signing_groups' => :'String',
    :'can_manage_signing_groups_metadata' => :'SettingsMetadata',
    :'can_manage_stamps' => :'String',
    :'can_manage_stamps_metadata' => :'SettingsMetadata',
    :'can_manage_users' => :'String',
    :'can_manage_users_metadata' => :'SettingsMetadata',
    :'can_view_users' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      can_manage_admins == o.can_manage_admins &&
       == o. &&
      can_manage_connect == o.can_manage_connect &&
       == o. &&
      can_manage_document_retention == o.can_manage_document_retention &&
       == o. &&
      can_manage_envelope_transfer == o.can_manage_envelope_transfer &&
       == o. &&
      can_manage_groups_but_not_users == o.can_manage_groups_but_not_users &&
       == o. &&
      can_manage_joint_agreements == o.can_manage_joint_agreements &&
       == o. &&
      can_manage_reporting == o.can_manage_reporting &&
       == o. &&
      can_manage_sharing == o.can_manage_sharing &&
       == o. &&
      can_manage_signing_groups == o.can_manage_signing_groups &&
       == o. &&
      can_manage_stamps == o.can_manage_stamps &&
       == o. &&
      can_manage_users == o.can_manage_users &&
       == o. &&
      can_view_users == o.can_view_users
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



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/user_account_management_granular_information.rb', line 364

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



430
431
432
433
434
435
436
437
438
439
440
441
442
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 430

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 343

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


330
331
332
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 330

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



336
337
338
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 336

def hash
  [, , , , can_manage_admins, , can_manage_connect, , can_manage_document_retention, , can_manage_envelope_transfer, , can_manage_groups_but_not_users, , can_manage_joint_agreements, , can_manage_reporting, , can_manage_sharing, , can_manage_signing_groups, , can_manage_stamps, , can_manage_users, , can_view_users].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



283
284
285
286
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 283

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



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

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



416
417
418
419
420
421
422
423
424
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 416

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



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

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



290
291
292
# File 'lib/docusign_esign/models/user_account_management_granular_information.rb', line 290

def valid?
  true
end