Class: SmoochApi::IntegrationCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/smooch-api/models/integration_create.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntegrationCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smooch-api/models/integration_create.rb', line 208

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#access_key ⇒ Object

The public API key of your MessageBird account. Required for messagebird integrations.



85
86
87
 
# File 'lib/smooch-api/models/integration_create.rb', line 85

def access_key
  @access_key
end

#access_token_key ⇒ Object

The access token key obtained from your user via oauth. Required for twitter integrations.



79
80
81
 
# File 'lib/smooch-api/models/integration_create.rb', line 79

def access_token_key
  @access_token_key
end

#access_token_secret ⇒ Object

The access token secret obtained from your user via oauth. Required for twitter integrations.



82
83
84
 
# File 'lib/smooch-api/models/integration_create.rb', line 82

def access_token_secret
  @access_token_secret
end

#account_sid ⇒ Object

Twilio Account SID. Required for twilio integrations.



31
32
33
 
# File 'lib/smooch-api/models/integration_create.rb', line 31

def 
  @account_sid
end

#action_color ⇒ Object

This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations.



97
98
99
 
# File 'lib/smooch-api/models/integration_create.rb', line 97

def action_color
  @action_color
end

#app_id ⇒ Object

Facebook App ID OR WeChat App ID. Required for messenger and wechat integrations.



25
26
27
 
# File 'lib/smooch-api/models/integration_create.rb', line 25

def app_id
  @app_id
end

#app_secret ⇒ Object

Facebook Page App Secret OR WeChat App Secret. Required for messenger and wechat integrations.



28
29
30
 
# File 'lib/smooch-api/models/integration_create.rb', line 28

def app_secret
  @app_secret
end

#auth_token ⇒ Object

Twilio Auth Token. Required for twilio integrations.



34
35
36
 
# File 'lib/smooch-api/models/integration_create.rb', line 34

def auth_token
  @auth_token
end

#auto_update_badge ⇒ Object

Use the unread count of the conversation as the application badge. (Optional) Used for apn integrations.



64
65
66
 
# File 'lib/smooch-api/models/integration_create.rb', line 64

def auto_update_badge
  @auto_update_badge
end

#background_image_url ⇒ Object

A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.



121
122
123
 
# File 'lib/smooch-api/models/integration_create.rb', line 121

def background_image_url
  @background_image_url
end

#brand_color ⇒ Object

This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations.



91
92
93
 
# File 'lib/smooch-api/models/integration_create.rb', line 91

def brand_color
  @brand_color
end

#business_icon_url ⇒ Object

A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.



118
119
120
 
# File 'lib/smooch-api/models/integration_create.rb', line 118

def business_icon_url
  @business_icon_url
end

#business_name ⇒ Object

A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.



115
116
117
 
# File 'lib/smooch-api/models/integration_create.rb', line 115

def business_name
  @business_name
end

#button_height ⇒ Object

With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations.



109
110
111
 
# File 'lib/smooch-api/models/integration_create.rb', line 109

def button_height
  @button_height
end

#button_icon_url ⇒ Object

With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations.



103
104
105
 
# File 'lib/smooch-api/models/integration_create.rb', line 103

def button_icon_url
  @button_icon_url
end

#button_width ⇒ Object

With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations.



106
107
108
 
# File 'lib/smooch-api/models/integration_create.rb', line 106

def button_width
  @button_width
end

#certificate ⇒ Object

The binary of your APN certificate base64 encoded. Required for apn integrations.



58
59
60
 
# File 'lib/smooch-api/models/integration_create.rb', line 58

def certificate
  @certificate
end

#channel_access_token ⇒ Object

LINE Channel Access Token. Required for line integrations.



49
50
51
 
# File 'lib/smooch-api/models/integration_create.rb', line 49

def channel_access_token
  @channel_access_token
end

#channel_id ⇒ Object

LINE Channel ID. Required for line integrations.



43
44
45
 
# File 'lib/smooch-api/models/integration_create.rb', line 43

def channel_id
  @channel_id
end

#channel_secret ⇒ Object

LINE Channel Secret. Required for line integrations.



46
47
48
 
# File 'lib/smooch-api/models/integration_create.rb', line 46

def channel_secret
  @channel_secret
end

#consumer_key ⇒ Object

The consumer key for your Twitter app. Required for twitter integrations.



73
74
75
 
# File 'lib/smooch-api/models/integration_create.rb', line 73

