bandwidth-sdk 15.1.0 → 16.0.0

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

@@ -0,0 +1,338 @@
+=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
+  # Represents a status callback for an outbound MT SMS or MMS or RBM message.
+  class StatusCallback
+    attr_accessor :time
+
+    # Represents the time at which the message was read, for `message-read` callbacks.
+    attr_accessor :event_time
+
+    attr_accessor :type
+
+    # The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user's client phone number.
+    attr_accessor :to
+
+    # A detailed description of the event described by the callback.
+    attr_accessor :description
+
+    attr_accessor :message
+
+    # Optional error code, applicable only when type is `message-failed`.
+    attr_accessor :error_code
+
+    # The name of the Authorized Message Provider (AMP) that handled this message.  In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled.
+    attr_accessor :carrier_name
+
+    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
+      {
+        :'time' => :'time',
+        :'event_time' => :'eventTime',
+        :'type' => :'type',
+        :'to' => :'to',
+        :'description' => :'description',
+        :'message' => :'message',
+        :'error_code' => :'errorCode',
+        :'carrier_name' => :'carrierName'
+      }
+    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
+      {
+        :'time' => :'Time',
+        :'event_time' => :'Time',
+        :'type' => :'StatusCallbackTypeEnum',
+        :'to' => :'String',
+        :'description' => :'String',
+        :'message' => :'StatusCallbackMessage',
+        :'error_code' => :'Integer',
+        :'carrier_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::StatusCallback` 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::StatusCallback`. 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?(:'time')
+        self.time = attributes[:'time']
+      else
+        self.time = nil
+      end
+
+      if attributes.key?(:'event_time')
+        self.event_time = attributes[:'event_time']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'carrier_name')
+        self.carrier_name = attributes[:'carrier_name']
+      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 @time.nil?
+        invalid_properties.push('invalid value for "time", time cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @time.nil?
+      return false if @type.nil?
+      return false if @to.nil?
+      return false if @description.nil?
+      return false if @message.nil?
+      true
+    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 &&
+          time == o.time &&
+          event_time == o.event_time &&
+          type == o.type &&
+          to == o.to &&
+          description == o.description &&
+          message == o.message &&
+          error_code == o.error_code &&
+          carrier_name == o.carrier_name
+    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
+      [time, event_time, type, to, description, message, error_code, carrier_name].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/{message_callback_message.rb → status_callback_message.rb}

@@ -14,33 +14,42 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message payload schema within a MessageCallback
-  class MessageCallbackMessage
+  # Message payload schema within a callback
+  class StatusCallbackMessage
+    # 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, applicable only for mms
+    # Optional media, not applicable for sms
     attr_accessor :media
 
     attr_accessor :priority
 
+    attr_accessor :channel
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -77,7 +86,8 @@ module Bandwidth
         :'text' => :'text',
         :'tag' => :'tag',
         :'media' => :'media',
-        :'priority' => :'priority'
+        :'priority' => :'priority',
+        :'channel' => :'channel'
       }
     end
 
@@ -100,14 +110,14 @@ module Bandwidth
         :'text' => :'String',
         :'tag' => :'String',
         :'media' => :'Array<String>',
-        :'priority' => :'PriorityEnum'
+        :'priority' => :'PriorityEnum',
+        :'channel' => :'MultiChannelMessageChannelEnum'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'media',
       ])
     end
 
@@ -115,13 +125,13 @@ module Bandwidth
     # @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::MessageCallbackMessage` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::StatusCallbackMessage` 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::MessageCallbackMessage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::StatusCallbackMessage`. 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
       }
@@ -178,8 +188,6 @@ module Bandwidth
 
       if attributes.key?(:'text')
         self.text = attributes[:'text']
-      else
-        self.text = nil
       end
 
       if attributes.key?(:'tag')
