Class: PureCloud::ScimServiceProviderConfig

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

Overview

Defines a SCIM service provider’s configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScimServiceProviderConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
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
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 108

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#authentication_schemes ⇒ Object

The list of supported authentication schemes.



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

def authentication_schemes
  @authentication_schemes
end

#bulk ⇒ Object

The "bulk" configuration options.



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

def bulk
  @bulk
end

#change_password ⇒ Object

The "changePassword" configuration options.



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

def change_password
  @change_password
end

#documentation_uri ⇒ Object

The HTTP-addressable URL that points to the service provider’s documentation.



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

def documentation_uri
  @documentation_uri
end

#etag ⇒ Object

The "etag" configuration options.



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

def etag
  @etag
end

#filter ⇒ Object

The "filter" configuration options.



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

def filter
  @filter
end

#meta ⇒ Object

The metadata of the SCIM resource.



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

def meta
  @meta
end

#patch ⇒ Object

The "patch" configuration options.



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

def patch
  @patch
end

#schemas ⇒ Object

The list of supported schemas.



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

def schemas
  @schemas
end

#sort ⇒ Object

The "sort" configuration options.



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

def sort
  @sort
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 53

def self.attribute_map
  {
    
    :'schemas' => :'schemas',
    
    :'documentation_uri' => :'documentationUri',
    
    :'patch' => :'patch',
    
    :'filter' => :'filter',
    
    :'etag' => :'etag',
    
    :'sort' => :'sort',
    
    :'bulk' => :'bulk',
    
    :'change_password' => :'changePassword',
    
    :'authentication_schemes' => :'authenticationSchemes',
    
    :'meta' => :'meta'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 80

def self.swagger_types
  {
    
    :'schemas' => :'Array<String>',
    
    :'documentation_uri' => :'String',
    
    :'patch' => :'ScimServiceProviderConfigSimpleFeature',
    
    :'filter' => :'ScimServiceProviderConfigFilterFeature',
    
    :'etag' => :'ScimServiceProviderConfigSimpleFeature',
    
    :'sort' => :'ScimServiceProviderConfigSimpleFeature',
    
    :'bulk' => :'ScimServiceProviderConfigBulkFeature',
    
    :'change_password' => :'ScimServiceProviderConfigSimpleFeature',
    
    :'authentication_schemes' => :'Array<ScimServiceProviderConfigAuthenticationScheme>',
    
    :'meta' => :'ScimMetadata'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      schemas == o.schemas &&
      documentation_uri == o.documentation_uri &&
      patch == o.patch &&
      filter == o.filter &&
      etag == o.etag &&
      sort == o.sort &&
      bulk == o.bulk &&
      change_password == o.change_password &&
      authentication_schemes == o.authentication_schemes &&
      meta == o.meta
end

#_deserialize(type, value) ⇒ Object 



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

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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 426

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 347

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


336
337
338
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 336

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



342
343
344
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 342

def hash
  [schemas, documentation_uri, patch, filter, etag, sort, bulk, change_password, authentication_schemes, meta].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



213
214
215
216
217
218
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 213

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))



409
410
411
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 409

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



414
415
416
417
418
419
420
421
422
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.rb', line 414

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 



404
405
406
 
# File 'lib/purecloudplatformclientv2/models/scim_service_provider_config.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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end