whatsapp_sdk 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 789c30c096735aa557c643a11a810990c8bc2c207360bee7d0b0e9710f2de60c
-  data.tar.gz: 66bf61944f214767a8feae139e62d544be51c10e32895b33ca5239b3b1582009
+  metadata.gz: b4f5058be0fce569741f60508e508ec0b1cba2eccffbc5f510d7312cb023847b
+  data.tar.gz: 0af25be3aad6fdb5ffc60b014745294a0fa5cf496ce11ce68ebb886a774dfca4
 SHA512:
-  metadata.gz: cc2eef92ce66f87374e1f2fb0f5cfb01f9bbf5814ae80d625403660fd1fc9d834680fb72a06941c8d66f0fb30e9dabe5561231c4547cc2fd1daf651300b93193
-  data.tar.gz: fe548e9bfee0913a4eca4b1675342c565d35821e5d7b384908eebc0073b03616d7bc762ca8afefd1284dd6bd6ddffe88904b339e6448622b7675f09e68ed62e9
+  metadata.gz: 6f1ede78aafc6391e5de55ac4aa338a3286d5a9eb634a6afac22bf28cf39afa2f8e8356db2f266aa1bb7101ca122497b6036b843146fb77890c6f10d7460f7f8
+  data.tar.gz: 4b7524e665d2c13e4b8561e125b1cdbccbdfc1f95c49b7b465ce0e368918ce239a17afb58d83625b28a3288d803b25680b78167a967e69f3575d27071f7d9d2c

data/.rubocop.yml

@@ -11,7 +11,10 @@ Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 30
+  Max: 40
+
+Naming/VariableNumber:
+  Enabled: false
 
 Metrics/ClassLength:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Unreleased
+# v 0.1.0
+- Added Message Template API.
+- Added Currency and Datetime resources.
+- Added Media resource.
+- Added Component and ParameterObject resource.
+- Fixed bug in recipient_number in Messages API.
 
 # v 0.0.2
 - Implement read message.
 - Implement Yard doc.
-

data/README.md

@@ -117,98 +117,76 @@ messages_api.send_sticker(sender_id: 123123, recipient_number: "56789", sticker_
 ```
 
 **Send contacts message**
-To send a contact, you need to create a Contact instance object that contain objects embedded like 
-`addresses`, `birthday`, `emails`, `name`, `org`. See this [guide](/test/contact_helper.rb) to learn how to create contacts objects.
+To send a contact, you need to create a Contact instance object that contain objects embedded like `addresses`, `birthday`, `emails`, `name`, `org`. See this [guide](/test/contact_helper.rb) to learn how to create contacts objects.
 
 ```ruby
 contacts = [create_contact(params)]
 messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts: contacts)
 ```
 
-## Example
-
-<details><summary>Example in a single file. </summary>
-    
-1) Copy this code into a file and save it `example.rb`
-2) Replace the `ACCESS_TOKEN` constant with a valid `access_token`. 
-3) Run the file with the command `ruby example.rb`
-
+Alernative, you could pass a plain json like this:
 ```ruby
-# frozen_string_literal: true
-
-require 'bundler/inline'
-
-gemfile(true) do
-  source 'https://rubygems.org'
-
-  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-  gem "whatsapp_sdk"
-  gem "pry"
-  gem "pry-nav"
-end
-
-require 'whatsapp_sdk'
-require "pry"
-require "pry-nav"
+messages_api.send_contacts(sender_id: 123123, recipient_number: "56789", contacts_json: {...})
+```
 
-ACCESS_TOKEN = "12345" # replace this with a valid access_token
-SENDER_ID = 107878721936019
-RECEIPIENT_NUMBER = "1234"
+**Send a template message**
+WhatsApp message templates are specific message formats that businesses use to send out notifications or customer care messages to people that have opted in to notifications. Messages can include appointment reminders, shipping information, issue resolution or payment updates.
 
-client = WhatsappSdk::Api::Client.new(ACCESS_TOKEN) # replace this with a valid access_token
-messages_api = WhatsappSdk::Api::Messages.new(client)
-phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+**Before sending a message template, you need to create one.** visit the [Official API Documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates)
 
-phone_numbers_api.registered_number("107878721936019")
-phone_numbers_api.registered_numbers("114503234599312") 
+<details> <summary>Component's example</summary>
 
-messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, message: "hola")
-messages_api.send_location(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, 
-  longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
+```ruby
+currency = WhatsappSdk::Resource::Currency.new(code: "USD", amount: 1000, fallback_value: "1000")
+date_time = WhatsappSdk::Resource::DateTime.new(fallback_value: "2020-01-01T00:00:00Z")
+image = WhatsappSdk::Resource::Media.new(type: "image", link: "http(s)://URL")
+
+parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: image)
+parameter_text = WhatsappSdk::Resource::ParameterObject.new(type: "text", text: "TEXT_STRING")
+parameter_currency = WhatsappSdk::Resource::ParameterObject.new(type: "currency", currency: currency)
+parameter_date_time = WhatsappSdk::Resource::ParameterObject.new(type: "date_time", date_time: date_time)
+
+header_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::HEADER,
+  parameters: [parameter_image]
 )
 
