warb 0.1.0

data/examples/audio.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+audio_link = ""
+
+# We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
+# So you can comment out the sections you don't want to test.
+
+# ############################################## #
+# ============== Using Warb.setup ============== #
+# ############################################## #
+
+warb_from_setup = Warb.setup do |config|
+  config.access_token = access_token
+  config.business_id = business_id
+  config.sender_id = sender_id
+end
+
+# To send audio using its ID, you may need to retrieve it first, which can be retrieved this way
+file_path = "" # fill this in with the file path pointing to wherever the audio is located
+file_type = "" # fill this in with the mimetype of the audio to be uploaded
+# allow values for file_type: audio/aac, audio/amr, audio/mpeg, audio/mp4 or audio/ogg
+audio_id = warb_from_setup.audio.upload(file_path: file_path, file_type: file_type)
+# if you already have an audio id, you can simply replace the above line with such id
+
+warb_from_setup.audio.dispatch(recipient_number, media_id: audio_id)
+warb_from_setup.audio.dispatch(recipient_number, link: audio_link)
+
+warb_from_setup.audio.dispatch(recipient_number) do |builder|
+  builder.media_id = audio_id
+end
+
+warb_from_setup.audio.dispatch(recipient_number) do |builder|
+  builder.link = audio_link
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+# Same as stated above, if you need an audio id, you can upload it this way
+file_path = "" # fill this in with the file path pointing to wherever the audio is located
+file_type = "" # fill this in with the mimetype of the audio to be uploaded
+# allow values for file_type: audio/aac, audio/amr, audio/mpeg, audio/mp4 or audio/ogg
+audio_id = warb_from_setup.audio.upload(file_path: file_path, file_type: file_type)
+# if you already have an audio id, you can simply replace the above line with such id
+
+warb_from_new.audio.dispatch(recipient_number, media_id: audio_id)
+warb_from_new.audio.dispatch(recipient_number, link: audio_link)
+
+warb_from_new.audio.dispatch(recipient_number) do |builder|
+  builder.media_id = audio_id
+end
+
+warb_from_new.audio.dispatch(recipient_number) do |builder|
+  builder.link = audio_link
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.audio.dispatch(recipient_number, media_id: audio_id)
+Warb.audio.dispatch(recipient_number, link: audio_link)
+
+Warb.audio.dispatch(recipient_number) do |builder|
+  builder.media_id = audio_id
+end
+
+Warb.audio.dispatch(recipient_number) do |builder|
+  builder.link = audio_link
+end

data/examples/document.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+document_link = ""
+
+# We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
+# So you can comment out the sections you don't want to test.
+
+# ############################################## #
+# ============== Using Warb.setup ============== #
+# ############################################## #
+
+warb_from_setup = Warb.setup do |config|
+  config.access_token = access_token
+  config.business_id = business_id
+  config.sender_id = sender_id
+end
+
+# To send document using its ID, you may need to retrieve it first, which can be retrieved this way
+file_path = "" # fill this in with the file path pointing to wherever the document is located
+file_type = "" # fill this in with the mimetype of the document to be uploaded
+# allow values for file_type:
+# text/plain, application/vnd.ms-excel, application/msword
+# application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint,
+# application/vnd.openxmlformats-officedocument.presentationml.presentation or application/pdf
+document_id = warb_from_setup.document.upload(file_path: file_path, file_type: file_type)
+# if you already have a document id, you can simply replace the above line with such id
+
+warb_from_setup.document.dispatch(recipient_number, media_id: document_id)
+warb_from_setup.document.dispatch(recipient_number, media_id: document_id, filename: "optional_name.pdf")
+warb_from_setup.document.dispatch(recipient_number, media_id: document_id, caption: "OPTIONAL - Document caption")
+warb_from_setup.document.dispatch(recipient_number, link: document_link)
+warb_from_setup.document.dispatch(recipient_number, link: document_link, filename: "optional_name.pdf")
+warb_from_setup.document.dispatch(recipient_number, link: document_link, caption: "OPTIONAL - Document caption")
+
+warb_from_setup.document.dispatch(recipient_number) do |builder|
+  builder.media_id = document_id
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end
+
+warb_from_setup.document.dispatch(recipient_number) do |builder|
+  builder.link = document_link
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+# Same as stated above, if you need a document id, you can upload it this way
+file_path = "" # fill this in with the file path pointing to wherever the document is located
+file_type = "" # fill this in with the mimetype of the document to be uploaded
+# allow values for file_type:
+# text/plain, application/vnd.ms-excel, application/msword
+# application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint,
+# application/vnd.openxmlformats-officedocument.presentationml.presentation or application/pdf
+document_id = warb_from_setup.document.upload(file_path: file_path, file_type: file_type)
+# if you already have a document id, you can simply replace the above line with such id
+
+warb_from_new.document.dispatch(recipient_number, media_id: document_id)
+warb_from_new.document.dispatch(recipient_number, media_id: document_id, filename: "optional_name.pdf")
+warb_from_new.document.dispatch(recipient_number, media_id: document_id, caption: "OPTIONAL - Document caption")
+warb_from_new.document.dispatch(recipient_number, link: document_link)
+warb_from_new.document.dispatch(recipient_number, link: document_link, filename: "optional_name.pdf")
+warb_from_new.document.dispatch(recipient_number, link: document_link, caption: "OPTIONAL - Document caption")
+
+warb_from_new.document.dispatch(recipient_number) do |builder|
+  builder.media_id = document_id
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end
+
+warb_from_new.document.dispatch(recipient_number) do |builder|
+  builder.link = document_link
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.document.dispatch(recipient_number, media_id: document_id)
+Warb.document.dispatch(recipient_number, media_id: document_id, filename: "optional_name.pdf")
+Warb.document.dispatch(recipient_number, media_id: document_id, caption: "OPTIONAL - Document caption")
+Warb.document.dispatch(recipient_number, link: document_link)
+Warb.document.dispatch(recipient_number, link: document_link, filename: "optional_name.pdf")
+Warb.document.dispatch(recipient_number, link: document_link, caption: "OPTIONAL - Document caption")
+
+Warb.document.dispatch(recipient_number) do |builder|
+  builder.media_id = document_id
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end
+
+Warb.document.dispatch(recipient_number) do |builder|
+  builder.link = document_link
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
+end

