bandwidth-sdk 2.1.1 → 6.1.0

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

@@ -0,0 +1,62 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # PageInfo Model.
+  class PageInfo < BaseModel
+    # The link to the previous page for pagination
+    # @return [String]
+    attr_accessor :prev_page
+
+    # The link to the next page for pagination
+    # @return [String]
+    attr_accessor :next_page
+
+    # The isolated pagination token for the previous page
+    # @return [String]
+    attr_accessor :prev_page_token
+
+    # The isolated pagination token for the next page
+    # @return [String]
+    attr_accessor :next_page_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prev_page'] = 'prevPage'
+      @_hash['next_page'] = 'nextPage'
+      @_hash['prev_page_token'] = 'prevPageToken'
+      @_hash['next_page_token'] = 'nextPageToken'
+      @_hash
+    end
+
+    def initialize(prev_page = nil,
+                   next_page = nil,
+                   prev_page_token = nil,
+                   next_page_token = nil)
+      @prev_page = prev_page
+      @next_page = next_page
+      @prev_page_token = prev_page_token
+      @next_page_token = next_page_token
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      prev_page = hash['prevPage']
+      next_page = hash['nextPage']
+      prev_page_token = hash['prevPageToken']
+      next_page_token = hash['nextPageToken']
+
+      # Create object from extracted values.
+      PageInfo.new(prev_page,
+                   next_page,
+                   prev_page_token,
+                   next_page_token)
+    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/two_factor_auth_lib/two_factor_auth.rb

@@ -0,0 +1,22 @@
+# 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/error_with_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/unauthorized_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/forbidden_request_exception.rb'
+# Controllers
+require_relative 'two_factor_auth/controllers/base_controller.rb'
+require_relative 'two_factor_auth/controllers/mfa_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 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: 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/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'
+      }
+    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/controllers/mfa_controller.rb

@@ -0,0 +1,209 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+module TwoFactorAuth
+  # MFAController
+  class MFAController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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:
+    # @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' => false }
+      )
+      _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 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
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response, data: TwoFactorVoiceResponse.from_hash(decoded)
+      )
+    end
+
+    # 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:
+    # @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' => false }
+      )
+      _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 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
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ApiResponse.new(
+        _response,
+        data: TwoFactorMessagingResponse.from_hash(decoded)
+      )
+    end
+
+    # 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:
+    # @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' => false }
+      )
+      _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 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
+      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/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