-# Send images
-
-## with a link 
-messages_api.send_image(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "image_link", caption: "Ignacio Chiazzo Profile"
+body_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BODY,
+  parameters: [parameter_text, parameter_currency, parameter_date_time]
 )
 
-## with an image id 
-messages_api.send_image(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, image_id: "1234", caption: "Ignacio Chiazzo Profile"
+button_component1 = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  index: 0,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  parameters: [
+    WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "PAYLOAD")
+  ]
 )
 
-# Send audios
-## with a link 
-messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "audio_link")
-
-## with an audio id 
-messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, audio_id: "1234")
-
-# Send documents
-## with a link 
-messages_api.send_document(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "document_link", caption: "Ignacio Chiazzo"
+button_component2 = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  index: 1,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  parameters: [
+    WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "PAYLOAD")
+  ]
 )
+@messages_api.send_template(sender_id: 12_345, recipient_number: "12345678", name: "hello_world", language: "en_US", components_json: [component_1])
+```
 
-## with a document id 
-messages_api.send_document(
-  sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, document_id: "1234", caption: "Ignacio Chiazzo"
-)
+</details>
 
-# send stickers
-## with a link 
-messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, link: "link")
+Alernative, you could pass a plain json like this:
+```ruby
+@messages_api.send_template(sender_id: 12_345, recipient_number: "12345678", name: "hello_world", language: "en_US", components_json: [{...}])
+```
 
-## with a sticker_id
-messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECEIPIENT_NUMBER, sticker_id: "1234")
-binding.pry
+## Example
+
+Visit [the example file](/example.rb) with examples to call the API in a single file.
 
-```
-</details>
 
 ## Whatsapp Cloud API
 

