warb 1.0.0

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

data/examples/interactive_reply_button.rb

@@ -0,0 +1,174 @@
+# 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_reply_button.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_reply_button.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_reply_button.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_setup.interactive_reply_button.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.buttons_texts = ["button 1", "button 2", "button 3"]
+  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_reply_button.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_reply_button.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_reply_button.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+warb_from_new.interactive_reply_button.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.buttons_texts = ["button 1", "button 2", "button 3"]
+  end
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.interactive_reply_button.dispatch(
+  recipient_number,
+  header: text_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_reply_button.dispatch(
+  recipient_number,
+  header: image_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_reply_button.dispatch(
+  recipient_number,
+  header: video_header,
+  body: "body",
+  footer: "footer",
+  action: action_component
+)
+
+Warb.interactive_reply_button.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.buttons_texts = ["button 1", "button 2", "button 3"]
+  end
+end

data/examples/location.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+# 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.location.dispatch(recipient_number, latitude: "37.44216251868683", longitude: "-122.16153582049394")
+warb_from_setup.location.dispatch(
+  recipient_number,
+  latitude: "37.44216251868683",
+  longitude: "-122.16153582049394",
+  name: "OPTIONAL - Location Name",
+  address: "OPTIONAL - Location Address"
+)
+
+warb_from_setup.location.dispatch(recipient_number) do |builder|
+  builder.latitude = "37.44216251868683"
+  builder.longitude = "-122.16153582049394"
+  builder.name = "OPTIONAL - Location Name"
+  builder.address = "OPTIONAL - Location Address"
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+warb_from_new.location.dispatch(recipient_number, latitude: "37.44216251868683", longitude: "-122.16153582049394")
+warb_from_new.location.dispatch(
+  recipient_number,
+  latitude: "37.44216251868683",
+  longitude: "-122.16153582049394",
+  name: "OPTIONAL - Location Name",
+  address: "OPTIONAL - Location Address"
+)
+
+warb_from_new.location.dispatch(recipient_number) do |builder|
+  builder.latitude = "37.44216251868683"
+  builder.longitude = "-122.16153582049394"
+  builder.name = "OPTIONAL - Location Name"
+  builder.address = "OPTIONAL - Location Address"
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.location.dispatch(recipient_number, latitude: "37.44216251868683", longitude: "-122.16153582049394")
+Warb.location.dispatch(
+  recipient_number,
+  latitude: "37.44216251868683",
+  longitude: "-122.16153582049394",
+  name: "OPTIONAL - Location Name",
+  address: "OPTIONAL - Location Address"
+)
+
+Warb.location.dispatch(recipient_number) do |builder|
+  builder.latitude = "37.44216251868683"
+  builder.longitude = "-122.16153582049394"
+  builder.name = "OPTIONAL - Location Name"
+  builder.address = "OPTIONAL - Location Address"
+end

data/examples/location_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+# 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.location_request.dispatch(recipient_number, body_text: "Location request body text")
+
+warb_from_setup.location_request.dispatch(recipient_number) do |builder|
+  builder.body_text = "Location request body text"
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+warb_from_new.location_request.dispatch(recipient_number, body_text: "Location request body text")
+
+warb_from_new.location_request.dispatch(recipient_number) do |builder|
+  builder.body_text = "Location request body text"
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.location_request.dispatch(recipient_number, body_text: "Location request body text")
+
+Warb.location_request.dispatch(recipient_number) do |builder|
+  builder.body_text = "Location request body text"
+end

data/examples/message.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../lib/warb"
+
+# Configure your variables here
+
+access_token = ""
+business_id = ""
+sender_id = ""
+recipient_number = ""
+
+# 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.message.dispatch(recipient_number, content: 'Hello from warb! Message sent with "content" key')
+warb_from_setup.message.dispatch(recipient_number, message: 'Hello from warb! Message sent with "message" key')
+warb_from_setup.message.dispatch(recipient_number, text: 'Hello from warb! Message sent with "text" key')
+
+warb_from_setup.message.dispatch(recipient_number) do |builder|
+  builder.content = "Hello from warb! Message sent with block builder"
+end
+
+# ############################################ #
+# ============== Using Warb.new ============== #
+# ############################################ #
+
+warb_from_new = Warb.new(
+  access_token: access_token,
+  business_id: business_id,
+  sender_id: sender_id
+)
+
+warb_from_new.message.dispatch(recipient_number, content: 'Hello from warb! Message sent with "content" key')
+warb_from_new.message.dispatch(recipient_number, message: 'Hello from warb! Message sent with "message" key')
+warb_from_new.message.dispatch(recipient_number, text: 'Hello from warb! Message sent with "text" key')
+
+warb_from_new.message.dispatch(recipient_number) do |builder|
+  builder.content = "Hello from warb! Message sent with block builder"
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.message.dispatch(recipient_number, content: 'Hello from warb! Message sent with "content" key')
+Warb.message.dispatch(recipient_number, message: 'Hello from warb! Message sent with "message" key')
+Warb.message.dispatch(recipient_number, text: 'Hello from warb! Message sent with "text" key')
+
+Warb.message.dispatch(recipient_number) do |builder|
+  builder.content = "Hello from warb! Message sent with block builder"
+end

data/examples/sticker.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 = ""
+
+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
+
+# To send sticker 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 sticker is located
+file_type = "image/webp" # fill this in with the mimetype of the sticker to be uploaded
+# only image/webp is allowed for sticker file type
+image_id = warb_from_setup.sticker.upload(file_path: file_path, file_type: file_type)
+# if you already have an sticker id, you can simply replace the above line with such id
+
+warb_from_setup.sticker.dispatch(recipient_number, media_id: image_id)
+warb_from_setup.sticker.dispatch(recipient_number, link: image_link)
+
+warb_from_setup.sticker.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+end
+
+warb_from_setup.sticker.dispatch(recipient_number) do |builder|
+  builder.link = image_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 a sticker id, you can upload it this way
+file_path = "" # fill this in with the file path pointing to wherever the sticker is located
+file_type = "" # fill this in with the mimetype of the sticker to be uploaded
+# allow values for file_type: sticker/aac, sticker/amr, sticker/mpeg, sticker/mp4 or sticker/ogg
+image_id = warb_from_setup.sticker.upload(file_path: file_path, file_type: file_type)
+# if you already have a sticker id, you can simply replace the above line with such id
+
+warb_from_new.sticker.dispatch(recipient_number, media_id: image_id)
+warb_from_new.sticker.dispatch(recipient_number, link: image_link)
+
+warb_from_new.sticker.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+end
+
+warb_from_new.sticker.dispatch(recipient_number) do |builder|
+  builder.link = image_link
+end
+
+# ################################################# #
+# ============== Using Warb directly ============== #
+# ################################################# #
+
+Warb.sticker.dispatch(recipient_number, media_id: image_id)
+Warb.sticker.dispatch(recipient_number, link: image_link)
+
+Warb.sticker.dispatch(recipient_number) do |builder|
+  builder.media_id = image_id
+end
+
+Warb.sticker.dispatch(recipient_number) do |builder|
+  builder.link = image_link
+end