Class: SunshineConversationsClient::Messagebird

Inherits:
Integration
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/messagebird.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 = {}) ⇒ Messagebird

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 67

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

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

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

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

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

Instance Attribute Details

#access_key ⇒ Object

The public API key of your MessageBird account.



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

def access_key
  @access_key
end

#originator ⇒ Object

Sunshine Conversations will receive all messages sent to this phone number.



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

def originator
  @originator
end

#signing_key ⇒ Object

The signing key of your MessageBird account. Used to validate the webhooks’ origin.



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

def signing_key
  @signing_key
end

#type ⇒ Object

To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint. The response will include the integration’s ‘_id` and `webhookSecret`, which must be used to configure the webhook in MessageBird. In the Flow Builder for the MessageBird number you’ve used to integrate, add a new step with the following settings: - Create a new Call HTTP endpoint with SMS flow. - Select your desired SMS number for Incoming SMS. - Click on Forward to URL and set its method to POST. - Then, using the integration _id and webhookSecret returned from the create integration call, enter the following into the URL field: `app.smooch.io/api/messagebird/webhooks/appId/integrationId/webhookSecret` - Select application/json for the Set Content-Type header field. - Save and publish your changes.



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

def type
  @type
end

#webhook_secret ⇒ Object

The secret that is used to configure webhooks in MessageBird.



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

def webhook_secret
  @webhook_secret
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 30

def self.attribute_map
  {
    :'type' => :'type',
    :'access_key' => :'accessKey',
    :'signing_key' => :'signingKey',
    :'originator' => :'originator',
    :'webhook_secret' => :'webhookSecret'
  }
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



218
219
220
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 218

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



58
59
60
61
62
63
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 58

def self.openapi_all_of
  [
  :'Integration',
  :'MessagebirdAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'type' => :'String',
    :'access_key' => :'String',
    :'signing_key' => :'String',
    :'originator' => :'String',
    :'webhook_secret' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      access_key == o.access_key &&
      signing_key == o.signing_key &&
      originator == o.originator &&
      webhook_secret == o.webhook_secret && 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



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

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 316

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 225

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


205
206
207
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 211

def hash
  [type, access_key, signing_key, originator, webhook_secret].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



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

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

  if @access_key.to_s.length < 1
    invalid_properties.push('invalid value for "access_key", the character length must be great than or equal to 1.')
  end

  if @signing_key.nil?
    invalid_properties.push('invalid value for "signing_key", signing_key cannot be nil.')
  end

  if @signing_key.to_s.length < 1
    invalid_properties.push('invalid value for "signing_key", the character length must be great than or equal to 1.')
  end

  if @originator.nil?
    invalid_properties.push('invalid value for "originator", originator cannot be nil.')
  end

  if @originator.to_s.length < 1
    invalid_properties.push('invalid value for "originator", the character length must be great than or equal to 1.')
  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



292
293
294
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 292

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



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 298

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



286
287
288
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 286

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



139
140
141
142
143
144
145
146
147
 
# File 'lib/sunshine-conversations-client/models/messagebird.rb', line 139

def valid?
  return false if @access_key.nil?
  return false if @access_key.to_s.length < 1
  return false if @signing_key.nil?
  return false if @signing_key.to_s.length < 1
  return false if @originator.nil?
  return false if @originator.to_s.length < 1
  true && super
end