Class: YousignClient::UserOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/models/user_output.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/yousign_client/models/user_output.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



60
61
62
 
# File 'lib/yousign_client/models/user_output.rb', line 60

def config
  @config
end

#created_at ⇒ Object

Created date of the object



49
50
51
 
# File 'lib/yousign_client/models/user_output.rb', line 49

def created_at
  @created_at
end

#default_sign_image ⇒ Object

ID of the default sign image.



69
70
71
 
# File 'lib/yousign_client/models/user_output.rb', line 69

def default_sign_image
  @default_sign_image
end

#deleted ⇒ Object

Defines if the User is deleted or not



55
56
57
 
# File 'lib/yousign_client/models/user_output.rb', line 55

def deleted
  @deleted
end

#deleted_at ⇒ Object

Defines the date where the user has been deleted



58
59
60
 
# File 'lib/yousign_client/models/user_output.rb', line 58

def deleted_at
  @deleted_at
end

#email ⇒ Object

User’s email address



27
28
29
 
# File 'lib/yousign_client/models/user_output.rb', line 27

def email
  @email
end

#fast_sign ⇒ Object

Defines if the fast signature is available for the user on the Yousign application



74
75
76
 
# File 'lib/yousign_client/models/user_output.rb', line 74

def fast_sign
  @fast_sign
end

#firstname ⇒ Object

User’s firstname



21
22
23
 
# File 'lib/yousign_client/models/user_output.rb', line 21

def firstname
  @firstname
end

#full_name ⇒ Object

User’s full name



77
78
79
 
# File 'lib/yousign_client/models/user_output.rb', line 77

def full_name
  @full_name
end

#group ⇒ Object

Returns the value of attribute group.



46
47
48
 
# File 'lib/yousign_client/models/user_output.rb', line 46

def group
  @group
end

#id ⇒ Object

Object’s ID



18
19
20
 
# File 'lib/yousign_client/models/user_output.rb', line 18

def id
  @id
end

#inwebo_user_request ⇒ Object

Internal usage, should not be used



63
64
65
 
# File 'lib/yousign_client/models/user_output.rb', line 63

def inwebo_user_request
  @inwebo_user_request
end

#lastname ⇒ Object

User’s lastname



24
25
26
 
# File 'lib/yousign_client/models/user_output.rb', line 24

def lastname
  @lastname
end

#notifications ⇒ Object

Returns the value of attribute notifications.



71
72
73
 
# File 'lib/yousign_client/models/user_output.rb', line 71

def notifications
  @notifications
end

#organization ⇒ Object

ID of the organization the user belongs to



39
40
41
 
# File 'lib/yousign_client/models/user_output.rb', line 39

def organization
  @organization
end

#permission ⇒ Object

Returns the value of attribute permission.



44
45
46
 
# File 'lib/yousign_client/models/user_output.rb', line 44

def permission
  @permission
end

#phone ⇒ Object

User’s phone number (mobiles and landline telephones are supported). Phone number must be formatted to E164 (en.wikipedia.org/wiki/E.164) which includes the symbol ‘+’ and the country code. For example : +33612131315. All countries are supported.



33
34
35
 
# File 'lib/yousign_client/models/user_output.rb', line 33

def phone
  @phone
end

#saml_name_id ⇒ Object

ID of SAML



66
67
68
 
# File 'lib/yousign_client/models/user_output.rb', line 66

def saml_name_id
  @saml_name_id
end

#status ⇒ Object

User’s status



36
37
38
 
# File 'lib/yousign_client/models/user_output.rb', line 36

def status
  @status
end

#title ⇒ Object

User’s title



30
31
32
 
# File 'lib/yousign_client/models/user_output.rb', line 30

def title
  @title
end

#updated_at ⇒ Object

Updated date of the object



52
53
54
 
# File 'lib/yousign_client/models/user_output.rb', line 52

def updated_at
  @updated_at
end

#workspaces ⇒ Object

List of workspaces to which the user is connected and has access



42
43
44
 
# File 'lib/yousign_client/models/user_output.rb', line 42

