Class: SunshineConversationsClient::Whatsapp

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

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 = {}) ⇒ Whatsapp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Whatsapp` 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::Whatsapp`. 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?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'whatsapp'
  end

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

  if attributes.key?(:'hsm_fallback_language')
    self.hsm_fallback_language = attributes[:'hsm_fallback_language']
  else
    self.hsm_fallback_language = 'en_US'
  end

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

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

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

  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
end

Instance Attribute Details

#account_id ⇒ Object

The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction.



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

def 
  @account_id
end

#account_management_access_token ⇒ Object

An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction.



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

def 
  @account_management_access_token
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



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

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 <a href="docs.smooch.io/guide/switchboard/#per-channel-default-responder">Per-channel default responder</a> guide.



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

def default_responder_id
  @default_responder_id
end

#deployment_id ⇒ Object

The Id of the deployment. The integrationId and the appId will be added to the deployment. Additionally, the deployment’s status will be set to integrated.



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

def deployment_id
  @deployment_id
end

#hsm_fallback_language ⇒ Object

Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info.



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

def hsm_fallback_language
  @hsm_fallback_language
end

#phone_number ⇒ Object

The phone number that is associated with the deployment of this integration, if one exists.



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

def phone_number
  @phone_number
end

#type ⇒ Object

To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our [WhatsApp guide](docs.smooch.io/guide/whatsapp/#whatsapp-api-client) for more details on WhatsApp API Client hosting.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 38

def self.attribute_map
  {
    :'type' => :'type',
    :'deployment_id' => :'deploymentId',
    :'hsm_fallback_language' => :'hsmFallbackLanguage',
    :'account_id' => :'accountId',
    :'account_management_access_token' => :'accountManagementAccessToken',
    :'phone_number' => :'phoneNumber',
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder'
  }
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



189
190
191
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 189

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



77
78
79
80
81
82
83
84
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 77

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
70
71
72
73
74
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 66

def self.openapi_nullable
  Set.new([
    :'hsm_fallback_language',
    :'account_id',
    :'account_management_access_token',
    :'phone_number',
    :'default_responder_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 52

def self.openapi_types
  {
    :'type' => :'String',
    :'deployment_id' => :'String',
    :'hsm_fallback_language' => :'String',
    :'account_id' => :'String',
    :'account_management_access_token' => :'String',
    :'phone_number' => :'String',
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      deployment_id == o.deployment_id &&
      hsm_fallback_language == o.hsm_fallback_language &&
       == o. &&
       == o. &&
      phone_number == o.phone_number &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder && super(o)
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



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

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 287

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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


176
177
178
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 182

def hash
  [type, deployment_id, hsm_fallback_language, , , phone_number, default_responder_id, default_responder].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



143
144
145
146
147
148
149
150
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 143

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

  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



263
264
265
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 263

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



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 269

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



257
258
259
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 257

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



154
155
156
157
 
# File 'lib/sunshine-conversations-client/models/whatsapp.rb', line 154

def valid?
  return false if @deployment_id.nil?
  true && super
end