data/examples/image.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+image_link = ""
+
+# We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
+# So you can comment out the sections you don't want to test.
+
+# ############################################## #
+# ============== Using Warb.setup ============== #
+# ############################################## #
+
+warb_from_setup = Warb.setup do |config|
+  config.access_token = access_token
+  config.business_id = business_id
+  config.sender_id = sender_id
+end
+
+warb_from_setup.image.dispatch(recipient_number, link: image_link)
+warb_from_setup.image.dispatch(recipient_number, link: image_link, caption: "OPTIONAL - Image caption")
+
+# To send image using its ID, you may need to retrieve it first, which can be retrieved this way
+file_path = "" # fill this in with the file path pointing to wherever the image is located
+file_type = "" # fill this in with the mimetype of the image to be uploaded. allowed values: "image/jpeg" or "image/png"
+image_id = warb_from_setup.image.upload(file_path: file_path, file_type: file_type)
+# if you already have an image id, you can simply replace the above line with such id
+
+warb_from_setup.image.dispatch(recipient_number, media_id: image_id)
+warb_from_setup.image.dispatch(recipient_number, media_id: image_id, caption: "OPTIONAL - Image caption")
+
+warb_from_setup.image.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+  builder.caption = "OPTIONAL - Image caption"
+end
+
+warb_from_setup.image.dispatch(recipient_number) do |builder|
+  builder.link = image_link
+  builder.caption = "OPTIONAL - Image caption"
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+# Same as stated above, if you need an image id, you can upload it this way
+file_path = "" # fill this in with the file path pointing to wherever the image is located
+file_type = "" # fill this in with the mimetype of the image to be uploaded. allowed values: "image/jpeg" or "image/png"
+image_id = warb_from_new.image.upload(file_path: file_path, file_type: file_type)
+# if you already have an image id, you can simply replace the above line with such id
+
+warb_from_new.image.dispatch(recipient_number, media_id: image_id)
+warb_from_new.image.dispatch(recipient_number, media_id: image_id, caption: "OPTIONAL - Image caption")
+warb_from_new.image.dispatch(recipient_number, link: image_link)
+warb_from_new.image.dispatch(recipient_number, link: image_link, caption: "OPTIONAL - Image caption")
+
+warb_from_new.image.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+  builder.caption = "OPTIONAL - Image caption"
+end
+
+warb_from_new.image.dispatch(recipient_number) do |builder|
+  builder.link = image_link
+  builder.caption = "OPTIONAL - Image caption"
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.image.dispatch(recipient_number, media_id: image_id)
+Warb.image.dispatch(recipient_number, media_id: image_id, caption: "OPTIONAL - Image caption")
+Warb.image.dispatch(recipient_number, link: image_link)
+Warb.image.dispatch(recipient_number, link: image_link, caption: "OPTIONAL - Image caption")
+
+Warb.image.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+  builder.caption = "OPTIONAL - Image caption"
+end
+
+Warb.image.dispatch(recipient_number) do |builder|
+  builder.link = image_link
+  builder.caption = "OPTIONAL - Image caption"
+end

