@zavudev/sdk 0.16.0 → 0.18.0

package/src/resources/regulatory-documents.ts

@@ -0,0 +1,184 @@
+// 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 RegulatoryDocuments extends APIResource {
+  /**
+   * Create a regulatory document record after uploading the file. Use the upload-url
+   * endpoint first to get an upload URL.
+   *
+   * @example
+   * ```ts
+   * const regulatoryDocument =
+   *   await client.regulatoryDocuments.create({
+   *     documentType: 'passport',
+   *     fileSize: 102400,
+   *     mimeType: 'image/jpeg',
+   *     name: 'Passport Scan',
+   *     storageId: 'kg2abc123...',
+   *   });
+   * ```
+   */
+  create(
+    body: RegulatoryDocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RegulatoryDocumentCreateResponse> {
+    return this._client.post('/v1/documents', { body, ...options });
+  }
+
+  /**
+   * Get a specific regulatory document.
+   *
+   * @example
+   * ```ts
+   * const regulatoryDocument =
+   *   await client.regulatoryDocuments.retrieve('documentId');
+   * ```
+   */
+  retrieve(documentID: string, options?: RequestOptions): APIPromise<RegulatoryDocumentRetrieveResponse> {
+    return this._client.get(path`/v1/documents/${documentID}`, options);
+  }
+
+  /**
+   * List regulatory documents for this project.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const regulatoryDocument of client.regulatoryDocuments.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: RegulatoryDocumentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RegulatoryDocumentsCursor, RegulatoryDocument> {
+    return this._client.getAPIList('/v1/documents', Cursor<RegulatoryDocument>, { query, ...options });
+  }
+
+  /**
+   * Delete a regulatory document. Cannot delete verified documents.
+   *
+   * @example
+   * ```ts
+   * await client.regulatoryDocuments.delete('documentId');
+   * ```
+   */
+  delete(documentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/documents/${documentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get a presigned URL to upload a document file. After uploading, use the
+   * storageId to create the document record.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.regulatoryDocuments.uploadURL();
+   * ```
+   */
+  uploadURL(options?: RequestOptions): APIPromise<RegulatoryDocumentUploadURLResponse> {
+    return this._client.post('/v1/documents/upload-url', options);
+  }
+}
+
+export type RegulatoryDocumentsCursor = Cursor<RegulatoryDocument>;
+
+/**
+ * A regulatory document for phone number requirements.
+ */
+export interface RegulatoryDocument {
+  id: string;
+
+  createdAt: string;
+
+  documentType:
+    | 'passport'
+    | 'national_id'
+    | 'drivers_license'
+    | 'utility_bill'
+    | 'tax_id'
+    | 'business_registration'
+    | 'proof_of_address'
+    | 'other';
+
+  name: string;
+
+  status: 'pending' | 'uploaded' | 'verified' | 'rejected';
+
+  fileSize?: number;
+
+  mimeType?: string;
+
+  rejectionReason?: string | null;
+
+  updatedAt?: string;
+}
+
+export interface RegulatoryDocumentCreateResponse {
+  /**
+   * A regulatory document for phone number requirements.
+   */
+  document: RegulatoryDocument;
+}
+
+export interface RegulatoryDocumentRetrieveResponse {
+  /**
+   * A regulatory document for phone number requirements.
+   */
+  document: RegulatoryDocument;
+}
+
+export interface RegulatoryDocumentUploadURLResponse {
+  /**
+   * Pre-signed URL for uploading the file.
+   */
+  uploadUrl: string;
+}
+
+export interface RegulatoryDocumentCreateParams {
+  documentType:
+    | 'passport'
+    | 'national_id'
+    | 'drivers_license'
+    | 'utility_bill'
+    | 'tax_id'
+    | 'business_registration'
+    | 'proof_of_address'
+    | 'other';
+
+  fileSize: number;
+
+  mimeType: string;
+
+  name: string;
+
+  /**
+   * Storage ID from the upload-url endpoint.
+   */
+  storageId: string;
+}
+
+export interface RegulatoryDocumentListParams extends CursorParams {}
+
+export declare namespace RegulatoryDocuments {
+  export {
+    type RegulatoryDocument as RegulatoryDocument,
+    type RegulatoryDocumentCreateResponse as RegulatoryDocumentCreateResponse,
+    type RegulatoryDocumentRetrieveResponse as RegulatoryDocumentRetrieveResponse,
+    type RegulatoryDocumentUploadURLResponse as RegulatoryDocumentUploadURLResponse,
+    type RegulatoryDocumentsCursor as RegulatoryDocumentsCursor,
+    type RegulatoryDocumentCreateParams as RegulatoryDocumentCreateParams,
+    type RegulatoryDocumentListParams as RegulatoryDocumentListParams,
+  };
+}

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

@@ -0,0 +1,417 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ExecutionsAPI from './executions';
+import { ExecutionListParams, Executions } from './executions';
+import * as FlowsAPI from './flows';
+import {
+  AgentFlow,
+  AgentFlowsCursor,
+  FlowCreateParams,
+  FlowCreateResponse,
+  FlowDeleteParams,
+  FlowDuplicateParams,
+  FlowDuplicateResponse,
+  FlowListParams,
+  FlowRetrieveParams,
+  FlowRetrieveResponse,
+  FlowUpdateParams,
+  FlowUpdateResponse,
+  Flows,
+} from './flows';
+import * as ToolsAPI from './tools';
+import {
+  AgentTool,
+  AgentToolsCursor,
+  ToolCreateParams,
+  ToolCreateResponse,
+  ToolDeleteParams,
+  ToolListParams,
+  ToolRetrieveParams,
+  ToolRetrieveResponse,
+  ToolTestParams,
+  ToolTestResponse,
+  ToolUpdateParams,
+  ToolUpdateResponse,
+  Tools,
+} from './tools';
+import * as KnowledgeBasesAPI from './knowledge-bases/knowledge-bases';
+import {
+  AgentDocument,
+  AgentKnowledgeBase,
+  AgentKnowledgeBasesCursor,
+  KnowledgeBaseCreateParams,
+  KnowledgeBaseCreateResponse,
+  KnowledgeBaseDeleteParams,
+  KnowledgeBaseListParams,
+  KnowledgeBaseRetrieveParams,
+  KnowledgeBaseRetrieveResponse,
+  KnowledgeBaseUpdateParams,
+  KnowledgeBaseUpdateResponse,
+  KnowledgeBases,
+} from './knowledge-bases/knowledge-bases';
+import { APIPromise } from '../../../core/api-promise';
+import { Cursor } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class AgentResource extends APIResource {
+  executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
+  flows: FlowsAPI.Flows = new FlowsAPI.Flows(this._client);
+  tools: ToolsAPI.Tools = new ToolsAPI.Tools(this._client);
+  knowledgeBases: KnowledgeBasesAPI.KnowledgeBases = new KnowledgeBasesAPI.KnowledgeBases(this._client);
+
+  /**
+   * Create an AI agent for a sender. Each sender can have at most one agent.
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.senders.agent.create(
+   *   'senderId',
+   *   {
+   *     model: 'gpt-4o-mini',
+   *     name: 'Customer Support',
+   *     provider: 'openai',
+   *     systemPrompt:
+   *       'You are a helpful customer support agent. Be friendly and concise.',
+   *     apiKey: 'sk-...',
+   *   },
+   * );
+   * ```
+   */
+  create(senderID: string, body: AgentCreateParams, options?: RequestOptions): APIPromise<AgentResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/agent`, { body, ...options });
+  }
+
+  /**
+   * Get the AI agent configuration for a sender.
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.senders.agent.retrieve(
+   *   'senderId',
+   * );
+   * ```
+   */
+  retrieve(senderID: string, options?: RequestOptions): APIPromise<AgentResponse> {
+    return this._client.get(path`/v1/senders/${senderID}/agent`, options);
+  }
+
+  /**
+   * Update an AI agent's configuration.
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.senders.agent.update(
+   *   'senderId',
+   * );
+   * ```
+   */
+  update(senderID: string, body: AgentUpdateParams, options?: RequestOptions): APIPromise<AgentResponse> {
+    return this._client.patch(path`/v1/senders/${senderID}/agent`, { body, ...options });
+  }
+
+  /**
+   * Delete an AI agent.
+   *
+   * @example
+   * ```ts
+   * await client.senders.agent.delete('senderId');
+   * ```
+   */
+  delete(senderID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/senders/${senderID}/agent`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get statistics for an AI agent including invocations, tokens, and costs.
+   *
+   * @example
+   * ```ts
+   * const agentStats = await client.senders.agent.stats(
+   *   'senderId',
+   * );
+   * ```
+   */
+  stats(senderID: string, options?: RequestOptions): APIPromise<AgentStats> {
+    return this._client.get(path`/v1/senders/${senderID}/agent/stats`, options);
+  }
+}
+
+export type AgentExecutionsCursor = Cursor<AgentExecution>;
+
+/**
+ * AI Agent configuration for a sender.
+ */
+export interface Agent {
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * Whether the agent is active.
+   */
+  enabled: boolean;
+
+  /**
+   * Model ID (e.g., gpt-4o-mini, claude-3-5-sonnet).
+   */
+  model: string;
+
+  name: string;
+
+  /**
+   * LLM provider for the AI agent.
+   */
+  provider: AgentProvider;
+
+  senderId: string;
+
+  /**
+   * System prompt for the agent.
+   */
+  systemPrompt: string;
+
+  updatedAt: string;
+
+  /**
+   * Number of previous messages to include as context.
+   */
+  contextWindowMessages?: number;
+
+  /**
+   * Whether to include contact metadata in context.
+   */
+  includeContactMetadata?: boolean;
+
+  /**
+   * Maximum tokens for LLM response.
+   */
+  maxTokens?: number | null;
+
+  stats?: Agent.Stats;
+
+  /**
+   * LLM temperature (0-2).
+   */
+  temperature?: number | null;
+
+  /**
+   * Channels that trigger the agent.
+   */
+  triggerOnChannels?: Array<string>;
+
+  /**
+   * Message types that trigger the agent.
+   */
+  triggerOnMessageTypes?: Array<string>;
+}
+
+export namespace Agent {
+  export interface Stats {
+    /**
+     * Total cost in USD.
+     */
+    totalCost?: number;
+
+    totalInvocations?: number;
+
+    totalTokensUsed?: number;
+  }
+}
+
+export interface AgentExecution {
+  id: string;
+
+  agentId: string;
+
+  /**
+   * Cost in USD.
+   */
+  cost: number;
+
+  createdAt: string;
+
+  inputTokens: number;
+
+  latencyMs: number;
+
+  outputTokens: number;
+
+  /**
+   * Status of an agent execution.
+   */
+  status: AgentExecutionStatus;
+
+  errorMessage?: string | null;
+
+  inboundMessageId?: string;
+
+  responseMessageId?: string | null;
+
+  responseText?: string | null;
+}
+
+/**
+ * Status of an agent execution.
+ */
+export type AgentExecutionStatus = 'success' | 'error' | 'filtered' | 'rate_limited' | 'balance_insufficient';
+
+/**
+ * LLM provider for the AI agent.
+ */
+export type AgentProvider = 'openai' | 'anthropic' | 'google' | 'mistral' | 'zavu';
+
+export interface AgentResponse {
+  /**
+   * AI Agent configuration for a sender.
+   */
+  agent: Agent;
+}
+
+export interface AgentStats {
+  errorCount: number;
+
+  successCount: number;
+
+  /**
+   * Total cost in USD.
+   */
+  totalCost: number;
+
+  totalInvocations: number;
+
+  totalTokensUsed: number;
+
+  avgLatencyMs?: number | null;
+}
+
+export interface AgentCreateParams {
+  model: string;
+
+  name: string;
+
+  /**
+   * LLM provider for the AI agent.
+   */
+  provider: AgentProvider;
+
+  systemPrompt: string;
+
+  /**
+   * API key for the LLM provider. Required unless provider is 'zavu'.
+   */
+  apiKey?: string;
+
+  contextWindowMessages?: number;
+
+  includeContactMetadata?: boolean;
+
+  maxTokens?: number;
+
+  temperature?: number;
+
+  triggerOnChannels?: Array<string>;
+
+  triggerOnMessageTypes?: Array<string>;
+}
+
+export interface AgentUpdateParams {
+  apiKey?: string;
+
+  contextWindowMessages?: number;
+
+  enabled?: boolean;
+
+  includeContactMetadata?: boolean;
+
+  maxTokens?: number | null;
+
+  model?: string;
+
+  name?: string;
+
+  /**
+   * LLM provider for the AI agent.
+   */
+  provider?: AgentProvider;
+
+  systemPrompt?: string;
+
+  temperature?: number | null;
+
+  triggerOnChannels?: Array<string>;
+
+  triggerOnMessageTypes?: Array<string>;
+}
+
+AgentResource.Executions = Executions;
+AgentResource.Flows = Flows;
+AgentResource.Tools = Tools;
+AgentResource.KnowledgeBases = KnowledgeBases;
+
+export declare namespace AgentResource {
+  export {
+    type Agent as Agent,
+    type AgentExecution as AgentExecution,
+    type AgentExecutionStatus as AgentExecutionStatus,
+    type AgentProvider as AgentProvider,
+    type AgentResponse as AgentResponse,
+    type AgentStats as AgentStats,
+    type AgentCreateParams as AgentCreateParams,
+    type AgentUpdateParams as AgentUpdateParams,
+  };
+
+  export { Executions as Executions, type ExecutionListParams as ExecutionListParams };
+
+  export {
+    Flows as Flows,
+    type AgentFlow as AgentFlow,
+    type FlowCreateResponse as FlowCreateResponse,
+    type FlowRetrieveResponse as FlowRetrieveResponse,
+    type FlowUpdateResponse as FlowUpdateResponse,
+    type FlowDuplicateResponse as FlowDuplicateResponse,
+    type AgentFlowsCursor as AgentFlowsCursor,
+    type FlowCreateParams as FlowCreateParams,
+    type FlowRetrieveParams as FlowRetrieveParams,
+    type FlowUpdateParams as FlowUpdateParams,
+    type FlowListParams as FlowListParams,
+    type FlowDeleteParams as FlowDeleteParams,
+    type FlowDuplicateParams as FlowDuplicateParams,
+  };
+
+  export {
+    Tools as Tools,
+    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,
+  };
+
+  export {
+    KnowledgeBases as KnowledgeBases,
+    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,
+  };
+}

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

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AgentAPI from './agent';
+import { AgentExecutionsCursor } from './agent';
+import { Cursor, type CursorParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Executions extends APIResource {
+  /**
+   * List recent agent executions with pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentExecution of client.senders.agent.executions.list(
+   *   'senderId',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    senderID: string,
+    query: ExecutionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentExecutionsCursor, AgentAPI.AgentExecution> {
+    return this._client.getAPIList(
+      path`/v1/senders/${senderID}/agent/executions`,
+      Cursor<AgentAPI.AgentExecution>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface ExecutionListParams extends CursorParams {
+  /**
+   * Status of an agent execution.
+   */
+  status?: AgentAPI.AgentExecutionStatus;
+}
+
+export declare namespace Executions {
+  export { type ExecutionListParams as ExecutionListParams };
+}
+
+export { type AgentExecutionsCursor };