bandwidth-sdk 3.1.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e5fe50a991db2fb94f074067e8288020c363c5aef6640f9e56d7e5f2ddc0c6
-  data.tar.gz: 7d726b1e2b912c334bc376d1851f087fc609f1c0ab20ad478dfd9c297f35b59e
+  metadata.gz: 9fd4c35a01e690a1ed61898424e735506a332fc4c2365db396632e084f4006b7
+  data.tar.gz: 03237075203ef664a43c5652ff5c6fcd4fef1b12e052cee38df0bad1f281cf0d
 SHA512:
-  metadata.gz: 525fd5027e01ea00e4912d5f8f02f5f89442a794558f79d3df37065c6bb3a8fd567e3bf3e11713771a166965a5e532abcbf15d8a99d6ace7120d868eb6877dbc
-  data.tar.gz: eccbe5576ad3f247f8e24b0e7708f1caf04339e0ed6741e649bb9e1344f85f662b76016af062735a8965375f4786ea55c1a0120b246e0d3edf9e32c48e6ba510
+  metadata.gz: '0943643c3e7b55171915a1533eba159ba646579c91757e493cda3da8da30c5abe54fe4b98058cbdd9f8d01751fd47f29af6384c184fe7da7a0cdc1393d2f992c'
+  data.tar.gz: a1272c7af11abb094444767dc4991807c81d373e9d7e31d88843804f29b38b92f2b7938956c12552446db330c55ec6a85b386d406782e45ab8b7630a34b8983c

data/lib/bandwidth.rb

@@ -35,6 +35,8 @@ require_relative 'bandwidth/configuration.rb'
 # Namespaces
 require_relative 'bandwidth/messaging_lib/messaging'
 require_relative 'bandwidth/http/auth/messaging_basic_auth.rb'
+require_relative 'bandwidth/two_factor_auth_lib/two_factor_auth'
+require_relative 'bandwidth/http/auth/two_factor_auth_basic_auth.rb'
 require_relative 'bandwidth/voice_lib/voice'
 require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
 

data/lib/bandwidth/client.rb

@@ -12,6 +12,11 @@ module Bandwidth
     def messaging_client
       @messaging_client ||= Messaging::Client.new(config: config)
     end
+    # Access to two_factor_auth_client controller.
+    # @return [TwoFactorAuth::Client] Returns the client instance.
+    def two_factor_auth_client
+      @two_factor_auth_client ||= TwoFactorAuth::Client.new(config: config)
+    end
     # Access to voice_client controller.
     # @return [Voice::Client] Returns the client instance.
     def voice_client
@@ -22,6 +27,8 @@ module Bandwidth
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
+                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   two_factor_auth_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace', config: nil)
       @config = if config.nil?
@@ -31,6 +38,8 @@ module Bandwidth
                                     environment: environment,
                                     messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                     messaging_basic_auth_password: messaging_basic_auth_password,
+                                    two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
+                                    two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,
                                     voice_basic_auth_password: voice_basic_auth_password)
                 else

data/lib/bandwidth/configuration.rb

@@ -16,6 +16,7 @@ module Bandwidth
     SERVER = [
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
+      TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
       VOICEDEFAULT = 'VoiceDefault'.freeze
     ].freeze
   end
@@ -32,6 +33,8 @@ module Bandwidth
     attr_reader :environment
     attr_reader :messaging_basic_auth_user_name
     attr_reader :messaging_basic_auth_password
+    attr_reader :two_factor_auth_basic_auth_user_name
+    attr_reader :two_factor_auth_basic_auth_password
     attr_reader :voice_basic_auth_user_name
     attr_reader :voice_basic_auth_password
 
@@ -43,6 +46,8 @@ module Bandwidth
                    backoff_factor: 1, environment: Environment::PRODUCTION,
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
+                   two_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                   two_factor_auth_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
                    voice_basic_auth_password: 'TODO: Replace')
       # The value to use for connection timeout
@@ -67,6 +72,12 @@ module Bandwidth
       # The password to use with basic authentication
       @messaging_basic_auth_password = messaging_basic_auth_password
 
+      # The username to use with basic authentication
+      @two_factor_auth_basic_auth_user_name = two_factor_auth_basic_auth_user_name
+
+      # The password to use with basic authentication
+      @two_factor_auth_basic_auth_password = two_factor_auth_basic_auth_password
+
       # The username to use with basic authentication
       @voice_basic_auth_user_name = voice_basic_auth_user_name
 
@@ -81,6 +92,8 @@ module Bandwidth
                    backoff_factor: nil, environment: nil,
                    messaging_basic_auth_user_name: nil,
                    messaging_basic_auth_password: nil,
+                   two_factor_auth_basic_auth_user_name: nil,
+                   two_factor_auth_basic_auth_password: nil,
                    voice_basic_auth_user_name: nil,
                    voice_basic_auth_password: nil)
       timeout ||= self.timeout
@@ -90,6 +103,8 @@ module Bandwidth
       environment ||= self.environment
       messaging_basic_auth_user_name ||= self.messaging_basic_auth_user_name
       messaging_basic_auth_password ||= self.messaging_basic_auth_password
