vatio-sdk 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74e75fcd7ef82ab7bf6ba02da68a175e7345fb55d8d2cb5921f34990d0a9d4f9
-  data.tar.gz: '08f6d5cef5a92586543490fbc26c0954c716a47a0b363cdd77c30b53f4aaf800'
+  metadata.gz: 8c921c47af7fe3fc6252679275a7717a2c3df5651c2772af28bb99202a8d11bb
+  data.tar.gz: 243719a522e1007183c248e847067f975ac727063edba7d561b85c941aecc596
 SHA512:
-  metadata.gz: 238c07a9e0f23466337769097f3d426b24c8b050acaf95984ca86cf905c30f7b121d762510ec0d441977c71435829b8ead29a5d0f7ccd99af125cc514b5ea4d1
-  data.tar.gz: a31fd505377fc32c91a49cc0dbdd873b9cb6fcb113d795e6bb97ceff4faa2f883d7f7a299d2129009a596792d77c009075a3c20649da13ffa290eba51773cd32
+  metadata.gz: 733e344de538c7430bbb5c85f51152aa87949a0fa70e0ac0bc01dd2fdffc29bb620887105c3e00e2c604b75506e44bc4bc606e361e7713f095bf5aee1f6393e5
+  data.tar.gz: 344d942247e4a56f60fd2a601a917eb4305668d628d40ac8c658b02f092d234c179ad6506b61d40cb4a8cb924b44603fe729f912391c7ce5e4a3553c8c315791

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,13 @@ 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] }])
+  ```
+
 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,10 +301,10 @@ 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_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` |
+| `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) |
 | `NotFound` | `message_status` with an id this key cannot see |
 | `RateLimited` | 429, more than 60 a minute on one key |
 | `Unavailable` | 5xx, timeouts, refused connections |

data/lib/vatio/identity/version.rb

@@ -2,6 +2,6 @@
 
 module Vatio
   module Identity
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/vatio/server/client.rb

@@ -35,8 +35,10 @@ 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}}.
       #           An authentication template takes `code:` instead of params,
       #           with no brief or text, and is sent whatever the window.
       #
@@ -149,7 +151,18 @@ module Vatio
       def normalize_template(template)
         hash = template.to_h.transform_keys(&:to_s)
         { 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,19 @@
 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"] }])
+    #
     # 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, :buttons, :example,
       keyword_init: true
     ) do
       def self.from(hash) = Value.build(self, hash)

data/lib/vatio/server/testing.rb

@@ -47,6 +47,7 @@ module Vatio
         "template_params" => 422, "content_required" => 422, "brief_too_long" => 422, "text_too_long" => 422,
         "invalid_recipient" => 422, "not_a_test_phone" => 422, "identity_not_configured" => 422,
         "invalid_identity" => 422, "whatsapp_not_connected" => 409, "whatsapp_paused" => 409,
+        "whatsapp_number_unhealthy" => 409,
         "idempotency_conflict" => 409, "identity_conflict" => 409, "invalid_key" => 401,
         "workspace_forbidden" => 403, "not_found" => 404, "rate_limited" => 429, "unavailable" => 503,
         "instagram_not_connected" => 409, "unknown_recipient" => 422, "templates_not_supported" => 422,

metadata

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