Class: SunshineConversationsClient::Web

Inherits:
Integration show all
Defined in:
lib/sunshine-conversations-client/models/web.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from Integration

#display_name, #id, #status

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Integration

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Web

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 170

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Web` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Web`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'default_responder_id')
    self.default_responder_id = attributes[:'default_responder_id']
  end

  if attributes.key?(:'default_responder')
    self.default_responder = attributes[:'default_responder']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'web'
  end

  if attributes.key?(:'brand_color')
    self.brand_color = attributes[:'brand_color']
  else
    self.brand_color = '65758e'
  end

  if attributes.key?(:'fixed_intro_pane')
    self.fixed_intro_pane = attributes[:'fixed_intro_pane']
  else
    self.fixed_intro_pane = false
  end

  if attributes.key?(:'conversation_color')
    self.conversation_color = attributes[:'conversation_color']
  else
    self.conversation_color = '0099ff'
  end

  if attributes.key?(:'action_color')
    self.action_color = attributes[:'action_color']
  else
    self.action_color = '0099ff'
  end

  if attributes.key?(:'display_style')
    self.display_style = attributes[:'display_style']
  else
    self.display_style = 'button'
  end

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

  if attributes.key?(:'button_width')
    self.button_width = attributes[:'button_width']
  else
    self.button_width = '58'
  end

  if attributes.key?(:'button_height')
    self.button_height = attributes[:'button_height']
  else
    self.button_height = '58'
  end

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

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

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

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

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

  if attributes.key?(:'prechat_capture')
    self.prechat_capture = attributes[:'prechat_capture']
  end

  if attributes.key?(:'can_user_see_conversation_list')
    self.can_user_see_conversation_list = attributes[:'can_user_see_conversation_list']
  end

  if attributes.key?(:'can_user_create_more_conversations')
    self.can_user_create_more_conversations = attributes[:'can_user_create_more_conversations']
  end

  if attributes.key?(:'attachments_enabled')
    self.attachments_enabled = attributes[:'attachments_enabled']
  end
end

Instance Attribute Details

#action_color ⇒ Object

This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 33

def action_color
  @action_color
end

#attachments_enabled ⇒ Object

Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center.



72
73
74
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 72

def attachments_enabled
  @attachments_enabled
end

#background_image_url ⇒ Object

A background image url for the conversation. Image will be tiled to fit the window.



57
58
59
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 57

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. Must be a 3 or 6-character hexadecimal color.



24
25
26
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 24

def brand_color
  @brand_color
end

#business_icon_url ⇒ Object

A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format.



54
55
56
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 54

def business_icon_url
  @business_icon_url
end

#business_name ⇒ Object

A custom business name for the Web Messenger.



51
52
53
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 51

def business_name
  @business_name
end

#button_height ⇒ Object

With the button style Web Messenger, you have the option of specifying the button height.



45
46
47
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 45

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. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format.



39
40
41
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 39

def button_icon_url
  @button_icon_url
end

#button_width ⇒ Object

With the button style Web Messenger, you have the option of specifying the button width.



42
43
44
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 42

def button_width
  @button_width
end

#can_user_create_more_conversations ⇒ Object

Allows users to create more than one conversation on the web messenger integration.



69
70
71
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 69

def can_user_create_more_conversations
  @can_user_create_more_conversations
end

#can_user_see_conversation_list ⇒ Object

Allows users to view their list of conversations. By default, the list of conversations will be visible. *This setting only applies to apps where ‘settings.multiConvoEnabled` is set to `true`*.



66
67
68
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 66

def can_user_see_conversation_list
  @can_user_see_conversation_list
end

#conversation_color ⇒ Object

This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color.



30
31
32
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 30

def conversation_color
  @conversation_color
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 18

def default_responder
  @default_responder
end

#default_responder_id ⇒ Object

The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href="developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment">Switchboard guide</a>.



16
17
18
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 16

def default_responder_id
  @default_responder_id
end

#display_style ⇒ Object

Choose how the messenger will appear on your website. Must be either button or tab.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 36

def display_style
  @display_style
end

#fixed_intro_pane ⇒ Object

When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it.



27
28
29
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 27

def fixed_intro_pane
  @fixed_intro_pane
end

#integration_order ⇒ Object

Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed.



48
49
50
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 48

def integration_order
  @integration_order
end

#origin_whitelist ⇒ Object

A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme "://" host [ ":" port ], where scheme is http or https.



60
61
62
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 60

def origin_whitelist
  @origin_whitelist
end

#prechat_capture ⇒ Object

Object whose properties can be set to specify the add-on’s options. See the [guide](docs.smooch.io/guide/web-messenger/#prechat-capture) to learn more about Prechat Capture.



63
64
65
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 63

def prechat_capture
  @prechat_capture
end

#type ⇒ Object

To configure a Web Messenger integration, acquire the required information and call the Create Integration endpoint.



21
22
23
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 21

def type
  @type
end

Class Method Details

._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



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
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 367

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SunshineConversationsClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 97

def self.attribute_map
  {
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder',
    :'type' => :'type',
    :'brand_color' => :'brandColor',
    :'fixed_intro_pane' => :'fixedIntroPane',
    :'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',
    :'origin_whitelist' => :'originWhitelist',
    :'prechat_capture' => :'prechatCapture',
    :'can_user_see_conversation_list' => :'canUserSeeConversationList',
    :'can_user_create_more_conversations' => :'canUserCreateMoreConversations',
    :'attachments_enabled' => :'attachmentsEnabled'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 342

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



160
161
162
163
164
165
166
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 160

def self.openapi_all_of
  [
  :'DefaultResponder',
  :'DefaultResponderId',
  :'Integration'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



149
150
151
152
153
154
155
156
157
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 149

def self.openapi_nullable
  Set.new([
    :'default_responder_id',
    :'default_responder',
    :'button_icon_url',
    :'integration_order',
    :'origin_whitelist',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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/sunshine-conversations-client/models/web.rb', line 123

def self.openapi_types
  {
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder',
    :'type' => :'String',
    :'brand_color' => :'String',
    :'fixed_intro_pane' => :'Boolean',
    :'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',
    :'origin_whitelist' => :'Array<String>',
    :'prechat_capture' => :'PrechatCapture',
    :'can_user_see_conversation_list' => :'Boolean',
    :'can_user_create_more_conversations' => :'Boolean',
    :'attachments_enabled' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder &&
      type == o.type &&
      brand_color == o.brand_color &&
      fixed_intro_pane == o.fixed_intro_pane &&
      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 &&
      origin_whitelist == o.origin_whitelist &&
      prechat_capture == o.prechat_capture &&
      can_user_see_conversation_list == o.can_user_see_conversation_list &&
      can_user_create_more_conversations == o.can_user_create_more_conversations &&
      attachments_enabled == o.attachments_enabled && super(o)
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



438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 438

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 335

def hash
  [default_responder_iddefault_respondertypebrand_colorfixed_intro_paneconversation_coloraction_colordisplay_stylebutton_icon_urlbutton_widthbutton_heightintegration_orderbusiness_namebusiness_icon_urlbackground_image_urlorigin_whitelistprechat_capturecan_user_see_conversation_listcan_user_create_more_conversationsattachments_enabled].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



289
290
291
292
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 289

def list_invalid_properties
  invalid_properties = super
  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



414
415
416
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 414

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 420

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



408
409
410
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 408

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



296
297
298
 
# File 'lib/sunshine-conversations-client/models/web.rb', line 296

def valid?
  true && super
end