Is your feature request related to a problem? Please describe.

Add share product on Whatsapp.

Documentation

Example:

This requires the Interactive API #8

Add media https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#get-media-id

Steps)

1. Create a medias file, similar to what messages does.
2. The media file will have 4 methods GET (x2)/DELETE/POST/
3. Add tests
4. Add media examples to the example.rb file and to the README.

I created a template for WhatsApp and the template includes a button that has a dynamic URL, I'm trying to use that template to send a message, but I'm getting an error, I'm not sure what am I doing wrong here. I attached images with my code and the error I'm getting.

Thank you,

Describe the bug
After we try to use the gem in our production Environment (Linux Server) we faced with a error:
Zeitwerk::NameError
It just happens in Linux but when we test in a MacOS everything is working fine.

To Reproduce
Steps to reproduce the behavior:

1. Ruby version: 2.7.1
2. Rails 6.0.4.4
3. ruby_whatsapp_sdk-0.5.1

Expected behavior
Start the server and send whatsapp messages through the gem

Additional context
Nothing

The messages_api allows users to send interactive messages.

We need to implement the functions defined in messages.rb

Read the FB documentation here.

The API just released, adding the location to the template via headers:

API responses to template creation and editing requests now include the template's status and category.

This PR introduced the business API. It's missing websites #53 (review).

TODO:

• Add websites to the business profile data response
• Add tests for receiving business profiles.

#53

The API just released a new change to the template response:

https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/#add-location-header-to-your-template

Use the example in the readme and add a tutorial on how to use it.

Example:

   Create a business account by visiting ....


   set the following variables: 
   ACCESS_TOKEN
   FROM_BUSINESS_NUMBER
   TO_PHONE_NUMBER


   # show some examples of how to use it to validate that the response is received.

We can even use this tutorial as an integration test with a real device, of course, the numbers should be opaque in the tutorial.

The business_id/registered_numbers API returns an array of phone_numbers and a cursor to the next and previous page. If the set has more than 250 numbers there is no way to paginate them in the SDK. We should introduce a module that can paginate resources easily and add it to the mentioned API.

Cloud API released register API.

Steps to implement it:

• Create the methods register and deregister in the file lib/whatsapp_sdk/api/phone_numbers.rb similar to the other two methods (you need to use http POST).
• Add a test file.

See documentation.

https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object

Currently, the Whatsapp API version is hardcoded here. We should expose a way for apps to set up the API version during initialization.

For example, we could provide a config method api_version which sets the version for all API requests.

Hints

The configuration lives in configuration.rb. We could accept an api_version argument which is used across the API.

If the argument isn't passed, we'd use the hardcoded version.

Add Business profile API https://developers.facebook.com/docs/whatsapp/cloud-api/reference/business-profiles

TODO:
Add the new business profile API

• Create a file business_profile.rb in lib/whatsapp_sdk/api/business_profile.rb, similar to https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/blob/main/lib/whatsapp_sdk/api/phone_numbers.rb.
• Add a test file.
• Add get method
• Add update method

Documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/business-profiles

https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-message-templates

Hi, can you help me? I need to track users messages and answers, how i can use session? For example rack?
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Additional context
Add any other context or screenshots about the feature request here.

Hi!
Could you tell me how to get a Access Token?
Do you have some step by step for that?

config.access_token = ACCESS_TOKEN

Thank you!

Responses must return objects never copy the fields.

Context

The API returns a JSON object which is converted to a Response object.

We also have resources that model the different artifacts Whatsapp provides: Message, Media (image/video/document), component among others.

Problem

Some of the responses have implemented fields as opposed to contain resources. For example

# bad
class MessageDataResponse
  attr_accessor: URL
  attr_accessor: id

end

# good
class MessageDataResponse
  attr_accessor: message # message contains URL, id and others
end

Action items

Update the following responses:

• The MediaDataResponse must contain a media.
• The PhoneNumberDataResponse must contain phone numbers.
• BusinessProfileDataResponse must contain a business resource (it doesn't exist yet).

We should build a website for documentation as opposed to have it on the README only.

I propose we use Docusaurus https://github.com/facebook/docusaurus

Implement new API just released: Whatsapp commerce settings https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings

https://developers.facebook.com/docs/whatsapp/cloud-api/guides/mark-message-as-read

Hi, I currently can't use this in jruby because it depends on oj, which is a C extension. Would you consider making oj an optional part of this gem and supporting other jruby-compatible json implementations? Thanks!

The main module requires a few library in the main entrypoint whatsapp_sdk

faraday and faraday/multipart are only required when sending http requests in the client.

TODO:

• Remove the require file from the whatsapp_sdk module
• Add the require file to the places needed.
• Run all the tests and make sure they pass.
• Grab an access token and run the example.rb file and make sure it sends the requests properly. Note: If the API says that the mssage was sent but it wasn't delivered to your phone, check the troubleshooting section.

According to the documentation

phone_numbers_api.register_number(phone_number_id, pin)

Will register a Phone Number on the account.

How do I generate the PIN on the phone to be registered?

Cloud API just released a reaction API

https://developers.facebook.com/docs/whatsapp/cloud-api/guides/send-messages#reaction-messages

TODO

• Add a new function to the messages.rb file similar to any other type of message
  

  ruby_whatsapp_sdk/lib/whatsapp_sdk/api/messages.rb

  Lines 64 to 94 in abd53ef

  	sig do
  	params(
  	sender_id: Integer, recipient_number: Integer,
  	longitude: Float, latitude: Float, name: String, address: String
  	).returns(WhatsappSdk::Api::Response)
  	end
  	def send_location(sender_id:, recipient_number:, longitude:, latitude:, name:, address:)
  	params = {
  	messaging_product: "whatsapp",
  	to: recipient_number,
  	recipient_type: "individual",
  	type: "location",
  	location: {
  	longitude: longitude,
  	latitude: latitude,
  	name: name,
  	address: address
  	}
  	}
  	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

The type should be reaction and the hptt method is post.

• Add test in the message https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/blob/main/test/whatsapp/api/messages_test.rb

Add Sorbet type checking to the gem.

Describe the bug
Every time when i get error my code print Error: #WhatsappSdk::Api::Responses::MessageErrorResponse:0x00007fb9a00fc9e8

message_response = messages_api.send_text(
                sender_id: sender_id,
                recipient_number: from.to_i,
                message: send_message,
              )

              if message_response.ok?
                puts "Message sent to: #{message_response.data.contacts.first.input}"

                # to = message_response.data.contacts.first.input
              else
                puts "Error: #{message_response.error&.to_s}"
              end

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'

Expected behavior
A clear and concise description of what you expected to happen.

Additional context
Add any other context about the problem here.

👋 It took a little effort to understand if the official API required payment, it seems up to 1000 conversations/month are free, then there's a charge:

https://developers.facebook.com/docs/whatsapp/pricing/

Meta released Media HTTP caching for images. Documentation.

To implement this feature, we need to follow the next steps:

• Add headers to the upload media endpoint

  ruby_whatsapp_sdk/lib/whatsapp_sdk/api/medias.rb

  Lines 75 to 90 in 422c3cc

  	def upload(sender_id:, file_path:, type:)
  	raise FileNotFoundError, file_path unless File.file?(file_path)
  	params = {
  	messaging_product: "whatsapp",
  	file: Faraday::FilePart.new(file_path, type),
  	type: type
  	}
  	response = send_request(http_method: "post", endpoint: "#{sender_id}/media", params: params)
  	WhatsappSdk::Api::Response.new(
  	response: response,
  	data_class_type: WhatsappSdk::Api::Responses::MediaDataResponse
  	)
  	end

• Add tests to the media test file

I am exploring the whatapp api with this great gem.

As I'm new to the whatsapp api, I do a lot of stupid mistakes. I have a hard time debbugging the mistakes I do because there no way to attach a logger to Faraday to see the HTTP requests (with headers and bodies).

It would be nice if while configuring the client one could set a logger:

# config/initializers/whatsapp_sdk.rb
WhatsappSdk.configure do |config|
  config.access_token = ACCESS_TOKEN
  config.logger = Rails.logger
end

Describe the bug
When receive a image/webp (sticker eg) the download medias doesn't work

To Reproduce

1. Send a sticker image
2. Try download :)