data/example.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# 1) Copy this code into a file and save it `example.rb`
+# 2) Replace the `ACCESS_TOKEN` constant with a valid `access_token`.
+# 3) Run the file with the command `ruby example.rb`
+
+require 'bundler/inline'
+
+gemfile(true) do
+  source 'https://rubygems.org'
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "whatsapp_sdk"
+  gem "pry"
+  gem "pry-nav"
+end
+
+require 'whatsapp_sdk'
+require "pry"
+require "pry-nav"
+
+ACCESS_TOKEN = "foo" # replace this with a valid access_token
+SENDER_ID = 123
+RECIPIENT_NUMBER = "456"
+
+client = WhatsappSdk::Api::Client.new(ACCESS_TOKEN) # replace this with a valid access_token
+messages_api = WhatsappSdk::Api::Messages.new(client)
+phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
+
+phone_numbers_api.registered_number("123")
+phone_numbers_api.registered_numbers("457")
+
+messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message: "hola")
+messages_api.send_location(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
+  longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
+)
+
+# Send images
+
+## with a link
+messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "image_link", caption: "Ignacio Chiazzo Profile"
+)
+
+## with an image id
+messages_api.send_image(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, image_id: "1234", caption: "Ignacio Chiazzo Profile"
+)
+
+# Send audios
+## with a link
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "audio_link")
+
+## with an audio id
+messages_api.send_audio(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, audio_id: "1234")
+
+# Send documents
+## with a link
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "document_link", caption: "Ignacio Chiazzo"
+)
+
+## with a document id
+messages_api.send_document(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, document_id: "1234", caption: "Ignacio Chiazzo"
+)
+
+# send stickers
+## with a link
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, link: "link")
+
+## with a sticker_id
+messages_api.send_sticker(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, sticker_id: "1234")
+
+# Send a template.
+# Note: The template must have been created previously.
+
+header_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::HEADER
+)
+
+image = WhatsappSdk::Resource::Media.new(type: "image", link: "http(s)://URL", caption: "caption")
+document = WhatsappSdk::Resource::Media.new(type: "document", link: "http(s)://URL", filename: "txt.rb")
+video = WhatsappSdk::Resource::Media.new(type: "video", id: 123)
+
+parameter_image = WhatsappSdk::Resource::ParameterObject.new(
+  type: "image",
+  image: image
+)
+
+parameter_document = WhatsappSdk::Resource::ParameterObject.new(
+  type: "document",
+  document: document
+)
+
+parameter_video = WhatsappSdk::Resource::ParameterObject.new(
+  type: "video",
+  video: video
+)
+
+parameter_text = WhatsappSdk::Resource::ParameterObject.new(
+  type: "text",
+  text: "I am a text"
+)
+
+header_component.add_parameter(parameter_text)
+header_component.add_parameter(parameter_image)
+header_component.add_parameter(parameter_video)
+header_component.add_parameter(parameter_document)
+header_component.to_json
+
+body_component = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BODY
+)
+body_component.add_parameter(parameter_text)
+body_component.add_parameter(parameter_image)
+body_component.add_parameter(parameter_video)
+body_component.add_parameter(parameter_document)
+body_component.to_json
+
+button_component_1 = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  index: 0,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  parameters: [WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "payload")]
+)
+
+button_component_2 = WhatsappSdk::Resource::Component.new(
+  type: WhatsappSdk::Resource::Component::Type::BUTTON,
+  index: 1,
+  sub_type: WhatsappSdk::Resource::Component::Subtype::QUICK_REPLY,
+  parameters: [WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "payload")]
+)
+
+# make sure that the template was created
+response_with_json = messages_api.send_template(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, name: "hello_world", language: "en_US",
+  components_json: [
+    {
+      "type": "header",
+      "parameters": [
+        {
+          "type": "image",
+          "image": {
+            "link": "https://www.google.com/imgres?imgurl=https%3A%2F%2Fqph.cf2.quoracdn.net%2Fmain-qimg-6d977408fdd90a09a1fee7ba9e2f777c-lq&imgrefurl=https%3A%2F%2Fwww.quora.com%2FHow-can-I-find-my-WhatsApp-ID&tbnid=lDAx1vzXwqCakM&vet=12ahUKEwjKupLviJX4AhVrrHIEHQpGD9MQMygAegUIARC9AQ..i&docid=s-DNQVCrZmhJYM&w=602&h=339&q=example%20whatsapp%20image%20id&ved=2ahUKEwjKupLviJX4AhVrrHIEHQpGD9MQMygAegUIARC9AQ"
+          }
+        }
+      ]
+    }
+  ]
+)
+puts response_with_json
+
+response_with_object = messages_api.send_template(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, name: "hello_world", language: "en_US",
+  components: [header_component, body_component, button_component_1, button_component_2]
+)
+puts response_with_object

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhatsappSdk
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/whatsapp_sdk/api/messages.rb

@@ -25,7 +25,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "text",
           "text": { body: message }
         }
@@ -51,7 +51,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "location",
           "location": {
             "longitude": longitude,
@@ -83,7 +83,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "image"
         }
         params[:image] = if link
@@ -113,7 +113,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "audio"
         }
         params[:audio] = link ? { link: link } : { id: audio_id }
@@ -140,7 +140,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "video"
         }
         params[:video] = if link
@@ -171,7 +171,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "document"
         }
         params[:document] = if link
@@ -200,7 +200,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "sticker"
         }
         params[:sticker] = link ? { link: link } : { id: sticker_id }
