bandwidth-sdk 13.1.4 → 14.1.0

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

@@ -0,0 +1,304 @@
+=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 FailureWebhook
+    # User's account ID.
+    attr_accessor :account_id
+
+    # Toll-free telephone number in E.164 format.
+    attr_accessor :phone_number
+
+    # An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered.
+    attr_accessor :error_code
+
+    # A description of the error that was encountered.
+    attr_accessor :error_description
+
+    # Details of the errors that were encountered when processing the request.
+    attr_accessor :errors
+
+    # Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
+    attr_accessor :internal_ticket_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'phone_number' => :'phoneNumber',
+        :'error_code' => :'errorCode',
+        :'error_description' => :'errorDescription',
+        :'errors' => :'errors',
+        :'internal_ticket_number' => :'internalTicketNumber'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'phone_number' => :'String',
+        :'error_code' => :'String',
+        :'error_description' => :'String',
+        :'errors' => :'Array<String>',
+        :'internal_ticket_number' => :'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::FailureWebhook` 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::FailureWebhook`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'error_description')
+        self.error_description = attributes[:'error_description']
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.key?(:'internal_ticket_number')
+        self.internal_ticket_number = attributes[:'internal_ticket_number']
+      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 !@phone_number.nil? && @phone_number.to_s.length > 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 12.')
+      end
+
+      if !@phone_number.nil? && @phone_number.to_s.length < 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be great than or equal to 12.')
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if !@phone_number.nil? && @phone_number !~ pattern
+        invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
+      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 !@phone_number.nil? && @phone_number.to_s.length > 12
+      return false if !@phone_number.nil? && @phone_number.to_s.length < 12
+      return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if phone_number.nil?
+        fail ArgumentError, 'phone_number cannot be nil'
+      end
+
+      if phone_number.to_s.length > 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 12.'
+      end
+
+      if phone_number.to_s.length < 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be great than or equal to 12.'
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if phone_number !~ pattern
+        fail ArgumentError, "invalid value for \"phone_number\", must conform to the pattern #{pattern}."
+      end
+
+      @phone_number = phone_number
+    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 &&
+          account_id == o.account_id &&
+          phone_number == o.phone_number &&
+          error_code == o.error_code &&
+          error_description == o.error_description &&
+          errors == o.errors &&
+          internal_ticket_number == o.internal_ticket_number
+    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
+      [account_id, phone_number, error_code, error_description, errors, internal_ticket_number].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/{transcription_metadata.rb → links_object.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.0.0
+Generator version: 7.8.0
 
 =end
 
@@ -14,27 +14,26 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # If the recording was transcribed, metadata about the transcription
-  class TranscriptionMetadata
-    # The unique transcription ID
-    attr_accessor :id
+  class LinksObject
+    # The first (or only) page of results matching the query.
+    attr_accessor :first
 
-    # The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.
-    attr_accessor :status
+    # If more results exist than specified by 'size', this link returns the next page of 'size' results.
+    attr_accessor :_next
 
-    # The time that the transcription was completed
-    attr_accessor :completed_time
+    # If the results are more than one page, this link returns the previous page of 'size' results.
+    attr_accessor :previous
 
-    # The URL of the [transcription](#operation/getCallTranscription)
-    attr_accessor :url
+    # If more results exist than specified by 'size', this link return the last page of result.
+    attr_accessor :last
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'status' => :'status',
-        :'completed_time' => :'completedTime',
-        :'url' => :'url'
+        :'first' => :'first',
+        :'_next' => :'next',
+        :'previous' => :'previous',
+        :'last' => :'last'
       }
     end
 
@@ -46,10 +45,10 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'status' => :'String',
-        :'completed_time' => :'String',
-        :'url' => :'String'
+        :'first' => :'String',
+        :'_next' => :'String',
+        :'previous' => :'String',
+        :'last' => :'String'
       }
     end
 
@@ -63,31 +62,31 @@ 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::TranscriptionMetadata` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::LinksObject` 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::TranscriptionMetadata`. 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::LinksObject`. 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']
+      if attributes.key?(:'first')
+        self.first = attributes[:'first']
       end
 
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'_next')
+        self._next = attributes[:'_next']
       end
 
-      if attributes.key?(:'completed_time')
-        self.completed_time = attributes[:'completed_time']
+      if attributes.key?(:'previous')
+        self.previous = attributes[:'previous']
       end
 
-      if attributes.key?(:'url')
-        self.url = attributes[:'url']
+      if attributes.key?(:'last')
+        self.last = attributes[:'last']
       end
     end
 
@@ -111,10 +110,10 @@ module Bandwidth
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          status == o.status &&
-          completed_time == o.completed_time &&
-          url == o.url
+          first == o.first &&
+          _next == o._next &&
+          previous == o.previous &&
+          last == o.last
     end
 
     # @see the `==` method
@@ -126,7 +125,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, status, completed_time, url].hash
+      [first, _next, previous, last].hash
     end
 
     # Builds the object from hash
@@ -191,7 +190,7 @@ module Bandwidth
       else # model
         # models (e.g. Pet) or oneOf
         klass = Bandwidth.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

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

@@ -14,20 +14,44 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Message Failed Callback
-  class MessageFailedCallback
+  # Message Callback Schema
+  class MessageCallback
     attr_accessor :time
 
     attr_accessor :type
 
     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
 
+    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
       {
@@ -49,10 +73,10 @@ module Bandwidth
     def self.openapi_types
       {
         :'time' => :'Time',
-        :'type' => :'String',
+        :'type' => :'CallbackTypeEnum',
         :'to' => :'String',
         :'description' => :'String',
-        :'message' => :'MessageFailedCallbackMessage',
+        :'message' => :'MessageCallbackMessage',
         :'error_code' => :'Integer'
       }
     end
@@ -60,6 +84,7 @@ module Bandwidth
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'error_code'
       ])
     end
 
@@ -67,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::MessageFailedCallback` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MessageCallback` 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::MessageFailedCallback`. 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::MessageCallback`. 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
       }
@@ -110,8 +135,6 @@ module Bandwidth
 
       if attributes.key?(:'error_code')
         self.error_code = attributes[:'error_code']
-      else
-        self.error_code = nil
       end
     end
 
@@ -140,10 +163,6 @@ module Bandwidth
         invalid_properties.push('invalid value for "message", message cannot be nil.')
       end
 
-      if @error_code.nil?
-        invalid_properties.push('invalid value for "error_code", error_code cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -156,7 +175,6 @@ module Bandwidth
       return false if @to.nil?
       return false if @description.nil?
       return false if @message.nil?
-      return false if @error_code.nil?
       true
     end
 

data/lib/bandwidth-sdk/models/{inbound_message_callback_message.rb → message_callback_message.rb}

@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  # Inbound Message Callback Message Schema
-  class InboundMessageCallbackMessage
+  # Message payload schema within a MessageCallback
+  class MessageCallbackMessage
     attr_accessor :id
 
     attr_accessor :owner
@@ -36,6 +36,7 @@ module Bandwidth
 
     attr_accessor :tag
 
+    # Optional media, applicable only for mms
     attr_accessor :media
 
     attr_accessor :priority
@@ -106,6 +107,7 @@ module Bandwidth
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'media',
       ])
     end
 
@@ -113,13 +115,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::InboundMessageCallbackMessage` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MessageCallbackMessage` 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::InboundMessageCallbackMessage`. 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::MessageCallbackMessage`. 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
       }