@zavudev/sdk 0.57.0 → 0.58.0

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

@@ -1,58 +1,35 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../../../../core/resource';
-import * as WebhookAPI from './webhook';
-import { Webhook, WebhookRotateSecretParams } from './webhook';
 import { APIPromise } from '../../../../core/api-promise';
-import { Cursor, type CursorParams, PagePromise } from '../../../../core/pagination';
+import { Cursor, PagePromise } from '../../../../core/pagination';
 import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
+import type * as T from '../../../../types';
+import * as WebhookAPI from './webhook';
+import { Webhook, type WebhookRotateSecretParams } from './webhook';
 
 export class Tools extends APIResource {
   webhook: WebhookAPI.Webhook = new WebhookAPI.Webhook(this._client);
 
   /**
+   * Create tool
+   *
    * Create a new tool for an agent. Tools allow the agent to call external webhooks.
    *
-   * @example
-   * ```ts
-   * const tool = await client.senders.agent.tools.create(
-   *   'senderId',
-   *   {
-   *     description: 'Get the status of a customer order',
-   *     name: 'get_order_status',
-   *     parameters: {
-   *       type: 'object',
-   *       properties: {
-   *         order_id: {
-   *           type: 'string',
-   *           description: 'The order ID to look up',
-   *         },
-   *       },
-   *       required: ['order_id'],
-   *     },
-   *     webhookUrl:
-   *       'https://api.example.com/webhooks/order-status',
-   *     webhookSecret: 'whsec_...',
-   *   },
-   * );
-   * ```
+   * `POST /v1/senders/{senderId}/agent/tools`
    */
   create(senderID: string, body: ToolCreateParams, options?: RequestOptions): APIPromise<ToolCreateResponse> {
     return this._client.post(path`/v1/senders/${senderID}/agent/tools`, { body, ...options });
   }
 
   /**
+   * Get tool
+   *
    * Get a specific tool.
    *
-   * @example
-   * ```ts
-   * const tool = await client.senders.agent.tools.retrieve(
-   *   'toolId',
-   *   { senderId: 'senderId' },
-   * );
-   * ```
+   * `GET /v1/senders/{senderId}/agent/tools/{toolId}`
    */
   retrieve(
     toolID: string,
@@ -64,15 +41,11 @@ export class Tools extends APIResource {
   }
 
   /**
+   * Update tool
+   *
    * Update a tool.
    *
-   * @example
-   * ```ts
-   * const tool = await client.senders.agent.tools.update(
-   *   'toolId',
-   *   { senderId: 'senderId' },
-   * );
-   * ```
+   * `PATCH /v1/senders/{senderId}/agent/tools/{toolId}`
    */
   update(toolID: string, params: ToolUpdateParams, options?: RequestOptions): APIPromise<ToolUpdateResponse> {
     const { senderId, ...body } = params;
@@ -80,17 +53,11 @@ export class Tools extends APIResource {
   }
 
   /**
+   * List tools
+   *
    * List tools for an agent.
    *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const agentTool of client.senders.agent.tools.list(
-   *   'senderId',
-   * )) {
-   *   // ...
-   * }
-   * ```
+   * `GET /v1/senders/{senderId}/agent/tools`
    */
   list(
     senderID: string,
@@ -104,14 +71,11 @@ export class Tools extends APIResource {
   }
 
   /**
+   * Delete tool
+   *
    * Delete a tool.
    *
-   * @example
-   * ```ts
-   * await client.senders.agent.tools.delete('toolId', {
-   *   senderId: 'senderId',
-   * });
-   * ```
+   * `DELETE /v1/senders/{senderId}/agent/tools/{toolId}`
    */
   delete(toolID: string, params: ToolDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { senderId } = params;
@@ -122,17 +86,13 @@ export class Tools extends APIResource {
   }
 
   /**
+   * List tool test runs
+   *
    * Recent runs of this tool triggered from the test endpoint, newest first. Covers
    * manual tests only: a tool called by an agent during a real conversation is not
    * recorded here.
    *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.senders.agent.tools.listTestRuns('toolId', {
-   *     senderId: 'senderId',
-   *   });
-   * ```
+   * `GET /v1/senders/{senderId}/agent/tools/{toolId}/test-runs`
    */
   listTestRuns(
     toolID: string,
@@ -147,27 +107,20 @@ export class Tools extends APIResource {
   }
 
   /**
+   * Test tool
+   *
    * 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`.
+   * 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
-   * const response = await client.senders.agent.tools.test(
-   *   'toolId',
-   *   {
-   *     senderId: 'senderId',
-   *     testParams: { order_id: 'ORD-12345' },
-   *   },
-   * );
-   * ```
+   * `POST /v1/senders/{senderId}/agent/tools/{toolId}/test`
    */
   test(toolID: string, params: ToolTestParams, options?: RequestOptions): APIPromise<ToolTestResponse> {
     const { senderId, ...body } = params;
@@ -175,267 +128,44 @@ export class Tools extends APIResource {
   }
 }
 
-export type AgentToolsCursor = Cursor<AgentTool>;
-
-export interface AgentTool {
-  id: string;
-
-  agentId: string;
-
-  createdAt: string;
-
-  /**
-   * Description for the LLM to understand when to use this tool.
-   */
-  description: string;
-
-  enabled: boolean;
-
-  name: string;
-
-  parameters: ToolParameters;
-
-  updatedAt: string;
-
-  /**
-   * 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 {
-  properties: { [key: string]: ToolParameters.Properties };
+export type AgentToolsCursor = Cursor<T.AgentTool>;
 
-  required: Array<string>;
-
-  type: 'object';
-}
+export type AgentTool = T.AgentTool;
 
+export type ToolParameters = T.ToolParameters;
 export namespace ToolParameters {
-  export interface Properties {
-    description?: string;
-
-    type?: string;
-  }
+  export type Properties = T.ToolParametersPropertiesValue;
 }
 
-export interface ToolCreateResponse {
-  tool: AgentTool;
-}
-
-export interface ToolRetrieveResponse {
-  tool: AgentTool;
-}
+export type ToolCreateResponse = T.ToolResponse;
 
-export interface ToolUpdateResponse {
-  tool: AgentTool;
-}
+export type ToolRetrieveResponse = T.ToolResponse;
 
-export interface ToolListTestRunsResponse {
-  items: Array<ToolListTestRunsResponse.Item>;
-}
+export type ToolUpdateResponse = T.ToolResponse;
 
+export type ToolListTestRunsResponse = T.ListAgentToolTestRunsResponse;
 export namespace ToolListTestRunsResponse {
-  /**
-   * 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 Item {
-    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 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.
-   */
-  run: ToolTestResponse.Run;
+  export type Item = T.AgentToolTestRun;
 }
 
+export type ToolTestResponse = T.ToolTestResponse;
 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 type Run = T.AgentToolTestRun;
 }
 
-export interface ToolCreateParams {
-  description: string;
-
-  name: string;
-
-  parameters: ToolParameters;
-
-  /**
-   * Must be HTTPS.
-   */
-  webhookUrl: string;
-
-  enabled?: boolean;
-
-  /**
-   * 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;
-}
+export type ToolCreateParams = T.SendersAgentToolsCreateParams;
 
-export interface ToolRetrieveParams {
-  senderId: string;
-}
+export type ToolRetrieveParams = T.SendersAgentToolsRetrieveParams;
 
-export interface ToolUpdateParams {
-  /**
-   * Path param
-   */
-  senderId: string;
+export type ToolUpdateParams = T.SendersAgentToolsUpdateParams;
 
-  /**
-   * Body param
-   */
-  description?: string;
+export type ToolListParams = T.SendersAgentToolsListParams;
 
-  /**
-   * Body param
-   */
-  enabled?: boolean;
+export type ToolDeleteParams = T.SendersAgentToolsDeleteParams;
 
-  /**
-   * Body param
-   */
-  name?: string;
+export type ToolListTestRunsParams = T.SendersAgentToolsListTestRunsParams;
 
-  /**
-   * Body param
-   */
-  parameters?: ToolParameters;
-
-  /**
-   * Body param
-   */
-  webhookSecret?: string | null;
-
-  /**
-   * Body param
-   */
-  webhookUrl?: string;
-}
-
-export interface ToolListParams extends CursorParams {
-  enabled?: boolean;
-}
-
-export interface ToolDeleteParams {
-  senderId: string;
-}
-
-export interface ToolListTestRunsParams {
-  /**
-   * Path param
-   */
-  senderId: string;
-
-  /**
-   * Query param
-   */
-  limit?: number;
-}
-
-export interface ToolTestParams {
-  /**
-   * Path param
-   */
-  senderId: string;
-
-  /**
-   * Body param: Parameters to pass to the tool for testing.
-   */
-  testParams: { [key: string]: unknown };
-}
-
-Tools.Webhook = Webhook;
+export type ToolTestParams = T.SendersAgentToolsTestParams;
 
 export declare namespace Tools {
   export {
@@ -454,7 +184,7 @@ export declare namespace Tools {
     type ToolDeleteParams as ToolDeleteParams,
     type ToolListTestRunsParams as ToolListTestRunsParams,
     type ToolTestParams as ToolTestParams,
+    Webhook as Webhook,
+    type WebhookRotateSecretParams as WebhookRotateSecretParams,
   };
-
-  export { Webhook as Webhook, type WebhookRotateSecretParams as WebhookRotateSecretParams };
 }

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

@@ -1,25 +1,21 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 import { APIResource } from '../../../../core/resource';
-import * as SendersAPI from '../../senders';
 import { APIPromise } from '../../../../core/api-promise';
 import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
+import type * as T from '../../../../types';
+import * as SendersAPI from '../../senders';
 
 export class Webhook extends APIResource {
   /**
+   * Rotate a tool's webhook secret
+   *
    * Generate a new signing secret for this tool. The previous one stops working on
    * the next call, with no overlap, so update your endpoint first. The tool keeps
    * its id, so flows that reference it by name are unaffected.
    *
-   * @example
-   * ```ts
-   * const webhookSecretResponse =
-   *   await client.senders.agent.tools.webhook.rotateSecret(
-   *     'toolId',
-   *     { senderId: 'senderId' },
-   *   );
-   * ```
+   * `POST /v1/senders/{senderId}/agent/tools/{toolId}/webhook/secret`
    */
   rotateSecret(
     toolID: string,
@@ -31,9 +27,7 @@ export class Webhook extends APIResource {
   }
 }
 
-export interface WebhookRotateSecretParams {
-  senderId: string;
-}
+export type WebhookRotateSecretParams = T.SendersAgentToolsWebhookRotateSecretParams;
 
 export declare namespace Webhook {
   export { type WebhookRotateSecretParams as WebhookRotateSecretParams };

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

@@ -1,3 +1,3 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export * from './tools/index';

package/src/resources/senders/agent.ts

@@ -1,3 +1,3 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export * from './agent/index';

package/src/resources/senders/channels.ts

@@ -0,0 +1,95 @@
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import type * as T from '../../types';
+
+export class Channels extends APIResource {
+  /**
+   * Activate a sender channel
+   *
+   * Switch on the account connected to this sender for one channel, so it sends and
+   * receives. This is the same switch as **Activate** on the dashboard's Accounts
+   * screen, with the same price and the same limits.
+   *
+   * A newly connected account that your plan already includes (nothing charged now,
+   * nothing added to the monthly bill) is switched on by itself as soon as it can
+   * carry messages. One that would cost money starts inactive: every send on it is
+   * refused and it is not listed in the sender's `channels` until you activate it
+   * here or from Accounts, after seeing the price. A connection you switched off
+   * stays off.
+   *
+   * **Billing.** Activating is billed as a channel connection. On a paid plan that
+   * is one full month charged from the balance at once, and the same amount every
+   * month while the connection stays active; the response states both as
+   * `chargedCents` and `monthlyCents`. The first connections a plan includes cost
+   * nothing, and so does re-activating a connection whose current month is already
+   * paid. A WhatsApp Business Account is never charged from the balance for its
+   * month: one beyond the ones the plan includes is billed on the subscription
+   * instead. The exception is a WhatsApp account switched off for non-payment, which
+   * settles its past-due fee from the balance when re-activated.
+   *
+   * Calling this on a channel that is already active changes nothing and charges
+   * nothing. Not available with test-mode keys.
+   *
+   * `POST /v1/senders/{senderId}/channels/{channel}/activate`
+   */
+  activate(
+    channel: string,
+    params: ChannelActivateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChannelActivateResponse> {
+    const { senderId } = params;
+    return this._client.post(path`/v1/senders/${senderId}/channels/${channel}/activate`, options);
+  }
+
+  /**
+   * Deactivate a sender channel
+   *
+   * Switch off the account connected to this sender for one channel. Sends on it are
+   * refused and it leaves the sender's `channels`. The account stays connected, so
+   * activating it again needs no reconnection.
+   *
+   * The month already paid is not refunded, and re-activating before it ends charges
+   * nothing. Calling this on a channel that is already inactive changes nothing. Not
+   * available with test-mode keys.
+   *
+   * `POST /v1/senders/{senderId}/channels/{channel}/deactivate`
+   */
+  deactivate(
+    channel: string,
+    params: ChannelDeactivateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChannelDeactivateResponse> {
+    const { senderId } = params;
+    return this._client.post(path`/v1/senders/${senderId}/channels/${channel}/deactivate`, options);
+  }
+}
+
+export type ChannelActivateParams = T.SendersChannelsActivateParams;
+
+export type ChannelActivateResponse = T.SenderChannelActivationResponse;
+
+export type ActivatableChannel = T.ActivatableChannel;
+
+export type SenderChannelActivationResponse = T.SenderChannelActivationResponse;
+
+export type ChannelDeactivateParams = T.SendersChannelsDeactivateParams;
+
+export type ChannelDeactivateResponse = T.SenderChannelDeactivationResponse;
+
+export type SenderChannelDeactivationResponse = T.SenderChannelDeactivationResponse;
+
+export declare namespace Channels {
+  export {
+    type ActivatableChannel as ActivatableChannel,
+    type ChannelActivateParams as ChannelActivateParams,
+    type ChannelActivateResponse as ChannelActivateResponse,
+    type ChannelDeactivateParams as ChannelDeactivateParams,
+    type ChannelDeactivateResponse as ChannelDeactivateResponse,
+    type SenderChannelActivationResponse as SenderChannelActivationResponse,
+    type SenderChannelDeactivationResponse as SenderChannelDeactivationResponse,
+  };
+}

package/src/resources/senders/index.ts

@@ -1,4 +1,4 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+// Generated by zavu-codegen from apps/docs/openapi.json. Do not edit: run `bun run codegen`.
 
 export {
   AgentResource,
@@ -41,3 +41,13 @@ export {
   type WhatsappSyncStartContactsSyncResponse,
   type WhatsappSyncStartHistorySyncResponse,
 } from './whatsapp-sync';
+export {
+  Channels,
+  type ChannelActivateParams,
+  type ChannelActivateResponse,
+  type ActivatableChannel,
+  type SenderChannelActivationResponse,
+  type ChannelDeactivateParams,
+  type ChannelDeactivateResponse,
+  type SenderChannelDeactivationResponse,
+} from './channels';