Class: PureCloud::WebChatDeployment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebChatDeployment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 101

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#allowed_domains ⇒ Object

Returns the value of attribute allowed_domains.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 37

def allowed_domains
  @allowed_domains
end

#authentication_required ⇒ Object

Returns the value of attribute authentication_required.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 28

def authentication_required
  @authentication_required
end

#authentication_url ⇒ Object

URL for third party service authenticating web chat clients. See github.com/MyPureCloud/authenticated-web-chat-server-examples



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 31

def authentication_url
  @authentication_url
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#disabled ⇒ Object

Returns the value of attribute disabled.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 33

def disabled
  @disabled
end

#flow ⇒ Object

The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 40

def flow
  @flow
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 22

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 24

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 43

def self_uri
  @self_uri
end

#web_chat_config ⇒ Object

Returns the value of attribute web_chat_config.



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

def web_chat_config
  @web_chat_config
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
67
68
69
70
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 46

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'authentication_required' => :'authenticationRequired',
    
    :'authentication_url' => :'authenticationUrl',
    
    :'disabled' => :'disabled',
    
    :'web_chat_config' => :'webChatConfig',
    
    :'allowed_domains' => :'allowedDomains',
    
    :'flow' => :'flow',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'authentication_required' => :'BOOLEAN',
    
    :'authentication_url' => :'String',
    
    :'disabled' => :'BOOLEAN',
    
    :'web_chat_config' => :'WebChatConfig',
    
    :'allowed_domains' => :'Array<String>',
    
    :'flow' => :'DomainEntityRef',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 310

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      authentication_required == o.authentication_required &&
      authentication_url == o.authentication_url &&
      disabled == o.disabled &&
      web_chat_config == o.web_chat_config &&
      allowed_domains == o.allowed_domains &&
      flow == o.flow &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



357
358
359
360
361
362
363
364
365
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
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 357

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 417

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 338

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


327
328
329
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



333
334
335
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 333

def hash
  [id, name, description, authentication_required, authentication_url, disabled, web_chat_config, allowed_domains, flow, self_uri].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



204
205
206
207
208
209
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 204

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



400
401
402
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 400

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



405
406
407
408
409
410
411
412
413
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 405

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 



395
396
397
 
# File 'lib/purecloudplatformclientv2/models/web_chat_deployment.rb', line 395

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end