warb 0.1.4 → 1.0.0

data/examples/document.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../lib/warb'
+require_relative "../lib/warb"
 
 # Configure your variables here
 
-access_token = ''
-business_id = ''
-sender_id = ''
-recipient_number = ''
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
 
-document_link = ''
+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.
@@ -25,8 +25,8 @@ warb_from_setup = Warb.setup do |config|
 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
+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,
@@ -35,22 +35,22 @@ document_id = warb_from_setup.document.upload(file_path: file_path, file_type: f
 # 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, 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, 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'
+  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'
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
 end
 
 # ############################################ #
@@ -64,8 +64,8 @@ warb_from_new = Warb.new(
 )
 
 # 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
+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,
@@ -74,22 +74,22 @@ document_id = warb_from_setup.document.upload(file_path: file_path, file_type: f
 # 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, 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, 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'
+  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'
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
 end
 
 # ################################################# #
@@ -97,20 +97,20 @@ end
 # ################################################# #
 
 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, 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, 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'
+  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'
+  builder.filename = "optional_name.pdf"
+  builder.caption = "OPTIONAL - Document caption"
 end

data/examples/image.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../lib/warb'
+require_relative "../lib/warb"
 
 # Configure your variables here
 
-access_token = ''
-business_id = ''
-sender_id = ''
-recipient_number = ''
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
 
-image_link = ''
+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.
@@ -25,25 +25,25 @@ warb_from_setup = Warb.setup do |config|
 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')
+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"
+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, 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'
+  builder.caption = "OPTIONAL - Image caption"
 end
 
 warb_from_setup.image.dispatch(recipient_number) do |builder|
   builder.link = image_link
-  builder.caption = 'OPTIONAL - Image caption'
+  builder.caption = "OPTIONAL - Image caption"
 end
 
 # ############################################ #
@@ -57,24 +57,24 @@ warb_from_new = Warb.new(
 )
 
 # 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"
+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, 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, 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'
+  builder.caption = "OPTIONAL - Image caption"
 end
 
 warb_from_new.image.dispatch(recipient_number) do |builder|
   builder.link = image_link
-  builder.caption = 'OPTIONAL - Image caption'
+  builder.caption = "OPTIONAL - Image caption"
 end
 
 # ################################################# #
@@ -82,16 +82,16 @@ end
 # ################################################# #
 
 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, 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, link: image_link, caption: "OPTIONAL - Image caption")
 
 Warb.image.dispatch(recipient_number) do |builder|
   builder.media_id = image_id
-  builder.caption = 'OPTIONAL - Image caption'
+  builder.caption = "OPTIONAL - Image caption"
 end
 
 Warb.image.dispatch(recipient_number) do |builder|
   builder.link = image_link
-  builder.caption = 'OPTIONAL - Image caption'
+  builder.caption = "OPTIONAL - Image caption"
 end

data/examples/interactive_call_to_action_url.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require_relative '../lib/warb'
+require_relative "../lib/warb"
 
 # Configure your variables here
 
-access_token = ''
-business_id = ''
-sender_id = ''
-recipient_number = ''
+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')
+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')
+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.
@@ -33,44 +33,44 @@ end
 warb_from_setup.interactive_call_to_action_url.dispatch(
   recipient_number,
   header: text_header,
-  body: 'body',
-  footer: 'footer',
+  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',
+  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',
+  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.add_text_header('Text Header')
+  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.add_image_header(media_id: image_id) # or builder.add_image_header(link: image_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.add_video_header(media_id: video_id) # or builder.add_video_header(link: video_link)
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
 
-  builder.body = 'body'
-  builder.footer = 'footer'
+  builder.body = "body"
+  builder.footer = "footer"
 
   builder.build_action do |action|
-    action.button_text = 'Action Button Text'
-    action.url = 'https://www.rebase.com.br'
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
   end
 end
 
@@ -87,44 +87,44 @@ warb_from_new = Warb.new(
 warb_from_new.interactive_call_to_action_url.dispatch(
   recipient_number,
   header: text_header,
-  body: 'body',
-  footer: 'footer',
+  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',
+  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',
+  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.add_text_header('Text Header')
+  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.add_image_header(media_id: image_id) # or builder.add_image_header(link: image_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.add_video_header(media_id: video_id) # or builder.add_video_header(link: video_link)
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
 
-  builder.body = 'body'
-  builder.footer = 'footer'
+  builder.body = "body"
+  builder.footer = "footer"
 
   builder.build_action do |action|
-    action.button_text = 'Action Button Text'
-    action.url = 'https://www.rebase.com.br'
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
   end
 end
 
@@ -135,43 +135,43 @@ end
 Warb.interactive_call_to_action_url.dispatch(
   recipient_number,
   header: text_header,
-  body: 'body',
-  footer: 'footer',
+  body: "body",
+  footer: "footer",
   action: action_component
 )
 
 Warb.interactive_call_to_action_url.dispatch(
   recipient_number,
   header: image_header,
-  body: 'body',
-  footer: 'footer',
+  body: "body",
+  footer: "footer",
   action: action_component
 )
 
 Warb.interactive_call_to_action_url.dispatch(
   recipient_number,
   header: video_header,
-  body: 'body',
-  footer: 'footer',
+  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.add_text_header('Text Header')
+  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.add_image_header(media_id: image_id) # or builder.add_image_header(link: image_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.add_video_header(media_id: video_id) # or builder.add_video_header(link: video_link)
+  # builder.set_video_header(media_id: video_id) # or builder.set_video_header(link: video_link)
 
-  builder.body = 'body'
-  builder.footer = 'footer'
+  builder.body = "body"
+  builder.footer = "footer"
 
   builder.build_action do |action|
-    action.button_text = 'Action Button Text'
-    action.url = 'https://www.rebase.com.br'
+    action.button_text = "Action Button Text"
+    action.url = "https://www.rebase.com.br"
   end
 end