Referencia del SDK

Resumen de lo que exporta @qcobro/sdk. Para las guías por tarea, empieza por Visión general del SDK.

Exports

import {
  Client,
  ValidationError,
  type ClientOptions,
  type Tokens,
  type FieldError,
  PortfoliosResource,
  AgentTemplatesResource,
  AgentEvaluationsResource
} from "@qcobro/sdk";

Export	Tipo	Descripción
`Client`	clase	El cliente de la API. Posee la conexión y el ciclo de autenticación, y expone los recursos.
`ClientOptions`	interfaz	Opciones del constructor de `Client`.
`Tokens`	interfaz	Tokens emitidos (`accessToken`, `refreshToken`, `idToken`).
`PortfoliosResource`	clase	El recurso de carteras, accesible vía `client.portfolios`.
`AgentTemplatesResource`	clase	El recurso de plantillas de agente, accesible vía `client.agentTemplates`. Incluye `preview` para canales sin conversación.
`AgentEvaluationsResource`	clase	El recurso de evaluación de agentes, accesible vía `client.agentEvaluations`.
`ValidationError`	clase	Error de validación en cliente, con detalle por campo.
`FieldError`	interfaz	Un fallo de validación por campo (`field`, `message`, `code`).

Client

El cliente de la API. Se construye una vez y se reutiliza.

const client = new Client(options: ClientOptions);

Miembro	Firma	Descripción
`portfolios`	`PortfoliosResource`	Operaciones de carteras (ver abajo).
`agentTemplates`	`AgentTemplatesResource`	Operaciones de plantillas de agente, incluida `preview` (ver Evaluar y previsualizar agentes).
`agentEvaluations`	`AgentEvaluationsResource`	Evaluación de agentes (ver abajo).
`trpc`	proxy tipado	Acceso directo a la API tRPC subyacente, para procedimientos que el SDK aún no envuelve. Prefiere los recursos cuando existan.
`login`	`(input) => Promise<Tokens>`	Autentica con email y contraseña.
`loginWithApiKey`	`(input) => Promise<Tokens>`	Autentica con una API key de workspace.
`refresh`	`(refreshToken?) => Promise<Tokens>`	Cambia el token de refresco por un nuevo token de acceso.
`useWorkspace`	`(accessKeyId) => this`	Selecciona el workspace activo.
`workspace`	`string \| undefined`	El `accessKeyId` del workspace activo.
`getTokens`	`() => Tokens`	Devuelve los tokens que tiene el cliente (en memoria).
`setTokens`	`(tokens) => this`	Reemplaza los tokens del cliente (para reanudar una sesión).

Consulta Autenticación y tokens para el ciclo completo.

PortfoliosResource

Accesible vía client.portfolios. No se construye directamente. Todos los métodos están acotados al workspace activo y validan su entrada en el cliente.

Método	Firma	Descripción
`list`	`(input?) => Promise<...>`	Lista las carteras del workspace activo.
`get`	`({ id }) => Promise<...>`	Obtiene una cartera por id.
`create`	`({ name, clientId }) => Promise<...>`	Crea una cartera.
`update`	`({ id, name?, archived? }) => Promise<...>`	Actualiza o archiva/restaura una cartera.
`delete`	`({ id }) => Promise<...>`	Elimina una cartera.
`listAccounts`	`({ portfolioId, limit?, offset? }) => Promise<...>`	Lista una página de cuentas de una cartera.
`syncAccounts`	`({ portfolioId, mode, rows }) => Promise<...>`	Sincroniza un lote de cuentas en una cartera.

Detalle de cada método en Gestionar carteras y Sincronizar cuentas.

AgentEvaluationsResource

Accesible vía client.agentEvaluations. No se construye directamente.

Método	Firma	Descripción
`evaluate`	`({ agentTemplateId, scenarios } \| { yaml }) => AsyncGenerator<...>`	Evalúa un agente `VOICE_AI`, `EMAIL` o `WHATSAPP` y transmite un evento por turno, por escenario, y un resumen final.

Detalle completo, junto con agentTemplates.preview para SMS/VOICE_PRERECORDED, en Evaluar y previsualizar agentes.

El escape hatch trpc

Cuando un procedimiento de la API todavía no tiene método de recurso, llámalo directamente por el proxy tipado client.trpc. Sigue beneficiándose de los tipos de extremo a extremo.

// Ejemplo: invocar un procedimiento que el SDK aún no envuelve.
const result = await client.trpc.someRouter.someProcedure.query(input);

Prefiere los recursos (client.portfolios, …) cuando existan; client.trpc es la vía para lo que todavía no está envuelto.

ValidationError y FieldError

Error estructurado que el SDK lanza cuando una entrada no pasa la validación en el cliente. Su forma completa está en Validación y errores.

class ValidationError extends Error {
  code: "VALIDATION_ERROR";
  fieldErrors: FieldError[];
  toJSON(): { code: string; message: string; fieldErrors: FieldError[] };
}

interface FieldError {
  field: string;
  message: string;
  code: string;
}

Get started

Operator guides

SDK

MCP

CLI

API reference

Concepts

Referencia del SDK

Exports

Client

PortfoliosResource

AgentEvaluationsResource

El escape hatch trpc

ValidationError y FieldError

​Exports

​Client

​PortfoliosResource

​AgentEvaluationsResource

​El escape hatch trpc

​ValidationError y FieldError

Exports

Client

PortfoliosResource

AgentEvaluationsResource

El escape hatch trpc

ValidationError y FieldError