whatsapp_sdk 0.12.1 → 1.0.0

data/README.md

@@ -35,11 +35,7 @@ There are three primary resources, `Messages`, `Media` and `PhoneNumbers`. `Mess
 
 To use `Messages`, `Media` or `PhoneNumbers`, you need to initialize the `Client` that contains auth information. There are two ways to do it.
 
-1. Use an initializer
-
-Note:
-Optionally, you can specify the desired API version to use (defaults to the latest version if omitted).
-Available API version can be found [here](https://developers.facebook.com/docs/graph-api/changelog/versions).
+#### Option 1) Use an initializer
 
 ```ruby
 # config/initializers/whatsapp_sdk.rb
@@ -50,23 +46,25 @@ WhatsappSdk.configure do |config|
   config.logger_options = { bodies: true } # optional, they are all valid logger_options for Faraday
 end
 ```
-More Details on Faraday Logger Options are [here](https://lostisland.github.io/faraday/#/middleware/included/logging?id=logging).
 
-OR 2) Create a `Client` instance and pass it to the `Messages`, `Medias` or `PhoneNumbers` instance like this:
+Notes:
+- Optionally, you can specify the desired API version to use (defaults to the latest version if omitted).
+Available API version can be found [here](https://developers.facebook.com/docs/graph-api/changelog/versions).
+- You can attach a logger. More Details on Faraday Logger Options are [here](https://lostisland.github.io/faraday/#/middleware/included/logging?id=logging).
+
+
+#### Option 2) Create a `Client` instance :
 
-**Without Logger:**
 ```ruby
+
+# without
 client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
-messages_api = WhatsappSdk::Api::Messages.new(client)
-```
-**With Logger:**
-```ruby
+
+# OR optionally use a logger, api_version and
 logger = Logger.new(STDOUT)
 logger_options = { bodies: true }
-client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>", "<API VERSION>", logger, logger_options) # replace this with a valid access token
-messages_api = WhatsappSdk::Api::Messages.new(client)
+client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>", "<API VERSION>", logger, logger_options)
 ```
-Each API operation returns a `WhatsappSdk::Api::Response` that contains `data` and `error` and a couple of helpful functions such as `ok?` and `error?`. There are three types of responses `WhatsappSdk::Api::MessageDataResponse`, `WhatsappSdk::Api::PhoneNumberDataResponse` and `WhatsappSdk::Api::PhoneNumbersDataResponse`. Each of them contains different attributes.
 
 ## Set up a Meta app
 
@@ -119,15 +117,13 @@ end
 Phone Numbers API
 
 ```ruby
-phone_numbers_api = WhatsappSdk::Api::PhoneNumbers.new
-registered_number = phone_numbers_api.registered_number(SENDER_ID)
+registered_number = client.phone_numbers.registered_number(SENDER_ID)
 ```
 
 Messages API
 
 ```ruby
-messages_api = WhatsappSdk::Api::Messages.new
-message_sent = messages_api.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
+message_sent = client.messages.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
                                       message: "Hey there! it's Whatsapp Ruby SDK")
 ```
 
@@ -135,19 +131,26 @@ Check the [example.rb file](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk
 
 </details>
 
-## Operations
-
-First, create the client and then create an instance `WhatsappSdk::Api::Messages` that requires a client as a param like this:
+## Sneak Peek
 
 ```ruby
-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
-templates_api = WhatsappSdk::Api::Templates.new
-```
+client = WhatsappSdk::Api::Client.new("<ACCESS TOKEN>") # replace this with a valid access token
+
+client.phone_numbers.register_number(SENDER_ID, 123456) # register the phone number to uplaod media and send message from.
+
+# send a text and a location
+client.messages.send_text(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,message: "Hey there! it's Whatsapp Ruby SDK")
 
-Note: Remember to initialize the client first!
+client.messages.send_location(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, longitude: -75.6898604, latitude: 45.4192206, name: "Ignacio", address: "My house")
+
+# upload a photo and send it
+image = client.media.upload(sender_id: SENDER_ID, file_path: "test/fixtures/assets/whatsapp.png", type: "image/png")image = client.media.get(media_id: uploaded_media.id)
+client.messages.send_image(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, image_id: image.id)
+
+# upload a sticker and send it
+sticker = client.media.upload(sender_id: SENDER_ID, file_path: "test/fixtures/assets/sticker.webp", type: "image/webp")
+client.messages.send_sticker(sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER, sticker_id: sticker.id)
+```
 
 ## APIs
 
