whatsapp_sdk 0.0.1 → 0.2.0

data/lib/whatsapp_sdk/api/messages.rb

@@ -15,13 +15,19 @@ module WhatsappSdk
         end
       end
 
+      # Send a text message.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param message [String] Text to send.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_text(sender_id:, recipient_number:, message:)
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "text",
-          "text": { body: message }
+          text: { body: message }
         }
 
         response = send_request(
@@ -29,20 +35,32 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send location.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param longitude [Float] Location longitude.
+      # @param latitude [Float] Location latitude.
+      # @param name [String] Location name.
+      # @param address [String] Location address.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_location(sender_id:, recipient_number:, longitude:, latitude:, name:, address:)
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "location",
-          "location": {
-            "longitude": longitude,
-            "latitude": latitude,
-            "name": name,
-            "address": address
+          location: {
+            longitude: longitude,
+            latitude: latitude,
+            name: name,
+            address: address
           }
         }
 
@@ -51,16 +69,27 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send an image.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param image_id [Integer] Image ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_image(sender_id:, recipient_number:, image_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "image_id or link is required" if !image_id && !link
 
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "image"
         }
         params[:image] = if link
@@ -74,16 +103,26 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send an audio.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param audio_id [Integer] Audio ID.
+      # @param link [String] Audio link.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_audio(sender_id:, recipient_number:, audio_id: nil, link: nil)
         raise MissingArgumentError, "audio_id or link is required" if !audio_id && !link
 
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "audio"
         }
         params[:audio] = link ? { link: link } : { id: audio_id }
@@ -93,16 +132,27 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send a video.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param video_id [Integer] Video ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_video(sender_id:, recipient_number:, video_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "video_id or link is required" if !video_id && !link
 
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "video"
         }
         params[:video] = if link
@@ -116,16 +166,27 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send a document.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param document_id [Integer] document ID.
+      # @param link [String] Image link.
+      # @param caption [String] Image caption.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_document(sender_id:, recipient_number:, document_id: nil, link: nil, caption: "")
         raise MissingArgumentError, "document or link is required" if !document_id && !link
 
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "document"
         }
         params[:document] = if link
@@ -139,16 +200,25 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send a document.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param link [String] Image link.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_sticker(sender_id:, recipient_number:, sticker_id: nil, link: nil)
         raise MissingArgumentError, "sticker or link is required" if !sticker_id && !link
 
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "sticker"
         }
         params[:sticker] = link ? { link: link } : { id: sticker_id }
@@ -158,14 +228,25 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
+      # Send contacts.
+      # You can either send contacts objects or contacts as JSON.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param contacts [Array<Contact>] Contacts.
+      # @param contacts_json [Json] Contacts.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def send_contacts(sender_id:, recipient_number:, contacts: nil, contacts_json: {})
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "contacts"
         }
         params[:contacts] = contacts ? contacts.map(&:to_h) : contacts_json
@@ -175,7 +256,10 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       def send_interactive_button
@@ -190,6 +274,69 @@ module WhatsappSdk
         # TODO: https://developers.facebook.com/docs/whatsapp_sdk/cloud-api/reference/messages#contacts-object
       end
 
+      # Mark a message as read.
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param message_id [Integer] Message ID.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def read_message(sender_id:, message_id:)
+        params = {
+          messaging_product: "whatsapp",
+          status: "read",
+          message_id: message_id
+        }
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::ReadMessageDataResponse
+        )
+      end
+
+      # Send template
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param name [String] the template's name.
+      # @param language [String] template language.
+      # @param components [Component] Component.
+      # @param components_json [Json] The component as a Json. If you pass components_json, you can't pass components.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      def send_template(sender_id:, recipient_number:, name:, language:, components: nil, components_json: nil)
+        raise MissingArgumentError, "components or components_json is required" if !components && !components_json
+
+        params = {
+          messaging_product: "whatsapp",
+          recipient_type: "individual",
+          to: recipient_number,
+          type: "template",
+          template: {
+            name: name
+          }
+        }
+
+        params[:template][:language] = { code: language } if language
+        params[:template][:components] = if components.nil?
+                                           components_json
+                                         else
+                                           components.map(&:to_json)
+                                         end
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
+      end
+
       private
 
       def endpoint(sender_id)

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -6,24 +6,36 @@ require_relative "response"
 module WhatsappSdk
   module Api
     class PhoneNumbers < Request
+      # Get list of registered numbers.
+      #
+      # @param business_id [Integer] Business Id.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def registered_numbers(business_id)
         response = send_request(
           http_method: "get",
           endpoint: "#{business_id}/phone_numbers"
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumbersDataResponse
+        )
       end
 
+      # Get the registered number id.
+      #
+      # @param phone_number_id [Integer] The registered number we want to retrieve.
+      # @return [WhatsappSdk::Api::Response] Response object.
       def registered_number(phone_number_id)
         response = send_request(
           http_method: "get",
           endpoint: phone_number_id.to_s
         )
 
