Better api responses - Use smart objects as returned objects for the API

[ignacio-chiazzo]

Context

Currently, the API returns a complex object Response that contains data and errors like the following example:

response = client.templates.list(business_id: BUSINESS_ID)
response.data&.templates.map { |r| r.template.name })}

This is verbose and complex to understand (it has been raised multiple times by users). Arguably, it lets handling errors gracefully.

Proposed solution

Replace the response with a resource. Here are some examples:

templates = client.templates.list(business_id: BUSINESS_ID)  # -> returns a Pagination object
templates.record -> [ARRAY<Template>]


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")

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)

As you can see the API is much simpler and easier to understand than using Responses and specific objects for the APIs.

Solves #157