messagemedia_messages_sdk 1.1.0 → 2.0.0

data/lib/message_media_messages/configuration.rb

@@ -1,27 +1,29 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
-
-  Logging.logger.root.appenders = Logging.appenders.stdout
-  Logging.logger.root.level = :info
-
   # All configuration including auth info and base URI for the API access
   # are configured in this class.
   class Configuration
     # The base Uri for API calls
-    @base_uri = 'http://api.messagemedia.com'
+    @base_uri = 'https://api.messagemedia.com'
 
     # The username to use with basic authentication
+    # TODO: Set an appropriate value
     @basic_auth_user_name = 'TODO: Replace'
 
     # The password to use with basic authentication
+    # TODO: Set an appropriate value
     @basic_auth_password = 'TODO: Replace'
 
     # The username to use with HMAC authentication
+    # TODO: Set an appropriate value
     @hmac_auth_user_name = nil
 
     # The password to use with HMAC authentication
+    # TODO: Set an appropriate value
     @hmac_auth_password = nil
 
     # The attribute accessors for public properties.

data/lib/message_media_messages/controllers/base_controller.rb

@@ -1,8 +1,8 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
-require 'message_media_messages/configuration.rb'
-
 module MessageMediaMessages
   # Base controller.
   class BaseController
@@ -13,11 +13,8 @@ module MessageMediaMessages
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'messagemedia-messages-ruby-sdk-1.0.0'
+        'user-agent' => 'messagemedia-messages'
       }
-
-      @logger = Logging.logger[self]
-      @logger.info("Instantiated controller class.")
     end
 
     def validate_parameters(args)
@@ -28,46 +25,33 @@ module MessageMediaMessages
       end
     end
 
-    def apply_authentication(request, url, body=nil)
-      if Configuration.hmac_auth_user_name == nil or Configuration.hmac_auth_password == nil
-        BasicAuth.apply(request)
-      else
-        HmacAuth.apply(request, url, body)
-      end
-    end
-
-    def execute_request(request, binary: false, name: nil)
-      @logger.info("Calling the on_before_request method of http_call_back for #{name}.") if @http_call_back
+    def execute_request(request, binary: false)
       @http_call_back.on_before_request(request) if @http_call_back
 
-      @logger.info("Merging global headers with endpoint headers for #{name}.")
       APIHelper.clean_hash(request.headers)
       request.headers = @global_headers.clone.merge(request.headers)
 
-      @logger.debug("Raw request for #{name} is: #{request.inspect}")
       response = if binary
                    @http_client.execute_as_binary(request)
                  else
                    @http_client.execute_as_string(request)
                  end
-      @logger.debug("Raw response for #{name} is: #{response.inspect}")
-      @logger.info("Wrapping request and response in a context object for #{name}.")
       context = HttpContext.new(request, response)
 
-      @logger.info("Calling on_after_response method of http_call_back for #{name}.") if @http_call_back
       @http_call_back.on_after_response(context) if @http_call_back
 
       context
     end
 
-    def add_account_header(headers, account_header_value)
-      if headers != nil && account_header_value != nil
-        headers["account"] = account_header_value
-      end
-    end
-
     def validate_response(context)
-      raise APIException.new 'HTTP Response Not OK. ' + context.response.raw_body, context unless
+      if context.response.status_code == 400
+        raise APIException.new('Request was invalid',
+                               context)
+      elsif context.response.status_code == 404
+        raise APIException.new('Message not found',
+                               context)
+      end
+      raise APIException.new 'HTTP Response Not OK', context unless
         context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
     end
   end

data/lib/message_media_messages/controllers/delivery_reports_controller.rb

@@ -1,9 +1,10 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # DeliveryReportsController
-  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class DeliveryReportsController < BaseController
     @instance = DeliveryReportsController.new
 
@@ -95,48 +96,31 @@ module MessageMediaMessages
     # *Note: It is recommended to use the Webhooks feature to receive reply
     # messages rather than
     # polling the check delivery reports endpoint.*
-    # @param [Object] account_header_value The account id to pass to the API
     # @return CheckDeliveryReportsResponse response from the API call