+      two_factor_auth_basic_auth_user_name ||= self.two_factor_auth_basic_auth_user_name
+      two_factor_auth_basic_auth_password ||= self.two_factor_auth_basic_auth_password
       voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
       voice_basic_auth_password ||= self.voice_basic_auth_password
 
@@ -99,6 +114,8 @@ module Bandwidth
         environment: environment,
         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
         messaging_basic_auth_password: messaging_basic_auth_password,
+        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
+        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
         voice_basic_auth_password: voice_basic_auth_password
       )
@@ -115,6 +132,7 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
+        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
       }
     }.freeze

data/lib/bandwidth/http/auth/two_factor_auth_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class TwoFactorAuthBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.two_factor_auth_basic_auth_user_name
+      password = config.two_factor_auth_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -19,6 +19,8 @@ module Bandwidth
                        backoff_factor: 1, environment: Environment::PRODUCTION,
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
+                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       two_factor_auth_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
                        voice_basic_auth_password: 'TODO: Replace', config: nil)
           @config = if config.nil?
@@ -29,6 +31,8 @@ module Bandwidth
                                         environment: environment,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
+                                        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
+                                        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
                                         voice_basic_auth_password: voice_basic_auth_password)
                     else

data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.1.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.6.0'
       }
     end
 

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb

@@ -0,0 +1,20 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'two_factor_auth/client.rb'
+
+# Models
+require_relative 'two_factor_auth/models/two_factor_code_request_schema.rb'
+require_relative 'two_factor_auth/models/two_factor_voice_response.rb'
+require_relative 'two_factor_auth/models/two_factor_messaging_response.rb'
+require_relative 'two_factor_auth/models/two_factor_verify_request_schema.rb'
+require_relative 'two_factor_auth/models/two_factor_verify_code_response.rb'
+
+# Exceptions
+require_relative 'two_factor_auth/exceptions/invalid_request_exception.rb'
+# Controllers
+require_relative 'two_factor_auth/controllers/base_controller.rb'
+require_relative 'two_factor_auth/controllers/api_controller.rb'

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/client.rb

@@ -0,0 +1,44 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+    module TwoFactorAuth
+      #  bandwidth client class.
+      class Client
+        attr_reader :config
+
+        # Access to client controller.
+        # @return [APIController] Returns the controller instance.
+        def client
+          @client ||= APIController.new config
+        end
+
+        def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
+                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       messaging_basic_auth_user_name: 'TODO: Replace',
+                       messaging_basic_auth_password: 'TODO: Replace',
+                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       two_factor_auth_basic_auth_password: 'TODO: Replace',
+                       voice_basic_auth_user_name: 'TODO: Replace',
+                       voice_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,
+                                        environment: environment,
+                                        messaging_basic_auth_user_name: messaging_basic_auth_user_name,
+                                        messaging_basic_auth_password: messaging_basic_auth_password,
+                                        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
+                                        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                        voice_basic_auth_user_name: voice_basic_auth_user_name,
+                                        voice_basic_auth_password: voice_basic_auth_password)
+                    else
+                      config
+                    end
+        end
+  end
+end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb

@@ -0,0 +1,153 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+module TwoFactorAuth
+  # APIController
+  class APIController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Two-Factor authentication with Bandwidth Voice services
+    # @param [String] account_id Required parameter: Bandwidth Account ID with
+    # Voice service enabled
+    # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
+    # @return [TwoFactorVoiceResponse] response from the API call
+    def create_voice_two_factor(account_id,
+                                body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder << '/accounts/{accountId}/code/voice'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      TwoFactorAuthBasicAuth.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',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(_response,
+                      data: TwoFactorVoiceResponse.from_hash(decoded))
+    end
+
+    # Two-Factor authentication with Bandwidth messaging services
+    # @param [String] account_id Required parameter: Bandwidth Account ID with
+    # Messaging service enabled
+    # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
+    # @return [TwoFactorMessagingResponse] response from the API call
+    def create_messaging_two_factor(account_id,
+                                    body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder << '/accounts/{accountId}/code/messaging'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      TwoFactorAuthBasicAuth.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',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(_response,
+                      data: TwoFactorMessagingResponse.from_hash(decoded))
+    end
+
+    # Verify a previously sent two-factor authentication code
+    # @param [String] account_id Required parameter: Bandwidth Account ID with
+    # Two-Factor enabled
+    # @param [TwoFactorVerifyRequestSchema] body Required parameter: Example:
+    # @return [TwoFactorVerifyCodeResponse] response from the API call
+    def create_verify_two_factor(account_id,
+                                 body)
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder << '/accounts/{accountId}/code/verify'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => account_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      TwoFactorAuthBasicAuth.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',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(_response,
+                      data: TwoFactorVerifyCodeResponse.from_hash(decoded))
+    end
+  end
+end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/base_controller.rb

@@ -0,0 +1,49 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.6.0'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back.on_after_response(response) if @http_call_back
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/invalid_request_exception.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # InvalidRequest class.
+  class InvalidRequestException < APIException
+    # An error message pertaining to what the issue could be
+    # @return [String]
+    attr_accessor :result
+
+    # 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)
+      @result = hash['result']
+    end
+  end
+end