@linkt/sdk 0.4.0 → 0.5.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 +15 -0
- package/package.json +1 -1
- package/resources/entity.d.mts +134 -11
- package/resources/entity.d.mts.map +1 -1
- package/resources/entity.d.ts +134 -11
- package/resources/entity.d.ts.map +1 -1
- package/resources/entity.js +17 -6
- package/resources/entity.js.map +1 -1
- package/resources/entity.mjs +17 -6
- package/resources/entity.mjs.map +1 -1
- package/src/resources/entity.ts +150 -11
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.5.0 (2026-01-27)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.4.0...v0.5.0](https://github.com/linkt-ai/linkt-typescript-sdk/compare/v0.4.0...v0.5.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([91b7f5a](https://github.com/linkt-ai/linkt-typescript-sdk/commit/91b7f5a7f0516c4342d242a43e1db652ce22e7cb))
|
|
10
|
+
* **api:** api update ([4a2d7a8](https://github.com/linkt-ai/linkt-typescript-sdk/commit/4a2d7a84dc50ecc94fa1c82cb687534a2ac5e3ae))
|
|
11
|
+
* **api:** api update ([611ec13](https://github.com/linkt-ai/linkt-typescript-sdk/commit/611ec131a59de9fb4c6c8726f13e377ae9ecdecb))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Chores
|
|
15
|
+
|
|
16
|
+
* **ci:** upgrade `actions/github-script` ([69cbcac](https://github.com/linkt-ai/linkt-typescript-sdk/commit/69cbcac05c2d45623c7d34a70dc0d63f2fc33d9a))
|
|
17
|
+
|
|
3
18
|
## 0.4.0 (2026-01-22)
|
|
4
19
|
|
|
5
20
|
Full Changelog: [v0.3.0...v0.4.0](https://github.com/linkt-ai/linkt-typescript-sdk/compare/v0.3.0...v0.4.0)
|
package/package.json
CHANGED
package/resources/entity.d.mts
CHANGED
|
@@ -6,17 +6,22 @@ export declare class Entity extends APIResource {
|
|
|
6
6
|
/**
|
|
7
7
|
* Get a single entity by ID with enrichment.
|
|
8
8
|
*
|
|
9
|
-
* Returns the entity with sheet_name, entity_type,
|
|
10
|
-
*
|
|
9
|
+
* Returns the entity with sheet_name, entity_type, icp_id, and duplicate_info
|
|
10
|
+
* populated. duplicate_info is null if the entity has no duplicates across ICPs.
|
|
11
11
|
*/
|
|
12
12
|
retrieve(entityID: string, options?: RequestOptions): APIPromise<EntityResponse>;
|
|
13
13
|
/**
|
|
14
|
-
* Update entity status or comments.
|
|
14
|
+
* Update entity status or comments with optional propagation.
|
|
15
15
|
*
|
|
16
16
|
* Only status and comments can be updated via this endpoint. Use status=null to
|
|
17
17
|
* clear status, comments=null to clear comments.
|
|
18
18
|
*
|
|
19
19
|
* Status must be one of: new, reviewed, passed, contacted, or null.
|
|
20
|
+
*
|
|
21
|
+
* Propagation flags control cascading updates:
|
|
22
|
+
*
|
|
23
|
+
* - propagate_to_family: Update parent/child entities (default: True)
|
|
24
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
20
25
|
*/
|
|
21
26
|
update(entityID: string, body: EntityUpdateParams, options?: RequestOptions): APIPromise<EntityResponse>;
|
|
22
27
|
/**
|
|
@@ -30,6 +35,7 @@ export declare class Entity extends APIResource {
|
|
|
30
35
|
* - status: Filter by workflow status (supports multiple:
|
|
31
36
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
32
37
|
* null
|
|
38
|
+
* - hide_duplicates: When true, only show primary entities (filter out duplicates)
|
|
33
39
|
*
|
|
34
40
|
* All results include enrichment fields for UI annotations.
|
|
35
41
|
*/
|
|
@@ -41,7 +47,7 @@ export declare class Entity extends APIResource {
|
|
|
41
47
|
*/
|
|
42
48
|
delete(entityID: string, options?: RequestOptions): APIPromise<void>;
|
|
43
49
|
/**
|
|
44
|
-
* Update status for multiple entities at once.
|
|
50
|
+
* Update status for multiple entities at once with optional propagation.
|
|
45
51
|
*
|
|
46
52
|
* Accepts a list of entity IDs and a status value. The status can be:
|
|
47
53
|
*
|
|
@@ -51,10 +57,14 @@ export declare class Entity extends APIResource {
|
|
|
51
57
|
* Returns the count of successfully updated entities and any failed IDs. Entities
|
|
52
58
|
* may fail to update if they have an invalid ID format or don't exist.
|
|
53
59
|
*
|
|
60
|
+
* Propagation flags control cascading updates:
|
|
61
|
+
*
|
|
62
|
+
* - propagate_to_family: Update parent/child of each entity (default: True)
|
|
63
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
64
|
+
*
|
|
54
65
|
* WHY: Bulk operations enable users to update status for many entities at once
|
|
55
66
|
* (e.g., mark all search results as "reviewed"), improving workflow efficiency
|
|
56
|
-
* versus N individual PUT calls.
|
|
57
|
-
* roundtrip efficiency.
|
|
67
|
+
* versus N individual PUT calls.
|
|
58
68
|
*/
|
|
59
69
|
bulkUpdateStatus(body: EntityBulkUpdateStatusParams, options?: RequestOptions): APIPromise<EntityBulkUpdateStatusResponse>;
|
|
60
70
|
/**
|
|
@@ -135,6 +145,7 @@ export declare class Entity extends APIResource {
|
|
|
135
145
|
* - status: Filter by workflow status (supports multiple:
|
|
136
146
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
137
147
|
* null
|
|
148
|
+
* - hide_duplicates: When true, only show primary entities
|
|
138
149
|
*/
|
|
139
150
|
search(query: EntitySearchParams, options?: RequestOptions): APIPromise<EntitySearchResponse>;
|
|
140
151
|
}
|
|
@@ -184,14 +195,96 @@ export interface EntityResponse {
|
|
|
184
195
|
* User comments
|
|
185
196
|
*/
|
|
186
197
|
comments?: string | null;
|
|
198
|
+
/**
|
|
199
|
+
* Duplicate status information for an entity.
|
|
200
|
+
*
|
|
201
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
202
|
+
*
|
|
203
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
204
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
205
|
+
* primary_icp_name
|
|
206
|
+
*
|
|
207
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
208
|
+
* EntityResponse.
|
|
209
|
+
*/
|
|
210
|
+
duplicate_info?: EntityResponse.DuplicateInfo | null;
|
|
187
211
|
/**
|
|
188
212
|
* Parent entity ID (for hierarchical entities)
|
|
189
213
|
*/
|
|
190
214
|
parent_id?: string | null;
|
|
191
215
|
/**
|
|
192
|
-
*
|
|
216
|
+
* Status values for entity workflow tracking.
|
|
217
|
+
*
|
|
218
|
+
* Transitions are user-driven (not automatic state machine):
|
|
219
|
+
*
|
|
220
|
+
* - new: Default for all newly created entities
|
|
221
|
+
* - reviewed: User has examined the entity
|
|
222
|
+
* - passed: Entity has been approved/qualified
|
|
223
|
+
* - contacted: Outreach has been initiated
|
|
193
224
|
*/
|
|
194
|
-
status?:
|
|
225
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
226
|
+
}
|
|
227
|
+
export declare namespace EntityResponse {
|
|
228
|
+
/**
|
|
229
|
+
* Duplicate status information for an entity.
|
|
230
|
+
*
|
|
231
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
232
|
+
*
|
|
233
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
234
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
235
|
+
* primary_icp_name
|
|
236
|
+
*
|
|
237
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
238
|
+
* EntityResponse.
|
|
239
|
+
*/
|
|
240
|
+
interface DuplicateInfo {
|
|
241
|
+
/**
|
|
242
|
+
* Whether this entity is a duplicate (not the primary)
|
|
243
|
+
*/
|
|
244
|
+
is_duplicate: boolean;
|
|
245
|
+
/**
|
|
246
|
+
* Whether this entity is the primary in a duplicate group
|
|
247
|
+
*/
|
|
248
|
+
is_primary: boolean;
|
|
249
|
+
/**
|
|
250
|
+
* Number of duplicate entities (primary only)
|
|
251
|
+
*/
|
|
252
|
+
duplicate_count?: number | null;
|
|
253
|
+
/**
|
|
254
|
+
* IDs of duplicate entities (primary only)
|
|
255
|
+
*/
|
|
256
|
+
duplicate_entity_ids?: Array<string> | null;
|
|
257
|
+
/**
|
|
258
|
+
* ICPs containing duplicates (primary only)
|
|
259
|
+
*/
|
|
260
|
+
duplicate_icps?: Array<DuplicateInfo.DuplicateIcp> | null;
|
|
261
|
+
/**
|
|
262
|
+
* ID of the primary entity (duplicate only)
|
|
263
|
+
*/
|
|
264
|
+
primary_entity_id?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* ICP name of the primary entity (duplicate only)
|
|
267
|
+
*/
|
|
268
|
+
primary_icp_name?: string | null;
|
|
269
|
+
}
|
|
270
|
+
namespace DuplicateInfo {
|
|
271
|
+
/**
|
|
272
|
+
* Info about an ICP containing a duplicate entity.
|
|
273
|
+
*
|
|
274
|
+
* Used in DuplicateInfo to show which ICPs contain duplicate instances of the same
|
|
275
|
+
* entity.
|
|
276
|
+
*/
|
|
277
|
+
interface DuplicateIcp {
|
|
278
|
+
/**
|
|
279
|
+
* ICP ID
|
|
280
|
+
*/
|
|
281
|
+
icp_id: string;
|
|
282
|
+
/**
|
|
283
|
+
* ICP name
|
|
284
|
+
*/
|
|
285
|
+
icp_name: string;
|
|
286
|
+
}
|
|
287
|
+
}
|
|
195
288
|
}
|
|
196
289
|
/**
|
|
197
290
|
* Paginated list response for entities.
|
|
@@ -279,16 +372,34 @@ export interface EntityUpdateParams {
|
|
|
279
372
|
*/
|
|
280
373
|
comments?: string | null;
|
|
281
374
|
/**
|
|
282
|
-
*
|
|
283
|
-
|
|
375
|
+
* Reflect updates to duplicate entities across ICPs (default: True)
|
|
376
|
+
*/
|
|
377
|
+
propagate_to_duplicates?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* Reflect updates to parent/child entities (default: True)
|
|
284
380
|
*/
|
|
285
|
-
|
|
381
|
+
propagate_to_family?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* Status values for entity workflow tracking.
|
|
384
|
+
*
|
|
385
|
+
* Transitions are user-driven (not automatic state machine):
|
|
386
|
+
*
|
|
387
|
+
* - new: Default for all newly created entities
|
|
388
|
+
* - reviewed: User has examined the entity
|
|
389
|
+
* - passed: Entity has been approved/qualified
|
|
390
|
+
* - contacted: Outreach has been initiated
|
|
391
|
+
*/
|
|
392
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
286
393
|
}
|
|
287
394
|
export interface EntityListParams {
|
|
288
395
|
/**
|
|
289
396
|
* Valid entity types for sheets.
|
|
290
397
|
*/
|
|
291
398
|
entity_type?: SheetAPI.EntityType | null;
|
|
399
|
+
/**
|
|
400
|
+
* Hide duplicate entities (show only primaries)
|
|
401
|
+
*/
|
|
402
|
+
hide_duplicates?: boolean;
|
|
292
403
|
/**
|
|
293
404
|
* Filter by ICP ID
|
|
294
405
|
*/
|
|
@@ -319,6 +430,14 @@ export interface EntityBulkUpdateStatusParams {
|
|
|
319
430
|
* New status value: new, reviewed, passed, contacted, or null to clear
|
|
320
431
|
*/
|
|
321
432
|
status: string | null;
|
|
433
|
+
/**
|
|
434
|
+
* Reflect status to duplicate entities across ICPs (default: True)
|
|
435
|
+
*/
|
|
436
|
+
propagate_to_duplicates?: boolean;
|
|
437
|
+
/**
|
|
438
|
+
* Reflect status to parent/child of each entity (default: True)
|
|
439
|
+
*/
|
|
440
|
+
propagate_to_family?: boolean;
|
|
322
441
|
}
|
|
323
442
|
export interface EntityExportParams {
|
|
324
443
|
/**
|
|
@@ -365,6 +484,10 @@ export interface EntitySearchParams {
|
|
|
365
484
|
* Valid entity types for sheets.
|
|
366
485
|
*/
|
|
367
486
|
entity_type?: SheetAPI.EntityType | null;
|
|
487
|
+
/**
|
|
488
|
+
* Hide duplicate entities (show only primaries)
|
|
489
|
+
*/
|
|
490
|
+
hide_duplicates?: boolean;
|
|
368
491
|
/**
|
|
369
492
|
* Filter by ICP ID
|
|
370
493
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.d.mts","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIhF
|
|
1
|
+
{"version":3,"file":"entity.d.mts","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIhF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIxG;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CACd,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIxG;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CAC7D;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,YAAY,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;QAE1D;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;;;;WAKG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/entity.d.ts
CHANGED
|
@@ -6,17 +6,22 @@ export declare class Entity extends APIResource {
|
|
|
6
6
|
/**
|
|
7
7
|
* Get a single entity by ID with enrichment.
|
|
8
8
|
*
|
|
9
|
-
* Returns the entity with sheet_name, entity_type,
|
|
10
|
-
*
|
|
9
|
+
* Returns the entity with sheet_name, entity_type, icp_id, and duplicate_info
|
|
10
|
+
* populated. duplicate_info is null if the entity has no duplicates across ICPs.
|
|
11
11
|
*/
|
|
12
12
|
retrieve(entityID: string, options?: RequestOptions): APIPromise<EntityResponse>;
|
|
13
13
|
/**
|
|
14
|
-
* Update entity status or comments.
|
|
14
|
+
* Update entity status or comments with optional propagation.
|
|
15
15
|
*
|
|
16
16
|
* Only status and comments can be updated via this endpoint. Use status=null to
|
|
17
17
|
* clear status, comments=null to clear comments.
|
|
18
18
|
*
|
|
19
19
|
* Status must be one of: new, reviewed, passed, contacted, or null.
|
|
20
|
+
*
|
|
21
|
+
* Propagation flags control cascading updates:
|
|
22
|
+
*
|
|
23
|
+
* - propagate_to_family: Update parent/child entities (default: True)
|
|
24
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
20
25
|
*/
|
|
21
26
|
update(entityID: string, body: EntityUpdateParams, options?: RequestOptions): APIPromise<EntityResponse>;
|
|
22
27
|
/**
|
|
@@ -30,6 +35,7 @@ export declare class Entity extends APIResource {
|
|
|
30
35
|
* - status: Filter by workflow status (supports multiple:
|
|
31
36
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
32
37
|
* null
|
|
38
|
+
* - hide_duplicates: When true, only show primary entities (filter out duplicates)
|
|
33
39
|
*
|
|
34
40
|
* All results include enrichment fields for UI annotations.
|
|
35
41
|
*/
|
|
@@ -41,7 +47,7 @@ export declare class Entity extends APIResource {
|
|
|
41
47
|
*/
|
|
42
48
|
delete(entityID: string, options?: RequestOptions): APIPromise<void>;
|
|
43
49
|
/**
|
|
44
|
-
* Update status for multiple entities at once.
|
|
50
|
+
* Update status for multiple entities at once with optional propagation.
|
|
45
51
|
*
|
|
46
52
|
* Accepts a list of entity IDs and a status value. The status can be:
|
|
47
53
|
*
|
|
@@ -51,10 +57,14 @@ export declare class Entity extends APIResource {
|
|
|
51
57
|
* Returns the count of successfully updated entities and any failed IDs. Entities
|
|
52
58
|
* may fail to update if they have an invalid ID format or don't exist.
|
|
53
59
|
*
|
|
60
|
+
* Propagation flags control cascading updates:
|
|
61
|
+
*
|
|
62
|
+
* - propagate_to_family: Update parent/child of each entity (default: True)
|
|
63
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
64
|
+
*
|
|
54
65
|
* WHY: Bulk operations enable users to update status for many entities at once
|
|
55
66
|
* (e.g., mark all search results as "reviewed"), improving workflow efficiency
|
|
56
|
-
* versus N individual PUT calls.
|
|
57
|
-
* roundtrip efficiency.
|
|
67
|
+
* versus N individual PUT calls.
|
|
58
68
|
*/
|
|
59
69
|
bulkUpdateStatus(body: EntityBulkUpdateStatusParams, options?: RequestOptions): APIPromise<EntityBulkUpdateStatusResponse>;
|
|
60
70
|
/**
|
|
@@ -135,6 +145,7 @@ export declare class Entity extends APIResource {
|
|
|
135
145
|
* - status: Filter by workflow status (supports multiple:
|
|
136
146
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
137
147
|
* null
|
|
148
|
+
* - hide_duplicates: When true, only show primary entities
|
|
138
149
|
*/
|
|
139
150
|
search(query: EntitySearchParams, options?: RequestOptions): APIPromise<EntitySearchResponse>;
|
|
140
151
|
}
|
|
@@ -184,14 +195,96 @@ export interface EntityResponse {
|
|
|
184
195
|
* User comments
|
|
185
196
|
*/
|
|
186
197
|
comments?: string | null;
|
|
198
|
+
/**
|
|
199
|
+
* Duplicate status information for an entity.
|
|
200
|
+
*
|
|
201
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
202
|
+
*
|
|
203
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
204
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
205
|
+
* primary_icp_name
|
|
206
|
+
*
|
|
207
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
208
|
+
* EntityResponse.
|
|
209
|
+
*/
|
|
210
|
+
duplicate_info?: EntityResponse.DuplicateInfo | null;
|
|
187
211
|
/**
|
|
188
212
|
* Parent entity ID (for hierarchical entities)
|
|
189
213
|
*/
|
|
190
214
|
parent_id?: string | null;
|
|
191
215
|
/**
|
|
192
|
-
*
|
|
216
|
+
* Status values for entity workflow tracking.
|
|
217
|
+
*
|
|
218
|
+
* Transitions are user-driven (not automatic state machine):
|
|
219
|
+
*
|
|
220
|
+
* - new: Default for all newly created entities
|
|
221
|
+
* - reviewed: User has examined the entity
|
|
222
|
+
* - passed: Entity has been approved/qualified
|
|
223
|
+
* - contacted: Outreach has been initiated
|
|
193
224
|
*/
|
|
194
|
-
status?:
|
|
225
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
226
|
+
}
|
|
227
|
+
export declare namespace EntityResponse {
|
|
228
|
+
/**
|
|
229
|
+
* Duplicate status information for an entity.
|
|
230
|
+
*
|
|
231
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
232
|
+
*
|
|
233
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
234
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
235
|
+
* primary_icp_name
|
|
236
|
+
*
|
|
237
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
238
|
+
* EntityResponse.
|
|
239
|
+
*/
|
|
240
|
+
interface DuplicateInfo {
|
|
241
|
+
/**
|
|
242
|
+
* Whether this entity is a duplicate (not the primary)
|
|
243
|
+
*/
|
|
244
|
+
is_duplicate: boolean;
|
|
245
|
+
/**
|
|
246
|
+
* Whether this entity is the primary in a duplicate group
|
|
247
|
+
*/
|
|
248
|
+
is_primary: boolean;
|
|
249
|
+
/**
|
|
250
|
+
* Number of duplicate entities (primary only)
|
|
251
|
+
*/
|
|
252
|
+
duplicate_count?: number | null;
|
|
253
|
+
/**
|
|
254
|
+
* IDs of duplicate entities (primary only)
|
|
255
|
+
*/
|
|
256
|
+
duplicate_entity_ids?: Array<string> | null;
|
|
257
|
+
/**
|
|
258
|
+
* ICPs containing duplicates (primary only)
|
|
259
|
+
*/
|
|
260
|
+
duplicate_icps?: Array<DuplicateInfo.DuplicateIcp> | null;
|
|
261
|
+
/**
|
|
262
|
+
* ID of the primary entity (duplicate only)
|
|
263
|
+
*/
|
|
264
|
+
primary_entity_id?: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* ICP name of the primary entity (duplicate only)
|
|
267
|
+
*/
|
|
268
|
+
primary_icp_name?: string | null;
|
|
269
|
+
}
|
|
270
|
+
namespace DuplicateInfo {
|
|
271
|
+
/**
|
|
272
|
+
* Info about an ICP containing a duplicate entity.
|
|
273
|
+
*
|
|
274
|
+
* Used in DuplicateInfo to show which ICPs contain duplicate instances of the same
|
|
275
|
+
* entity.
|
|
276
|
+
*/
|
|
277
|
+
interface DuplicateIcp {
|
|
278
|
+
/**
|
|
279
|
+
* ICP ID
|
|
280
|
+
*/
|
|
281
|
+
icp_id: string;
|
|
282
|
+
/**
|
|
283
|
+
* ICP name
|
|
284
|
+
*/
|
|
285
|
+
icp_name: string;
|
|
286
|
+
}
|
|
287
|
+
}
|
|
195
288
|
}
|
|
196
289
|
/**
|
|
197
290
|
* Paginated list response for entities.
|
|
@@ -279,16 +372,34 @@ export interface EntityUpdateParams {
|
|
|
279
372
|
*/
|
|
280
373
|
comments?: string | null;
|
|
281
374
|
/**
|
|
282
|
-
*
|
|
283
|
-
|
|
375
|
+
* Reflect updates to duplicate entities across ICPs (default: True)
|
|
376
|
+
*/
|
|
377
|
+
propagate_to_duplicates?: boolean;
|
|
378
|
+
/**
|
|
379
|
+
* Reflect updates to parent/child entities (default: True)
|
|
284
380
|
*/
|
|
285
|
-
|
|
381
|
+
propagate_to_family?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* Status values for entity workflow tracking.
|
|
384
|
+
*
|
|
385
|
+
* Transitions are user-driven (not automatic state machine):
|
|
386
|
+
*
|
|
387
|
+
* - new: Default for all newly created entities
|
|
388
|
+
* - reviewed: User has examined the entity
|
|
389
|
+
* - passed: Entity has been approved/qualified
|
|
390
|
+
* - contacted: Outreach has been initiated
|
|
391
|
+
*/
|
|
392
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
286
393
|
}
|
|
287
394
|
export interface EntityListParams {
|
|
288
395
|
/**
|
|
289
396
|
* Valid entity types for sheets.
|
|
290
397
|
*/
|
|
291
398
|
entity_type?: SheetAPI.EntityType | null;
|
|
399
|
+
/**
|
|
400
|
+
* Hide duplicate entities (show only primaries)
|
|
401
|
+
*/
|
|
402
|
+
hide_duplicates?: boolean;
|
|
292
403
|
/**
|
|
293
404
|
* Filter by ICP ID
|
|
294
405
|
*/
|
|
@@ -319,6 +430,14 @@ export interface EntityBulkUpdateStatusParams {
|
|
|
319
430
|
* New status value: new, reviewed, passed, contacted, or null to clear
|
|
320
431
|
*/
|
|
321
432
|
status: string | null;
|
|
433
|
+
/**
|
|
434
|
+
* Reflect status to duplicate entities across ICPs (default: True)
|
|
435
|
+
*/
|
|
436
|
+
propagate_to_duplicates?: boolean;
|
|
437
|
+
/**
|
|
438
|
+
* Reflect status to parent/child of each entity (default: True)
|
|
439
|
+
*/
|
|
440
|
+
propagate_to_family?: boolean;
|
|
322
441
|
}
|
|
323
442
|
export interface EntityExportParams {
|
|
324
443
|
/**
|
|
@@ -365,6 +484,10 @@ export interface EntitySearchParams {
|
|
|
365
484
|
* Valid entity types for sheets.
|
|
366
485
|
*/
|
|
367
486
|
entity_type?: SheetAPI.EntityType | null;
|
|
487
|
+
/**
|
|
488
|
+
* Hide duplicate entities (show only primaries)
|
|
489
|
+
*/
|
|
490
|
+
hide_duplicates?: boolean;
|
|
368
491
|
/**
|
|
369
492
|
* Filter by ICP ID
|
|
370
493
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIhF
|
|
1
|
+
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIhF;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIxG;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CACd,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAI7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIxG;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG9F;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CAC7D;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,YAAY,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;QAE5C;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;QAE1D;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAClC;IAED,UAAiB,aAAa,CAAC;QAC7B;;;;;WAKG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CAC7D;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
package/resources/entity.js
CHANGED
|
@@ -9,19 +9,24 @@ class Entity extends resource_1.APIResource {
|
|
|
9
9
|
/**
|
|
10
10
|
* Get a single entity by ID with enrichment.
|
|
11
11
|
*
|
|
12
|
-
* Returns the entity with sheet_name, entity_type,
|
|
13
|
-
*
|
|
12
|
+
* Returns the entity with sheet_name, entity_type, icp_id, and duplicate_info
|
|
13
|
+
* populated. duplicate_info is null if the entity has no duplicates across ICPs.
|
|
14
14
|
*/
|
|
15
15
|
retrieve(entityID, options) {
|
|
16
16
|
return this._client.get((0, path_1.path) `/v1/entity/${entityID}`, options);
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* Update entity status or comments.
|
|
19
|
+
* Update entity status or comments with optional propagation.
|
|
20
20
|
*
|
|
21
21
|
* Only status and comments can be updated via this endpoint. Use status=null to
|
|
22
22
|
* clear status, comments=null to clear comments.
|
|
23
23
|
*
|
|
24
24
|
* Status must be one of: new, reviewed, passed, contacted, or null.
|
|
25
|
+
*
|
|
26
|
+
* Propagation flags control cascading updates:
|
|
27
|
+
*
|
|
28
|
+
* - propagate_to_family: Update parent/child entities (default: True)
|
|
29
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
25
30
|
*/
|
|
26
31
|
update(entityID, body, options) {
|
|
27
32
|
return this._client.put((0, path_1.path) `/v1/entity/${entityID}`, { body, ...options });
|
|
@@ -37,6 +42,7 @@ class Entity extends resource_1.APIResource {
|
|
|
37
42
|
* - status: Filter by workflow status (supports multiple:
|
|
38
43
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
39
44
|
* null
|
|
45
|
+
* - hide_duplicates: When true, only show primary entities (filter out duplicates)
|
|
40
46
|
*
|
|
41
47
|
* All results include enrichment fields for UI annotations.
|
|
42
48
|
*/
|
|
@@ -55,7 +61,7 @@ class Entity extends resource_1.APIResource {
|
|
|
55
61
|
});
|
|
56
62
|
}
|
|
57
63
|
/**
|
|
58
|
-
* Update status for multiple entities at once.
|
|
64
|
+
* Update status for multiple entities at once with optional propagation.
|
|
59
65
|
*
|
|
60
66
|
* Accepts a list of entity IDs and a status value. The status can be:
|
|
61
67
|
*
|
|
@@ -65,10 +71,14 @@ class Entity extends resource_1.APIResource {
|
|
|
65
71
|
* Returns the count of successfully updated entities and any failed IDs. Entities
|
|
66
72
|
* may fail to update if they have an invalid ID format or don't exist.
|
|
67
73
|
*
|
|
74
|
+
* Propagation flags control cascading updates:
|
|
75
|
+
*
|
|
76
|
+
* - propagate_to_family: Update parent/child of each entity (default: True)
|
|
77
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
78
|
+
*
|
|
68
79
|
* WHY: Bulk operations enable users to update status for many entities at once
|
|
69
80
|
* (e.g., mark all search results as "reviewed"), improving workflow efficiency
|
|
70
|
-
* versus N individual PUT calls.
|
|
71
|
-
* roundtrip efficiency.
|
|
81
|
+
* versus N individual PUT calls.
|
|
72
82
|
*/
|
|
73
83
|
bulkUpdateStatus(body, options) {
|
|
74
84
|
return this._client.patch('/v1/entity/status/bulk', { body, ...options });
|
|
@@ -155,6 +165,7 @@ class Entity extends resource_1.APIResource {
|
|
|
155
165
|
* - status: Filter by workflow status (supports multiple:
|
|
156
166
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
157
167
|
* null
|
|
168
|
+
* - hide_duplicates: When true, only show primary entities
|
|
158
169
|
*/
|
|
159
170
|
search(query, options) {
|
|
160
171
|
return this._client.get('/v1/entity/search', { query, ...options });
|
package/resources/entity.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,cAAc,QAAQ,EAAE,EAAE;YACvD,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;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CACd,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,QAA+C,EAAE,EAAE,OAAwB;QAChF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,KAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AArLD,wBAqLC"}
|
package/resources/entity.mjs
CHANGED
|
@@ -6,19 +6,24 @@ export class Entity extends APIResource {
|
|
|
6
6
|
/**
|
|
7
7
|
* Get a single entity by ID with enrichment.
|
|
8
8
|
*
|
|
9
|
-
* Returns the entity with sheet_name, entity_type,
|
|
10
|
-
*
|
|
9
|
+
* Returns the entity with sheet_name, entity_type, icp_id, and duplicate_info
|
|
10
|
+
* populated. duplicate_info is null if the entity has no duplicates across ICPs.
|
|
11
11
|
*/
|
|
12
12
|
retrieve(entityID, options) {
|
|
13
13
|
return this._client.get(path `/v1/entity/${entityID}`, options);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* Update entity status or comments.
|
|
16
|
+
* Update entity status or comments with optional propagation.
|
|
17
17
|
*
|
|
18
18
|
* Only status and comments can be updated via this endpoint. Use status=null to
|
|
19
19
|
* clear status, comments=null to clear comments.
|
|
20
20
|
*
|
|
21
21
|
* Status must be one of: new, reviewed, passed, contacted, or null.
|
|
22
|
+
*
|
|
23
|
+
* Propagation flags control cascading updates:
|
|
24
|
+
*
|
|
25
|
+
* - propagate_to_family: Update parent/child entities (default: True)
|
|
26
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
22
27
|
*/
|
|
23
28
|
update(entityID, body, options) {
|
|
24
29
|
return this._client.put(path `/v1/entity/${entityID}`, { body, ...options });
|
|
@@ -34,6 +39,7 @@ export class Entity extends APIResource {
|
|
|
34
39
|
* - status: Filter by workflow status (supports multiple:
|
|
35
40
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
36
41
|
* null
|
|
42
|
+
* - hide_duplicates: When true, only show primary entities (filter out duplicates)
|
|
37
43
|
*
|
|
38
44
|
* All results include enrichment fields for UI annotations.
|
|
39
45
|
*/
|
|
@@ -52,7 +58,7 @@ export class Entity extends APIResource {
|
|
|
52
58
|
});
|
|
53
59
|
}
|
|
54
60
|
/**
|
|
55
|
-
* Update status for multiple entities at once.
|
|
61
|
+
* Update status for multiple entities at once with optional propagation.
|
|
56
62
|
*
|
|
57
63
|
* Accepts a list of entity IDs and a status value. The status can be:
|
|
58
64
|
*
|
|
@@ -62,10 +68,14 @@ export class Entity extends APIResource {
|
|
|
62
68
|
* Returns the count of successfully updated entities and any failed IDs. Entities
|
|
63
69
|
* may fail to update if they have an invalid ID format or don't exist.
|
|
64
70
|
*
|
|
71
|
+
* Propagation flags control cascading updates:
|
|
72
|
+
*
|
|
73
|
+
* - propagate_to_family: Update parent/child of each entity (default: True)
|
|
74
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
75
|
+
*
|
|
65
76
|
* WHY: Bulk operations enable users to update status for many entities at once
|
|
66
77
|
* (e.g., mark all search results as "reviewed"), improving workflow efficiency
|
|
67
|
-
* versus N individual PUT calls.
|
|
68
|
-
* roundtrip efficiency.
|
|
78
|
+
* versus N individual PUT calls.
|
|
69
79
|
*/
|
|
70
80
|
bulkUpdateStatus(body, options) {
|
|
71
81
|
return this._client.patch('/v1/entity/status/bulk', { body, ...options });
|
|
@@ -152,6 +162,7 @@ export class Entity extends APIResource {
|
|
|
152
162
|
* - status: Filter by workflow status (supports multiple:
|
|
153
163
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
154
164
|
* null
|
|
165
|
+
* - hide_duplicates: When true, only show primary entities
|
|
155
166
|
*/
|
|
156
167
|
search(query, options) {
|
|
157
168
|
return this._client.get('/v1/entity/search', { query, ...options });
|
package/resources/entity.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.mjs","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"entity.mjs","sourceRoot":"","sources":["../src/resources/entity.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAgB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,cAAc,QAAQ,EAAE,EAAE;YACvD,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;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CACd,IAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,MAAM,CAAC,QAA+C,EAAE,EAAE,OAAwB;QAChF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,KAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}
|
package/src/resources/entity.ts
CHANGED
|
@@ -11,20 +11,25 @@ export class Entity extends APIResource {
|
|
|
11
11
|
/**
|
|
12
12
|
* Get a single entity by ID with enrichment.
|
|
13
13
|
*
|
|
14
|
-
* Returns the entity with sheet_name, entity_type,
|
|
15
|
-
*
|
|
14
|
+
* Returns the entity with sheet_name, entity_type, icp_id, and duplicate_info
|
|
15
|
+
* populated. duplicate_info is null if the entity has no duplicates across ICPs.
|
|
16
16
|
*/
|
|
17
17
|
retrieve(entityID: string, options?: RequestOptions): APIPromise<EntityResponse> {
|
|
18
18
|
return this._client.get(path`/v1/entity/${entityID}`, options);
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
|
-
* Update entity status or comments.
|
|
22
|
+
* Update entity status or comments with optional propagation.
|
|
23
23
|
*
|
|
24
24
|
* Only status and comments can be updated via this endpoint. Use status=null to
|
|
25
25
|
* clear status, comments=null to clear comments.
|
|
26
26
|
*
|
|
27
27
|
* Status must be one of: new, reviewed, passed, contacted, or null.
|
|
28
|
+
*
|
|
29
|
+
* Propagation flags control cascading updates:
|
|
30
|
+
*
|
|
31
|
+
* - propagate_to_family: Update parent/child entities (default: True)
|
|
32
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
28
33
|
*/
|
|
29
34
|
update(entityID: string, body: EntityUpdateParams, options?: RequestOptions): APIPromise<EntityResponse> {
|
|
30
35
|
return this._client.put(path`/v1/entity/${entityID}`, { body, ...options });
|
|
@@ -41,6 +46,7 @@ export class Entity extends APIResource {
|
|
|
41
46
|
* - status: Filter by workflow status (supports multiple:
|
|
42
47
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
43
48
|
* null
|
|
49
|
+
* - hide_duplicates: When true, only show primary entities (filter out duplicates)
|
|
44
50
|
*
|
|
45
51
|
* All results include enrichment fields for UI annotations.
|
|
46
52
|
*/
|
|
@@ -64,7 +70,7 @@ export class Entity extends APIResource {
|
|
|
64
70
|
}
|
|
65
71
|
|
|
66
72
|
/**
|
|
67
|
-
* Update status for multiple entities at once.
|
|
73
|
+
* Update status for multiple entities at once with optional propagation.
|
|
68
74
|
*
|
|
69
75
|
* Accepts a list of entity IDs and a status value. The status can be:
|
|
70
76
|
*
|
|
@@ -74,10 +80,14 @@ export class Entity extends APIResource {
|
|
|
74
80
|
* Returns the count of successfully updated entities and any failed IDs. Entities
|
|
75
81
|
* may fail to update if they have an invalid ID format or don't exist.
|
|
76
82
|
*
|
|
83
|
+
* Propagation flags control cascading updates:
|
|
84
|
+
*
|
|
85
|
+
* - propagate_to_family: Update parent/child of each entity (default: True)
|
|
86
|
+
* - propagate_to_duplicates: Update duplicate entities across ICPs (default: True)
|
|
87
|
+
*
|
|
77
88
|
* WHY: Bulk operations enable users to update status for many entities at once
|
|
78
89
|
* (e.g., mark all search results as "reviewed"), improving workflow efficiency
|
|
79
|
-
* versus N individual PUT calls.
|
|
80
|
-
* roundtrip efficiency.
|
|
90
|
+
* versus N individual PUT calls.
|
|
81
91
|
*/
|
|
82
92
|
bulkUpdateStatus(
|
|
83
93
|
body: EntityBulkUpdateStatusParams,
|
|
@@ -173,6 +183,7 @@ export class Entity extends APIResource {
|
|
|
173
183
|
* - status: Filter by workflow status (supports multiple:
|
|
174
184
|
* ?status=new&status=reviewed) Valid values: new, reviewed, passed, contacted,
|
|
175
185
|
* null
|
|
186
|
+
* - hide_duplicates: When true, only show primary entities
|
|
176
187
|
*/
|
|
177
188
|
search(query: EntitySearchParams, options?: RequestOptions): APIPromise<EntitySearchResponse> {
|
|
178
189
|
return this._client.get('/v1/entity/search', { query, ...options });
|
|
@@ -232,15 +243,107 @@ export interface EntityResponse {
|
|
|
232
243
|
*/
|
|
233
244
|
comments?: string | null;
|
|
234
245
|
|
|
246
|
+
/**
|
|
247
|
+
* Duplicate status information for an entity.
|
|
248
|
+
*
|
|
249
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
250
|
+
*
|
|
251
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
252
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
253
|
+
* primary_icp_name
|
|
254
|
+
*
|
|
255
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
256
|
+
* EntityResponse.
|
|
257
|
+
*/
|
|
258
|
+
duplicate_info?: EntityResponse.DuplicateInfo | null;
|
|
259
|
+
|
|
235
260
|
/**
|
|
236
261
|
* Parent entity ID (for hierarchical entities)
|
|
237
262
|
*/
|
|
238
263
|
parent_id?: string | null;
|
|
239
264
|
|
|
240
265
|
/**
|
|
241
|
-
*
|
|
266
|
+
* Status values for entity workflow tracking.
|
|
267
|
+
*
|
|
268
|
+
* Transitions are user-driven (not automatic state machine):
|
|
269
|
+
*
|
|
270
|
+
* - new: Default for all newly created entities
|
|
271
|
+
* - reviewed: User has examined the entity
|
|
272
|
+
* - passed: Entity has been approved/qualified
|
|
273
|
+
* - contacted: Outreach has been initiated
|
|
274
|
+
*/
|
|
275
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
export namespace EntityResponse {
|
|
279
|
+
/**
|
|
280
|
+
* Duplicate status information for an entity.
|
|
281
|
+
*
|
|
282
|
+
* Indicates whether an entity is part of a duplicate group and its role:
|
|
283
|
+
*
|
|
284
|
+
* - Primary entities: is_primary=True, has duplicate_entity_ids and duplicate_icps
|
|
285
|
+
* - Duplicate entities: is_duplicate=True, has primary_entity_id and
|
|
286
|
+
* primary_icp_name
|
|
287
|
+
*
|
|
288
|
+
* For entities that have no duplicates, this field will be None/null in the
|
|
289
|
+
* EntityResponse.
|
|
242
290
|
*/
|
|
243
|
-
|
|
291
|
+
export interface DuplicateInfo {
|
|
292
|
+
/**
|
|
293
|
+
* Whether this entity is a duplicate (not the primary)
|
|
294
|
+
*/
|
|
295
|
+
is_duplicate: boolean;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Whether this entity is the primary in a duplicate group
|
|
299
|
+
*/
|
|
300
|
+
is_primary: boolean;
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* Number of duplicate entities (primary only)
|
|
304
|
+
*/
|
|
305
|
+
duplicate_count?: number | null;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* IDs of duplicate entities (primary only)
|
|
309
|
+
*/
|
|
310
|
+
duplicate_entity_ids?: Array<string> | null;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* ICPs containing duplicates (primary only)
|
|
314
|
+
*/
|
|
315
|
+
duplicate_icps?: Array<DuplicateInfo.DuplicateIcp> | null;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* ID of the primary entity (duplicate only)
|
|
319
|
+
*/
|
|
320
|
+
primary_entity_id?: string | null;
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* ICP name of the primary entity (duplicate only)
|
|
324
|
+
*/
|
|
325
|
+
primary_icp_name?: string | null;
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
export namespace DuplicateInfo {
|
|
329
|
+
/**
|
|
330
|
+
* Info about an ICP containing a duplicate entity.
|
|
331
|
+
*
|
|
332
|
+
* Used in DuplicateInfo to show which ICPs contain duplicate instances of the same
|
|
333
|
+
* entity.
|
|
334
|
+
*/
|
|
335
|
+
export interface DuplicateIcp {
|
|
336
|
+
/**
|
|
337
|
+
* ICP ID
|
|
338
|
+
*/
|
|
339
|
+
icp_id: string;
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* ICP name
|
|
343
|
+
*/
|
|
344
|
+
icp_name: string;
|
|
345
|
+
}
|
|
346
|
+
}
|
|
244
347
|
}
|
|
245
348
|
|
|
246
349
|
/**
|
|
@@ -342,10 +445,26 @@ export interface EntityUpdateParams {
|
|
|
342
445
|
comments?: string | null;
|
|
343
446
|
|
|
344
447
|
/**
|
|
345
|
-
*
|
|
346
|
-
|
|
448
|
+
* Reflect updates to duplicate entities across ICPs (default: True)
|
|
449
|
+
*/
|
|
450
|
+
propagate_to_duplicates?: boolean;
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* Reflect updates to parent/child entities (default: True)
|
|
454
|
+
*/
|
|
455
|
+
propagate_to_family?: boolean;
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Status values for entity workflow tracking.
|
|
459
|
+
*
|
|
460
|
+
* Transitions are user-driven (not automatic state machine):
|
|
461
|
+
*
|
|
462
|
+
* - new: Default for all newly created entities
|
|
463
|
+
* - reviewed: User has examined the entity
|
|
464
|
+
* - passed: Entity has been approved/qualified
|
|
465
|
+
* - contacted: Outreach has been initiated
|
|
347
466
|
*/
|
|
348
|
-
status?:
|
|
467
|
+
status?: 'new' | 'reviewed' | 'passed' | 'contacted' | null;
|
|
349
468
|
}
|
|
350
469
|
|
|
351
470
|
export interface EntityListParams {
|
|
@@ -354,6 +473,11 @@ export interface EntityListParams {
|
|
|
354
473
|
*/
|
|
355
474
|
entity_type?: SheetAPI.EntityType | null;
|
|
356
475
|
|
|
476
|
+
/**
|
|
477
|
+
* Hide duplicate entities (show only primaries)
|
|
478
|
+
*/
|
|
479
|
+
hide_duplicates?: boolean;
|
|
480
|
+
|
|
357
481
|
/**
|
|
358
482
|
* Filter by ICP ID
|
|
359
483
|
*/
|
|
@@ -390,6 +514,16 @@ export interface EntityBulkUpdateStatusParams {
|
|
|
390
514
|
* New status value: new, reviewed, passed, contacted, or null to clear
|
|
391
515
|
*/
|
|
392
516
|
status: string | null;
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* Reflect status to duplicate entities across ICPs (default: True)
|
|
520
|
+
*/
|
|
521
|
+
propagate_to_duplicates?: boolean;
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* Reflect status to parent/child of each entity (default: True)
|
|
525
|
+
*/
|
|
526
|
+
propagate_to_family?: boolean;
|
|
393
527
|
}
|
|
394
528
|
|
|
395
529
|
export interface EntityExportParams {
|
|
@@ -447,6 +581,11 @@ export interface EntitySearchParams {
|
|
|
447
581
|
*/
|
|
448
582
|
entity_type?: SheetAPI.EntityType | null;
|
|
449
583
|
|
|
584
|
+
/**
|
|
585
|
+
* Hide duplicate entities (show only primaries)
|
|
586
|
+
*/
|
|
587
|
+
hide_duplicates?: boolean;
|
|
588
|
+
|
|
450
589
|
/**
|
|
451
590
|
* Filter by ICP ID
|
|
452
591
|
*/
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.5.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.5.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.5.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.
|
|
1
|
+
export const VERSION = '0.5.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|