bandwidth-sdk 5.0.0 → 7.0.0

data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb

@@ -32,6 +32,12 @@ module Bandwidth
     # @return [String]
     attr_accessor :tag
 
+    # The message's priority, currently for toll-free or short code SMS only.
+    # Messages with a priority value of `"high"` are given preference over your
+    # other traffic.
+    # @return [PriorityEnum]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -41,6 +47,7 @@ module Bandwidth
       @_hash['text'] = 'text'
       @_hash['media'] = 'media'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -49,13 +56,15 @@ module Bandwidth
                    from = nil,
                    text = nil,
                    media = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @application_id = application_id
       @to = to
       @from = from
       @text = text
       @media = media
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -69,6 +78,7 @@ module Bandwidth
       text = hash['text']
       media = hash['media']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       MessageRequest.new(application_id,
@@ -76,7 +86,8 @@ module Bandwidth
                          from,
                          text,
                          media,
-                         tag)
+                         tag,
+                         priority)
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/priority_enum.rb

@@ -0,0 +1,19 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # The message's priority, currently for toll-free or short code SMS only.
+  # Messages with a priority value of `"high"` are given preference over your
+  # other traffic.
+  class PriorityEnum
+    PRIORITY_ENUM = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze
+    ].freeze
+  end
+end

data/lib/bandwidth/models/base_model.rb

@@ -13,15 +13,26 @@ module Bandwidth
         value = instance_variable_get(name)
         name = name[1..-1]
         key = self.class.names.key?(name) ? self.class.names[name] : name
-        if value.instance_of? Array
-          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-        elsif value.instance_of? Hash
-          hash[key] = {}
-          value.each do |k, v|
-            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_#{name}", *params)
+            else
+              hash[key] = send("to_#{name}")
+            end
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
           end
-        else
-          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
         end
       end
       hash

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth.rb

@@ -0,0 +1,23 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'multi_factor_auth/client.rb'
+
+# Models
+require_relative 'multi_factor_auth/models/two_factor_code_request_schema.rb'
+require_relative 'multi_factor_auth/models/two_factor_voice_response.rb'
+require_relative 'multi_factor_auth/models/two_factor_messaging_response.rb'
+require_relative 'multi_factor_auth/models/two_factor_verify_request_schema.rb'
+require_relative 'multi_factor_auth/models/two_factor_verify_code_response.rb'
+
+# Exceptions
+require_relative 'multi_factor_auth/exceptions/error_with_request_exception.rb'
+require_relative 'multi_factor_auth/exceptions/unauthorized_request' \
+                 '_exception.rb'
+require_relative 'multi_factor_auth/exceptions/forbidden_request_exception.rb'
+# Controllers
+require_relative 'multi_factor_auth/controllers/base_controller.rb'
+require_relative 'multi_factor_auth/controllers/mfa_controller.rb'

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/client.rb

@@ -0,0 +1,60 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+    module MultiFactorAuth
+      #  bandwidth client class.
+      class Client
+        attr_reader :config
+
+        # Access to mfa controller.
+        # @return [MFAController] Returns the controller instance.
+        def mfa
+          @mfa ||= MFAController.new config
+        end
+
+        def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                       backoff_factor: 2,
+                       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                       retry_methods: %i[get put get put],
+                       environment: Environment::PRODUCTION,
+                       base_url: 'https://www.example.com',
+                       messaging_basic_auth_user_name: 'TODO: Replace',
+                       messaging_basic_auth_password: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_password: 'TODO: Replace',
+                       voice_basic_auth_user_name: 'TODO: Replace',
+                       voice_basic_auth_password: 'TODO: Replace',
+                       web_rtc_basic_auth_user_name: 'TODO: Replace',
+                       web_rtc_basic_auth_password: 'TODO: Replace',
+                       config: nil)
+          @config = if config.nil?
+                      Configuration.new(timeout: timeout,
+                                        max_retries: max_retries,
+                                        retry_interval: retry_interval,
+                                        backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses,
+                                        retry_methods: retry_methods,
+                                        environment: environment,
+                                        base_url: base_url,
+                                        messaging_basic_auth_user_name: messaging_basic_auth_user_name,
+                                        messaging_basic_auth_password: messaging_basic_auth_password,
+                                        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+                                        phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+                                        phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
+                                        voice_basic_auth_user_name: voice_basic_auth_user_name,
+                                        voice_basic_auth_password: voice_basic_auth_password,
+                                        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                        web_rtc_basic_auth_password: web_rtc_basic_auth_password)
+                    else
+                      config
+                    end
+        end
+  end
+end
+end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb → multi_factor_auth_lib/multi_factor_auth/controllers/mfa_controller.rb}

@@ -4,14 +4,14 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-module TwoFactorAuth
-  # APIController
-  class APIController < BaseController
+module MultiFactorAuth
+  # MFAController
+  class MFAController < BaseController
     def initialize(config, http_call_back: nil)
       super(config, http_call_back: http_call_back)
     end
 
-    # Two-Factor authentication with Bandwidth Voice services
+    # Allows a user to send a MFA code through a phone call
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Voice service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -19,7 +19,7 @@ module TwoFactorAuth
     def create_voice_two_factor(account_id,
                                 body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/voice'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -39,13 +39,28 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -58,7 +73,7 @@ module TwoFactorAuth
       )
     end
 
-    # Two-Factor authentication with Bandwidth messaging services
+    # Allows a user to send a MFA code through a text message (SMS)
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Messaging service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -66,7 +81,7 @@ module TwoFactorAuth
     def create_messaging_two_factor(account_id,
                                     body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/messaging'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -86,13 +101,28 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -106,7 +136,7 @@ module TwoFactorAuth
       )
     end
 
-    # Verify a previously sent two-factor authentication code
+    # Allows a user to verify an MFA code
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Two-Factor enabled
     # @param [TwoFactorVerifyRequestSchema] body Required parameter: Example:
@@ -114,7 +144,7 @@ module TwoFactorAuth
     def create_verify_two_factor(account_id,
                                  body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/verify'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -134,13 +164,34 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise ErrorWithRequestException.new(
+          'The user has made too many bad requests and is temporarily locked' \
+          ' out',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/error_with_request_exception.rb

@@ -0,0 +1,34 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # ErrorWithRequest class.
+  class ErrorWithRequestException < APIException
+    # An error message pertaining to what the issue could be
+    # @return [String]
+    attr_accessor :error
+
+    # The associated requestId from AWS
+    # @return [String]
+    attr_accessor :request_id
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash['error']
+      @request_id = hash['requestId']
+    end
+  end
+end

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/forbidden_request_exception.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # ForbiddenRequest class.
+  class ForbiddenRequestException < APIException
+    # The message containing the reason behind the request being forbidden
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @message = hash['Message']
+    end
+  end
+end

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/unauthorized_request_exception.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # UnauthorizedRequest class.
+  class UnauthorizedRequestException < APIException
+    # The message containing the reason behind the request being unauthorized
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @message = hash['message']
+    end
+  end
+end