@pidgeon-ai/cli 1.8.5 → 1.9.0

package/README.md

@@ -48,6 +48,14 @@ describes one command, with its endpoint and its flags. Documentation:
 - A nested object takes JSON: `--some_field '{"a":1}'`.
 - `PIDGEON_BASE_URL` points it somewhere other than production.
 
+## Retrying a send
+
+Every command that sends takes `--idempotency-key`. Run it again with the
+same key and the message goes out once; the second run prints the first
+answer. Without one, each run makes up its own key. `--verbose` prints it
+on stderr before the call, and a failure that may already have sent (no
+answer, or a 5xx) prints it in the error, so a script can retry with it.
+
 ## When it fails
 
 A refusal from the API exits 1 and prints the status, the API's code and

package/dist/{chunk-QVT6JKM6.js → chunk-4KV65KM4.js}

@@ -204,6 +204,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "title",
         "kind": "string",
@@ -313,6 +321,22 @@ var COMMANDS = [
         ],
         "required": false,
         "where": "query"
+      },
+      {
+        "name": "if-match",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "The `etag` you last read. A stale one is a `409` naming the current version \u2014 two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.",
+        "header": "If-Match"
+      },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
       }
     ]
   },
@@ -487,6 +511,22 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "if-match",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "The `etag` you last read. A stale one is a `409` naming the current version \u2014 two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.",
+        "header": "If-Match"
+      },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "status",
         "kind": "string",
@@ -526,6 +566,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "if-match",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "The `etag` you last read. A stale one is a `409` naming the current version \u2014 two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.",
+        "header": "If-Match"
+      },
       {
         "name": "timezone",
         "kind": "string",
@@ -565,6 +613,22 @@ var COMMANDS = [
         "required": false,
         "where": "query"
       },
+      {
+        "name": "if-match",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "The `etag` you last read. A stale one is a `409` naming the current version \u2014 two agents on one mailbox is the case this product is for, and last-write-wins loses a meeting.",
+        "header": "If-Match"
+      },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "title",
         "kind": "string",
@@ -653,6 +717,14 @@ var COMMANDS = [
     "path": "/domains",
     "summary": "Connect a domain",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "domain",
         "kind": "string",
@@ -827,6 +899,14 @@ var COMMANDS = [
     "path": "/drafts",
     "summary": "Write one without sending it",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "identity_id",
         "kind": "string",
@@ -989,6 +1069,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "send_at",
         "kind": "string",
@@ -1010,6 +1098,14 @@ var COMMANDS = [
         "kind": "string",
         "required": true,
         "where": "path"
+      },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
       }
     ]
   },
@@ -1325,6 +1421,14 @@ var COMMANDS = [
     "path": "/identities",
     "summary": "Create an address",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "domain_id",
         "kind": "string",
@@ -1858,6 +1962,14 @@ var COMMANDS = [
     "path": "/labels",
     "summary": "Create a label",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "identity_id",
         "kind": "string",
@@ -2172,7 +2284,8 @@ var COMMANDS = [
         "name": "after",
         "kind": "string",
         "required": false,
-        "where": "query"
+        "where": "query",
+        "describe": "Only messages that arrived after this: the `cursor` a previous call returned, or `now`. Without it, the wait first looks back 2 minutes and returns the newest matching message from then, so a code that beat you to the call is not missed."
       },
       {
         "name": "timeout",
@@ -2196,6 +2309,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "text",
         "kind": "string",
@@ -2335,6 +2456,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "text",
         "kind": "string",
@@ -2393,6 +2522,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "text",
         "kind": "string",
@@ -2451,6 +2588,14 @@ var COMMANDS = [
         "required": true,
         "where": "path"
       },
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "status",
         "kind": "string",
@@ -2560,6 +2705,14 @@ var COMMANDS = [
     "path": "/messages",
     "summary": "Send a message",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "from",
         "kind": "string",
@@ -2725,6 +2878,14 @@ var COMMANDS = [
     "path": "/pods",
     "summary": "Create a pod",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "name",
         "kind": "string",
@@ -2801,7 +2962,16 @@ var COMMANDS = [
     "method": "POST",
     "path": "/routing-rules",
     "summary": "Route an address somewhere",
-    "flags": []
+    "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      }
+    ]
   },
   {
     "group": "routing",
@@ -3055,6 +3225,14 @@ var COMMANDS = [
     "path": "/webhooks",
     "summary": "Create a webhook",
     "flags": [
+      {
+        "name": "idempotency-key",
+        "kind": "string",
+        "required": false,
+        "where": "header",
+        "describe": "Any string unique to this attempt, reused on its retries. A repeat with the same key and the same request returns the first answer with `Idempotent-Replay: true` and does nothing \u2014 no second email. The same key with a different request is a `409`. Kept for 24 hours; a failure is not kept, so a retry after one runs.",
+        "header": "Idempotency-Key"
+      },
       {
         "name": "url",
         "kind": "string",
@@ -3258,4 +3436,4 @@ export {
   __export,
   COMMANDS
 };
-//# sourceMappingURL=chunk-QVT6JKM6.js.map
+//# sourceMappingURL=chunk-4KV65KM4.js.map