@@ -157,64 +160,52 @@ Note: Remember to initialize the client first!
 
 ```ruby
 # Get list of templates
-templates_api.templates(business_id: BUSINESS_ID)
+client.templates.list(business_id: BUSINESS_ID)
+
+# Get Message Template Namespace
+# The message template namespace is required to send messages using the message templates.
+client.templates.get_message_template_namespace(business_id: BUSINESS_ID)
 
 # Create a template
-new_template = templates_api.create(
+client.templates.create(
   business_id: BUSINESS_ID, name: "seasonal_promotion", language: "en_US", category: "MARKETING",
   components_json: components_json, allow_category_change: true
 )
 
 # Delete a template
-templates_api.delete(business_id: BUSINESS_ID, name: "my_name") # delete by name
+client.templates.delete(business_id: BUSINESS_ID, name: "my_name") # delete by name
 ```
-
 </details>
 
 ### Business Profile API
 
 <details>
 
-Get the details of your business
-
 ```ruby
-business_profile = business_profile_api.details(123456)
-```
+# Get the details of your business
+client.business_profiles.get(phone_number_id)
 
-Update the details of your business
-
-```ruby
-business_profile_api.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
+# Update the details of your business
+client.business_profiles.update(phone_number_id: SENDER_ID, params: { about: "A very cool business" } )
 ```
-
 </details>
 
 ### Phone numbers API
 
 <details>
 
-Get the list of phone numbers registered
-
 ```ruby
-phone_numbers_api.registered_numbers(123456) # accepts a business_id
-```
+# Get the list of phone numbers registered
+client.phone_numbers.list(business_id)
 
-Get the a phone number by id
+# Get the a phone number by id
+client.phone_numbers.get(phone_number_id)
 
-```ruby
-phone_numbers_api.registered_numbers(123456) # accepts a phone_number_id
-```
-
-Register a phone number
+# Register a phone number
+client.phone_numbers.register_number(phone_number_id, pin)
 
-```ruby
-phone_numbers_api.register_number(phone_number_id, pin)
-```
-
-Deregister a phone number
-
-```ruby
-phone_numbers_api.deregister_number(phone_number_id)
+# Deregister a phone number
+client.phone_numbers.deregister_number(phone_number_id)
 ```
 
 </details>
@@ -223,188 +214,141 @@ phone_numbers_api.deregister_number(phone_number_id)
 
 <details>
 
-Upload a media
-
-```ruby
-medias_api.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
-```
-
-Get a media
-
 ```ruby
-media = medias_api.media(media_id: MEDIA_ID)
-```
+# Upload a media
+client.media.upload(sender_id: SENDER_ID, file_path: "tmp/whatsapp.png", type: "image/png")
 
-Download media
+# Get a media
+media = client.media.get(media_id: MEDIA_ID)
 
-```ruby
-medias_api.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png', media_type: "image/png")
-```
+# Download media
+client.media.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png', media_type: "image/png")
 
-Delete a media
-
-```ruby
-medias_api.delete(media_id: MEDIA_ID)
+# Delete a media
+client.media.delete(media_id: MEDIA_ID)
 ```
-
 </details>
 
 ### Messages API
 
 <details>
 
-**Send a text message**
-
-```ruby
-messages_api.send_text(sender_id: 1234, recipient_number: 112345678, message: "hola")
-```
-
-**Read a message**
-
-```ruby
-messages_api.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M12345678910=")
-```
-
-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 message 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}")
+# Send a text message
+client.messages.send_text(sender_id: 1234, recipient_number: 112345678, message: "hola")
 
