bandwidth-sdk 10.3.0 → 11.0.0.pre.beta.1

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

@@ -1,122 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # MessageRequest Model.
-  class MessageRequest < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The ID of the Application your from number is associated with in the
-    # Bandwidth Phone Number Dashboard.
-    # @return [String]
-    attr_accessor :application_id
-
-    # The phone number(s) the message should be sent to in E164 format
-    # @return [List of String]
-    attr_accessor :to
-
-    # One of your telephone numbers the message should come from in E164 format
-    # @return [String]
-    attr_accessor :from
-
-    # The contents of the text message. Must be 2048 characters or less.
-    # @return [String]
-    attr_accessor :text
-
-    # A list of URLs to include as media attachments as part of the message.
-    # @return [List of String]
-    attr_accessor :media
-
-    # A custom string that will be included in callback events of the message.
-    # Max 1024 characters
-    # @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 string with the date/time value that the message will automatically expire by.
-    # This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00.
-    # @return [String]
-    attr_accessor :expiration
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['application_id'] = 'applicationId'
-      @_hash['to'] = 'to'
-      @_hash['from'] = 'from'
-      @_hash['text'] = 'text'
-      @_hash['media'] = 'media'
-      @_hash['tag'] = 'tag'
-      @_hash['priority'] = 'priority'
-      @_hash['expiration'] = 'expiration'
-      @_hash
-    end
-
-    # An array for optional fields
-    def optionals
-      %w[
-        text
-        media
-        tag
-        priority
-        expiration
-      ]
-    end
-
-    # An array for nullable fields
-    def nullables
-      []
-    end
-
-    def initialize(application_id = nil,
-                   to = nil,
-                   from = nil,
-                   text = nil,
-                   media = nil,
-                   tag = nil,
-                   priority = nil,
-                   expiration = nil)
-      @application_id = application_id unless application_id == SKIP
-      @to = to unless to == SKIP
-      @from = from unless from == SKIP
-      @text = text unless text == SKIP
-      @media = media unless media == SKIP
-      @tag = tag unless tag == SKIP
-      @priority = priority unless priority == SKIP
-      @expiration = expiration unless expiration == SKIP
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
-      to = hash.key?('to') ? hash['to'] : SKIP
-      from = hash.key?('from') ? hash['from'] : SKIP
-      text = hash.key?('text') ? hash['text'] : SKIP
-      media = hash.key?('media') ? hash['media'] : SKIP
-      tag = hash.key?('tag') ? hash['tag'] : SKIP
-      priority = hash.key?('priority') ? hash['priority'] : SKIP
-      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
-
-      # Create object from extracted values.
-      MessageRequest.new(application_id,
-                         to,
-                         from,
-                         text,
-                         media,
-                         tag,
-                         priority,
-                         expiration)
-    end
-  end
-end

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

@@ -1,82 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # PageInfo Model.
-  class PageInfo < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # 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
-
-    # An array for optional fields
-    def optionals
-      %w[
-        prev_page
-        next_page
-        prev_page_token
-        next_page_token
-      ]
-    end
-
-    # An array for nullable fields
-    def nullables
-      []
-    end
-
-    def initialize(prev_page = nil,
-                   next_page = nil,
-                   prev_page_token = nil,
-                   next_page_token = nil)
-      @prev_page = prev_page unless prev_page == SKIP
-      @next_page = next_page unless next_page == SKIP
-      @prev_page_token = prev_page_token unless prev_page_token == SKIP
-      @next_page_token = next_page_token unless next_page_token == SKIP
-    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.key?('prevPage') ? hash['prevPage'] : SKIP
-      next_page = hash.key?('nextPage') ? hash['nextPage'] : SKIP
-      prev_page_token =
-        hash.key?('prevPageToken') ? hash['prevPageToken'] : SKIP
-      next_page_token =
-        hash.key?('nextPageToken') ? hash['nextPageToken'] : SKIP
-
-      # 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

@@ -1,19 +0,0 @@
-# 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/messaging_lib/messaging/models/tag.rb

