messagemedia_messages_sdk 1.0.0 → 1.1.0

data/lib/message_media_messages/controllers/replies_controller.rb

@@ -3,6 +3,7 @@
 
 module MessageMediaMessages
   # RepliesController
+  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class RepliesController < BaseController
     @instance = RepliesController.new
 
@@ -36,49 +37,58 @@ module MessageMediaMessages
     # Up to 100 replies can be confirmed in a single confirm replies request.
     # @param [ConfirmRepliesAsReceivedRequest] body Required parameter:
     # Example:
+    # @param [Object] account_header_value The account id to pass to the API
     # @return Mixed response from the API call
-    def create_confirm_replies_as_received(body)
+    def create_confirm_replies_as_received(body, account_header_value=nil)
       begin
         @logger.info("create_confirm_replies_as_received called.")
+        
+        request_url = '/v1/replies/confirmed'
+        
         # Prepare query url.
         @logger.info("Preparing query URL for create_confirm_replies_as_received.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/replies/confirmed'
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for create_confirm_replies_as_received.")
-        _headers = {
+        headers = {
           'accept' => 'application/json',
           'content-type' => 'application/json; charset=utf-8'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
+        json_body = body.to_json
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for create_confirm_replies_as_received.')
-        _request = @http_client.post(
-          _query_url,
-          headers: _headers,
-          parameters: body.to_json
+        request = @http_client.post(
+          query_url,
+          headers: headers,
+          parameters: json_body
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'create_confirm_replies_as_received')
+
+        apply_authentication(request, request_url, json_body)
+
+        context = execute_request(request, name: 'create_confirm_replies_as_received')
   
         # Validate response against endpoint and global error codes.
         @logger.info("Validating response for create_confirm_replies_as_received.")
-        if _context.response.status_code == 400
+        if context.response.status_code == 400
           raise APIException.new(
             '',
-            _context
+            context
           )
         end
-        validate_response(_context)
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for create_confirm_replies_as_received.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
-          _context.response.raw_body.nil? ||
-          _context.response.raw_body.to_s.strip.empty?
-        decoded
+        return APIHelper.json_deserialize(context.response.raw_body) unless
+                context.response.raw_body.nil? ||
+                context.response.raw_body.to_s.strip.empty?
 
       rescue Exception => e
         @logger.error(e)
@@ -168,35 +178,42 @@ module MessageMediaMessages
     # *Note: It is recommended to use the Webhooks feature to receive reply
     # messages rather than polling
     # the check replies endpoint.*
+    # @param [Object] account_header_value The account id to pass to the API
     # @return CheckRepliesResponse response from the API call
-    def get_check_replies
+    def get_check_replies(account_header_value=nil)
       begin
         @logger.info("get_check_replies called.")
+        
+        request_url = '/v1/replies'
         # Prepare query url.
         @logger.info("Preparing query URL for get_check_replies.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/replies'
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for get_check_replies.")
-        _headers = {
+        headers = {
           'accept' => 'application/json'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_check_replies.')
-        _request = @http_client.get(
-          _query_url,
-          headers: _headers
+        request = @http_client.get(
+          query_url,
+          headers: headers
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_check_replies')
-        validate_response(_context)
+
+        apply_authentication(request, request_url)
+
+        context = execute_request(request, name: 'get_check_replies')
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for get_check_replies.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        decoded = APIHelper.json_deserialize(context.response.raw_body)
         CheckRepliesResponse.from_hash(decoded)
 
       rescue Exception => e

data/lib/message_media_messages/exceptions/api_exception.rb

@@ -7,8 +7,8 @@ module MessageMediaMessages
     attr_reader :context, :response_code
 
     # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpContext] The HttpContext of the API call.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpContext] context The HttpContext of the API call.
     def initialize(reason, context)
       super(reason)
       @context = context

data/lib/message_media_messages/http/auth/basic_auth.rb

@@ -9,7 +9,7 @@ module MessageMediaMessages
     # Add basic authentication to the request.
     # @param [HttpRequest] The HttpRequest object to which authentication will
     # be added.
-    def self.apply(http_request)
+    def self.apply(http_request, url=nil, body=nil)
       username = Configuration.basic_auth_user_name
       password = Configuration.basic_auth_password
       value = Base64.strict_encode64("#{username}:#{password}")

data/lib/message_media_messages/http/auth/hmac_auth.rb

@@ -0,0 +1,54 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module MessageMediaMessages
+  # Utility class for basic authorization.
+  class HmacAuth
+    def self.create_signature(date, content_signature, url, body=nil)
+      request_type = "GET"
+
+      if body != nil
+        request_type = "POST"
+      end
+
+      signing_string = "date: #{date}\n#{content_signature}#{request_type} #{url} HTTP/1.1"
+      hmac = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), Configuration.hmac_auth_password.encode("ASCII"), signing_string.encode("ASCII"))
+
+      return Base64.encode64(hmac).chomp
+    end
+
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(http_request, url=nil, body=nil)
+      username = Configuration.hmac_auth_user_name
+
+      content_signature = ""
+      content_header = ""
+
+      now = DateTime.now.new_offset(0).to_time.strftime("%a, %d %b %Y %H:%M:%S GMT")
+
+      date_header = now
+
+      if body != nil
+        md5 = Digest::MD5.new
+        md5.update(body)
+
+        content_hash = md5.hexdigest
+        content_signature = "x-Content-MD5: #{content_hash}\n"
+        content_header = "x-Content-MD5 "
+        http_request.headers["x-Content-MD5"] = content_hash
+      end
+
+      http_request.headers["date"] = date_header
+
+      hmac_signature = HmacAuth.create_signature(date_header, content_signature, url, body)
+
+      joined = "username=\"#{username}\", algorithm=\"hmac-sha1\", headers=\"date #{content_header}request-line\", signature=\"#{hmac_signature}\""
+      header_value = "hmac #{joined}"
+      http_request.headers["Authorization"] = header_value
+    end
+  end
+end

data/lib/message_media_messages/http/http_call_back.rb

@@ -5,7 +5,7 @@ module MessageMediaMessages
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack
     # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # @param [HttpRequest] _http_request The HttpRequest object which the HttpClient
     # will execute.
     def on_before_request(_http_request)
       raise NotImplementedError, 'This method needs
@@ -13,7 +13,7 @@ module MessageMediaMessages
     end
 
     # A controller will call this method after making an HTTP Request.
-    # @param [HttpContext] The HttpContext of the API call.
+    # @param [HttpContext] _http_context The HttpContext of the API call.
     def on_after_response(_http_context)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'

data/lib/message_media_messages/http/http_client.rb

@@ -8,29 +8,29 @@ module MessageMediaMessages
   # for HTTP Client classes.
   class HttpClient
     # Execute an HttpRequest when the response is expected to be a string.
-    # @param [HttpRequest] The HttpRequest to be executed.
+    # @param [HttpRequest] _http_request The HttpRequest to be executed.
     def execute_as_string(_http_request)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Execute an HttpRequest when the response is expected to be binary.
-    # @param [HttpRequest] The HttpRequest to be executed.
+    # @param [HttpRequest] _http_request The HttpRequest to be executed.
     def execute_as_binary(_http_request)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Converts the HTTP Response from the client to an HttpResponse object.
-    # @param [Dynamic] The response object received from the client.
+    # @param [Dynamic] _response The response object received from the client.
     def convert_response(_response)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Get a GET HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
     def get(query_url,
             headers: {})
       HttpRequest.new(HttpMethodEnum::GET,
@@ -39,9 +39,9 @@ module MessageMediaMessages
     end
 
     # Get a POST HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
     def post(query_url,
              headers: {},
              parameters: {})
@@ -52,9 +52,9 @@ module MessageMediaMessages
     end
 
     # Get a PUT HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
     def put(query_url,
             headers: {},
             parameters: {})
@@ -65,9 +65,9 @@ module MessageMediaMessages
     end
 
     # Get a PATCH HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
     def patch(query_url,
               headers: {},
               parameters: {})
@@ -78,8 +78,9 @@ module MessageMediaMessages
     end
 
     # Get a DELETE HttpRequest object.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
     def delete(query_url,
                headers: {},
                parameters: {})

data/lib/message_media_messages/http/http_context.rb

@@ -7,8 +7,8 @@ module MessageMediaMessages
     attr_accessor :request, :response
 
     # The constructor.
-    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
-    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # @param [HttpRequest] request An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] response An HttpResponse object representing the HTTP
     # response.
     def initialize(request, response)
       @request = request

data/lib/message_media_messages/http/http_request.rb

@@ -8,10 +8,10 @@ module MessageMediaMessages
                   :parameters, :username, :password
 
     # The constructor.
-    # @param [HttpMethodEnum] The HTTP method.
-    # @param [String] The URL to send the request to.
-    # @param [Hash, Optional] The headers for the HTTP Request.
-    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [HttpMethodEnum] http_method The HTTP method.
+    # @param [String] query_url The URL to send the request to.
+    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
     def initialize(http_method,
                    query_url,
                    headers: {},
@@ -23,22 +23,22 @@ module MessageMediaMessages
     end
 
     # Add a header to the HttpRequest.
-    # @param [String] The name of the header.
-    # @param [String] The value of the header.
+    # @param [String] name The name of the header.
+    # @param [String] value The value of the header.
     def add_header(name, value)
       @headers[name] = value
     end
 
     # Add a parameter to the HttpRequest.
-    # @param [String] The name of the parameter.
-    # @param [String] The value of the parameter.
+    # @param [String] name The name of the parameter.
+    # @param [String] value The value of the parameter.
     def add_parameter(name, value)
       @parameters[name] = value
     end
 
     # Add a query parameter to the HttpRequest.
-    # @param [String] The name of the query parameter.
-    # @param [String] The value of the query parameter.
+    # @param [String] name The name of the query parameter.
+    # @param [String] value The value of the query parameter.
     def add_query_parameter(name, value)
       @query_url = APIHelper.append_url_with_query_parameters(@query_url,
                                                               name => value)

data/lib/message_media_messages/http/http_response.rb

@@ -7,9 +7,9 @@ module MessageMediaMessages
     attr_accessor :status_code, :headers, :raw_body
 
     # The constructor
-    # @param [Integer] The status code returned by the server.
-    # @param [Hash] The headers sent by the server in the response.
-    # @param [String] The raw body of the response.
+    # @param [Integer] status_code The status code returned by the server.
+    # @param [Hash] headers The headers sent by the server in the response.
+    # @param [String] raw_body The raw body of the response.
     def initialize(status_code,
                    headers,
                    raw_body)

data/lib/message_media_messages/message_media_messages_client.rb

@@ -29,11 +29,14 @@ module MessageMediaMessages
     end
 
     # Initializer with authentication and configuration parameters.
-    def initialize(basic_auth_user_name: nil, basic_auth_password: nil)
-      Configuration.basic_auth_user_name = basic_auth_user_name if
-        basic_auth_user_name
-      Configuration.basic_auth_password = basic_auth_password if
-        basic_auth_password
+    def initialize(auth_user_name: nil, auth_password: nil, use_hmac: false)
+      if (use_hmac == false)
+        Configuration.basic_auth_user_name = auth_user_name
+        Configuration.basic_auth_password = auth_password
+      else
+        Configuration.hmac_auth_user_name = auth_user_name
+        Configuration.hmac_auth_password = auth_password
+      end
     end
   end
 end

data/test/controllers/controller_test_base.rb

@@ -3,9 +3,11 @@
 require 'json'
 require 'test/unit'
 require 'message_media_messages.rb'
+require 'message_media_messages/configuration.rb'
 require_relative '../test_helper.rb'
 require_relative '../http_response_catcher.rb'
 
+# noinspection RubyClassVariableUsageInspection
 class ControllerTestBase < Test::Unit::TestCase
   include MessageMediaMessages
 
@@ -19,7 +21,8 @@ class ControllerTestBase < Test::Unit::TestCase
     @@request_timeout = 30
     @@assert_precision = 0.01
 
-
+    Configuration.basic_auth_user_name = ENV['MessageMediaApiTestsKey']
+    Configuration.basic_auth_password = ENV['MessageMediaApiTestsSecret']
   end
 
   # Called once before every test case.

data/test/controllers/test_delivery_reports_controller.rb

@@ -1,131 +1,164 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
-
-require_relative 'controller_test_base'
-
-class DeliveryReportsControllerTests < ControllerTestBase
-  # Called only once for the class before any test has executed
-  def self.startup
-    self.controller = @@api_client.delivery_reports
-  end
-
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+# noinspection RubyClassVariableUsageInspection,RubyInstanceMethodNamingConvention
+class DeliveryReportsControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.delivery_reports
+  end
+
   # Check for any delivery reports that have been received.
-  #Delivery reports are a notification of the change in status of a message as it is being processed.
-  #Each request to the check delivery reports endpoint will return any delivery reports received that
-  #have not yet been confirmed using the confirm delivery reports endpoint. A response from the check
-  #delivery reports endpoint will have the following structure:
-  #```json
-  #{
-  #    "delivery_reports": [
-  #        {
-  #            "callback_url": "https://my.callback.url.com",
-  #            "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",
-  #            "source_number": "+61491570157",
-  #            "date_received": "2017-05-20T06:30:37.642Z",
-  #            "status": "enroute",
-  #            "delay": 0,
-  #            "submitted_date": "2017-05-20T06:30:37.639Z",
-  #            "original_text": "My first message!",
-  #            "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",
-  #            "vendor_account_id": {
-  #                "vendor_id": "MessageMedia",
-  #                "account_id": "MyAccount"
-  #            },
-  #            "metadata": {
-  #                "key1": "value1",
-  #                "key2": "value2"
-  #            }
-  #        },
-  #        {
-  #            "callback_url": "https://my.callback.url.com",
-  #            "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",
-  #            "source_number": "+61491570158",
-  #            "date_received": "2017-05-21T01:46:42.579Z",
-  #            "status": "enroute",
-  #            "delay": 0,
-  #            "submitted_date": "2017-05-21T01:46:42.574Z",
-  #            "original_text": "My second message!",
-  #            "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",
-  #            "vendor_account_id": {
-  #                "vendor_id": "MessageMedia",
-  #                "account_id": "MyAccount"
-  #            },
-  #            "metadata": {
-  #                "key1": "value1",
-  #                "key2": "value2"
-  #            }
-  #        }
-  #    ]
-  #}
-  #```
-  #Each delivery report will contain details about the message, including any metadata specified
-  #and the new status of the message (as each delivery report indicates a change in status of a
-  #message) and the timestamp at which the status changed. Every delivery report will have a 
-  #unique delivery report ID for use with the confirm delivery reports endpoint.
-  #*Note: The source number and destination number properties in a delivery report are the inverse of
-  #those specified in the message that the delivery report relates to. The source number of the
-  #delivery report is the destination number of the original message.*
-  #Subsequent requests to the check delivery reports endpoint will return the same delivery reports
-  #and a maximum of 100 delivery reports will be returned in each request. Applications should use the
-  #confirm delivery reports endpoint in the following pattern so that delivery reports that have been
-  #processed are no longer returned in subsequent check delivery reports requests.
-  #1. Call check delivery reports endpoint
-  #2. Process each delivery report
-  #3. Confirm all processed delivery reports using the confirm delivery reports endpoint
-  #*Note: It is recommended to use the Webhooks feature to receive reply messages rather than
-  #polling the check delivery reports endpoint.*
-  def test_check_delivery_reports_1()
-
-    # Perform the API call through the SDK function
-    result = self.class.controller.get_check_delivery_reports()
-
-    # Test response code
-    assert_equal(@response_catcher.response.status_code, 200)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = nil
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-
-    # Test whether the captured response is as we expected
-    assert_not_nil(result)
-    assert_equal('{    "delivery_reports": [        {            "callback_url": "https://my.callback.url.com",            "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",            "source_number": "+61491570157",            "date_received": "2017-05-20T06:30:37.642Z",            "status": "enroute",            "delay": 0,            "submitted_date": "2017-05-20T06:30:37.639Z",            "original_text": "My first message!",            "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",            "vendor_account_id": {                "vendor_id": "MessageMedia",                "account_id": "MyAccount"            },            "metadata": {                "key1": "value1",                "key2": "value2"            }        },        {            "callback_url": "https://my.callback.url.com",            "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",            "source_number": "+61491570158",            "date_received": "2017-05-21T01:46:42.579Z",            "status": "enroute",            "delay": 0,            "submitted_date": "2017-05-21T01:46:42.574Z",            "original_text": "My second message!",            "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",            "vendor_account_id": {                "vendor_id": "MessageMedia",                "account_id": "MyAccount"            },            "metadata": {                "key1": "value1",                "key2": "value2"            }        }    ]}', @response_catcher.response.raw_body)
-  end
-
+  # Delivery reports are a notification of the change in status of a message as it is being processed.
+  # Each request to the check delivery reports endpoint will return any delivery reports received that
+  # have not yet been confirmed using the confirm delivery reports endpoint. A response from the check
+  # delivery reports endpoint will have the following structure:
+  # ```json
+  # {
+  #     "delivery_reports": [
+  #         {
+  #             "callback_url": "https://my.callback.url.com",
+  #             "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",
+  #             "source_number": "+61491570157",
+  #             "date_received": "2017-05-20T06:30:37.642Z",
+  #             "status": "enroute",
+  #             "delay": 0,
+  #             "submitted_date": "2017-05-20T06:30:37.639Z",
+  #             "original_text": "My first message!",
+  #             "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",
+  #             "vendor_account_id": {
+  #                 "vendor_id": "MessageMedia",
+  #                 "account_id": "MyAccount"
+  #             },
+  #             "metadata": {
+  #                 "key1": "value1",
+  #                 "key2": "value2"
+  #             }
+  #         },
+  #         {
+  #             "callback_url": "https://my.callback.url.com",
+  #             "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",
+  #             "source_number": "+61491570158",
+  #             "date_received": "2017-05-21T01:46:42.579Z",
+  #             "status": "enroute",
+  #             "delay": 0,
+  #             "submitted_date": "2017-05-21T01:46:42.574Z",
+  #             "original_text": "My second message!",
+  #             "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",
+  #             "vendor_account_id": {
+  #                 "vendor_id": "MessageMedia",
+  #                 "account_id": "MyAccount"
+  #             },
+  #             "metadata": {
+  #                 "key1": "value1",
+  #                 "key2": "value2"
+  #             }
+  #         }
+  #     ]
+  # }
+  # ```
+  # Each delivery report will contain details about the message, including any metadata specified
+  # and the new status of the message (as each delivery report indicates a change in status of a
+  # message) and the timestamp at which the status changed. Every delivery report will have a
+  # unique delivery report ID for use with the confirm delivery reports endpoint.
+  # *Note: The source number and destination number properties in a delivery report are the inverse of
+  # those specified in the message that the delivery report relates to. The source number of the
+  # delivery report is the destination number of the original message.*
+  # Subsequent requests to the check delivery reports endpoint will return the same delivery reports
+  # and a maximum of 100 delivery reports will be returned in each request. Applications should use the
+  # confirm delivery reports endpoint in the following pattern so that delivery reports that have been
+  # processed are no longer returned in subsequent check delivery reports requests.
+  # 1. Call check delivery reports endpoint
+  # 2. Process each delivery report
+  # 3. Confirm all processed delivery reports using the confirm delivery reports endpoint
+  # *Note: It is recommended to use the Webhooks feature to receive reply messages rather than
+  # polling the check delivery reports endpoint.*
+  def test_check_delivery_reports_1
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.get_check_delivery_reports
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 200)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    assert_not_nil(result)
+    assert_true(@response_catcher.response.raw_body.index('{"delivery_reports":[') >= 0, "Must get our delivery reports")
+  end
+
+  # Make sure our SDK fails when passed an invalid account id
+  def test_check_delivery_reports_with_invalid_account
+    begin
+      # Perform the API call through the SDK function
+      self.class.controller.get_check_delivery_reports('INVALID ACCOUNT')
+    rescue APIException => api_exception
+      assert_equal('HTTP Response Not OK. {"message":"Invalid account \'INVALID ACCOUNT\' in header Account"}' + "\n",
+                   api_exception.message,'Make sure we''ve got our error message')
+      # Test response code
+      assert_equal(@response_catcher.response.status_code, 403)
+    end
+  end
+
   # Mark a delivery report as confirmed so it is no longer return in check delivery reports requests.
-  #The confirm delivery reports endpoint is intended to be used in conjunction with the check delivery
-  #reports endpoint to allow for robust processing of delivery reports. Once one or more delivery
-  #reports have been processed, they can then be confirmed using the confirm delivery reports endpoint so they
-  #are no longer returned in subsequent check delivery reports requests.
-  #The confirm delivery reports endpoint takes a list of delivery report IDs as follows:
-  #```json
-  #{
-  #    "delivery_report_ids": [
-  #        "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
-  #        "3487b3fa-6586-4979-a233-2d1b095c7718",
-  #        "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
-  #    ]
-  #}
-  #```
-  #Up to 100 delivery reports can be confirmed in a single confirm delivery reports request.
-  def test_confirm_delivery_reports_as_received_1()
-    # Parameters for the API call
-    body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
-      '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
-      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
-      ))
-
-    # Perform the API call through the SDK function
-    result = self.class.controller.create_confirm_delivery_reports_as_received(body)
-
-    # Test response code
-    assert_equal(@response_catcher.response.status_code, 202)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = nil
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-end
+  # The confirm delivery reports endpoint is intended to be used in conjunction with the check delivery
+  # reports endpoint to allow for robust processing of delivery reports. Once one or more delivery
+  # reports have been processed, they can then be confirmed using the confirm delivery reports endpoint so they
+  # are no longer returned in subsequent check delivery reports requests.
+  # The confirm delivery reports endpoint takes a list of delivery report IDs as follows:
+  # ```json
+  # {
+  #     "delivery_report_ids": [
+  #         "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
+  #         "3487b3fa-6586-4979-a233-2d1b095c7718",
+  #         "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
+  #     ]
+  # }
+  # ```
+  # Up to 100 delivery reports can be confirmed in a single confirm delivery reports request.
+  def test_confirm_delivery_reports_as_received_1
+    # Parameters for the API call
+    body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
+      '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
+      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
+      ))
+
+    # Perform the API call through the SDK function
+    self.class.controller.create_confirm_delivery_reports_as_received(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 202)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+  end
+
+  # Make sure our SDK fails when passed an invalid account id
+  def test_confirm_delivery_reports_as_received_with_invalid_account
+    begin
+      # Perform the API call through the SDK function
+      body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
+          '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
+      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
+      ))
+
+      # Perform the API call through the SDK function
+      self.class.controller.create_confirm_delivery_reports_as_received(body, 'INVALID ACCOUNT')
+    rescue APIException => api_exception
+      assert_equal('HTTP Response Not OK. {"message":"Invalid account \'INVALID ACCOUNT\' in header Account"}' + "\n",
+                   api_exception.message,'Make sure we''ve got our error message')
+      # Test response code
+      assert_equal(@response_catcher.response.status_code, 403)
+    end
+  end
+
+end