@zavudev/sdk 0.52.0 → 0.54.0

package/src/resources/senders/agent/tools.ts

@@ -118,7 +118,16 @@ export class Tools extends APIResource {
   }
 
   /**
-   * Test a tool by triggering its webhook with test parameters.
+   * Run a tool with the parameters you supply and return what it answered.
+   *
+   * The call is synchronous: the response carries the tool's status, body, and
+   * duration, so a green result is evidence the tool ran rather than evidence it was
+   * accepted. Each run is also recorded and readable afterwards via
+   * `GET /v1/senders/{senderId}/agent/tools/{toolId}/test-runs`.
+   *
+   * A tool that answers with an error is reported as a run with `success: false` —
+   * the endpoint itself still returns 200. This fires the tool's real webhook, so a
+   * test has whatever side effects the tool has.
    *
    * @example
    * ```ts
@@ -163,6 +172,17 @@ export interface AgentTool {
    * HTTPS URL to call when the tool is executed.
    */
   webhookUrl: string;
+
+  /**
+   * Signing secret for this tool's webhook. **Returned only when the tool is
+   * created**, never on a later read.
+   *
+   * Zavu generates one if you do not supply it, and signs every call to this tool
+   * with it: `X-Zavu-Signature: <hex>`, the HMAC-SHA256 of the request body. Verify
+   * it before trusting the call. Lost it? Rotate with
+   * `POST /v1/senders/{senderId}/agent/tools/{toolId}/webhook/secret`.
+   */
+  webhookSecret?: string;
 }
 
 export interface ToolParameters {
@@ -194,7 +214,54 @@ export interface ToolUpdateResponse {
 }
 
 export interface ToolTestResponse {
-  scheduled: boolean;
+  /**
+   * One run of a tool triggered from the test endpoint. Recorded so a test is
+   * verifiable after the fact rather than only visible in the response.
+   */
+  run: ToolTestResponse.Run;
+}
+
+export namespace ToolTestResponse {
+  /**
+   * One run of a tool triggered from the test endpoint. Recorded so a test is
+   * verifiable after the fact rather than only visible in the response.
+   */
+  export interface Run {
+    id: string;
+
+    createdAt: string;
+
+    durationMs: number;
+
+    /**
+     * Whether the tool returned without error. A tool that answered with a non-2xx
+     * status is a failed run, not an error of this endpoint.
+     */
+    success: boolean;
+
+    toolId: string;
+
+    /**
+     * Why the run failed, when it did.
+     */
+    error?: string | null;
+
+    /**
+     * The parameters the tool was called with.
+     */
+    params?: { [key: string]: unknown };
+
+    /**
+     * The tool's response body, truncated.
+     */
+    response?: string | null;
+
+    /**
+     * HTTP status the tool's webhook returned. Absent for tools that do not go over
+     * HTTP.
+     */
+    statusCode?: number | null;
+  }
 }
 
 export interface ToolCreateParams {
@@ -212,7 +279,9 @@ export interface ToolCreateParams {
   enabled?: boolean;
 
   /**
-   * Optional secret for webhook signature verification.
+   * Signing secret for the webhook. Optional: Zavu generates one when omitted and
+   * returns it on this response only. Supply your own if you already have a secret
+   * you want reused.
    */
   webhookSecret?: string;
 }

package/src/resources/senders/senders.ts

@@ -300,6 +300,22 @@ export interface SenderWebhook {
    */
   events: Array<WebhookEvent>;
 
+  /**
+   * Which `X-Zavu-Signature` scheme this receiver is sent.
+   *
+   * - `v1`: `v1=HMAC_SHA256(secret, body)`. The scheme used before this was
+   *   configurable. Existing webhooks stay on it until you move them.
+   * - `v2`: `v2=HMAC_SHA256(secret, "{t}.{body}")`. The current scheme, and the
+   *   default for new senders. It signs the timestamp together with the body.
+   * - `v1+v2`: both signatures, sharing one `t`. The migration setting: a receiver
+   *   reading either one works, so you can deploy and confirm your new verifier
+   *   before switching over.
+   *
+   * Moving from `v1` straight to `v2` returns `400`. Set `v1+v2` first. See
+   * https://docs.zavu.dev/guides/receiving-messages/signature-migration
+   */
+  signatureVersion: 'v1' | 'v1+v2' | 'v2';
+
   /**
    * HTTPS URL that will receive webhook events.
    */
@@ -539,6 +555,14 @@ export interface SenderCreateParams {
    */
   emailReceivingEnabled?: boolean;
 
+  /**
+   * Enable the one-way SMS channel (`sms_oneway`). Needs nothing else — no phone
+   * number, no credential — so it is the fastest way to get a sender that can send.
+   * Recipients cannot reply. Confirm with `sms_oneway` in the `channels` array on
+   * the response.
+   */
+  enableSmsOneway?: boolean;
+
   /**
    * Let this sender place and answer phone calls. Requires `phoneNumber`; enabling
    * it without one returns 400. Check the `channels` array on the response to
@@ -562,6 +586,22 @@ export interface SenderCreateParams {
    */
   webhookEvents?: Array<WebhookEvent>;
 
+  /**
+   * Which `X-Zavu-Signature` scheme this receiver is sent.
+   *
+   * - `v1`: `v1=HMAC_SHA256(secret, body)`. The scheme used before this was
+   *   configurable. Existing webhooks stay on it until you move them.
+   * - `v2`: `v2=HMAC_SHA256(secret, "{t}.{body}")`. The current scheme, and the
+   *   default for new senders. It signs the timestamp together with the body.
+   * - `v1+v2`: both signatures, sharing one `t`. The migration setting: a receiver
+   *   reading either one works, so you can deploy and confirm your new verifier
+   *   before switching over.
+   *
+   * Moving from `v1` straight to `v2` returns `400`. Set `v1+v2` first. See
+   * https://docs.zavu.dev/guides/receiving-messages/signature-migration
+   */
+  webhookSignatureVersion?: 'v1' | 'v1+v2' | 'v2';
+
   /**
    * HTTPS URL for webhook events.
    */
@@ -598,6 +638,13 @@ export interface SenderUpdateParams {
    */
   emailReceivingEnabled?: boolean;
 
+  /**
+   * Turn the one-way SMS channel on or off. Enabling needs nothing else and takes
+   * effect immediately; disabling removes the channel from the sender. Confirm with
+   * the `channels` array on the response.
+   */
+  enableSmsOneway?: boolean;
+
   /**
    * Turn the voice channel on or off. The sender must already have a phone number
    * provisioned for calls; enabling it otherwise returns 400 instead of storing a
@@ -619,6 +666,22 @@ export interface SenderUpdateParams {
    */
   webhookEvents?: Array<WebhookEvent>;
 
+  /**
+   * Which `X-Zavu-Signature` scheme this receiver is sent.
+   *
+   * - `v1`: `v1=HMAC_SHA256(secret, body)`. The scheme used before this was
+   *   configurable. Existing webhooks stay on it until you move them.
+   * - `v2`: `v2=HMAC_SHA256(secret, "{t}.{body}")`. The current scheme, and the
+   *   default for new senders. It signs the timestamp together with the body.
+   * - `v1+v2`: both signatures, sharing one `t`. The migration setting: a receiver
+   *   reading either one works, so you can deploy and confirm your new verifier
+   *   before switching over.
+   *
+   * Moving from `v1` straight to `v2` returns `400`. Set `v1+v2` first. See
+   * https://docs.zavu.dev/guides/receiving-messages/signature-migration
+   */
+  webhookSignatureVersion?: 'v1' | 'v1+v2' | 'v2';
+
   /**
    * HTTPS URL for webhook events. Set to null to remove webhook.
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.52.0'; // x-release-please-version
+export const VERSION = '0.54.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.52.0";
+export declare const VERSION = "0.54.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.52.0";
+export declare const VERSION = "0.54.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.52.0'; // x-release-please-version
+exports.VERSION = '0.54.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.52.0'; // x-release-please-version
+export const VERSION = '0.54.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map