Class: PureCloud::ScimV2SchemaDefinition

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

Overview

Defines a SCIM schema.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScimV2SchemaDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

73
74
75
76
77
78
79
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
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/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 73

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

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

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

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

  
end

Instance Attribute Details

#attributesObject

The list of service provider attributes.


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

def attributes
  @attributes
end

#descriptionObject

The description of the schema.


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

def description
  @description
end

#idObject

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_v2_schema_definition.rb', line 23

def id
  @id
end

#metaObject

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


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

def meta
  @meta
end

#nameObject

The name of the schema.


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

def name
  @name
end

Class Method Details

.attribute_mapObject

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

[View source]

38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 38

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'attributes' => :'attributes',
    
    :'meta' => :'meta'
    
  }
end

.swagger_typesObject

Attribute type mapping.

[View source]

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 55

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'attributes' => :'Array<ScimV2SchemaAttribute>',
    
    :'meta' => :'ScimMetadata'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared

[View source]

192
193
194
195
196
197
198
199
200
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      attributes == o.attributes &&
      meta == o.meta
end

#_deserialize(type, value) ⇒ Object

[View source]

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

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

[View source]

294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 294

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

[View source]

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 215

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
[View source]

204
205
206
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 204

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code

[View source]

210
211
212
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 210

def hash
  [id, name, description, attributes, meta].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons

[View source]

131
132
133
134
135
136
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))

[View source]

277
278
279
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 277

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash

[View source]

282
283
284
285
286
287
288
289
290
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 282

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_sObject

[View source]

272
273
274
# File 'lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 272

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

[View source]

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/purecloudplatformclientv2/models/scim_v2_schema_definition.rb', line 140

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end