bandwidth-sdk 16.2.2 → 17.0.1

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

@@ -16,45 +16,72 @@ require 'time'
 module Bandwidth
   # Carrier information results for the specified telephone number.
   class LookupResult
-    # Our vendor's response code.
-    attr_accessor :response_code
+    # The telephone number in E.164 format.
+    attr_accessor :phone_number
 
-    # Message associated with the response code.
-    attr_accessor :message
+    attr_accessor :line_type
 
-    # The telephone number in E.164 format.
-    attr_accessor :e_164_format
+    # The messaging service provider of the telephone number.
+    attr_accessor :messaging_provider
 
-    # The formatted version of the telephone number.
-    attr_accessor :formatted
+    # The voice service provider of the telephone number.
+    attr_accessor :voice_provider
 
-    # The country of the telephone number.
-    attr_accessor :country
+    # The country code of the telephone number in ISO 3166-1 alpha-3 format.
+    attr_accessor :country_code_a3
 
-    # The line type of the telephone number.
-    attr_accessor :line_type
+    # [DNI-Only](#section/DNI-Only). The carrier that reported a deactivation event for this phone number. 
+    attr_accessor :deactivation_reporter
 
-    # The messaging service provider of the telephone number.
-    attr_accessor :line_provider
+    # [DNI-Only](#section/DNI-Only). The datetime the carrier reported a deactivation event.
+    attr_accessor :deactivation_date
 
-    # The first half of the Home Network Identity (HNI).
-    attr_accessor :mobile_country_code
+    attr_accessor :deactivation_event
+
+    attr_accessor :latest_message_delivery_status
+
+    # [DNI-Only](#section/DNI-Only). The date the phone number entered the status described in `latestMessageDeliveryStatus`.  Think of this as the \"start time\" for that status. Value resets every time the `latestMessageDeliveryStatus` changes.
+    attr_accessor :initial_message_delivery_status_date
+
+    # [DNI-Only](#section/DNI-Only). The date bandwidth last received delivery status information for this phone number.  Use this field to understand how up-to-date the `latestMessageDeliveryStatus` is. Value resets every time the `latestMessageDeliveryStatus` changes.
+    attr_accessor :latest_message_delivery_status_date
+
+    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
 
-    # The second half of the HNI.
-    attr_accessor :mobile_network_code
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'response_code' => :'Response Code',
-        :'message' => :'Message',
-        :'e_164_format' => :'E.164 Format',
-        :'formatted' => :'Formatted',
-        :'country' => :'Country',
-        :'line_type' => :'Line Type',
-        :'line_provider' => :'Line Provider',
-        :'mobile_country_code' => :'Mobile Country Code',
-        :'mobile_network_code' => :'Mobile Network Code'
+        :'phone_number' => :'phoneNumber',
+        :'line_type' => :'lineType',
+        :'messaging_provider' => :'messagingProvider',
+        :'voice_provider' => :'voiceProvider',
+        :'country_code_a3' => :'countryCodeA3',
+        :'deactivation_reporter' => :'deactivationReporter',
+        :'deactivation_date' => :'deactivationDate',
+        :'deactivation_event' => :'deactivationEvent',
+        :'latest_message_delivery_status' => :'latestMessageDeliveryStatus',
+        :'initial_message_delivery_status_date' => :'initialMessageDeliveryStatusDate',
+        :'latest_message_delivery_status_date' => :'latestMessageDeliveryStatusDate'
       }
     end
 
@@ -66,15 +93,17 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'response_code' => :'Integer',
-        :'message' => :'String',
-        :'e_164_format' => :'String',
-        :'formatted' => :'String',
-        :'country' => :'String',
-        :'line_type' => :'String',
-        :'line_provider' => :'String',
-        :'mobile_country_code' => :'String',
-        :'mobile_network_code' => :'String'
+        :'phone_number' => :'String',
+        :'line_type' => :'LineTypeEnum',
+        :'messaging_provider' => :'String',
+        :'voice_provider' => :'String',
+        :'country_code_a3' => :'String',
+        :'deactivation_reporter' => :'String',
+        :'deactivation_date' => :'String',
+        :'deactivation_event' => :'DeactivationEventEnum',
+        :'latest_message_delivery_status' => :'LatestMessageDeliveryStatusEnum',
+        :'initial_message_delivery_status_date' => :'Date',
+        :'latest_message_delivery_status_date' => :'Date'
       }
     end
 