@@ -195,6 +203,10 @@ module Bandwidth
       if attributes.key?(:'priority')
         self.priority = attributes[:'priority']
       end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -234,10 +246,6 @@ module Bandwidth
         invalid_properties.push('invalid value for "from", from cannot be nil.')
       end
 
-      if @text.nil?
-        invalid_properties.push('invalid value for "text", text cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -253,7 +261,6 @@ module Bandwidth
       return false if @direction.nil?
       return false if @to.nil?
       return false if @from.nil?
-      return false if @text.nil?
       true
     end
 
@@ -283,7 +290,8 @@ module Bandwidth
           text == o.text &&
           tag == o.tag &&
           media == o.media &&
-          priority == o.priority
+          priority == o.priority &&
+          channel == o.channel
     end
 
     # @see the `==` method
@@ -295,7 +303,7 @@ module Bandwidth
     # 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].hash
+      [id, owner, application_id, time, segment_count, direction, to, from, text, tag, media, priority, channel].hash
     end
 
     # Builds the object from hash

data/lib/bandwidth-sdk/models/{callback_type_enum.rb → status_callback_type_enum.rb}

@@ -14,14 +14,14 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class CallbackTypeEnum
-    RECEIVED = 'message-received'.freeze
+  class StatusCallbackTypeEnum
     SENDING = 'message-sending'.freeze
     DELIVERED = 'message-delivered'.freeze
     FAILED = 'message-failed'.freeze
+    READ = 'message-read'.freeze
 
     def self.all_vars
-      @all_vars ||= [RECEIVED, SENDING, DELIVERED, FAILED].freeze
+      @all_vars ||= [SENDING, DELIVERED, FAILED, READ].freeze
     end
 
     # Builds the enum from string
@@ -35,8 +35,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 CallbackTypeEnum.all_vars.include?(value)
-      raise "Invalid ENUM value #{value} for class #CallbackTypeEnum"
+      return value if StatusCallbackTypeEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #StatusCallbackTypeEnum"
     end
   end
 end

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

@@ -37,10 +37,10 @@ module Bandwidth
 
     attr_accessor :submission
 
-    # Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    # Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
     attr_accessor :blocked
 
-    # The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    # The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
     attr_accessor :blocked_reason
 
     class EnumAttributeValidator

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

@@ -39,13 +39,13 @@ module Bandwidth
     # ISV name.
     attr_accessor :isv_reseller
 
-    # The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request privacy policy URL.
     attr_accessor :privacy_policy_url
 
-    # The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request terms and conditions policy URL.
     attr_accessor :terms_and_conditions_url
 
-    # The company 'Doing Business As'. (Not Available Until 5/28/2025)
+    # The company 'Doing Business As'.
     attr_accessor :business_dba
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -38,10 +38,10 @@ module Bandwidth
 
     attr_accessor :status
 
-    # Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    # Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
     attr_accessor :blocked
 
-    # The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    # The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.
     attr_accessor :blocked_reason
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -41,13 +41,13 @@ module Bandwidth
     # ISV name.
     attr_accessor :isv_reseller
 
-    # The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request privacy policy URL.
     attr_accessor :privacy_policy_url
 
-    # The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request terms and conditions policy URL.
     attr_accessor :terms_and_conditions_url
 
-    # The company 'Doing Business As'. (Not Available Until 5/28/2025)
+    # The company 'Doing Business As'.
     attr_accessor :business_dba
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -39,13 +39,13 @@ module Bandwidth
     # ISV name.
     attr_accessor :isv_reseller
 
-    # The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request privacy policy URL.
     attr_accessor :privacy_policy_url
 
-    # The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
+    # The Toll-Free Verification request terms and conditions policy URL.
     attr_accessor :terms_and_conditions_url
 
-    # The company 'Doing Business As'. (Not Available Until 5/28/2025)
+    # The company 'Doing Business As'.
     attr_accessor :business_dba
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/bandwidth-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.8.0
 =end
 
 module Bandwidth
-  VERSION = '15.1.0'
+  VERSION = '16.0.0'
 end