whatsapp_sdk 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d31bd48fd780c01049dfb4057424ce55cc6bc5092a5b250900482044bd8622
-  data.tar.gz: 0a76d504966100b86add6394bd69af61863575c05d3c67db74eab934a199fb5a
+  metadata.gz: 1f391a609a7230a7772cf0328b570c84be187ce2c94d5f9858cb7fe3776798e4
+  data.tar.gz: 393eebc7cbb96780d02329f9f167b4c1c904bf1e900b9bf31baef72ef2ea4de8
 SHA512:
-  metadata.gz: 66dc2b2cad95e2b230203613be97fef11ea32bcaaba1f9a157a9e7d1336060690462a1e4b4202b31d9b4494158ea55a29b88e2b26b45ec16e67817054b653bc5
-  data.tar.gz: e9a7602a3f6f74a1ee043b21b4beee11160db4286eb28b4addbe5867c9b088bc796e612f62f8b1cd48200677b018f7b6c51c6bd99d456d9f3d2277d5479b55f6
+  metadata.gz: 96005fff84e2b54ae069ebc7dd49e3dcce72ce58f7269a5d20f8a9f25b29ba6fab6e42d2a1fbf33b0c8eb02b9e66663fcf8d441d86557cf5a21032906936e80c
+  data.tar.gz: c17e00d76ca9a9bd3d9348ae95bea014241dccd101c4f224a0844f85b28c8f7d80223aac542997b006515fb8bfb90a00aa4d4ca4a6479ac74253b28cff46ed01

data/CHANGELOG.md