-    def get_check_delivery_reports(account_header_value=nil)
-      begin
-        @logger.info("get_check_delivery_reports called.")
-
-        request_url = '/v1/delivery_reports'
-        # Prepare query url.
-        @logger.info("Preparing query URL for get_check_delivery_reports.")
-        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_delivery_reports.")
-        headers = {
-          'accept' => 'application/json'
-        }
-
-        add_account_header(headers, account_header_value)
-
-        # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_check_delivery_reports.')
-        request = @http_client.get(
-          query_url,
-          headers: headers
-        )
-
-        apply_authentication(request, request_url)
-
-        context = execute_request(request, name: 'get_check_delivery_reports')
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for get_check_delivery_reports.")
-        decoded = APIHelper.json_deserialize(context.response.raw_body)
-        CheckDeliveryReportsResponse.from_hash(decoded)
-
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
+    def check_delivery_reports
+      # Prepare query url.
+      _path_url = '/v1/delivery_reports'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      AuthManager.apply(_request, _path_url)
+      _context = execute_request(_request)
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      CheckDeliveryReportsResponse.from_hash(decoded)
     end
 
     # Mark a delivery report as confirmed so it is no longer return in check
@@ -163,64 +147,35 @@ module MessageMediaMessages
     # reports request.
     # @param [ConfirmDeliveryReportsAsReceivedRequest] 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_delivery_reports_as_received(body, account_header_value=nil)
-      begin
-        @logger.info("create_confirm_delivery_reports_as_received called.")
-
-        request_url = '/v1/delivery_reports/confirmed'
-
-        # Prepare query url.
-        @logger.info("Preparing query URL for create_confirm_delivery_reports_as_received.")
-        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_delivery_reports_as_received.")
-        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_delivery_reports_as_received.')
-        request = @http_client.post(
-          query_url,
-          headers: headers,
-          parameters: json_body
-        )
-
-        apply_authentication(request, request_url, json_body)
-
-        context = execute_request(request, name: 'create_confirm_delivery_reports_as_received')
-  
-        # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for create_confirm_delivery_reports_as_received.")
-        if context.response.status_code == 400
-          raise APIException.new(
-            '',
-            context
-          )
-        end
-
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for create_confirm_delivery_reports_as_received.")
-        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)
-        raise e
-      end
+    def confirm_delivery_reports_as_received(body)
+      # Prepare query url.
+      _path_url = '/v1/delivery_reports/confirmed'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _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 = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      AuthManager.apply(_request, _path_url, body.to_json)
+      _context = execute_request(_request)
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
+        _context.response.raw_body.nil? ||
+        _context.response.raw_body.to_s.strip.empty?
+      decoded
     end
   end
 end

data/lib/message_media_messages/controllers/messages_controller.rb

@@ -1,9 +1,10 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # MessagesController
-  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class MessagesController < BaseController
     @instance = MessagesController.new
 
@@ -15,97 +16,6 @@ module MessageMediaMessages
       self.class.instance
     end
 
-    # Cancel a scheduled message that has not yet been delivered.
-    # A scheduled message can be cancelled by updating the status of a message
-    # from ```scheduled```
-    # to ```cancelled```. This is done by submitting a PUT request to the
-    # messages endpoint using
-    # the message ID as a parameter (the same endpoint used above to retrieve
-    # the status of a message).
-    # The body of the request simply needs to contain a ```status``` property
-    # with the value set
-    # to ```cancelled```.
-    # ```json
-    # {
-    #     "status": "cancelled"
-    # }
-    # ```
-    # *Note: Only messages with a status of scheduled can be cancelled. If an
-    # invalid or non existent
-    # message ID parameter is specified in the request, then a HTTP 404 Not
-    # Found response will be
-    # returned*
-    # @param [String] message_id Required parameter: Example:
-    # @param [CancelScheduledMessageRequest] 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 update_cancel_scheduled_message(message_id, body, account_header_value=nil)
-      begin
-        @logger.info("update_cancel_scheduled_message called.")
-
-        request_url = '/v1/messages/{messageId}'
-        request_url = APIHelper.append_url_with_template_parameters(
-            request_url,
-            'messageId' => message_id
-        )
-
-        # Prepare query url.
-        @logger.info("Preparing query URL for update_cancel_scheduled_message.")
-        query_builder = Configuration.base_uri.dup
-        query_builder << request_url
-        query_url = APIHelper.clean_url query_builder
-
-        # Prepare headers.
-        @logger.info("Preparing headers for update_cancel_scheduled_message.")
-        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 update_cancel_scheduled_message.')
-        request = @http_client.put(
-          query_url,
-          headers: headers,
-          parameters: json_body
-        )
-
-        apply_authentication(request, request_url, json_body)
-
-        context = execute_request(request, name: 'update_cancel_scheduled_message')
-
-        # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for update_cancel_scheduled_message.")
-        if context.response.status_code == 400
-          raise APIException.new(
-            '',
-            context
-          )
-        elsif context.response.status_code == 404
-          raise APIException.new(
-            '',
-            context
-          )
-        end
-        validate_response(context)
-
-        # Return appropriate response type.
-        @logger.info("Returning response for update_cancel_scheduled_message.")
-        decoded = APIHelper.json_deserialize(context.response.raw_body) unless
-          context.response.raw_body.nil? ||
-          context.response.raw_body.to_s.strip.empty?
-        decoded
-
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
-    end
-
     # Retrieve the current status of a message using the message ID returned in
     # the send messages end point.
     # A successful request to the get message status endpoint will return a
