@zavudev/sdk 0.17.0 → 0.18.0

package/src/resources/senders/agent/knowledge-bases/knowledge-bases.ts

@@ -0,0 +1,251 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as DocumentsAPI from './documents';
+import {
+  DocumentCreateParams,
+  DocumentCreateResponse,
+  DocumentDeleteParams,
+  DocumentListParams,
+  Documents,
+} from './documents';
+import { APIPromise } from '../../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../../core/pagination';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class KnowledgeBases extends APIResource {
+  documents: DocumentsAPI.Documents = new DocumentsAPI.Documents(this._client);
+
+  /**
+   * Create a new knowledge base for an agent.
+   *
+   * @example
+   * ```ts
+   * const knowledgeBase =
+   *   await client.senders.agent.knowledgeBases.create(
+   *     'senderId',
+   *     {
+   *       name: 'Product FAQ',
+   *       description:
+   *         'Frequently asked questions about our products',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    senderID: string,
+    body: KnowledgeBaseCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<KnowledgeBaseCreateResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/agent/knowledge-bases`, { body, ...options });
+  }
+
+  /**
+   * Get a specific knowledge base.
+   *
+   * @example
+   * ```ts
+   * const knowledgeBase =
+   *   await client.senders.agent.knowledgeBases.retrieve(
+   *     'kbId',
+   *     { senderId: 'senderId' },
+   *   );
+   * ```
+   */
+  retrieve(
+    kbID: string,
+    params: KnowledgeBaseRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<KnowledgeBaseRetrieveResponse> {
+    const { senderId } = params;
+    return this._client.get(path`/v1/senders/${senderId}/agent/knowledge-bases/${kbID}`, options);
+  }
+
+  /**
+   * Update a knowledge base.
+   *
+   * @example
+   * ```ts
+   * const knowledgeBase =
+   *   await client.senders.agent.knowledgeBases.update('kbId', {
+   *     senderId: 'senderId',
+   *   });
+   * ```
+   */
+  update(
+    kbID: string,
+    params: KnowledgeBaseUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<KnowledgeBaseUpdateResponse> {
+    const { senderId, ...body } = params;
+    return this._client.patch(path`/v1/senders/${senderId}/agent/knowledge-bases/${kbID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List knowledge bases for an agent.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentKnowledgeBase of client.senders.agent.knowledgeBases.list(
+   *   'senderId',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    senderID: string,
+    query: KnowledgeBaseListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentKnowledgeBasesCursor, AgentKnowledgeBase> {
+    return this._client.getAPIList(
+      path`/v1/senders/${senderID}/agent/knowledge-bases`,
+      Cursor<AgentKnowledgeBase>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a knowledge base and all its documents.
+   *
+   * @example
+   * ```ts
+   * await client.senders.agent.knowledgeBases.delete('kbId', {
+   *   senderId: 'senderId',
+   * });
+   * ```
+   */
+  delete(kbID: string, params: KnowledgeBaseDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { senderId } = params;
+    return this._client.delete(path`/v1/senders/${senderId}/agent/knowledge-bases/${kbID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type AgentKnowledgeBasesCursor = Cursor<AgentKnowledgeBase>;
+
+export type AgentDocumentsCursor = Cursor<AgentDocument>;
+
+export interface AgentDocument {
+  id: string;
+
+  /**
+   * Number of chunks created from this document.
+   */
+  chunkCount: number;
+
+  /**
+   * Length of the document content in characters.
+   */
+  contentLength: number;
+
+  createdAt: string;
+
+  /**
+   * Whether the document has been processed for RAG.
+   */
+  isProcessed: boolean;
+
+  knowledgeBaseId: string;
+
+  title: string;
+
+  updatedAt: string;
+}
+
+export interface AgentKnowledgeBase {
+  id: string;
+
+  agentId: string;
+
+  createdAt: string;
+
+  documentCount: number;
+
+  name: string;
+
+  totalChunks: number;
+
+  updatedAt: string;
+
+  description?: string | null;
+}
+
+export interface KnowledgeBaseCreateResponse {
+  knowledgeBase: AgentKnowledgeBase;
+}
+
+export interface KnowledgeBaseRetrieveResponse {
+  knowledgeBase: AgentKnowledgeBase;
+}
+
+export interface KnowledgeBaseUpdateResponse {
+  knowledgeBase: AgentKnowledgeBase;
+}
+
+export interface KnowledgeBaseCreateParams {
+  name: string;
+
+  description?: string;
+}
+
+export interface KnowledgeBaseRetrieveParams {
+  senderId: string;
+}
+
+export interface KnowledgeBaseUpdateParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+
+  /**
+   * Body param:
+   */
+  description?: string | null;
+
+  /**
+   * Body param:
+   */
+  name?: string;
+}
+
+export interface KnowledgeBaseListParams extends CursorParams {}
+
+export interface KnowledgeBaseDeleteParams {
+  senderId: string;
+}
+
+KnowledgeBases.Documents = Documents;
+
+export declare namespace KnowledgeBases {
+  export {
+    type AgentDocument as AgentDocument,
+    type AgentKnowledgeBase as AgentKnowledgeBase,
+    type KnowledgeBaseCreateResponse as KnowledgeBaseCreateResponse,
+    type KnowledgeBaseRetrieveResponse as KnowledgeBaseRetrieveResponse,
+    type KnowledgeBaseUpdateResponse as KnowledgeBaseUpdateResponse,
+    type AgentKnowledgeBasesCursor as AgentKnowledgeBasesCursor,
+    type KnowledgeBaseCreateParams as KnowledgeBaseCreateParams,
+    type KnowledgeBaseRetrieveParams as KnowledgeBaseRetrieveParams,
+    type KnowledgeBaseUpdateParams as KnowledgeBaseUpdateParams,
+    type KnowledgeBaseListParams as KnowledgeBaseListParams,
+    type KnowledgeBaseDeleteParams as KnowledgeBaseDeleteParams,
+  };
+
+  export {
+    Documents as Documents,
+    type DocumentCreateResponse as DocumentCreateResponse,
+    type DocumentCreateParams as DocumentCreateParams,
+    type DocumentListParams as DocumentListParams,
+    type DocumentDeleteParams as DocumentDeleteParams,
+  };
+}

package/src/resources/senders/agent/knowledge-bases.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './knowledge-bases/index';

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

@@ -0,0 +1,334 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Tools extends APIResource {
+  /**
+   * 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_...',
+   *   },
+   * );
+   * ```
+   */
+  create(senderID: string, body: ToolCreateParams, options?: RequestOptions): APIPromise<ToolCreateResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/agent/tools`, { body, ...options });
+  }
+
+  /**
+   * Get a specific tool.
+   *
+   * @example
+   * ```ts
+   * const tool = await client.senders.agent.tools.retrieve(
+   *   'toolId',
+   *   { senderId: 'senderId' },
+   * );
+   * ```
+   */
+  retrieve(
+    toolID: string,
+    params: ToolRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ToolRetrieveResponse> {
+    const { senderId } = params;
+    return this._client.get(path`/v1/senders/${senderId}/agent/tools/${toolID}`, options);
+  }
+
+  /**
+   * Update a tool.
+   *
+   * @example
+   * ```ts
+   * const tool = await client.senders.agent.tools.update(
+   *   'toolId',
+   *   { senderId: 'senderId' },
+   * );
+   * ```
+   */
+  update(toolID: string, params: ToolUpdateParams, options?: RequestOptions): APIPromise<ToolUpdateResponse> {
+    const { senderId, ...body } = params;
+    return this._client.patch(path`/v1/senders/${senderId}/agent/tools/${toolID}`, { body, ...options });
+  }
+
+  /**
+   * List tools for an agent.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentTool of client.senders.agent.tools.list(
+   *   'senderId',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    senderID: string,
+    query: ToolListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentToolsCursor, AgentTool> {
+    return this._client.getAPIList(path`/v1/senders/${senderID}/agent/tools`, Cursor<AgentTool>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a tool.
+   *
+   * @example
+   * ```ts
+   * await client.senders.agent.tools.delete('toolId', {
+   *   senderId: 'senderId',
+   * });
+   * ```
+   */
+  delete(toolID: string, params: ToolDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { senderId } = params;
+    return this._client.delete(path`/v1/senders/${senderId}/agent/tools/${toolID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Test a tool by triggering its webhook with test parameters.
+   *
+   * @example
+   * ```ts
+   * const response = await client.senders.agent.tools.test(
+   *   'toolId',
+   *   {
+   *     senderId: 'senderId',
+   *     testParams: { order_id: 'ORD-12345' },
+   *   },
+   * );
+   * ```
+   */
+  test(toolID: string, params: ToolTestParams, options?: RequestOptions): APIPromise<ToolTestResponse> {
+    const { senderId, ...body } = params;
+    return this._client.post(path`/v1/senders/${senderId}/agent/tools/${toolID}/test`, { body, ...options });
+  }
+}
+
+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: AgentTool.Parameters;
+
+  updatedAt: string;
+
+  /**
+   * HTTPS URL to call when the tool is executed.
+   */
+  webhookUrl: string;
+}
+
+export namespace AgentTool {
+  export interface Parameters {
+    properties: { [key: string]: Parameters.Properties };
+
+    required: Array<string>;
+
+    type: 'object';
+  }
+
+  export namespace Parameters {
+    export interface Properties {
+      description?: string;
+
+      type?: string;
+    }
+  }
+}
+
+export interface ToolCreateResponse {
+  tool: AgentTool;
+}
+
+export interface ToolRetrieveResponse {
+  tool: AgentTool;
+}
+
+export interface ToolUpdateResponse {
+  tool: AgentTool;
+}
+
+export interface ToolTestResponse {
+  scheduled: boolean;
+}
+
+export interface ToolCreateParams {
+  description: string;
+
+  name: string;
+
+  parameters: ToolCreateParams.Parameters;
+
+  /**
+   * Must be HTTPS.
+   */
+  webhookUrl: string;
+
+  enabled?: boolean;
+
+  /**
+   * Optional secret for webhook signature verification.
+   */
+  webhookSecret?: string;
+}
+
+export namespace ToolCreateParams {
+  export interface Parameters {
+    properties: { [key: string]: Parameters.Properties };
+
+    required: Array<string>;
+
+    type: 'object';
+  }
+
+  export namespace Parameters {
+    export interface Properties {
+      description?: string;
+
+      type?: 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?: ToolUpdateParams.Parameters;
+
+  /**
+   * Body param:
+   */
+  webhookSecret?: string | null;
+
+  /**
+   * Body param:
+   */
+  webhookUrl?: string;
+}
+
+export namespace ToolUpdateParams {
+  export interface Parameters {
+    properties: { [key: string]: Parameters.Properties };
+
+    required: Array<string>;
+
+    type: 'object';
+  }
+
+  export namespace Parameters {
+    export interface Properties {
+      description?: string;
+
+      type?: string;
+    }
+  }
+}
+
+export interface ToolListParams extends CursorParams {
+  enabled?: boolean;
+}
+
+export interface ToolDeleteParams {
+  senderId: string;
+}
+
+export interface ToolTestParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+
+  /**
+   * Body param: Parameters to pass to the tool for testing.
+   */
+  testParams: { [key: string]: unknown };
+}
+
+export declare namespace Tools {
+  export {
+    type AgentTool as AgentTool,
+    type ToolCreateResponse as ToolCreateResponse,
+    type ToolRetrieveResponse as ToolRetrieveResponse,
+    type ToolUpdateResponse as ToolUpdateResponse,
+    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 ToolTestParams as ToolTestParams,
+  };
+}

package/src/resources/senders/agent.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './agent/index';

package/src/resources/senders/index.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AgentResource,
+  type Agent,
+  type AgentExecution,
+  type AgentExecutionStatus,
+  type AgentProvider,
+  type AgentResponse,
+  type AgentStats,
+  type AgentCreateParams,
+  type AgentUpdateParams,
+  type AgentExecutionsCursor,
+} from './agent/index';
+export {
+  Senders,
+  type Sender,
+  type SenderWebhook,
+  type WebhookEvent,
+  type WebhookSecretResponse,
+  type WhatsappBusinessProfile,
+  type WhatsappBusinessProfileResponse,
+  type WhatsappBusinessProfileVertical,
+  type SenderUpdateProfileResponse,
+  type SenderUploadProfilePictureResponse,
+  type SenderCreateParams,
+  type SenderUpdateParams,
+  type SenderListParams,
+  type SenderUpdateProfileParams,
+  type SenderUploadProfilePictureParams,
+  type SendersCursor,
+} from './senders';