vatio-sdk 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f58bd6f7a713426a74eb89e6393bcd5b678d02abc6e29cc5e9e8286a1bc6366b
-  data.tar.gz: 36b34dfc45e5f65e74f24f14d74c54833a55ef11f8339396c3af7e0277db8b7b
+  metadata.gz: 8fc024c85ca67669f7b0971a9fafbd65c0932f1608e7e2ffdc8a8714088d5e5c
+  data.tar.gz: 4801d1b1efe265284e53ae3c2d29ae09cda61016e85c66c33547f1fe2723ae81
 SHA512:
-  metadata.gz: 313a84c0a4b58cf9234f99acd6136bd7729bd2afc68a250341c63e63e5c9c85dcf5bd1712037763b6eaf1e3b34e468a67d3e5d36cc96430fb929e13382bdd784
-  data.tar.gz: 994c112d1aa656138ccd9b6855b52c45422610addaee8b1a2fe47e3bb97c1f10c295da6e396c4273e77851a4e4a4b1c9aa3e2b4630be1a90994296379ba49633
+  metadata.gz: 5105ee83825f513850f5e0196af8c6af66dd9aa5a500e0cc9f1be60f47a1be04fd055532e432f5ee394144790d3f1186ac427686e10a5778f6605fac32d6eff8
+  data.tar.gz: 600c732a95c860429fab141eb4ae4a70cd945a477c1a20f1c63609a6916c7bc99334c0fed9fc8a7d679dd70b80af6e16064dd6259db816355f866646e3ee172c

data/README.md

@@ -198,8 +198,10 @@ end
 ```
 
 A secret key belongs to one workspace and one environment, and a preview key
-can only write to a test phone verified in the inbox's Try the agent panel (WhatsApp). Keep
-it on your server: it can message your customers. Net::HTTP does the talking
+can only write, from Vatio's shared WhatsApp number, to someone on the
+workspace's team with their WhatsApp verified, or to a customer phone added in
+the inbox's Try the agent panel (WhatsApp). Keep it on your server: it can
+message your customers. Net::HTTP does the talking
 (`base_url`, `open_timeout` and `read_timeout` are there if you need them);
 there is no other dependency.
 
@@ -233,6 +235,24 @@ you:
   Vatio::Server.send_message(to: phone, brief: brief, template: shipped.with_params("Ana", "#1042"))
   ```
 
+  A URL button whose link ends in `{{1}}` takes its value per message, by
+  the button's position (`template.buttons` lists them):
+
+  ```ruby
+  template: offer.with_params("Ana").merge(buttons: [{ index: 0, params: [offer.code] }])
+  ```
+
+  Anything else a template takes (a media or text header, named
+  parameters, a coupon code) goes as Meta's own send components, as each
+  template's `example` shows:
+
+  ```ruby
+  template: { name: "ati_offer", language: "es", components: [
+    { type: "header", parameters: [{ type: "image", image: { link: photo_url } }] },
+    { type: "body", parameters: [{ type: "text", parameter_name: "name", text: "Ana" }] }
+  ] }
+  ```
+
 The response only says it is queued: the agent's turn and Meta's delivery
 both happen after it. `Vatio::Server.message_status(id)` reads it back,
 with `content` (what reached the phone) once it is sent, and
@@ -292,7 +312,7 @@ end
 | `OutsideWindow` | `outside_window`, with `last_inbound_at` |
 | `OptedOut` | `opted_out` |
 | `HumanAnswering` | `human_takeover`, `handoff_pending` |
-| `TemplateError` | `template_not_found` (often created in Meta a minute ago: Vatio is syncing, retry shortly), `template_not_approved`, `template_params`, `template_required` |
+| `TemplateError` | `template_not_found` (often created in Meta a minute ago: Vatio is syncing, retry shortly), `template_not_approved`, `template_params`, `template_buttons`, `template_components`, `template_required` |
 | `InvalidRequest` | Any other 422: `invalid_recipient`, `content_required`, `invalid_identity`, `not_a_test_phone`… |
 | `Unauthorized` | 401 / 403: the key is wrong, revoked, or another workspace's |
 | `Conflict` | Any other 409: `idempotency_conflict` (`details["message_id"]`), `identity_conflict`, `whatsapp_not_connected`, `whatsapp_paused`, `whatsapp_number_unhealthy` (Meta refuses every send from the number; `details["issue"]` says why and the fix) |

