@arbol-ai/cli 3.41.0 → 3.42.0

package/dist/index.js

@@ -18962,7 +18962,7 @@ var commands = {
         flag: "expand",
         kind: "string",
         required: false,
-        description: "Related data to include, comma-separated: `recipients`, `readiness`."
+        description: "Related data to include, comma-separated: `recipients`, `readiness`, `results`."
       },
       {
         name: "recipientsCursor",
@@ -18998,6 +18998,13 @@ var commands = {
         required: false,
         description: "With `expand=recipients`: only those whose number contains these digits or whose name contains this text."
       },
+      {
+        name: "recipientsResult",
+        flag: "recipients-result",
+        kind: "string",
+        required: false,
+        description: "With `expand=recipients`: `definitionKey=optionKey`, only those whose latest answer is that option; `definitionKey=`, only those with no answer yet."
+      },
       {
         name: "recipientsStatus",
         flag: "recipients-status",
@@ -19025,11 +19032,11 @@ var commands = {
           type: "string"
         },
         expand: {
-          description: "Related data to include, comma-separated: `recipients`, `readiness`.",
+          description: "Related data to include, comma-separated: `recipients`, `readiness`, `results`.",
           examples: [
-            "recipients,readiness"
+            "recipients,readiness,results"
           ],
-          pattern: "^(recipients|readiness)(,(recipients|readiness))*$",
+          pattern: "^(recipients|readiness|results)(,(recipients|readiness|results))*$",
           type: "string"
         },
         recipientsCursor: {
@@ -19064,6 +19071,11 @@ var commands = {
           minLength: 1,
           type: "string"
         },
+        recipientsResult: {
+          description: "With `expand=recipients`: `definitionKey=optionKey`, only those whose latest answer is that option; `definitionKey=`, only those with no answer yet.",
+          pattern: "^[a-z][a-z0-9_]{0,63}=([a-z][a-z0-9_]{0,63})?$",
+          type: "string"
+        },
         recipientsStatus: {
           description: "`pending`: waiting for its (next) call or message. `in_progress`: being called, or on WhatsApp waiting for a reply until a reminder is due. `completed`: an attempt succeeded; on WhatsApp, the message arrived. `failed`: its attempts ran out, or it cannot be reached.",
           anyOf: [
@@ -19096,7 +19108,7 @@ var commands = {
       additionalProperties: false
     },
     title: "Get a campaign",
-    description: "Read one campaign: Agent, schedule, contact hours, retries, progress and, in `errorCode`, why it cannot reach anyone now. `expand=recipients` adds its recipients in the order they were added, each with attempts, next attempt, error and latest call or message; continue with `recipientsCursor` (`recipientsDirection` reads the other way). `expand=readiness` says whether it can start and lists what has to be fixed first, without reaching anyone. Read it before `update_campaign` and send `expectedVersion`.",
+    description: "Read one campaign: Agent, schedule, contact hours, retries, progress and, in `errorCode`, why it cannot reach anyone now. `expand=recipients` adds its recipients in the order they were added, each with attempts, next attempt, error and latest call or message; continue with `recipientsCursor` (`recipientsDirection` reads the other way). `expand=readiness` says whether it can start and lists what has to be fixed first, without reaching anyone. `expand=results` counts what people answered, by the Agent's data definitions with options; each recipient also says their own. Read it before `update_campaign` and send `expectedVersion`.",
     effect: "read",
     confirmation: null,
     hidden: false
@@ -88361,6 +88373,14 @@ var schemaComponents = {
       recipients: {
         $ref: "#/components/schemas/RaizCampaignRecipientPage",
         description: "The campaign's recipients in the order they were added, each with its latest attempt. Present only when expanded."
+      },
+      results: {
+        description: "What people answered, for each data definition with options their Agent collects that has an answer yet. Answers arrive when a conversation closes and is analyzed, so they can keep arriving after the campaign ends.",
+        maxItems: 100,
+        type: "array",
+        items: {
+          $ref: "#/components/schemas/RaizCampaignResult"
+        }
       }
     }
   },
@@ -88586,7 +88606,7 @@ var schemaComponents = {
         ]
       },
       variables: {
-        description: "Values for the `{{name}}` variables a WhatsApp template's parameters, or the Agent's instructions, first message or this campaign's texts on a call, reference. Raíz always provides `contact_name`, `contact_given_name` and `contact_phone`, and on a call also `contact_id`, `conversation_id` and `bulletins` (the business bulletins in force); a recipient's values never replace them.",
+        description: "Values for the `{{name}}` variables a WhatsApp template's parameters, or the Agent's instructions, first message or this campaign's texts on a call, reference. A reference means the variable that is the same word, whatever its accents and case: `{{País}}` reads `pais`, and an exact name wins. Raíz always provides `contact_name`, `contact_given_name` and `contact_phone`, and on a call also `contact_id`, `conversation_id` and `bulletins` (the business bulletins in force); a recipient's values never replace them.",
         maxProperties: 30,
         type: "object",
         patternProperties: {
@@ -88616,6 +88636,7 @@ var schemaComponents = {
           required: [
             "address",
             "attemptCount",
+            "contact",
             "contactId",
             "createdAt",
             "deliveredAt",
@@ -88629,6 +88650,7 @@ var schemaComponents = {
             "nextAttemptAt",
             "readAt",
             "repliedAt",
+            "results",
             "status",
             "updatedAt",
             "variables"
@@ -88641,6 +88663,43 @@ var schemaComponents = {
               minimum: 0,
               type: "integer"
             },
+            contact: {
+              anyOf: [
+                {
+                  description: "The contact this person is: the one the list named, else the one that owns the number. Null when the organization has none yet; the campaign creates it when it reaches them.",
+                  additionalProperties: false,
+                  type: "object",
+                  required: [
+                    "id",
+                    "name"
+                  ],
+                  properties: {
+                    id: {
+                      description: "Contact id.",
+                      examples: [
+                        "cnt_01m45h8q2rf3t9w6y7z0b1c2d3"
+                      ],
+                      pattern: "^cnt_(?:[0-7][0-9a-hjkmnp-tv-z]{25}|(?:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|[a-f0-9]{32}))$",
+                      type: "string"
+                    },
+                    name: {
+                      anyOf: [
+                        {
+                          description: "Their saved name, else the name they show on WhatsApp; null when the organization has neither.",
+                          type: "string"
+                        },
+                        {
+                          type: "null"
+                        }
+                      ]
+                    }
+                  }
+                },
+                {
+                  type: "null"
+                }
+              ]
+            },
             contactId: {
               anyOf: [
                 {
@@ -88735,7 +88794,7 @@ var schemaComponents = {
             lastAttempt: {
               anyOf: [
                 {
-                  description: "The latest call or message to this recipient; its transcript is `getConversation`.",
+                  description: "The latest call or message to this recipient, or their answer when it came after that conversation closed; its transcript is `getConversation`.",
                   additionalProperties: false,
                   type: "object",
                   required: [
@@ -88836,6 +88895,34 @@ var schemaComponents = {
                 }
               ]
             },
+            results: {
+              description: "What this person answered, from their conversations: the latest for each data definition with options their Agent collects. Empty until a conversation they answered closes and is analyzed.",
+              maxItems: 100,
+              type: "array",
+              items: {
+                additionalProperties: false,
+                type: "object",
+                required: [
+                  "definitionKey",
+                  "label",
+                  "value"
+                ],
+                properties: {
+                  definitionKey: {
+                    description: "The key of the data definition that read it.",
+                    type: "string"
+                  },
+                  label: {
+                    description: "The answer, as people read it.",
+                    type: "string"
+                  },
+                  value: {
+                    description: "The key of the answer's option.",
+                    type: "string"
+                  }
+                }
+              }
+            },
             status: {
               description: "`pending`: waiting for its (next) call or message. `in_progress`: being called, or on WhatsApp waiting for a reply until a reminder is due. `completed`: an attempt succeeded; on WhatsApp, the message arrived. `failed`: its attempts ran out, or it cannot be reached.",
               anyOf: [
@@ -88867,7 +88954,7 @@ var schemaComponents = {
               type: "string"
             },
             variables: {
-              description: "Values for the `{{name}}` variables a WhatsApp template's parameters, or the Agent's instructions, first message or this campaign's texts on a call, reference. Raíz always provides `contact_name`, `contact_given_name` and `contact_phone`, and on a call also `contact_id`, `conversation_id` and `bulletins` (the business bulletins in force); a recipient's values never replace them.",
+              description: "Values for the `{{name}}` variables a WhatsApp template's parameters, or the Agent's instructions, first message or this campaign's texts on a call, reference. A reference means the variable that is the same word, whatever its accents and case: `{{País}}` reads `pais`, and an exact name wins. Raíz always provides `contact_name`, `contact_given_name` and `contact_phone`, and on a call also `contact_id`, `conversation_id` and `bulletins` (the business bulletins in force); a recipient's values never replace them.",
               maxProperties: 30,
               type: "object",
               patternProperties: {
@@ -88891,6 +88978,60 @@ var schemaComponents = {
       }
     }
   },
+  RaizCampaignResult: {
+    additionalProperties: false,
+    type: "object",
+    required: [
+      "definition",
+      "values"
+    ],
+    properties: {
+      definition: {
+        additionalProperties: false,
+        type: "object",
+        required: [
+          "key",
+          "name"
+        ],
+        properties: {
+          key: {
+            type: "string"
+          },
+          name: {
+            type: "string"
+          }
+        }
+      },
+      values: {
+        maxItems: 100,
+        type: "array",
+        items: {
+          additionalProperties: false,
+          type: "object",
+          required: [
+            "key",
+            "label",
+            "people"
+          ],
+          properties: {
+            key: {
+              description: "The key of the answer's option.",
+              type: "string"
+            },
+            label: {
+              description: "The answer, as people read it.",
+              type: "string"
+            },
+            people: {
+              description: "How many recipients it is the latest answer of. Each counts once, however many conversations they had.",
+              minimum: 1,
+              type: "integer"
+            }
+          }
+        }
+      }
+    }
+  },
   RaizCampaignTemplate: {
     additionalProperties: false,
     type: "object",
@@ -128434,11 +128575,11 @@ var schemaComponents = {
         type: "string"
       },
       expand: {
-        description: "Related data to include, comma-separated: `recipients`, `readiness`.",
+        description: "Related data to include, comma-separated: `recipients`, `readiness`, `results`.",
         examples: [
-          "recipients,readiness"
+          "recipients,readiness,results"
         ],
-        pattern: "^(recipients|readiness)(,(recipients|readiness))*$",
+        pattern: "^(recipients|readiness|results)(,(recipients|readiness|results))*$",
         type: "string"
       },
       recipientsCursor: {
@@ -128473,6 +128614,11 @@ var schemaComponents = {
         minLength: 1,
         type: "string"
       },
+      recipientsResult: {
+        description: "With `expand=recipients`: `definitionKey=optionKey`, only those whose latest answer is that option; `definitionKey=`, only those with no answer yet.",
+        pattern: "^[a-z][a-z0-9_]{0,63}=([a-z][a-z0-9_]{0,63})?$",
+        type: "string"
+      },
       recipientsStatus: {
         description: "`pending`: waiting for its (next) call or message. `in_progress`: being called, or on WhatsApp waiting for a reply until a reminder is due. `completed`: an attempt succeeded; on WhatsApp, the message arrived. `failed`: its attempts ran out, or it cannot be reached.",
         anyOf: [
@@ -136548,9 +136694,9 @@ var schemaComponents = {
 // src/generated/generation.json
 var generation_default = {
   formatVersion: 6,
-  release: "1.20261106.171439",
-  openapiSha256: "3dde2e71d41c041ea8a06dcad793712321720bccfd252ba901b8575274e4d042",
-  openapiContentSha256: "e7c2c8058a6f848070f1d5933ea788446ac39acb99aa97b4f6eed2f83162f71f",
+  release: "1.20261106.175459",
+  openapiSha256: "5f4c8fe2bd581b29d21de1dc673df5cbf07ccf6fac105dd2d7ae2cd23260233f",
+  openapiContentSha256: "7ce3b52ae65d2f5e08a6fffa59be703c62066678493c5fb3bcc3646d3a39a91f",
   forge: {
     repository: "https://github.com/cloudflare/forge",
     commit: "7f86447210b7bea3779bfdab3cd5655eade0eadb",
@@ -136563,7 +136709,7 @@ var generation_default = {
   outputs: [
     {
       path: "src/generated/commands.ts",
-      sha256: "6ae733a2be6cc4395d26c710ecbfe0ac6c569f63abcb4630629aa45cef3aeec5"
+      sha256: "ff6dca4fe9e0da6026de47d2870b001871ad436ac88bed99b338739ed06251d3"
     }
   ]
 };
@@ -138163,7 +138309,7 @@ ${name}`);
 }
 
 // src/index.ts
-var VERSION = "3.41.0";
+var VERSION = "3.42.0";
 var RELEASE = generation_default.release;
 var commands2 = { ...commands, ...accountOperatorCommands };
 var SDK_PATHS = new Map(Object.values(commands2).map((command) => [command.operation, command.sdkPath]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbol-ai/cli",
-  "version": "3.41.0",
+  "version": "3.42.0",
   "description": "The Arbol CLI: the Arbol API from your terminal, with commands generated by Cloudflare Forge from the public OpenAPI.",
   "keywords": [
     "arbol",
@@ -45,7 +45,7 @@
     "verify:with-tests": "bun run typecheck && bun run test && bun run build"
   },
   "dependencies": {
-    "@arbol-ai/sdk": "5.41.0",
+    "@arbol-ai/sdk": "5.42.0",
     "ajv": "8.20.0",
     "ajv-formats": "3.0.1",
     "oauth4webapi": "3.8.8"
@@ -60,8 +60,8 @@
   "packageManager": "bun@1.4.3",
   "arbol": {
     "openapi": {
-      "release": "1.20261106.171439",
-      "sha256": "e7c2c8058a6f848070f1d5933ea788446ac39acb99aa97b4f6eed2f83162f71f"
+      "release": "1.20261106.175459",
+      "sha256": "7ce3b52ae65d2f5e08a6fffa59be703c62066678493c5fb3bcc3646d3a39a91f"
     }
   }
 }