@pidgeon-ai/cli 1.8.7 → 1.10.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-EPX6BZRJ.js → chunk-2LT3D2LK.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",
@@ -876,6 +956,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: `{ schema, body }`, where `schema` is a URL naming what `body` is and `body` is up to 64 KB of JSON. Sent as its own part beside the text, never mixed into it."
+      },
       {
         "name": "in_reply_to_message_id",
         "kind": "string",
@@ -989,6 +1076,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 +1105,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"
       }
     ]
   },
@@ -1069,6 +1172,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The plain-text body. Send this even when you send `html` \u2014 some clients only read it."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: `{ schema, body }`, where `schema` is a URL naming what `body` is and `body` is up to 64 KB of JSON. Sent as its own part beside the text, never mixed into it."
+      },
       {
         "name": "attachment_ids",
         "kind": "list",
@@ -1325,6 +1435,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 +1976,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",
@@ -2197,6 +2323,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",
@@ -2211,6 +2345,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: structured JSON sent beside the text, for software at the other end to read as fields. Travels as its own part; it is never mixed into the text."
+      },
       {
         "name": "to",
         "kind": "list",
@@ -2336,6 +2477,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",
@@ -2350,6 +2499,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: structured JSON sent beside the text, for software at the other end to read as fields. Travels as its own part; it is never mixed into the text."
+      },
       {
         "name": "to",
         "kind": "list",
@@ -2394,6 +2550,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",
@@ -2408,6 +2572,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: structured JSON sent beside the text, for software at the other end to read as fields. Travels as its own part; it is never mixed into the text."
+      },
       {
         "name": "to",
         "kind": "list",
@@ -2452,6 +2623,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",
@@ -2561,6 +2740,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",
@@ -2610,6 +2797,13 @@ var COMMANDS = [
         "where": "body",
         "describe": "The rich body. Sanitised on the way in; scripts and remote content are removed."
       },
+      {
+        "name": "data",
+        "kind": "json",
+        "required": false,
+        "where": "body",
+        "describe": "Typed data: structured JSON sent beside the text, for software at the other end to read as fields. Travels as its own part; it is never mixed into the text."
+      },
       {
         "name": "attachment_ids",
         "kind": "list",
@@ -2726,6 +2920,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",
@@ -2802,7 +3004,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",
@@ -3056,6 +3267,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",
@@ -3259,4 +3478,4 @@ export {
   __export,
   COMMANDS
 };
-//# sourceMappingURL=chunk-EPX6BZRJ.js.map
+//# sourceMappingURL=chunk-2LT3D2LK.js.map