bandwidth-sdk 2.1.1 → 3.7.0

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

@@ -19,8 +19,13 @@ 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)
+                       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,
@@ -29,8 +34,12 @@ 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)
+                                        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

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

@@ -11,59 +11,6 @@ module Messaging
       super(config, http_call_back: http_call_back)
     end
 
-    # getMessage
-    # @return [void] response from the API call
-    def get_message
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/ping'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
-        raise GenericClientException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      elsif _response.status_code == 401
-        raise PathClientException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      elsif _response.status_code == 403
-        raise PathClientException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      elsif _response.status_code == 404
-        raise PathClientException.new(
-          '404 Path not found',
-          _response
-        )
-      elsif _response.status_code == 415
-        raise GenericClientException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      elsif _response.status_code == 429
-        raise GenericClientException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(_response)
-    end
-
     # listMedia
     # @param [String] user_id Required parameter: Example:
     # @param [String] continuation_token Optional parameter: Example:
@@ -95,32 +42,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -158,32 +105,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -198,15 +145,16 @@ module Messaging
     # @param [String] user_id Required parameter: Example:
     # @param [String] media_id Required parameter: Example:
     # @param [Long] content_length Required parameter: Example:
-    # @param [String] body Required parameter: Example:
-    # @param [String] content_type Optional parameter: Example:
+    # @param [File | UploadIO] body Required parameter: Example:
+    # @param [String] content_type Optional parameter:
+    # Example:application/octet-stream
     # @param [String] cache_control Optional parameter: Example:
     # @return [void] response from the API call
     def upload_media(user_id,
                      media_id,
                      content_length,
                      body,
-                     content_type: nil,
+                     content_type: 'application/octet-stream',
                      cache_control: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
@@ -218,10 +166,19 @@ module Messaging
       )
       _query_url = APIHelper.clean_url _query_builder
 
+      if body.is_a? FileWrapper
+        body_wrapper = body.file
+        body_content_type = body.content_type
+      else
+        body_wrapper = body
+        body_content_type = content_type
+      end
+
       # Prepare headers.
       _headers = {
+        'content-type' => body_content_type,
+        'content-length' => body_wrapper.size.to_s,
         'Content-Length' => content_length,
-        'Content-Type' => content_type,
         'Cache-Control' => cache_control
       }
 
@@ -229,39 +186,39 @@ module Messaging
       _request = config.http_client.put(
         _query_url,
         headers: _headers,
-        parameters: body
+        parameters: body_wrapper
       )
       MessagingBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -297,32 +254,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )
@@ -365,32 +322,32 @@ module Messaging
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '400 Request is malformed or invalid',
           _response
         )
       elsif _response.status_code == 401
-        raise PathClientException.new(
+        raise MessagingException.new(
           '401 The specified user does not have access to the account',
           _response
         )
       elsif _response.status_code == 403
-        raise PathClientException.new(
+        raise MessagingException.new(
           '403 The user does not have access to this API',
           _response
         )
       elsif _response.status_code == 404
-        raise PathClientException.new(
+        raise MessagingException.new(
           '404 Path not found',
           _response
         )
       elsif _response.status_code == 415
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '415 The content-type of the request is incorrect',
           _response
         )
       elsif _response.status_code == 429
-        raise GenericClientException.new(
+        raise MessagingException.new(
           '429 The rate limit has been reached',
           _response
         )

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' => 'APIMATIC 2.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.7.0'
       }
     end
 

data/lib/bandwidth/messaging_lib/messaging/exceptions/{generic_client_exception.rb → messaging_exception.rb}

@@ -4,8 +4,8 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # GenericClientException class.
-  class GenericClientException < APIException
+  # MessagingException class.
+  class MessagingException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :type
@@ -14,10 +14,6 @@ module Bandwidth
     # @return [String]
     attr_accessor :description
 
-    # TODO: Write general description for this method
-    # @return [List of FieldError]
-    attr_accessor :field_errors
-
     # The constructor.
     # @param [String] The reason for raising an exception.
     # @param [HttpResponse] The HttpReponse of the API call.
@@ -33,14 +29,6 @@ module Bandwidth
     def unbox(hash)
       @type = hash['type']
       @description = hash['description']
-      # Parameter is an array, so we need to iterate through it
-      @field_errors = nil
-      unless hash['fieldErrors'].nil?
-        @field_errors = []
-        hash['fieldErrors'].each do |structure|
-          @field_errors << (FieldError.from_hash(structure) if structure)
-        end
-      end
     end
   end
 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,49 @@
+# 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',
+                       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,
+                                        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,
+                                        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

@@ -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