def workspaces
  @workspaces
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/yousign_client/models/user_output.rb', line 102

def self.attribute_map
  {
    :'id' => :'id',
    :'firstname' => :'firstname',
    :'lastname' => :'lastname',
    :'email' => :'email',
    :'title' => :'title',
    :'phone' => :'phone',
    :'status' => :'status',
    :'organization' => :'organization',
    :'workspaces' => :'workspaces',
    :'permission' => :'permission',
    :'group' => :'group',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'deleted' => :'deleted',
    :'deleted_at' => :'deletedAt',
    :'config' => :'config',
    :'inwebo_user_request' => :'inweboUserRequest',
    :'saml_name_id' => :'samlNameId',
    :'default_sign_image' => :'defaultSignImage',
    :'notifications' => :'notifications',
    :'fast_sign' => :'fastSign',
    :'full_name' => :'fullName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/yousign_client/models/user_output.rb', line 130

def self.swagger_types
  {
    :'id' => :'String',
    :'firstname' => :'String',
    :'lastname' => :'String',
    :'email' => :'String',
    :'title' => :'String',
    :'phone' => :'String',
    :'status' => :'String',
    :'organization' => :'String',
    :'workspaces' => :'Array<UserWorkspaceOutput>',
    :'permission' => :'String',
    :'group' => :'UserGroup',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'deleted' => :'BOOLEAN',
    :'deleted_at' => :'DateTime',
    :'config' => :'Object',
    :'inwebo_user_request' => :'String',
    :'saml_name_id' => :'String',
    :'default_sign_image' => :'String',
    :'notifications' => :'UserOutputNotifications',
    :'fast_sign' => :'BOOLEAN',
    :'full_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/yousign_client/models/user_output.rb', line 298

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      firstname == o.firstname &&
      lastname == o.lastname &&
      email == o.email &&
      title == o.title &&
      phone == o.phone &&
      status == o.status &&
      organization == o.organization &&
      workspaces == o.workspaces &&
      permission == o.permission &&
      group == o.group &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      deleted == o.deleted &&
      deleted_at == o.deleted_at &&
      config == o.config &&
      inwebo_user_request == o.inwebo_user_request &&
      saml_name_id == o.saml_name_id &&
      default_sign_image == o.default_sign_image &&
      notifications == o.notifications &&
      fast_sign == o.fast_sign &&
      full_name == o.full_name
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



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
 
# File 'lib/yousign_client/models/user_output.rb', line 361

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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/yousign_client/models/user_output.rb', line 427

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/yousign_client/models/user_output.rb', line 340

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


327
328
329
 
# File 'lib/yousign_client/models/user_output.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



333
334
335
 
# File 'lib/yousign_client/models/user_output.rb', line 333

def hash
  [id, firstname, lastname, email, title, phone, status, organization, workspaces, permission, group, created_at, updated_at, deleted, deleted_at, config, inwebo_user_request, saml_name_id, default_sign_image, notifications, fast_sign, full_name].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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/yousign_client/models/user_output.rb', line 258

def list_invalid_properties
  invalid_properties = Array.new
  if @firstname.nil?
    invalid_properties.push('invalid value for "firstname", firstname cannot be nil.')
  end

  if @lastname.nil?
    invalid_properties.push('invalid value for "lastname", lastname cannot be nil.')
  end

  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  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



407
408
409
 
# File 'lib/yousign_client/models/user_output.rb', line 407

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



413
414
415
416
417
418
419
420
421
 
# File 'lib/yousign_client/models/user_output.rb', line 413

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



401
402
403
 
# File 'lib/yousign_client/models/user_output.rb', line 401

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



277
278
279
280
281
282
283
284
 
# File 'lib/yousign_client/models/user_output.rb', line 277

def valid?
  return false if @firstname.nil?
  return false if @lastname.nil?
  return false if @email.nil?
  status_validator = EnumAttributeValidator.new('String', ['not_activated', 'activated'])
  return false unless status_validator.valid?(@status)
  true
end