-messages_api.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "⛄️")
-```
+# Read a message
+client.messages.read_message(sender_id: 1234, message_id: "wamid.HBgLMTM0M12345678910=")
 
-**Reply to a message**
-To reply to a message, just include the id of the message in the `messages_api` methods. For example, to reply to a text message include the following:
+# 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.
 
-```ruby
-messages_api.send_text(sender_id: 123_123, recipient_number: 56_789, message: "I'm a reply", message_id: "wamid.1234")
-```
+# Send a reaction to message
+#   To send a reaction to a message, you need to obtain the message id and look for the emoji's unicode you want to use.
+client.messages.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "\u{1f550}")
+client.messages.send_reaction(sender_id: 123_123, recipient_number: 56_789, message_id: "12345", emoji: "⛄️")
 
-**Send a location message**
+# Reply to a message
+# To reply to a message, just include the id of the message in the `client.messages` methods. For example, to reply to a text message include the following:
+client.messages.send_text(sender_id: 123_123, recipient_number: 56_789, message: "I'm a reply", message_id: "wamid.1234")
 
-```ruby
-messages_api.send_location(
+# Send a location message
+client.messages.send_location(
   sender_id: 123123, recipient_number: 56789,
   longitude: 45.4215, latitude: 75.6972, name: "nacho", address: "141 cooper street"
 )
-```
 
-**Send an image message**
-It could use a link or an image_id.
-
-```ruby
-# with a link
-messages_api.send_image(
-  sender_id: 123123, recipient_number: 56789, link: "image_link", caption: "Ignacio Chiazzo Profile"
-)
+# Send an image message
+#  It uses a link or an image_id.
+#  with a link
+client.messages.send_image(sender_id: 123123, recipient_number: 56789, link: "image_link", caption: "Ignacio Chiazzo Profile")
 
 # with an image id
-messages_api.send_image(
-  sender_id: 123123, recipient_number: 56789, image_id: "1234", caption: "Ignacio Chiazzo Profile"
-)
-```
+client.messages.send_image(sender_id: 123123, recipient_number: 56789, image_id: "1234", caption: "Ignacio Chiazzo Profile")
 
-**Send an audio message**
-It could use a link or an audio_id.
 
-```ruby
+# Send an audio message
+# It uses a link or an audio_id.
 # with a link
-messages_api.send_audio(sender_id: 123123, recipient_number: 56789, link: "audio_link")
+client.messages.send_audio(sender_id: 123123, recipient_number: 56789, link: "audio_link")
 
 # with an audio id
-messages_api.send_audio(sender_id: 123123, recipient_number: 56789, audio_id: "1234")
-```
-
-**Send a document message**
-It could use a link or a document_id.
+client.messages.send_audio(sender_id: 123123, recipient_number: 56789, audio_id: "1234")
 
-```ruby
+# Send a document message
+# It uses a link or a document_id.
 # with a link
-messages_api.send_document(
-  sender_id: 123123, recipient_number: 56789, link: "document_link", caption: "Ignacio Chiazzo"
-)
+client.messages.send_document(sender_id: 123123, recipient_number: 56789, link: "document_link", caption: "Ignacio Chiazzo")
 
 # with a document id
-messages_api.send_document(
-  sender_id: 123123, recipient_number: 56789, document_id: "1234", caption: "Ignacio Chiazzo"
-)
-```
+client.messages.send_document(sender_id: 123123, recipient_number: 56789, document_id: "1234", caption: "Ignacio Chiazzo")
+# Note, you can specify the filename via argument [`filename`](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages). 
 
-**Send a sticker message**
-It could use a link or a sticker_id.
-
-```ruby
-# with a link
-messages_api.send_sticker(sender_id: 123123, recipient_number: 56789, link: "link")
+# Send a sticker message
+#  It could use a link or a sticker_id.
+#  with a link
+client.messages.send_sticker(sender_id: 123123, recipient_number: 56789, link: "link")
 
 # with a sticker_id
-messages_api.send_sticker(sender_id: 123123, recipient_number: 56789, sticker_id: "1234")
-```
+client.messages.send_sticker(sender_id: 123123, recipient_number: 56789, sticker_id: "1234")
 
-**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.
+# 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.
+client.messages.send_contacts(sender_id: 123123, recipient_number: 56789, contacts: [create_contact(params)])
 
-```ruby
-contacts = [create_contact(params)]
-messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts: contacts)
-```
+# Alternatively, you could pass a plain json like this:
+client.messages.send_contacts(sender_id: 123123, recipient_number: 56789, contacts_json: {...})
 
-Alternatively, you could pass a plain json like this:
+# 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.
 
-```ruby
-messages_api.send_contacts(sender_id: 123123, recipient_number: 56789, contacts_json: {...})
+# 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)
 ```
 
-**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.
-
-**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)
-
 <details> <summary>Component's example</summary>
 
 ```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: WhatsappSdk::Resource::ParameterObject::Type::Image, image: image)
