Class: SmoochApi::IntegrationUpdate
- Inherits:
-
Object
- Object
- SmoochApi::IntegrationUpdate
- Defined in:
- lib/smooch-api/models/integration_update.rb
Instance Attribute Summary collapse
-
#actionColor ⇒ Object
This color will be used for call-to-actions inside your messages.
-
#backgroundImageUrl ⇒ Object
A custom background url for the Web Messenger.
-
#brandColor ⇒ Object
This color will be used in the messenger header and the button or tab in idle state.
-
#businessIconUrl ⇒ Object
A custom business icon url for the Web Messenger.
-
#businessName ⇒ Object
A custom business name for the Web Messenger.
-
#buttonHeight ⇒ Object
With the button style Web Messenger, you have the option of specifying its height.
-
#buttonIconUrl ⇒ Object
With the button style Web Messenger, you have the option of selecting your own button icon.
-
#buttonWidth ⇒ Object
With the button style Web Messenger, you have the option of specifying its width.
-
#channelId ⇒ Object
LINE Channel ID.
-
#channelSecret ⇒ Object
LINE Channel Secret.
-
#conversationColor ⇒ Object
This color will be used for customer messages, quick replies and actions in the footer.
-
#displayName ⇒ Object
The integration display name.
-
#displayStyle ⇒ Object
Choose how the messenger will appear on your website.
-
#fixedIntroPane ⇒ Object
When ‘true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it.
-
#hideUnsubscribeLink ⇒ Object
When ‘true`, unsubscribe links will not be included in outbound emails.
-
#hsmFallbackLanguage ⇒ Object
Specification of a fallback language.
-
#integrationOrder ⇒ Object
Array of integration IDs, order will be reflected in the Web Messenger.
-
#originWhitelist ⇒ Object
A list of origins to whitelist.
-
#qrCodeUrl ⇒ Object
URL provided by LINE in the [Developer Console](developers.line.biz/console/).
-
#serviceCode ⇒ Object
LINE Service Code.
-
#switcherSecret ⇒ Object
LINE Switcher Secret.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ IntegrationUpdate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ IntegrationUpdate
Initializes the object
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 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 |
# File 'lib/smooch-api/models/integration_update.rb', line 138 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?(:'displayName') self.displayName = attributes[:'displayName'] end if attributes.has_key?(:'brandColor') self.brandColor = attributes[:'brandColor'] end if attributes.has_key?(:'fixedIntroPane') self.fixedIntroPane = attributes[:'fixedIntroPane'] end if attributes.has_key?(:'conversationColor') self.conversationColor = attributes[:'conversationColor'] end if attributes.has_key?(:'actionColor') self.actionColor = attributes[:'actionColor'] end if attributes.has_key?(:'displayStyle') self.displayStyle = attributes[:'displayStyle'] end if attributes.has_key?(:'buttonIconUrl') self. = attributes[:'buttonIconUrl'] end if attributes.has_key?(:'buttonWidth') self. = attributes[:'buttonWidth'] end if attributes.has_key?(:'buttonHeight') self. = attributes[:'buttonHeight'] end if attributes.has_key?(:'integrationOrder') if (value = attributes[:'integrationOrder']).is_a?(Array) self.integrationOrder = value end end if attributes.has_key?(:'businessName') self.businessName = attributes[:'businessName'] end if attributes.has_key?(:'businessIconUrl') self.businessIconUrl = attributes[:'businessIconUrl'] end if attributes.has_key?(:'backgroundImageUrl') self.backgroundImageUrl = attributes[:'backgroundImageUrl'] end if attributes.has_key?(:'originWhitelist') if (value = attributes[:'originWhitelist']).is_a?(Array) self.originWhitelist = value end end if attributes.has_key?(:'channelId') self.channelId = attributes[:'channelId'] end if attributes.has_key?(:'channelSecret') self.channelSecret = attributes[:'channelSecret'] end if attributes.has_key?(:'serviceCode') self.serviceCode = attributes[:'serviceCode'] end if attributes.has_key?(:'switcherSecret') self.switcherSecret = attributes[:'switcherSecret'] end if attributes.has_key?(:'hsmFallbackLanguage') self.hsmFallbackLanguage = attributes[:'hsmFallbackLanguage'] end if attributes.has_key?(:'qrCodeUrl') self.qrCodeUrl = attributes[:'qrCodeUrl'] end if attributes.has_key?(:'hideUnsubscribeLink') self.hideUnsubscribeLink = attributes[:'hideUnsubscribeLink'] end end |
Instance Attribute Details
#actionColor ⇒ Object
This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations.
31 32 33 |
# File 'lib/smooch-api/models/integration_update.rb', line 31 def actionColor @actionColor end |
#backgroundImageUrl ⇒ Object
A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.
55 56 57 |
# File 'lib/smooch-api/models/integration_update.rb', line 55 def backgroundImageUrl @backgroundImageUrl end |
#brandColor ⇒ Object
This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations.
22 23 24 |
# File 'lib/smooch-api/models/integration_update.rb', line 22 def brandColor @brandColor end |
#businessIconUrl ⇒ Object
A custom business icon 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 businessIconUrl @businessIconUrl end |
#businessName ⇒ Object
A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.
49 50 51 |
# File 'lib/smooch-api/models/integration_update.rb', line 49 def businessName @businessName end |
#buttonHeight ⇒ Object
With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations.
43 44 45 |
# File 'lib/smooch-api/models/integration_update.rb', line 43 def @buttonHeight end |
#buttonIconUrl ⇒ Object
With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations.
37 38 39 |
# File 'lib/smooch-api/models/integration_update.rb', line 37 def @buttonIconUrl end |
#buttonWidth ⇒ Object
With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations.
40 41 42 |
# File 'lib/smooch-api/models/integration_update.rb', line 40 def @buttonWidth end |
#channelId ⇒ Object
LINE Channel ID. Required for line integrations.
61 62 63 |
# File 'lib/smooch-api/models/integration_update.rb', line 61 def channelId @channelId end |
#channelSecret ⇒ Object
LINE Channel Secret. Required for line integrations.
64 65 66 |
# File 'lib/smooch-api/models/integration_update.rb', line 64 def channelSecret @channelSecret end |
#conversationColor ⇒ Object
This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations.
28 29 30 |
# File 'lib/smooch-api/models/integration_update.rb', line 28 def conversationColor @conversationColor end |
#displayName ⇒ Object
The integration display name. Used to map a human-friendly name to an integration.
19 20 21 |
# File 'lib/smooch-api/models/integration_update.rb', line 19 def displayName @displayName end |
#displayStyle ⇒ Object
Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations.
34 35 36 |
# File 'lib/smooch-api/models/integration_update.rb', line 34 def displayStyle @displayStyle end |
#fixedIntroPane ⇒ 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.
25 26 27 |
# File 'lib/smooch-api/models/integration_update.rb', line 25 def fixedIntroPane @fixedIntroPane end |
#hideUnsubscribeLink ⇒ Object
When ‘true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for mailgun integrations.
79 80 81 |
# File 'lib/smooch-api/models/integration_update.rb', line 79 def hideUnsubscribeLink @hideUnsubscribeLink end |
#hsmFallbackLanguage ⇒ Object
Specification of a fallback language. (Optional) Used for WhatsApp integrations.
73 74 75 |
# File 'lib/smooch-api/models/integration_update.rb', line 73 def hsmFallbackLanguage @hsmFallbackLanguage end |
#integrationOrder ⇒ 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.
46 47 48 |
# File 'lib/smooch-api/models/integration_update.rb', line 46 def integrationOrder @integrationOrder end |
#originWhitelist ⇒ 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.
58 59 60 |
# File 'lib/smooch-api/models/integration_update.rb', line 58 def originWhitelist @originWhitelist end |
#qrCodeUrl ⇒ Object
URL provided by LINE in the [Developer Console](developers.line.biz/console/).
76 77 78 |
# File 'lib/smooch-api/models/integration_update.rb', line 76 def qrCodeUrl @qrCodeUrl end |
#serviceCode ⇒ Object
LINE Service Code.
67 68 69 |
# File 'lib/smooch-api/models/integration_update.rb', line 67 def serviceCode @serviceCode end |
#switcherSecret ⇒ Object
LINE Switcher Secret.
70 71 72 |
# File 'lib/smooch-api/models/integration_update.rb', line 70 def switcherSecret @switcherSecret end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/smooch-api/models/integration_update.rb', line 83 def self.attribute_map { :'displayName' => :'displayName', :'brandColor' => :'brandColor', :'fixedIntroPane' => :'fixedIntroPane', :'conversationColor' => :'conversationColor', :'actionColor' => :'actionColor', :'displayStyle' => :'displayStyle', :'buttonIconUrl' => :'buttonIconUrl', :'buttonWidth' => :'buttonWidth', :'buttonHeight' => :'buttonHeight', :'integrationOrder' => :'integrationOrder', :'businessName' => :'businessName', :'businessIconUrl' => :'businessIconUrl', :'backgroundImageUrl' => :'backgroundImageUrl', :'originWhitelist' => :'originWhitelist', :'channelId' => :'channelId', :'channelSecret' => :'channelSecret', :'serviceCode' => :'serviceCode', :'switcherSecret' => :'switcherSecret', :'hsmFallbackLanguage' => :'hsmFallbackLanguage', :'qrCodeUrl' => :'qrCodeUrl', :'hideUnsubscribeLink' => :'hideUnsubscribeLink' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/smooch-api/models/integration_update.rb', line 110 def self.swagger_types { :'displayName' => :'String', :'brandColor' => :'String', :'fixedIntroPane' => :'BOOLEAN', :'conversationColor' => :'String', :'actionColor' => :'String', :'displayStyle' => :'String', :'buttonIconUrl' => :'String', :'buttonWidth' => :'String', :'buttonHeight' => :'String', :'integrationOrder' => :'Array<String>', :'businessName' => :'String', :'businessIconUrl' => :'String', :'backgroundImageUrl' => :'String', :'originWhitelist' => :'Array<String>', :'channelId' => :'String', :'channelSecret' => :'String', :'serviceCode' => :'String', :'switcherSecret' => :'String', :'hsmFallbackLanguage' => :'String', :'qrCodeUrl' => :'String', :'hideUnsubscribeLink' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/smooch-api/models/integration_update.rb', line 249 def ==(o) return true if self.equal?(o) self.class == o.class && displayName == o.displayName && brandColor == o.brandColor && fixedIntroPane == o.fixedIntroPane && conversationColor == o.conversationColor && actionColor == o.actionColor && displayStyle == o.displayStyle && == o. && == o. && == o. && integrationOrder == o.integrationOrder && businessName == o.businessName && businessIconUrl == o.businessIconUrl && backgroundImageUrl == o.backgroundImageUrl && originWhitelist == o.originWhitelist && channelId == o.channelId && channelSecret == o.channelSecret && serviceCode == o.serviceCode && switcherSecret == o.switcherSecret && hsmFallbackLanguage == o.hsmFallbackLanguage && qrCodeUrl == o.qrCodeUrl && hideUnsubscribeLink == o.hideUnsubscribeLink end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/smooch-api/models/integration_update.rb', line 311 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
377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/smooch-api/models/integration_update.rb', line 377 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
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/smooch-api/models/integration_update.rb', line 290 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
277 278 279 |
# File 'lib/smooch-api/models/integration_update.rb', line 277 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
283 284 285 |
# File 'lib/smooch-api/models/integration_update.rb', line 283 def hash [displayName, brandColor, fixedIntroPane, conversationColor, actionColor, displayStyle, , , , integrationOrder, businessName, businessIconUrl, backgroundImageUrl, originWhitelist, channelId, channelSecret, serviceCode, switcherSecret, hsmFallbackLanguage, qrCodeUrl, hideUnsubscribeLink].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
236 237 238 239 |
# File 'lib/smooch-api/models/integration_update.rb', line 236 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)
357 358 359 |
# File 'lib/smooch-api/models/integration_update.rb', line 357 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
363 364 365 366 367 368 369 370 371 |
# File 'lib/smooch-api/models/integration_update.rb', line 363 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
351 352 353 |
# File 'lib/smooch-api/models/integration_update.rb', line 351 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
243 244 245 |
# File 'lib/smooch-api/models/integration_update.rb', line 243 def valid? return true end |