@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,195 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as EntityAPI from "./entity.mjs";
|
|
3
|
+
import { Entity, EntityRetrieveParams, EntityRetrieveResponse, EntityUpdateCommentsParams, EntityUpdateStatusParams } from "./entity.mjs";
|
|
4
|
+
import * as SchemaAPI from "./schema.mjs";
|
|
5
|
+
import { Schema, SchemaAddFieldsParams, SchemaDeleteFieldsParams, SchemaGetDefaultResponse, SchemaGetFieldDefinitionsResponse, SchemaGetResponse } from "./schema.mjs";
|
|
6
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
7
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
8
|
+
export declare class SheetResource extends APIResource {
|
|
9
|
+
entity: EntityAPI.Entity;
|
|
10
|
+
schema: SchemaAPI.Schema;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new sheet linked to an ICP.
|
|
13
|
+
*
|
|
14
|
+
* Sheets hold entities of a single type (company or person) and must reference an
|
|
15
|
+
* ICP. The entity type must match one of the ICP's configured entity targets.
|
|
16
|
+
*/
|
|
17
|
+
create(body: SheetCreateParams, options?: RequestOptions): APIPromise<Sheet>;
|
|
18
|
+
/**
|
|
19
|
+
* Get a specific sheet by ID.
|
|
20
|
+
*/
|
|
21
|
+
retrieve(sheetID: string, options?: RequestOptions): APIPromise<Sheet>;
|
|
22
|
+
/**
|
|
23
|
+
* Update an existing sheet.
|
|
24
|
+
*
|
|
25
|
+
* Only provided fields will be updated; omitted fields remain unchanged. The ICP
|
|
26
|
+
* reference and entity_type cannot be changed after creation.
|
|
27
|
+
*/
|
|
28
|
+
update(sheetID: string, body: SheetUpdateParams, options?: RequestOptions): APIPromise<void>;
|
|
29
|
+
/**
|
|
30
|
+
* List all sheets for the organization.
|
|
31
|
+
*
|
|
32
|
+
* Filter by ICP to see sheets for a specific targeting profile, or by entity type
|
|
33
|
+
* to see all company or person sheets.
|
|
34
|
+
*/
|
|
35
|
+
list(query?: SheetListParams | null | undefined, options?: RequestOptions): APIPromise<SheetListResponse>;
|
|
36
|
+
/**
|
|
37
|
+
* Delete a sheet and all its entities.
|
|
38
|
+
*
|
|
39
|
+
* **Cascade delete**: This permanently removes the sheet and all entities within
|
|
40
|
+
* it. This operation cannot be undone.
|
|
41
|
+
*/
|
|
42
|
+
delete(sheetID: string, options?: RequestOptions): APIPromise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Export sheet entities as a CSV file.
|
|
45
|
+
*
|
|
46
|
+
* Exports entities with proper field formatting based on the sheet's schema. Pass
|
|
47
|
+
* specific entity_ids to export a subset, or omit to export all entities.
|
|
48
|
+
*/
|
|
49
|
+
exportCsv(sheetID: string, query?: SheetExportCsvParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
|
|
50
|
+
/**
|
|
51
|
+
* List all entities in a sheet.
|
|
52
|
+
*
|
|
53
|
+
* Supports text search across name/company fields and comprehensive filtering by
|
|
54
|
+
* status, comments, and date ranges.
|
|
55
|
+
*/
|
|
56
|
+
getEntities(sheetID: string, query?: SheetGetEntitiesParams | null | undefined, options?: RequestOptions): APIPromise<SheetGetEntitiesResponse>;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Valid entity types for sheets.
|
|
60
|
+
*/
|
|
61
|
+
export type EntityType = 'company' | 'person' | 'job_board' | 'school_district' | 'product';
|
|
62
|
+
/**
|
|
63
|
+
* Response model for sheet.
|
|
64
|
+
*/
|
|
65
|
+
export interface Sheet {
|
|
66
|
+
id: string;
|
|
67
|
+
created_at: string;
|
|
68
|
+
description: string;
|
|
69
|
+
entity_schema: {
|
|
70
|
+
[key: string]: unknown;
|
|
71
|
+
};
|
|
72
|
+
icp_id: string;
|
|
73
|
+
name: string;
|
|
74
|
+
updated_at: string;
|
|
75
|
+
entity_type?: string | null;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Response model for sheet list.
|
|
79
|
+
*/
|
|
80
|
+
export interface SheetListResponse {
|
|
81
|
+
page: number;
|
|
82
|
+
page_size: number;
|
|
83
|
+
sheets: Array<{
|
|
84
|
+
[key: string]: unknown;
|
|
85
|
+
}>;
|
|
86
|
+
total: number;
|
|
87
|
+
}
|
|
88
|
+
export type SheetExportCsvResponse = unknown;
|
|
89
|
+
/**
|
|
90
|
+
* Response schema for paginated list of sheet entities.
|
|
91
|
+
*
|
|
92
|
+
* Uses EntityForHTTP which automatically excludes embedding data for efficient API
|
|
93
|
+
* responses.
|
|
94
|
+
*
|
|
95
|
+
* Attributes: entities: List of EntityForHTTP objects for the current page total:
|
|
96
|
+
* Total number of entities matching the filter criteria page: Current page number
|
|
97
|
+
* (1-based) page_size: Number of items per page
|
|
98
|
+
*/
|
|
99
|
+
export interface SheetGetEntitiesResponse {
|
|
100
|
+
entities: Array<{
|
|
101
|
+
[key: string]: unknown;
|
|
102
|
+
}>;
|
|
103
|
+
page: number;
|
|
104
|
+
page_size: number;
|
|
105
|
+
total: number;
|
|
106
|
+
}
|
|
107
|
+
export interface SheetCreateParams {
|
|
108
|
+
description: string;
|
|
109
|
+
/**
|
|
110
|
+
* Type of entities to store
|
|
111
|
+
*/
|
|
112
|
+
entity_type: EntityType;
|
|
113
|
+
/**
|
|
114
|
+
* ICP this sheet belongs to
|
|
115
|
+
*/
|
|
116
|
+
icp_id: string;
|
|
117
|
+
name: string;
|
|
118
|
+
}
|
|
119
|
+
export interface SheetUpdateParams {
|
|
120
|
+
description?: string | null;
|
|
121
|
+
icp_id?: string | null;
|
|
122
|
+
name?: string | null;
|
|
123
|
+
}
|
|
124
|
+
export interface SheetListParams {
|
|
125
|
+
entity_type?: string | null;
|
|
126
|
+
icp_id?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
129
|
+
*/
|
|
130
|
+
order?: number | null;
|
|
131
|
+
page?: number;
|
|
132
|
+
page_size?: number;
|
|
133
|
+
/**
|
|
134
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'name')
|
|
135
|
+
*/
|
|
136
|
+
sort_by?: string | null;
|
|
137
|
+
}
|
|
138
|
+
export interface SheetExportCsvParams {
|
|
139
|
+
/**
|
|
140
|
+
* Optional list of entity IDs to export. If not provided, exports all entities.
|
|
141
|
+
*/
|
|
142
|
+
entity_ids?: Array<string> | null;
|
|
143
|
+
}
|
|
144
|
+
export interface SheetGetEntitiesParams {
|
|
145
|
+
/**
|
|
146
|
+
* Filter entities created after this date (ISO 8601 format: 2024-01-15T10:30:00Z)
|
|
147
|
+
*/
|
|
148
|
+
created_after?: string | null;
|
|
149
|
+
/**
|
|
150
|
+
* Filter entities created before this date (ISO 8601 format)
|
|
151
|
+
*/
|
|
152
|
+
created_before?: string | null;
|
|
153
|
+
/**
|
|
154
|
+
* Filter entities with or without user comments
|
|
155
|
+
*/
|
|
156
|
+
has_comments?: boolean | null;
|
|
157
|
+
/**
|
|
158
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
159
|
+
*/
|
|
160
|
+
order?: number | null;
|
|
161
|
+
/**
|
|
162
|
+
* Page number (1-based)
|
|
163
|
+
*/
|
|
164
|
+
page?: number;
|
|
165
|
+
/**
|
|
166
|
+
* Items per page (max 100, default 50)
|
|
167
|
+
*/
|
|
168
|
+
page_size?: number;
|
|
169
|
+
/**
|
|
170
|
+
* Search entities by name or company
|
|
171
|
+
*/
|
|
172
|
+
search?: string | null;
|
|
173
|
+
/**
|
|
174
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'status')
|
|
175
|
+
*/
|
|
176
|
+
sort_by?: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* Filter by entity status (true=active, false=inactive)
|
|
179
|
+
*/
|
|
180
|
+
status?: boolean | null;
|
|
181
|
+
/**
|
|
182
|
+
* Filter entities updated after this date (ISO 8601 format)
|
|
183
|
+
*/
|
|
184
|
+
updated_after?: string | null;
|
|
185
|
+
/**
|
|
186
|
+
* Filter entities updated before this date (ISO 8601 format)
|
|
187
|
+
*/
|
|
188
|
+
updated_before?: string | null;
|
|
189
|
+
}
|
|
190
|
+
export declare namespace SheetResource {
|
|
191
|
+
export { type EntityType as EntityType, type Sheet as Sheet, type SheetListResponse as SheetListResponse, type SheetExportCsvResponse as SheetExportCsvResponse, type SheetGetEntitiesResponse as SheetGetEntitiesResponse, type SheetCreateParams as SheetCreateParams, type SheetUpdateParams as SheetUpdateParams, type SheetListParams as SheetListParams, type SheetExportCsvParams as SheetExportCsvParams, type SheetGetEntitiesParams as SheetGetEntitiesParams, };
|
|
192
|
+
export { Entity as Entity, type EntityRetrieveResponse as EntityRetrieveResponse, type EntityRetrieveParams as EntityRetrieveParams, type EntityUpdateCommentsParams as EntityUpdateCommentsParams, type EntityUpdateStatusParams as EntityUpdateStatusParams, };
|
|
193
|
+
export { Schema as Schema, type SchemaGetResponse as SchemaGetResponse, type SchemaGetDefaultResponse as SchemaGetDefaultResponse, type SchemaGetFieldDefinitionsResponse as SchemaGetFieldDefinitionsResponse, type SchemaAddFieldsParams as SchemaAddFieldsParams, type SchemaDeleteFieldsParams as SchemaDeleteFieldsParams, };
|
|
194
|
+
}
|
|
195
|
+
//# sourceMappingURL=sheet.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.d.mts","sourceRoot":"","sources":["../../src/resources/sheet/sheet.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,MAAM,EACN,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,KAAK,SAAS;OACd,EACL,MAAM,EACN,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,iCAAiC,EACjC,iBAAiB,EAClB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;OAKG;IACH,SAAS,CACP,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;OAKG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,iBAAiB,GAAG,SAAS,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE1C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE5C,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B;;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAKD,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as EntityAPI from "./entity.js";
|
|
3
|
+
import { Entity, EntityRetrieveParams, EntityRetrieveResponse, EntityUpdateCommentsParams, EntityUpdateStatusParams } from "./entity.js";
|
|
4
|
+
import * as SchemaAPI from "./schema.js";
|
|
5
|
+
import { Schema, SchemaAddFieldsParams, SchemaDeleteFieldsParams, SchemaGetDefaultResponse, SchemaGetFieldDefinitionsResponse, SchemaGetResponse } from "./schema.js";
|
|
6
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
7
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
8
|
+
export declare class SheetResource extends APIResource {
|
|
9
|
+
entity: EntityAPI.Entity;
|
|
10
|
+
schema: SchemaAPI.Schema;
|
|
11
|
+
/**
|
|
12
|
+
* Create a new sheet linked to an ICP.
|
|
13
|
+
*
|
|
14
|
+
* Sheets hold entities of a single type (company or person) and must reference an
|
|
15
|
+
* ICP. The entity type must match one of the ICP's configured entity targets.
|
|
16
|
+
*/
|
|
17
|
+
create(body: SheetCreateParams, options?: RequestOptions): APIPromise<Sheet>;
|
|
18
|
+
/**
|
|
19
|
+
* Get a specific sheet by ID.
|
|
20
|
+
*/
|
|
21
|
+
retrieve(sheetID: string, options?: RequestOptions): APIPromise<Sheet>;
|
|
22
|
+
/**
|
|
23
|
+
* Update an existing sheet.
|
|
24
|
+
*
|
|
25
|
+
* Only provided fields will be updated; omitted fields remain unchanged. The ICP
|
|
26
|
+
* reference and entity_type cannot be changed after creation.
|
|
27
|
+
*/
|
|
28
|
+
update(sheetID: string, body: SheetUpdateParams, options?: RequestOptions): APIPromise<void>;
|
|
29
|
+
/**
|
|
30
|
+
* List all sheets for the organization.
|
|
31
|
+
*
|
|
32
|
+
* Filter by ICP to see sheets for a specific targeting profile, or by entity type
|
|
33
|
+
* to see all company or person sheets.
|
|
34
|
+
*/
|
|
35
|
+
list(query?: SheetListParams | null | undefined, options?: RequestOptions): APIPromise<SheetListResponse>;
|
|
36
|
+
/**
|
|
37
|
+
* Delete a sheet and all its entities.
|
|
38
|
+
*
|
|
39
|
+
* **Cascade delete**: This permanently removes the sheet and all entities within
|
|
40
|
+
* it. This operation cannot be undone.
|
|
41
|
+
*/
|
|
42
|
+
delete(sheetID: string, options?: RequestOptions): APIPromise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Export sheet entities as a CSV file.
|
|
45
|
+
*
|
|
46
|
+
* Exports entities with proper field formatting based on the sheet's schema. Pass
|
|
47
|
+
* specific entity_ids to export a subset, or omit to export all entities.
|
|
48
|
+
*/
|
|
49
|
+
exportCsv(sheetID: string, query?: SheetExportCsvParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
|
|
50
|
+
/**
|
|
51
|
+
* List all entities in a sheet.
|
|
52
|
+
*
|
|
53
|
+
* Supports text search across name/company fields and comprehensive filtering by
|
|
54
|
+
* status, comments, and date ranges.
|
|
55
|
+
*/
|
|
56
|
+
getEntities(sheetID: string, query?: SheetGetEntitiesParams | null | undefined, options?: RequestOptions): APIPromise<SheetGetEntitiesResponse>;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Valid entity types for sheets.
|
|
60
|
+
*/
|
|
61
|
+
export type EntityType = 'company' | 'person' | 'job_board' | 'school_district' | 'product';
|
|
62
|
+
/**
|
|
63
|
+
* Response model for sheet.
|
|
64
|
+
*/
|
|
65
|
+
export interface Sheet {
|
|
66
|
+
id: string;
|
|
67
|
+
created_at: string;
|
|
68
|
+
description: string;
|
|
69
|
+
entity_schema: {
|
|
70
|
+
[key: string]: unknown;
|
|
71
|
+
};
|
|
72
|
+
icp_id: string;
|
|
73
|
+
name: string;
|
|
74
|
+
updated_at: string;
|
|
75
|
+
entity_type?: string | null;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Response model for sheet list.
|
|
79
|
+
*/
|
|
80
|
+
export interface SheetListResponse {
|
|
81
|
+
page: number;
|
|
82
|
+
page_size: number;
|
|
83
|
+
sheets: Array<{
|
|
84
|
+
[key: string]: unknown;
|
|
85
|
+
}>;
|
|
86
|
+
total: number;
|
|
87
|
+
}
|
|
88
|
+
export type SheetExportCsvResponse = unknown;
|
|
89
|
+
/**
|
|
90
|
+
* Response schema for paginated list of sheet entities.
|
|
91
|
+
*
|
|
92
|
+
* Uses EntityForHTTP which automatically excludes embedding data for efficient API
|
|
93
|
+
* responses.
|
|
94
|
+
*
|
|
95
|
+
* Attributes: entities: List of EntityForHTTP objects for the current page total:
|
|
96
|
+
* Total number of entities matching the filter criteria page: Current page number
|
|
97
|
+
* (1-based) page_size: Number of items per page
|
|
98
|
+
*/
|
|
99
|
+
export interface SheetGetEntitiesResponse {
|
|
100
|
+
entities: Array<{
|
|
101
|
+
[key: string]: unknown;
|
|
102
|
+
}>;
|
|
103
|
+
page: number;
|
|
104
|
+
page_size: number;
|
|
105
|
+
total: number;
|
|
106
|
+
}
|
|
107
|
+
export interface SheetCreateParams {
|
|
108
|
+
description: string;
|
|
109
|
+
/**
|
|
110
|
+
* Type of entities to store
|
|
111
|
+
*/
|
|
112
|
+
entity_type: EntityType;
|
|
113
|
+
/**
|
|
114
|
+
* ICP this sheet belongs to
|
|
115
|
+
*/
|
|
116
|
+
icp_id: string;
|
|
117
|
+
name: string;
|
|
118
|
+
}
|
|
119
|
+
export interface SheetUpdateParams {
|
|
120
|
+
description?: string | null;
|
|
121
|
+
icp_id?: string | null;
|
|
122
|
+
name?: string | null;
|
|
123
|
+
}
|
|
124
|
+
export interface SheetListParams {
|
|
125
|
+
entity_type?: string | null;
|
|
126
|
+
icp_id?: string | null;
|
|
127
|
+
/**
|
|
128
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
129
|
+
*/
|
|
130
|
+
order?: number | null;
|
|
131
|
+
page?: number;
|
|
132
|
+
page_size?: number;
|
|
133
|
+
/**
|
|
134
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'name')
|
|
135
|
+
*/
|
|
136
|
+
sort_by?: string | null;
|
|
137
|
+
}
|
|
138
|
+
export interface SheetExportCsvParams {
|
|
139
|
+
/**
|
|
140
|
+
* Optional list of entity IDs to export. If not provided, exports all entities.
|
|
141
|
+
*/
|
|
142
|
+
entity_ids?: Array<string> | null;
|
|
143
|
+
}
|
|
144
|
+
export interface SheetGetEntitiesParams {
|
|
145
|
+
/**
|
|
146
|
+
* Filter entities created after this date (ISO 8601 format: 2024-01-15T10:30:00Z)
|
|
147
|
+
*/
|
|
148
|
+
created_after?: string | null;
|
|
149
|
+
/**
|
|
150
|
+
* Filter entities created before this date (ISO 8601 format)
|
|
151
|
+
*/
|
|
152
|
+
created_before?: string | null;
|
|
153
|
+
/**
|
|
154
|
+
* Filter entities with or without user comments
|
|
155
|
+
*/
|
|
156
|
+
has_comments?: boolean | null;
|
|
157
|
+
/**
|
|
158
|
+
* Sort order: -1 for descending, 1 for ascending
|
|
159
|
+
*/
|
|
160
|
+
order?: number | null;
|
|
161
|
+
/**
|
|
162
|
+
* Page number (1-based)
|
|
163
|
+
*/
|
|
164
|
+
page?: number;
|
|
165
|
+
/**
|
|
166
|
+
* Items per page (max 100, default 50)
|
|
167
|
+
*/
|
|
168
|
+
page_size?: number;
|
|
169
|
+
/**
|
|
170
|
+
* Search entities by name or company
|
|
171
|
+
*/
|
|
172
|
+
search?: string | null;
|
|
173
|
+
/**
|
|
174
|
+
* Field to sort by (e.g., 'created_at', 'updated_at', 'status')
|
|
175
|
+
*/
|
|
176
|
+
sort_by?: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* Filter by entity status (true=active, false=inactive)
|
|
179
|
+
*/
|
|
180
|
+
status?: boolean | null;
|
|
181
|
+
/**
|
|
182
|
+
* Filter entities updated after this date (ISO 8601 format)
|
|
183
|
+
*/
|
|
184
|
+
updated_after?: string | null;
|
|
185
|
+
/**
|
|
186
|
+
* Filter entities updated before this date (ISO 8601 format)
|
|
187
|
+
*/
|
|
188
|
+
updated_before?: string | null;
|
|
189
|
+
}
|
|
190
|
+
export declare namespace SheetResource {
|
|
191
|
+
export { type EntityType as EntityType, type Sheet as Sheet, type SheetListResponse as SheetListResponse, type SheetExportCsvResponse as SheetExportCsvResponse, type SheetGetEntitiesResponse as SheetGetEntitiesResponse, type SheetCreateParams as SheetCreateParams, type SheetUpdateParams as SheetUpdateParams, type SheetListParams as SheetListParams, type SheetExportCsvParams as SheetExportCsvParams, type SheetGetEntitiesParams as SheetGetEntitiesParams, };
|
|
192
|
+
export { Entity as Entity, type EntityRetrieveResponse as EntityRetrieveResponse, type EntityRetrieveParams as EntityRetrieveParams, type EntityUpdateCommentsParams as EntityUpdateCommentsParams, type EntityUpdateStatusParams as EntityUpdateStatusParams, };
|
|
193
|
+
export { Schema as Schema, type SchemaGetResponse as SchemaGetResponse, type SchemaGetDefaultResponse as SchemaGetDefaultResponse, type SchemaGetFieldDefinitionsResponse as SchemaGetFieldDefinitionsResponse, type SchemaAddFieldsParams as SchemaAddFieldsParams, type SchemaDeleteFieldsParams as SchemaDeleteFieldsParams, };
|
|
194
|
+
}
|
|
195
|
+
//# sourceMappingURL=sheet.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.d.ts","sourceRoot":"","sources":["../../src/resources/sheet/sheet.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,MAAM,EACN,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,KAAK,SAAS;OACd,EACL,MAAM,EACN,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EACxB,iCAAiC,EACjC,iBAAiB,EAClB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAItE;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5F;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOnE;;;;;OAKG;IACH,SAAS,CACP,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;;OAKG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAGxC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,iBAAiB,GAAG,SAAS,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE1C,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,MAAM,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE1C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,KAAK,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAC;IAE5C,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9B;;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,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAKD,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -0,0 +1,90 @@
|
|
|
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.SheetResource = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const EntityAPI = tslib_1.__importStar(require("./entity.js"));
|
|
8
|
+
const entity_1 = require("./entity.js");
|
|
9
|
+
const SchemaAPI = tslib_1.__importStar(require("./schema.js"));
|
|
10
|
+
const schema_1 = require("./schema.js");
|
|
11
|
+
const headers_1 = require("../../internal/headers.js");
|
|
12
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
13
|
+
class SheetResource extends resource_1.APIResource {
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
this.entity = new EntityAPI.Entity(this._client);
|
|
17
|
+
this.schema = new SchemaAPI.Schema(this._client);
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Create a new sheet linked to an ICP.
|
|
21
|
+
*
|
|
22
|
+
* Sheets hold entities of a single type (company or person) and must reference an
|
|
23
|
+
* ICP. The entity type must match one of the ICP's configured entity targets.
|
|
24
|
+
*/
|
|
25
|
+
create(body, options) {
|
|
26
|
+
return this._client.post('/v1/sheet', { body, ...options });
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Get a specific sheet by ID.
|
|
30
|
+
*/
|
|
31
|
+
retrieve(sheetID, options) {
|
|
32
|
+
return this._client.get((0, path_1.path) `/v1/sheet/${sheetID}`, options);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Update an existing sheet.
|
|
36
|
+
*
|
|
37
|
+
* Only provided fields will be updated; omitted fields remain unchanged. The ICP
|
|
38
|
+
* reference and entity_type cannot be changed after creation.
|
|
39
|
+
*/
|
|
40
|
+
update(sheetID, body, options) {
|
|
41
|
+
return this._client.put((0, path_1.path) `/v1/sheet/${sheetID}`, {
|
|
42
|
+
body,
|
|
43
|
+
...options,
|
|
44
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* List all sheets for the organization.
|
|
49
|
+
*
|
|
50
|
+
* Filter by ICP to see sheets for a specific targeting profile, or by entity type
|
|
51
|
+
* to see all company or person sheets.
|
|
52
|
+
*/
|
|
53
|
+
list(query = {}, options) {
|
|
54
|
+
return this._client.get('/v1/sheet', { query, ...options });
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Delete a sheet and all its entities.
|
|
58
|
+
*
|
|
59
|
+
* **Cascade delete**: This permanently removes the sheet and all entities within
|
|
60
|
+
* it. This operation cannot be undone.
|
|
61
|
+
*/
|
|
62
|
+
delete(sheetID, options) {
|
|
63
|
+
return this._client.delete((0, path_1.path) `/v1/sheet/${sheetID}`, {
|
|
64
|
+
...options,
|
|
65
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Export sheet entities as a CSV file.
|
|
70
|
+
*
|
|
71
|
+
* Exports entities with proper field formatting based on the sheet's schema. Pass
|
|
72
|
+
* specific entity_ids to export a subset, or omit to export all entities.
|
|
73
|
+
*/
|
|
74
|
+
exportCsv(sheetID, query = {}, options) {
|
|
75
|
+
return this._client.get((0, path_1.path) `/v1/sheet/${sheetID}/export-csv`, { query, ...options });
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* List all entities in a sheet.
|
|
79
|
+
*
|
|
80
|
+
* Supports text search across name/company fields and comprehensive filtering by
|
|
81
|
+
* status, comments, and date ranges.
|
|
82
|
+
*/
|
|
83
|
+
getEntities(sheetID, query = {}, options) {
|
|
84
|
+
return this._client.get((0, path_1.path) `/v1/sheet/${sheetID}/entities`, { query, ...options });
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
exports.SheetResource = SheetResource;
|
|
88
|
+
SheetResource.Entity = entity_1.Entity;
|
|
89
|
+
SheetResource.Schema = schema_1.Schema;
|
|
90
|
+
//# sourceMappingURL=sheet.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.js","sourceRoot":"","sources":["../../src/resources/sheet/sheet.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAMkB;AAClB,+DAAsC;AACtC,wCAOkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,sBAAW;IAA9C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsFhE,CAAC;IApFC;;;;;OAKG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,OAAO,EAAE,EAAE;YAClD,IAAI;YACJ,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,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,OAAO,EAAE,EAAE;YACrD,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,SAAS,CACP,OAAe,EACf,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,OAAO,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IACH,WAAW,CACT,OAAe,EACf,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,OAAO,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAxFD,sCAwFC;AA2KD,aAAa,CAAC,MAAM,GAAG,eAAM,CAAC;AAC9B,aAAa,CAAC,MAAM,GAAG,eAAM,CAAC"}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as EntityAPI from "./entity.mjs";
|
|
4
|
+
import { Entity, } from "./entity.mjs";
|
|
5
|
+
import * as SchemaAPI from "./schema.mjs";
|
|
6
|
+
import { Schema, } from "./schema.mjs";
|
|
7
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
8
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
9
|
+
export class SheetResource extends APIResource {
|
|
10
|
+
constructor() {
|
|
11
|
+
super(...arguments);
|
|
12
|
+
this.entity = new EntityAPI.Entity(this._client);
|
|
13
|
+
this.schema = new SchemaAPI.Schema(this._client);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Create a new sheet linked to an ICP.
|
|
17
|
+
*
|
|
18
|
+
* Sheets hold entities of a single type (company or person) and must reference an
|
|
19
|
+
* ICP. The entity type must match one of the ICP's configured entity targets.
|
|
20
|
+
*/
|
|
21
|
+
create(body, options) {
|
|
22
|
+
return this._client.post('/v1/sheet', { body, ...options });
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Get a specific sheet by ID.
|
|
26
|
+
*/
|
|
27
|
+
retrieve(sheetID, options) {
|
|
28
|
+
return this._client.get(path `/v1/sheet/${sheetID}`, options);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Update an existing sheet.
|
|
32
|
+
*
|
|
33
|
+
* Only provided fields will be updated; omitted fields remain unchanged. The ICP
|
|
34
|
+
* reference and entity_type cannot be changed after creation.
|
|
35
|
+
*/
|
|
36
|
+
update(sheetID, body, options) {
|
|
37
|
+
return this._client.put(path `/v1/sheet/${sheetID}`, {
|
|
38
|
+
body,
|
|
39
|
+
...options,
|
|
40
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* List all sheets for the organization.
|
|
45
|
+
*
|
|
46
|
+
* Filter by ICP to see sheets for a specific targeting profile, or by entity type
|
|
47
|
+
* to see all company or person sheets.
|
|
48
|
+
*/
|
|
49
|
+
list(query = {}, options) {
|
|
50
|
+
return this._client.get('/v1/sheet', { query, ...options });
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* Delete a sheet and all its entities.
|
|
54
|
+
*
|
|
55
|
+
* **Cascade delete**: This permanently removes the sheet and all entities within
|
|
56
|
+
* it. This operation cannot be undone.
|
|
57
|
+
*/
|
|
58
|
+
delete(sheetID, options) {
|
|
59
|
+
return this._client.delete(path `/v1/sheet/${sheetID}`, {
|
|
60
|
+
...options,
|
|
61
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Export sheet entities as a CSV file.
|
|
66
|
+
*
|
|
67
|
+
* Exports entities with proper field formatting based on the sheet's schema. Pass
|
|
68
|
+
* specific entity_ids to export a subset, or omit to export all entities.
|
|
69
|
+
*/
|
|
70
|
+
exportCsv(sheetID, query = {}, options) {
|
|
71
|
+
return this._client.get(path `/v1/sheet/${sheetID}/export-csv`, { query, ...options });
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* List all entities in a sheet.
|
|
75
|
+
*
|
|
76
|
+
* Supports text search across name/company fields and comprehensive filtering by
|
|
77
|
+
* status, comments, and date ranges.
|
|
78
|
+
*/
|
|
79
|
+
getEntities(sheetID, query = {}, options) {
|
|
80
|
+
return this._client.get(path `/v1/sheet/${sheetID}/entities`, { query, ...options });
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
SheetResource.Entity = Entity;
|
|
84
|
+
SheetResource.Schema = Schema;
|
|
85
|
+
//# sourceMappingURL=sheet.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.mjs","sourceRoot":"","sources":["../../src/resources/sheet/sheet.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,MAAM,GAKP;OACM,KAAK,SAAS;OACd,EACL,MAAM,GAMP;OAEM,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAA9C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsFhE,CAAC;IApFC;;;;;OAKG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,OAAO,EAAE,EAAE;YAClD,IAAI;YACJ,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,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,OAAO,EAAE,EAAE;YACrD,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,SAAS,CACP,OAAe,EACf,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,OAAO,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;OAKG;IACH,WAAW,CACT,OAAe,EACf,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,OAAO,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AA2KD,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;AAC9B,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.d.mts","sourceRoot":"","sources":["../src/resources/sheet.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.d.ts","sourceRoot":"","sources":["../src/resources/sheet.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,6 @@
|
|
|
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
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./sheet/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=sheet.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.js","sourceRoot":"","sources":["../src/resources/sheet.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAA8B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sheet.mjs","sourceRoot":"","sources":["../src/resources/sheet.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|