@linkt/sdk 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/LICENSE +201 -0
- package/README.md +424 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +206 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +206 -0
- package/client.d.ts.map +1 -0
- package/client.js +473 -0
- package/client.js.map +1 -0
- package/client.mjs +469 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +137 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/files.d.mts +170 -0
- package/resources/files.d.mts.map +1 -0
- package/resources/files.d.ts +170 -0
- package/resources/files.d.ts.map +1 -0
- package/resources/files.js +39 -0
- package/resources/files.js.map +1 -0
- package/resources/files.mjs +35 -0
- package/resources/files.mjs.map +1 -0
- package/resources/icp.d.mts +162 -0
- package/resources/icp.d.mts.map +1 -0
- package/resources/icp.d.ts +162 -0
- package/resources/icp.d.ts.map +1 -0
- package/resources/icp.js +69 -0
- package/resources/icp.js.map +1 -0
- package/resources/icp.mjs +65 -0
- package/resources/icp.mjs.map +1 -0
- package/resources/index.d.mts +7 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +7 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +17 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +8 -0
- package/resources/index.mjs.map +1 -0
- package/resources/run.d.mts +224 -0
- package/resources/run.d.mts.map +1 -0
- package/resources/run.d.ts +224 -0
- package/resources/run.d.ts.map +1 -0
- package/resources/run.js +107 -0
- package/resources/run.js.map +1 -0
- package/resources/run.mjs +103 -0
- package/resources/run.mjs.map +1 -0
- package/resources/sheet/entity.d.mts +52 -0
- package/resources/sheet/entity.d.mts.map +1 -0
- package/resources/sheet/entity.d.ts +52 -0
- package/resources/sheet/entity.d.ts.map +1 -0
- package/resources/sheet/entity.js +45 -0
- package/resources/sheet/entity.js.map +1 -0
- package/resources/sheet/entity.mjs +41 -0
- package/resources/sheet/entity.mjs.map +1 -0
- package/resources/sheet/index.d.mts +4 -0
- package/resources/sheet/index.d.mts.map +1 -0
- package/resources/sheet/index.d.ts +4 -0
- package/resources/sheet/index.d.ts.map +1 -0
- package/resources/sheet/index.js +11 -0
- package/resources/sheet/index.js.map +1 -0
- package/resources/sheet/index.mjs +5 -0
- package/resources/sheet/index.mjs.map +1 -0
- package/resources/sheet/schema.d.mts +207 -0
- package/resources/sheet/schema.d.mts.map +1 -0
- package/resources/sheet/schema.d.ts +207 -0
- package/resources/sheet/schema.d.ts.map +1 -0
- package/resources/sheet/schema.js +65 -0
- package/resources/sheet/schema.js.map +1 -0
- package/resources/sheet/schema.mjs +61 -0
- package/resources/sheet/schema.mjs.map +1 -0
- package/resources/sheet/sheet.d.mts +195 -0
- package/resources/sheet/sheet.d.mts.map +1 -0
- package/resources/sheet/sheet.d.ts +195 -0
- package/resources/sheet/sheet.d.ts.map +1 -0
- package/resources/sheet/sheet.js +90 -0
- package/resources/sheet/sheet.js.map +1 -0
- package/resources/sheet/sheet.mjs +85 -0
- package/resources/sheet/sheet.mjs.map +1 -0
- package/resources/sheet.d.mts +2 -0
- package/resources/sheet.d.mts.map +1 -0
- package/resources/sheet.d.ts +2 -0
- package/resources/sheet.d.ts.map +1 -0
- package/resources/sheet.js +6 -0
- package/resources/sheet.js.map +1 -0
- package/resources/sheet.mjs +3 -0
- package/resources/sheet.mjs.map +1 -0
- package/resources/signal.d.mts +79 -0
- package/resources/signal.d.mts.map +1 -0
- package/resources/signal.d.ts +79 -0
- package/resources/signal.d.ts.map +1 -0
- package/resources/signal.js +26 -0
- package/resources/signal.js.map +1 -0
- package/resources/signal.mjs +22 -0
- package/resources/signal.mjs.map +1 -0
- package/resources/task.d.mts +717 -0
- package/resources/task.d.mts.map +1 -0
- package/resources/task.d.ts +717 -0
- package/resources/task.d.ts.map +1 -0
- package/resources/task.js +108 -0
- package/resources/task.js.map +1 -0
- package/resources/task.mjs +104 -0
- package/resources/task.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +877 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/files.ts +219 -0
- package/src/resources/icp.ts +227 -0
- package/src/resources/index.ts +64 -0
- package/src/resources/run.ts +293 -0
- package/src/resources/sheet/entity.ts +97 -0
- package/src/resources/sheet/index.ts +30 -0
- package/src/resources/sheet/schema.ts +246 -0
- package/src/resources/sheet/sheet.ts +318 -0
- package/src/resources/sheet.ts +3 -0
- package/src/resources/signal.ts +117 -0
- package/src/resources/task.ts +912 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { type Uploadable } from "../core/uploads.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class Files extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Get file details by ID.
|
|
8
|
+
*
|
|
9
|
+
* Returns metadata for a specific file including name, size, and processing
|
|
10
|
+
* status. Use this to check if a file is ready for use in workflows.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(fileID: string, options?: RequestOptions): APIPromise<FileRetrieveResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* List uploaded files.
|
|
15
|
+
*
|
|
16
|
+
* Returns a paginated list of all files uploaded by your organization. Files can
|
|
17
|
+
* be used as data sources for signal monitoring and ingest tasks.
|
|
18
|
+
*/
|
|
19
|
+
list(query?: FileListParams | null | undefined, options?: RequestOptions): APIPromise<FileListResponse>;
|
|
20
|
+
/**
|
|
21
|
+
* Upload a CSV or XLSX file.
|
|
22
|
+
*
|
|
23
|
+
* Upload a data file for use in signal monitoring or ingest workflows. The file is
|
|
24
|
+
* stored securely and can be referenced when creating tasks. XLSX files are
|
|
25
|
+
* automatically converted to CSV format (first sheet only).
|
|
26
|
+
*/
|
|
27
|
+
upload(body: FileUploadParams, options?: RequestOptions): APIPromise<FileUploadResponse>;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Processing status for CSV files.
|
|
31
|
+
*/
|
|
32
|
+
export type CsvProcessingStatus = 'pending' | 'processing' | 'completed' | 'failed';
|
|
33
|
+
/**
|
|
34
|
+
* Response model for file details.
|
|
35
|
+
*/
|
|
36
|
+
export interface FileRetrieveResponse {
|
|
37
|
+
/**
|
|
38
|
+
* Content type of the file
|
|
39
|
+
*/
|
|
40
|
+
content_type: string;
|
|
41
|
+
/**
|
|
42
|
+
* The ID of the file
|
|
43
|
+
*/
|
|
44
|
+
file_id: string;
|
|
45
|
+
/**
|
|
46
|
+
* The name of the file
|
|
47
|
+
*/
|
|
48
|
+
name: string;
|
|
49
|
+
/**
|
|
50
|
+
* S3 URI of the file
|
|
51
|
+
*/
|
|
52
|
+
s3_uri: string;
|
|
53
|
+
/**
|
|
54
|
+
* Size of the file in bytes
|
|
55
|
+
*/
|
|
56
|
+
size_bytes: number;
|
|
57
|
+
/**
|
|
58
|
+
* CSV metadata
|
|
59
|
+
*/
|
|
60
|
+
csv_metadata?: {
|
|
61
|
+
[key: string]: unknown;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* Original file type if converted (e.g., 'xlsx' if XLSX was converted to CSV)
|
|
65
|
+
*/
|
|
66
|
+
original_file_type?: string | null;
|
|
67
|
+
/**
|
|
68
|
+
* Processing status
|
|
69
|
+
*/
|
|
70
|
+
processing_status?: CsvProcessingStatus;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Response model for file listing.
|
|
74
|
+
*/
|
|
75
|
+
export interface FileListResponse {
|
|
76
|
+
/**
|
|
77
|
+
* List of files
|
|
78
|
+
*/
|
|
79
|
+
files: Array<FileListResponse.File>;
|
|
80
|
+
/**
|
|
81
|
+
* Current page number
|
|
82
|
+
*/
|
|
83
|
+
page: number;
|
|
84
|
+
/**
|
|
85
|
+
* Number of items per page
|
|
86
|
+
*/
|
|
87
|
+
page_size: number;
|
|
88
|
+
/**
|
|
89
|
+
* Total number of files
|
|
90
|
+
*/
|
|
91
|
+
total: number;
|
|
92
|
+
}
|
|
93
|
+
export declare namespace FileListResponse {
|
|
94
|
+
/**
|
|
95
|
+
* File item in list response.
|
|
96
|
+
*/
|
|
97
|
+
interface File {
|
|
98
|
+
/**
|
|
99
|
+
* The ID of the file
|
|
100
|
+
*/
|
|
101
|
+
file_id: string;
|
|
102
|
+
/**
|
|
103
|
+
* The name of the file
|
|
104
|
+
*/
|
|
105
|
+
name: string;
|
|
106
|
+
/**
|
|
107
|
+
* Size of the file in bytes
|
|
108
|
+
*/
|
|
109
|
+
size_bytes: number;
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Response model for file upload.
|
|
114
|
+
*/
|
|
115
|
+
export interface FileUploadResponse {
|
|
116
|
+
/**
|
|
117
|
+
* Content type of the file
|
|
118
|
+
*/
|
|
119
|
+
content_type: string;
|
|
120
|
+
/**
|
|
121
|
+
* The ID of the uploaded file
|
|
122
|
+
*/
|
|
123
|
+
file_id: string;
|
|
124
|
+
/**
|
|
125
|
+
* The name of the file
|
|
126
|
+
*/
|
|
127
|
+
name: string;
|
|
128
|
+
/**
|
|
129
|
+
* Processing status
|
|
130
|
+
*/
|
|
131
|
+
processing_status: CsvProcessingStatus;
|
|
132
|
+
/**
|
|
133
|
+
* S3 URI of the uploaded file
|
|
134
|
+
*/
|
|
135
|
+
s3_uri: string;
|
|
136
|
+
/**
|
|
137
|
+
* Size of the file in bytes
|
|
138
|
+
*/
|
|
139
|
+
size_bytes: number;
|
|
140
|
+
/**
|
|
141
|
+
* CSV metadata
|
|
142
|
+
*/
|
|
143
|
+
csv_metadata?: {
|
|
144
|
+
[key: string]: unknown;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Original file type if converted (e.g., 'xlsx' if XLSX was converted to CSV)
|
|
148
|
+
*/
|
|
149
|
+
original_file_type?: string | null;
|
|
150
|
+
}
|
|
151
|
+
export interface FileListParams {
|
|
152
|
+
/**
|
|
153
|
+
* Page number (1-based)
|
|
154
|
+
*/
|
|
155
|
+
page?: number;
|
|
156
|
+
/**
|
|
157
|
+
* Items per page
|
|
158
|
+
*/
|
|
159
|
+
page_size?: number;
|
|
160
|
+
}
|
|
161
|
+
export interface FileUploadParams {
|
|
162
|
+
/**
|
|
163
|
+
* CSV or XLSX file to upload
|
|
164
|
+
*/
|
|
165
|
+
file: Uploadable;
|
|
166
|
+
}
|
|
167
|
+
export declare namespace Files {
|
|
168
|
+
export { type CsvProcessingStatus as CsvProcessingStatus, type FileRetrieveResponse as FileRetrieveResponse, type FileListResponse as FileListResponse, type FileUploadResponse as FileUploadResponse, type FileListParams as FileListParams, type FileUploadParams as FileUploadParams, };
|
|
169
|
+
}
|
|
170
|
+
//# sourceMappingURL=files.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIpF;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAMzF;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEpF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,iBAAiB,EAAE,mBAAmB,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Files = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const uploads_1 = require("../internal/uploads.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Files extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Get file details by ID.
|
|
11
|
+
*
|
|
12
|
+
* Returns metadata for a specific file including name, size, and processing
|
|
13
|
+
* status. Use this to check if a file is ready for use in workflows.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(fileID, options) {
|
|
16
|
+
return this._client.get((0, path_1.path) `/v1/files/${fileID}`, options);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* List uploaded files.
|
|
20
|
+
*
|
|
21
|
+
* Returns a paginated list of all files uploaded by your organization. Files can
|
|
22
|
+
* be used as data sources for signal monitoring and ingest tasks.
|
|
23
|
+
*/
|
|
24
|
+
list(query = {}, options) {
|
|
25
|
+
return this._client.get('/v1/files', { query, ...options });
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Upload a CSV or XLSX file.
|
|
29
|
+
*
|
|
30
|
+
* Upload a data file for use in signal monitoring or ingest workflows. The file is
|
|
31
|
+
* stored securely and can be referenced when creating tasks. XLSX files are
|
|
32
|
+
* automatically converted to CSV format (first sheet only).
|
|
33
|
+
*/
|
|
34
|
+
upload(body, options) {
|
|
35
|
+
return this._client.post('/v1/files/upload', (0, uploads_1.multipartFormRequestOptions)({ body, ...options }, this._client));
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.Files = Files;
|
|
39
|
+
//# sourceMappingURL=files.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAkE;AAClE,oDAA8C;AAE9C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,kBAAkB,EAClB,IAAA,qCAA2B,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF;AArCD,sBAqCC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { multipartFormRequestOptions } from "../internal/uploads.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Files extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Get file details by ID.
|
|
8
|
+
*
|
|
9
|
+
* Returns metadata for a specific file including name, size, and processing
|
|
10
|
+
* status. Use this to check if a file is ready for use in workflows.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(fileID, options) {
|
|
13
|
+
return this._client.get(path `/v1/files/${fileID}`, options);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* List uploaded files.
|
|
17
|
+
*
|
|
18
|
+
* Returns a paginated list of all files uploaded by your organization. Files can
|
|
19
|
+
* be used as data sources for signal monitoring and ingest tasks.
|
|
20
|
+
*/
|
|
21
|
+
list(query = {}, options) {
|
|
22
|
+
return this._client.get('/v1/files', { query, ...options });
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Upload a CSV or XLSX file.
|
|
26
|
+
*
|
|
27
|
+
* Upload a data file for use in signal monitoring or ingest workflows. The file is
|
|
28
|
+
* stored securely and can be referenced when creating tasks. XLSX files are
|
|
29
|
+
* automatically converted to CSV format (first sheet only).
|
|
30
|
+
*/
|
|
31
|
+
upload(body, options) {
|
|
32
|
+
return this._client.post('/v1/files/upload', multipartFormRequestOptions({ body, ...options }, this._client));
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=files.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../src/resources/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,IAAI,CACF,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,kBAAkB,EAClB,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAChE,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Icp extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new Ideal Customer Profile (ICP).
|
|
7
|
+
*
|
|
8
|
+
* ICPs are the foundation of your research workflows. They define WHAT entities to
|
|
9
|
+
* target using business-level descriptions and filters, without specifying
|
|
10
|
+
* technical implementation details.
|
|
11
|
+
*
|
|
12
|
+
* Create an ICP first, then link Sheets to it for entity storage.
|
|
13
|
+
*/
|
|
14
|
+
create(body: IcpCreateParams, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Get a specific ICP by ID.
|
|
17
|
+
*/
|
|
18
|
+
retrieve(icpID: string, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Update an existing ICP.
|
|
21
|
+
*
|
|
22
|
+
* Only provided fields will be updated; omitted fields remain unchanged.
|
|
23
|
+
*/
|
|
24
|
+
update(icpID: string, body: IcpUpdateParams, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* List all ICPs for the organization.
|
|
27
|
+
*
|
|
28
|
+
* Results are scoped to your organization. Use the `mode` filter to separate
|
|
29
|
+
* discovery ICPs (for finding new entities) from monitoring ICPs (for tracking
|
|
30
|
+
* existing entities).
|
|
31
|
+
*/
|
|
32
|
+
list(query?: IcpListParams | null | undefined, options?: RequestOptions): APIPromise<IcpListResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Delete an ICP and all related resources.
|
|
35
|
+
*
|
|
36
|
+
* **Cascade delete**: This permanently removes the ICP along with all associated
|
|
37
|
+
* sheets, entities, schedules, tasks, and signals. This operation cannot be
|
|
38
|
+
* undone.
|
|
39
|
+
*/
|
|
40
|
+
delete(icpID: string, options?: RequestOptions): APIPromise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* Get all active runs for an ICP.
|
|
43
|
+
*
|
|
44
|
+
* Returns runs in non-terminal states (RUNNING, SCHEDULED, PENDING). Useful for
|
|
45
|
+
* checking if workflows are currently processing this ICP before making changes.
|
|
46
|
+
*/
|
|
47
|
+
getActiveRuns(icpID: string, options?: RequestOptions): APIPromise<IcpGetActiveRunsResponse>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Request model for entity target configuration.
|
|
51
|
+
*/
|
|
52
|
+
export interface EntityTargetConfig {
|
|
53
|
+
/**
|
|
54
|
+
* Business description of targets
|
|
55
|
+
*/
|
|
56
|
+
description: string;
|
|
57
|
+
/**
|
|
58
|
+
* Entity type to target
|
|
59
|
+
*/
|
|
60
|
+
entity_type: string;
|
|
61
|
+
/**
|
|
62
|
+
* Filters to apply
|
|
63
|
+
*/
|
|
64
|
+
filters?: Array<string>;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Response model for ICP.
|
|
68
|
+
*/
|
|
69
|
+
export interface IcpResponse {
|
|
70
|
+
id: string;
|
|
71
|
+
created_at: string;
|
|
72
|
+
description: string;
|
|
73
|
+
entity_targets: Array<IcpResponse.EntityTarget>;
|
|
74
|
+
name: string;
|
|
75
|
+
updated_at: string;
|
|
76
|
+
}
|
|
77
|
+
export declare namespace IcpResponse {
|
|
78
|
+
/**
|
|
79
|
+
* Response model for entity target configuration.
|
|
80
|
+
*/
|
|
81
|
+
interface EntityTarget {
|
|
82
|
+
description: string;
|
|
83
|
+
entity_type: string;
|
|
84
|
+
root: boolean;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Response for listing ICPs.
|
|
89
|
+
*/
|
|
90
|
+
export interface IcpListResponse {
|
|
91
|
+
icps: Array<IcpResponse>;
|
|
92
|
+
page: number;
|
|
93
|
+
page_size: number;
|
|
94
|
+
total: number;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Response model for ICP running status.
|
|
98
|
+
*/
|
|
99
|
+
export interface IcpGetActiveRunsResponse {
|
|
100
|
+
runs: Array<IcpGetActiveRunsResponse.Run>;
|
|
101
|
+
}
|
|
102
|
+
export declare namespace IcpGetActiveRunsResponse {
|
|
103
|
+
/**
|
|
104
|
+
* Individual run status item for API responses.
|
|
105
|
+
*
|
|
106
|
+
* Includes both agent_type (execution context) and task_type (workflow type)
|
|
107
|
+
* fields to support filtering and display during the transition from legacy runs.
|
|
108
|
+
*
|
|
109
|
+
* Attributes: id: Unique run identifier (ObjectId as string) agent_type: HOW the
|
|
110
|
+
* run was triggered ("task", "play") task_type: WHAT workflow runs ("signal",
|
|
111
|
+
* "search", "profile", "ingest"). None for plays or legacy runs without this
|
|
112
|
+
* field. created_at: When the run was created
|
|
113
|
+
*/
|
|
114
|
+
interface Run {
|
|
115
|
+
/**
|
|
116
|
+
* Run ID
|
|
117
|
+
*/
|
|
118
|
+
id: string;
|
|
119
|
+
/**
|
|
120
|
+
* Execution context (task, play)
|
|
121
|
+
*/
|
|
122
|
+
agent_type: string;
|
|
123
|
+
/**
|
|
124
|
+
* Creation timestamp
|
|
125
|
+
*/
|
|
126
|
+
created_at?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Workflow type for task-based runs (signal, search, profile, ingest)
|
|
129
|
+
*/
|
|
130
|
+
task_type?: string | null;
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
export interface IcpCreateParams {
|
|
134
|
+
description: string;
|
|
135
|
+
entity_targets: Array<EntityTargetConfig>;
|
|
136
|
+
name: string;
|
|
137
|
+
}
|
|
138
|
+
export interface IcpUpdateParams {
|
|
139
|
+
description?: string | null;
|
|
140
|
+
entity_targets?: Array<EntityTargetConfig> | null;
|
|
141
|
+
name?: string | null;
|
|
142
|
+
}
|
|
143
|
+
export interface IcpListParams {
|
|
144
|
+
/**
|
|
145
|
+
* Filter by ICP mode: 'discovery' or 'monitoring'
|
|
146
|
+
*/
|
|
147
|
+
mode?: 'discovery' | 'monitoring' | null;
|
|
148
|
+
/**
|
|
149
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
150
|
+
*/
|
|
151
|
+
order?: number | null;
|
|
152
|
+
page?: number;
|
|
153
|
+
page_size?: number;
|
|
154
|
+
/**
|
|
155
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'name')
|
|
156
|
+
*/
|
|
157
|
+
sort_by?: string | null;
|
|
158
|
+
}
|
|
159
|
+
export declare namespace Icp {
|
|
160
|
+
export { type EntityTargetConfig as EntityTargetConfig, type IcpResponse as IcpResponse, type IcpListResponse as IcpListResponse, type IcpGetActiveRunsResponse as IcpGetActiveRunsResponse, type IcpCreateParams as IcpCreateParams, type IcpUpdateParams as IcpUpdateParams, type IcpListParams as IcpListParams, };
|
|
161
|
+
}
|
|
162
|
+
//# sourceMappingURL=icp.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"icp.d.mts","sourceRoot":"","sources":["../src/resources/icp.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIhF;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI1E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI/F;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAEhD,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,YAAY;QAC3B,WAAW,EAAE,MAAM,CAAC;QAEpB,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;CAC3C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;;;;;;OAUG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE1C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,cAAc,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAElD,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Icp extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new Ideal Customer Profile (ICP).
|
|
7
|
+
*
|
|
8
|
+
* ICPs are the foundation of your research workflows. They define WHAT entities to
|
|
9
|
+
* target using business-level descriptions and filters, without specifying
|
|
10
|
+
* technical implementation details.
|
|
11
|
+
*
|
|
12
|
+
* Create an ICP first, then link Sheets to it for entity storage.
|
|
13
|
+
*/
|
|
14
|
+
create(body: IcpCreateParams, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Get a specific ICP by ID.
|
|
17
|
+
*/
|
|
18
|
+
retrieve(icpID: string, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
19
|
+
/**
|
|
20
|
+
* Update an existing ICP.
|
|
21
|
+
*
|
|
22
|
+
* Only provided fields will be updated; omitted fields remain unchanged.
|
|
23
|
+
*/
|
|
24
|
+
update(icpID: string, body: IcpUpdateParams, options?: RequestOptions): APIPromise<IcpResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* List all ICPs for the organization.
|
|
27
|
+
*
|
|
28
|
+
* Results are scoped to your organization. Use the `mode` filter to separate
|
|
29
|
+
* discovery ICPs (for finding new entities) from monitoring ICPs (for tracking
|
|
30
|
+
* existing entities).
|
|
31
|
+
*/
|
|
32
|
+
list(query?: IcpListParams | null | undefined, options?: RequestOptions): APIPromise<IcpListResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Delete an ICP and all related resources.
|
|
35
|
+
*
|
|
36
|
+
* **Cascade delete**: This permanently removes the ICP along with all associated
|
|
37
|
+
* sheets, entities, schedules, tasks, and signals. This operation cannot be
|
|
38
|
+
* undone.
|
|
39
|
+
*/
|
|
40
|
+
delete(icpID: string, options?: RequestOptions): APIPromise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* Get all active runs for an ICP.
|
|
43
|
+
*
|
|
44
|
+
* Returns runs in non-terminal states (RUNNING, SCHEDULED, PENDING). Useful for
|
|
45
|
+
* checking if workflows are currently processing this ICP before making changes.
|
|
46
|
+
*/
|
|
47
|
+
getActiveRuns(icpID: string, options?: RequestOptions): APIPromise<IcpGetActiveRunsResponse>;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Request model for entity target configuration.
|
|
51
|
+
*/
|
|
52
|
+
export interface EntityTargetConfig {
|
|
53
|
+
/**
|
|
54
|
+
* Business description of targets
|
|
55
|
+
*/
|
|
56
|
+
description: string;
|
|
57
|
+
/**
|
|
58
|
+
* Entity type to target
|
|
59
|
+
*/
|
|
60
|
+
entity_type: string;
|
|
61
|
+
/**
|
|
62
|
+
* Filters to apply
|
|
63
|
+
*/
|
|
64
|
+
filters?: Array<string>;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Response model for ICP.
|
|
68
|
+
*/
|
|
69
|
+
export interface IcpResponse {
|
|
70
|
+
id: string;
|
|
71
|
+
created_at: string;
|
|
72
|
+
description: string;
|
|
73
|
+
entity_targets: Array<IcpResponse.EntityTarget>;
|
|
74
|
+
name: string;
|
|
75
|
+
updated_at: string;
|
|
76
|
+
}
|
|
77
|
+
export declare namespace IcpResponse {
|
|
78
|
+
/**
|
|
79
|
+
* Response model for entity target configuration.
|
|
80
|
+
*/
|
|
81
|
+
interface EntityTarget {
|
|
82
|
+
description: string;
|
|
83
|
+
entity_type: string;
|
|
84
|
+
root: boolean;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Response for listing ICPs.
|
|
89
|
+
*/
|
|
90
|
+
export interface IcpListResponse {
|
|
91
|
+
icps: Array<IcpResponse>;
|
|
92
|
+
page: number;
|
|
93
|
+
page_size: number;
|
|
94
|
+
total: number;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Response model for ICP running status.
|
|
98
|
+
*/
|
|
99
|
+
export interface IcpGetActiveRunsResponse {
|
|
100
|
+
runs: Array<IcpGetActiveRunsResponse.Run>;
|
|
101
|
+
}
|
|
102
|
+
export declare namespace IcpGetActiveRunsResponse {
|
|
103
|
+
/**
|
|
104
|
+
* Individual run status item for API responses.
|
|
105
|
+
*
|
|
106
|
+
* Includes both agent_type (execution context) and task_type (workflow type)
|
|
107
|
+
* fields to support filtering and display during the transition from legacy runs.
|
|
108
|
+
*
|
|
109
|
+
* Attributes: id: Unique run identifier (ObjectId as string) agent_type: HOW the
|
|
110
|
+
* run was triggered ("task", "play") task_type: WHAT workflow runs ("signal",
|
|
111
|
+
* "search", "profile", "ingest"). None for plays or legacy runs without this
|
|
112
|
+
* field. created_at: When the run was created
|
|
113
|
+
*/
|
|
114
|
+
interface Run {
|
|
115
|
+
/**
|
|
116
|
+
* Run ID
|
|
117
|
+
*/
|
|
118
|
+
id: string;
|
|
119
|
+
/**
|
|
120
|
+
* Execution context (task, play)
|
|
121
|
+
*/
|
|
122
|
+
agent_type: string;
|
|
123
|
+
/**
|
|
124
|
+
* Creation timestamp
|
|
125
|
+
*/
|
|
126
|
+
created_at?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Workflow type for task-based runs (signal, search, profile, ingest)
|
|
129
|
+
*/
|
|
130
|
+
task_type?: string | null;
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
export interface IcpCreateParams {
|
|
134
|
+
description: string;
|
|
135
|
+
entity_targets: Array<EntityTargetConfig>;
|
|
136
|
+
name: string;
|
|
137
|
+
}
|
|
138
|
+
export interface IcpUpdateParams {
|
|
139
|
+
description?: string | null;
|
|
140
|
+
entity_targets?: Array<EntityTargetConfig> | null;
|
|
141
|
+
name?: string | null;
|
|
142
|
+
}
|
|
143
|
+
export interface IcpListParams {
|
|
144
|
+
/**
|
|
145
|
+
* Filter by ICP mode: 'discovery' or 'monitoring'
|
|
146
|
+
*/
|
|
147
|
+
mode?: 'discovery' | 'monitoring' | null;
|
|
148
|
+
/**
|
|
149
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
150
|
+
*/
|
|
151
|
+
order?: number | null;
|
|
152
|
+
page?: number;
|
|
153
|
+
page_size?: number;
|
|
154
|
+
/**
|
|
155
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'name')
|
|
156
|
+
*/
|
|
157
|
+
sort_by?: string | null;
|
|
158
|
+
}
|
|
159
|
+
export declare namespace Icp {
|
|
160
|
+
export { type EntityTargetConfig as EntityTargetConfig, type IcpResponse as IcpResponse, type IcpListResponse as IcpListResponse, type IcpGetActiveRunsResponse as IcpGetActiveRunsResponse, type IcpCreateParams as IcpCreateParams, type IcpUpdateParams as IcpUpdateParams, type IcpListParams as IcpListParams, };
|
|
161
|
+
}
|
|
162
|
+
//# sourceMappingURL=icp.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"icp.d.ts","sourceRoot":"","sources":["../src/resources/icp.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIhF;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI1E;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI/F;;;;;;OAMG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOjE;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAG7F;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAEhD,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,YAAY;QAC3B,WAAW,EAAE,MAAM,CAAC;QAEpB,WAAW,EAAE,MAAM,CAAC;QAEpB,IAAI,EAAE,OAAO,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;CAC3C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;;;;;;;OAUG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE1C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,cAAc,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAElD,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
|
package/resources/icp.js
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Icp = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Icp extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Create a new Ideal Customer Profile (ICP).
|
|
11
|
+
*
|
|
12
|
+
* ICPs are the foundation of your research workflows. They define WHAT entities to
|
|
13
|
+
* target using business-level descriptions and filters, without specifying
|
|
14
|
+
* technical implementation details.
|
|
15
|
+
*
|
|
16
|
+
* Create an ICP first, then link Sheets to it for entity storage.
|
|
17
|
+
*/
|
|
18
|
+
create(body, options) {
|
|
19
|
+
return this._client.post('/v1/icp', { body, ...options });
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Get a specific ICP by ID.
|
|
23
|
+
*/
|
|
24
|
+
retrieve(icpID, options) {
|
|
25
|
+
return this._client.get((0, path_1.path) `/v1/icp/${icpID}`, options);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Update an existing ICP.
|
|
29
|
+
*
|
|
30
|
+
* Only provided fields will be updated; omitted fields remain unchanged.
|
|
31
|
+
*/
|
|
32
|
+
update(icpID, body, options) {
|
|
33
|
+
return this._client.put((0, path_1.path) `/v1/icp/${icpID}`, { body, ...options });
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* List all ICPs for the organization.
|
|
37
|
+
*
|
|
38
|
+
* Results are scoped to your organization. Use the `mode` filter to separate
|
|
39
|
+
* discovery ICPs (for finding new entities) from monitoring ICPs (for tracking
|
|
40
|
+
* existing entities).
|
|
41
|
+
*/
|
|
42
|
+
list(query = {}, options) {
|
|
43
|
+
return this._client.get('/v1/icp', { query, ...options });
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Delete an ICP and all related resources.
|
|
47
|
+
*
|
|
48
|
+
* **Cascade delete**: This permanently removes the ICP along with all associated
|
|
49
|
+
* sheets, entities, schedules, tasks, and signals. This operation cannot be
|
|
50
|
+
* undone.
|
|
51
|
+
*/
|
|
52
|
+
delete(icpID, options) {
|
|
53
|
+
return this._client.delete((0, path_1.path) `/v1/icp/${icpID}`, {
|
|
54
|
+
...options,
|
|
55
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Get all active runs for an ICP.
|
|
60
|
+
*
|
|
61
|
+
* Returns runs in non-terminal states (RUNNING, SCHEDULED, PENDING). Useful for
|
|
62
|
+
* checking if workflows are currently processing this ICP before making changes.
|
|
63
|
+
*/
|
|
64
|
+
getActiveRuns(icpID, options) {
|
|
65
|
+
return this._client.get((0, path_1.path) `/v1/icp/${icpID}/active_runs`, options);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
exports.Icp = Icp;
|
|
69
|
+
//# sourceMappingURL=icp.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"icp.js","sourceRoot":"","sources":["../src/resources/icp.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,GAAI,SAAQ,sBAAW;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,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,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,IAAA,WAAI,EAAA,WAAW,KAAK,EAAE,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,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,IAAA,WAAI,EAAA,WAAW,KAAK,cAAc,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAhED,kBAgEC"}
|