-# You can also use a plain string as type e.g.
-# parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: image)
-parameter_text = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Text, text: "TEXT_STRING")
-parameter_currency = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::Currency, currency: currency)
-parameter_date_time = WhatsappSdk::Resource::ParameterObject.new(type: WhatsappSdk::Resource::ParameterObject::Type::DateTime, date_time: date_time)
-
-header_component = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::Header,
-  parameters: [parameter_image]
+media_component = WhatsappSdk::Resource::MediaComponent.new(type: "image", link: "http(s)://URL")
+location = WhatsappSdk::Resource::Location.new(
+  latitude: 25.779510, longitude: -80.338631, name: "miami store", address: "820 nw 87th ave, miami, fl"
 )
 
+parameter_image = WhatsappSdk::Resource::ParameterObject.new(type: "image", image: media_component)
+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)
+parameter_location = WhatsappSdk::Resource::ParameterObject.new(type: "location", location: location)
+
+header_component = WhatsappSdk::Resource::Component.new(type: "header", parameters: [parameter_image])
+
 body_component = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::Body,
+  type: "body", 
   parameters: [parameter_text, parameter_currency, parameter_date_time]
 )
 
 button_component1 = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::Button,
+  type: "button",
   index: 0,
-  sub_type: WhatsappSdk::Resource::Component::Subtype::QuickReply,
+  sub_type: "quick_reply",
   parameters: [
-    WhatsappSdk::Resource::ButtonParameter.new(type: WhatsappSdk::Resource::ButtonParameter::Type::Payload, payload: "PAYLOAD")
+    WhatsappSdk::Resource::ButtonParameter.new(type: "payload", payload: "PAYLOAD")
   ]
 )
 
 button_component2 = WhatsappSdk::Resource::Component.new(
-  type: WhatsappSdk::Resource::Component::Type::Button,
+  type: "button",
   index: 1,
-  sub_type: WhatsappSdk::Resource::Component::Subtype::QuickReply,
+  sub_type: "quick_reply",
   parameters: [
-    WhatsappSdk::Resource::ButtonParameter.new(type: WhatsappSdk::Resource::ButtonParameter::Type::Payload, payload: "PAYLOAD")
+    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])
+
+location_component = WhatsappSdk::Resource::Component.new(type: "header", parameters: [parameter_location])
+client.messages.send_template(
+  sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components: [...]
+)
 ```
 
 </details>
@@ -412,7 +356,7 @@ button_component2 = WhatsappSdk::Resource::Component.new(
 Alternatively, 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: [{...}])
+client.messages.send_template(sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components_json: [{...}])
 ```
 
 **Send interactive messages**
