@linkt/sdk 0.5.0 → 0.7.0

package/src/resources/task.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * **Tasks** are reusable workflow templates that define HOW research is executed. Tasks reference Prefect flow deployments and can be configured with prompts and parameters. Create a task once, then execute it multiple times to generate runs. Each execution creates a new run that can be monitored independently.
+ */
 export class Task extends APIResource {
   /**
    * Create a new task template.
@@ -758,6 +761,7 @@ export interface TaskCreateResponse {
   task_config?:
     | SearchTaskConfigResponse
     | IngestTaskConfigResponse
+    | TaskCreateResponse.OnDemandIngestTaskConfigResponse
     | IngestPromptConfigResponse
     | ProfilePromptConfigResponse
     | SignalTopicConfigResponse
@@ -766,6 +770,54 @@ export interface TaskCreateResponse {
     | null;
 }
 
+export namespace TaskCreateResponse {
+  /**
+   * On-demand ingest task configuration in API responses.
+   *
+   * Response model for on-demand ingest task configs that excludes backend-managed
+   * fields from the API surface.
+   *
+   * Attributes: type: Config type discriminator (always "ingest-ondemand"). file_id:
+   * ID of the CSV file. primary_column: Column containing entity names.
+   * csv_entity_type: Entity type in CSV. ignored_fields: Existing sheet fields
+   * allowed to be nullable. new_custom_fields: New enrichment fields added to sheet
+   * schema. webhook_url: Webhook URL for completion notification.
+   */
+  export interface OnDemandIngestTaskConfigResponse {
+    /**
+     * Entity type in CSV
+     */
+    csv_entity_type: string;
+
+    /**
+     * ID of the CSV file
+     */
+    file_id: string;
+
+    /**
+     * Column containing entity names
+     */
+    primary_column: string;
+
+    /**
+     * Existing sheet fields allowed to be nullable
+     */
+    ignored_fields?: Array<string>;
+
+    /**
+     * New enrichment fields added to sheet schema
+     */
+    new_custom_fields?: Array<{ [key: string]: string }>;
+
+    type?: 'ingest-ondemand';
+
+    /**
+     * Webhook URL for completion notification
+     */
+    webhook_url?: string | null;
+  }
+}
+
 /**
  * Response model for task data.
  *
@@ -830,6 +882,7 @@ export interface TaskRetrieveResponse {
   task_config?:
     | SearchTaskConfigResponse
     | IngestTaskConfigResponse
+    | TaskRetrieveResponse.OnDemandIngestTaskConfigResponse
     | IngestPromptConfigResponse
     | ProfilePromptConfigResponse
     | SignalTopicConfigResponse
@@ -838,6 +891,54 @@ export interface TaskRetrieveResponse {
     | null;
 }
 
+export namespace TaskRetrieveResponse {
+  /**
+   * On-demand ingest task configuration in API responses.
+   *
+   * Response model for on-demand ingest task configs that excludes backend-managed
+   * fields from the API surface.
+   *
+   * Attributes: type: Config type discriminator (always "ingest-ondemand"). file_id:
+   * ID of the CSV file. primary_column: Column containing entity names.
+   * csv_entity_type: Entity type in CSV. ignored_fields: Existing sheet fields
+   * allowed to be nullable. new_custom_fields: New enrichment fields added to sheet
+   * schema. webhook_url: Webhook URL for completion notification.
+   */
+  export interface OnDemandIngestTaskConfigResponse {
+    /**
+     * Entity type in CSV
+     */
+    csv_entity_type: string;
+
+    /**
+     * ID of the CSV file
+     */
+    file_id: string;
+
+    /**
+     * Column containing entity names
+     */
+    primary_column: string;
+
+    /**
+     * Existing sheet fields allowed to be nullable
+     */
+    ignored_fields?: Array<string>;
+
+    /**
+     * New enrichment fields added to sheet schema
+     */
+    new_custom_fields?: Array<{ [key: string]: string }>;
+
+    type?: 'ingest-ondemand';
+
+    /**
+     * Webhook URL for completion notification
+     */
+    webhook_url?: string | null;
+  }
+}
+
 /**
  * Response model for paginated task list.
  *
@@ -931,6 +1032,7 @@ export namespace TaskListResponse {
     task_config?:
       | TaskAPI.SearchTaskConfigResponse
       | TaskAPI.IngestTaskConfigResponse
+      | Task.OnDemandIngestTaskConfigResponse
       | TaskAPI.IngestPromptConfigResponse
       | TaskAPI.ProfilePromptConfigResponse
       | TaskAPI.SignalTopicConfigResponse
@@ -938,6 +1040,54 @@ export namespace TaskListResponse {
       | TaskAPI.SignalSheetConfigResponse
       | null;
   }
+
+  export namespace Task {
+    /**
+     * On-demand ingest task configuration in API responses.
+     *
+     * Response model for on-demand ingest task configs that excludes backend-managed
+     * fields from the API surface.
+     *
+     * Attributes: type: Config type discriminator (always "ingest-ondemand"). file_id:
+     * ID of the CSV file. primary_column: Column containing entity names.
+     * csv_entity_type: Entity type in CSV. ignored_fields: Existing sheet fields
+     * allowed to be nullable. new_custom_fields: New enrichment fields added to sheet
+     * schema. webhook_url: Webhook URL for completion notification.
+     */
+    export interface OnDemandIngestTaskConfigResponse {
+      /**
+       * Entity type in CSV
+       */
+      csv_entity_type: string;
+
+      /**
+       * ID of the CSV file
+       */
+      file_id: string;
+
+      /**
+       * Column containing entity names
+       */
+      primary_column: string;
+
+      /**
+       * Existing sheet fields allowed to be nullable
+       */
+      ignored_fields?: Array<string>;
+
+      /**
+       * New enrichment fields added to sheet schema
+       */
+      new_custom_fields?: Array<{ [key: string]: string }>;
+
+      type?: 'ingest-ondemand';
+
+      /**
+       * Webhook URL for completion notification
+       */
+      webhook_url?: string | null;
+    }
+  }
 }
 
 /**
@@ -1000,6 +1150,7 @@ export interface TaskCreateParams {
   task_config?:
     | SearchTaskConfig
     | IngestTaskConfig
+    | TaskCreateParams.OnDemandIngestTaskConfigRequest
     | ProfilePromptConfig
     | SignalTopicConfig
     | SignalCsvConfig
@@ -1007,6 +1158,59 @@ export interface TaskCreateParams {
     | null;
 }
 
+export namespace TaskCreateParams {
+  /**
+   * On-demand ingest task configuration for adding entities to existing ICPs.
+   *
+   * Creates a task that ingests additional entities from a CSV file into an existing
+   * ICP. Supports declaring which existing sheet fields can be nullable for the new
+   * entities and adding new enrichment fields to the sheet schema.
+   *
+   * Attributes: type: Config type discriminator (always "ingest-ondemand"). file_id:
+   * ID of the uploaded CSV file to process. primary_column: Column containing entity
+   * names for matching. csv_entity_type: Entity type in the CSV (e.g., 'person',
+   * 'company'). ignored_fields: Existing sheet fields allowed to be nullable for new
+   * entities. new_custom_fields: New enrichment fields to add to the sheet schema.
+   * webhook_url: Optional webhook URL for completion notification.
+   */
+  export interface OnDemandIngestTaskConfigRequest {
+    /**
+     * Entity type in the CSV (e.g., 'person', 'company')
+     */
+    csv_entity_type: string;
+
+    /**
+     * ID of the uploaded CSV file to process
+     */
+    file_id: string;
+
+    /**
+     * Column containing entity names for matching
+     */
+    primary_column: string;
+
+    /**
+     * Existing sheet fields allowed to be nullable for new entities
+     */
+    ignored_fields?: Array<string>;
+
+    /**
+     * New enrichment fields to add to sheet schema ({name, description})
+     */
+    new_custom_fields?: Array<{ [key: string]: string }>;
+
+    /**
+     * Config type discriminator
+     */
+    type?: 'ingest-ondemand';
+
+    /**
+     * Optional webhook URL to notify when workflow completes
+     */
+    webhook_url?: string | null;
+  }
+}
+
 export interface TaskUpdateParams {
   /**
    * Updated deployment name
@@ -1039,6 +1243,7 @@ export interface TaskUpdateParams {
   task_config?:
     | SearchTaskConfig
     | IngestTaskConfig
+    | TaskUpdateParams.OnDemandIngestTaskConfigRequest
     | ProfilePromptConfig
     | SignalTopicConfig
     | SignalCsvConfig
@@ -1046,6 +1251,59 @@ export interface TaskUpdateParams {
     | null;
 }
 
+export namespace TaskUpdateParams {
+  /**
+   * On-demand ingest task configuration for adding entities to existing ICPs.
+   *
+   * Creates a task that ingests additional entities from a CSV file into an existing
+   * ICP. Supports declaring which existing sheet fields can be nullable for the new
+   * entities and adding new enrichment fields to the sheet schema.
+   *
+   * Attributes: type: Config type discriminator (always "ingest-ondemand"). file_id:
+   * ID of the uploaded CSV file to process. primary_column: Column containing entity
+   * names for matching. csv_entity_type: Entity type in the CSV (e.g., 'person',
+   * 'company'). ignored_fields: Existing sheet fields allowed to be nullable for new
+   * entities. new_custom_fields: New enrichment fields to add to the sheet schema.
+   * webhook_url: Optional webhook URL for completion notification.
+   */
+  export interface OnDemandIngestTaskConfigRequest {
+    /**
+     * Entity type in the CSV (e.g., 'person', 'company')
+     */
+    csv_entity_type: string;
+
+    /**
+     * ID of the uploaded CSV file to process
+     */
+    file_id: string;
+
+    /**
+     * Column containing entity names for matching
+     */
+    primary_column: string;
+
+    /**
+     * Existing sheet fields allowed to be nullable for new entities
+     */
+    ignored_fields?: Array<string>;
+
+    /**
+     * New enrichment fields to add to sheet schema ({name, description})
+     */
+    new_custom_fields?: Array<{ [key: string]: string }>;
+
+    /**
+     * Config type discriminator
+     */
+    type?: 'ingest-ondemand';
+
+    /**
+     * Optional webhook URL to notify when workflow completes
+     */
+    webhook_url?: string | null;
+  }
+}
+
 export interface TaskListParams {
   /**
    * Filter by flow name

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.7.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.7.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.7.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.5.0'; // x-release-please-version
+exports.VERSION = '0.7.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.7.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map