Class: PureCloud::FacebookIntegration

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacebookIntegration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 121

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#app_id ⇒ Object

The App Id from Facebook messenger



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

def app_id
  @app_id
end

#created_by ⇒ Object

User reference that created this Integration



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 46

def created_by
  @created_by
end

#date_created ⇒ Object

Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_created
  @date_created
end

#date_modified ⇒ Object

Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_modified
  @date_modified
end

#id ⇒ Object

A unique Integration Id.



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

def id
  @id
end

#modified_by ⇒ Object

User reference that last modified this Integration



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 49

def modified_by
  @modified_by
end

#name ⇒ Object

The name of the Facebook Integration



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 25

def name
  @name
end

#page_id ⇒ Object

The Page Id from Facebook messenger



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

def page_id
  @page_id
end

#recipient ⇒ Object

The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration



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

def recipient
  @recipient
end

#self_uri ⇒ Object

The URI for this object



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 55

def self_uri
  @self_uri
end

#status ⇒ Object

The status of the Facebook Integration



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 34

def status
  @status
end

#version ⇒ Object

Version number required for updates.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 52

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 58

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'app_id' => :'appId',
    
    :'page_id' => :'pageId',
    
    :'status' => :'status',
    
    :'recipient' => :'recipient',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'created_by' => :'createdBy',
    
    :'modified_by' => :'modifiedBy',
    
    :'version' => :'version',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'app_id' => :'String',
    
    :'page_id' => :'String',
    
    :'status' => :'String',
    
    :'recipient' => :'DomainEntityRef',
    
    :'date_created' => :'DateTime',
    
    :'date_modified' => :'DateTime',
    
    :'created_by' => :'DomainEntityRef',
    
    :'modified_by' => :'DomainEntityRef',
    
    :'version' => :'Integer',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 384

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      app_id == o.app_id &&
      page_id == o.page_id &&
      status == o.status &&
      recipient == o.recipient &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      created_by == o.created_by &&
      modified_by == o.modified_by &&
      version == o.version &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 433

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



493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 493

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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 414

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


403
404
405
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 403

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, name, app_id, page_id, status, recipient, date_created, date_modified, created_by, modified_by, version, 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



240
241
242
243
244
245
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 240

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



476
477
478
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 476

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



481
482
483
484
485
486
487
488
489
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 481

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 



471
472
473
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 471

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/purecloudplatformclientv2/models/facebook_integration.rb', line 249

def valid?
  
  
  if @id.nil?
    return false
  end

  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  if @app_id.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @version.nil?
    return false
  end

  
  
  
  
  
  
  
  
end