data/lib/vatio/identity/version.rb

@@ -2,6 +2,6 @@
 
 module Vatio
   module Identity
-    VERSION = "0.7.1"
+    VERSION = "0.9.0"
   end
 end

data/lib/vatio/server/client.rb

@@ -35,8 +35,12 @@ module Vatio
       #           Needs no `to` or `channel`.
       # brief:    what the agent should write about, and the facts to use.
       # text:     your own words, sent as is.
-      # template: { name:, language:, params: [] }, used only when the 24-hour
-      #           window is closed -- send it too to always reach the person.
+      # template: { name:, language:, params: [], buttons: [{ index:, params: [] }] },
+      #           used only when the 24-hour window is closed -- send it too
+      #           to always reach the person. `buttons` fills URL buttons
+      #           whose link ends in {{1}}. Or { name:, language:, components: [] }
+      #           with Meta's own send components, for anything else a
+      #           template takes (a header, named parameters, a coupon code).
       #           An authentication template takes `code:` instead of params,
       #           with no brief or text, and is sent whatever the window.
       #
@@ -148,8 +152,23 @@ module Vatio
       # Accepts a Hash with symbol or string keys, or anything with `to_h`.
       def normalize_template(template)
         hash = template.to_h.transform_keys(&:to_s)
+        if hash.key?("components")
+          return { name: hash["name"], language: hash["language"], components: Array(hash["components"]) }
+        end
+
         { name: hash["name"], language: hash["language"], params: Array(hash["params"]).map(&:to_s),
-          code: hash["code"]&.to_s }.compact
+          code: hash["code"]&.to_s, buttons: normalize_buttons(hash["buttons"]) }.compact
+      end
+
+      # [{ index: 0, params: ["ABC123"] }]: the value of each URL button whose
+      # link ends in {{1}}, by its position.
+      def normalize_buttons(buttons)
+        return nil if buttons.nil? || buttons.empty?
+
+        buttons.map do |button|
+          button = button.to_h.transform_keys(&:to_s)
+          { index: button["index"], params: Array(button["params"]).map(&:to_s) }
+        end
       end
 
       def present(value)

data/lib/vatio/server/template.rb

@@ -3,15 +3,25 @@
 module Vatio
   module Server
     # A WhatsApp template the key's number can send, from Vatio's mirror of
-    # Meta's: its body, how many `{{n}}` parameters that body takes, and the
-    # object `send_message` expects as `template:`.
+    # Meta's: its body, how many `{{n}}` parameters that body takes, its
+    # buttons, and the object `send_message` expects as `template:`.
     #
     #   shipped = Vatio::Server.templates.find { |t| t.name == "order_shipped" }
     #   Vatio::Server.send_message(to: phone, brief: brief, template: shipped.with_params("Ana", "#1042"))
     #
+    # A URL button whose link ends in {{1}} takes its value by position:
+    #
+    #   template: offer.with_params("Ana").merge(buttons: [{ index: 0, params: ["ABC123"] }])
+    #
+    # Anything else it takes (a header, named parameters, a coupon code) goes
+    # as Meta's own send components; `example` shows them:
+    #
+    #   template: { name: t.name, language: t.language, components: [...] }
+    #
     # Empty on a preview key: the preview number's templates are Vatio's.
     Template = Struct.new(
-      :name, :language, :category, :status, :rejected_reason, :body, :parameter_count, :example,
+      :name, :language, :category, :status, :rejected_reason, :body, :parameter_count, :parameter_format, :buttons,
+      :components, :example,
       keyword_init: true
     ) do
       def self.from(hash) = Value.build(self, hash)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vatio-sdk
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Urcalab