Class: SunshineConversationsClient::WebUpdateAllOf

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/web_update_all_of.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebUpdateAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::WebUpdateAllOf` 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::WebUpdateAllOf`. 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
  }

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

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

  if attributes.key?(:'can_user_create_more_conversations')
    self.can_user_create_more_conversations = attributes[:'can_user_create_more_conversations']
  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.



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

def action_color
  @action_color
end

#background_image_url ⇒ Object

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



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

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.



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

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.



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

def business_icon_url
  @business_icon_url
end

#business_name ⇒ Object

A custom business name for the Web Messenger.



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

def business_name
  @business_name
end

#button_height ⇒ Object

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



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

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.



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

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.



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

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.



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

def can_user_create_more_conversations
  @can_user_create_more_conversations
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.



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

def conversation_color
  @conversation_color
end

#display_style ⇒ Object

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



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

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.



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

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.



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

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.



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

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.



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

def prechat_capture
  @prechat_capture
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 61

def self.attribute_map
  {
    :'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_create_more_conversations' => :'canUserCreateMoreConversations'
  }
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



249
250
251
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 249

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



103
104
105
106
107
108
109
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 82

def self.openapi_types
  {
    :'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_create_more_conversations' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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_create_more_conversations == o.can_user_create_more_conversations
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



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

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
    SunshineConversationsClient.const_get(type).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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 346

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 256

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[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


236
237
238
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



242
243
244
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 242

def hash
  [brand_color, fixed_intro_pane, conversation_color, action_color, display_style, button_icon_url, button_width, button_height, integration_order, business_name, business_icon_url, background_image_url, origin_whitelist, prechat_capture, can_user_create_more_conversations].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



201
202
203
204
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 201

def list_invalid_properties
  invalid_properties = Array.new
  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



322
323
324
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 322

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 328

def to_hash
  hash = {}
  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



316
317
318
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 316

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



208
209
210
 
# File 'lib/sunshine-conversations-client/models/web_update_all_of.rb', line 208

def valid?
  true
end