bandwidth-sdk 2.1.1 → 6.1.0

data/lib/bandwidth/http/api_response.rb

@@ -25,10 +25,12 @@ module Bandwidth
       @errors = errors
     end
 
+    # returns true if status_code is between 200-300
     def success?
       status_code >= 200 && status_code < 300
     end
 
+    # returns true if status_code is between 400-600
     def error?
       status_code >= 400 && status_code < 600
     end

data/lib/bandwidth/http/auth/two_factor_auth_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class TwoFactorAuthBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.two_factor_auth_basic_auth_user_name
+      password = config.two_factor_auth_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/http/auth/web_rtc_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class WebRtcBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.web_rtc_basic_auth_user_name
+      password = config.web_rtc_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/http/faraday_client.rb

@@ -15,6 +15,7 @@ module Bandwidth
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use :gzip
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where
@@ -34,7 +35,8 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
           request.body = http_request.parameters
         end
       end
@@ -48,7 +50,8 @@ module Bandwidth
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        unless http_request.parameters.empty?
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
           request.body = http_request.parameters
         end
       end

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -7,17 +7,19 @@
 require_relative 'messaging/client.rb'
 
 # Models
-require_relative 'messaging/models/field_error.rb'
+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/generic_client_exception.rb'
-require_relative 'messaging/exceptions/path_client_exception.rb'
+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/messaging_lib/messaging/client.rb

@@ -17,20 +17,31 @@ module Bandwidth
 
         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', 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,
                                         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)
+                                        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,62 +11,10 @@ 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:
+    # @param [String] user_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(user_id,
                    continuation_token: nil)
@@ -75,7 +23,7 @@ module Messaging
       _query_builder << '/users/{userId}/media'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id
+        'userId' => { 'value' => user_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -95,32 +43,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
         )
@@ -129,13 +77,15 @@ module Messaging
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response,
-                      data: decoded.map { |element| Media.from_hash(element) })
+      ApiResponse.new(
+        _response,
+        data: decoded.map { |element| Media.from_hash(element) }
+      )
     end
 
     # getMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_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(user_id,
                   media_id)
@@ -144,8 +94,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_id, 'encode' => false },
+        'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -158,32 +108,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
         )
@@ -191,37 +141,53 @@ module Messaging
       validate_response(_response)
 
       # Return appropriate response type.
-      ApiResponse.new(_response, data: _response.raw_body)
+      ApiResponse.new(
+        _response, data: _response.raw_body
+      )
     end
 
     # uploadMedia
-    # @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 [String] cache_control Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] media_id Required parameter: The user supplied custom
+    # media ID
+    # @param [Long] content_length Required parameter: The size of the
+    # entity-body
+    # @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(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)
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_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,
         'Content-Length' => content_length,
-        'Content-Type' => content_type,
         'Cache-Control' => cache_control
       }
 
@@ -229,39 +195,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
         )
@@ -273,8 +239,8 @@ module Messaging
     end
 
     # deleteMedia
-    # @param [String] user_id Required parameter: Example:
-    # @param [String] media_id Required parameter: Example:
+    # @param [String] user_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(user_id,
                      media_id)
@@ -283,8 +249,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_id, 'encode' => false },
+        'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -297,32 +263,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
         )
@@ -333,18 +299,128 @@ module Messaging
       ApiResponse.new(_response)
     end
 
+    # getMessages
+    # @param [String] user_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,
+    # DLR_EXPIRED
+    # @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(user_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/{userId}/messages'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'userId' => { 'value' => user_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.
+      if _response.status_code == 400
+        raise MessagingException.new(
+          '400 Request is malformed or invalid',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise MessagingException.new(
+          '401 The specified user does not have access to the account',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise MessagingException.new(
+          '403 The user does not have access to this API',
+          _response
+        )
+      elsif _response.status_code == 404
+        raise MessagingException.new(
+          '404 Path not found',
+          _response
+        )
+      elsif _response.status_code == 415
+        raise MessagingException.new(
+          '415 The content-type of the request is incorrect',
+          _response
+        )
+      elsif _response.status_code == 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
+
     # createMessage
-    # @param [String] user_id Required parameter: Example:
-    # @param [MessageRequest] body Optional parameter: Example:
+    # @param [String] user_id Required parameter: User's account ID
+    # @param [MessageRequest] body Required parameter: Example:
     # @return [BandwidthMessage] response from the API call
     def create_message(user_id,
-                       body: nil)
+                       body)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
       _query_builder << '/users/{userId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id
+        'userId' => { 'value' => user_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -365,32 +441,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
         )
@@ -399,7 +475,9 @@ module Messaging
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response, data: BandwidthMessage.from_hash(decoded))
+      ApiResponse.new(
+        _response, data: BandwidthMessage.from_hash(decoded)
+      )
     end
   end
 end