bandwidth-sdk 15.1.0 → 16.0.0

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

@@ -0,0 +1,244 @@
+=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
+  # Specifies relevant sources of the error, if any.
+  class ErrorSource
+    # The relevant URI query parameter causing the error
+    attr_accessor :parameter
+
+    # The request body field that led to the error
+    attr_accessor :field
+
+    # The header field that contributed to the error
+    attr_accessor :header
+
+    # A resource ID or path linked to the error
+    attr_accessor :reference
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'parameter' => :'parameter',
+        :'field' => :'field',
+        :'header' => :'header',
+        :'reference' => :'reference'
+      }
+    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
+      {
+        :'parameter' => :'String',
+        :'field' => :'String',
+        :'header' => :'String',
+        :'reference' => :'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::ErrorSource` 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::ErrorSource`. 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?(:'parameter')
+        self.parameter = attributes[:'parameter']
+      end
+
+      if attributes.key?(:'field')
+        self.field = attributes[:'field']
+      end
+
+      if attributes.key?(:'header')
+        self.header = attributes[:'header']
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      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
+      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'
+      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 &&
+          parameter == o.parameter &&
+          field == o.field &&
+          header == o.header &&
+          reference == o.reference
+    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
+      [parameter, field, header, reference].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/failure_webhook.rb

@@ -25,7 +25,7 @@ module Bandwidth
     attr_accessor :error_code
 
     # A description of the error that was encountered.
-    attr_accessor :error_description
+    attr_accessor :error_message
 
     # Details of the errors that were encountered when processing the request.
     attr_accessor :errors
@@ -39,7 +39,7 @@ module Bandwidth
         :'account_id' => :'accountId',
         :'phone_number' => :'phoneNumber',
         :'error_code' => :'errorCode',
-        :'error_description' => :'errorDescription',
+        :'error_message' => :'errorMessage',
         :'errors' => :'errors',
         :'internal_ticket_number' => :'internalTicketNumber'
       }
@@ -56,7 +56,7 @@ module Bandwidth
         :'account_id' => :'String',
         :'phone_number' => :'String',
         :'error_code' => :'String',
-        :'error_description' => :'String',
+        :'error_message' => :'String',
         :'errors' => :'Array<String>',
         :'internal_ticket_number' => :'String'
       }
@@ -95,8 +95,8 @@ module Bandwidth
         self.error_code = attributes[:'error_code']
       end
 
-      if attributes.key?(:'error_description')
-        self.error_description = attributes[:'error_description']
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
       end
 
       if attributes.key?(:'errors')
@@ -172,7 +172,7 @@ module Bandwidth
           account_id == o.account_id &&
           phone_number == o.phone_number &&
           error_code == o.error_code &&
-          error_description == o.error_description &&
+          error_message == o.error_message &&
           errors == o.errors &&
           internal_ticket_number == o.internal_ticket_number
     end
@@ -186,7 +186,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, phone_number, error_code, error_description, errors, internal_ticket_number].hash
+      [account_id, phone_number, error_code, error_message, errors, internal_ticket_number].hash
     end
 
     # Builds the object from hash

data/lib/bandwidth-sdk/models/{message_callback.rb → inbound_callback.rb}

@@ -14,12 +14,13 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message Callback Schema
-  class MessageCallback
+  # Represents an inbound callback.
+  class InboundCallback
     attr_accessor :time
 
     attr_accessor :type
 
+    # The destination phone number the message was sent to.  For inbound callbacks, this is the Bandwidth number or alphanumeric identifier that received the message. 
     attr_accessor :to
 
     # A detailed description of the event described by the callback.
@@ -27,10 +28,7 @@ module Bandwidth
 
     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.
+    # 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
@@ -63,7 +61,6 @@ module Bandwidth
         :'to' => :'to',
         :'description' => :'description',
         :'message' => :'message',
-        :'error_code' => :'errorCode',
         :'carrier_name' => :'carrierName'
       }
     end
@@ -77,11 +74,10 @@ module Bandwidth
     def self.openapi_types
       {
         :'time' => :'Time',
-        :'type' => :'CallbackTypeEnum',
+        :'type' => :'InboundCallbackTypeEnum',
         :'to' => :'String',
         :'description' => :'String',
-        :'message' => :'MessageCallbackMessage',
-        :'error_code' => :'Integer',
+        :'message' => :'InboundCallbackMessage',
         :'carrier_name' => :'String'
       }
     end
@@ -89,8 +85,6 @@ module Bandwidth
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'error_code',
-        :'carrier_name'
       ])
     end
 
@@ -98,13 +92,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::MessageCallback` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::InboundCallback` 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::MessageCallback`. 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::InboundCallback`. 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
       }
@@ -139,10 +133,6 @@ module Bandwidth
         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
@@ -198,7 +188,6 @@ module Bandwidth
           to == o.to &&
           description == o.description &&
           message == o.message &&
-          error_code == o.error_code &&
           carrier_name == o.carrier_name
     end
 
@@ -211,7 +200,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [time, type, to, description, message, error_code, carrier_name].hash
+      [time, type, to, description, message, carrier_name].hash
     end
 
     # Builds the object from hash