whatsapp_sdk 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c730759fac4bf2321be036813acb1708c92c9476fc4af1b330a81a249ef8f1d9
-  data.tar.gz: 71a10b4c8449b2e2e240ad25be6352e19cf91870c6caa68b84849bbf6129a997
+  metadata.gz: b916f88ff7d75987b2173c55eb05efa2761951667f5d09daa2d6febba5e2ad63
+  data.tar.gz: 9c1974df055bdab421285fb4095f205b4713a22ca5363841737157c3f5ddf40a
 SHA512:
-  metadata.gz: 2b0b1e93dd3370eb032c7f07fa14a2fc0c6561f96c091e862fb11f8c1fb0d8d4bcd008a5ffcef0b7abcc46b73262e86e52e1ef68bceadd9dd01066ed18b122b5
-  data.tar.gz: 9e028ba82392db6092a4c9f7d831df4f7f5ce4912ee916938d8c88fbad86a4d8f2471577f6c04cfa0ed9311953843d00a4f0b7148142fdc04e8c2770a09d0f68
+  metadata.gz: 74f451bf6122b298a40aebae35806e49ad630ed1a7e54ca021b2179c3339361366190594dfe5327a575964203a49c0064cf4f0d14a6772a2b70ff0e9a1ea1d78
+  data.tar.gz: 28766015d65c3e7bac47cbc50bef0dd2e509bb326d20d360ed3e2cb9993c60adebe3059af882f8b9c01519485a868db7c7ca3ca2590e7e44cae3ae7b3a6e7eb6

data/.cursorrules

@@ -0,0 +1,53 @@
+You are an expert Ruby developer with experience using the Whatsapp Cloud API.
+
+# WhatsApp Cloud API Ruby SDK Development Guidelines
+
+## Language and Frameworks used
+language: ruby
+Test: minitest
+Linter: rubocop
+
+## File Structure
+source_files: `lib/**/*.rb`
+test_files: `test/**/*_test.rb`
+example_files: `example.rb`
+
+## Dependencies
+gemfile: Gemfile
+
+## Documentation
+docs:
+  - README.md
+  - CONTRIBUTING.MD
+  - CHANGELOG.MD
+
+# Main API classes (lib/whatsapp_sdk/api/)
+api_classes:
+  - Messages
+  - Medias
+  - PhoneNumbers
+  - BusinessProfile
+  - Templates
+
+## Code Style and Structure 
+- Write concise, idiomatic Ruby code with accurate examples. 
+- Follow Ruby conventions and best practices. 
+- Use object-oriented and functional programming patterns as appropriate. 
+- Follow the Ruby Style Guide (https://rubystyle.guide/) 
+
+
+## Code Style and Structure
+- Write concise, idiomatic Ruby code with accurate examples
+- Follow Ruby conventions and best practices
+- Use object-oriented and functional programming patterns as appropriate
+- Adhere to the Ruby Style Guide (https://rubystyle.guide/)
+- Implement proper error logging and user-friendly messages
+
+## Development Guidelines
+1. Ensure comprehensive test coverage for all API classes
+2. Document public methods and classes using YARD syntax
+3. Keep the SDK modular and extensible for future WhatsApp API updates
+4. Implement robust error handling and provide clear error messages
+5. Use semantic versioning for releases
+6. Maintain backwards compatibility when possible
+

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 # Unreleased
+
+# v 1.0.0
+- Implement a Better response API [159](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/156)
+- Implement a Better API for calling the Cloud API [156](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/156)
+- Used [VCR gem]() for tests @igacio-chiazzo [153](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/153)
+- Added support for  API v20.0 and v21.0 @guizaols [152](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/152)
+- Increased minimum required Ruby version to 2.7.0 @ignacio-chiazzo [151](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/151)
+
+# v 0.13.0
+
 - Remove sorbet dependency @ignacio-chiazzo [148](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/148) 
 - Added the ability to specify the `filename` [via the document](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages) API. @sahilas [#137](https://github.com/ignacio-chiazzo/ruby_whatsapp_sdk/pull/137)
 

data/Gemfile

@@ -10,6 +10,7 @@ group(:test) do
   gem('rubocop', require: false)
   gem('rubocop-minitest', require: false)
   gem('rubocop-performance', require: false)
+  gem('vcr')
   gem('webmock')
 end
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whatsapp_sdk (0.13.0)
+    whatsapp_sdk (1.0.0)
       faraday (~> 2)
       faraday-multipart (~> 1)
       zeitwerk (~> 2)
@@ -27,7 +27,7 @@ GEM
     method_source (1.0.0)
     minitest (5.16.1)
     mocha (1.14.0)
-    multipart-post (2.4.0)
+    multipart-post (2.4.1)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
@@ -40,7 +40,8 @@ GEM
     rainbow (3.1.1)
     rake (12.3.3)
     regexp_parser (2.5.0)
-    rexml (3.2.5)
+    rexml (3.3.6)
+      strscan
     rubocop (1.30.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
@@ -59,12 +60,15 @@ GEM
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    strscan (3.1.0)
     unicode-display_width (2.2.0)
+    vcr (6.3.1)
+      base64
     webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.13)
+    zeitwerk (2.6.18)
 
 PLATFORMS
   arm64-darwin-21
@@ -82,6 +86,7 @@ DEPENDENCIES
   rubocop
   rubocop-minitest
   rubocop-performance
+  vcr
   webmock
   whatsapp_sdk!
 

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)
-```
-
-Update the details of your business
+# Get the details of your business
+client.business_profiles.get(phone_number_id)
 
-```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 a phone number by id
+# Get the list of phone numbers registered
+client.phone_numbers.list(business_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)
-```
+# Get the a phone number by id
+client.phone_numbers.get(phone_number_id)
 
-Deregister a phone number
+# Register a phone number
+client.phone_numbers.register_number(phone_number_id, pin)
 
-```ruby
-phone_numbers_api.deregister_number(phone_number_id)
+# Deregister a phone number
+client.phone_numbers.deregister_number(phone_number_id)
 ```
 
 </details>
@@ -223,159 +214,107 @@ 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")
-```
+# Upload a media
+client.media.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)
-```
+# Get a media
+media = client.media.get(media_id: MEDIA_ID)
 
-Download media
+# Download media
+client.media.download(url: MEDIA_URL, file_path: 'tmp/downloaded_whatsapp.png', media_type: "image/png")
 
-```ruby
-medias_api.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"
-)
-```
-
-Note, you can specify the filename via file [`filename` argument](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages). 
-
-**Send a sticker message**
-It could use a link or a sticker_id.
+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). 
 
-```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")
+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: image)
+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)
@@ -407,7 +346,9 @@ button_component2 = WhatsappSdk::Resource::Component.new(
 )
 
 location_component = WhatsappSdk::Resource::Component.new(type: "header", parameters: [parameter_location])
-@messages_api.send_template(sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components_json: [component_1])
+client.messages.send_template(
+  sender_id: 12_345, recipient_number: 12345678, name: "hello_world", language: "en_US", components: [...]
+)
 ```
 
 </details>
@@ -415,7 +356,7 @@ location_component = WhatsappSdk::Resource::Component.new(type: "header", parame
 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**
@@ -449,8 +390,8 @@ interactive_list_messages = WhatsappSdk::Resource::Interactive.new(
   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
 )
 ```
@@ -460,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: {...}
 )
@@ -495,7 +436,7 @@ interactive_reply_buttons = WhatsappSdk::Resource::Interactive.new(
   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
 )
@@ -506,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: {...}
 )
@@ -514,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.