@linkt/sdk 0.2.0

package/resources/icp.mjs

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Icp extends APIResource {
+    /**
+     * Create a new Ideal Customer Profile (ICP).
+     *
+     * ICPs are the foundation of your research workflows. They define WHAT entities to
+     * target using business-level descriptions and filters, without specifying
+     * technical implementation details.
+     *
+     * Create an ICP first, then link Sheets to it for entity storage.
+     */
+    create(body, options) {
+        return this._client.post('/v1/icp', { body, ...options });
+    }
+    /**
+     * Get a specific ICP by ID.
+     */
+    retrieve(icpID, options) {
+        return this._client.get(path `/v1/icp/${icpID}`, options);
+    }
+    /**
+     * Update an existing ICP.
+     *
+     * Only provided fields will be updated; omitted fields remain unchanged.
+     */
+    update(icpID, body, options) {
+        return this._client.put(path `/v1/icp/${icpID}`, { body, ...options });
+    }
+    /**
+     * List all ICPs for the organization.
+     *
+     * Results are scoped to your organization. Use the `mode` filter to separate
+     * discovery ICPs (for finding new entities) from monitoring ICPs (for tracking
+     * existing entities).
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/icp', { query, ...options });
+    }
+    /**
+     * Delete an ICP and all related resources.
+     *
+     * **Cascade delete**: This permanently removes the ICP along with all associated
+     * sheets, entities, schedules, tasks, and signals. This operation cannot be
+     * undone.
+     */
+    delete(icpID, options) {
+        return this._client.delete(path `/v1/icp/${icpID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get all active runs for an ICP.
+     *
+     * Returns runs in non-terminal states (RUNNING, SCHEDULED, PENDING). Useful for
+     * checking if workflows are currently processing this ICP before making changes.
+     */
+    getActiveRuns(icpID, options) {
+        return this._client.get(path `/v1/icp/${icpID}/active_runs`, options);
+    }
+}
+//# sourceMappingURL=icp.mjs.map

package/resources/icp.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"icp.mjs","sourceRoot":"","sources":["../src/resources/icp.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,GAAI,SAAQ,WAAW;IAClC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAqB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAa,EAAE,IAAqB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,QAA0C,EAAE,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,WAAW,KAAK,EAAE,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,KAAa,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,KAAK,cAAc,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}

package/resources/index.d.mts

@@ -0,0 +1,7 @@
+export { Files, type CsvProcessingStatus, type FileRetrieveResponse, type FileListResponse, type FileUploadResponse, type FileListParams, type FileUploadParams, } from "./files.mjs";
+export { Icp, type EntityTargetConfig, type IcpResponse, type IcpListResponse, type IcpGetActiveRunsResponse, type IcpCreateParams, type IcpUpdateParams, type IcpListParams, } from "./icp.mjs";
+export { Run, type RunCreateResponse, type RunRetrieveResponse, type RunListResponse, type RunGetQueueResponse, type RunCreateParams, type RunListParams, type RunGetQueueParams, } from "./run.mjs";
+export { SheetResource, type EntityType, type Sheet, type SheetListResponse, type SheetExportCsvResponse, type SheetGetEntitiesResponse, type SheetCreateParams, type SheetUpdateParams, type SheetListParams, type SheetExportCsvParams, type SheetGetEntitiesParams, } from "./sheet/sheet.mjs";
+export { Signal, type SignalResponse, type SignalListResponse, type SignalListParams } from "./signal.mjs";
+export { Task, type IngestTaskConfig, type SearchV2Config, type SearchV3Config, type SignalCsvConfigInput, type SignalSheetConfigInput, type SignalTopicConfigInput, type SignalTypeConfig, type StandardPromptConfig, type TaskCreateResponse, type TaskRetrieveResponse, type TaskListResponse, type TaskExecuteResponse, type TaskCreateParams, type TaskUpdateParams, type TaskListParams, type TaskExecuteParams, } from "./task.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,gBAAgB,GACtB;OACM,EACL,GAAG,EACH,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB;OACM,EACL,GAAG,EACH,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,iBAAiB,GACvB;OACM,EACL,aAAa,EACb,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B;OACM,EAAE,MAAM,EAAE,KAAK,cAAc,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC/E,EACL,IAAI,EACJ,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,iBAAiB,GACvB"}

package/resources/index.d.ts

@@ -0,0 +1,7 @@
+export { Files, type CsvProcessingStatus, type FileRetrieveResponse, type FileListResponse, type FileUploadResponse, type FileListParams, type FileUploadParams, } from "./files.js";
+export { Icp, type EntityTargetConfig, type IcpResponse, type IcpListResponse, type IcpGetActiveRunsResponse, type IcpCreateParams, type IcpUpdateParams, type IcpListParams, } from "./icp.js";
+export { Run, type RunCreateResponse, type RunRetrieveResponse, type RunListResponse, type RunGetQueueResponse, type RunCreateParams, type RunListParams, type RunGetQueueParams, } from "./run.js";
+export { SheetResource, type EntityType, type Sheet, type SheetListResponse, type SheetExportCsvResponse, type SheetGetEntitiesResponse, type SheetCreateParams, type SheetUpdateParams, type SheetListParams, type SheetExportCsvParams, type SheetGetEntitiesParams, } from "./sheet/sheet.js";
+export { Signal, type SignalResponse, type SignalListResponse, type SignalListParams } from "./signal.js";
+export { Task, type IngestTaskConfig, type SearchV2Config, type SearchV3Config, type SignalCsvConfigInput, type SignalSheetConfigInput, type SignalTopicConfigInput, type SignalTypeConfig, type StandardPromptConfig, type TaskCreateResponse, type TaskRetrieveResponse, type TaskListResponse, type TaskExecuteResponse, type TaskCreateParams, type TaskUpdateParams, type TaskListParams, type TaskExecuteParams, } from "./task.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,gBAAgB,GACtB;OACM,EACL,GAAG,EACH,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB;OACM,EACL,GAAG,EACH,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,iBAAiB,GACvB;OACM,EACL,aAAa,EACb,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,GAC5B;OACM,EAAE,MAAM,EAAE,KAAK,cAAc,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE;OAC/E,EACL,IAAI,EACJ,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,iBAAiB,GACvB"}

package/resources/index.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Task = exports.Signal = exports.SheetResource = exports.Run = exports.Icp = exports.Files = void 0;
+var files_1 = require("./files.js");
+Object.defineProperty(exports, "Files", { enumerable: true, get: function () { return files_1.Files; } });
+var icp_1 = require("./icp.js");
+Object.defineProperty(exports, "Icp", { enumerable: true, get: function () { return icp_1.Icp; } });
+var run_1 = require("./run.js");
+Object.defineProperty(exports, "Run", { enumerable: true, get: function () { return run_1.Run; } });
+var sheet_1 = require("./sheet/sheet.js");
+Object.defineProperty(exports, "SheetResource", { enumerable: true, get: function () { return sheet_1.SheetResource; } });
+var signal_1 = require("./signal.js");
+Object.defineProperty(exports, "Signal", { enumerable: true, get: function () { return signal_1.Signal; } });
+var task_1 = require("./task.js");
+Object.defineProperty(exports, "Task", { enumerable: true, get: function () { return task_1.Task; } });
+//# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,gCASe;AARb,0FAAA,GAAG,OAAA;AASL,gCASe;AARb,0FAAA,GAAG,OAAA;AASL,0CAYuB;AAXrB,sGAAA,aAAa,OAAA;AAYf,sCAAuG;AAA9F,gGAAA,MAAM,OAAA;AACf,kCAkBgB;AAjBd,4FAAA,IAAI,OAAA"}

package/resources/index.mjs

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Files, } from "./files.mjs";
+export { Icp, } from "./icp.mjs";
+export { Run, } from "./run.mjs";
+export { SheetResource, } from "./sheet/sheet.mjs";
+export { Signal } from "./signal.mjs";
+export { Task, } from "./task.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,KAAK,GAON;OACM,EACL,GAAG,GAQJ;OACM,EACL,GAAG,GAQJ;OACM,EACL,aAAa,GAWd;OACM,EAAE,MAAM,EAAuE;OAC/E,EACL,IAAI,GAiBL"}

package/resources/run.d.mts

@@ -0,0 +1,224 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Run extends APIResource {
+    /**
+     * Execute an agent by creating a new run.
+     *
+     * Creates a new workflow execution asynchronously. Prefer using POST
+     * /v1/task/{task_id}/execute for task-based workflows.
+     *
+     * @example
+     * ```ts
+     * const run = await client.run.create({
+     *   agent_id: '5eb7cf5a86d9755df3a6c593',
+     *   parameters: { foo: 'bar' },
+     * });
+     * ```
+     */
+    create(body: RunCreateParams, options?: RequestOptions): APIPromise<RunCreateResponse>;
+    /**
+     * Get a specific run by ID.
+     *
+     * Automatically refreshes status from Prefect if the run is still active.
+     *
+     * @example
+     * ```ts
+     * const run = await client.run.retrieve(
+     *   '5eb7cf5a86d9755df3a6c593',
+     * );
+     * ```
+     */
+    retrieve(runID: string, options?: RequestOptions): APIPromise<RunRetrieveResponse>;
+    /**
+     * List all runs for the organization.
+     *
+     * Runs are workflow executions created from tasks. Filter by status to find active
+     * runs (RUNNING, PENDING) or completed ones (COMPLETED, FAILED).
+     *
+     * @example
+     * ```ts
+     * const runs = await client.run.list();
+     * ```
+     */
+    list(query?: RunListParams | null | undefined, options?: RequestOptions): APIPromise<RunListResponse>;
+    /**
+     * Delete a run.
+     *
+     * Permanently deletes the run record. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * await client.run.delete('5eb7cf5a86d9755df3a6c593');
+     * ```
+     */
+    delete(runID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Cancel a running workflow.
+     *
+     * Cancels both the Prefect flow and updates the database record. Only effective
+     * for non-terminal runs.
+     *
+     * @example
+     * ```ts
+     * await client.run.cancel('5eb7cf5a86d9755df3a6c593');
+     * ```
+     */
+    cancel(runID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get the queue status for a run.
+     *
+     * Shows entities being processed by the workflow. States: queued (waiting),
+     * processing (active), completed (done), discarded (skipped). Set
+     * include_history=true to see all processed entities.
+     *
+     * @example
+     * ```ts
+     * const response = await client.run.getQueue(
+     *   '5eb7cf5a86d9755df3a6c593',
+     * );
+     * ```
+     */
+    getQueue(runID: string, query?: RunGetQueueParams | null | undefined, options?: RequestOptions): APIPromise<RunGetQueueResponse>;
+}
+export type RunCreateResponse = {
+    [key: string]: unknown;
+};
+export type RunRetrieveResponse = {
+    [key: string]: unknown;
+};
+/**
+ * Response schema for paginated list of agent runs.
+ *
+ * Follows the established pattern from other list endpoints:
+ *
+ * - SheetListResponse (src/api/schema/sheet.py)
+ * - ICPListResponse (src/api/schema/icp.py)
+ *
+ * Attributes: runs: List of AgentRun objects for the current page total: Total
+ * number of runs matching the filter criteria page: Current page number (1-based)
+ * page_size: Number of items per page
+ */
+export interface RunListResponse {
+    page: number;
+    page_size: number;
+    runs: Array<{
+        [key: string]: unknown;
+    }>;
+    total: number;
+}
+/**
+ * Response schema for run queue status with optional history.
+ *
+ * Provides a read-only view into the current state of a run's entity queue,
+ * including queued entities, processing history, and statistics.
+ *
+ * Attributes: entities: List of entities (current queue or full history based on
+ * request) stats: Queue statistics or state counts total: Total number of entities
+ * returned offset: Offset used for pagination (0-indexed) limit: Maximum number of
+ * entities returned state_counts: Optional breakdown of entities by state
+ * include_history: Whether response includes historical data
+ */
+export interface RunGetQueueResponse {
+    entities: Array<{
+        [key: string]: unknown;
+    }>;
+    limit: number;
+    offset: number;
+    stats: {
+        [key: string]: unknown;
+    };
+    total: number;
+    include_history?: boolean;
+    state_counts?: {
+        [key: string]: number;
+    } | null;
+}
+export interface RunCreateParams {
+    agent_id: string;
+    parameters: {
+        [key: string]: unknown;
+    };
+    icp_id?: string | null;
+}
+export interface RunListParams {
+    /**
+     * Filter by agent ID (legacy)
+     */
+    agent_id?: string | null;
+    /**
+     * Filter by agent type
+     */
+    agent_type?: string | null;
+    /**
+     * Filter runs created after this date (ISO 8601 format: 2024-01-15T10:30:00Z)
+     */
+    created_after?: string | null;
+    /**
+     * Filter runs created before this date (ISO 8601 format)
+     */
+    created_before?: string | null;
+    /**
+     * Filter by ICP ID
+     */
+    icp_id?: string | null;
+    /**
+     * Sort order: -1 for descending, 1 for ascending
+     */
+    order?: number | null;
+    /**
+     * Page number (1-based)
+     */
+    page?: number;
+    /**
+     * Items per page (max 100)
+     */
+    page_size?: number;
+    /**
+     * Field to sort by (e.g., 'created_at', 'updated_at', 'agent_type')
+     */
+    sort_by?: string | null;
+    /**
+     * Filter by run status (SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELED,
+     * CRASHED, PAUSED)
+     */
+    status?: 'SCHEDULED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'CRASHED' | 'PAUSED' | null;
+    /**
+     * Filter by task ID
+     */
+    task_id?: string | null;
+    /**
+     * Filter by task type (signal, search, profile, ingest)
+     */
+    task_type?: string | null;
+    /**
+     * Filter runs updated after this date (ISO 8601 format)
+     */
+    updated_after?: string | null;
+    /**
+     * Filter runs updated before this date (ISO 8601 format)
+     */
+    updated_before?: string | null;
+}
+export interface RunGetQueueParams {
+    /**
+     * Include processing history from all states
+     */
+    include_history?: boolean;
+    /**
+     * Maximum number of entities to return
+     */
+    limit?: number;
+    /**
+     * Starting position in queue (0-indexed)
+     */
+    offset?: number;
+    /**
+     * Filter by state: queued, processing, completed, discarded
+     */
+    state?: string | null;
+}
+export declare namespace Run {
+    export { type RunCreateResponse as RunCreateResponse, type RunRetrieveResponse as RunRetrieveResponse, type RunListResponse as RunListResponse, type RunGetQueueResponse as RunGetQueueResponse, type RunCreateParams as RunCreateParams, type RunListParams as RunListParams, type RunGetQueueParams as RunGetQueueParams, };
+}
+//# sourceMappingURL=run.d.mts.map

package/resources/run.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.mts","sourceRoot":"","sources":["../src/resources/run.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,MAAM,iBAAiB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAExC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE5C,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EACH,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,SAAS,GACT,QAAQ,GACR,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/run.d.ts

@@ -0,0 +1,224 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Run extends APIResource {
+    /**
+     * Execute an agent by creating a new run.
+     *
+     * Creates a new workflow execution asynchronously. Prefer using POST
+     * /v1/task/{task_id}/execute for task-based workflows.
+     *
+     * @example
+     * ```ts
+     * const run = await client.run.create({
+     *   agent_id: '5eb7cf5a86d9755df3a6c593',
+     *   parameters: { foo: 'bar' },
+     * });
+     * ```
+     */
+    create(body: RunCreateParams, options?: RequestOptions): APIPromise<RunCreateResponse>;
+    /**
+     * Get a specific run by ID.
+     *
+     * Automatically refreshes status from Prefect if the run is still active.
+     *
+     * @example
+     * ```ts
+     * const run = await client.run.retrieve(
+     *   '5eb7cf5a86d9755df3a6c593',
+     * );
+     * ```
+     */
+    retrieve(runID: string, options?: RequestOptions): APIPromise<RunRetrieveResponse>;
+    /**
+     * List all runs for the organization.
+     *
+     * Runs are workflow executions created from tasks. Filter by status to find active
+     * runs (RUNNING, PENDING) or completed ones (COMPLETED, FAILED).
+     *
+     * @example
+     * ```ts
+     * const runs = await client.run.list();
+     * ```
+     */
+    list(query?: RunListParams | null | undefined, options?: RequestOptions): APIPromise<RunListResponse>;
+    /**
+     * Delete a run.
+     *
+     * Permanently deletes the run record. This operation cannot be undone.
+     *
+     * @example
+     * ```ts
+     * await client.run.delete('5eb7cf5a86d9755df3a6c593');
+     * ```
+     */
+    delete(runID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Cancel a running workflow.
+     *
+     * Cancels both the Prefect flow and updates the database record. Only effective
+     * for non-terminal runs.
+     *
+     * @example
+     * ```ts
+     * await client.run.cancel('5eb7cf5a86d9755df3a6c593');
+     * ```
+     */
+    cancel(runID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get the queue status for a run.
+     *
+     * Shows entities being processed by the workflow. States: queued (waiting),
+     * processing (active), completed (done), discarded (skipped). Set
+     * include_history=true to see all processed entities.
+     *
+     * @example
+     * ```ts
+     * const response = await client.run.getQueue(
+     *   '5eb7cf5a86d9755df3a6c593',
+     * );
+     * ```
+     */
+    getQueue(runID: string, query?: RunGetQueueParams | null | undefined, options?: RequestOptions): APIPromise<RunGetQueueResponse>;
+}
+export type RunCreateResponse = {
+    [key: string]: unknown;
+};
+export type RunRetrieveResponse = {
+    [key: string]: unknown;
+};
+/**
+ * Response schema for paginated list of agent runs.
+ *
+ * Follows the established pattern from other list endpoints:
+ *
+ * - SheetListResponse (src/api/schema/sheet.py)
+ * - ICPListResponse (src/api/schema/icp.py)
+ *
+ * Attributes: runs: List of AgentRun objects for the current page total: Total
+ * number of runs matching the filter criteria page: Current page number (1-based)
+ * page_size: Number of items per page
+ */
+export interface RunListResponse {
+    page: number;
+    page_size: number;
+    runs: Array<{
+        [key: string]: unknown;
+    }>;
+    total: number;
+}
+/**
+ * Response schema for run queue status with optional history.
+ *
+ * Provides a read-only view into the current state of a run's entity queue,
+ * including queued entities, processing history, and statistics.
+ *
+ * Attributes: entities: List of entities (current queue or full history based on
+ * request) stats: Queue statistics or state counts total: Total number of entities
+ * returned offset: Offset used for pagination (0-indexed) limit: Maximum number of
+ * entities returned state_counts: Optional breakdown of entities by state
+ * include_history: Whether response includes historical data
+ */
+export interface RunGetQueueResponse {
+    entities: Array<{
+        [key: string]: unknown;
+    }>;
+    limit: number;
+    offset: number;
+    stats: {
+        [key: string]: unknown;
+    };
+    total: number;
+    include_history?: boolean;
+    state_counts?: {
+        [key: string]: number;
+    } | null;
+}
+export interface RunCreateParams {
+    agent_id: string;
+    parameters: {
+        [key: string]: unknown;
+    };
+    icp_id?: string | null;
+}
+export interface RunListParams {
+    /**
+     * Filter by agent ID (legacy)
+     */
+    agent_id?: string | null;
+    /**
+     * Filter by agent type
+     */
+    agent_type?: string | null;
+    /**
+     * Filter runs created after this date (ISO 8601 format: 2024-01-15T10:30:00Z)
+     */
+    created_after?: string | null;
+    /**
+     * Filter runs created before this date (ISO 8601 format)
+     */
+    created_before?: string | null;
+    /**
+     * Filter by ICP ID
+     */
+    icp_id?: string | null;
+    /**
+     * Sort order: -1 for descending, 1 for ascending
+     */
+    order?: number | null;
+    /**
+     * Page number (1-based)
+     */
+    page?: number;
+    /**
+     * Items per page (max 100)
+     */
+    page_size?: number;
+    /**
+     * Field to sort by (e.g., 'created_at', 'updated_at', 'agent_type')
+     */
+    sort_by?: string | null;
+    /**
+     * Filter by run status (SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELED,
+     * CRASHED, PAUSED)
+     */
+    status?: 'SCHEDULED' | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'CRASHED' | 'PAUSED' | null;
+    /**
+     * Filter by task ID
+     */
+    task_id?: string | null;
+    /**
+     * Filter by task type (signal, search, profile, ingest)
+     */
+    task_type?: string | null;
+    /**
+     * Filter runs updated after this date (ISO 8601 format)
+     */
+    updated_after?: string | null;
+    /**
+     * Filter runs updated before this date (ISO 8601 format)
+     */
+    updated_before?: string | null;
+}
+export interface RunGetQueueParams {
+    /**
+     * Include processing history from all states
+     */
+    include_history?: boolean;
+    /**
+     * Maximum number of entities to return
+     */
+    limit?: number;
+    /**
+     * Starting position in queue (0-indexed)
+     */
+    offset?: number;
+    /**
+     * Filter by state: queued, processing, completed, discarded
+     */
+    state?: string | null;
+}
+export declare namespace Run {
+    export { type RunCreateResponse as RunCreateResponse, type RunRetrieveResponse as RunRetrieveResponse, type RunListResponse as RunListResponse, type RunGetQueueResponse as RunGetQueueResponse, type RunCreateParams as RunCreateParams, type RunListParams as RunListParams, type RunGetQueueParams as RunGetQueueParams, };
+}
+//# sourceMappingURL=run.d.ts.map

package/resources/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../src/resources/run.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAItF;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;;;;;;;;;OAaG;IACH,QAAQ,CACN,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED,MAAM,MAAM,iBAAiB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,IAAI,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAExC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE5C,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAElC,KAAK,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,MAAM,CAAC,EACH,WAAW,GACX,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,SAAS,GACT,QAAQ,GACR,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}