@epilot/entity-client 6.10.1 → 6.11.0-rc.2
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/dist/client.d.ts +0 -0
- package/dist/client.js +0 -0
- package/dist/definition.d.ts +0 -0
- package/dist/definition.js +1 -1
- package/dist/index.d.ts +0 -0
- package/dist/index.js +0 -0
- package/dist/openapi-runtime.json +19 -1
- package/dist/openapi.d.ts +632 -14
- package/dist/openapi.json +275 -6
- package/dist/schema-model.d.ts +0 -0
- package/dist/schema-model.js +0 -0
- package/package.json +16 -15
- package/LICENSE +0 -21
package/dist/openapi.d.ts
CHANGED
|
@@ -93,6 +93,28 @@ declare namespace Components {
|
|
|
93
93
|
ValidateEntityQueryParam?: Parameters.ValidateEntityQueryParam;
|
|
94
94
|
}
|
|
95
95
|
namespace Responses {
|
|
96
|
+
/**
|
|
97
|
+
* A generic error returned by the API
|
|
98
|
+
* example:
|
|
99
|
+
* {
|
|
100
|
+
* "status": 400,
|
|
101
|
+
* "error": "Bad Request"
|
|
102
|
+
* }
|
|
103
|
+
*/
|
|
104
|
+
export interface BadRequestError {
|
|
105
|
+
/**
|
|
106
|
+
* The HTTP status code of the error
|
|
107
|
+
* example:
|
|
108
|
+
* 400
|
|
109
|
+
*/
|
|
110
|
+
status?: number;
|
|
111
|
+
/**
|
|
112
|
+
* The error message
|
|
113
|
+
* example:
|
|
114
|
+
* Bad Request
|
|
115
|
+
*/
|
|
116
|
+
error?: string;
|
|
117
|
+
}
|
|
96
118
|
/**
|
|
97
119
|
* A generic error returned by the API
|
|
98
120
|
* example:
|
|
@@ -140,11 +162,23 @@ declare namespace Components {
|
|
|
140
162
|
}
|
|
141
163
|
namespace Schemas {
|
|
142
164
|
export interface Activity {
|
|
143
|
-
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
165
|
+
type: /**
|
|
166
|
+
* A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.
|
|
167
|
+
*
|
|
168
|
+
* Built-in entity activity types (custom activities can be defined as well):
|
|
169
|
+
* - EntityCreated
|
|
170
|
+
* - EntityUpdated
|
|
171
|
+
* - EntityDeleted
|
|
172
|
+
* - EntitySoftDeleted
|
|
173
|
+
* - EntityRestored
|
|
174
|
+
* - RelationsAdded
|
|
175
|
+
* - RelationsRemoved
|
|
176
|
+
* - RelationsSoftDeleted
|
|
177
|
+
* - RelationsRestored
|
|
178
|
+
* - RelationsDeleted
|
|
179
|
+
*
|
|
146
180
|
*/
|
|
147
|
-
|
|
181
|
+
ActivityType;
|
|
148
182
|
/**
|
|
149
183
|
* Title for activity. Supports handlebars syntax.
|
|
150
184
|
* example:
|
|
@@ -241,11 +275,23 @@ declare namespace Components {
|
|
|
241
275
|
*/
|
|
242
276
|
ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */;
|
|
243
277
|
timestamp?: string; // date-time
|
|
244
|
-
/**
|
|
245
|
-
*
|
|
246
|
-
*
|
|
278
|
+
type: /**
|
|
279
|
+
* A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.
|
|
280
|
+
*
|
|
281
|
+
* Built-in entity activity types (custom activities can be defined as well):
|
|
282
|
+
* - EntityCreated
|
|
283
|
+
* - EntityUpdated
|
|
284
|
+
* - EntityDeleted
|
|
285
|
+
* - EntitySoftDeleted
|
|
286
|
+
* - EntityRestored
|
|
287
|
+
* - RelationsAdded
|
|
288
|
+
* - RelationsRemoved
|
|
289
|
+
* - RelationsSoftDeleted
|
|
290
|
+
* - RelationsRestored
|
|
291
|
+
* - RelationsDeleted
|
|
292
|
+
*
|
|
247
293
|
*/
|
|
248
|
-
|
|
294
|
+
ActivityType;
|
|
249
295
|
/**
|
|
250
296
|
* Title for activity. Supports handlebars syntax.
|
|
251
297
|
* example:
|
|
@@ -285,6 +331,23 @@ declare namespace Components {
|
|
|
285
331
|
operations_total?: number;
|
|
286
332
|
operations?: EntityOperation[];
|
|
287
333
|
}
|
|
334
|
+
/**
|
|
335
|
+
* A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.
|
|
336
|
+
*
|
|
337
|
+
* Built-in entity activity types (custom activities can be defined as well):
|
|
338
|
+
* - EntityCreated
|
|
339
|
+
* - EntityUpdated
|
|
340
|
+
* - EntityDeleted
|
|
341
|
+
* - EntitySoftDeleted
|
|
342
|
+
* - EntityRestored
|
|
343
|
+
* - RelationsAdded
|
|
344
|
+
* - RelationsRemoved
|
|
345
|
+
* - RelationsSoftDeleted
|
|
346
|
+
* - RelationsRestored
|
|
347
|
+
* - RelationsDeleted
|
|
348
|
+
*
|
|
349
|
+
*/
|
|
350
|
+
export type ActivityType = string;
|
|
288
351
|
/**
|
|
289
352
|
* Address attribute
|
|
290
353
|
*/
|
|
@@ -419,6 +482,13 @@ declare namespace Components {
|
|
|
419
482
|
*/
|
|
420
483
|
hint_tooltip_placement?: string;
|
|
421
484
|
};
|
|
485
|
+
/**
|
|
486
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
487
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
488
|
+
* that must always be included in search operations.
|
|
489
|
+
*
|
|
490
|
+
*/
|
|
491
|
+
explicit_searchable?: boolean;
|
|
422
492
|
/**
|
|
423
493
|
* The attribute is a repeatable
|
|
424
494
|
*/
|
|
@@ -584,6 +654,13 @@ declare namespace Components {
|
|
|
584
654
|
*/
|
|
585
655
|
hint_tooltip_placement?: string;
|
|
586
656
|
};
|
|
657
|
+
/**
|
|
658
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
659
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
660
|
+
* that must always be included in search operations.
|
|
661
|
+
*
|
|
662
|
+
*/
|
|
663
|
+
explicit_searchable?: boolean;
|
|
587
664
|
/**
|
|
588
665
|
* The attribute is a repeatable
|
|
589
666
|
*/
|
|
@@ -766,6 +843,13 @@ declare namespace Components {
|
|
|
766
843
|
*/
|
|
767
844
|
hint_tooltip_placement?: string;
|
|
768
845
|
};
|
|
846
|
+
/**
|
|
847
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
848
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
849
|
+
* that must always be included in search operations.
|
|
850
|
+
*
|
|
851
|
+
*/
|
|
852
|
+
explicit_searchable?: boolean;
|
|
769
853
|
/**
|
|
770
854
|
* The attribute is a repeatable
|
|
771
855
|
*/
|
|
@@ -781,11 +865,23 @@ declare namespace Components {
|
|
|
781
865
|
*/
|
|
782
866
|
ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */;
|
|
783
867
|
timestamp?: string; // date-time
|
|
784
|
-
/**
|
|
785
|
-
*
|
|
786
|
-
*
|
|
868
|
+
type: /**
|
|
869
|
+
* A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.
|
|
870
|
+
*
|
|
871
|
+
* Built-in entity activity types (custom activities can be defined as well):
|
|
872
|
+
* - EntityCreated
|
|
873
|
+
* - EntityUpdated
|
|
874
|
+
* - EntityDeleted
|
|
875
|
+
* - EntitySoftDeleted
|
|
876
|
+
* - EntityRestored
|
|
877
|
+
* - RelationsAdded
|
|
878
|
+
* - RelationsRemoved
|
|
879
|
+
* - RelationsSoftDeleted
|
|
880
|
+
* - RelationsRestored
|
|
881
|
+
* - RelationsDeleted
|
|
882
|
+
*
|
|
787
883
|
*/
|
|
788
|
-
|
|
884
|
+
ActivityType;
|
|
789
885
|
/**
|
|
790
886
|
* Title for activity. Supports handlebars syntax.
|
|
791
887
|
* example:
|
|
@@ -949,6 +1045,13 @@ declare namespace Components {
|
|
|
949
1045
|
*/
|
|
950
1046
|
hint_tooltip_placement?: string;
|
|
951
1047
|
};
|
|
1048
|
+
/**
|
|
1049
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1050
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1051
|
+
* that must always be included in search operations.
|
|
1052
|
+
*
|
|
1053
|
+
*/
|
|
1054
|
+
explicit_searchable?: boolean;
|
|
952
1055
|
/**
|
|
953
1056
|
* The attribute is a repeatable
|
|
954
1057
|
*/
|
|
@@ -1171,6 +1274,13 @@ declare namespace Components {
|
|
|
1171
1274
|
*/
|
|
1172
1275
|
hint_tooltip_placement?: string;
|
|
1173
1276
|
};
|
|
1277
|
+
/**
|
|
1278
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1279
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1280
|
+
* that must always be included in search operations.
|
|
1281
|
+
*
|
|
1282
|
+
*/
|
|
1283
|
+
explicit_searchable?: boolean;
|
|
1174
1284
|
/**
|
|
1175
1285
|
* The attribute is a repeatable
|
|
1176
1286
|
*/
|
|
@@ -1355,6 +1465,13 @@ declare namespace Components {
|
|
|
1355
1465
|
*/
|
|
1356
1466
|
hint_tooltip_placement?: string;
|
|
1357
1467
|
};
|
|
1468
|
+
/**
|
|
1469
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1470
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1471
|
+
* that must always be included in search operations.
|
|
1472
|
+
*
|
|
1473
|
+
*/
|
|
1474
|
+
explicit_searchable?: boolean;
|
|
1358
1475
|
/**
|
|
1359
1476
|
* The attribute is a repeatable
|
|
1360
1477
|
*/
|
|
@@ -1505,6 +1622,13 @@ declare namespace Components {
|
|
|
1505
1622
|
*/
|
|
1506
1623
|
hint_tooltip_placement?: string;
|
|
1507
1624
|
};
|
|
1625
|
+
/**
|
|
1626
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1627
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1628
|
+
* that must always be included in search operations.
|
|
1629
|
+
*
|
|
1630
|
+
*/
|
|
1631
|
+
explicit_searchable?: boolean;
|
|
1508
1632
|
/**
|
|
1509
1633
|
* The attribute is a repeatable
|
|
1510
1634
|
*/
|
|
@@ -1648,6 +1772,13 @@ declare namespace Components {
|
|
|
1648
1772
|
*/
|
|
1649
1773
|
hint_tooltip_placement?: string;
|
|
1650
1774
|
};
|
|
1775
|
+
/**
|
|
1776
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1777
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1778
|
+
* that must always be included in search operations.
|
|
1779
|
+
*
|
|
1780
|
+
*/
|
|
1781
|
+
explicit_searchable?: boolean;
|
|
1651
1782
|
/**
|
|
1652
1783
|
* The attribute is a repeatable
|
|
1653
1784
|
*/
|
|
@@ -1789,6 +1920,13 @@ declare namespace Components {
|
|
|
1789
1920
|
*/
|
|
1790
1921
|
hint_tooltip_placement?: string;
|
|
1791
1922
|
};
|
|
1923
|
+
/**
|
|
1924
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
1925
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
1926
|
+
* that must always be included in search operations.
|
|
1927
|
+
*
|
|
1928
|
+
*/
|
|
1929
|
+
explicit_searchable?: boolean;
|
|
1792
1930
|
/**
|
|
1793
1931
|
* The attribute is a repeatable
|
|
1794
1932
|
*/
|
|
@@ -1940,6 +2078,13 @@ declare namespace Components {
|
|
|
1940
2078
|
*/
|
|
1941
2079
|
hint_tooltip_placement?: string;
|
|
1942
2080
|
};
|
|
2081
|
+
/**
|
|
2082
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
2083
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
2084
|
+
* that must always be included in search operations.
|
|
2085
|
+
*
|
|
2086
|
+
*/
|
|
2087
|
+
explicit_searchable?: boolean;
|
|
1943
2088
|
/**
|
|
1944
2089
|
* The attribute is a repeatable
|
|
1945
2090
|
*/
|
|
@@ -2115,6 +2260,13 @@ declare namespace Components {
|
|
|
2115
2260
|
*/
|
|
2116
2261
|
hint_tooltip_placement?: string;
|
|
2117
2262
|
};
|
|
2263
|
+
/**
|
|
2264
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
2265
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
2266
|
+
* that must always be included in search operations.
|
|
2267
|
+
*
|
|
2268
|
+
*/
|
|
2269
|
+
explicit_searchable?: boolean;
|
|
2118
2270
|
/**
|
|
2119
2271
|
* The attribute is a repeatable
|
|
2120
2272
|
*/
|
|
@@ -2828,6 +2980,23 @@ declare namespace Components {
|
|
|
2828
2980
|
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
2829
2981
|
*/
|
|
2830
2982
|
ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */;
|
|
2983
|
+
activity_type?: /**
|
|
2984
|
+
* A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.
|
|
2985
|
+
*
|
|
2986
|
+
* Built-in entity activity types (custom activities can be defined as well):
|
|
2987
|
+
* - EntityCreated
|
|
2988
|
+
* - EntityUpdated
|
|
2989
|
+
* - EntityDeleted
|
|
2990
|
+
* - EntitySoftDeleted
|
|
2991
|
+
* - EntityRestored
|
|
2992
|
+
* - RelationsAdded
|
|
2993
|
+
* - RelationsRemoved
|
|
2994
|
+
* - RelationsSoftDeleted
|
|
2995
|
+
* - RelationsRestored
|
|
2996
|
+
* - RelationsDeleted
|
|
2997
|
+
*
|
|
2998
|
+
*/
|
|
2999
|
+
ActivityType;
|
|
2831
3000
|
operation: "createEntity" | "updateEntity" | "deleteEntity" | "softDeleteEntity" | "restoreEntity" | "relationsAdded" | "relationsRemoved" | "relationsSoftDeleted" | "relationsRestored" | "relationsDeleted";
|
|
2832
3001
|
/**
|
|
2833
3002
|
* example:
|
|
@@ -4310,6 +4479,13 @@ declare namespace Components {
|
|
|
4310
4479
|
*/
|
|
4311
4480
|
hint_tooltip_placement?: string;
|
|
4312
4481
|
};
|
|
4482
|
+
/**
|
|
4483
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
4484
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
4485
|
+
* that must always be included in search operations.
|
|
4486
|
+
*
|
|
4487
|
+
*/
|
|
4488
|
+
explicit_searchable?: boolean;
|
|
4313
4489
|
/**
|
|
4314
4490
|
* The attribute is a repeatable
|
|
4315
4491
|
*/
|
|
@@ -4400,6 +4576,215 @@ declare namespace Components {
|
|
|
4400
4576
|
hits?: number;
|
|
4401
4577
|
relations?: GetRelationsResp;
|
|
4402
4578
|
}
|
|
4579
|
+
export interface GraphDefinition {
|
|
4580
|
+
/**
|
|
4581
|
+
* List of node definitions in the graph
|
|
4582
|
+
* example:
|
|
4583
|
+
* [
|
|
4584
|
+
* {
|
|
4585
|
+
* "id": "portal_user",
|
|
4586
|
+
* "schema": "portal_user",
|
|
4587
|
+
* "cardinality": "one"
|
|
4588
|
+
* },
|
|
4589
|
+
* {
|
|
4590
|
+
* "id": "contact",
|
|
4591
|
+
* "schema": "contact",
|
|
4592
|
+
* "cardinality": "one"
|
|
4593
|
+
* },
|
|
4594
|
+
* {
|
|
4595
|
+
* "id": "billing_accounts",
|
|
4596
|
+
* "schema": "account",
|
|
4597
|
+
* "cardinality": "many"
|
|
4598
|
+
* }
|
|
4599
|
+
* ]
|
|
4600
|
+
*/
|
|
4601
|
+
nodes: GraphNode[];
|
|
4602
|
+
/**
|
|
4603
|
+
* List of edge definitions connecting nodes
|
|
4604
|
+
* example:
|
|
4605
|
+
* [
|
|
4606
|
+
* {
|
|
4607
|
+
* "from": "portal_user",
|
|
4608
|
+
* "to": "contact"
|
|
4609
|
+
* },
|
|
4610
|
+
* {
|
|
4611
|
+
* "from": "contact",
|
|
4612
|
+
* "to": "billing_accounts"
|
|
4613
|
+
* }
|
|
4614
|
+
* ]
|
|
4615
|
+
*/
|
|
4616
|
+
edges: GraphEdge[];
|
|
4617
|
+
}
|
|
4618
|
+
export interface GraphEdge {
|
|
4619
|
+
/**
|
|
4620
|
+
* Source node ID
|
|
4621
|
+
* example:
|
|
4622
|
+
* contact
|
|
4623
|
+
*/
|
|
4624
|
+
from: string;
|
|
4625
|
+
/**
|
|
4626
|
+
* Target node ID
|
|
4627
|
+
* example:
|
|
4628
|
+
* billing_account
|
|
4629
|
+
*/
|
|
4630
|
+
to: string;
|
|
4631
|
+
}
|
|
4632
|
+
export interface GraphNode {
|
|
4633
|
+
/**
|
|
4634
|
+
* Unique identifier for this node in the graph definition
|
|
4635
|
+
* example:
|
|
4636
|
+
* contact
|
|
4637
|
+
*/
|
|
4638
|
+
id: string;
|
|
4639
|
+
/**
|
|
4640
|
+
* Entity schema slug for this node
|
|
4641
|
+
* example:
|
|
4642
|
+
* contact
|
|
4643
|
+
*/
|
|
4644
|
+
schema: string;
|
|
4645
|
+
/**
|
|
4646
|
+
* Optional cardinality for this node when used with hydrate=true:
|
|
4647
|
+
* - "one": Node can only contain one entity, return single Entity object in entityNodes
|
|
4648
|
+
* - "many": Node can contain multiple entities, return array of Entity objects in entityNodes
|
|
4649
|
+
* If not specified, defaults to "many" (returns array). The seed node always returns a single entity regardless of this setting.
|
|
4650
|
+
*
|
|
4651
|
+
* example:
|
|
4652
|
+
* one
|
|
4653
|
+
*/
|
|
4654
|
+
cardinality?: "one" | "many";
|
|
4655
|
+
}
|
|
4656
|
+
export interface GraphQueryRequest {
|
|
4657
|
+
seed: GraphSeed;
|
|
4658
|
+
graph: GraphDefinition;
|
|
4659
|
+
/**
|
|
4660
|
+
* If true, return full entity objects in entityNodes instead of just entity IDs in nodes
|
|
4661
|
+
*/
|
|
4662
|
+
hydrate?: boolean;
|
|
4663
|
+
}
|
|
4664
|
+
export interface GraphQueryResponse {
|
|
4665
|
+
/**
|
|
4666
|
+
* Map of node IDs to arrays of entity IDs found for that node (present when hydrate=false)
|
|
4667
|
+
* example:
|
|
4668
|
+
* {
|
|
4669
|
+
* "portal_user": [
|
|
4670
|
+
* "550e8400-e29b-41d4-a716-446655440001"
|
|
4671
|
+
* ],
|
|
4672
|
+
* "contact": [
|
|
4673
|
+
* "550e8400-e29b-41d4-a716-446655440002"
|
|
4674
|
+
* ],
|
|
4675
|
+
* "billing_accounts": [
|
|
4676
|
+
* "550e8400-e29b-41d4-a716-446655440003",
|
|
4677
|
+
* "550e8400-e29b-41d4-a716-446655440004"
|
|
4678
|
+
* ]
|
|
4679
|
+
* }
|
|
4680
|
+
*/
|
|
4681
|
+
nodes?: {
|
|
4682
|
+
[name: string]: EntityId /* uuid */[];
|
|
4683
|
+
};
|
|
4684
|
+
/**
|
|
4685
|
+
* Map of node IDs to entity objects or arrays of entity objects (present when hydrate=true).
|
|
4686
|
+
* The seed node always returns a single Entity object.
|
|
4687
|
+
* Other nodes return a single Entity object if they contain exactly one entity, or an array of Entity objects if they contain multiple entities.
|
|
4688
|
+
*
|
|
4689
|
+
*/
|
|
4690
|
+
entityNodes?: {
|
|
4691
|
+
[name: string]: /**
|
|
4692
|
+
* example:
|
|
4693
|
+
* {
|
|
4694
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
4695
|
+
* "_org": "123",
|
|
4696
|
+
* "_owners": [
|
|
4697
|
+
* {
|
|
4698
|
+
* "org_id": "123",
|
|
4699
|
+
* "user_id": "123"
|
|
4700
|
+
* }
|
|
4701
|
+
* ],
|
|
4702
|
+
* "_schema": "contact",
|
|
4703
|
+
* "_tags": [
|
|
4704
|
+
* "example",
|
|
4705
|
+
* "mock"
|
|
4706
|
+
* ],
|
|
4707
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
4708
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
4709
|
+
* "_acl": {
|
|
4710
|
+
* "view": [
|
|
4711
|
+
* "org:456",
|
|
4712
|
+
* "org:789"
|
|
4713
|
+
* ],
|
|
4714
|
+
* "edit": [
|
|
4715
|
+
* "org:456"
|
|
4716
|
+
* ],
|
|
4717
|
+
* "delete": [
|
|
4718
|
+
* "org:456"
|
|
4719
|
+
* ]
|
|
4720
|
+
* },
|
|
4721
|
+
* "_manifest": [
|
|
4722
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4723
|
+
* ]
|
|
4724
|
+
* }
|
|
4725
|
+
*/
|
|
4726
|
+
Entity | /**
|
|
4727
|
+
* example:
|
|
4728
|
+
* {
|
|
4729
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
4730
|
+
* "_org": "123",
|
|
4731
|
+
* "_owners": [
|
|
4732
|
+
* {
|
|
4733
|
+
* "org_id": "123",
|
|
4734
|
+
* "user_id": "123"
|
|
4735
|
+
* }
|
|
4736
|
+
* ],
|
|
4737
|
+
* "_schema": "contact",
|
|
4738
|
+
* "_tags": [
|
|
4739
|
+
* "example",
|
|
4740
|
+
* "mock"
|
|
4741
|
+
* ],
|
|
4742
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
4743
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
4744
|
+
* "_acl": {
|
|
4745
|
+
* "view": [
|
|
4746
|
+
* "org:456",
|
|
4747
|
+
* "org:789"
|
|
4748
|
+
* ],
|
|
4749
|
+
* "edit": [
|
|
4750
|
+
* "org:456"
|
|
4751
|
+
* ],
|
|
4752
|
+
* "delete": [
|
|
4753
|
+
* "org:456"
|
|
4754
|
+
* ]
|
|
4755
|
+
* },
|
|
4756
|
+
* "_manifest": [
|
|
4757
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4758
|
+
* ]
|
|
4759
|
+
* }
|
|
4760
|
+
*/
|
|
4761
|
+
Entity[];
|
|
4762
|
+
};
|
|
4763
|
+
/**
|
|
4764
|
+
* List of edges as defined in the request
|
|
4765
|
+
* example:
|
|
4766
|
+
* [
|
|
4767
|
+
* {
|
|
4768
|
+
* "from": "portal_user",
|
|
4769
|
+
* "to": "contact"
|
|
4770
|
+
* },
|
|
4771
|
+
* {
|
|
4772
|
+
* "from": "contact",
|
|
4773
|
+
* "to": "billing_accounts"
|
|
4774
|
+
* }
|
|
4775
|
+
* ]
|
|
4776
|
+
*/
|
|
4777
|
+
edges: GraphEdge[];
|
|
4778
|
+
}
|
|
4779
|
+
export interface GraphSeed {
|
|
4780
|
+
entity_id: EntityId /* uuid */;
|
|
4781
|
+
/**
|
|
4782
|
+
* The node ID in the graph definition that corresponds to the seed entity
|
|
4783
|
+
* example:
|
|
4784
|
+
* contact
|
|
4785
|
+
*/
|
|
4786
|
+
node_id: string;
|
|
4787
|
+
}
|
|
4403
4788
|
export interface GroupHeadline {
|
|
4404
4789
|
id?: string; // uuid
|
|
4405
4790
|
name: string;
|
|
@@ -4804,6 +5189,13 @@ declare namespace Components {
|
|
|
4804
5189
|
*/
|
|
4805
5190
|
hint_tooltip_placement?: string;
|
|
4806
5191
|
};
|
|
5192
|
+
/**
|
|
5193
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5194
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5195
|
+
* that must always be included in search operations.
|
|
5196
|
+
*
|
|
5197
|
+
*/
|
|
5198
|
+
explicit_searchable?: boolean;
|
|
4807
5199
|
/**
|
|
4808
5200
|
* The attribute is a repeatable
|
|
4809
5201
|
*/
|
|
@@ -4945,6 +5337,13 @@ declare namespace Components {
|
|
|
4945
5337
|
*/
|
|
4946
5338
|
hint_tooltip_placement?: string;
|
|
4947
5339
|
};
|
|
5340
|
+
/**
|
|
5341
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5342
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5343
|
+
* that must always be included in search operations.
|
|
5344
|
+
*
|
|
5345
|
+
*/
|
|
5346
|
+
explicit_searchable?: boolean;
|
|
4948
5347
|
/**
|
|
4949
5348
|
* The attribute is a repeatable
|
|
4950
5349
|
*/
|
|
@@ -5086,6 +5485,13 @@ declare namespace Components {
|
|
|
5086
5485
|
*/
|
|
5087
5486
|
hint_tooltip_placement?: string;
|
|
5088
5487
|
};
|
|
5488
|
+
/**
|
|
5489
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5490
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5491
|
+
* that must always be included in search operations.
|
|
5492
|
+
*
|
|
5493
|
+
*/
|
|
5494
|
+
explicit_searchable?: boolean;
|
|
5089
5495
|
/**
|
|
5090
5496
|
* The attribute is a repeatable
|
|
5091
5497
|
*/
|
|
@@ -5235,6 +5641,13 @@ declare namespace Components {
|
|
|
5235
5641
|
*/
|
|
5236
5642
|
hint_tooltip_placement?: string;
|
|
5237
5643
|
};
|
|
5644
|
+
/**
|
|
5645
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5646
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5647
|
+
* that must always be included in search operations.
|
|
5648
|
+
*
|
|
5649
|
+
*/
|
|
5650
|
+
explicit_searchable?: boolean;
|
|
5238
5651
|
/**
|
|
5239
5652
|
* The attribute is a repeatable
|
|
5240
5653
|
*/
|
|
@@ -5384,6 +5797,13 @@ declare namespace Components {
|
|
|
5384
5797
|
*/
|
|
5385
5798
|
hint_tooltip_placement?: string;
|
|
5386
5799
|
};
|
|
5800
|
+
/**
|
|
5801
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5802
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5803
|
+
* that must always be included in search operations.
|
|
5804
|
+
*
|
|
5805
|
+
*/
|
|
5806
|
+
explicit_searchable?: boolean;
|
|
5387
5807
|
/**
|
|
5388
5808
|
* The attribute is a repeatable
|
|
5389
5809
|
*/
|
|
@@ -5528,6 +5948,13 @@ declare namespace Components {
|
|
|
5528
5948
|
*/
|
|
5529
5949
|
hint_tooltip_placement?: string;
|
|
5530
5950
|
};
|
|
5951
|
+
/**
|
|
5952
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5953
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5954
|
+
* that must always be included in search operations.
|
|
5955
|
+
*
|
|
5956
|
+
*/
|
|
5957
|
+
explicit_searchable?: boolean;
|
|
5531
5958
|
/**
|
|
5532
5959
|
* The attribute is a repeatable
|
|
5533
5960
|
*/
|
|
@@ -5685,6 +6112,13 @@ declare namespace Components {
|
|
|
5685
6112
|
*/
|
|
5686
6113
|
hint_tooltip_placement?: string;
|
|
5687
6114
|
};
|
|
6115
|
+
/**
|
|
6116
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6117
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6118
|
+
* that must always be included in search operations.
|
|
6119
|
+
*
|
|
6120
|
+
*/
|
|
6121
|
+
explicit_searchable?: boolean;
|
|
5688
6122
|
/**
|
|
5689
6123
|
* The attribute is a repeatable
|
|
5690
6124
|
*/
|
|
@@ -5831,6 +6265,13 @@ declare namespace Components {
|
|
|
5831
6265
|
*/
|
|
5832
6266
|
hint_tooltip_placement?: string;
|
|
5833
6267
|
};
|
|
6268
|
+
/**
|
|
6269
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6270
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6271
|
+
* that must always be included in search operations.
|
|
6272
|
+
*
|
|
6273
|
+
*/
|
|
6274
|
+
explicit_searchable?: boolean;
|
|
5834
6275
|
/**
|
|
5835
6276
|
* The attribute is a repeatable
|
|
5836
6277
|
*/
|
|
@@ -5972,6 +6413,13 @@ declare namespace Components {
|
|
|
5972
6413
|
*/
|
|
5973
6414
|
hint_tooltip_placement?: string;
|
|
5974
6415
|
};
|
|
6416
|
+
/**
|
|
6417
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6418
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6419
|
+
* that must always be included in search operations.
|
|
6420
|
+
*
|
|
6421
|
+
*/
|
|
6422
|
+
explicit_searchable?: boolean;
|
|
5975
6423
|
/**
|
|
5976
6424
|
* The attribute is a repeatable
|
|
5977
6425
|
*/
|
|
@@ -6113,6 +6561,13 @@ declare namespace Components {
|
|
|
6113
6561
|
*/
|
|
6114
6562
|
hint_tooltip_placement?: string;
|
|
6115
6563
|
};
|
|
6564
|
+
/**
|
|
6565
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6566
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6567
|
+
* that must always be included in search operations.
|
|
6568
|
+
*
|
|
6569
|
+
*/
|
|
6570
|
+
explicit_searchable?: boolean;
|
|
6116
6571
|
/**
|
|
6117
6572
|
* The attribute is a repeatable
|
|
6118
6573
|
*/
|
|
@@ -6254,6 +6709,13 @@ declare namespace Components {
|
|
|
6254
6709
|
*/
|
|
6255
6710
|
hint_tooltip_placement?: string;
|
|
6256
6711
|
};
|
|
6712
|
+
/**
|
|
6713
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6714
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6715
|
+
* that must always be included in search operations.
|
|
6716
|
+
*
|
|
6717
|
+
*/
|
|
6718
|
+
explicit_searchable?: boolean;
|
|
6257
6719
|
/**
|
|
6258
6720
|
* The attribute is a repeatable
|
|
6259
6721
|
*/
|
|
@@ -6395,6 +6857,13 @@ declare namespace Components {
|
|
|
6395
6857
|
*/
|
|
6396
6858
|
hint_tooltip_placement?: string;
|
|
6397
6859
|
};
|
|
6860
|
+
/**
|
|
6861
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6862
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6863
|
+
* that must always be included in search operations.
|
|
6864
|
+
*
|
|
6865
|
+
*/
|
|
6866
|
+
explicit_searchable?: boolean;
|
|
6398
6867
|
/**
|
|
6399
6868
|
* The attribute is a repeatable
|
|
6400
6869
|
*/
|
|
@@ -6536,6 +7005,13 @@ declare namespace Components {
|
|
|
6536
7005
|
*/
|
|
6537
7006
|
hint_tooltip_placement?: string;
|
|
6538
7007
|
};
|
|
7008
|
+
/**
|
|
7009
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7010
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7011
|
+
* that must always be included in search operations.
|
|
7012
|
+
*
|
|
7013
|
+
*/
|
|
7014
|
+
explicit_searchable?: boolean;
|
|
6539
7015
|
/**
|
|
6540
7016
|
* The attribute is a repeatable
|
|
6541
7017
|
*/
|
|
@@ -6677,6 +7153,13 @@ declare namespace Components {
|
|
|
6677
7153
|
*/
|
|
6678
7154
|
hint_tooltip_placement?: string;
|
|
6679
7155
|
};
|
|
7156
|
+
/**
|
|
7157
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7158
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7159
|
+
* that must always be included in search operations.
|
|
7160
|
+
*
|
|
7161
|
+
*/
|
|
7162
|
+
explicit_searchable?: boolean;
|
|
6680
7163
|
/**
|
|
6681
7164
|
* The attribute is a repeatable
|
|
6682
7165
|
*/
|
|
@@ -6818,6 +7301,13 @@ declare namespace Components {
|
|
|
6818
7301
|
*/
|
|
6819
7302
|
hint_tooltip_placement?: string;
|
|
6820
7303
|
};
|
|
7304
|
+
/**
|
|
7305
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7306
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7307
|
+
* that must always be included in search operations.
|
|
7308
|
+
*
|
|
7309
|
+
*/
|
|
7310
|
+
explicit_searchable?: boolean;
|
|
6821
7311
|
/**
|
|
6822
7312
|
* The attribute is a repeatable
|
|
6823
7313
|
*/
|
|
@@ -6959,6 +7449,13 @@ declare namespace Components {
|
|
|
6959
7449
|
*/
|
|
6960
7450
|
hint_tooltip_placement?: string;
|
|
6961
7451
|
};
|
|
7452
|
+
/**
|
|
7453
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7454
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7455
|
+
* that must always be included in search operations.
|
|
7456
|
+
*
|
|
7457
|
+
*/
|
|
7458
|
+
explicit_searchable?: boolean;
|
|
6962
7459
|
/**
|
|
6963
7460
|
* The attribute is a repeatable
|
|
6964
7461
|
*/
|
|
@@ -7115,6 +7612,13 @@ declare namespace Components {
|
|
|
7115
7612
|
*/
|
|
7116
7613
|
hint_tooltip_placement?: string;
|
|
7117
7614
|
};
|
|
7615
|
+
/**
|
|
7616
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7617
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7618
|
+
* that must always be included in search operations.
|
|
7619
|
+
*
|
|
7620
|
+
*/
|
|
7621
|
+
explicit_searchable?: boolean;
|
|
7118
7622
|
/**
|
|
7119
7623
|
* Relations are always repeatables
|
|
7120
7624
|
*/
|
|
@@ -7466,6 +7970,13 @@ declare namespace Components {
|
|
|
7466
7970
|
*/
|
|
7467
7971
|
hint_tooltip_placement?: string;
|
|
7468
7972
|
};
|
|
7973
|
+
/**
|
|
7974
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7975
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7976
|
+
* that must always be included in search operations.
|
|
7977
|
+
*
|
|
7978
|
+
*/
|
|
7979
|
+
explicit_searchable?: boolean;
|
|
7469
7980
|
/**
|
|
7470
7981
|
* The attribute is a repeatable
|
|
7471
7982
|
*/
|
|
@@ -8007,6 +8518,13 @@ declare namespace Components {
|
|
|
8007
8518
|
*/
|
|
8008
8519
|
hint_tooltip_placement?: string;
|
|
8009
8520
|
};
|
|
8521
|
+
/**
|
|
8522
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8523
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8524
|
+
* that must always be included in search operations.
|
|
8525
|
+
*
|
|
8526
|
+
*/
|
|
8527
|
+
explicit_searchable?: boolean;
|
|
8010
8528
|
/**
|
|
8011
8529
|
* The attribute is a repeatable
|
|
8012
8530
|
*/
|
|
@@ -8156,6 +8674,13 @@ declare namespace Components {
|
|
|
8156
8674
|
*/
|
|
8157
8675
|
hint_tooltip_placement?: string;
|
|
8158
8676
|
};
|
|
8677
|
+
/**
|
|
8678
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8679
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8680
|
+
* that must always be included in search operations.
|
|
8681
|
+
*
|
|
8682
|
+
*/
|
|
8683
|
+
explicit_searchable?: boolean;
|
|
8159
8684
|
/**
|
|
8160
8685
|
* The attribute is a repeatable
|
|
8161
8686
|
*/
|
|
@@ -8314,6 +8839,13 @@ declare namespace Components {
|
|
|
8314
8839
|
*/
|
|
8315
8840
|
hint_tooltip_placement?: string;
|
|
8316
8841
|
};
|
|
8842
|
+
/**
|
|
8843
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8844
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8845
|
+
* that must always be included in search operations.
|
|
8846
|
+
*
|
|
8847
|
+
*/
|
|
8848
|
+
explicit_searchable?: boolean;
|
|
8317
8849
|
/**
|
|
8318
8850
|
* The attribute is a repeatable
|
|
8319
8851
|
*/
|
|
@@ -8551,6 +9083,13 @@ declare namespace Components {
|
|
|
8551
9083
|
*/
|
|
8552
9084
|
hint_tooltip_placement?: string;
|
|
8553
9085
|
};
|
|
9086
|
+
/**
|
|
9087
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9088
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9089
|
+
* that must always be included in search operations.
|
|
9090
|
+
*
|
|
9091
|
+
*/
|
|
9092
|
+
explicit_searchable?: boolean;
|
|
8554
9093
|
/**
|
|
8555
9094
|
* The attribute is a repeatable
|
|
8556
9095
|
*/
|
|
@@ -8881,6 +9420,13 @@ declare namespace Components {
|
|
|
8881
9420
|
*/
|
|
8882
9421
|
hint_tooltip_placement?: string;
|
|
8883
9422
|
};
|
|
9423
|
+
/**
|
|
9424
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9425
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9426
|
+
* that must always be included in search operations.
|
|
9427
|
+
*
|
|
9428
|
+
*/
|
|
9429
|
+
explicit_searchable?: boolean;
|
|
8884
9430
|
/**
|
|
8885
9431
|
* The attribute is a repeatable
|
|
8886
9432
|
*/
|
|
@@ -9035,6 +9581,13 @@ declare namespace Components {
|
|
|
9035
9581
|
*/
|
|
9036
9582
|
hint_tooltip_placement?: string;
|
|
9037
9583
|
};
|
|
9584
|
+
/**
|
|
9585
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9586
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9587
|
+
* that must always be included in search operations.
|
|
9588
|
+
*
|
|
9589
|
+
*/
|
|
9590
|
+
explicit_searchable?: boolean;
|
|
9038
9591
|
/**
|
|
9039
9592
|
* The attribute is a repeatable
|
|
9040
9593
|
*/
|
|
@@ -11042,7 +11595,7 @@ declare namespace Paths {
|
|
|
11042
11595
|
/**
|
|
11043
11596
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
11044
11597
|
* example:
|
|
11045
|
-
* 2023-01-01T00:00:
|
|
11598
|
+
* 2023-01-01T00:00:00Z
|
|
11046
11599
|
*/
|
|
11047
11600
|
export type CreatedAfter = string; // date-time
|
|
11048
11601
|
/**
|
|
@@ -11068,7 +11621,7 @@ declare namespace Paths {
|
|
|
11068
11621
|
created_after?: /**
|
|
11069
11622
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
11070
11623
|
* example:
|
|
11071
|
-
* 2023-01-01T00:00:
|
|
11624
|
+
* 2023-01-01T00:00:00Z
|
|
11072
11625
|
*/
|
|
11073
11626
|
Parameters.CreatedAfter /* date-time */;
|
|
11074
11627
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -11838,6 +12391,30 @@ declare namespace Paths {
|
|
|
11838
12391
|
}
|
|
11839
12392
|
}
|
|
11840
12393
|
}
|
|
12394
|
+
namespace TraverseEntityGraph {
|
|
12395
|
+
export type RequestBody = Components.Schemas.GraphQueryRequest;
|
|
12396
|
+
namespace Responses {
|
|
12397
|
+
export type $200 = Components.Schemas.GraphQueryResponse;
|
|
12398
|
+
export type $400 = /**
|
|
12399
|
+
* A generic error returned by the API
|
|
12400
|
+
* example:
|
|
12401
|
+
* {
|
|
12402
|
+
* "status": 400,
|
|
12403
|
+
* "error": "Bad Request"
|
|
12404
|
+
* }
|
|
12405
|
+
*/
|
|
12406
|
+
Components.Responses.BadRequestError;
|
|
12407
|
+
export type $404 = /**
|
|
12408
|
+
* A generic error returned by the API
|
|
12409
|
+
* example:
|
|
12410
|
+
* {
|
|
12411
|
+
* "status": 404,
|
|
12412
|
+
* "error": "Not Found"
|
|
12413
|
+
* }
|
|
12414
|
+
*/
|
|
12415
|
+
Components.Responses.NotFoundError;
|
|
12416
|
+
}
|
|
12417
|
+
}
|
|
11841
12418
|
namespace UpdateClassificationsForTaxonomy {
|
|
11842
12419
|
namespace Parameters {
|
|
11843
12420
|
export type TaxonomySlug = string;
|
|
@@ -13056,6 +13633,22 @@ export interface OperationMethods {
|
|
|
13056
13633
|
data?: Paths.ImportEntities.RequestBody,
|
|
13057
13634
|
config?: AxiosRequestConfig
|
|
13058
13635
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
13636
|
+
/**
|
|
13637
|
+
* traverseEntityGraph - Traverse Entity Graph
|
|
13638
|
+
*
|
|
13639
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
13640
|
+
*
|
|
13641
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
13642
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
13643
|
+
*
|
|
13644
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
13645
|
+
*
|
|
13646
|
+
*/
|
|
13647
|
+
'traverseEntityGraph'(
|
|
13648
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13649
|
+
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
13650
|
+
config?: AxiosRequestConfig
|
|
13651
|
+
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
13059
13652
|
/**
|
|
13060
13653
|
* listSavedViews - listSavedViews
|
|
13061
13654
|
*
|
|
@@ -14201,6 +14794,24 @@ export interface PathsDictionary {
|
|
|
14201
14794
|
config?: AxiosRequestConfig
|
|
14202
14795
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
14203
14796
|
}
|
|
14797
|
+
['/v1/entity:graph']: {
|
|
14798
|
+
/**
|
|
14799
|
+
* traverseEntityGraph - Traverse Entity Graph
|
|
14800
|
+
*
|
|
14801
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
14802
|
+
*
|
|
14803
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
14804
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
14805
|
+
*
|
|
14806
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
14807
|
+
*
|
|
14808
|
+
*/
|
|
14809
|
+
'post'(
|
|
14810
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14811
|
+
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
14812
|
+
config?: AxiosRequestConfig
|
|
14813
|
+
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
14814
|
+
}
|
|
14204
14815
|
['/v1/entity/views']: {
|
|
14205
14816
|
/**
|
|
14206
14817
|
* listSavedViews - listSavedViews
|
|
@@ -14700,6 +15311,7 @@ export type Activity = Components.Schemas.Activity;
|
|
|
14700
15311
|
export type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
|
|
14701
15312
|
export type ActivityId = Components.Schemas.ActivityId;
|
|
14702
15313
|
export type ActivityItem = Components.Schemas.ActivityItem;
|
|
15314
|
+
export type ActivityType = Components.Schemas.ActivityType;
|
|
14703
15315
|
export type AddressAttribute = Components.Schemas.AddressAttribute;
|
|
14704
15316
|
export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute;
|
|
14705
15317
|
export type Attribute = Components.Schemas.Attribute;
|
|
@@ -14765,6 +15377,12 @@ export type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEn
|
|
|
14765
15377
|
export type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
|
14766
15378
|
export type GetRelationsResp = Components.Schemas.GetRelationsResp;
|
|
14767
15379
|
export type GetRelationsRespWithPagination = Components.Schemas.GetRelationsRespWithPagination;
|
|
15380
|
+
export type GraphDefinition = Components.Schemas.GraphDefinition;
|
|
15381
|
+
export type GraphEdge = Components.Schemas.GraphEdge;
|
|
15382
|
+
export type GraphNode = Components.Schemas.GraphNode;
|
|
15383
|
+
export type GraphQueryRequest = Components.Schemas.GraphQueryRequest;
|
|
15384
|
+
export type GraphQueryResponse = Components.Schemas.GraphQueryResponse;
|
|
15385
|
+
export type GraphSeed = Components.Schemas.GraphSeed;
|
|
14768
15386
|
export type GroupHeadline = Components.Schemas.GroupHeadline;
|
|
14769
15387
|
export type GroupHeadlineWithCompositeID = Components.Schemas.GroupHeadlineWithCompositeID;
|
|
14770
15388
|
export type HydratedEntity = Components.Schemas.HydratedEntity;
|