Expected behavior
Download happened

Additional context

I Made a ugly monkey patch

WhatsappSdk::Resource::MediaTypes::IMAGE_TYPES = WhatsappSdk::Resource::MediaTypes::IMAGE_TYPES.dup
WhatsappSdk::Resource::MediaTypes::IMAGE_TYPES.push("image/webp")
WhatsappSdk::Resource::MediaTypes::IMAGE_TYPES.freeze


WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES = WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.dup
WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.push("image/webp")
WhatsappSdk::Resource::MediaTypes::SUPPORTED_MEDIA_TYPES.freeze

and all worked :)

Describe the bug
After to finish all configuration and added the new phone number, when i try to send a message using the Gem, I receive the message "message sent" but the recipient dont receive any message.

To Reproduce
Steps to reproduce the behavior:
the Code below:
def send_whatsapp_message
@config = Config.first
require 'whatsapp_sdk'

#variables
access_token = @config.access_token_whats
business_id = @config.business_id_whats
sender_id = @config.sender_id_whats
recipient_number = params[:numero_whatsapp]

client = WhatsappSdk::Api::Client.new(access_token) # replace this with a valid access token
messages_api = WhatsappSdk::Api::Messages.new(client)

message_sent = messages_api.send_text(sender_id: sender_id.to_i, recipient_number: recipient_number.to_i, message: params[:mensagem].to_s)
print_message_sent(message_sent)
redirect_back(fallback_location: root_path)
end

def print_message_sent(message_response)
if message_response.ok?
sweetalert_success("Mensagem enviada com sucesso para: #{message_response.data.contacts.first.input}", 'Sucesso!', persistent: 'Ok')
puts "Message sent to: #{message_response.data.inspect}"
else
sweetalert_success("Ocorreu um erro: #{message_response.error&.to_s}", 'Erro:', persistent: 'Ok')
end
end

THIS IS MY RESPONSE:
Message sent to: #<WhatsappSdk::Api::Responses::MessageDataResponse:0x000000010667d728 @contacts=[#<WhatsappSdk::Resource::ContactResponse:0x000000010667d570 @input="5511991078572", @wa_id="5511991078572">], @messages=[#<WhatsappSdk::Resource::Message:0x000000010667d368 @id="wamid.HBgNNTUxMTk5MTA3ODU3MhUCABEYEjBFQkI2OEYyNTdBMTBDRUY1NwA=">], @raw_data_response={"messaging_product"=>"whatsapp", "contacts"=>[{"input"=>"5511991078572", "wa_id"=>"5511991078572"}], "messages"=>[{"id"=>"wamid.HBgNNTUxMTk5MTA3ODU3MhUCABEYEjBFQkI2OEYyNTdBMTBDRUY1NwA="}]}>

Expected behavior
The recipient receive the message.

If you look to my configs at images attached you can see that everything is configured, (I guess)
There is something else more to do?
thanks!

Additional context
Add any other context about the problem here



.

Implement authentication through this gem.

Sorbet is nice, but it's a pain to make everyone install it in production apps since it's not widely used and is not part of Ruby core.

Instead, Sorbet should be a development_dependency, and this gem should use *.rbs files to annotate types which are the Ruby-core way and can be read by Sorbet. The Ruby .rb files should be kept clean of Sorbet markup.

I think this is a best practice for gem maintainers.

Please let me know if you'd accept a PR for this.