def consumer_key
  @consumer_key
end

#consumer_secret ⇒ Object

The consumer secret for your Twitter app. Required for twitter integrations.



76
77
78
 
# File 'lib/smooch-api/models/integration_create.rb', line 76

def consumer_secret
  @consumer_secret
end

#conversation_color ⇒ Object

This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations.



94
95
96
 
# File 'lib/smooch-api/models/integration_create.rb', line 94

def conversation_color
  @conversation_color
end

#display_style ⇒ Object

Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations.



100
101
102
 
# File 'lib/smooch-api/models/integration_create.rb', line 100

def display_style
  @display_style
end

#encoding_aes_key ⇒ Object

AES Encoding Key. (Optional) Used for wechat integrations.



52
53
54
 
# File 'lib/smooch-api/models/integration_create.rb', line 52

def encoding_aes_key
  @encoding_aes_key
end

#from_address ⇒ Object

Email will display as coming from this address. (Optional) Used for frontendEmail integrations.



55
56
57
 
# File 'lib/smooch-api/models/integration_create.rb', line 55

def from_address
  @from_address
end

#integration_order ⇒ Object

A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.



112
113
114
 
# File 'lib/smooch-api/models/integration_create.rb', line 112

def integration_order
  @integration_order
end

#originator ⇒ Object

Smooch will receive all messages sent to this phone number. Required for messagebird integrations.



88
89
90
 
# File 'lib/smooch-api/models/integration_create.rb', line 88

def originator
  @originator
end

#page_access_token ⇒ Object

Facebook Page Access Token. Required for messenger integrations.



22
23
24
 
# File 'lib/smooch-api/models/integration_create.rb', line 22

def page_access_token
  @page_access_token
end

#password ⇒ Object

The password for your APN certificate. (Optional) Used for apn integrations.



61
62
63
 
# File 'lib/smooch-api/models/integration_create.rb', line 61

def password
  @password
end

#phone_number_sid ⇒ Object

SID for specific phone number. Required for twilio integrations.



37
38
39
 
# File 'lib/smooch-api/models/integration_create.rb', line 37

def phone_number_sid
  @phone_number_sid
end

#sender_id ⇒ Object

Your sender id from the fcm console. Required for fcm integrations.



70
71
72
 
# File 'lib/smooch-api/models/integration_create.rb', line 70

def sender_id
  @sender_id
end

#server_key ⇒ Object

Your server key from the fcm console. Required for fcm integrations.



67
68
69
 
# File 'lib/smooch-api/models/integration_create.rb', line 67

def server_key
  @server_key
end

#token ⇒ Object

Telegram Bot Token OR Viber Public Account token. Required for twilio and viber integrations.



40
41
42
 
# File 'lib/smooch-api/models/integration_create.rb', line 40

def token
  @token
end

#type ⇒ Object

The integration type.



19
20
21
 
# File 'lib/smooch-api/models/integration_create.rb', line 19

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/smooch-api/models/integration_create.rb', line 125

