messagemedia_conversations_sdk 1.0.0

data/lib/message_media_conversations/controllers/facebook_controller.rb

@@ -0,0 +1,192 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # FacebookController
+  class FacebookController < BaseController
+    @instance = FacebookController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Integrates the Facebook page with the given ID with the configured
+    # account.
+    # @param [String] facebook_page_id Required parameter: facebookPageId
+    # @return String response from the API call
+    def create_integrate_facebook_page(facebook_page_id)
+      begin
+        @logger.info("create_integrate_facebook_page called.")
+        # Prepare query url.
+        @logger.info("Preparing query URL for create_integrate_facebook_page.")
+        _query_builder = Configuration.base_uri.dup
+        _query_builder << '/beta/conversations/facebook/pages/{facebookPageId}/integrate'
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
+          'facebookPageId' => facebook_page_id
+        )
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for create_integrate_facebook_page.')
+        _request = @http_client.post(
+          _query_url
+        )
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'create_integrate_facebook_page')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for create_integrate_facebook_page.")
+        if _context.response.status_code == 400
+          raise APIException.new(
+            'The account is not provisioned or the Facebook user isn\'t' \
+            ' authenticated or the facebookPageId is invalid.',
+            _context
+          )
+        end
+        validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for create_integrate_facebook_page.")
+        _context.response.raw_body
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Gets a list of Facebook pages belonging to the provisioned and Facebook
+    # authorised account. A successful response from this endpoint will have the
+    # following structure:
+    # ```
+    # {
+    #   "data": [
+    #     {
+    #       "id": "1573307926039629",
+    #       "name": "Rainbow Serpent Festival"
+    #     },
+    #     {
+    #       "id": "373479609790958",
+    #       "name": "Fans of Doing Live Demos"
+    #     }
+    #   ]
+    # }
+    # ```
+    # @return GetFacebookPagesResponse response from the API call
+    def get_facebook_pages
+      begin
+        @logger.info("get_facebook_pages called.")
+        # Prepare query url.
+        @logger.info("Preparing query URL for get_facebook_pages.")
+        _query_builder = Configuration.base_uri.dup
+        _query_builder << '/beta/conversations/facebook/pages'
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare headers.
+        @logger.info("Preparing headers for get_facebook_pages.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for get_facebook_pages.')
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'get_facebook_pages')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_facebook_pages.")
+        if _context.response.status_code == 400
+          raise APIException.new(
+            'The account is not provisioned or the Facebook user isn\'t' \
+            ' authenticated.',
+            _context
+          )
+        end
+        validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for get_facebook_pages.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        GetFacebookPagesResponse.from_hash(decoded)
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+
+    # Before you can start integrating Facebook pages on your Facebook account,
+    # MessageMedia's messaging platform needs access to that page via what
+    # Facebook call a page access token. To get the page access token you first
+    # need to provide MessageMedia limited access to your Facebook account.
+    # Calling this endpoint will get the Facebook authorisation URL which you
+    # are required to go through before you can call the integration endpoints.
+    # A successful response from this endpoint will have the following
+    # structure:
+    # ```
+    # {
+    #   "authorisation_url":
+    # "https://www.facebook.com/v2.12/dialog/oauth?client_id={facebookAppId}&amp
+    # ;redirect_uri={apiUrl}/beta/integration/authenticated&amp;state={provision
+    # edAccountUUID}&amp;response_type=token&amp;scope=email,manage_pages,pages_
+    # messaging"
+    # }
+    # ```
+    # *Note: Granting MessageMedia access will only see allow us to see your
+    # basic details and the list of pages you have*
+    # @return GetFacebookAuthorisationURLResponse response from the API call
+    def get_facebook_authorisation_url
+      begin
+        @logger.info("get_facebook_authorisation_url called.")
+        # Prepare query url.
+        @logger.info("Preparing query URL for get_facebook_authorisation_url.")
+        _query_builder = Configuration.base_uri.dup
+        _query_builder << '/beta/conversations/facebook/authorise'
+        _query_url = APIHelper.clean_url _query_builder
+  
+        # Prepare headers.
+        @logger.info("Preparing headers for get_facebook_authorisation_url.")
+        _headers = {
+          'accept' => 'application/json'
+        }
+  
+        # Prepare and execute HttpRequest.
+        @logger.info('Preparing and executing HttpRequest for get_facebook_authorisation_url.')
+        _request = @http_client.get(
+          _query_url,
+          headers: _headers
+        )
+        BasicAuth.apply(_request)
+        _context = execute_request(_request, name: 'get_facebook_authorisation_url')
+  
+        # Validate response against endpoint and global error codes.
+        @logger.info("Validating response for get_facebook_authorisation_url.")
+        if _context.response.status_code == 400
+          raise APIException.new(
+            'The account is not provisioned',
+            _context
+          )
+        end
+        validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for get_facebook_authorisation_url.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        GetFacebookAuthorisationURLResponse.from_hash(decoded)
+
+      rescue Exception => e
+        @logger.error(e)
+        raise e
+      end
+    end
+  end
+end

data/lib/message_media_conversations/exceptions/api_exception.rb

@@ -0,0 +1,18 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason)
+      @context = context
+      @response_code = context.response.status_code
+    end
+  end
+end

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

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

data/lib/message_media_conversations/http/faraday_client.rb

@@ -0,0 +1,55 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+require 'faraday/http_cache'
+
+module MessageMediaConversations
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout: nil, cache: false,
+                   max_retries: nil, retry_interval: nil)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:open_timeout] = timeout if timeout
+        faraday.request :retry, max: max_retries, interval: if max_retries &&
+                                                               retry_interval
+                                                              retry_interval
+                                                            end
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.body = http_request.parameters
+      end
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      HttpResponse.new(response.status, response.headers, response.body)
+    end
+  end
+end

data/lib/message_media_conversations/http/http_call_back.rb

@@ -0,0 +1,22 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # 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
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpContext] The HttpContext of the API call.
+    def on_after_response(_http_context)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/message_media_conversations/http/http_client.rb

@@ -0,0 +1,102 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # 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.
+    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.
+    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.
+    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.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    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.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    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.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    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.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/message_media_conversations/http/http_context.rb

@@ -0,0 +1,18 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # Represents an Http call in context.
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/message_media_conversations/http/http_method_enum.rb

@@ -0,0 +1,11 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaConversations
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end