@@ -99,40 +128,48 @@ module Bandwidth
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'response_code')
-        self.response_code = attributes[:'response_code']
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'line_type')
+        self.line_type = attributes[:'line_type']
       end
 
-      if attributes.key?(:'message')
-        self.message = attributes[:'message']
+      if attributes.key?(:'messaging_provider')
+        self.messaging_provider = attributes[:'messaging_provider']
       end
 
-      if attributes.key?(:'e_164_format')
-        self.e_164_format = attributes[:'e_164_format']
+      if attributes.key?(:'voice_provider')
+        self.voice_provider = attributes[:'voice_provider']
       end
 
-      if attributes.key?(:'formatted')
-        self.formatted = attributes[:'formatted']
+      if attributes.key?(:'country_code_a3')
+        self.country_code_a3 = attributes[:'country_code_a3']
       end
 
-      if attributes.key?(:'country')
-        self.country = attributes[:'country']
+      if attributes.key?(:'deactivation_reporter')
+        self.deactivation_reporter = attributes[:'deactivation_reporter']
       end
 
-      if attributes.key?(:'line_type')
-        self.line_type = attributes[:'line_type']
+      if attributes.key?(:'deactivation_date')
+        self.deactivation_date = attributes[:'deactivation_date']
+      end
+
+      if attributes.key?(:'deactivation_event')
+        self.deactivation_event = attributes[:'deactivation_event']
       end
 
-      if attributes.key?(:'line_provider')
-        self.line_provider = attributes[:'line_provider']
+      if attributes.key?(:'latest_message_delivery_status')
+        self.latest_message_delivery_status = attributes[:'latest_message_delivery_status']
       end
 
-      if attributes.key?(:'mobile_country_code')
-        self.mobile_country_code = attributes[:'mobile_country_code']
+      if attributes.key?(:'initial_message_delivery_status_date')
+        self.initial_message_delivery_status_date = attributes[:'initial_message_delivery_status_date']
       end
 
-      if attributes.key?(:'mobile_network_code')
-        self.mobile_network_code = attributes[:'mobile_network_code']
+      if attributes.key?(:'latest_message_delivery_status_date')
+        self.latest_message_delivery_status_date = attributes[:'latest_message_delivery_status_date']
       end
     end
 
@@ -156,15 +193,17 @@ module Bandwidth
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          response_code == o.response_code &&
-          message == o.message &&
-          e_164_format == o.e_164_format &&
-          formatted == o.formatted &&
-          country == o.country &&
+          phone_number == o.phone_number &&
           line_type == o.line_type &&
-          line_provider == o.line_provider &&
-          mobile_country_code == o.mobile_country_code &&
-          mobile_network_code == o.mobile_network_code
+          messaging_provider == o.messaging_provider &&
+          voice_provider == o.voice_provider &&
+          country_code_a3 == o.country_code_a3 &&
+          deactivation_reporter == o.deactivation_reporter &&
+          deactivation_date == o.deactivation_date &&
+          deactivation_event == o.deactivation_event &&
+          latest_message_delivery_status == o.latest_message_delivery_status &&
+          initial_message_delivery_status_date == o.initial_message_delivery_status_date &&
+          latest_message_delivery_status_date == o.latest_message_delivery_status_date
     end
 
     # @see the `==` method
@@ -176,7 +215,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [response_code, message, e_164_format, formatted, country, line_type, line_provider, mobile_country_code, mobile_network_code].hash
+      [phone_number, line_type, messaging_provider, voice_provider, country_code_a3, deactivation_reporter, deactivation_date, deactivation_event, latest_message_delivery_status, initial_message_delivery_status_date, latest_message_delivery_status_date].hash
     end
 
     # Builds the object from hash

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

@@ -16,8 +16,8 @@ require 'time'
 module Bandwidth
   module MultiChannelAction
     class << self
-      # List of class defined in oneOf (OpenAPI v3)
-      def openapi_one_of
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
         [
           :'MultiChannelActionCalendarEvent',
           :'RbmActionBase',
@@ -27,35 +27,80 @@ module Bandwidth
         ]
       end
 
