Class: PureCloud::IntegrationType

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/integration_type.rb

Overview

Descriptor for a type of Integration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntegrationType

Returns a new instance of IntegrationType.



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
 
# File 'lib/purecloud/models/integration_type.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'images']
    if (value = attributes[:'images']).is_a?(Array)
      self.images = value
    end
  end
  
  if attributes[:'configPropertiesSchemaUri']
    self.config_properties_schema_uri = attributes[:'configPropertiesSchemaUri']
  end
  
  if attributes[:'configAdvancedSchemaUri']
    self.config_advanced_schema_uri = attributes[:'configAdvancedSchemaUri']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#config_advanced_schema_uri ⇒ Object

URI of the schema describing the advanced JSON document needed to configure an integration of this type.



40
41
42
 
# File 'lib/purecloud/models/integration_type.rb', line 40

def config_advanced_schema_uri
  @config_advanced_schema_uri
end

#config_properties_schema_uri ⇒ Object

URI of the schema describing the key-value properties needed to configure an integration of this type.



37
38
39
 
# File 'lib/purecloud/models/integration_type.rb', line 37

def config_properties_schema_uri
  @config_properties_schema_uri
end

#description ⇒ Object

Localized description of the integration type.



28
29
30
 
# File 'lib/purecloud/models/integration_type.rb', line 28

def description
  @description
end

#id ⇒ Object

The ID of the integration type.



23
24
25
 
# File 'lib/purecloud/models/integration_type.rb', line 23

def id
  @id
end

#images ⇒ Object

Collection of logos.



34
35
36
 
# File 'lib/purecloud/models/integration_type.rb', line 34

def images
  @images
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloud/models/integration_type.rb', line 25

def name
  @name
end

#provider ⇒ Object

PureCloud provider of the integration type.



31
32
33
 
# File 'lib/purecloud/models/integration_type.rb', line 31

def provider
  @provider
end

#self_uri ⇒ Object

The URI for this object



43
44
45
 
# File 'lib/purecloud/models/integration_type.rb', line 43

def self_uri
  @self_uri
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'provider' => :'provider',
    
    :'images' => :'images',
    
    :'config_properties_schema_uri' => :'configPropertiesSchemaUri',
    
    :'config_advanced_schema_uri' => :'configAdvancedSchemaUri',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/purecloud/models/integration_type.rb', line 69

def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'provider' => :'String',
    :'images' => :'Array<UserImage>',
    :'config_properties_schema_uri' => :'String',
    :'config_advanced_schema_uri' => :'String',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/purecloud/models/integration_type.rb', line 127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      provider == o.provider &&
      images == o.images &&
      config_properties_schema_uri == o.config_properties_schema_uri &&
      config_advanced_schema_uri == o.config_advanced_schema_uri &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/integration_type.rb', line 170

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/purecloud/models/integration_type.rb', line 230

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/purecloud/models/integration_type.rb', line 151

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

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/purecloud/models/integration_type.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



146
147
148
 
# File 'lib/purecloud/models/integration_type.rb', line 146

def hash
  [id, name, description, provider, images, config_properties_schema_uri, config_advanced_schema_uri, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



213
214
215
 
# File 'lib/purecloud/models/integration_type.rb', line 213

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



218
219
220
221
222
223
224
225
226
 
# File 'lib/purecloud/models/integration_type.rb', line 218

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 



208
209
210
 
# File 'lib/purecloud/models/integration_type.rb', line 208

def to_s
  to_hash.to_s
end