def self.attribute_map
  {
    :'type' => :'type',
    :'page_access_token' => :'pageAccessToken',
    :'app_id' => :'appId',
    :'app_secret' => :'appSecret',
    :'account_sid' => :'accountSid',
    :'auth_token' => :'authToken',
    :'phone_number_sid' => :'phoneNumberSid',
    :'token' => :'token',
    :'channel_id' => :'channelId',
    :'channel_secret' => :'channelSecret',
    :'channel_access_token' => :'channelAccessToken',
    :'encoding_aes_key' => :'encodingAesKey',
    :'from_address' => :'fromAddress',
    :'certificate' => :'certificate',
    :'password' => :'password',
    :'auto_update_badge' => :'autoUpdateBadge',
    :'server_key' => :'serverKey',
    :'sender_id' => :'senderId',
    :'consumer_key' => :'consumerKey',
    :'consumer_secret' => :'consumerSecret',
    :'access_token_key' => :'accessTokenKey',
    :'access_token_secret' => :'accessTokenSecret',
    :'access_key' => :'accessKey',
    :'originator' => :'originator',
    :'brand_color' => :'brandColor',
    :'conversation_color' => :'conversationColor',
    :'action_color' => :'actionColor',
    :'display_style' => :'displayStyle',
    :'button_icon_url' => :'buttonIconUrl',
    :'button_width' => :'buttonWidth',
    :'button_height' => :'buttonHeight',
    :'integration_order' => :'integrationOrder',
    :'business_name' => :'businessName',
    :'business_icon_url' => :'businessIconUrl',
    :'background_image_url' => :'backgroundImageUrl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/smooch-api/models/integration_create.rb', line 166

def self.swagger_types
  {
    :'type' => :'String',
    :'page_access_token' => :'String',
    :'app_id' => :'String',
    :'app_secret' => :'String',
    :'account_sid' => :'String',
    :'auth_token' => :'String',
    :'phone_number_sid' => :'String',
    :'token' => :'String',
    :'channel_id' => :'String',
    :'channel_secret' => :'String',
    :'channel_access_token' => :'String',
    :'encoding_aes_key' => :'String',
    :'from_address' => :'String',
    :'certificate' => :'String',
    :'password' => :'String',
    :'auto_update_badge' => :'BOOLEAN',
    :'server_key' => :'String',
    :'sender_id' => :'String',
    :'consumer_key' => :'String',
    :'consumer_secret' => :'String',
    :'access_token_key' => :'String',
    :'access_token_secret' => :'String',
    :'access_key' => :'String',
    :'originator' => :'String',
    :'brand_color' => :'String',
    :'conversation_color' => :'String',
    :'action_color' => :'String',
    :'display_style' => :'String',
    :'button_icon_url' => :'String',
    :'button_width' => :'String',
    :'button_height' => :'String',
    :'integration_order' => :'Array<String>',
    :'business_name' => :'String',
    :'business_icon_url' => :'String',
    :'background_image_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/smooch-api/models/integration_create.rb', line 378

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      page_access_token == o.page_access_token &&
      app_id == o.app_id &&
      app_secret == o.app_secret &&
       == o. &&
      auth_token == o.auth_token &&
      phone_number_sid == o.phone_number_sid &&
      token == o.token &&
      channel_id == o.channel_id &&
      channel_secret == o.channel_secret &&
      channel_access_token == o.channel_access_token &&
      encoding_aes_key == o.encoding_aes_key &&
      from_address == o.from_address &&
      certificate == o.certificate &&
      password == o.password &&
      auto_update_badge == o.auto_update_badge &&
      server_key == o.server_key &&
      sender_id == o.sender_id &&
      consumer_key == o.consumer_key &&
      consumer_secret == o.consumer_secret &&
      access_token_key == o.access_token_key &&
      access_token_secret == o.access_token_secret &&
      access_key == o.access_key &&
      originator == o.originator &&
      brand_color == o.brand_color &&
      conversation_color == o.conversation_color &&
      action_color == o.action_color &&
      display_style == o.display_style &&
      button_icon_url == o.button_icon_url &&
      button_width == o.button_width &&
      button_height == o.button_height &&
      integration_order == o.integration_order &&
      business_name == o.business_name &&
      business_icon_url == o.business_icon_url &&
      background_image_url == o.background_image_url
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/smooch-api/models/integration_create.rb', line 454

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 =~ /\A(true|t|yes|y|1)\z/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
    temp_model = SmoochApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/smooch-api/models/integration_create.rb', line 520

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/smooch-api/models/integration_create.rb', line 433

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


420
421
422
 
# File 'lib/smooch-api/models/integration_create.rb', line 420

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



426
427
428
 
# File 'lib/smooch-api/models/integration_create.rb', line 426

def hash
  [type, page_access_token, app_id, app_secret, , auth_token, phone_number_sid, token, channel_id, channel_secret, channel_access_token, encoding_aes_key, from_address, certificate, password, auto_update_badge, server_key, sender_id, consumer_key, consumer_secret, access_token_key, access_token_secret, access_key, originator, brand_color, conversation_color, action_color, display_style, button_icon_url, button_width, button_height, integration_order, business_name, business_icon_url, background_image_url].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



360
361
362
363
364
365
366
367
 
# File 'lib/smooch-api/models/integration_create.rb', line 360

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



500
501
502
 
# File 'lib/smooch-api/models/integration_create.rb', line 500

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



506
507
508
509
510
511
512
513
514
 
# File 'lib/smooch-api/models/integration_create.rb', line 506

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



494
495
496
 
# File 'lib/smooch-api/models/integration_create.rb', line 494

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



371
372
373
374
 
# File 'lib/smooch-api/models/integration_create.rb', line 371

def valid?
  return false if @type.nil?
  return true
end