@epilot/entity-client 6.10.1 → 6.11.0-rc.1
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 +642 -14
- package/dist/openapi.json +286 -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,225 @@ 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
|
+
* },
|
|
4588
|
+
* {
|
|
4589
|
+
* "id": "contact",
|
|
4590
|
+
* "schema": "contact"
|
|
4591
|
+
* },
|
|
4592
|
+
* {
|
|
4593
|
+
* "id": "billing_account",
|
|
4594
|
+
* "schema": "account"
|
|
4595
|
+
* }
|
|
4596
|
+
* ]
|
|
4597
|
+
*/
|
|
4598
|
+
nodes: GraphNode[];
|
|
4599
|
+
/**
|
|
4600
|
+
* List of edge definitions connecting nodes
|
|
4601
|
+
* example:
|
|
4602
|
+
* [
|
|
4603
|
+
* {
|
|
4604
|
+
* "from": "portal_user",
|
|
4605
|
+
* "to": "contact",
|
|
4606
|
+
* "cardinality": "one"
|
|
4607
|
+
* },
|
|
4608
|
+
* {
|
|
4609
|
+
* "from": "contact",
|
|
4610
|
+
* "to": "billing_account",
|
|
4611
|
+
* "cardinality": "many"
|
|
4612
|
+
* }
|
|
4613
|
+
* ]
|
|
4614
|
+
*/
|
|
4615
|
+
edges: GraphEdge[];
|
|
4616
|
+
}
|
|
4617
|
+
export interface GraphEdge {
|
|
4618
|
+
/**
|
|
4619
|
+
* Source node ID
|
|
4620
|
+
* example:
|
|
4621
|
+
* contact
|
|
4622
|
+
*/
|
|
4623
|
+
from: string;
|
|
4624
|
+
/**
|
|
4625
|
+
* Target node ID
|
|
4626
|
+
* example:
|
|
4627
|
+
* billing_account
|
|
4628
|
+
*/
|
|
4629
|
+
to: string;
|
|
4630
|
+
/**
|
|
4631
|
+
* Cardinality of the relationship:
|
|
4632
|
+
* - "one": Take the first related entity only
|
|
4633
|
+
* - "many": Take all related entities
|
|
4634
|
+
*
|
|
4635
|
+
* example:
|
|
4636
|
+
* one
|
|
4637
|
+
*/
|
|
4638
|
+
cardinality: "one" | "many";
|
|
4639
|
+
}
|
|
4640
|
+
export interface GraphNode {
|
|
4641
|
+
/**
|
|
4642
|
+
* Unique identifier for this node in the graph definition
|
|
4643
|
+
* example:
|
|
4644
|
+
* contact
|
|
4645
|
+
*/
|
|
4646
|
+
id: string;
|
|
4647
|
+
/**
|
|
4648
|
+
* Entity schema slug for this node
|
|
4649
|
+
* example:
|
|
4650
|
+
* contact
|
|
4651
|
+
*/
|
|
4652
|
+
schema: string;
|
|
4653
|
+
/**
|
|
4654
|
+
* Optional cardinality for this node when used with hydrate=true:
|
|
4655
|
+
* - "one": Node can only contain one entity, return single Entity object in entityNodes
|
|
4656
|
+
* - "many": Node can contain multiple entities, return array of Entity objects in entityNodes
|
|
4657
|
+
* If not specified, defaults to "many" (returns array). The seed node always returns a single entity regardless of this setting.
|
|
4658
|
+
*
|
|
4659
|
+
* example:
|
|
4660
|
+
* one
|
|
4661
|
+
*/
|
|
4662
|
+
cardinality?: "one" | "many";
|
|
4663
|
+
}
|
|
4664
|
+
export interface GraphQueryRequest {
|
|
4665
|
+
seed: GraphSeed;
|
|
4666
|
+
graph: GraphDefinition;
|
|
4667
|
+
/**
|
|
4668
|
+
* If true, return full entity objects in entityNodes instead of just entity IDs in nodes
|
|
4669
|
+
*/
|
|
4670
|
+
hydrate?: boolean;
|
|
4671
|
+
}
|
|
4672
|
+
export interface GraphQueryResponse {
|
|
4673
|
+
/**
|
|
4674
|
+
* Map of node IDs to arrays of entity IDs found for that node (present when hydrate=false)
|
|
4675
|
+
* example:
|
|
4676
|
+
* {
|
|
4677
|
+
* "portal_user": [
|
|
4678
|
+
* "550e8400-e29b-41d4-a716-446655440001"
|
|
4679
|
+
* ],
|
|
4680
|
+
* "contact": [
|
|
4681
|
+
* "550e8400-e29b-41d4-a716-446655440002"
|
|
4682
|
+
* ],
|
|
4683
|
+
* "billing_account": [
|
|
4684
|
+
* "550e8400-e29b-41d4-a716-446655440003",
|
|
4685
|
+
* "550e8400-e29b-41d4-a716-446655440004"
|
|
4686
|
+
* ]
|
|
4687
|
+
* }
|
|
4688
|
+
*/
|
|
4689
|
+
nodes?: {
|
|
4690
|
+
[name: string]: EntityId /* uuid */[];
|
|
4691
|
+
};
|
|
4692
|
+
/**
|
|
4693
|
+
* Map of node IDs to entity objects or arrays of entity objects (present when hydrate=true).
|
|
4694
|
+
* The seed node always returns a single Entity object.
|
|
4695
|
+
* Other nodes return a single Entity object if they contain exactly one entity, or an array of Entity objects if they contain multiple entities.
|
|
4696
|
+
*
|
|
4697
|
+
*/
|
|
4698
|
+
entityNodes?: {
|
|
4699
|
+
[name: string]: /**
|
|
4700
|
+
* example:
|
|
4701
|
+
* {
|
|
4702
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
4703
|
+
* "_org": "123",
|
|
4704
|
+
* "_owners": [
|
|
4705
|
+
* {
|
|
4706
|
+
* "org_id": "123",
|
|
4707
|
+
* "user_id": "123"
|
|
4708
|
+
* }
|
|
4709
|
+
* ],
|
|
4710
|
+
* "_schema": "contact",
|
|
4711
|
+
* "_tags": [
|
|
4712
|
+
* "example",
|
|
4713
|
+
* "mock"
|
|
4714
|
+
* ],
|
|
4715
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
4716
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
4717
|
+
* "_acl": {
|
|
4718
|
+
* "view": [
|
|
4719
|
+
* "org:456",
|
|
4720
|
+
* "org:789"
|
|
4721
|
+
* ],
|
|
4722
|
+
* "edit": [
|
|
4723
|
+
* "org:456"
|
|
4724
|
+
* ],
|
|
4725
|
+
* "delete": [
|
|
4726
|
+
* "org:456"
|
|
4727
|
+
* ]
|
|
4728
|
+
* },
|
|
4729
|
+
* "_manifest": [
|
|
4730
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4731
|
+
* ]
|
|
4732
|
+
* }
|
|
4733
|
+
*/
|
|
4734
|
+
Entity | /**
|
|
4735
|
+
* example:
|
|
4736
|
+
* {
|
|
4737
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
4738
|
+
* "_org": "123",
|
|
4739
|
+
* "_owners": [
|
|
4740
|
+
* {
|
|
4741
|
+
* "org_id": "123",
|
|
4742
|
+
* "user_id": "123"
|
|
4743
|
+
* }
|
|
4744
|
+
* ],
|
|
4745
|
+
* "_schema": "contact",
|
|
4746
|
+
* "_tags": [
|
|
4747
|
+
* "example",
|
|
4748
|
+
* "mock"
|
|
4749
|
+
* ],
|
|
4750
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
4751
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
4752
|
+
* "_acl": {
|
|
4753
|
+
* "view": [
|
|
4754
|
+
* "org:456",
|
|
4755
|
+
* "org:789"
|
|
4756
|
+
* ],
|
|
4757
|
+
* "edit": [
|
|
4758
|
+
* "org:456"
|
|
4759
|
+
* ],
|
|
4760
|
+
* "delete": [
|
|
4761
|
+
* "org:456"
|
|
4762
|
+
* ]
|
|
4763
|
+
* },
|
|
4764
|
+
* "_manifest": [
|
|
4765
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4766
|
+
* ]
|
|
4767
|
+
* }
|
|
4768
|
+
*/
|
|
4769
|
+
Entity[];
|
|
4770
|
+
};
|
|
4771
|
+
/**
|
|
4772
|
+
* List of edges as defined in the request
|
|
4773
|
+
* example:
|
|
4774
|
+
* [
|
|
4775
|
+
* {
|
|
4776
|
+
* "from": "portal_user",
|
|
4777
|
+
* "to": "contact",
|
|
4778
|
+
* "cardinality": "one"
|
|
4779
|
+
* },
|
|
4780
|
+
* {
|
|
4781
|
+
* "from": "contact",
|
|
4782
|
+
* "to": "billing_account",
|
|
4783
|
+
* "cardinality": "many"
|
|
4784
|
+
* }
|
|
4785
|
+
* ]
|
|
4786
|
+
*/
|
|
4787
|
+
edges: GraphEdge[];
|
|
4788
|
+
}
|
|
4789
|
+
export interface GraphSeed {
|
|
4790
|
+
entity_id: EntityId /* uuid */;
|
|
4791
|
+
/**
|
|
4792
|
+
* The node ID in the graph definition that corresponds to the seed entity
|
|
4793
|
+
* example:
|
|
4794
|
+
* contact
|
|
4795
|
+
*/
|
|
4796
|
+
node_id: string;
|
|
4797
|
+
}
|
|
4403
4798
|
export interface GroupHeadline {
|
|
4404
4799
|
id?: string; // uuid
|
|
4405
4800
|
name: string;
|
|
@@ -4804,6 +5199,13 @@ declare namespace Components {
|
|
|
4804
5199
|
*/
|
|
4805
5200
|
hint_tooltip_placement?: string;
|
|
4806
5201
|
};
|
|
5202
|
+
/**
|
|
5203
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5204
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5205
|
+
* that must always be included in search operations.
|
|
5206
|
+
*
|
|
5207
|
+
*/
|
|
5208
|
+
explicit_searchable?: boolean;
|
|
4807
5209
|
/**
|
|
4808
5210
|
* The attribute is a repeatable
|
|
4809
5211
|
*/
|
|
@@ -4945,6 +5347,13 @@ declare namespace Components {
|
|
|
4945
5347
|
*/
|
|
4946
5348
|
hint_tooltip_placement?: string;
|
|
4947
5349
|
};
|
|
5350
|
+
/**
|
|
5351
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5352
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5353
|
+
* that must always be included in search operations.
|
|
5354
|
+
*
|
|
5355
|
+
*/
|
|
5356
|
+
explicit_searchable?: boolean;
|
|
4948
5357
|
/**
|
|
4949
5358
|
* The attribute is a repeatable
|
|
4950
5359
|
*/
|
|
@@ -5086,6 +5495,13 @@ declare namespace Components {
|
|
|
5086
5495
|
*/
|
|
5087
5496
|
hint_tooltip_placement?: string;
|
|
5088
5497
|
};
|
|
5498
|
+
/**
|
|
5499
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5500
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5501
|
+
* that must always be included in search operations.
|
|
5502
|
+
*
|
|
5503
|
+
*/
|
|
5504
|
+
explicit_searchable?: boolean;
|
|
5089
5505
|
/**
|
|
5090
5506
|
* The attribute is a repeatable
|
|
5091
5507
|
*/
|
|
@@ -5235,6 +5651,13 @@ declare namespace Components {
|
|
|
5235
5651
|
*/
|
|
5236
5652
|
hint_tooltip_placement?: string;
|
|
5237
5653
|
};
|
|
5654
|
+
/**
|
|
5655
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5656
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5657
|
+
* that must always be included in search operations.
|
|
5658
|
+
*
|
|
5659
|
+
*/
|
|
5660
|
+
explicit_searchable?: boolean;
|
|
5238
5661
|
/**
|
|
5239
5662
|
* The attribute is a repeatable
|
|
5240
5663
|
*/
|
|
@@ -5384,6 +5807,13 @@ declare namespace Components {
|
|
|
5384
5807
|
*/
|
|
5385
5808
|
hint_tooltip_placement?: string;
|
|
5386
5809
|
};
|
|
5810
|
+
/**
|
|
5811
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5812
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5813
|
+
* that must always be included in search operations.
|
|
5814
|
+
*
|
|
5815
|
+
*/
|
|
5816
|
+
explicit_searchable?: boolean;
|
|
5387
5817
|
/**
|
|
5388
5818
|
* The attribute is a repeatable
|
|
5389
5819
|
*/
|
|
@@ -5528,6 +5958,13 @@ declare namespace Components {
|
|
|
5528
5958
|
*/
|
|
5529
5959
|
hint_tooltip_placement?: string;
|
|
5530
5960
|
};
|
|
5961
|
+
/**
|
|
5962
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
5963
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
5964
|
+
* that must always be included in search operations.
|
|
5965
|
+
*
|
|
5966
|
+
*/
|
|
5967
|
+
explicit_searchable?: boolean;
|
|
5531
5968
|
/**
|
|
5532
5969
|
* The attribute is a repeatable
|
|
5533
5970
|
*/
|
|
@@ -5685,6 +6122,13 @@ declare namespace Components {
|
|
|
5685
6122
|
*/
|
|
5686
6123
|
hint_tooltip_placement?: string;
|
|
5687
6124
|
};
|
|
6125
|
+
/**
|
|
6126
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6127
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6128
|
+
* that must always be included in search operations.
|
|
6129
|
+
*
|
|
6130
|
+
*/
|
|
6131
|
+
explicit_searchable?: boolean;
|
|
5688
6132
|
/**
|
|
5689
6133
|
* The attribute is a repeatable
|
|
5690
6134
|
*/
|
|
@@ -5831,6 +6275,13 @@ declare namespace Components {
|
|
|
5831
6275
|
*/
|
|
5832
6276
|
hint_tooltip_placement?: string;
|
|
5833
6277
|
};
|
|
6278
|
+
/**
|
|
6279
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6280
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6281
|
+
* that must always be included in search operations.
|
|
6282
|
+
*
|
|
6283
|
+
*/
|
|
6284
|
+
explicit_searchable?: boolean;
|
|
5834
6285
|
/**
|
|
5835
6286
|
* The attribute is a repeatable
|
|
5836
6287
|
*/
|
|
@@ -5972,6 +6423,13 @@ declare namespace Components {
|
|
|
5972
6423
|
*/
|
|
5973
6424
|
hint_tooltip_placement?: string;
|
|
5974
6425
|
};
|
|
6426
|
+
/**
|
|
6427
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6428
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6429
|
+
* that must always be included in search operations.
|
|
6430
|
+
*
|
|
6431
|
+
*/
|
|
6432
|
+
explicit_searchable?: boolean;
|
|
5975
6433
|
/**
|
|
5976
6434
|
* The attribute is a repeatable
|
|
5977
6435
|
*/
|
|
@@ -6113,6 +6571,13 @@ declare namespace Components {
|
|
|
6113
6571
|
*/
|
|
6114
6572
|
hint_tooltip_placement?: string;
|
|
6115
6573
|
};
|
|
6574
|
+
/**
|
|
6575
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6576
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6577
|
+
* that must always be included in search operations.
|
|
6578
|
+
*
|
|
6579
|
+
*/
|
|
6580
|
+
explicit_searchable?: boolean;
|
|
6116
6581
|
/**
|
|
6117
6582
|
* The attribute is a repeatable
|
|
6118
6583
|
*/
|
|
@@ -6254,6 +6719,13 @@ declare namespace Components {
|
|
|
6254
6719
|
*/
|
|
6255
6720
|
hint_tooltip_placement?: string;
|
|
6256
6721
|
};
|
|
6722
|
+
/**
|
|
6723
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6724
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6725
|
+
* that must always be included in search operations.
|
|
6726
|
+
*
|
|
6727
|
+
*/
|
|
6728
|
+
explicit_searchable?: boolean;
|
|
6257
6729
|
/**
|
|
6258
6730
|
* The attribute is a repeatable
|
|
6259
6731
|
*/
|
|
@@ -6395,6 +6867,13 @@ declare namespace Components {
|
|
|
6395
6867
|
*/
|
|
6396
6868
|
hint_tooltip_placement?: string;
|
|
6397
6869
|
};
|
|
6870
|
+
/**
|
|
6871
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
6872
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
6873
|
+
* that must always be included in search operations.
|
|
6874
|
+
*
|
|
6875
|
+
*/
|
|
6876
|
+
explicit_searchable?: boolean;
|
|
6398
6877
|
/**
|
|
6399
6878
|
* The attribute is a repeatable
|
|
6400
6879
|
*/
|
|
@@ -6536,6 +7015,13 @@ declare namespace Components {
|
|
|
6536
7015
|
*/
|
|
6537
7016
|
hint_tooltip_placement?: string;
|
|
6538
7017
|
};
|
|
7018
|
+
/**
|
|
7019
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7020
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7021
|
+
* that must always be included in search operations.
|
|
7022
|
+
*
|
|
7023
|
+
*/
|
|
7024
|
+
explicit_searchable?: boolean;
|
|
6539
7025
|
/**
|
|
6540
7026
|
* The attribute is a repeatable
|
|
6541
7027
|
*/
|
|
@@ -6677,6 +7163,13 @@ declare namespace Components {
|
|
|
6677
7163
|
*/
|
|
6678
7164
|
hint_tooltip_placement?: string;
|
|
6679
7165
|
};
|
|
7166
|
+
/**
|
|
7167
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7168
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7169
|
+
* that must always be included in search operations.
|
|
7170
|
+
*
|
|
7171
|
+
*/
|
|
7172
|
+
explicit_searchable?: boolean;
|
|
6680
7173
|
/**
|
|
6681
7174
|
* The attribute is a repeatable
|
|
6682
7175
|
*/
|
|
@@ -6818,6 +7311,13 @@ declare namespace Components {
|
|
|
6818
7311
|
*/
|
|
6819
7312
|
hint_tooltip_placement?: string;
|
|
6820
7313
|
};
|
|
7314
|
+
/**
|
|
7315
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7316
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7317
|
+
* that must always be included in search operations.
|
|
7318
|
+
*
|
|
7319
|
+
*/
|
|
7320
|
+
explicit_searchable?: boolean;
|
|
6821
7321
|
/**
|
|
6822
7322
|
* The attribute is a repeatable
|
|
6823
7323
|
*/
|
|
@@ -6959,6 +7459,13 @@ declare namespace Components {
|
|
|
6959
7459
|
*/
|
|
6960
7460
|
hint_tooltip_placement?: string;
|
|
6961
7461
|
};
|
|
7462
|
+
/**
|
|
7463
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7464
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7465
|
+
* that must always be included in search operations.
|
|
7466
|
+
*
|
|
7467
|
+
*/
|
|
7468
|
+
explicit_searchable?: boolean;
|
|
6962
7469
|
/**
|
|
6963
7470
|
* The attribute is a repeatable
|
|
6964
7471
|
*/
|
|
@@ -7115,6 +7622,13 @@ declare namespace Components {
|
|
|
7115
7622
|
*/
|
|
7116
7623
|
hint_tooltip_placement?: string;
|
|
7117
7624
|
};
|
|
7625
|
+
/**
|
|
7626
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7627
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7628
|
+
* that must always be included in search operations.
|
|
7629
|
+
*
|
|
7630
|
+
*/
|
|
7631
|
+
explicit_searchable?: boolean;
|
|
7118
7632
|
/**
|
|
7119
7633
|
* Relations are always repeatables
|
|
7120
7634
|
*/
|
|
@@ -7466,6 +7980,13 @@ declare namespace Components {
|
|
|
7466
7980
|
*/
|
|
7467
7981
|
hint_tooltip_placement?: string;
|
|
7468
7982
|
};
|
|
7983
|
+
/**
|
|
7984
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
7985
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
7986
|
+
* that must always be included in search operations.
|
|
7987
|
+
*
|
|
7988
|
+
*/
|
|
7989
|
+
explicit_searchable?: boolean;
|
|
7469
7990
|
/**
|
|
7470
7991
|
* The attribute is a repeatable
|
|
7471
7992
|
*/
|
|
@@ -8007,6 +8528,13 @@ declare namespace Components {
|
|
|
8007
8528
|
*/
|
|
8008
8529
|
hint_tooltip_placement?: string;
|
|
8009
8530
|
};
|
|
8531
|
+
/**
|
|
8532
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8533
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8534
|
+
* that must always be included in search operations.
|
|
8535
|
+
*
|
|
8536
|
+
*/
|
|
8537
|
+
explicit_searchable?: boolean;
|
|
8010
8538
|
/**
|
|
8011
8539
|
* The attribute is a repeatable
|
|
8012
8540
|
*/
|
|
@@ -8156,6 +8684,13 @@ declare namespace Components {
|
|
|
8156
8684
|
*/
|
|
8157
8685
|
hint_tooltip_placement?: string;
|
|
8158
8686
|
};
|
|
8687
|
+
/**
|
|
8688
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8689
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8690
|
+
* that must always be included in search operations.
|
|
8691
|
+
*
|
|
8692
|
+
*/
|
|
8693
|
+
explicit_searchable?: boolean;
|
|
8159
8694
|
/**
|
|
8160
8695
|
* The attribute is a repeatable
|
|
8161
8696
|
*/
|
|
@@ -8314,6 +8849,13 @@ declare namespace Components {
|
|
|
8314
8849
|
*/
|
|
8315
8850
|
hint_tooltip_placement?: string;
|
|
8316
8851
|
};
|
|
8852
|
+
/**
|
|
8853
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
8854
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
8855
|
+
* that must always be included in search operations.
|
|
8856
|
+
*
|
|
8857
|
+
*/
|
|
8858
|
+
explicit_searchable?: boolean;
|
|
8317
8859
|
/**
|
|
8318
8860
|
* The attribute is a repeatable
|
|
8319
8861
|
*/
|
|
@@ -8551,6 +9093,13 @@ declare namespace Components {
|
|
|
8551
9093
|
*/
|
|
8552
9094
|
hint_tooltip_placement?: string;
|
|
8553
9095
|
};
|
|
9096
|
+
/**
|
|
9097
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9098
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9099
|
+
* that must always be included in search operations.
|
|
9100
|
+
*
|
|
9101
|
+
*/
|
|
9102
|
+
explicit_searchable?: boolean;
|
|
8554
9103
|
/**
|
|
8555
9104
|
* The attribute is a repeatable
|
|
8556
9105
|
*/
|
|
@@ -8881,6 +9430,13 @@ declare namespace Components {
|
|
|
8881
9430
|
*/
|
|
8882
9431
|
hint_tooltip_placement?: string;
|
|
8883
9432
|
};
|
|
9433
|
+
/**
|
|
9434
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9435
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9436
|
+
* that must always be included in search operations.
|
|
9437
|
+
*
|
|
9438
|
+
*/
|
|
9439
|
+
explicit_searchable?: boolean;
|
|
8884
9440
|
/**
|
|
8885
9441
|
* The attribute is a repeatable
|
|
8886
9442
|
*/
|
|
@@ -9035,6 +9591,13 @@ declare namespace Components {
|
|
|
9035
9591
|
*/
|
|
9036
9592
|
hint_tooltip_placement?: string;
|
|
9037
9593
|
};
|
|
9594
|
+
/**
|
|
9595
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9596
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9597
|
+
* that must always be included in search operations.
|
|
9598
|
+
*
|
|
9599
|
+
*/
|
|
9600
|
+
explicit_searchable?: boolean;
|
|
9038
9601
|
/**
|
|
9039
9602
|
* The attribute is a repeatable
|
|
9040
9603
|
*/
|
|
@@ -11042,7 +11605,7 @@ declare namespace Paths {
|
|
|
11042
11605
|
/**
|
|
11043
11606
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
11044
11607
|
* example:
|
|
11045
|
-
* 2023-01-01T00:00:
|
|
11608
|
+
* 2023-01-01T00:00:00Z
|
|
11046
11609
|
*/
|
|
11047
11610
|
export type CreatedAfter = string; // date-time
|
|
11048
11611
|
/**
|
|
@@ -11068,7 +11631,7 @@ declare namespace Paths {
|
|
|
11068
11631
|
created_after?: /**
|
|
11069
11632
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
11070
11633
|
* example:
|
|
11071
|
-
* 2023-01-01T00:00:
|
|
11634
|
+
* 2023-01-01T00:00:00Z
|
|
11072
11635
|
*/
|
|
11073
11636
|
Parameters.CreatedAfter /* date-time */;
|
|
11074
11637
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -11838,6 +12401,30 @@ declare namespace Paths {
|
|
|
11838
12401
|
}
|
|
11839
12402
|
}
|
|
11840
12403
|
}
|
|
12404
|
+
namespace TraverseEntityGraph {
|
|
12405
|
+
export type RequestBody = Components.Schemas.GraphQueryRequest;
|
|
12406
|
+
namespace Responses {
|
|
12407
|
+
export type $200 = Components.Schemas.GraphQueryResponse;
|
|
12408
|
+
export type $400 = /**
|
|
12409
|
+
* A generic error returned by the API
|
|
12410
|
+
* example:
|
|
12411
|
+
* {
|
|
12412
|
+
* "status": 400,
|
|
12413
|
+
* "error": "Bad Request"
|
|
12414
|
+
* }
|
|
12415
|
+
*/
|
|
12416
|
+
Components.Responses.BadRequestError;
|
|
12417
|
+
export type $404 = /**
|
|
12418
|
+
* A generic error returned by the API
|
|
12419
|
+
* example:
|
|
12420
|
+
* {
|
|
12421
|
+
* "status": 404,
|
|
12422
|
+
* "error": "Not Found"
|
|
12423
|
+
* }
|
|
12424
|
+
*/
|
|
12425
|
+
Components.Responses.NotFoundError;
|
|
12426
|
+
}
|
|
12427
|
+
}
|
|
11841
12428
|
namespace UpdateClassificationsForTaxonomy {
|
|
11842
12429
|
namespace Parameters {
|
|
11843
12430
|
export type TaxonomySlug = string;
|
|
@@ -13056,6 +13643,22 @@ export interface OperationMethods {
|
|
|
13056
13643
|
data?: Paths.ImportEntities.RequestBody,
|
|
13057
13644
|
config?: AxiosRequestConfig
|
|
13058
13645
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
13646
|
+
/**
|
|
13647
|
+
* traverseEntityGraph - Traverse Entity Graph
|
|
13648
|
+
*
|
|
13649
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
13650
|
+
*
|
|
13651
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
13652
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
13653
|
+
*
|
|
13654
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
13655
|
+
*
|
|
13656
|
+
*/
|
|
13657
|
+
'traverseEntityGraph'(
|
|
13658
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
13659
|
+
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
13660
|
+
config?: AxiosRequestConfig
|
|
13661
|
+
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
13059
13662
|
/**
|
|
13060
13663
|
* listSavedViews - listSavedViews
|
|
13061
13664
|
*
|
|
@@ -14201,6 +14804,24 @@ export interface PathsDictionary {
|
|
|
14201
14804
|
config?: AxiosRequestConfig
|
|
14202
14805
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
14203
14806
|
}
|
|
14807
|
+
['/v1/entity:graph']: {
|
|
14808
|
+
/**
|
|
14809
|
+
* traverseEntityGraph - Traverse Entity Graph
|
|
14810
|
+
*
|
|
14811
|
+
* Traverse an entity relationship graph starting from a seed entity.
|
|
14812
|
+
*
|
|
14813
|
+
* Define the shape of the graph using nodes (entity schemas) and edges (relationships with cardinality).
|
|
14814
|
+
* The API will traverse the graph bidirectionally and return all discovered entity IDs.
|
|
14815
|
+
*
|
|
14816
|
+
* Example: Find all entities connected to a contact through portal_user -> contact -> billing_account -> files
|
|
14817
|
+
*
|
|
14818
|
+
*/
|
|
14819
|
+
'post'(
|
|
14820
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14821
|
+
data?: Paths.TraverseEntityGraph.RequestBody,
|
|
14822
|
+
config?: AxiosRequestConfig
|
|
14823
|
+
): OperationResponse<Paths.TraverseEntityGraph.Responses.$200>
|
|
14824
|
+
}
|
|
14204
14825
|
['/v1/entity/views']: {
|
|
14205
14826
|
/**
|
|
14206
14827
|
* listSavedViews - listSavedViews
|
|
@@ -14700,6 +15321,7 @@ export type Activity = Components.Schemas.Activity;
|
|
|
14700
15321
|
export type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
|
|
14701
15322
|
export type ActivityId = Components.Schemas.ActivityId;
|
|
14702
15323
|
export type ActivityItem = Components.Schemas.ActivityItem;
|
|
15324
|
+
export type ActivityType = Components.Schemas.ActivityType;
|
|
14703
15325
|
export type AddressAttribute = Components.Schemas.AddressAttribute;
|
|
14704
15326
|
export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute;
|
|
14705
15327
|
export type Attribute = Components.Schemas.Attribute;
|
|
@@ -14765,6 +15387,12 @@ export type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEn
|
|
|
14765
15387
|
export type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
|
14766
15388
|
export type GetRelationsResp = Components.Schemas.GetRelationsResp;
|
|
14767
15389
|
export type GetRelationsRespWithPagination = Components.Schemas.GetRelationsRespWithPagination;
|
|
15390
|
+
export type GraphDefinition = Components.Schemas.GraphDefinition;
|
|
15391
|
+
export type GraphEdge = Components.Schemas.GraphEdge;
|
|
15392
|
+
export type GraphNode = Components.Schemas.GraphNode;
|
|
15393
|
+
export type GraphQueryRequest = Components.Schemas.GraphQueryRequest;
|
|
15394
|
+
export type GraphQueryResponse = Components.Schemas.GraphQueryResponse;
|
|
15395
|
+
export type GraphSeed = Components.Schemas.GraphSeed;
|
|
14768
15396
|
export type GroupHeadline = Components.Schemas.GroupHeadline;
|
|
14769
15397
|
export type GroupHeadlineWithCompositeID = Components.Schemas.GroupHeadlineWithCompositeID;
|
|
14770
15398
|
export type HydratedEntity = Components.Schemas.HydratedEntity;
|