bandwidth-sdk 15.1.0 → 16.0.0

data/lib/bandwidth-sdk/models/inbound_callback_message.rb

@@ -0,0 +1,454 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class InboundCallbackMessage
+    # A unique identifier of the message.
+    attr_accessor :id
+
+    # The Bandwidth phone number or alphanumeric identifier associated with the message.
+    attr_accessor :owner
+
+    # The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
+    attr_accessor :application_id
+
+    attr_accessor :time
+
+    # The number of segments the user's message is broken into before sending over carrier networks.
+    attr_accessor :segment_count
+
+    attr_accessor :direction
+
+    # The phone number recipients of the message.
+    attr_accessor :to
+
+    # The Bandwidth phone number or alphanumeric identifier the message was sent from.
+    attr_accessor :from
+
+    attr_accessor :text
+
+    # A custom string that will be included in callback events of the message. Max 1024 characters.
+    attr_accessor :tag
+
+    # Optional media, not applicable for sms
+    attr_accessor :media
+
+    attr_accessor :priority
+
+    attr_accessor :channel
+
+    attr_accessor :content
+
+    attr_accessor :suggestion_response
+
+    attr_accessor :location_response
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'owner' => :'owner',
+        :'application_id' => :'applicationId',
+        :'time' => :'time',
+        :'segment_count' => :'segmentCount',
+        :'direction' => :'direction',
+        :'to' => :'to',
+        :'from' => :'from',
+        :'text' => :'text',
+        :'tag' => :'tag',
+        :'media' => :'media',
+        :'priority' => :'priority',
+        :'channel' => :'channel',
+        :'content' => :'content',
+        :'suggestion_response' => :'suggestionResponse',
+        :'location_response' => :'locationResponse'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'owner' => :'String',
+        :'application_id' => :'String',
+        :'time' => :'Time',
+        :'segment_count' => :'Integer',
+        :'direction' => :'MessageDirectionEnum',
+        :'to' => :'Array<String>',
+        :'from' => :'String',
+        :'text' => :'String',
+        :'tag' => :'String',
+        :'media' => :'Array<String>',
+        :'priority' => :'PriorityEnum',
+        :'channel' => :'MultiChannelMessageChannelEnum',
+        :'content' => :'MultiChannelMessageContent',
+        :'suggestion_response' => :'RbmSuggestionResponse',
+        :'location_response' => :'RbmLocationResponse'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'StatusCallbackMessage'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::InboundCallbackMessage` 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 `Bandwidth::InboundCallbackMessage`. 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
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'owner')
+        self.owner = attributes[:'owner']
+      else
+        self.owner = nil
+      end
+
+      if attributes.key?(:'application_id')
+        self.application_id = attributes[:'application_id']
+      else
+        self.application_id = nil
+      end
+
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      else
+        self.time = nil
+      end
+
+      if attributes.key?(:'segment_count')
+        self.segment_count = attributes[:'segment_count']
+      else
+        self.segment_count = nil
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      else
+        self.direction = nil
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      else
+        self.from = nil
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'media')
+        if (value = attributes[:'media']).is_a?(Array)
+          self.media = value
+        end
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'suggestion_response')
+        self.suggestion_response = attributes[:'suggestion_response']
+      end
+
+      if attributes.key?(:'location_response')
+        self.location_response = attributes[:'location_response']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @owner.nil?
+        invalid_properties.push('invalid value for "owner", owner cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @time.nil?
+        invalid_properties.push('invalid value for "time", time cannot be nil.')
+      end
+
+      if @segment_count.nil?
+        invalid_properties.push('invalid value for "segment_count", segment_count cannot be nil.')
+      end
+
+      if @direction.nil?
+        invalid_properties.push('invalid value for "direction", direction cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @owner.nil?
+      return false if @application_id.nil?
+      return false if @time.nil?
+      return false if @segment_count.nil?
+      return false if @direction.nil?
+      return false if @to.nil?
+      return false if @from.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          owner == o.owner &&
+          application_id == o.application_id &&
+          time == o.time &&
+          segment_count == o.segment_count &&
+          direction == o.direction &&
+          to == o.to &&
+          from == o.from &&
+          text == o.text &&
+          tag == o.tag &&
+          media == o.media &&
+          priority == o.priority &&
+          channel == o.channel &&
+          content == o.content &&
+          suggestion_response == o.suggestion_response &&
+          location_response == o.location_response
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, owner, application_id, time, segment_count, direction, to, from, text, tag, media, priority, channel, content, suggestion_response, location_response].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Bandwidth.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      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
+
+    # 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
+    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
+  end
+end

data/lib/bandwidth-sdk/models/{multi_channel_message_direction_enum.rb → inbound_callback_type_enum.rb}

@@ -14,12 +14,13 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class MultiChannelMessageDirectionEnum
-    INBOUND = 'INBOUND'.freeze
-    OUTBOUND = 'OUTBOUND'.freeze
+  class InboundCallbackTypeEnum
+    MESSAGE_RECEIVED = 'message-received'.freeze
+    REQUEST_LOCATION_RESPONSE = 'request-location-response'.freeze
+    SUGGESTION_RESPONSE = 'suggestion-response'.freeze
 
     def self.all_vars
-      @all_vars ||= [INBOUND, OUTBOUND].freeze
+      @all_vars ||= [MESSAGE_RECEIVED, REQUEST_LOCATION_RESPONSE, SUGGESTION_RESPONSE].freeze
     end
 
     # Builds the enum from string
@@ -33,8 +34,8 @@ module Bandwidth
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      return value if MultiChannelMessageDirectionEnum.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #MultiChannelMessageDirectionEnum"
+      return value if InboundCallbackTypeEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #InboundCallbackTypeEnum"
     end
   end
 end

data/lib/bandwidth-sdk/models/list_message_item.rb

@@ -33,7 +33,7 @@ module Bandwidth
 
     attr_accessor :message_type
 
-    # The number of segments the message was sent as.
+    # The number of segments the user's message is broken into before sending over carrier networks.
     attr_accessor :segment_count
 
     # The numeric error code of the message.

data/lib/bandwidth-sdk/models/message.rb

@@ -21,13 +21,13 @@ module Bandwidth
     # The Bandwidth phone number associated with the message.
     attr_accessor :owner
 
-    # The application ID associated with the message.
+    # The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
     attr_accessor :application_id
 
     # The datetime stamp of the message in ISO 8601
     attr_accessor :time
 
-    # The number of segments the original message from the user is broken into before sending over to carrier networks.
+    # The number of segments the user's message is broken into before sending over carrier networks.
     attr_accessor :segment_count
 
     attr_accessor :direction
@@ -44,7 +44,7 @@ module Bandwidth
     # The contents of the message.
     attr_accessor :text
 
-    # The custom string set by the user.
+    # A custom string that will be included in callback events of the message. Max 1024 characters.
     attr_accessor :tag
 
     attr_accessor :priority

data/lib/bandwidth-sdk/models/message_request.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module Bandwidth
   class MessageRequest
-    # The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard.
+    # The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
     attr_accessor :application_id
 
     # The phone number(s) the message should be sent to in E164 format.

data/lib/bandwidth-sdk/models/mms_message_content.rb

@@ -18,7 +18,6 @@ module Bandwidth
     # The contents of the text message. Must be 2048 characters or less.
     attr_accessor :text
 
-    # A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters.
     attr_accessor :media
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,7 +37,7 @@ module Bandwidth
     def self.openapi_types
       {
         :'text' => :'String',
-        :'media' => :'Array<String>'
+        :'media' => :'Array<MmsMessageContentFile>'
       }
     end