Class: SmoochApi::IntegrationUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntegrationUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/smooch-api/models/integration_update.rb', line 98

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

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

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

end

Instance Attribute Details

#action_color ⇒ Object

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



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

def action_color
  @action_color
end

#background_image_url ⇒ Object

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



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

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.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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



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

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.



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

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. The default value is false. (Optional) Used for *Web Messenger* integrations.



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

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 (Optional) Used for *Web Messenger* integrations.



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

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. (Optional) Used for *Web Messenger* integrations.



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

def origin_whitelist
  @origin_whitelist
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/smooch-api/models/integration_update.rb', line 59

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

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/smooch-api/models/integration_update.rb', line 78

def self.swagger_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>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/smooch-api/models/integration_update.rb', line 177

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



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/smooch-api/models/integration_update.rb', line 297

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/smooch-api/models/integration_update.rb', line 210

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


197
198
199
 
# File 'lib/smooch-api/models/integration_update.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/smooch-api/models/integration_update.rb', line 203

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



164
165
166
167
 
# File 'lib/smooch-api/models/integration_update.rb', line 164

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



277
278
279
 
# File 'lib/smooch-api/models/integration_update.rb', line 277

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



283
284
285
286
287
288
289
290
291
 
# File 'lib/smooch-api/models/integration_update.rb', line 283

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



271
272
273
 
# File 'lib/smooch-api/models/integration_update.rb', line 271

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



171
172
173
 
# File 'lib/smooch-api/models/integration_update.rb', line 171

def valid?
  return true
end