@@ -225,7 +225,7 @@ module WhatsappSdk
         params = {
           messaging_product: "whatsapp",
           to: recipient_number,
-          recepient_type: "individual",
+          recipient_type: "individual",
           type: "contacts"
         }
         params[:contacts] = contacts ? contacts.map(&:to_h) : contacts_json
@@ -267,7 +267,50 @@ module WhatsappSdk
           params: params
         )
 
-        WhatsappSdk::Api::Response.new(response: response, class_type: WhatsappSdk::Api::Responses::MessageDataResponse)
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          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,
+          class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
       end
 
       private

data/lib/whatsapp_sdk/api/response.rb

@@ -3,6 +3,7 @@
 require_relative "responses/message_data_response"
 require_relative "responses/phone_number_data_response"
 require_relative "responses/phone_numbers_data_response"
+require_relative "responses/read_message_data_response"
 require_relative "responses/error_response"
 
 module WhatsappSdk
@@ -14,7 +15,7 @@ module WhatsappSdk
         message_data_response: Responses::MessageDataResponse,
         phone_number_data_response: Responses::PhoneNumberDataResponse,
         phone_numbers_data_response: Responses::PhoneNumbersDataResponse,
-        read_message_data_response: ReadMessageDataResponse
+        read_message_data_response: Responses::ReadMessageDataResponse
       }.freeze
 
       def initialize(response:, class_type:)

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

@@ -8,7 +8,7 @@ require_relative "../../resource/contact_response"
 module WhatsappSdk
   module Api
     module Responses
-      class MessageDataResponse < DataResponse
+      class ReadMessageDataResponse < DataResponse
         attr_reader :sucess
 
         def initialize(response:)

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