-        WhatsappSdk::Api::Response.new(response: response,
-                                       class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/request.rb

@@ -10,8 +10,14 @@ module WhatsappSdk
         @client = client
       end
 
-      def send_request(endpoint:, http_method: "post", params: {})
-        @client.send_request(http_method: http_method, endpoint: endpoint, params: params)
+      def download_file(url, path_to_file_name = nil)
+        @client.download_file(url, path_to_file_name)
+      end
+
+      def send_request(endpoint: nil, full_url: nil, http_method: "post", params: {})
+        @client.send_request(
+          http_method: http_method, full_url: full_url, endpoint: endpoint, params: params
+        )
       end
     end
   end

data/lib/whatsapp_sdk/api/response.rb

@@ -3,28 +3,25 @@
 require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"
 require_relative "responses/phone_numbers_data_response"
-require_relative "responses/error_response"
+require_relative "responses/read_message_data_response"
+require_relative "responses/message_error_response"
 
 module WhatsappSdk
   module Api
     class Response
       attr_accessor :error, :data
 
-      CLASS_TYPE = {
-        message_data_response: Responses::MessageDataResponse,
-        phone_number_data_response: Responses::PhoneNumberDataResponse,
-        phone_numbers_data_response: Responses::PhoneNumbersDataResponse
-      }.freeze
-
-      def initialize(response:, class_type:)
-        @data = class_type.build_from_response(response: response)
-        @error = Responses::ErrorResponse.build_from_response(response: response)
+      def initialize(response:, data_class_type:, error_class_type: Responses::MessageErrorResponse)
+        @data = data_class_type.build_from_response(response: response)
+        @error = error_class_type.build_from_response(response: response)
       end
 
+      # @return [Boolean] Whether or not the response is successful.
       def ok?
         @error.nil?
       end
 
+      # @return [Boolean] Whether or not the response has an error.
       def error?
         !!@error
       end

data/lib/whatsapp_sdk/api/responses/error_response.rb

@@ -1,32 +1,23 @@
 # frozen_string_literal: true
 
+require_relative "data_response"
+
 module WhatsappSdk
   module Api
     module Responses
-      class ErrorResponse
-        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+      class ErrorResponse < DataResponse
+        attr_accessor :error, :status
 
-        def initialize(code:, subcode:, message:, type:, data:, fbtrace_id:)
-          @code = code
-          @subcode = subcode
-          @message = message
-          @type = type
-          @data = data
-          @fbtrace_id = fbtrace_id
+        def initialize(response:)
+          @error = response["error"]
+          @status = response["status"]
+          super(response)
         end
 
         def self.build_from_response(response:)
-          error_response = response["error"]
-          return unless error_response
+          return unless response["error"]
 
-          new(
-            code: error_response["code"],
-            subcode: error_response["error_subcode"],
-            message: error_response["message"],
-            type: error_response["type"],
-            data: error_response["data"],
-            fbtrace_id: error_response["fbtrace_id"]
-          )
+          new(response: response)
         end
       end
     end

data/lib/whatsapp_sdk/api/responses/media_data_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MediaDataResponse < DataResponse
+        attr_accessor :id, :url, :mime_type, :sha256, :file_size, :messaging_product
+
+        def initialize(response)
+          @id = response["id"]
+          @messaging_product = response["messaging_product"]
+          @url = response["url"]
+          @mime_type = response["mime_type"]
+          @sha256 = response["sha256"]
+          @file_size = response["file_size"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["id"]
+
+          new(response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/message_error_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "error_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class MessageErrorResponse < ErrorResponse
+        attr_reader :code, :subcode, :message, :type, :data, :fbtrace_id
+
+        def initialize(response:)
+          @code = response["code"]
+          @subcode = response["error_subcode"]
+          @message = response["message"]
+          @type = response["type"]
+          @data = response["data"]
+          @fbtrace_id = response["fbtrace_id"]
+          super(response: response)
+        end
+
+        def self.build_from_response(response:)
+          error_response = response["error"]
+          return unless error_response
+
+          new(response: error_response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/read_message_data_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "../request"
+require_relative "data_response"
+require_relative "../../resource/message"
+require_relative "../../resource/contact_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class ReadMessageDataResponse < DataResponse
+        attr_reader :success
+
+        def initialize(response:)
+          @success = response["success"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return if response["error"]
+
+          new(response: response)
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/api/responses/success_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "data_response"
+
+module WhatsappSdk
+  module Api
+    module Responses
+      class SuccessResponse < DataResponse
+        def initialize(response:)
+          @success = response["success"]
+          super(response)
+        end
+
+        def self.build_from_response(response:)
+          return unless response["success"]
+
+          new(response: response)
+        end
+
+        def success?
+          @success
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/button_parameter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class ButtonParameter
+      class InvalidType < StandardError
+        attr_accessor :message
+
+        def initialize(type)
+          @message = "invalid type #{type}. type should be text or payload"
+          super
+        end
+      end
+
+      # Returns the button parameter type.
+      #
+      # @returns type [String] Valid options are payload and text.
+      attr_accessor :type
+
+      module Type
+        TEXT = "text"
+        PAYLOAD = "payload"
+
+        VALID_TYPES = [PAYLOAD, TEXT].freeze
+      end
+
+      # Required for quick_reply buttons.
+      # Returns the button payload. Developer-defined payload that is returned when the button is clicked
+      # in addition to the display text on the button.
+      #
+      # @returns payload [String]
+      attr_accessor :payload
+
+      # Required for URL buttons.
+      # Developer-provided suffix that is appended to the predefined prefix URL in the template.
+      #
+      # @returns text [String]
+      attr_accessor :text
+
+      def initialize(type:, payload: nil, text: nil)
+        @type = type
+        @payload = payload
+        @text = text
+        validate
+      end
+
+      def to_json(*_args)
+        json = {
+          type: type
+        }
+        json[:payload] = payload if payload
+        json[:text] = text if text
+        json
+      end
+
+      private
+
+      def validate
+        return if Type::VALID_TYPES.include?(type)
+
+        raise InvalidType, type
+      end
+    end
+  end
+end