@@ -1,60 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # Tag Model.
-  class Tag < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :key
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :value
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['key'] = 'key'
-      @_hash['value'] = 'value'
-      @_hash
-    end
-
-    # An array for optional fields
-    def optionals
-      %w[
-        key
-        value
-      ]
-    end
-
-    # An array for nullable fields
-    def nullables
-      []
-    end
-
-    def initialize(key = nil,
-                   value = nil)
-      @key = key unless key == SKIP
-      @value = value unless value == SKIP
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      key = hash.key?('key') ? hash['key'] : SKIP
-      value = hash.key?('value') ? hash['value'] : SKIP
-
-      # Create object from extracted values.
-      Tag.new(key,
-              value)
-    end
-  end
-end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -1,25 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-
-require_relative 'messaging/client.rb'
-
-# Models
-require_relative 'messaging/models/bandwidth_messages_list.rb'
-require_relative 'messaging/models/bandwidth_message_item.rb'
-require_relative 'messaging/models/page_info.rb'
-require_relative 'messaging/models/media.rb'
-require_relative 'messaging/models/tag.rb'
-require_relative 'messaging/models/deferred_result.rb'
-require_relative 'messaging/models/bandwidth_callback_message.rb'
-require_relative 'messaging/models/bandwidth_message.rb'
-require_relative 'messaging/models/message_request.rb'
-require_relative 'messaging/models/priority_enum.rb'
-
-# Exceptions
-require_relative 'messaging/exceptions/messaging_exception.rb'
-# Controllers
-require_relative 'messaging/controllers/base_controller.rb'
-require_relative 'messaging/controllers/api_controller.rb'

data/lib/bandwidth/models/base_model.rb

@@ -1,58 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # Base model.
-  class BaseModel
-    # Returns a Hash representation of the current object.
-    def to_hash
-      hash = {}
-      instance_variables.each do |name|
-        value = instance_variable_get(name)
-        name = name[1..-1]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
-
-        optional_fields = optionals if respond_to? 'optionals'
-        nullable_fields = nullables if respond_to? 'nullables'
-        if value.nil?
-          next unless nullable_fields.include?(name)
-
-          if !optional_fields.include?(name) && !nullable_fields.include?(name)
-            raise ArgumentError,
-                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
-          end
-        end
-
-        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
-        end
-      end
-      hash
-    end
-
-    # Returns a JSON representation of the curent object.
-    def to_json(options = {})
-      hash = to_hash.reject { |k, v| v.nil? }
-      hash.to_json(options)
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# 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/multi_factor_auth_lib/multi_factor_auth/controllers/base_controller.rb

@@ -1,47 +0,0 @@
-# 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|
-        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
-      end
-    end
-
-    def execute_request(request, binary: false)
-      @http_call_back&.on_before_request(request)
-
-      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)
-
-      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/multi_factor_auth_lib/multi_factor_auth/controllers/mfa_controller.rb

@@ -1,214 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-module MultiFactorAuth
-  # MFAController
-  class MFAController < BaseController
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Multi-Factor authentication with Bandwidth Voice services. Allows for a
-    # user to send an MFA code via 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::MULTIFACTORAUTHDEFAULT)
-      _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
-      )
-      MultiFactorAuthBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise ErrorWithRequestException.new(
-          'If there is any issue with values passed in by the user',
-          _response
-        )
-      when 401
-        raise UnauthorizedRequestException.new(
-          'Authentication is either incorrect or not present',
-          _response
-        )
-      when 403
-        raise ForbiddenRequestException.new(
-          'The user is not authorized to access this resource',
-          _response
-        )
-      when 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
-
-    # Multi-Factor authentication with Bandwidth Messaging services. Allows a
-    # user to send an MFA code via 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::MULTIFACTORAUTHDEFAULT)
-      _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
-      )
-      MultiFactorAuthBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise ErrorWithRequestException.new(
-          'If there is any issue with values passed in by the user',
-          _response
-        )
-      when 401
-        raise UnauthorizedRequestException.new(
-          'Authentication is either incorrect or not present',
-          _response
-        )
-      when 403
-        raise ForbiddenRequestException.new(
-          'The user is not authorized to access this resource',
-          _response
-        )
-      when 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::MULTIFACTORAUTHDEFAULT)
-      _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
-      )
-      MultiFactorAuthBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise ErrorWithRequestException.new(
-          'If there is any issue with values passed in by the user',
-          _response
-        )
-      when 401
-        raise UnauthorizedRequestException.new(
-          'Authentication is either incorrect or not present',
-          _response
-        )
-      when 403
-        raise ForbiddenRequestException.new(
-          'The user is not authorized to access this resource',
-          _response
-        )
-      when 429
-        raise ErrorWithRequestException.new(
-          'The user has made too many bad requests and is temporarily locked' \
-          ' out',
-          _response
-        )
-      when 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