@zavudev/sdk 0.17.0 → 0.18.0

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

@@ -0,0 +1,409 @@
+// 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 Flows extends APIResource {
+  /**
+   * Create a new flow for an agent.
+   *
+   * @example
+   * ```ts
+   * const flow = await client.senders.agent.flows.create(
+   *   'senderId',
+   *   {
+   *     name: 'Lead Capture',
+   *     steps: [
+   *       {
+   *         id: 'welcome',
+   *         type: 'message',
+   *         config: {
+   *           text: 'Thanks for your interest! Let me get some info.',
+   *         },
+   *         nextStepId: 'ask_name',
+   *       },
+   *       {
+   *         id: 'ask_name',
+   *         type: 'collect',
+   *         config: {
+   *           variable: 'name',
+   *           prompt: "What's your name?",
+   *         },
+   *       },
+   *     ],
+   *     trigger: {
+   *       type: 'keyword',
+   *       keywords: ['info', 'pricing', 'demo'],
+   *     },
+   *     description: 'Capture lead information',
+   *   },
+   * );
+   * ```
+   */
+  create(senderID: string, body: FlowCreateParams, options?: RequestOptions): APIPromise<FlowCreateResponse> {
+    return this._client.post(path`/v1/senders/${senderID}/agent/flows`, { body, ...options });
+  }
+
+  /**
+   * Get a specific flow.
+   *
+   * @example
+   * ```ts
+   * const flow = await client.senders.agent.flows.retrieve(
+   *   'flowId',
+   *   { senderId: 'senderId' },
+   * );
+   * ```
+   */
+  retrieve(
+    flowID: string,
+    params: FlowRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<FlowRetrieveResponse> {
+    const { senderId } = params;
+    return this._client.get(path`/v1/senders/${senderId}/agent/flows/${flowID}`, options);
+  }
+
+  /**
+   * Update a flow.
+   *
+   * @example
+   * ```ts
+   * const flow = await client.senders.agent.flows.update(
+   *   'flowId',
+   *   { senderId: 'senderId' },
+   * );
+   * ```
+   */
+  update(flowID: string, params: FlowUpdateParams, options?: RequestOptions): APIPromise<FlowUpdateResponse> {
+    const { senderId, ...body } = params;
+    return this._client.patch(path`/v1/senders/${senderId}/agent/flows/${flowID}`, { body, ...options });
+  }
+
+  /**
+   * List flows for an agent.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentFlow of client.senders.agent.flows.list(
+   *   'senderId',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    senderID: string,
+    query: FlowListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentFlowsCursor, AgentFlow> {
+    return this._client.getAPIList(path`/v1/senders/${senderID}/agent/flows`, Cursor<AgentFlow>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Delete a flow. Cannot delete flows with active sessions.
+   *
+   * @example
+   * ```ts
+   * await client.senders.agent.flows.delete('flowId', {
+   *   senderId: 'senderId',
+   * });
+   * ```
+   */
+  delete(flowID: string, params: FlowDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { senderId } = params;
+    return this._client.delete(path`/v1/senders/${senderId}/agent/flows/${flowID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Create a copy of an existing flow with a new name.
+   *
+   * @example
+   * ```ts
+   * const response = await client.senders.agent.flows.duplicate(
+   *   'flowId',
+   *   { senderId: 'senderId', newName: 'Lead Capture (Copy)' },
+   * );
+   * ```
+   */
+  duplicate(
+    flowID: string,
+    params: FlowDuplicateParams,
+    options?: RequestOptions,
+  ): APIPromise<FlowDuplicateResponse> {
+    const { senderId, ...body } = params;
+    return this._client.post(path`/v1/senders/${senderId}/agent/flows/${flowID}/duplicate`, {
+      body,
+      ...options,
+    });
+  }
+}
+
+export type AgentFlowsCursor = Cursor<AgentFlow>;
+
+export interface AgentFlow {
+  id: string;
+
+  agentId: string;
+
+  createdAt: string;
+
+  enabled: boolean;
+
+  name: string;
+
+  /**
+   * Priority when multiple flows match (higher = more priority).
+   */
+  priority: number;
+
+  steps: Array<AgentFlow.Step>;
+
+  trigger: AgentFlow.Trigger;
+
+  updatedAt: string;
+
+  description?: string | null;
+}
+
+export namespace AgentFlow {
+  export interface Step {
+    /**
+     * Unique step identifier.
+     */
+    id: string;
+
+    /**
+     * Step configuration (varies by type).
+     */
+    config: { [key: string]: unknown };
+
+    /**
+     * Type of flow step.
+     */
+    type: 'message' | 'collect' | 'condition' | 'tool' | 'llm' | 'transfer';
+
+    /**
+     * ID of the next step to execute.
+     */
+    nextStepId?: string | null;
+  }
+
+  export interface Trigger {
+    /**
+     * Type of trigger for a flow.
+     */
+    type: 'keyword' | 'intent' | 'always' | 'manual';
+
+    /**
+     * Intent that triggers the flow (for intent type).
+     */
+    intent?: string;
+
+    /**
+     * Keywords that trigger the flow (for keyword type).
+     */
+    keywords?: Array<string>;
+  }
+}
+
+export interface FlowCreateResponse {
+  flow: AgentFlow;
+}
+
+export interface FlowRetrieveResponse {
+  flow: AgentFlow;
+}
+
+export interface FlowUpdateResponse {
+  flow: AgentFlow;
+}
+
+export interface FlowDuplicateResponse {
+  flow: AgentFlow;
+}
+
+export interface FlowCreateParams {
+  name: string;
+
+  steps: Array<FlowCreateParams.Step>;
+
+  trigger: FlowCreateParams.Trigger;
+
+  description?: string;
+
+  enabled?: boolean;
+
+  priority?: number;
+}
+
+export namespace FlowCreateParams {
+  export interface Step {
+    /**
+     * Unique step identifier.
+     */
+    id: string;
+
+    /**
+     * Step configuration (varies by type).
+     */
+    config: { [key: string]: unknown };
+
+    /**
+     * Type of flow step.
+     */
+    type: 'message' | 'collect' | 'condition' | 'tool' | 'llm' | 'transfer';
+
+    /**
+     * ID of the next step to execute.
+     */
+    nextStepId?: string | null;
+  }
+
+  export interface Trigger {
+    /**
+     * Type of trigger for a flow.
+     */
+    type: 'keyword' | 'intent' | 'always' | 'manual';
+
+    /**
+     * Intent that triggers the flow (for intent type).
+     */
+    intent?: string;
+
+    /**
+     * Keywords that trigger the flow (for keyword type).
+     */
+    keywords?: Array<string>;
+  }
+}
+
+export interface FlowRetrieveParams {
+  senderId: string;
+}
+
+export interface FlowUpdateParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+
+  /**
+   * Body param:
+   */
+  description?: string;
+
+  /**
+   * Body param:
+   */
+  enabled?: boolean;
+
+  /**
+   * Body param:
+   */
+  name?: string;
+
+  /**
+   * Body param:
+   */
+  priority?: number;
+
+  /**
+   * Body param:
+   */
+  steps?: Array<FlowUpdateParams.Step>;
+
+  /**
+   * Body param:
+   */
+  trigger?: FlowUpdateParams.Trigger;
+}
+
+export namespace FlowUpdateParams {
+  export interface Step {
+    /**
+     * Unique step identifier.
+     */
+    id: string;
+
+    /**
+     * Step configuration (varies by type).
+     */
+    config: { [key: string]: unknown };
+
+    /**
+     * Type of flow step.
+     */
+    type: 'message' | 'collect' | 'condition' | 'tool' | 'llm' | 'transfer';
+
+    /**
+     * ID of the next step to execute.
+     */
+    nextStepId?: string | null;
+  }
+
+  export interface Trigger {
+    /**
+     * Type of trigger for a flow.
+     */
+    type: 'keyword' | 'intent' | 'always' | 'manual';
+
+    /**
+     * Intent that triggers the flow (for intent type).
+     */
+    intent?: string;
+
+    /**
+     * Keywords that trigger the flow (for keyword type).
+     */
+    keywords?: Array<string>;
+  }
+}
+
+export interface FlowListParams extends CursorParams {
+  enabled?: boolean;
+}
+
+export interface FlowDeleteParams {
+  senderId: string;
+}
+
+export interface FlowDuplicateParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+
+  /**
+   * Body param:
+   */
+  newName: string;
+}
+
+export declare namespace Flows {
+  export {
+    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,
+  };
+}

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

@@ -0,0 +1,60 @@
+// 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';
+export { Executions, type ExecutionListParams } from './executions';
+export {
+  Flows,
+  type AgentFlow,
+  type FlowCreateResponse,
+  type FlowRetrieveResponse,
+  type FlowUpdateResponse,
+  type FlowDuplicateResponse,
+  type FlowCreateParams,
+  type FlowRetrieveParams,
+  type FlowUpdateParams,
+  type FlowListParams,
+  type FlowDeleteParams,
+  type FlowDuplicateParams,
+  type AgentFlowsCursor,
+} from './flows';
+export {
+  KnowledgeBases,
+  type AgentDocument,
+  type AgentKnowledgeBase,
+  type KnowledgeBaseCreateResponse,
+  type KnowledgeBaseRetrieveResponse,
+  type KnowledgeBaseUpdateResponse,
+  type KnowledgeBaseCreateParams,
+  type KnowledgeBaseRetrieveParams,
+  type KnowledgeBaseUpdateParams,
+  type KnowledgeBaseListParams,
+  type KnowledgeBaseDeleteParams,
+  type AgentDocumentsCursor,
+  type AgentKnowledgeBasesCursor,
+} from './knowledge-bases/index';
+export {
+  Tools,
+  type AgentTool,
+  type ToolCreateResponse,
+  type ToolRetrieveResponse,
+  type ToolUpdateResponse,
+  type ToolTestResponse,
+  type ToolCreateParams,
+  type ToolRetrieveParams,
+  type ToolUpdateParams,
+  type ToolListParams,
+  type ToolDeleteParams,
+  type ToolTestParams,
+  type AgentToolsCursor,
+} from './tools';

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

@@ -0,0 +1,133 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as KnowledgeBasesAPI from './knowledge-bases';
+import { AgentDocumentsCursor } from './knowledge-bases';
+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 Documents extends APIResource {
+  /**
+   * Add a document to a knowledge base. The document will be automatically processed
+   * for RAG.
+   *
+   * @example
+   * ```ts
+   * const document =
+   *   await client.senders.agent.knowledgeBases.documents.create(
+   *     'kbId',
+   *     {
+   *       senderId: 'senderId',
+   *       content:
+   *         'Our return policy allows returns within 30 days of purchase...',
+   *       title: 'Return Policy',
+   *     },
+   *   );
+   * ```
+   */
+  create(
+    kbID: string,
+    params: DocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DocumentCreateResponse> {
+    const { senderId, ...body } = params;
+    return this._client.post(path`/v1/senders/${senderId}/agent/knowledge-bases/${kbID}/documents`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List documents in a knowledge base.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const agentDocument of client.senders.agent.knowledgeBases.documents.list(
+   *   'kbId',
+   *   { senderId: 'senderId' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    kbID: string,
+    params: DocumentListParams,
+    options?: RequestOptions,
+  ): PagePromise<AgentDocumentsCursor, KnowledgeBasesAPI.AgentDocument> {
+    const { senderId, ...query } = params;
+    return this._client.getAPIList(
+      path`/v1/senders/${senderId}/agent/knowledge-bases/${kbID}/documents`,
+      Cursor<KnowledgeBasesAPI.AgentDocument>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a document from a knowledge base.
+   *
+   * @example
+   * ```ts
+   * await client.senders.agent.knowledgeBases.documents.delete(
+   *   'docId',
+   *   { senderId: 'senderId', kbId: 'kbId' },
+   * );
+   * ```
+   */
+  delete(docID: string, params: DocumentDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { senderId, kbId } = params;
+    return this._client.delete(
+      path`/v1/senders/${senderId}/agent/knowledge-bases/${kbId}/documents/${docID}`,
+      { ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+    );
+  }
+}
+
+export interface DocumentCreateResponse {
+  document: KnowledgeBasesAPI.AgentDocument;
+}
+
+export interface DocumentCreateParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+
+  /**
+   * Body param:
+   */
+  content: string;
+
+  /**
+   * Body param:
+   */
+  title: string;
+}
+
+export interface DocumentListParams extends CursorParams {
+  /**
+   * Path param:
+   */
+  senderId: string;
+}
+
+export interface DocumentDeleteParams {
+  senderId: string;
+
+  kbId: string;
+}
+
+export declare namespace Documents {
+  export {
+    type DocumentCreateResponse as DocumentCreateResponse,
+    type DocumentCreateParams as DocumentCreateParams,
+    type DocumentListParams as DocumentListParams,
+    type DocumentDeleteParams as DocumentDeleteParams,
+  };
+}
+
+export { type AgentDocumentsCursor };

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

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Documents,
+  type DocumentCreateResponse,
+  type DocumentCreateParams,
+  type DocumentListParams,
+  type DocumentDeleteParams,
+} from './documents';
+export {
+  KnowledgeBases,
+  type AgentDocument,
+  type AgentKnowledgeBase,
+  type KnowledgeBaseCreateResponse,
+  type KnowledgeBaseRetrieveResponse,
+  type KnowledgeBaseUpdateResponse,
+  type KnowledgeBaseCreateParams,
+  type KnowledgeBaseRetrieveParams,
+  type KnowledgeBaseUpdateParams,
+  type KnowledgeBaseListParams,
+  type KnowledgeBaseDeleteParams,
+  type AgentDocumentsCursor,
+  type AgentKnowledgeBasesCursor,
+} from './knowledge-bases';