Class: PureCloud::ScimConfigResourceType

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

Overview

Defines a SCIM resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScimConfigResourceType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#description ⇒ Object

The description of the resource type.



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

def description
  @description
end

#endpoint ⇒ Object

The HTTP-addressable endpoint of the resource type. Appears after the base URL.



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

def endpoint
  @endpoint
end

#id ⇒ Object

The ID of the SCIM resource. Set by the service provider. "caseExact" is set to "true". "mutability" is set to "readOnly". "returned" is set to "always".



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

def id
  @id
end

#meta ⇒ Object

The metadata of the SCIM resource. Only location and resourceType are set for ResourceType resources.



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

def meta
  @meta
end

#name ⇒ Object

The name of the resource type.



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

def name
  @name
end

#schema ⇒ Object

The URI of the primary or base schema for the resource type.



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

def schema
  @schema
end

#schema_extensions ⇒ Object

The list of schema extensions for the resource type.



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

def schema_extensions
  @schema_extensions
end

#schemas ⇒ Object

The list of supported schemas.



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

def schemas
  @schemas
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 47

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'schemas' => :'schemas',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'schema' => :'schema',
    
    :'schema_extensions' => :'schemaExtensions',
    
    :'endpoint' => :'endpoint',
    
    :'meta' => :'meta'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 70

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'schemas' => :'Array<String>',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'schema' => :'String',
    
    :'schema_extensions' => :'Array<ScimConfigResourceTypeSchemaExtension>',
    
    :'endpoint' => :'String',
    
    :'meta' => :'ScimMetadata'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 269

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      schemas == o.schemas &&
      name == o.name &&
      description == o.description &&
      schema == o.schema &&
      schema_extensions == o.schema_extensions &&
      endpoint == o.endpoint &&
      meta == o.meta
end

#_deserialize(type, value) ⇒ Object 



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

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 374

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 295

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


284
285
286
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



290
291
292
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 290

def hash
  [id, schemas, name, description, schema, schema_extensions, endpoint, 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



181
182
183
184
185
186
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 181

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



357
358
359
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 357

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



362
363
364
365
366
367
368
369
370
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 362

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 



352
353
354
 
# File 'lib/purecloudplatformclientv2/models/scim_config_resource_type.rb', line 352

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end