@@ -124,7 +34,7 @@ module MessageMediaMessages
     #     "destination_number": "+61401760575",
     #     "scheduled": "2016-11-03T11:49:02.807Z",
     #     "source_number": "+61491570157",
-    #     "source_number_type": "INTERNATIONAL"
+    #     "source_number_type": "INTERNATIONAL",
     #     "message_expiry_timestamp": "2016-11-03T11:49:02.807Z",
     #     "status": "enroute"
     # }
@@ -137,68 +47,47 @@ module MessageMediaMessages
     # the request, then
     # a HTTP 404 Not Found response will be returned*
     # @param [String] message_id Required parameter: Example:
-    # @param [Object] account_header_value The account id to pass to the API
-    # @return Mixed response from the API call
-    def get_message_status(message_id, account_header_value=nil)
-      begin
-        @logger.info("get_message_status called.")
+    # @return GetMessageStatusResponse response from the API call
+    def get_message_status(message_id)
+      # Prepare query url.
+      _path_url = '/v1/messages/{messageId}'
+      _path_url = APIHelper.append_url_with_template_parameters(
+        _path_url,
+        'messageId' => message_id
+      )
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
 
-        request_url = '/v1/messages/{messageId}'
-        request_url = APIHelper.append_url_with_template_parameters(
-            request_url,
-            'messageId' => message_id
-        )
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
 
-        # Prepare query url.
-        @logger.info("Preparing query URL for get_message_status.")
-        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_message_status.")
-        headers = {
-          'accept' => 'application/json'
-        }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      AuthManager.apply(_request, _path_url)
+      _context = execute_request(_request)
 