@@ -1,5 +1,15 @@
+# unreleased 
+  
+# v 0.7.1
+Add Register API [#65](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/65)
+
+# v 0.7.0
+Add message reaction @sanchezpaco [#58](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/58)
+Add Business update API @sahilbansal17 [#56](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/56)
+Fix Sorbet bug BusinessAPI [#60](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/60)
+
 # v 0.6.2
-Add Business Profiles API [#53](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/53)
+Add Business Profiles API @sahilbansal17 [#53](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/53)
 
 # v 0.6.1
 Add raw_response to response [#47](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/46)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.6.2)
+    whatsapp_sdk (0.7.0)
       faraday (>= 2.3.0)
       faraday-multipart (~> 1.0.4)
       oj (~> 3.13.13)
@@ -108,6 +108,7 @@ GEM
     zeitwerk (2.6.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-21
   x86_64-linux
 

data/README.md

@@ -4,7 +4,7 @@
 <a href="https://codeclimate.com/github/ignacio-chiazzo/ruby_whatsapp_sdk/maintainability"><img src="https://api.codeclimate.com/v1/badges/169cce95450272e4ad7d/maintainability" /></a>
 
 The SDK provides a set of operations and classes to use the Whatsapp API.
-Send stickers, messages, audio, videos, and locations or just ask for the phone numbers through this library in a few steps!
+Send stickers, messages, audio, videos, locations, react to messages or just ask for the phone numbers through this library in a few steps!
 
 
 ## Demo
@@ -96,9 +96,9 @@ WhatsappSdk.configure do |config|
 end
 ```
 
-6) Try the Medias or Messages API
+6) Try the Phone Numbers API or Messages API
 
-Medias API
+Phone Numbers API
 ```ruby
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
 registered_number = phone_numbers_api.registered_number(SENDER_ID)
@@ -122,12 +122,27 @@ First, create the client and then create an instance `WhatsappSdk::Api::Messages
 messages_api = WhatsappSdk::Api::Messages.new
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
 medias_api = WhatsappSdk::Api::Medias.new
+business_profile_api = WhatsappSdk::Api::BusinessProfile.new
 ```
 
 Note: Remember to initialize the client first!
 
 ## APIs
 
+### Business Profile API
+<details>
+
+Get the details of your business
+```ruby
+business_profile = business_profile_api.details(123456)
+```
+
+Update the details of your business
+```ruby
+business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
+```
+</details>
+
 ### Phone numbers API
 
 <details>
@@ -141,6 +156,16 @@ Get the a phone number by id
 ```ruby
 phone_numbers_api.registered_numbers(123456) # accepts a phone_number_id
 ```
+
+Register a phone number
+```ruby
+phone_numbers_api.register_number(phone_number_id, pin)
+```
+
+Deregister a phone number
+```ruby
+phone_numbers_api.deregister_number(phone_number_id)
+```
 </details>
 
 ### Media API
@@ -184,6 +209,14 @@ messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M123456789
 
 Note: To get the `message_id` you can set up [Webhooks](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components) that will listen and fire an event when a message is received.
 
+**Send a reaction to message**
+To send a reaction to a message, you need to obtain the mssage id and look for the emoji's unicode you want to use.
+
+```ruby
+messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "\u{1f550}")
+
+messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "⛄️")
+```
 
 **Send a location message**
 

data/example.rb

@@ -11,7 +11,7 @@ gemfile(true) do
 
   git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-  gem "whatsapp_sdk", path: "."
+  gem "whatsapp_sdk"
   gem "pry"
   gem "pry-nav"
 end
@@ -22,11 +22,16 @@ require "pry-nav"
 
 ################# UPDATE CONSTANTS #################
 
-ACCESS_TOKEN = "EAAZAvvr0DZBs0BAFe8yjwJujpg5JZBX5DvzQ5Mv1oUBxuOefZAmi1TuRTkYmd9AqNqyTt2TtGict94yDWMmxb4fVQ3gZANjIb0IXXptezSad0xTHIZBpCNqZB8SBeBGL0eajPEjP1tZBwY3oyuOMwRU1ZAQuKMFkIV7Sw01AA3nX32plODm7LObsLp04C3aL7Pb1UF6OYKS0vPcqtFl21E9sf" # replace this with a valid access_token # TODO replace
-SENDER_ID = 111591145018464
-RECIPIENT_NUMBER = 13_437_772_910
-BUSINESS_ID = 102261539298487
-IMAGE_LINK = "https://ignaciochiazzo.com/static/4c403819b9750c8ad8b20a75308f2a8a/876d5/profile-pic.avif"
+ACCESS_TOKEN = "<TODO replace>"
+SENDER_ID = "<TODO replace>"
+RECIPIENT_NUMBER = "<TODO replace>"
+BUSINESS_ID = "<TODO replace>"
+IMAGE_LINK = "<TODO replace>"
+
+if ACCESS_TOKEN == "<TODO replace>"
+  puts "\n\n**** Please update the ACCESS_TOKEN constant in this file. ****\n\n"
+  exit
+end
 
 ################# Initialize Client #################
 WhatsappSdk.configure do |config|
@@ -46,13 +51,16 @@ end
 medias_api = WhatsappSdk::Api::Medias.new
 messages_api = WhatsappSdk::Api::Messages.new
 phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
-business_profile = WhatsappSdk::Api::BusinessProfile.new
+business_profile_api = WhatsappSdk::Api::BusinessProfile.new
 
-binding.pry
+############################## Business API ##############################
+business_profile = business_profile_api.details(SENDER_ID)
+business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
 
 ############################## Phone Numbers API ##############################
 registered_number = phone_numbers_api.registered_number(SENDER_ID)
 registered_numbers = phone_numbers_api.registered_numbers(BUSINESS_ID)
+
 ############################## Media API ##############################
 
 # upload a media
@@ -79,6 +87,12 @@ message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RE
                                       message: "Hey there! it's Whatsapp Ruby SDK")
 print_message_sent(message_sent)
 
+######### React to a message
+message_id = message_sent.data.messages.first.id
+messages_api.send_reaction(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message_id: message_id, emoji: "\u{1f550}")
+messages_api.send_reaction(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, message_id: message_id, emoji: "⛄️")
+
+######### Send location
 location_sent = messages_api.send_location(
   sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
   longitude: -75.6898604, latitude: 45.4192206, name: "Ignacio", address: "My house"

data/lib/whatsapp_sdk/api/business_profile.rb

@@ -7,7 +7,7 @@ require_relative "response"
 module WhatsappSdk
   module Api
     class BusinessProfile < Request
-      DEFAULT_FIELDS = 'about,address,description,email,profile_picture_url,websites,vertical'.freeze
+      DEFAULT_FIELDS = 'about,address,description,email,profile_picture_url,websites,vertical'
 
       # Get the details of business profile.
       #
@@ -25,6 +25,32 @@ module WhatsappSdk
           data_class_type: WhatsappSdk::Api::Responses::BusinessProfileDataResponse
         )
       end
+
+      # Update the details of business profile.
+      #
+      # @param phone_number_id [Integer] Phone Number Id.
+      # @param params [Hash] Params to update.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          phone_number_id: Integer, params: T::Hash[T.untyped, T.untyped]
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def update(phone_number_id:, params:)
+        # this is a required field
+        params[:messaging_product] = 'whatsapp'
+
+        response = send_request(
+          http_method: "post",
+          endpoint: "#{phone_number_id}/whatsapp_business_profile",
+          params: params
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::SuccessResponse
+        )
+      end
     end
   end
 end

data/lib/whatsapp_sdk/api/messages.rb

@@ -406,6 +406,42 @@ module WhatsappSdk
         )
       end
 
+      # Send reaction
+      #
+      # @param sender_id [Integer] Sender' phone number.
+      # @param recipient_number [Integer] Recipient' Phone number.
+      # @param message_id [String] the id of the message to reaction.
+      # @param emoji [String] unicode of the emoji to send.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          sender_id: Integer, recipient_number: Integer, message_id: String, emoji: T.any(String, Integer)
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def send_reaction(sender_id:, recipient_number:, message_id:, emoji:)
+        params = {
+          messaging_product: "whatsapp",
+          recipient_type: "individual",
+          to: recipient_number,
+          type: "reaction",
+          reaction: {
+            message_id: message_id,
+            emoji: emoji
+          }
+        }
+
+        response = send_request(
+          endpoint: endpoint(sender_id),
+          params: params,
+          headers: DEFAULT_HEADERS
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::MessageDataResponse
+        )
+      end
+
       private
 
       sig { params(sender_id: Integer).returns(String) }

data/lib/whatsapp_sdk/api/phone_numbers.rb

@@ -40,6 +40,52 @@ module WhatsappSdk
           data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
         )
       end
+
+      # Register a phone number.
+      #
+      # @param phone_number_id [Integer] The registered number we want to retrieve.
+      # @param pin [Integer] Pin of 6 digits.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          phone_number_id: Integer,
+          pin: Integer
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def register_number(phone_number_id, pin)
+        response = send_request(
+          http_method: "post",
+          endpoint: "#{phone_number_id}/register",
+          params: { messaging_product: 'whatsapp', pin: pin }
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
+        )
+      end
+
+      # Deregister a phone number.
+      #
+      # @param phone_number_id [Integer] The registered number we want to retrieve.
+      # @return [WhatsappSdk::Api::Response] Response object.
+      sig do
+        params(
+          phone_number_id: Integer
+        ).returns(WhatsappSdk::Api::Response)
+      end
+      def deregister_number(phone_number_id)
+        response = send_request(
+          http_method: "post",
+          endpoint: "#{phone_number_id}/deregister",
+          params: {}
+        )
+
+        WhatsappSdk::Api::Response.new(
+          response: response,
+          data_class_type: WhatsappSdk::Api::Responses::PhoneNumberDataResponse
+        )
+      end
     end
   end
 end

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

@@ -7,24 +7,30 @@ module WhatsappSdk
   module Api
     module Responses
       class BusinessProfileDataResponse < DataResponse
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :about
 
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :address
 
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :email
 
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :messaging_product
 
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :profile_picture_url
 
+        sig { returns(T.nilable(String)) }
+        attr_accessor :vertical
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :websites
+
         sig { params(response: T::Hash[T.untyped, T.untyped]).void }
         def initialize(response)
           @about = T.let(response["data"][0]["about"], T.nilable(String))
@@ -33,6 +39,8 @@ module WhatsappSdk
           @email = T.let(response["data"][0]["email"], T.nilable(String))
           @messaging_product = T.let(response["data"][0]["messaging_product"], T.nilable(String))
           @profile_picture_url = T.let(response["data"][0]["profile_picture_url"], T.nilable(String))
+          @vertical = T.let(response["data"][0]["vertical"], T.nilable(String))
+          @websites = T.let(response["data"][0]["websites"], T.nilable(T::Array[String]))
           super(response)
         end
 

data/lib/whatsapp_sdk/version.rb

@@ -2,5 +2,5 @@
 # typed: strict
 
 module WhatsappSdk
-  VERSION = "0.6.2"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - ignacio-chiazzo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler