@zavudev/sdk 0.57.0 → 0.58.1

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

@@ -1,338 +1,105 @@
 import { APIResource } from "../../../../core/resource.js";
-import * as WebhookAPI from "./webhook.js";
-import { Webhook, WebhookRotateSecretParams } from "./webhook.js";
 import { APIPromise } from "../../../../core/api-promise.js";
-import { Cursor, type CursorParams, PagePromise } from "../../../../core/pagination.js";
+import { Cursor, PagePromise } from "../../../../core/pagination.js";
 import { RequestOptions } from "../../../../internal/request-options.js";
+import type * as T from "../../../../types.js";
+import * as WebhookAPI from "./webhook.js";
+import { Webhook, type WebhookRotateSecretParams } from "./webhook.js";
 export declare class Tools extends APIResource {
     webhook: WebhookAPI.Webhook;
     /**
+     * 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>;
     /**
+     * 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, params: ToolRetrieveParams, options?: RequestOptions): APIPromise<ToolRetrieveResponse>;
     /**
+     * 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>;
     /**
+     * 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, query?: ToolListParams | null | undefined, options?: RequestOptions): PagePromise<AgentToolsCursor, AgentTool>;
     /**
+     * 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>;
     /**
+     * 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, params: ToolListTestRunsParams, options?: RequestOptions): APIPromise<ToolListTestRunsResponse>;
     /**
+     * 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>;
 }
-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;
-    };
-    required: Array<string>;
-    type: 'object';
-}
+export type AgentToolsCursor = Cursor<T.AgentTool>;
+export type AgentTool = T.AgentTool;
+export type ToolParameters = T.ToolParameters;
 export declare namespace ToolParameters {
-    interface Properties {
-        description?: string;
-        type?: string;
-    }
-}
-export interface ToolCreateResponse {
-    tool: AgentTool;
-}
-export interface ToolRetrieveResponse {
-    tool: AgentTool;
-}
-export interface ToolUpdateResponse {
-    tool: AgentTool;
-}
-export interface ToolListTestRunsResponse {
-    items: Array<ToolListTestRunsResponse.Item>;
+    type Properties = T.ToolParametersPropertiesValue;
 }
+export type ToolCreateResponse = T.ToolResponse;
+export type ToolRetrieveResponse = T.ToolResponse;
+export type ToolUpdateResponse = T.ToolResponse;
+export type ToolListTestRunsResponse = T.ListAgentToolTestRunsResponse;
 export declare 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.
-     */
-    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;
+    type Item = T.AgentToolTestRun;
 }
+export type ToolTestResponse = T.ToolTestResponse;
 export declare 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.
-     */
-    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 {
-    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 interface ToolRetrieveParams {
-    senderId: string;
-}
-export interface ToolUpdateParams {
-    /**
-     * Path param
-     */
-    senderId: string;
-    /**
-     * Body param
-     */
-    description?: string;
-    /**
-     * Body param
-     */
-    enabled?: boolean;
-    /**
-     * Body param
-     */
-    name?: string;
-    /**
-     * 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;
-    };
-}
+    type Run = T.AgentToolTestRun;
+}
+export type ToolCreateParams = T.SendersAgentToolsCreateParams;
+export type ToolRetrieveParams = T.SendersAgentToolsRetrieveParams;
+export type ToolUpdateParams = T.SendersAgentToolsUpdateParams;
+export type ToolListParams = T.SendersAgentToolsListParams;
+export type ToolDeleteParams = T.SendersAgentToolsDeleteParams;
+export type ToolListTestRunsParams = T.SendersAgentToolsListTestRunsParams;
+export type ToolTestParams = T.SendersAgentToolsTestParams;
 export declare namespace Tools {
-    export { type AgentTool as AgentTool, type ToolParameters as ToolParameters, type ToolCreateResponse as ToolCreateResponse, type ToolRetrieveResponse as ToolRetrieveResponse, type ToolUpdateResponse as ToolUpdateResponse, type ToolListTestRunsResponse as ToolListTestRunsResponse, type ToolTestResponse as ToolTestResponse, type AgentToolsCursor as AgentToolsCursor, type ToolCreateParams as ToolCreateParams, type ToolRetrieveParams as ToolRetrieveParams, type ToolUpdateParams as ToolUpdateParams, type ToolListParams as ToolListParams, type ToolDeleteParams as ToolDeleteParams, type ToolListTestRunsParams as ToolListTestRunsParams, type ToolTestParams as ToolTestParams, };
-    export { Webhook as Webhook, type WebhookRotateSecretParams as WebhookRotateSecretParams };
+    export { type AgentTool as AgentTool, type ToolParameters as ToolParameters, type ToolCreateResponse as ToolCreateResponse, type ToolRetrieveResponse as ToolRetrieveResponse, type ToolUpdateResponse as ToolUpdateResponse, type ToolListTestRunsResponse as ToolListTestRunsResponse, type ToolTestResponse as ToolTestResponse, type AgentToolsCursor as AgentToolsCursor, type ToolCreateParams as ToolCreateParams, type ToolRetrieveParams as ToolRetrieveParams, type ToolUpdateParams as ToolUpdateParams, type ToolListParams as ToolListParams, type ToolDeleteParams as ToolDeleteParams, type ToolListTestRunsParams as ToolListTestRunsParams, type ToolTestParams as ToolTestParams, Webhook as Webhook, type WebhookRotateSecretParams as WebhookRotateSecretParams, };
 }
 //# sourceMappingURL=tools.d.ts.map

package/resources/senders/agent/tools/tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../../../src/resources/senders/agent/tools/tools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,qCAAkC;AACxD,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,qBAAkB;AAC/D,OAAO,EAAE,UAAU,EAAE,wCAAqC;AAC1D,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE,uCAAoC;AAErF,OAAO,EAAE,cAAc,EAAE,gDAA6C;AAGtE,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1G;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAK1G;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gBAAgB,EAAE,SAAS,CAAC;IAO3C;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAIrG;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAEjD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,OAAO,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,cAAc,CAAC;IAE3B,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,UAAU,CAAA;KAAE,CAAC;IAEzD,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,UAAU;QACzB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAC7C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;OAGG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,GAAG,EAAE,gBAAgB,CAAC,GAAG,CAAC;CAC3B;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;OAGG;IACH,UAAiB,GAAG;QAClB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,cAAc,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,yBAAyB,IAAI,yBAAyB,EAAE,CAAC;CAC5F"}
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../../../src/resources/senders/agent/tools/tools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,wCAAqC;AAC1D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,uCAAoC;AAElE,OAAO,EAAE,cAAc,EAAE,gDAA6C;AAEtE,OAAO,KAAK,KAAK,CAAC,6BAA0B;AAC5C,OAAO,KAAK,UAAU,qBAAkB;AACxC,OAAO,EAAE,OAAO,EAAE,KAAK,yBAAyB,EAAE,qBAAkB;AAEpE,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI1G;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAKnC;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAK1G;;;;;;OAMG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gBAAgB,EAAE,SAAS,CAAC;IAO3C;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;;;;OAQG;IACH,YAAY,CACV,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAQvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAIrG;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAEnD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;AAEpC,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,cAAc,CAAC;AAC9C,yBAAiB,cAAc,CAAC;IAC9B,KAAY,UAAU,GAAG,CAAC,CAAC,6BAA6B,CAAC;CAC1D;AAED,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;AAEhD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;AAElD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,CAAC;AAEhD,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,6BAA6B,CAAC;AACvE,yBAAiB,wBAAwB,CAAC;IACxC,KAAY,IAAI,GAAG,CAAC,CAAC,gBAAgB,CAAC;CACvC;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;AAClD,yBAAiB,gBAAgB,CAAC;IAChC,KAAY,GAAG,GAAG,CAAC,CAAC,gBAAgB,CAAC;CACtC;AAED,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,6BAA6B,CAAC;AAE/D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,+BAA+B,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,6BAA6B,CAAC;AAE/D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,2BAA2B,CAAC;AAE3D,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,6BAA6B,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,mCAAmC,CAAC;AAE3E,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,2BAA2B,CAAC;AAE3D,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,cAAc,IAAI,cAAc,EACrC,OAAO,IAAI,OAAO,EAClB,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/senders/agent/tools/tools.js

@@ -1,91 +1,56 @@
 "use strict";
-// 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`.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tools = void 0;
 const tslib_1 = require("../../../../internal/tslib.js");
 const resource_1 = require("../../../../core/resource.js");
-const WebhookAPI = tslib_1.__importStar(require("./webhook.js"));
-const webhook_1 = require("./webhook.js");
 const pagination_1 = require("../../../../core/pagination.js");
 const headers_1 = require("../../../../internal/headers.js");
 const path_1 = require("../../../../internal/utils/path.js");
+const WebhookAPI = tslib_1.__importStar(require("./webhook.js"));
 class Tools extends resource_1.APIResource {
     constructor() {
         super(...arguments);
         this.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, body, options) {
         return this._client.post((0, path_1.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, params, options) {
         const { senderId } = params;
         return this._client.get((0, path_1.path) `/v1/senders/${senderId}/agent/tools/${toolID}`, options);
     }
     /**
+     * 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, params, options) {
         const { senderId, ...body } = params;
         return this._client.patch((0, path_1.path) `/v1/senders/${senderId}/agent/tools/${toolID}`, { body, ...options });
     }
     /**
+     * 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, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/v1/senders/${senderID}/agent/tools`, (pagination_1.Cursor), {
@@ -94,14 +59,11 @@ class Tools extends resource_1.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, params, options) {
         const { senderId } = params;
@@ -111,17 +73,13 @@ class Tools extends resource_1.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, params, options) {
         const { senderId, ...query } = params;
@@ -131,27 +89,20 @@ class Tools extends resource_1.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, params, options) {
         const { senderId, ...body } = params;
@@ -159,5 +110,4 @@ class Tools extends resource_1.APIResource {
     }
 }
 exports.Tools = Tools;
-Tools.Webhook = webhook_1.Webhook;
 //# sourceMappingURL=tools.js.map

package/resources/senders/agent/tools/tools.js.map

@@ -1 +1 @@
-{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../../../src/resources/senders/agent/tools/tools.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,2DAAwD;AACxD,iEAAwC;AACxC,0CAA+D;AAE/D,+DAAqF;AACrF,6DAA4D;AAE5D,6DAAuD;AAEvD,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmKrE,CAAC;IAjKC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAsB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAc,EACd,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAgB,EAChB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,cAAc,EAAE,CAAA,mBAAiB,CAAA,EAAE;YAC3F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE;YAC9E,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,MAAc,EACd,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,YAAY,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,CAAC,MAAc,EAAE,MAAsB,EAAE,OAAwB;QACnE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AApKD,sBAoKC;AAsQD,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC"}
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../../../src/resources/senders/agent/tools/tools.ts"],"names":[],"mappings":";AAAA,6FAA6F;;;;AAE7F,2DAAwD;AAExD,+DAAkE;AAClE,6DAA4D;AAE5D,6DAAuD;AAEvD,iEAAwC;AAGxC,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmHrE,CAAC;IAjHC;;;;;;OAMG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAsB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CACN,MAAc,EACd,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAgB,EAChB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,cAAc,EAAE,CAAA,mBAAiB,CAAA,EAAE;YAC3F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,EAAE,EAAE;YAC9E,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,MAAc,EACd,MAA8B,EAC9B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,YAAY,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,MAAc,EAAE,MAAsB,EAAE,OAAwB;QACnE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,eAAe,QAAQ,gBAAgB,MAAM,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;CACF;AApHD,sBAoHC"}