-        add_account_header(headers, account_header_value)
-
-        # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_message_status.')
-        request = @http_client.get(
-          query_url,
-          headers: headers
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 404
+        raise APIException.new(
+          'Resource not found',
+          _context
         )
-
-        apply_authentication(request, request_url)
-
-        context = execute_request(request, name: 'get_message_status')
-  
-        # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for get_message_status.")
-        if context.response.status_code == 404
-          raise APIException.new(
-            '',
-            context
-          )
-        end
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for get_message_status.")
-        decoded = APIHelper.json_deserialize(context.response.raw_body) unless
-          context.response.raw_body.nil? ||
-          context.response.raw_body.to_s.strip.empty?
-        decoded
-
-      rescue Exception => e
-        @logger.error(e)
-        raise e
       end
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      GetMessageStatusResponse.from_hash(decoded)
     end
 
-    # Submit one or more (up to 100 per request) SMS or text to voice messages
-    # for delivery.
+    # Submit one or more (up to 100 per request) SMS, MMS or text to voice
+    # messages for delivery.
     # The most basic message has the following structure:
     # ```json
     # {
@@ -238,7 +127,7 @@ module MessageMediaMessages
     # http://en.wikipedia.org/wiki/E.164.
     #   A destination number is required.
     # - ```format``` The format specifies which format the message will be sent
-    # as, ```SMS``` (text message)
+    # as, ```SMS``` (text message), ```MMS``` (multimedia message)
     #   or ```TTS``` (text to speech). With ```TTS``` format, we will call the
     # destination number and read out the
     #   message using a computer generated voice. Specifying a format is
@@ -247,10 +136,16 @@ module MessageMediaMessages
     # this will be the number that
     #   the message appears from on the handset. By default this feature is
     # _not_ available and will be ignored
-    #   in the request. Please contact <support@messagemeda.com> for more
+    #   in the request. Please contact <support@messagemedia.com> for more
     # information. Specifying a source
     #   number is optional and a by default a source number will be assigned to
     # the message.
+    # - ```media``` The media is used to specify the url of the media file that
+    # you are trying to send. Supported file formats include png, jpeg and gif.
+    # ```format``` parameter must be set to ```MMS``` for this to work.
+    # - ```subject``` The subject field is used to denote subject of the MMS
+    # message and has a maximum size of 64 characters long. Specifying a subject
+    # is optional.
     # - ```source_number_type``` If a source number is specified, the type of
     # source number may also be
     #   specified. This is recommended when using a source address type that is
@@ -303,61 +198,129 @@ module MessageMediaMessages
     # valid for the request to be successful.
     # If any messages in the request are invalid, no messages will be sent.*
     # @param [SendMessagesRequest] body Required parameter: Example:
-    # @param [Object] account_header_value The account id to pass to the API
     # @return SendMessagesResponse response from the API call
-    def create_send_messages(body, account_header_value=nil)
-      begin
-        @logger.info("create_send_messages called.")
+    def send_messages(body)
+      # Prepare query url.
+      _path_url = '/v1/messages'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
 
-        request_url = '/v1/messages'
-        # Prepare query url.
-        @logger.info("Preparing query URL for create_send_messages.")
-        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_send_messages.")
-        headers = {
-          'accept' => 'application/json',
-          'content-type' => 'application/json; charset=utf-8'
-        }
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
 
-        add_account_header(headers, account_header_value)
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      AuthManager.apply(_request, _path_url, body.to_json)
+      _context = execute_request(_request)
 
-        json_body = body.to_json
-
-        # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for create_send_messages.')
-        request = @http_client.post(
-          query_url,
-          headers: headers,
-          parameters: json_body
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise SendMessages400ResponseException.new(
+          'Unexpected error in API call. See HTTP response body for details.',
+          _context
         )
+      end
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      SendMessagesResponse.from_hash(decoded)
+    end
+
+    # Cancel a scheduled message that has not yet been delivered.
+    # A scheduled message can be cancelled by updating the status of a message
+    # from ```scheduled```
+    # to ```cancelled```. This is done by submitting a PUT request to the
+    # messages endpoint using
+    # the message ID as a parameter (the same endpoint used above to retrieve
+    # the status of a message).
+    # The body of the request simply needs to contain a ```status``` property
+    # with the value set
+    # to ```cancelled```.
+    # ```json
+    # {
+    #     "status": "cancelled"
+    # }
+    # ```
+    # *Note: Only messages with a status of scheduled can be cancelled. If an
+    # invalid or non existent
+    # message ID parameter is specified in the request, then a HTTP 404 Not
+    # Found response will be
+    # returned*
+    # @param [String] message_id Required parameter: Example:
+    # @param [CancelScheduledMessageRequest] body Required parameter: Example:
+    # @return Mixed response from the API call
+    def cancel_scheduled_message(message_id,
+                                 body)
+      # Prepare query url.
+      _path_url = '/v1/messages/{messageId}'
+      _path_url = APIHelper.append_url_with_template_parameters(
+        _path_url,
+        'messageId' => message_id
+      )
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
 
-        apply_authentication(request, request_url, json_body)
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
 
-        context = execute_request(request, name: 'create_send_messages')
-  
-        # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for create_send_messages.")
-        if context.response.status_code == 400
-          raise APIException.new(
-            '',
-            context
-          )
-        end
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for create_send_messages.")
-        decoded = APIHelper.json_deserialize(context.response.raw_body)
-        SendMessagesResponse.from_hash(decoded)
+      # Prepare and execute HttpRequest.
+      _request = @http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      AuthManager.apply(_request, _path_url, body.to_json)
+      _context = execute_request(_request)
+      validate_response(_context)
 
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
+        _context.response.raw_body.nil? ||
+        _context.response.raw_body.to_s.strip.empty?
+      decoded
+    end
+
+    # TODO: type endpoint description here
+    # @return Mixed response from the API call
+    def check_credits_remaining
+      # Prepare query url.
+      _path_url = '/v1/messaging/credits'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      AuthManager.apply(_request, _path_url)
+      _context = execute_request(_request)
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
+        _context.response.raw_body.nil? ||
+        _context.response.raw_body.to_s.strip.empty?
+      decoded
     end
   end
-end
+end