data/lib/whatsapp_sdk/resource/component.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Component
+      class InvalidField < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      module Type
+        HEADER = 'header'
+        BODY = 'body'
+        BUTTON = 'button'
+      end
+
+      module Subtype
+        QUICK_REPLY = "quick_reply"
+        URL = "url"
+      end
+
+      # Returns the Component type.
+      #
+      # @returns type [String]. Supported Options are header, body and button.
+      attr_accessor :type
+
+      # Returns the parameters of the component. For button type, it's required.
+      #
+      # @returns parameter [Array<ButtonParameter, ParameterObject>] .
+      attr_accessor :parameters
+
+      # Returns the Type of button to create. Required when type=button. Not used for the other types.
+      # Supported Options
+      # quick_reply: Refers to a previously created quick reply button
+      # that allows for the customer to return a predefined message.
+      # url: Refers to a previously created button that allows the customer to visit the URL generated by
+      # appending the text parameter to the predefined prefix URL in the template.
+      #
+      # @returns subtype [String]. Valid options are quick_reply and url.
+      attr_accessor :sub_type
+
+      # Required when type=button. Not used for the other types.
+      # Position index of the button. You can have up to 3 buttons using index values of 0 to 2.
+      #
+      # @returns index [Integer].
+      attr_accessor :index
+
+      def add_parameter(parameter)
+        @parameters << parameter
+      end
+
+      def initialize(type:, parameters: [], sub_type: nil, index: nil)
+        @parameters = parameters
+        @type = type
+        @sub_type = sub_type
+        @index = index.nil? && type == Type::BUTTON ? 0 : index
+        validate_fields
+      end
+
+      def to_json(*_args)
+        json = {
+          type: type,
+          parameters: parameters.map(&:to_json)
+        }
+        json[:sub_type] = sub_type if sub_type
+        json[:index] = index if index
+        json
+      end
+
+      private
+
+      def validate_fields
+        return if type == Type::BUTTON
+        raise InvalidField.new(:sub_type, 'sub_type is not required when type is not button') if sub_type
+
+        raise InvalidField.new(:index, 'index is not required when type is not button') if index
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/currency.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Currency
+      # Returns default text if localization fails.
+      #
+      # @returns fallback_value [String].
+      attr_accessor :fallback_value
+
+      # Currency code as defined in ISO 4217.
+      #
+      # @returns code [String].
+      attr_accessor :code
+
+      # Amount multiplied by 1000.
+      #
+      # @returns code [Float].
+      attr_accessor :amount
+
+      def initialize(fallback_value:, code:, amount:)
+        @fallback_value = fallback_value
+        @code = code
+        @amount = amount
+      end
+
+      def to_json(*_args)
+        {
+          fallback_value: fallback_value,
+          code: code,
+          amount_1000: amount
+        }
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/date_time.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class DateTime
+      # Returns default text if localization fails.
+      #
+      # @returns fallback_value [String].
+      attr_accessor :fallback_value
+
+      def initialize(fallback_value:)
+        @fallback_value = fallback_value
+      end
+
+      def to_json(*_args)
+        {
+          fallback_value: fallback_value
+        }
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/media.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class Media
+      class InvalidMedia < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      # Returns media id.
+      #
+      # @returns id [String].
+      attr_accessor :id
+
+      module Type
+        AUDIO = 'audio'
+        DOCUMENT = 'document'
+        IMAGE = 'image'
+        VIDEO = 'video'
+        STICKER = 'sticker'
+
+        VALID_TYPES = [AUDIO, DOCUMENT, IMAGE, VIDEO, STICKER].freeze
+      end
+
+      # @returns type [String]. Valid options ar audio, document, image, video and sticker.
+      attr_accessor :type
+
+      # The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.
+      # Do not use this field when the message type is set to text.
+      #
+      # @returns link [String].
+      attr_accessor :link
+
+      # Describes the specified document or image media.
+      #
+      # @returns caption [String].
+      attr_accessor :caption
+
+      # Describes the filename for the specific document. Use only with document media.
+      #
+      # @returns filename [String].
+      attr_accessor :filename
+
+      def initialize(type:, id: nil, link: nil, caption: nil, filename: nil)
+        @type = type
+        @id = id
+        @link = link
+        @caption = caption
+        @filename = filename
+        validate_media
+      end
+
+      def to_json(*_args)
+        json = {}
+        json[:id] = id unless id.nil?
+        json[:link] = link unless link.nil?
+        json[:caption] = caption unless caption.nil?
+        json[:filename] = filename unless filename.nil?
+        json
+      end
+
+      private
+
+      def validate_media
+        unless Type::VALID_TYPES.include?(type)
+          raise InvalidMedia.new(:type, "invalid type. type should be audio, document, image, video or sticker")
+        end
+        if filename && (type != Type::DOCUMENT)
+          raise InvalidMedia.new(:filename, "filename can only be used with document")
+        end
+
+        if caption && !(type == Type::DOCUMENT || type == Type::IMAGE)
+          raise InvalidMedia.new(:caption, "caption can only be used with document or image")
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk/resource/parameter_object.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module WhatsappSdk
+  module Resource
+    class ParameterObject
+      class InvalidType < StandardError
+        attr_accessor :message
+
+        def initialize(type)
+          @message = "invalid type #{type}. type should be text, currency, date_time, image, document or video"
+          super
+        end
+      end
+
+      class MissingValue < StandardError
+        attr_reader :field, :message
+
+        def initialize(field, message)
+          @field = field
+          @message = message
+          super(message)
+        end
+      end
+
+      # Returns the parameter type.
+      #
+      # @returns type [String] Valid options are text, currency, date_time, image, document, video.
+      attr_accessor :type
+
+      module Type
+        TEXT = "text"
+        CURRENCY = "currency"
+        DATE_TIME = "date_time"
+        IMAGE = "image"
+        DOCUMENT = "document"
+        VIDEO = "video"
+
+        VALID_TYPES = [TEXT, CURRENCY, DATE_TIME, IMAGE, DOCUMENT, VIDEO].freeze
+      end
+
+      # Returns Text string if the parameter object type is text.
+      # For the header component, the character limit is 60 characters.
+      # For the body component, the character limit is 1024 characters.
+      #
+      # @returns text [String]
+      attr_accessor :text
+
+      # Returns Currency if the parameter object type is currency.
+      #
+      # @returns currency [Currency]
+      attr_accessor :currency
+
+      # Returns date_time if the parameter object type is date_time.
+      #
+      # @returns date_time [DateTime]
+      attr_accessor :date_time
+
+      # Returns image if the parameter object type is image.
+      #
+      # @returns image [Media]
+      attr_accessor :image
+
+      # Returns document if the parameter object type is document.
+      #
+      # @returns document [Media]
+      attr_accessor :document
+
+      # Returns video if the parameter object type is video.
+      #
+      # @returns video [Media]
+      attr_accessor :video
+
+      def initialize(type:, text: nil, currency: nil, date_time: nil, image: nil, document: nil, video: nil)
+        @type = type
+        @text = text
+        @currency = currency
+        @date_time = date_time
+        @image = image
+        @document = document
+        @video = video
+        validate
+      end
+
+      def to_json(*_args)
+        json = { type: type }
+        json[type.to_sym] = case type
+                            when "text"
+                              text
+                            when "currency"
+                              currency.to_json
+                            when "date_time"
+                              date_time.to_json
+                            when "image"
+                              image.to_json
+                            when "document"
+                              document.to_json
+                            when "video"
+                              video.to_json
+                            else
+                              raise "Invalid type: #{type}"
+                            end
+
+        json
+      end
+
+      private
+
+      def validate
+        validate_attributes
+        validate_type
+      end
+
+      def validate_type
+        return if Type::VALID_TYPES.include?(type)
+
+        raise InvalidType, type
+      end
+
+      def validate_attributes
+        [
+          [:text, text],
+          [:currency, currency],
+          [:date_time, date_time],
+          [:image, image],
+          [:document, document],
+          [:video, video]
+        ].each do |type_sym, value|
+          next unless type == type_sym
+          raise MissingValue.new(type, "#{type} is required when the type is #{type}") if value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/whatsapp_sdk.rb

