bandwidth-sdk 2.2.2 → 3.12.1

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.12.1'
       }
     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,51 @@
+# 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,
+                       base_url: 'https://www.example.com',
+                       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,
+                                        base_url: base_url,
+                                        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,158 @@
+# 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' => { 'value' => account_id, 'encode' => true }
+      )
+      _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' => { 'value' => account_id, 'encode' => true }
+      )
+      _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' => { 'value' => account_id, 'encode' => true }
+      )
+      _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.12.1'
+      }
+    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

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_code_request_schema.rb

@@ -0,0 +1,88 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorCodeRequestSchema Model.
+  class TwoFactorCodeRequestSchema < BaseModel
+    # The phone number to send the 2fa code to.
+    # @return [String]
+    attr_accessor :to
+
+    # The application phone number, the sender of the 2fa code.
+    # @return [String]
+    attr_accessor :from
+
+    # The application unique ID, obtained from Bandwidth.
+    # @return [String]
+    attr_accessor :application_id
+
+    # An optional field to denote what scope or action the 2fa code is
+    # addressing.  If not supplied, defaults to "2FA".
+    # @return [String]
+    attr_accessor :scope
+
+    # The message format of the 2fa code.  There are three values that the
+    # system will replace "{CODE}", "{NAME}", "{SCOPE}".  The "{SCOPE}" and
+    # "{NAME} value template are optional, while "{CODE}" must be supplied.  As
+    # the name would suggest, code will be replace with the actual 2fa code. 
+    # Name is replaced with the application name, configured during provisioning
+    # of 2fa.  The scope value is the same value sent during the call and
+    # partitioned by the server.
+    # @return [String]
+    attr_accessor :message
+
+    # The number of digits for your 2fa code.  The valid number ranges from 2 to
+    # 8, inclusively.
+    # @return [Float]
+    attr_accessor :digits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['scope'] = 'scope'
+      @_hash['message'] = 'message'
+      @_hash['digits'] = 'digits'
+      @_hash
+    end
+
+    def initialize(to = nil,
+                   from = nil,
+                   application_id = nil,
+                   message = nil,
+                   digits = nil,
+                   scope = nil)
+      @to = to
+      @from = from
+      @application_id = application_id
+      @scope = scope
+      @message = message
+      @digits = digits
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      to = hash['to']
+      from = hash['from']
+      application_id = hash['applicationId']
+      message = hash['message']
+      digits = hash['digits']
+      scope = hash['scope']
+
+      # Create object from extracted values.
+      TwoFactorCodeRequestSchema.new(to,
+                                     from,
+                                     application_id,
+                                     message,
+                                     digits,
+                                     scope)
+    end
+  end
+end