Class: PureCloud::ScimV2CreateUser

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/scim_v2_create_user.rb

Overview

Defines the creation of a SCIM user.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScimV2CreateUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 129

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User')
    
    
    self.urnietfparamsscimschemasextensionenterprise2_0_user = attributes[:'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User']
    
  
  end

  
  if attributes.has_key?(:'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User')
    
    
    self.urnietfparamsscimschemasextensiongenesyspurecloud2_0_user = attributes[:'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User']
    
  
  end

  
end

Instance Attribute Details

#active ⇒ Object

Indicates whether the user’s administrative status is active.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 26

def active
  @active
end

#display_name ⇒ Object

The display name of the user.



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 32

def display_name
  @display_name
end

#emails ⇒ Object

The list of the user’s email addresses.



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 44

def emails
  @emails
end

#external_id ⇒ Object

The external ID of the user. Set by the provisioning client. "caseExact" is set to "true". "mutability" is set to "readWrite".



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 47

def external_id
  @external_id
end

#groups ⇒ Object

The list of groups that the user is a member of.



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 50

def groups
  @groups
end

#password ⇒ Object

The new password for the Genesys Cloud user. Does not return an existing password.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 35

def password
  @password
end

#phone_numbers ⇒ Object

The list of the user’s phone numbers.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 41

def phone_numbers
  @phone_numbers
end

#roles ⇒ Object

The list of roles assigned to the user.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 53

def roles
  @roles
end

#schemas ⇒ Object

The list of supported schemas.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 23

def schemas
  @schemas
end

#title ⇒ Object

The user’s title.



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 38

def title
  @title
end

#urnietfparamsscimschemasextensionenterprise2_0_user ⇒ Object

The URI of the schema for the enterprise user.



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 56

def urnietfparamsscimschemasextensionenterprise2_0_user
  @urnietfparamsscimschemasextensionenterprise2_0_user
end

#urnietfparamsscimschemasextensiongenesyspurecloud2_0_user ⇒ Object

The URI of the schema for the Genesys Cloud user.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 59

def urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
  @urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
end

#user_name ⇒ Object

The user’s Genesys Cloud email address. Must be unique.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 29

def user_name
  @user_name
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 62

def self.attribute_map
  {
    
    :'schemas' => :'schemas',
    
    :'active' => :'active',
    
    :'user_name' => :'userName',
    
    :'display_name' => :'displayName',
    
    :'password' => :'password',
    
    :'title' => :'title',
    
    :'phone_numbers' => :'phoneNumbers',
    
    :'emails' => :'emails',
    
    :'external_id' => :'externalId',
    
    :'groups' => :'groups',
    
    :'roles' => :'roles',
    
    :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User',
    
    :'urnietfparamsscimschemasextensiongenesyspurecloud2_0_user' => :'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
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
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 95

def self.swagger_types
  {
    
    :'schemas' => :'Array<String>',
    
    :'active' => :'BOOLEAN',
    
    :'user_name' => :'String',
    
    :'display_name' => :'String',
    
    :'password' => :'String',
    
    :'title' => :'String',
    
    :'phone_numbers' => :'Array<ScimPhoneNumber>',
    
    :'emails' => :'Array<ScimEmail>',
    
    :'external_id' => :'String',
    
    :'groups' => :'Array<ScimV2GroupReference>',
    
    :'roles' => :'Array<ScimUserRole>',
    
    :'urnietfparamsscimschemasextensionenterprise2_0_user' => :'ScimV2EnterpriseUser',
    
    :'urnietfparamsscimschemasextensiongenesyspurecloud2_0_user' => :'ScimUserExtensions'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 410

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      schemas == o.schemas &&
      active == o.active &&
      user_name == o.user_name &&
      display_name == o.display_name &&
      password == o.password &&
      title == o.title &&
      phone_numbers == o.phone_numbers &&
      emails == o.emails &&
      external_id == o.external_id &&
      groups == o.groups &&
      roles == o.roles &&
      urnietfparamsscimschemasextensionenterprise2_0_user == o.urnietfparamsscimschemasextensionenterprise2_0_user &&
      urnietfparamsscimschemasextensiongenesyspurecloud2_0_user == o.urnietfparamsscimschemasextensiongenesyspurecloud2_0_user
end

#_deserialize(type, value) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 460

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 520

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

build the object from hash



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 441

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


430
431
432
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 430

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



436
437
438
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 436

def hash
  [schemas, active, user_name, display_name, password, title, phone_numbers, emails, external_id, groups, roles, urnietfparamsscimschemasextensionenterprise2_0_user, urnietfparamsscimschemasextensiongenesyspurecloud2_0_user].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



267
268
269
270
271
272
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 267

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



503
504
505
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 503

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



508
509
510
511
512
513
514
515
516
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 508

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



498
499
500
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 498

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



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
 
# File 'lib/purecloudplatformclientv2/models/scim_v2_create_user.rb', line 276

def valid?
  
  
  
  
  
  
  
  
  
  
  if @user_name.nil?
    return false
  end

  
  
  
  
  
  if @display_name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end