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

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

@@ -1,491 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-module Messaging
-  # APIController
-  class APIController < BaseController
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Gets a list of your media files. No query parameters are supported.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [String] continuation_token Optional parameter: Continuation token
-    # used to retrieve subsequent media.
-    # @return [List of Media] response from the API call
-    def list_media(account_id,
-                   continuation_token: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/media'
-      _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',
-        'Continuation-Token' => continuation_token
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(
-        _response,
-        data: decoded.map { |element| Media.from_hash(element) }
-      )
-    end
-
-    # Downloads a media file you previously uploaded.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [String] media_id Required parameter: Media ID to retrieve
-    # @return [Binary] response from the API call
-    def get_media(account_id,
-                  media_id)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/media/{mediaId}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => false },
-        'mediaId' => { 'value' => media_id, 'encode' => false }
-      )
-      _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, binary: true)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(
-        _response, data: _response.raw_body
-      )
-    end
-
-    # Uploads a file the normal HTTP way. You may add headers to the request in
-    # order to provide some control to your media-file.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [String] media_id Required parameter: The user supplied custom
-    # media ID
-    # @param [File | UploadIO] body Required parameter: Example:
-    # @param [String] content_type Optional parameter: The media type of the
-    # entity-body
-    # @param [String] cache_control Optional parameter: General-header field is
-    # used to specify directives that MUST be obeyed by all caching mechanisms
-    # along the request/response chain.
-    # @return [void] response from the API call
-    def upload_media(account_id,
-                     media_id,
-                     body,
-                     content_type: 'application/octet-stream',
-                     cache_control: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/media/{mediaId}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => false },
-        'mediaId' => { 'value' => media_id, 'encode' => false }
-      )
-      _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,
-        'Cache-Control' => cache_control
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.put(
-        _query_url,
-        headers: _headers,
-        parameters: body_wrapper
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(_response)
-    end
-
-    # Deletes a media file from Bandwidth API server. Make sure you don't have
-    # any application scripts still using the media before you delete. If you
-    # accidentally delete a media file, you can immediately upload a new file
-    # with the same name.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [String] media_id Required parameter: The media ID to delete
-    # @return [void] response from the API call
-    def delete_media(account_id,
-                     media_id)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/media/{mediaId}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => false },
-        'mediaId' => { 'value' => media_id, 'encode' => false }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.delete(
-        _query_url
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      ApiResponse.new(_response)
-    end
-
-    # Gets a list of messages based on query parameters.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [String] message_id Optional parameter: The ID of the message to
-    # search for. Special characters need to be encoded using URL encoding
-    # @param [String] source_tn Optional parameter: The phone number that sent
-    # the message
-    # @param [String] destination_tn Optional parameter: The phone number that
-    # received the message
-    # @param [String] message_status Optional parameter: The status of the
-    # message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED,
-    # ACCEPTED, UNDELIVERED
-    # @param [Integer] error_code Optional parameter: The error code of the
-    # message
-    # @param [String] from_date_time Optional parameter: The start of the date
-    # range to search in ISO 8601 format. Uses the message receive time. The
-    # date range to search in is currently 14 days.
-    # @param [String] to_date_time Optional parameter: The end of the date range
-    # to search in ISO 8601 format. Uses the message receive time. The date
-    # range to search in is currently 14 days.
-    # @param [String] page_token Optional parameter: A base64 encoded value used
-    # for pagination of results
-    # @param [Integer] limit Optional parameter: The maximum records requested
-    # in search result. Default 100. The sum of limit and after cannot be more
-    # than 10000
-    # @return [BandwidthMessagesList] response from the API call
-    def get_messages(account_id,
-                     message_id: nil,
-                     source_tn: nil,
-                     destination_tn: nil,
-                     message_status: nil,
-                     error_code: nil,
-                     from_date_time: nil,
-                     to_date_time: nil,
-                     page_token: nil,
-                     limit: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/messages'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => false }
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'messageId' => message_id,
-        'sourceTn' => source_tn,
-        'destinationTn' => destination_tn,
-        'messageStatus' => message_status,
-        'errorCode' => error_code,
-        'fromDateTime' => from_date_time,
-        'toDateTime' => to_date_time,
-        'pageToken' => page_token,
-        'limit' => limit
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(
-        _response, data: BandwidthMessagesList.from_hash(decoded)
-      )
-    end
-
-    # Endpoint for sending text messages and picture messages using V2
-    # messaging.
-    # @param [String] account_id Required parameter: User's account ID
-    # @param [MessageRequest] body Required parameter: Example:
-    # @return [BandwidthMessage] response from the API call
-    def create_message(account_id,
-                       body)
-      # Prepare query url.
-      _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{accountId}/messages'
-      _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
-      )
-      MessagingBasicAuth.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Validate response against endpoint and global error codes.
-      case _response.status_code
-      when 400
-        raise MessagingException.new(
-          '400 Request is malformed or invalid',
-          _response
-        )
-      when 401
-        raise MessagingException.new(
-          '401 The specified user does not have access to the account',
-          _response
-        )
-      when 403
-        raise MessagingException.new(
-          '403 The user does not have access to this API',
-          _response
-        )
-      when 404
-        raise MessagingException.new(
-          '404 Path not found',
-          _response
-        )
-      when 415
-        raise MessagingException.new(
-          '415 The content-type of the request is incorrect',
-          _response
-        )
-      when 429
-        raise MessagingException.new(
-          '429 The rate limit has been reached',
-          _response
-        )
-      end
-      validate_response(_response)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(
-        _response, data: BandwidthMessage.from_hash(decoded)
-      )
-    end
-  end
-end
-end

data/lib/bandwidth/messaging_lib/messaging/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/messaging_lib/messaging/exceptions/messaging_exception.rb

@@ -1,37 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # MessagingException class.
-  class MessagingException < APIException
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :type
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :description
-
-    # 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)
-      @type = hash.key?('type') ? hash['type'] : SKIP
-      @description = hash.key?('description') ? hash['description'] : SKIP
-    end
-  end
-end

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

@@ -1,100 +0,0 @@
-# bandwidth
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module Bandwidth
-  # BandwidthCallbackMessage Model.
-  class BandwidthCallbackMessage < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :time
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :type
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :to
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :error_code
-
-    # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :description
-
-    # TODO: Write general description for this method
-    # @return [BandwidthMessage]
-    attr_accessor :message
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['time'] = 'time'
-      @_hash['type'] = 'type'
-      @_hash['to'] = 'to'
-      @_hash['error_code'] = 'errorCode'
-      @_hash['description'] = 'description'
-      @_hash['message'] = 'message'
-      @_hash
-    end
-
-    # An array for optional fields
-    def optionals
-      %w[
-        time
-        type
-        to
-        error_code
-        description
-        message
-      ]
-    end
-
-    # An array for nullable fields
-    def nullables
-      []
-    end
-
-    def initialize(time = nil,
-                   type = nil,
-                   to = nil,
-                   error_code = nil,
-                   description = nil,
-                   message = nil)
-      @time = time unless time == SKIP
-      @type = type unless type == SKIP
-      @to = to unless to == SKIP
-      @error_code = error_code unless error_code == SKIP
-      @description = description unless description == SKIP
-      @message = message unless message == 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.
-      time = hash.key?('time') ? hash['time'] : SKIP
-      type = hash.key?('type') ? hash['type'] : SKIP
-      to = hash.key?('to') ? hash['to'] : SKIP
-      error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
-      description = hash.key?('description') ? hash['description'] : SKIP
-      message = BandwidthMessage.from_hash(hash['message']) if hash['message']
-
-      # Create object from extracted values.
-      BandwidthCallbackMessage.new(time,
-                                   type,
-                                   to,
-                                   error_code,
-                                   description,
-                                   message)
-    end
-  end
-end