@@ -11,14 +11,21 @@ require_relative "whatsapp_sdk/api/responses/phone_number_data_response"
 require_relative "whatsapp_sdk/api/responses/phone_numbers_data_response"
 require_relative "whatsapp_sdk/api/responses/error_response"
 require_relative "whatsapp_sdk/api/responses/data_response"
+require_relative "whatsapp_sdk/api/responses/read_message_data_response"
 
 # Resources
 require_relative "whatsapp_sdk/resource/address"
+require_relative "whatsapp_sdk/resource/button_parameter"
+require_relative "whatsapp_sdk/resource/component"
 require_relative "whatsapp_sdk/resource/contact_response"
 require_relative "whatsapp_sdk/resource/contact"
+require_relative "whatsapp_sdk/resource/currency"
+require_relative "whatsapp_sdk/resource/date_time"
 require_relative "whatsapp_sdk/resource/email"
+require_relative "whatsapp_sdk/resource/media"
 require_relative "whatsapp_sdk/resource/message"
 require_relative "whatsapp_sdk/resource/name"
 require_relative "whatsapp_sdk/resource/org"
+require_relative "whatsapp_sdk/resource/parameter_object"
 require_relative "whatsapp_sdk/resource/phone_number"
 require_relative "whatsapp_sdk/resource/url"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,6 +102,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example.rb
 - lib/version.rb
 - lib/whatsapp_sdk.rb
 - lib/whatsapp_sdk/api/client.rb
@@ -117,12 +118,18 @@ files:
 - lib/whatsapp_sdk/api/responses/read_message_data_response.rb
 - lib/whatsapp_sdk/error.rb
 - lib/whatsapp_sdk/resource/address.rb
+- lib/whatsapp_sdk/resource/button_parameter.rb
+- lib/whatsapp_sdk/resource/component.rb
 - lib/whatsapp_sdk/resource/contact.rb
 - lib/whatsapp_sdk/resource/contact_response.rb
+- lib/whatsapp_sdk/resource/currency.rb
+- lib/whatsapp_sdk/resource/date_time.rb
 - lib/whatsapp_sdk/resource/email.rb
+- lib/whatsapp_sdk/resource/media.rb
 - lib/whatsapp_sdk/resource/message.rb
 - lib/whatsapp_sdk/resource/name.rb
 - lib/whatsapp_sdk/resource/org.rb
+- lib/whatsapp_sdk/resource/parameter_object.rb
 - lib/whatsapp_sdk/resource/phone_number.rb
 - lib/whatsapp_sdk/resource/url.rb
 - whatsapp_sdk.gemspec