data/examples/interactive_call_to_action_url.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+# You can use Resources to create headers for your messages.
+text_header = Warb::Resources::Text.as_header("OPTIONAL - Header")
+image_header = Warb::Resources::Image.as_header(media_id: image_id)
+video_header = Warb::Resources::Video.as_header(link: image_url)
+
+# You can use Action Components to create actions for your messages.
+action_component = Warb::Components::CTAAction.new(button_text: "Action button text", url: "https://www.rebase.com.br")
+
+# We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
+# So you can comment out the sections you don't want to test.
+
+# ############################################## #
+# ============== Using Warb.setup ============== #
+# ############################################## #
+
+warb_from_setup = Warb.setup do |config|
+  config.access_token = access_token
+  config.business_id = business_id
+  config.sender_id = sender_id
+end
+
+warb_from_setup.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_call_to_action_url.dispatch(recipient_number) do |builder|
+  # OPTIONAL Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
+  end
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+warb_from_new.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_call_to_action_url.dispatch(recipient_number) do |builder|
+  # Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
+  end
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_call_to_action_url.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_call_to_action_url.dispatch(recipient_number) do |builder|
+  # Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
+  end
+end

data/examples/interactive_list.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+# You can use Resources to create headers for your messages.
+text_header = Warb::Resources::Text.as_header("OPTIONAL - Header")
+image_header = Warb::Resources::Image.as_header(media_id: image_id)
+video_header = Warb::Resources::Video.as_header(link: image_url)
+
+# You can use Action Components to create actions for your messages.
+action_component = Warb::Components::ReplyButtonAction.new(["button 1", "button 2", "button 3"])
+
+# We recommend testing one section at a time, as it can be overwhelming to see all the messages at once.
+# So you can comment out the sections you don't want to test.
+
+# ############################################## #
+# ============== Using Warb.setup ============== #
+# ############################################## #
+
+warb_from_setup = Warb.setup do |config|
+  config.access_token = access_token
+  config.business_id = business_id
+  config.sender_id = sender_id
+end
+
+warb_from_setup.interactive_list.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_list.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_list.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_list.dispatch(recipient_number) do |builder|
+  # OPTIONAL Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action button text"
+
+    section = action.add_section
+    section.title = "Title"
+    section.rows = [Warb::Components::Row.new(title: "S #0 R #0")]
+    section.add_row title: "Second Row", description: "Who knows?"
+
+    section = action.add_section title: "Second Section"
+    row = section.add_row title: "KeK"
+    row.description = "Description"
+  end
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+warb_from_new.interactive_list.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_list.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_list.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_list.dispatch(recipient_number) do |builder|
+  # OPTIONAL Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action button text"
+
+    section = action.add_section
+    section.title = "Title"
+    section.rows = [Warb::Components::Row.new(title: "S #0 R #0")]
+    section.add_row title: "Second Row", description: "Who knows?"
+
+    section = action.add_section title: "Second Section"
+    row = section.add_row title: "KeK"
+    row.description = "Description"
+  end
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.interactive_list.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_list.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_list.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_list.dispatch(recipient_number) do |builder|
+  # OPTIONAL Headers: you can choose between text, image, or video headers.
+
+  builder.set_text_header("Text Header")
+
+  # If you want to use an image header, uncomment the line below and provide a valid or Media ID or Link.
+  # builder.set_image_header(media_id: image_id) # or builder.set_image_header(link: image_link)
+
+  # If you want to use a video header, uncomment the line below and provide a valid Media ID or Link.
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
+
+  builder.body = "body"
+  builder.footer = "footer"
+
+  builder.build_action do |action|
+    action.button_text = "Action button text"
+
+    section = action.add_section
+    section.title = "Title"
+    section.rows = [Warb::Components::Row.new(title: "S #0 R #0")]
+    section.add_row title: "Second Row", description: "Who knows?"
+
+    section = action.add_section title: "Second Section"
+    row = section.add_row title: "KeK"
+    row.description = "Description"
+  end
+end