A new endpoint was just released `template-comparison https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/template-comparison

Tried all the steps in the description

Is your feature request related to a problem? Please describe.

Today when business profile is updated, doesn´t have any check if vertical is correct, based on: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/business-profiles/ we can validate if vertical supplied is correct

Instead of passing the token everywhere, we can have a singleton that stores the token and is used in every client call.

Example:

#before
client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>")
messages_api = WhatsappSdk::Api::Messages.new(client)
phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new(client)
phone_numbers_api.registered_numbers("123456")

# after
### we can have an initializer that stores the access token
WhatsappSdk::Api::Client.setup do |client|
  client.access_token = "<ACCESS TOKEN>"
end

WhatsappSdk::Api::PhoneNumbers.registered_numbers("123456")

Describe the bug
We use this gem in our Rails application, thank you so much for providing it!

While the regular rails stack still seems to work fine, the zeitwerk:check rake task that we use for linting in CI fails now:

$ rails r 'pp true'
true

$ rails zeitwerk:check
Hold on, I am eager loading the application.
rails aborted!
Errno::ENOENT: No such file or directory @ rb_check_realpath_internal - config/api_versions.yml (Errno::ENOENT)

Tasks: TOP => zeitwerk:check
(See full trace by running task with --trace)

To Reproduce
Steps to reproduce the behavior:

1. Run rails zeitwerk:check in your rails app.

Expected behavior
No error should occur.

Additional context

It seems that the recent changes from #126 introduced a regression.

Could it be an alternative to switch from loading a yaml file to preparing the list directly in a ruby file?

Hello,

So it seems the access token provided by Facebook is temporary and it needs to be refreshed each day I think, is that implemented inside the gem, or do I need to handle that from my end?

Thank you,

Hi, from what I saw the SDK doesn't support group management, I'll put some things here to understand how the groups API works

• Create Group
• Update group info
• Send message in group
• Remove group participant

Add yardoc to the public functions so that consumers can use it easily.

Is your feature request related to a problem? Please describe.

Meta just released a new API: https://developers.facebook.com/docs/whatsapp/cloud-api/phone-numbers/conversational-components/#using-the-api

We should add support to it in the gem.

Discussed in #92

message_sent = messages_api.send_text(sender_id: sender, recipient_number: phone_numbers, message: "Hey there! it's Whatsapp Ruby SDK")
message_id = message_sent.data.messages.first.id
puts message_id

Is your feature request related to a problem? Please describe.
I'm working on a use-case that involves replying to users' messages with context, i.e., against an existing conversation, shown as below.

Additional context
Documentation
Enabling this would require to pass context object with the request params, which will have the message_id for the user message. Replies seem to be supported for text, audio, document, video, location, sticker and contact.

Please let me know how I can help out here in case you wish to incorporate the support in this helpful library.

Is your feature request related to a problem? Please describe.

For change Profile Picture, sic, the upload of image works different of rest the cloud sdk api, it's based on resumable interface.

Specification for profile_picture_handle field in:
https://developers.facebook.com/docs/whatsapp/cloud-api/reference/business-profiles/

Resumable Interface Upload:
https://developers.facebook.com/docs/graph-api/guides/upload

Additional context
I Tried use Koala gem, but only helped for call the graph api, does not have support for resumable upload too

Hi, I have following issue, pls take a look

Base on my research, Whatsapp let us add maximum 2 phone numbers to an Whatsapp business account.
So now if I have an system with multiple users register as a business (ex: user1 is owner of flower company, user2 is owner of food company...) and I want to integrate Whatsapp API (send messages, reply, get messages...) for each their customers. The whole system with a lot of 'business users' (user1, user2...) will be use same phone numbers as registered to Whatsapp developer app before when they send messages to their customers, right ? So when customer receive messages, they will see same name of business with same phone number.

Can we use each phone number of users when they registered to system when send messages through Whatsapp ?

I believe this is a little detail but it would be better if the dependencies defined in the gemspec did not fix minor or patch versions, otherwise projects that include this gem will never be able to update these dependencies without a release even if they are compatible (semver)

Additional context
An example of this is now occurring with Faraday.

Gemspec

spec.add_dependency("faraday", "~> 2.7.10")

The last Faraday version is v2.7.11 and theres no breaking changes.

Add rubocop performance https://github.com/rubocop/rubocop-performance