-      # Discriminator's property name (OpenAPI v3)
-      def openapi_discriminator_name
-        :'type'
-      end
-
-      # Discriminator's mapping (OpenAPI v3)
-      def openapi_discriminator_mapping
-        {
-          :'CREATE_CALENDAR_EVENT' => :'MultiChannelActionCalendarEvent',
-          :'DIAL_PHONE' => :'RbmActionDial',
-          :'OPEN_URL' => :'RbmActionOpenUrl',
-          :'REPLY' => :'RbmActionBase',
-          :'REQUEST_LOCATION' => :'RbmActionBase',
-          :'SHOW_LOCATION' => :'RbmActionViewLocation'
-        }
-      end
-
       # Builds the object
-      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @param [Mixed] Data to be matched against the list of anyOf items
       # @return [Object] Returns the model or the data itself
       def build(data)
-        discriminator_value = data[openapi_discriminator_name]
-        return nil if discriminator_value.nil?
-
-        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
-        return nil unless klass
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
 
-        Bandwidth.const_get(klass).build_from_hash(data)
+        openapi_any_of.include?(:AnyType) ? data : nil
       end
+
+      private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when 'Boolean'
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when 'Float'
+            return data if data.instance_of?(Float)
+          when 'Integer'
+            return data if data.instance_of?(Integer)
+          when 'Time'
+            return Time.parse(data)
+          when 'Date'
+            return Date.parse(data)
+          when 'String'
+            return data if data.instance_of?(String)
+          when 'Object' # "type: object"
+            return data if data.instance_of?(Hash)
+          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+          else # model
+            const = Bandwidth.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_any_of) # nested anyOf model
+                model = const.build(data)
+                return model if model
+              else
+                # raise if data contains keys that are not known to the model
+                raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+                model = const.build_from_hash(data)
+                return model if model
+              end
+            end
+          end
+
+          raise # if no match by now, raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
     end
   end
 end

data/lib/bandwidth-sdk/models/{multi_channel_channel_list_object.rb → multi_channel_channel_list_mms_object.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class MultiChannelChannelListObject
+  class MultiChannelChannelListMMSObject
     # The sender ID of the message. This could be an alphanumeric sender ID.
     attr_accessor :from
 
@@ -68,7 +68,7 @@ module Bandwidth
         :'from' => :'String',
         :'application_id' => :'String',
         :'channel' => :'MultiChannelMessageChannelEnum',
-        :'content' => :'MultiChannelChannelListObjectContent'
+        :'content' => :'MmsMessageContent'
       }
     end
 
@@ -78,17 +78,24 @@ module Bandwidth
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'MultiChannelChannelListObjectBase'
+      ]
+    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::MultiChannelChannelListObject` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MultiChannelChannelListMMSObject` 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::MultiChannelChannelListObject`. 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::MultiChannelChannelListMMSObject`. 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
       }

data/lib/bandwidth-sdk/models/{multi_channel_message_response_data_channel_list_inner.rb → multi_channel_channel_list_mms_response_object.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class MultiChannelMessageResponseDataChannelListInner
+  class MultiChannelChannelListMMSResponseObject
     # The sender ID of the message. This could be an alphanumeric sender ID.
     attr_accessor :from
 
@@ -72,7 +72,7 @@ module Bandwidth
         :'from' => :'String',
         :'application_id' => :'String',
         :'channel' => :'MultiChannelMessageChannelEnum',
-        :'content' => :'MultiChannelChannelListObjectContent',
+        :'content' => :'MmsMessageContent',
         :'owner' => :'String'
       }
     end
@@ -86,7 +86,8 @@ module Bandwidth
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'MultiChannelChannelListObject'
+      :'MultiChannelChannelListMMSObject',
+      :'MultiChannelChannelListOwnerObject'
       ]
     end
 
@@ -94,13 +95,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::MultiChannelMessageResponseDataChannelListInner` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MultiChannelChannelListMMSResponseObject` 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::MultiChannelMessageResponseDataChannelListInner`. 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::MultiChannelChannelListMMSResponseObject`. 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
       }