messagemedia_messages_sdk 1.0.0

data/lib/message_media_messages.rb

@@ -0,0 +1,50 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'message_media_messages/api_helper.rb'
+require_relative 'message_media_messages/message_media_messages_client.rb'
+
+# Http
+require_relative 'message_media_messages/http/http_call_back.rb'
+require_relative 'message_media_messages/http/http_client.rb'
+require_relative 'message_media_messages/http/http_method_enum.rb'
+require_relative 'message_media_messages/http/http_request.rb'
+require_relative 'message_media_messages/http/http_response.rb'
+require_relative 'message_media_messages/http/http_context.rb'
+require_relative 'message_media_messages/http/faraday_client.rb'
+require_relative 'message_media_messages/http/auth/basic_auth.rb'
+
+# Models
+require_relative 'message_media_messages/models/base_model.rb'
+require_relative 'message_media_messages/models' \
+                 '/check_delivery_reports_response.rb'
+require_relative 'message_media_messages/models' \
+                 '/confirm_replies_as_received_request_8.rb'
+require_relative 'message_media_messages/models' \
+                 '/confirm_replies_as_received_request.rb'
+require_relative 'message_media_messages/models/check_replies_response.rb'
+require_relative 'message_media_messages/models' \
+                 '/cancel_scheduled_message_request.rb'
+require_relative 'message_media_messages/models/send_messages_response.rb'
+require_relative 'message_media_messages/models/send_messages_request.rb'
+require_relative 'message_media_messages/models' \
+                 '/confirm_delivery_reports_as_received_request.rb'
+require_relative 'message_media_messages/models' \
+                 '/confirm_delivery_reports_as_received_request_11.rb'
+
+# Exceptions
+require_relative 'message_media_messages/exceptions/api_exception.rb'
+
+require_relative 'message_media_messages/configuration.rb'
+
+# Controllers
+require_relative 'message_media_messages/controllers/base_controller.rb'
+require_relative 'message_media_messages/controllers/messages_controller.rb'
+require_relative 'message_media_messages/controllers' \
+                 '/delivery_reports_controller.rb'
+require_relative 'message_media_messages/controllers/replies_controller.rb'

data/lib/message_media_messages/api_helper.rb

@@ -0,0 +1,209 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      # Iterate and append parameters.
+      parameters.each do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    # @param [String] The format of array parameter serialization.
+    def self.append_url_with_query_parameters(query_builder, parameters,
+                                              array_serialization: 'indexed')
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('\t')}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = {}
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode(value, key))
+      end
+      encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form
+    # of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = {}
+
+      # If this is a structure, resolve it's field names.
+      obj = obj.to_hash if obj.is_a? BaseModel
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+            index.to_s + ']'))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+            key + ']'))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      retval
+    end
+  end
+end
+
+# Extend types to support to_bool.
+module ToBoolean
+  def to_bool
+    return true if self == true || to_s.strip =~ /^(true|yes|y|1)$/i
+    false
+  end
+end
+
+# Extend NilClass type to support to_bool.
+class NilClass; include ToBoolean; end
+# Extend TrueClass type to support to_bool.
+class TrueClass; include ToBoolean; end
+# Extend FalseClass type to support to_bool.
+class FalseClass; include ToBoolean; end
+# Extend Numeric type to support to_bool.
+class Numeric; include ToBoolean; end
+# Extend String type to support to_bool.
+class String; include ToBoolean; end

data/lib/message_media_messages/configuration.rb

@@ -0,0 +1,29 @@
+# This file was automatically generated for MessageMedia 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 = 'https://api.messagemedia.com'
+
+    # The username to use with basic authentication
+    @basic_auth_user_name = 'TODO: Replace'
+
+    # The password to use with basic authentication
+    @basic_auth_password = 'TODO: Replace'
+
+    # The attribute accessors for public properties.
+    class << self
+      attr_accessor :array_serialization
+      attr_accessor :base_uri
+      attr_accessor :basic_auth_user_name
+      attr_accessor :basic_auth_password
+    end
+  end
+end

data/lib/message_media_messages/controllers/base_controller.rb

@@ -0,0 +1,57 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # Base controller.
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client || FaradayClient.new
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'messagemedia-messages-ruby-sdk-1.0.0'
+      }
+      @logger = Logging.logger[self]
+      @logger.info("Instantiated controller class.")
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      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
+      @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 validate_response(context)
+      raise APIException.new 'HTTP Response Not OK', context unless
+        context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/message_media_messages/controllers/delivery_reports_controller.rb

@@ -0,0 +1,208 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # DeliveryReportsController
+  class DeliveryReportsController < BaseController
+    @instance = DeliveryReportsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    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.*
+    # @return CheckDeliveryReportsResponse response from the API call
+    def get_check_delivery_reports
+      begin
+        @logger.info("get_check_delivery_reports called.")
+        # Prepare query url.
+        @logger.info("Preparing query URL for get_check_delivery_reports.")
+        _query_builder = Configuration.base_uri.dup
+        _query_builder << '/v1/delivery_reports'
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare headers.
+        @logger.info("Preparing headers for get_check_delivery_reports.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for get_check_delivery_reports.')
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
+        BasicAuth.apply(_request)
+        _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
+    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.
+    # @param [ConfirmDeliveryReportsAsReceivedRequest] body Required parameter:
+    # Example:
+    # @return Mixed response from the API call
+    def create_confirm_delivery_reports_as_received(body)
+      begin
+        @logger.info("create_confirm_delivery_reports_as_received called.")
+        # Prepare query url.
+        @logger.info("Preparing query URL for create_confirm_delivery_reports_as_received.")
+        _query_builder = Configuration.base_uri.dup
+        _query_builder << '/v1/delivery_reports/confirmed'
+        _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'
+        }
+  
+        # 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: body.to_json
+        )
+        BasicAuth.apply(_request)
+        _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.")
+        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
+  end
+end