@@ -422,28 +366,14 @@ Visit the [Official API Documentation](https://developers.facebook.com/docs/what
 <summary>List Message's example</summary>
 
 ```ruby
-interactive_header = WhatsappSdk::Resource::InteractiveHeader.new(
-  type: WhatsappSdk::Resource::InteractiveHeader::Type::Text,
-  text: "I am the header!"
-)
-
-interactive_body = WhatsappSdk::Resource::InteractiveBody.new(
-  text: "I am the body!"
-)
-
-interactive_footer = WhatsappSdk::Resource::InteractiveFooter.new(
-  text: "I am the footer!"
-)
-
-interactive_action = WhatsappSdk::Resource::InteractiveAction.new(
-  type: WhatsappSdk::Resource::InteractiveAction::Type::ListMessage
-)
+interactive_header = WhatsappSdk::Resource::InteractiveHeader.new(type: "text", text: "I am the header!")
+interactive_body = WhatsappSdk::Resource::InteractiveBody.new(text: "I am the body!")
+interactive_footer = WhatsappSdk::Resource::InteractiveFooter.new(text: "I am the footer!")
+interactive_action = WhatsappSdk::Resource::InteractiveAction.new(type: "list_message")
 
 interactive_action.button = "I am the button CTA"
 
-interactive_section_1 = WhatsappSdk::Resource::InteractiveActionSection.new(
-  title: "I am the section 1"
-)
+interactive_section_1 = WhatsappSdk::Resource::InteractiveActionSection.new(title: "I am the section 1")
 interactive_section_1_row_1 = WhatsappSdk::Resource::InteractiveActionSectionRow.new(
   title: "I am the row 1 title",
   id: "section_1_row_1",
@@ -453,15 +383,15 @@ interactive_section_1.add_row(interactive_section_1_row_1)
 interactive_action.add_section(interactive_section_1)
 
 interactive_list_messages = WhatsappSdk::Resource::Interactive.new(
-  type: WhatsappSdk::Resource::Interactive::Type::ListMessage,
+  type: "list",
   header: interactive_header,
   body: interactive_body,
   footer: interactive_footer,
   action: interactive_action
 )
 
-messages_api.send_interactive_list_messages(
-  sender_id: 12_345, recipient_number: 1234567890,
+client.messages.send_interactive_list_messages(
+  sender_id: SENDER_ID, recipient_number: RECIPIENT_NUMBER,
   interactive: interactive_list_messages
 )
 ```
@@ -471,7 +401,7 @@ messages_api.send_interactive_list_messages(
 Alternatively, you could pass a plain json like this:
 
 ```ruby
-messages_api.send_interactive_list_messages(
+client.messages.send_interactive_list_messages(
   sender_id: 12_345, recipient_number: 1234567890
   interactive_json: {...}
 )
@@ -481,23 +411,11 @@ messages_api.send_interactive_list_messages(
 <summary>Reply Button's example</summary>
 
 ```ruby
-interactive_header = WhatsappSdk::Resource::InteractiveHeader.new(
-  type: WhatsappSdk::Resource::InteractiveHeader::Type::Text,
-  text: "I am the header!"
-)
-
-interactive_body = WhatsappSdk::Resource::InteractiveBody.new(
-  text: "I am the body!"
-)
-
-interactive_footer = WhatsappSdk::Resource::InteractiveFooter.new(
-  text: "I am the footer!"
-)
-
-interactive_action = WhatsappSdk::Resource::InteractiveAction.new(
-  type: WhatsappSdk::Resource::InteractiveAction::Type::ReplyButton
-)
+interactive_header = WhatsappSdk::Resource::InteractiveHeader.new(type: "text", text: "I am the header!")
+interactive_body = WhatsappSdk::Resource::InteractiveBody.new(text: "I am the body!")
+interactive_footer = WhatsappSdk::Resource::InteractiveFooter.new(text: "I am the footer!")
 
+interactive_action = WhatsappSdk::Resource::InteractiveAction.new(type: "reply_button")
 interactive_reply_button_1 = WhatsappSdk::Resource::InteractiveActionReplyButton.new(
   title: "I am the reply button 1",
   id: "button_1"
@@ -511,14 +429,14 @@ interactive_reply_button_2 = WhatsappSdk::Resource::InteractiveActionReplyButton
 interactive_action.add_reply_button(interactive_reply_button_2)
 
 interactive_reply_buttons = WhatsappSdk::Resource::Interactive.new(
-  type: WhatsappSdk::Resource::Interactive::Type::ReplyButton,
+  type: "reply_button",
   header: interactive_header,
   body: interactive_body,
   footer: interactive_footer,
   action: interactive_action
 )
 
-messages_api.send_interactive_reply_buttons(
+client.messages.send_interactive_reply_buttons(
   sender_id: 12_345, recipient_number: 1234567890,
   interactive: interactive_reply_buttons
 )
@@ -529,7 +447,7 @@ messages_api.send_interactive_reply_buttons(
 Alternative, you could pass a plain json like this:
 
 ```ruby
-messages_api.send_interactive_reply_buttons(
+client.messages.send_interactive_reply_buttons(
   sender_id: 12_345, recipient_number: 1234567890
   interactive_json: {...}
 )
@@ -537,6 +455,10 @@ messages_api.send_interactive_reply_buttons(
 
 </details>
 
+### Errors
+
+If the API returns an error then an exception `WhatsappSdk::Api::Responses::HttpResponseError` is raised. The  object contains information returned by the Cloud API. For more information about the potential error check the [official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/).
+
 ## Examples
 
 Visit [the example file](/example.rb) with examples to call the API in a single file.
@@ -548,7 +470,10 @@ Visit [the example file](/example.rb) with examples to call the API in a single
 
 ## Troubleshooting
 
-- If the API response is `success`, but the message is not delivered, ensure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered). Try also replying a message to the number you are registered on your Whatsapp.
+If you try to send a text message directly without a message template created and approved in your Meta control panel, you can't start a chat with other people. But if you receive a message before, it's possible to send a message.
+
+If the API response is still `success`, but the message is not delivered:
+  - ensure the device you're sending the message to is using a supported Whatsapp version. [Check documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/support/troubleshooting#message-not-delivered). Try also replying a message to the number you are registered on your Whatsapp.
 - Ensure your Meta App uses an API version greater than or equal to `v.14`.
 - Ensure that the Panel in the Facebook dashboard doesn't display any errors.
 

data/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.