Class: PureCloud::IntegrationType

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
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
351
352
353
354
355
356
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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 205

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#category ⇒ Object

Category describing the integration type.



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

def category
  @category
end

#config_advanced_schema_uri ⇒ Object

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



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

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.



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

def config_properties_schema_uri
  @config_properties_schema_uri
end

#credentials ⇒ Object

Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.



76
77
78
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 76

def credentials
  @credentials
end

#description ⇒ Object

Description of the integration type.



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

def description
  @description
end

#faq_uri ⇒ Object

URI of frequently asked questions about the integration type



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 61

def faq_uri
  @faq_uri
end

#help_links ⇒ Object

List of links to additional help resources



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 73

def help_links
  @help_links
end

#help_uri ⇒ Object

URI of a page with more information about the integration type



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

def help_uri
  @help_uri
end

#id ⇒ Object

The ID of the integration type.



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

def id
  @id
end

#images ⇒ Object

Collection of logos.



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

def images
  @images
end

#marketplace_uri ⇒ Object

URI of the marketplace listing for this integration type



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 58

def marketplace_uri
  @marketplace_uri
end

#max_instances ⇒ Object

The maximum number of integration instances allowable for this integration type



82
83
84
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 82

def max_instances
  @max_instances
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#non_installable ⇒ Object

Indicates if the integration type is installable or not.



79
80
81
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 79

def non_installable
  @non_installable
end

#privacy_policy_uri ⇒ Object

URI of a privacy policy for users of the integration type



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 64

def privacy_policy_uri
  @privacy_policy_uri
end

#provider ⇒ Object

PureCloud provider of the integration type.



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

def provider
  @provider
end

#sales_contact_uri ⇒ Object

URI for vendor sales information



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 70

def sales_contact_uri
  @sales_contact_uri
end

#self_uri ⇒ Object

The URI for this object



91
92
93
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 91

def self_uri
  @self_uri
end

#support_contact_uri ⇒ Object

URI for vendor support



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 67

def support_contact_uri
  @support_contact_uri
end

#terms_of_service_uri ⇒ Object

URI of a page with terms and conditions for the integration type



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

def terms_of_service_uri
  @terms_of_service_uri
end

#user_permissions ⇒ Object

List of permissions required to permit user access to the integration type.



85
86
87
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 85

def user_permissions
  @user_permissions
end

#vendor_name ⇒ Object

Name of the vendor of this integration type



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

def vendor_name
  @vendor_name
end

#vendor_o_auth_client_ids ⇒ Object

List of OAuth Client IDs that must be authorized when the integration is created.



88
89
90
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 88

def vendor_o_auth_client_ids
  @vendor_o_auth_client_ids
end

#vendor_website_uri ⇒ Object

URI of the vendor’s website



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

def vendor_website_uri
  @vendor_website_uri
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'provider' => :'provider',
    
    :'category' => :'category',
    
    :'images' => :'images',
    
    :'config_properties_schema_uri' => :'configPropertiesSchemaUri',
    
    :'config_advanced_schema_uri' => :'configAdvancedSchemaUri',
    
    :'help_uri' => :'helpUri',
    
    :'terms_of_service_uri' => :'termsOfServiceUri',
    
    :'vendor_name' => :'vendorName',
    
    :'vendor_website_uri' => :'vendorWebsiteUri',
    
    :'marketplace_uri' => :'marketplaceUri',
    
    :'faq_uri' => :'faqUri',
    
    :'privacy_policy_uri' => :'privacyPolicyUri',
    
    :'support_contact_uri' => :'supportContactUri',
    
    :'sales_contact_uri' => :'salesContactUri',
    
    :'help_links' => :'helpLinks',
    
    :'credentials' => :'credentials',
    
    :'non_installable' => :'nonInstallable',
    
    :'max_instances' => :'maxInstances',
    
    :'user_permissions' => :'userPermissions',
    
    :'vendor_o_auth_client_ids' => :'vendorOAuthClientIds',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'provider' => :'String',
    
    :'category' => :'String',
    
    :'images' => :'Array<UserImage>',
    
    :'config_properties_schema_uri' => :'String',
    
    :'config_advanced_schema_uri' => :'String',
    
    :'help_uri' => :'String',
    
    :'terms_of_service_uri' => :'String',
    
    :'vendor_name' => :'String',
    
    :'vendor_website_uri' => :'String',
    
    :'marketplace_uri' => :'String',
    
    :'faq_uri' => :'String',
    
    :'privacy_policy_uri' => :'String',
    
    :'support_contact_uri' => :'String',
    
    :'sales_contact_uri' => :'String',
    
    :'help_links' => :'Array<HelpLink>',
    
    :'credentials' => :'Hash<String, CredentialSpecification>',
    
    :'non_installable' => :'BOOLEAN',
    
    :'max_instances' => :'Integer',
    
    :'user_permissions' => :'Array<String>',
    
    :'vendor_o_auth_client_ids' => :'Array<String>',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 679

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      provider == o.provider &&
      category == o.category &&
      images == o.images &&
      config_properties_schema_uri == o.config_properties_schema_uri &&
      config_advanced_schema_uri == o.config_advanced_schema_uri &&
      help_uri == o.help_uri &&
      terms_of_service_uri == o.terms_of_service_uri &&
      vendor_name == o.vendor_name &&
      vendor_website_uri == o.vendor_website_uri &&
      marketplace_uri == o.marketplace_uri &&
      faq_uri == o.faq_uri &&
      privacy_policy_uri == o.privacy_policy_uri &&
      support_contact_uri == o.support_contact_uri &&
      sales_contact_uri == o.sales_contact_uri &&
      help_links == o.help_links &&
      credentials == o.credentials &&
      non_installable == o.non_installable &&
      max_instances == o.max_instances &&
      user_permissions == o.user_permissions &&
      vendor_o_auth_client_ids == o.vendor_o_auth_client_ids &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 740

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



800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 800

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



721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 721

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


710
711
712
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 710

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



716
717
718
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 716

def hash
  [id, name, description, provider, category, images, config_properties_schema_uri, config_advanced_schema_uri, help_uri, terms_of_service_uri, vendor_name, vendor_website_uri, marketplace_uri, faq_uri, privacy_policy_uri, support_contact_uri, sales_contact_uri, help_links, credentials, non_installable, max_instances, user_permissions, vendor_o_auth_client_ids, 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



442
443
444
445
446
447
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 442

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



783
784
785
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 783

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



788
789
790
791
792
793
794
795
796
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 788

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 



778
779
780
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 778

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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/purecloudplatformclientv2/models/integration_type.rb', line 451

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end