class SunshineConversationsClient::Messagebird

Attributes

access_key[RW]

The public API key of your MessageBird account.

originator[RW]

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

signing_key[RW]

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

type[RW]

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.

webhook_secret[RW]

The secret that is used to configure webhooks in MessageBird.

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/messagebird.rb, line 218
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/sunshine-conversations-client/models/messagebird.rb, line 58
def self.openapi_all_of
  [
  :'Integration',
  :'MessagebirdAllOf'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/sunshine-conversations-client/models/messagebird.rb, line 52
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

Calls superclass method SunshineConversationsClient::Integration#==
# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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
access_key=(access_key) click to toggle source

Custom attribute writer method with validation @param [Object] access_key Value to be assigned

# File lib/sunshine-conversations-client/models/messagebird.rb, line 151
def access_key=(access_key)
  if access_key.nil?
    fail ArgumentError, 'access_key cannot be nil'
  end

  if access_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "access_key", the character length must be great than or equal to 1.'
  end

  @access_key = access_key
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/messagebird.rb, line 205
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
originator=(originator) click to toggle source

Custom attribute writer method with validation @param [Object] originator Value to be assigned

# File lib/sunshine-conversations-client/models/messagebird.rb, line 179
def originator=(originator)
  if originator.nil?
    fail ArgumentError, 'originator cannot be nil'
  end

  if originator.to_s.length < 1
    fail ArgumentError, 'invalid value for "originator", the character length must be great than or equal to 1.'
  end

  @originator = originator
end
signing_key=(signing_key) click to toggle source

Custom attribute writer method with validation @param [Object] signing_key Value to be assigned

# File lib/sunshine-conversations-client/models/messagebird.rb, line 165
def signing_key=(signing_key)
  if signing_key.nil?
    fail ArgumentError, 'signing_key cannot be nil'
  end

  if signing_key.to_s.length < 1
    fail ArgumentError, 'invalid value for "signing_key", the character length must be great than or equal to 1.'
  end

  @signing_key = signing_key
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/messagebird.rb, line 292
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sunshine-conversations-client/models/messagebird.rb, line 286
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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