@epilot/entity-client 4.9.3 → 4.10.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/dist/openapi.d.ts CHANGED
@@ -135,12 +135,6 @@ declare namespace Components {
135
135
  [name: string]: any;
136
136
  };
137
137
  caller?: ActivityCallerContext;
138
- /**
139
- * Count of total operations attached to this activity
140
- * example:
141
- * 1
142
- */
143
- operations_total?: number;
144
138
  operations?: EntityOperation[];
145
139
  }
146
140
  /**
@@ -161,21 +155,10 @@ declare namespace Components {
161
155
  required?: boolean;
162
156
  readonly?: boolean;
163
157
  deprecated?: boolean;
164
- default_value?: any;
165
- /**
166
- * Which group the attribute should appear in. Accepts group ID or group name
167
- */
158
+ default_value?: string | {
159
+ [name: string]: any;
160
+ } | number | number | boolean | any[];
168
161
  group?: string;
169
- /**
170
- * Attribute sort order (ascending) in group
171
- * example:
172
- * 0
173
- */
174
- order?: number;
175
- /**
176
- * example:
177
- * full_width
178
- */
179
162
  layout?: string;
180
163
  /**
181
164
  * When set to true, will hide the label of the field.
@@ -194,7 +177,6 @@ declare namespace Components {
194
177
  *
195
178
  */
196
179
  render_condition?: string;
197
- _purpose?: ClassificationId /* uuid */[];
198
180
  /**
199
181
  * A set of constraints applicable to the attribute.
200
182
  * These constraints should and will be enforced by the attribute renderer.
@@ -232,7 +214,16 @@ declare namespace Components {
232
214
  type?: "relation_address";
233
215
  has_primary?: boolean;
234
216
  }
235
- export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute;
217
+ export interface Attachment {
218
+ key: string;
219
+ mime: string;
220
+ name: string;
221
+ size: number;
222
+ image_url: string;
223
+ download_url: string;
224
+ alt_text?: string;
225
+ }
226
+ export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute;
236
227
  /**
237
228
  * Automation entity
238
229
  */
@@ -251,21 +242,10 @@ declare namespace Components {
251
242
  required?: boolean;
252
243
  readonly?: boolean;
253
244
  deprecated?: boolean;
254
- default_value?: any;
255
- /**
256
- * Which group the attribute should appear in. Accepts group ID or group name
257
- */
245
+ default_value?: string | {
246
+ [name: string]: any;
247
+ } | number | number | boolean | any[];
258
248
  group?: string;
259
- /**
260
- * Attribute sort order (ascending) in group
261
- * example:
262
- * 0
263
- */
264
- order?: number;
265
- /**
266
- * example:
267
- * full_width
268
- */
269
249
  layout?: string;
270
250
  /**
271
251
  * When set to true, will hide the label of the field.
@@ -284,7 +264,6 @@ declare namespace Components {
284
264
  *
285
265
  */
286
266
  render_condition?: string;
287
- _purpose?: ClassificationId /* uuid */[];
288
267
  /**
289
268
  * A set of constraints applicable to the attribute.
290
269
  * These constraints should and will be enforced by the attribute renderer.
@@ -336,21 +315,10 @@ declare namespace Components {
336
315
  required?: boolean;
337
316
  readonly?: boolean;
338
317
  deprecated?: boolean;
339
- default_value?: any;
340
- /**
341
- * Which group the attribute should appear in. Accepts group ID or group name
342
- */
318
+ default_value?: string | {
319
+ [name: string]: any;
320
+ } | number | number | boolean | any[];
343
321
  group?: string;
344
- /**
345
- * Attribute sort order (ascending) in group
346
- * example:
347
- * 0
348
- */
349
- order?: number;
350
- /**
351
- * example:
352
- * full_width
353
- */
354
322
  layout?: string;
355
323
  /**
356
324
  * When set to true, will hide the label of the field.
@@ -369,7 +337,6 @@ declare namespace Components {
369
337
  *
370
338
  */
371
339
  render_condition?: string;
372
- _purpose?: ClassificationId /* uuid */[];
373
340
  /**
374
341
  * A set of constraints applicable to the attribute.
375
342
  * These constraints should and will be enforced by the attribute renderer.
@@ -420,8 +387,11 @@ declare namespace Components {
420
387
  * }
421
388
  */
422
389
  export interface BaseEntity {
423
- [name: string]: any;
424
390
  _id: EntityId /* uuid */;
391
+ /**
392
+ * Title of entity
393
+ */
394
+ _title: string;
425
395
  /**
426
396
  * Organization Id the entity belongs to
427
397
  */
@@ -432,13 +402,9 @@ declare namespace Components {
432
402
  * contact
433
403
  */
434
404
  EntitySlug;
435
- /**
436
- * Title of entity
437
- */
438
- _title: string | null;
439
- _tags?: string[] | null;
440
- _created_at: string | null; // date-time
441
- _updated_at: string | null; // date-time
405
+ _tags?: string[];
406
+ _created_at: string; // date-time
407
+ _updated_at: string; // date-time
442
408
  }
443
409
  /**
444
410
  * Reference to blueprint
@@ -462,21 +428,10 @@ declare namespace Components {
462
428
  required?: boolean;
463
429
  readonly?: boolean;
464
430
  deprecated?: boolean;
465
- default_value?: any;
466
- /**
467
- * Which group the attribute should appear in. Accepts group ID or group name
468
- */
431
+ default_value?: string | {
432
+ [name: string]: any;
433
+ } | number | number | boolean | any[];
469
434
  group?: string;
470
- /**
471
- * Attribute sort order (ascending) in group
472
- * example:
473
- * 0
474
- */
475
- order?: number;
476
- /**
477
- * example:
478
- * full_width
479
- */
480
435
  layout?: string;
481
436
  /**
482
437
  * When set to true, will hide the label of the field.
@@ -495,7 +450,6 @@ declare namespace Components {
495
450
  *
496
451
  */
497
452
  render_condition?: string;
498
- _purpose?: ClassificationId /* uuid */[];
499
453
  /**
500
454
  * A set of constraints applicable to the attribute.
501
455
  * These constraints should and will be enforced by the attribute renderer.
@@ -532,12 +486,6 @@ declare namespace Components {
532
486
  protected?: boolean;
533
487
  type?: "boolean";
534
488
  }
535
- export type ClassificationId = string; // uuid
536
- export interface ClassificationsUpdate {
537
- create?: TaxonomyClassification[];
538
- update?: TaxonomyClassification[];
539
- delete?: ClassificationId /* uuid */[];
540
- }
541
489
  /**
542
490
  * An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes)
543
491
  */
@@ -556,21 +504,10 @@ declare namespace Components {
556
504
  required?: boolean;
557
505
  readonly?: boolean;
558
506
  deprecated?: boolean;
559
- default_value?: any;
560
- /**
561
- * Which group the attribute should appear in. Accepts group ID or group name
562
- */
507
+ default_value?: string | {
508
+ [name: string]: any;
509
+ } | number | number | boolean | any[];
563
510
  group?: string;
564
- /**
565
- * Attribute sort order (ascending) in group
566
- * example:
567
- * 0
568
- */
569
- order?: number;
570
- /**
571
- * example:
572
- * full_width
573
- */
574
511
  layout?: string;
575
512
  /**
576
513
  * When set to true, will hide the label of the field.
@@ -589,7 +526,6 @@ declare namespace Components {
589
526
  *
590
527
  */
591
528
  render_condition?: string;
592
- _purpose?: ClassificationId /* uuid */[];
593
529
  /**
594
530
  * A set of constraints applicable to the attribute.
595
531
  * These constraints should and will be enforced by the attribute renderer.
@@ -644,21 +580,10 @@ declare namespace Components {
644
580
  required?: boolean;
645
581
  readonly?: boolean;
646
582
  deprecated?: boolean;
647
- default_value?: any;
648
- /**
649
- * Which group the attribute should appear in. Accepts group ID or group name
650
- */
583
+ default_value?: string | {
584
+ [name: string]: any;
585
+ } | number | number | boolean | any[];
651
586
  group?: string;
652
- /**
653
- * Attribute sort order (ascending) in group
654
- * example:
655
- * 0
656
- */
657
- order?: number;
658
- /**
659
- * example:
660
- * full_width
661
- */
662
587
  layout?: string;
663
588
  /**
664
589
  * When set to true, will hide the label of the field.
@@ -677,7 +602,6 @@ declare namespace Components {
677
602
  *
678
603
  */
679
604
  render_condition?: string;
680
- _purpose?: ClassificationId /* uuid */[];
681
605
  /**
682
606
  * A set of constraints applicable to the attribute.
683
607
  * These constraints should and will be enforced by the attribute renderer.
@@ -734,21 +658,10 @@ declare namespace Components {
734
658
  required?: boolean;
735
659
  readonly?: boolean;
736
660
  deprecated?: boolean;
737
- default_value?: any;
738
- /**
739
- * Which group the attribute should appear in. Accepts group ID or group name
740
- */
661
+ default_value?: string | {
662
+ [name: string]: any;
663
+ } | number | number | boolean | any[];
741
664
  group?: string;
742
- /**
743
- * Attribute sort order (ascending) in group
744
- * example:
745
- * 0
746
- */
747
- order?: number;
748
- /**
749
- * example:
750
- * full_width
751
- */
752
665
  layout?: string;
753
666
  /**
754
667
  * When set to true, will hide the label of the field.
@@ -767,7 +680,6 @@ declare namespace Components {
767
680
  *
768
681
  */
769
682
  render_condition?: string;
770
- _purpose?: ClassificationId /* uuid */[];
771
683
  /**
772
684
  * A set of constraints applicable to the attribute.
773
685
  * These constraints should and will be enforced by the attribute renderer.
@@ -822,21 +734,10 @@ declare namespace Components {
822
734
  required?: boolean;
823
735
  readonly?: boolean;
824
736
  deprecated?: boolean;
825
- default_value?: any;
826
- /**
827
- * Which group the attribute should appear in. Accepts group ID or group name
828
- */
737
+ default_value?: string | {
738
+ [name: string]: any;
739
+ } | number | number | boolean | any[];
829
740
  group?: string;
830
- /**
831
- * Attribute sort order (ascending) in group
832
- * example:
833
- * 0
834
- */
835
- order?: number;
836
- /**
837
- * example:
838
- * full_width
839
- */
840
741
  layout?: string;
841
742
  /**
842
743
  * When set to true, will hide the label of the field.
@@ -855,7 +756,6 @@ declare namespace Components {
855
756
  *
856
757
  */
857
758
  render_condition?: string;
858
- _purpose?: ClassificationId /* uuid */[];
859
759
  /**
860
760
  * A set of constraints applicable to the attribute.
861
761
  * These constraints should and will be enforced by the attribute renderer.
@@ -920,21 +820,10 @@ declare namespace Components {
920
820
  required?: boolean;
921
821
  readonly?: boolean;
922
822
  deprecated?: boolean;
923
- default_value?: any;
924
- /**
925
- * Which group the attribute should appear in. Accepts group ID or group name
926
- */
823
+ default_value?: string | {
824
+ [name: string]: any;
825
+ } | number | number | boolean | any[];
927
826
  group?: string;
928
- /**
929
- * Attribute sort order (ascending) in group
930
- * example:
931
- * 0
932
- */
933
- order?: number;
934
- /**
935
- * example:
936
- * full_width
937
- */
938
827
  layout?: string;
939
828
  /**
940
829
  * When set to true, will hide the label of the field.
@@ -953,7 +842,6 @@ declare namespace Components {
953
842
  *
954
843
  */
955
844
  render_condition?: string;
956
- _purpose?: ClassificationId /* uuid */[];
957
845
  /**
958
846
  * A set of constraints applicable to the attribute.
959
847
  * These constraints should and will be enforced by the attribute renderer.
@@ -990,40 +878,8 @@ declare namespace Components {
990
878
  protected?: boolean;
991
879
  type?: "date" | "datetime";
992
880
  }
993
- /**
994
- * example:
995
- * {
996
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
997
- * "_org": "123",
998
- * "_schema": "contact",
999
- * "_tags": [
1000
- * "example",
1001
- * "mock"
1002
- * ],
1003
- * "_created_at": "2021-02-09T12:41:43.662Z",
1004
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1005
- * }
1006
- */
1007
881
  export interface Entity {
1008
882
  [name: string]: any;
1009
- _id?: EntityId /* uuid */;
1010
- /**
1011
- * Organization Id the entity belongs to
1012
- */
1013
- _org?: string;
1014
- _schema?: /**
1015
- * URL-friendly identifier for the entity schema
1016
- * example:
1017
- * contact
1018
- */
1019
- EntitySlug;
1020
- /**
1021
- * Title of entity
1022
- */
1023
- _title?: string | null;
1024
- _tags?: string[] | null;
1025
- _created_at?: string | null; // date-time
1026
- _updated_at?: string | null; // date-time
1027
883
  }
1028
884
  /**
1029
885
  * Capabilities the Entity has. Turn features on/off for entities.
@@ -1042,7 +898,6 @@ declare namespace Components {
1042
898
  */
1043
899
  title?: string;
1044
900
  attributes?: Attribute[];
1045
- _purpose?: ClassificationId /* uuid */[];
1046
901
  ui_hooks?: {
1047
902
  [name: string]: any;
1048
903
  /**
@@ -1156,7 +1011,7 @@ declare namespace Components {
1156
1011
  label?: string;
1157
1012
  };
1158
1013
  }
1159
- export interface EntityDefaultTable {
1014
+ export interface EntityDefaultOverview {
1160
1015
  view_type?: "default";
1161
1016
  dropdown_items?: ({
1162
1017
  type?: "entity";
@@ -1183,7 +1038,7 @@ declare namespace Components {
1183
1038
  * Opportunities
1184
1039
  */
1185
1040
  title?: string;
1186
- uri?: string; // uri-reference
1041
+ uri?: string; // uri
1187
1042
  /**
1188
1043
  * This dropdown item should only be active when the feature flag is enabled
1189
1044
  * example:
@@ -1196,41 +1051,9 @@ declare namespace Components {
1196
1051
  legacy?: boolean;
1197
1052
  })[];
1198
1053
  row_actions?: string[];
1199
- navbar_actions?: {
1200
- type: string;
1201
- options?: {
1202
- label: string;
1203
- params?: {
1204
- [key: string]: any;
1205
- };
1206
- }[];
1207
- }[];
1208
- /**
1209
- * Enable the thumbnail column
1210
- */
1211
- enable_thumbnails?: boolean;
1212
- classic_view?: string; // uri-reference
1054
+ classic_view?: string; // uri
1213
1055
  }
1214
1056
  export type EntityId = string; // uuid
1215
- export interface EntityImportParams {
1216
- S3Reference: {
1217
- /**
1218
- * example:
1219
- * epilot-files-prod
1220
- */
1221
- bucket: string;
1222
- /**
1223
- * example:
1224
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
1225
- */
1226
- key: string;
1227
- };
1228
- /**
1229
- * example:
1230
- * contact
1231
- */
1232
- schema: string;
1233
- }
1234
1057
  /**
1235
1058
  * example:
1236
1059
  * {
@@ -1239,8 +1062,6 @@ declare namespace Components {
1239
1062
  * "_schema": "contact",
1240
1063
  * "_tags": [
1241
1064
  * "example",
1242
- * "mock",
1243
- * "example",
1244
1065
  * "mock"
1245
1066
  * ],
1246
1067
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -1250,6 +1071,10 @@ declare namespace Components {
1250
1071
  export interface EntityItem {
1251
1072
  [name: string]: any;
1252
1073
  _id: EntityId /* uuid */;
1074
+ /**
1075
+ * Title of entity
1076
+ */
1077
+ _title: string;
1253
1078
  /**
1254
1079
  * Organization Id the entity belongs to
1255
1080
  */
@@ -1260,13 +1085,9 @@ declare namespace Components {
1260
1085
  * contact
1261
1086
  */
1262
1087
  EntitySlug;
1263
- /**
1264
- * Title of entity
1265
- */
1266
- _title: string | null;
1267
- _tags?: string[] | null;
1268
- _created_at: string | null; // date-time
1269
- _updated_at: string | null; // date-time
1088
+ _tags?: string[];
1089
+ _created_at: string; // date-time
1090
+ _updated_at: string; // date-time
1270
1091
  }
1271
1092
  export interface EntityOperation {
1272
1093
  entity: EntityId /* uuid */;
@@ -1301,87 +1122,35 @@ declare namespace Components {
1301
1122
  /**
1302
1123
  * example:
1303
1124
  * {
1304
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1305
- * "_org": "123",
1306
1125
  * "_schema": "contact",
1307
- * "_tags": [
1308
- * "example",
1309
- * "mock"
1310
- * ],
1311
- * "_created_at": "2021-02-09T12:41:43.662Z",
1312
- * "_updated_at": "2021-02-09T12:41:43.662Z",
1126
+ * "_org": "123",
1313
1127
  * "status": "Inactive"
1314
1128
  * }
1315
1129
  */
1316
1130
  payload?: {
1317
1131
  [name: string]: any;
1318
- _id?: EntityId /* uuid */;
1319
- /**
1320
- * Organization Id the entity belongs to
1321
- */
1322
- _org?: string;
1323
- _schema?: /**
1324
- * URL-friendly identifier for the entity schema
1325
- * example:
1326
- * contact
1327
- */
1328
- EntitySlug;
1329
- /**
1330
- * Title of entity
1331
- */
1332
- _title?: string | null;
1333
- _tags?: string[] | null;
1334
- _created_at?: string | null; // date-time
1335
- _updated_at?: string | null; // date-time
1336
1132
  };
1337
1133
  diff?: {
1338
- added?: /**
1339
- * example:
1340
- * {
1341
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1342
- * "_org": "123",
1343
- * "_schema": "contact",
1344
- * "_tags": [
1345
- * "example",
1346
- * "mock"
1347
- * ],
1348
- * "_created_at": "2021-02-09T12:41:43.662Z",
1349
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1350
- * }
1351
- */
1352
- Entity;
1353
- updated?: /**
1354
- * example:
1355
- * {
1356
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1357
- * "_org": "123",
1358
- * "_schema": "contact",
1359
- * "_tags": [
1360
- * "example",
1361
- * "mock"
1362
- * ],
1363
- * "_created_at": "2021-02-09T12:41:43.662Z",
1364
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1365
- * }
1366
- */
1367
- Entity;
1368
- deleted?: /**
1369
- * example:
1370
- * {
1371
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1372
- * "_org": "123",
1373
- * "_schema": "contact",
1374
- * "_tags": [
1375
- * "example",
1376
- * "mock"
1377
- * ],
1378
- * "_created_at": "2021-02-09T12:41:43.662Z",
1379
- * "_updated_at": "2021-02-09T12:41:43.662Z"
1380
- * }
1381
- */
1382
- Entity;
1134
+ added?: Entity;
1135
+ updated?: Entity;
1136
+ deleted?: Entity;
1383
1137
  };
1384
1138
  }
1139
+ /**
1140
+ * example:
1141
+ * {
1142
+ * "type": "redirect",
1143
+ * "route": "/app/pricing-hub/product/:entityId"
1144
+ * }
1145
+ */
1146
+ export interface EntityParcelView {
1147
+ view_type?: "parcel";
1148
+ /**
1149
+ * example:
1150
+ * @epilot360/pricing-hub-app
1151
+ */
1152
+ import?: string;
1153
+ }
1385
1154
  /**
1386
1155
  * The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
1387
1156
  */
@@ -1437,38 +1206,10 @@ declare namespace Components {
1437
1206
  */
1438
1207
  title_template?: string;
1439
1208
  ui_config?: {
1440
- table_view?: EntityDefaultTable | /**
1441
- * example:
1442
- * {
1443
- * "type": "redirect",
1444
- * "route": "/app/pricing-hub/product/:entityId"
1445
- * }
1446
- */
1447
- RedirectEntityView | EntityViewDisabled;
1448
- create_view?: EntityDefaultCreate | /**
1449
- * example:
1450
- * {
1451
- * "type": "redirect",
1452
- * "route": "/app/pricing-hub/product/:entityId"
1453
- * }
1454
- */
1455
- RedirectEntityView | EntityViewDisabled;
1456
- edit_view?: EntityDefaultEdit | /**
1457
- * example:
1458
- * {
1459
- * "type": "redirect",
1460
- * "route": "/app/pricing-hub/product/:entityId"
1461
- * }
1462
- */
1463
- RedirectEntityView | EntityViewDisabled;
1464
- single_view?: EntityDefaultEdit | /**
1465
- * example:
1466
- * {
1467
- * "type": "redirect",
1468
- * "route": "/app/pricing-hub/product/:entityId"
1469
- * }
1470
- */
1471
- RedirectEntityView | EntityViewDisabled;
1209
+ table_view?: EntityViewConfig;
1210
+ create_view?: EntityViewConfig;
1211
+ edit_view?: EntityViewConfig;
1212
+ single_view?: EntityViewConfig;
1472
1213
  list_item?: {
1473
1214
  summary_attributes?: (/**
1474
1215
  * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1541,24 +1282,15 @@ declare namespace Components {
1541
1282
  key?: string;
1542
1283
  default?: string;
1543
1284
  };
1544
- _purpose?: ClassificationId /* uuid */[];
1545
1285
  }[];
1546
1286
  /**
1547
- * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
1548
- * - Managed Properties: are interpreted and transformed into layout styles
1549
- * - Un-managed Properties: are appended as styles into the attribute mounting node
1550
- *
1287
+ * Custom grid definitions for the layout
1551
1288
  */
1552
1289
  layout_settings?: {
1553
- [name: string]: any;
1554
- /**
1555
- * Defines the grid gap for the mounting node of the attribute.
1556
- */
1557
- grid_gap?: string;
1558
- /**
1559
- * Defines the grid column template for the mounting node of the attribute.
1560
- */
1561
- grid_template_columns?: string;
1290
+ [name: string]: {
1291
+ grid_gap?: string;
1292
+ grid_template_columns?: string;
1293
+ };
1562
1294
  };
1563
1295
  dialog_config?: {
1564
1296
  [name: string]: any;
@@ -1687,38 +1419,10 @@ declare namespace Components {
1687
1419
  */
1688
1420
  title_template?: string;
1689
1421
  ui_config?: {
1690
- table_view?: EntityDefaultTable | /**
1691
- * example:
1692
- * {
1693
- * "type": "redirect",
1694
- * "route": "/app/pricing-hub/product/:entityId"
1695
- * }
1696
- */
1697
- RedirectEntityView | EntityViewDisabled;
1698
- create_view?: EntityDefaultCreate | /**
1699
- * example:
1700
- * {
1701
- * "type": "redirect",
1702
- * "route": "/app/pricing-hub/product/:entityId"
1703
- * }
1704
- */
1705
- RedirectEntityView | EntityViewDisabled;
1706
- edit_view?: EntityDefaultEdit | /**
1707
- * example:
1708
- * {
1709
- * "type": "redirect",
1710
- * "route": "/app/pricing-hub/product/:entityId"
1711
- * }
1712
- */
1713
- RedirectEntityView | EntityViewDisabled;
1714
- single_view?: EntityDefaultEdit | /**
1715
- * example:
1716
- * {
1717
- * "type": "redirect",
1718
- * "route": "/app/pricing-hub/product/:entityId"
1719
- * }
1720
- */
1721
- RedirectEntityView | EntityViewDisabled;
1422
+ table_view?: EntityViewConfig;
1423
+ create_view?: EntityViewConfig;
1424
+ edit_view?: EntityViewConfig;
1425
+ single_view?: EntityViewConfig;
1722
1426
  list_item?: {
1723
1427
  summary_attributes?: (/**
1724
1428
  * Represents an expanded version of an attribute to be displayed in the list item summary.
@@ -1791,26 +1495,17 @@ declare namespace Components {
1791
1495
  key?: string;
1792
1496
  default?: string;
1793
1497
  };
1794
- _purpose?: ClassificationId /* uuid */[];
1795
1498
  }[];
1796
1499
  /**
1797
- * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
1798
- * - Managed Properties: are interpreted and transformed into layout styles
1799
- * - Un-managed Properties: are appended as styles into the attribute mounting node
1800
- *
1500
+ * Custom grid definitions for the layout
1801
1501
  */
1802
1502
  layout_settings?: {
1803
- [name: string]: any;
1804
- /**
1805
- * Defines the grid gap for the mounting node of the attribute.
1806
- */
1807
- grid_gap?: string;
1808
- /**
1809
- * Defines the grid column template for the mounting node of the attribute.
1810
- */
1811
- grid_template_columns?: string;
1812
- };
1813
- dialog_config?: {
1503
+ [name: string]: {
1504
+ grid_gap?: string;
1505
+ grid_template_columns?: string;
1506
+ };
1507
+ };
1508
+ dialog_config?: {
1814
1509
  [name: string]: any;
1815
1510
  };
1816
1511
  /**
@@ -1887,9 +1582,6 @@ declare namespace Components {
1887
1582
  */
1888
1583
  sort?: string;
1889
1584
  from?: number;
1890
- /**
1891
- * Max search size is 1000 with higher values defaulting to 1000
1892
- */
1893
1585
  size?: number;
1894
1586
  /**
1895
1587
  * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
@@ -1905,24 +1597,6 @@ declare namespace Components {
1905
1597
  * ]
1906
1598
  */
1907
1599
  fields?: string[];
1908
- /**
1909
- * Adds a `_score` number field to results that can be used to rank by match score
1910
- */
1911
- include_scores?: boolean;
1912
- /**
1913
- * Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.
1914
- * example:
1915
- * {
1916
- * "contact-count-per-tag": {
1917
- * "terms": {
1918
- * "field": "_tags.keyword"
1919
- * }
1920
- * }
1921
- * }
1922
- */
1923
- aggs?: {
1924
- [key: string]: any;
1925
- };
1926
1600
  }
1927
1601
  export interface EntitySearchResults {
1928
1602
  /**
@@ -1938,8 +1612,6 @@ declare namespace Components {
1938
1612
  * "_schema": "contact",
1939
1613
  * "_tags": [
1940
1614
  * "example",
1941
- * "mock",
1942
- * "example",
1943
1615
  * "mock"
1944
1616
  * ],
1945
1617
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -1947,28 +1619,6 @@ declare namespace Components {
1947
1619
  * }
1948
1620
  */
1949
1621
  EntityItem[];
1950
- /**
1951
- * example:
1952
- * {
1953
- * "contact-count-per-tag": {
1954
- * "doc_count_error_upper_bound": 0,
1955
- * "sum_other_doc_count": 23,
1956
- * "buckets": [
1957
- * {
1958
- * "key": "automation",
1959
- * "doc_count": 108
1960
- * },
1961
- * {
1962
- * "key": "primary",
1963
- * "doc_count": 66
1964
- * }
1965
- * ]
1966
- * }
1967
- * }
1968
- */
1969
- aggregations?: {
1970
- [key: string]: any;
1971
- };
1972
1622
  }
1973
1623
  /**
1974
1624
  * URL-friendly identifier for the entity schema
@@ -1976,6 +1626,21 @@ declare namespace Components {
1976
1626
  * contact
1977
1627
  */
1978
1628
  export type EntitySlug = string;
1629
+ export type EntityViewConfig = EntityDefaultCreate | EntityDefaultEdit | EntityDefaultOverview | /**
1630
+ * example:
1631
+ * {
1632
+ * "type": "redirect",
1633
+ * "route": "/app/pricing-hub/product/:entityId"
1634
+ * }
1635
+ */
1636
+ RedirectEntityView | /**
1637
+ * example:
1638
+ * {
1639
+ * "type": "redirect",
1640
+ * "route": "/app/pricing-hub/product/:entityId"
1641
+ * }
1642
+ */
1643
+ EntityParcelView | EntityViewDisabled;
1979
1644
  export interface EntityViewDisabled {
1980
1645
  view_type?: "disabled";
1981
1646
  }
@@ -2001,21 +1666,10 @@ declare namespace Components {
2001
1666
  required?: boolean;
2002
1667
  readonly?: boolean;
2003
1668
  deprecated?: boolean;
2004
- default_value?: any;
2005
- /**
2006
- * Which group the attribute should appear in. Accepts group ID or group name
2007
- */
1669
+ default_value?: string | {
1670
+ [name: string]: any;
1671
+ } | number | number | boolean | any[];
2008
1672
  group?: string;
2009
- /**
2010
- * Attribute sort order (ascending) in group
2011
- * example:
2012
- * 0
2013
- */
2014
- order?: number;
2015
- /**
2016
- * example:
2017
- * full_width
2018
- */
2019
1673
  layout?: string;
2020
1674
  /**
2021
1675
  * When set to true, will hide the label of the field.
@@ -2034,7 +1688,6 @@ declare namespace Components {
2034
1688
  *
2035
1689
  */
2036
1690
  render_condition?: string;
2037
- _purpose?: ClassificationId /* uuid */[];
2038
1691
  /**
2039
1692
  * A set of constraints applicable to the attribute.
2040
1693
  * These constraints should and will be enforced by the attribute renderer.
@@ -2102,14 +1755,6 @@ declare namespace Components {
2102
1755
  * }
2103
1756
  */
2104
1757
  RelationEntity)[];
2105
- export interface GetRelationsRespWithPagination {
2106
- /**
2107
- * example:
2108
- * 1
2109
- */
2110
- hits?: number;
2111
- relations?: GetRelationsResp;
2112
- }
2113
1758
  /**
2114
1759
  * Entity with relation data resolved into the attribute values
2115
1760
  * example:
@@ -2237,6 +1882,10 @@ declare namespace Components {
2237
1882
  export interface HydratedEntityItem {
2238
1883
  [name: string]: any;
2239
1884
  _id: EntityId /* uuid */;
1885
+ /**
1886
+ * Title of entity
1887
+ */
1888
+ _title: string;
2240
1889
  /**
2241
1890
  * Organization Id the entity belongs to
2242
1891
  */
@@ -2247,13 +1896,9 @@ declare namespace Components {
2247
1896
  * contact
2248
1897
  */
2249
1898
  EntitySlug;
2250
- /**
2251
- * Title of entity
2252
- */
2253
- _title: string | null;
2254
- _tags?: string[] | null;
2255
- _created_at: string | null; // date-time
2256
- _updated_at: string | null; // date-time
1899
+ _tags?: string[];
1900
+ _created_at: string; // date-time
1901
+ _updated_at: string; // date-time
2257
1902
  }
2258
1903
  /**
2259
1904
  * No UI representation
@@ -2273,21 +1918,10 @@ declare namespace Components {
2273
1918
  required?: boolean;
2274
1919
  readonly?: boolean;
2275
1920
  deprecated?: boolean;
2276
- default_value?: any;
2277
- /**
2278
- * Which group the attribute should appear in. Accepts group ID or group name
2279
- */
1921
+ default_value?: string | {
1922
+ [name: string]: any;
1923
+ } | number | number | boolean | any[];
2280
1924
  group?: string;
2281
- /**
2282
- * Attribute sort order (ascending) in group
2283
- * example:
2284
- * 0
2285
- */
2286
- order?: number;
2287
- /**
2288
- * example:
2289
- * full_width
2290
- */
2291
1925
  layout?: string;
2292
1926
  /**
2293
1927
  * When set to true, will hide the label of the field.
@@ -2306,7 +1940,6 @@ declare namespace Components {
2306
1940
  *
2307
1941
  */
2308
1942
  render_condition?: string;
2309
- _purpose?: ClassificationId /* uuid */[];
2310
1943
  /**
2311
1944
  * A set of constraints applicable to the attribute.
2312
1945
  * These constraints should and will be enforced by the attribute renderer.
@@ -2361,21 +1994,10 @@ declare namespace Components {
2361
1994
  required?: boolean;
2362
1995
  readonly?: boolean;
2363
1996
  deprecated?: boolean;
2364
- default_value?: any;
2365
- /**
2366
- * Which group the attribute should appear in. Accepts group ID or group name
2367
- */
1997
+ default_value?: string | {
1998
+ [name: string]: any;
1999
+ } | number | number | boolean | any[];
2368
2000
  group?: string;
2369
- /**
2370
- * Attribute sort order (ascending) in group
2371
- * example:
2372
- * 0
2373
- */
2374
- order?: number;
2375
- /**
2376
- * example:
2377
- * full_width
2378
- */
2379
2001
  layout?: string;
2380
2002
  /**
2381
2003
  * When set to true, will hide the label of the field.
@@ -2394,7 +2016,6 @@ declare namespace Components {
2394
2016
  *
2395
2017
  */
2396
2018
  render_condition?: string;
2397
- _purpose?: ClassificationId /* uuid */[];
2398
2019
  /**
2399
2020
  * A set of constraints applicable to the attribute.
2400
2021
  * These constraints should and will be enforced by the attribute renderer.
@@ -2449,21 +2070,10 @@ declare namespace Components {
2449
2070
  required?: boolean;
2450
2071
  readonly?: boolean;
2451
2072
  deprecated?: boolean;
2452
- default_value?: any;
2453
- /**
2454
- * Which group the attribute should appear in. Accepts group ID or group name
2455
- */
2073
+ default_value?: string | {
2074
+ [name: string]: any;
2075
+ } | number | number | boolean | any[];
2456
2076
  group?: string;
2457
- /**
2458
- * Attribute sort order (ascending) in group
2459
- * example:
2460
- * 0
2461
- */
2462
- order?: number;
2463
- /**
2464
- * example:
2465
- * full_width
2466
- */
2467
2077
  layout?: string;
2468
2078
  /**
2469
2079
  * When set to true, will hide the label of the field.
@@ -2482,7 +2092,6 @@ declare namespace Components {
2482
2092
  *
2483
2093
  */
2484
2094
  render_condition?: string;
2485
- _purpose?: ClassificationId /* uuid */[];
2486
2095
  /**
2487
2096
  * A set of constraints applicable to the attribute.
2488
2097
  * These constraints should and will be enforced by the attribute renderer.
@@ -2519,14 +2128,6 @@ declare namespace Components {
2519
2128
  protected?: boolean;
2520
2129
  type?: "invitation_email";
2521
2130
  }
2522
- /**
2523
- * Pass 'true' to generate import template
2524
- */
2525
- export type IsTemplate = boolean;
2526
- /**
2527
- * Export headers translation Language
2528
- */
2529
- export type Language = string;
2530
2131
  /**
2531
2132
  * Link with title and href
2532
2133
  */
@@ -2545,21 +2146,10 @@ declare namespace Components {
2545
2146
  required?: boolean;
2546
2147
  readonly?: boolean;
2547
2148
  deprecated?: boolean;
2548
- default_value?: any;
2549
- /**
2550
- * Which group the attribute should appear in. Accepts group ID or group name
2551
- */
2149
+ default_value?: string | {
2150
+ [name: string]: any;
2151
+ } | number | number | boolean | any[];
2552
2152
  group?: string;
2553
- /**
2554
- * Attribute sort order (ascending) in group
2555
- * example:
2556
- * 0
2557
- */
2558
- order?: number;
2559
- /**
2560
- * example:
2561
- * full_width
2562
- */
2563
2153
  layout?: string;
2564
2154
  /**
2565
2155
  * When set to true, will hide the label of the field.
@@ -2578,7 +2168,6 @@ declare namespace Components {
2578
2168
  *
2579
2169
  */
2580
2170
  render_condition?: string;
2581
- _purpose?: ClassificationId /* uuid */[];
2582
2171
  /**
2583
2172
  * A set of constraints applicable to the attribute.
2584
2173
  * These constraints should and will be enforced by the attribute renderer.
@@ -2633,21 +2222,10 @@ declare namespace Components {
2633
2222
  required?: boolean;
2634
2223
  readonly?: boolean;
2635
2224
  deprecated?: boolean;
2636
- default_value?: any;
2637
- /**
2638
- * Which group the attribute should appear in. Accepts group ID or group name
2639
- */
2225
+ default_value?: string | {
2226
+ [name: string]: any;
2227
+ } | number | number | boolean | any[];
2640
2228
  group?: string;
2641
- /**
2642
- * Attribute sort order (ascending) in group
2643
- * example:
2644
- * 0
2645
- */
2646
- order?: number;
2647
- /**
2648
- * example:
2649
- * full_width
2650
- */
2651
2229
  layout?: string;
2652
2230
  /**
2653
2231
  * When set to true, will hide the label of the field.
@@ -2666,7 +2244,6 @@ declare namespace Components {
2666
2244
  *
2667
2245
  */
2668
2246
  render_condition?: string;
2669
- _purpose?: ClassificationId /* uuid */[];
2670
2247
  /**
2671
2248
  * A set of constraints applicable to the attribute.
2672
2249
  * These constraints should and will be enforced by the attribute renderer.
@@ -2737,21 +2314,10 @@ declare namespace Components {
2737
2314
  required?: boolean;
2738
2315
  readonly?: boolean;
2739
2316
  deprecated?: boolean;
2740
- default_value?: any;
2741
- /**
2742
- * Which group the attribute should appear in. Accepts group ID or group name
2743
- */
2317
+ default_value?: string | {
2318
+ [name: string]: any;
2319
+ } | number | number | boolean | any[];
2744
2320
  group?: string;
2745
- /**
2746
- * Attribute sort order (ascending) in group
2747
- * example:
2748
- * 0
2749
- */
2750
- order?: number;
2751
- /**
2752
- * example:
2753
- * full_width
2754
- */
2755
2321
  layout?: string;
2756
2322
  /**
2757
2323
  * When set to true, will hide the label of the field.
@@ -2770,7 +2336,6 @@ declare namespace Components {
2770
2336
  *
2771
2337
  */
2772
2338
  render_condition?: string;
2773
- _purpose?: ClassificationId /* uuid */[];
2774
2339
  /**
2775
2340
  * A set of constraints applicable to the attribute.
2776
2341
  * These constraints should and will be enforced by the attribute renderer.
@@ -2826,21 +2391,10 @@ declare namespace Components {
2826
2391
  required?: boolean;
2827
2392
  readonly?: boolean;
2828
2393
  deprecated?: boolean;
2829
- default_value?: any;
2830
- /**
2831
- * Which group the attribute should appear in. Accepts group ID or group name
2832
- */
2394
+ default_value?: string | {
2395
+ [name: string]: any;
2396
+ } | number | number | boolean | any[];
2833
2397
  group?: string;
2834
- /**
2835
- * Attribute sort order (ascending) in group
2836
- * example:
2837
- * 0
2838
- */
2839
- order?: number;
2840
- /**
2841
- * example:
2842
- * full_width
2843
- */
2844
2398
  layout?: string;
2845
2399
  /**
2846
2400
  * When set to true, will hide the label of the field.
@@ -2859,7 +2413,6 @@ declare namespace Components {
2859
2413
  *
2860
2414
  */
2861
2415
  render_condition?: string;
2862
- _purpose?: ClassificationId /* uuid */[];
2863
2416
  /**
2864
2417
  * A set of constraints applicable to the attribute.
2865
2418
  * These constraints should and will be enforced by the attribute renderer.
@@ -2914,21 +2467,10 @@ declare namespace Components {
2914
2467
  required?: boolean;
2915
2468
  readonly?: boolean;
2916
2469
  deprecated?: boolean;
2917
- default_value?: any;
2918
- /**
2919
- * Which group the attribute should appear in. Accepts group ID or group name
2920
- */
2470
+ default_value?: string | {
2471
+ [name: string]: any;
2472
+ } | number | number | boolean | any[];
2921
2473
  group?: string;
2922
- /**
2923
- * Attribute sort order (ascending) in group
2924
- * example:
2925
- * 0
2926
- */
2927
- order?: number;
2928
- /**
2929
- * example:
2930
- * full_width
2931
- */
2932
2474
  layout?: string;
2933
2475
  /**
2934
2476
  * When set to true, will hide the label of the field.
@@ -2947,7 +2489,6 @@ declare namespace Components {
2947
2489
  *
2948
2490
  */
2949
2491
  render_condition?: string;
2950
- _purpose?: ClassificationId /* uuid */[];
2951
2492
  /**
2952
2493
  * A set of constraints applicable to the attribute.
2953
2494
  * These constraints should and will be enforced by the attribute renderer.
@@ -3002,21 +2543,10 @@ declare namespace Components {
3002
2543
  required?: boolean;
3003
2544
  readonly?: boolean;
3004
2545
  deprecated?: boolean;
3005
- default_value?: any;
3006
- /**
3007
- * Which group the attribute should appear in. Accepts group ID or group name
3008
- */
2546
+ default_value?: string | {
2547
+ [name: string]: any;
2548
+ } | number | number | boolean | any[];
3009
2549
  group?: string;
3010
- /**
3011
- * Attribute sort order (ascending) in group
3012
- * example:
3013
- * 0
3014
- */
3015
- order?: number;
3016
- /**
3017
- * example:
3018
- * full_width
3019
- */
3020
2550
  layout?: string;
3021
2551
  /**
3022
2552
  * When set to true, will hide the label of the field.
@@ -3035,7 +2565,6 @@ declare namespace Components {
3035
2565
  *
3036
2566
  */
3037
2567
  render_condition?: string;
3038
- _purpose?: ClassificationId /* uuid */[];
3039
2568
  /**
3040
2569
  * A set of constraints applicable to the attribute.
3041
2570
  * These constraints should and will be enforced by the attribute renderer.
@@ -3073,102 +2602,6 @@ declare namespace Components {
3073
2602
  type?: "relation_payment_method";
3074
2603
  has_primary?: boolean;
3075
2604
  }
3076
- /**
3077
- * Entity Taxonomy
3078
- */
3079
- export interface PurposeAttribute {
3080
- /**
3081
- * example:
3082
- * Wallbox PV
3083
- */
3084
- name: string;
3085
- label: string;
3086
- placeholder?: string;
3087
- /**
3088
- * Do not render attribute in entity views
3089
- */
3090
- hidden?: boolean;
3091
- /**
3092
- * Render as a column in table views. When defined, overrides `hidden`
3093
- */
3094
- show_in_table?: boolean;
3095
- required?: boolean;
3096
- readonly?: boolean;
3097
- deprecated?: boolean;
3098
- default_value?: any;
3099
- /**
3100
- * Which group the attribute should appear in. Accepts group ID or group name
3101
- */
3102
- group?: string;
3103
- /**
3104
- * Attribute sort order (ascending) in group
3105
- * example:
3106
- * 0
3107
- */
3108
- order?: number;
3109
- /**
3110
- * example:
3111
- * full_width
3112
- */
3113
- layout?: string;
3114
- /**
3115
- * When set to true, will hide the label of the field.
3116
- */
3117
- hide_label?: boolean;
3118
- /**
3119
- * Code name of the icon to used to represent this attribute.
3120
- * The value must be a valid @epilot/base-elements Icon name
3121
- *
3122
- */
3123
- icon?: string;
3124
- /**
3125
- * Defines the conditional rendering expression for showing this field.
3126
- * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
3127
- * Note: Empty or invalid expression have no effect on the field visibility.
3128
- *
3129
- */
3130
- render_condition?: string;
3131
- _purpose?: ClassificationId /* uuid */[];
3132
- /**
3133
- * A set of constraints applicable to the attribute.
3134
- * These constraints should and will be enforced by the attribute renderer.
3135
- *
3136
- * example:
3137
- * {
3138
- * "disablePast": true
3139
- * }
3140
- */
3141
- constraints?: {
3142
- [key: string]: any;
3143
- };
3144
- /**
3145
- * This attribute should only be active when the feature flag is enabled
3146
- * example:
3147
- * FF_MY_FEATURE_FLAG
3148
- */
3149
- feature_flag?: string;
3150
- /**
3151
- * This attribute should only be active when the setting is enabled
3152
- * example:
3153
- * MY_SETTING
3154
- */
3155
- setting_flag?: string;
3156
- value_formatter?: string;
3157
- preview_value_formatter?: string;
3158
- /**
3159
- * Setting to `true` disables editing the attribute on the entity builder UI
3160
- */
3161
- entity_builder_disable_edit?: boolean;
3162
- /**
3163
- * Setting to `true` prevents the attribute from being modified / deleted
3164
- */
3165
- protected?: boolean;
3166
- id?: ClassificationId /* uuid */;
3167
- parents?: ClassificationId /* uuid */[];
3168
- created_at?: string; // date-time
3169
- updated_at?: string; // date-time
3170
- type?: "purpose";
3171
- }
3172
2605
  /**
3173
2606
  * example:
3174
2607
  * {
@@ -3202,21 +2635,10 @@ declare namespace Components {
3202
2635
  required?: boolean;
3203
2636
  readonly?: boolean;
3204
2637
  deprecated?: boolean;
3205
- default_value?: any;
3206
- /**
3207
- * Which group the attribute should appear in. Accepts group ID or group name
3208
- */
2638
+ default_value?: string | {
2639
+ [name: string]: any;
2640
+ } | number | number | boolean | any[];
3209
2641
  group?: string;
3210
- /**
3211
- * Attribute sort order (ascending) in group
3212
- * example:
3213
- * 0
3214
- */
3215
- order?: number;
3216
- /**
3217
- * example:
3218
- * full_width
3219
- */
3220
2642
  layout?: string;
3221
2643
  /**
3222
2644
  * When set to true, will hide the label of the field.
@@ -3235,7 +2657,6 @@ declare namespace Components {
3235
2657
  *
3236
2658
  */
3237
2659
  render_condition?: string;
3238
- _purpose?: ClassificationId /* uuid */[];
3239
2660
  /**
3240
2661
  * A set of constraints applicable to the attribute.
3241
2662
  * These constraints should and will be enforced by the attribute renderer.
@@ -3272,20 +2693,7 @@ declare namespace Components {
3272
2693
  protected?: boolean;
3273
2694
  type?: "relation";
3274
2695
  relation_type?: "has_many" | "has_one";
3275
- /**
3276
- * Map of schema slug to target relation attribute
3277
- * example:
3278
- * {
3279
- * "contact": "account",
3280
- * "opportunity": "customer"
3281
- * }
3282
- */
3283
- reverse_attributes?: {
3284
- [name: string]: string;
3285
- };
3286
- /**
3287
- * Weak relation attributes are kept when duplicating an entity. Strong relation attributes are discarded when duplicating an entity.
3288
- */
2696
+ delete_mode?: "cascade";
3289
2697
  relation_affinity_mode?: "weak" | "strong";
3290
2698
  /**
3291
2699
  * When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
@@ -3352,8 +2760,6 @@ declare namespace Components {
3352
2760
  * "_schema": "contact",
3353
2761
  * "_tags": [
3354
2762
  * "example",
3355
- * "mock",
3356
- * "example",
3357
2763
  * "mock"
3358
2764
  * ],
3359
2765
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -3363,6 +2769,10 @@ declare namespace Components {
3363
2769
  new_entity_item?: {
3364
2770
  [name: string]: any;
3365
2771
  _id: EntityId /* uuid */;
2772
+ /**
2773
+ * Title of entity
2774
+ */
2775
+ _title: string;
3366
2776
  /**
3367
2777
  * Organization Id the entity belongs to
3368
2778
  */
@@ -3373,13 +2783,9 @@ declare namespace Components {
3373
2783
  * contact
3374
2784
  */
3375
2785
  EntitySlug;
3376
- /**
3377
- * Title of entity
3378
- */
3379
- _title: string | null;
3380
- _tags?: string[] | null;
3381
- _created_at: string | null; // date-time
3382
- _updated_at: string | null; // date-time
2786
+ _tags?: string[];
2787
+ _created_at: string; // date-time
2788
+ _updated_at: string; // date-time
3383
2789
  };
3384
2790
  }[];
3385
2791
  drawer_size?: "small" | "medium" | "large";
@@ -3395,14 +2801,6 @@ declare namespace Components {
3395
2801
  * When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.
3396
2802
  */
3397
2803
  enable_relation_tags?: boolean;
3398
- /**
3399
- * Optional label for the add button. The translated value for add_button_lable is used, if found else the string is used as is.
3400
- */
3401
- add_button_label?: string;
3402
- /**
3403
- * Optional placeholder text for the relation search input. The translated value for search_placeholder is used, if found else the string is used as is.
3404
- */
3405
- search_placeholder?: string;
3406
2804
  }
3407
2805
  /**
3408
2806
  * example:
@@ -3419,8 +2817,11 @@ declare namespace Components {
3419
2817
  * }
3420
2818
  */
3421
2819
  export interface RelationEntity {
3422
- [name: string]: any;
3423
2820
  _id: EntityId /* uuid */;
2821
+ /**
2822
+ * Title of entity
2823
+ */
2824
+ _title: string;
3424
2825
  /**
3425
2826
  * Organization Id the entity belongs to
3426
2827
  */
@@ -3431,23 +2832,15 @@ declare namespace Components {
3431
2832
  * contact
3432
2833
  */
3433
2834
  EntitySlug;
3434
- /**
3435
- * Title of entity
3436
- */
3437
- _title: string | null;
3438
- _tags?: string[] | null;
3439
- _created_at: string | null; // date-time
3440
- _updated_at: string | null; // date-time
2835
+ _tags?: string[];
2836
+ _created_at: string; // date-time
2837
+ _updated_at: string; // date-time
3441
2838
  $relation?: RelationItem;
3442
2839
  }
3443
2840
  export interface RelationItem {
3444
2841
  entity_id: EntityId /* uuid */;
3445
2842
  attribute: string;
3446
2843
  _tags?: string[];
3447
- /**
3448
- * Whether this is a reverse relation
3449
- */
3450
- reverse?: boolean;
3451
2844
  }
3452
2845
  /**
3453
2846
  * Repeatable (add N number of fields)
@@ -3467,21 +2860,10 @@ declare namespace Components {
3467
2860
  required?: boolean;
3468
2861
  readonly?: boolean;
3469
2862
  deprecated?: boolean;
3470
- default_value?: any;
3471
- /**
3472
- * Which group the attribute should appear in. Accepts group ID or group name
3473
- */
2863
+ default_value?: string | {
2864
+ [name: string]: any;
2865
+ } | number | number | boolean | any[];
3474
2866
  group?: string;
3475
- /**
3476
- * Attribute sort order (ascending) in group
3477
- * example:
3478
- * 0
3479
- */
3480
- order?: number;
3481
- /**
3482
- * example:
3483
- * full_width
3484
- */
3485
2867
  layout?: string;
3486
2868
  /**
3487
2869
  * When set to true, will hide the label of the field.
@@ -3500,7 +2882,6 @@ declare namespace Components {
3500
2882
  *
3501
2883
  */
3502
2884
  render_condition?: string;
3503
- _purpose?: ClassificationId /* uuid */[];
3504
2885
  /**
3505
2886
  * A set of constraints applicable to the attribute.
3506
2887
  * These constraints should and will be enforced by the attribute renderer.
@@ -3537,9 +2918,6 @@ declare namespace Components {
3537
2918
  protected?: boolean;
3538
2919
  repeatable?: boolean;
3539
2920
  has_primary?: boolean;
3540
- /**
3541
- * Weak repeatable attributes are kept when duplicating an entity. Strong repeatable attributes are discarded when duplicating an entity.
3542
- */
3543
2921
  relation_affinity_mode?: "weak" | "strong";
3544
2922
  type?: "string" | "phone" | "email" | "address" | "relation" | "payment" | "price_component" | "date";
3545
2923
  /**
@@ -3547,137 +2925,6 @@ declare namespace Components {
3547
2925
  */
3548
2926
  enable_relation_picker?: boolean;
3549
2927
  }
3550
- /**
3551
- * A saved entity view
3552
- */
3553
- export interface SavedView {
3554
- /**
3555
- * list of schemas a view can belong to
3556
- */
3557
- slug: /**
3558
- * URL-friendly identifier for the entity schema
3559
- * example:
3560
- * contact
3561
- */
3562
- EntitySlug[];
3563
- /**
3564
- * User-friendly identifier for the saved view
3565
- * example:
3566
- * View listing German
3567
- */
3568
- name: string;
3569
- /**
3570
- * Organisation ID a view belongs to
3571
- * example:
3572
- * 66
3573
- */
3574
- org?: string;
3575
- /**
3576
- * boolean property for if a view is shared with organisation
3577
- * example:
3578
- * true
3579
- */
3580
- shared?: boolean;
3581
- created_by: {
3582
- /**
3583
- * example:
3584
- * 10598
3585
- */
3586
- user_id?: string;
3587
- } | {
3588
- [name: string]: any;
3589
- source?: "SYSTEM" | "BLUEPRINT";
3590
- };
3591
- /**
3592
- * example:
3593
- * {
3594
- * "filters": {
3595
- * "customer_name": "suresh test",
3596
- * "_tags": "360"
3597
- * },
3598
- * "table_layout": {
3599
- * "opportunity": {
3600
- * "page": 1,
3601
- * "sort": "_created_at:desc",
3602
- * "pageSize": 25,
3603
- * "columnSettings": []
3604
- * }
3605
- * }
3606
- * }
3607
- */
3608
- ui_config: {
3609
- [name: string]: any;
3610
- };
3611
- }
3612
- /**
3613
- * Generated uuid for a saved view
3614
- */
3615
- export type SavedViewId = string; // uuid
3616
- /**
3617
- * A saved entity view
3618
- */
3619
- export interface SavedViewItem {
3620
- id?: /* Generated uuid for a saved view */ SavedViewId /* uuid */;
3621
- created_at?: string;
3622
- updated_at?: string;
3623
- /**
3624
- * list of schemas a view can belong to
3625
- */
3626
- slug: /**
3627
- * URL-friendly identifier for the entity schema
3628
- * example:
3629
- * contact
3630
- */
3631
- EntitySlug[];
3632
- /**
3633
- * User-friendly identifier for the saved view
3634
- * example:
3635
- * View listing German
3636
- */
3637
- name: string;
3638
- /**
3639
- * Organisation ID a view belongs to
3640
- * example:
3641
- * 66
3642
- */
3643
- org?: string;
3644
- /**
3645
- * boolean property for if a view is shared with organisation
3646
- * example:
3647
- * true
3648
- */
3649
- shared?: boolean;
3650
- created_by: {
3651
- /**
3652
- * example:
3653
- * 10598
3654
- */
3655
- user_id?: string;
3656
- } | {
3657
- [name: string]: any;
3658
- source?: "SYSTEM" | "BLUEPRINT";
3659
- };
3660
- /**
3661
- * example:
3662
- * {
3663
- * "filters": {
3664
- * "customer_name": "suresh test",
3665
- * "_tags": "360"
3666
- * },
3667
- * "table_layout": {
3668
- * "opportunity": {
3669
- * "page": 1,
3670
- * "sort": "_created_at:desc",
3671
- * "pageSize": 25,
3672
- * "columnSettings": []
3673
- * }
3674
- * }
3675
- * }
3676
- */
3677
- ui_config: {
3678
- [name: string]: any;
3679
- };
3680
- }
3681
2928
  /**
3682
2929
  * Generated uuid for schema
3683
2930
  */
@@ -3720,21 +2967,10 @@ declare namespace Components {
3720
2967
  required?: boolean;
3721
2968
  readonly?: boolean;
3722
2969
  deprecated?: boolean;
3723
- default_value?: any;
3724
- /**
3725
- * Which group the attribute should appear in. Accepts group ID or group name
3726
- */
2970
+ default_value?: string | {
2971
+ [name: string]: any;
2972
+ } | number | number | boolean | any[];
3727
2973
  group?: string;
3728
- /**
3729
- * Attribute sort order (ascending) in group
3730
- * example:
3731
- * 0
3732
- */
3733
- order?: number;
3734
- /**
3735
- * example:
3736
- * full_width
3737
- */
3738
2974
  layout?: string;
3739
2975
  /**
3740
2976
  * When set to true, will hide the label of the field.
@@ -3753,7 +2989,6 @@ declare namespace Components {
3753
2989
  *
3754
2990
  */
3755
2991
  render_condition?: string;
3756
- _purpose?: ClassificationId /* uuid */[];
3757
2992
  /**
3758
2993
  * A set of constraints applicable to the attribute.
3759
2994
  * These constraints should and will be enforced by the attribute renderer.
@@ -3789,10 +3024,10 @@ declare namespace Components {
3789
3024
  */
3790
3025
  protected?: boolean;
3791
3026
  type?: "select" | "radio";
3792
- options?: ({
3027
+ options?: ((string | null) | {
3793
3028
  value: string;
3794
3029
  title?: string;
3795
- } | (string | null))[];
3030
+ })[];
3796
3031
  /**
3797
3032
  * Allow arbitrary input values in addition to provided options
3798
3033
  */
@@ -3816,21 +3051,10 @@ declare namespace Components {
3816
3051
  required?: boolean;
3817
3052
  readonly?: boolean;
3818
3053
  deprecated?: boolean;
3819
- default_value?: any;
3820
- /**
3821
- * Which group the attribute should appear in. Accepts group ID or group name
3822
- */
3054
+ default_value?: string | {
3055
+ [name: string]: any;
3056
+ } | number | number | boolean | any[];
3823
3057
  group?: string;
3824
- /**
3825
- * Attribute sort order (ascending) in group
3826
- * example:
3827
- * 0
3828
- */
3829
- order?: number;
3830
- /**
3831
- * example:
3832
- * full_width
3833
- */
3834
3058
  layout?: string;
3835
3059
  /**
3836
3060
  * When set to true, will hide the label of the field.
@@ -3849,7 +3073,6 @@ declare namespace Components {
3849
3073
  *
3850
3074
  */
3851
3075
  render_condition?: string;
3852
- _purpose?: ClassificationId /* uuid */[];
3853
3076
  /**
3854
3077
  * A set of constraints applicable to the attribute.
3855
3078
  * These constraints should and will be enforced by the attribute renderer.
@@ -3911,21 +3134,10 @@ declare namespace Components {
3911
3134
  required?: boolean;
3912
3135
  readonly?: boolean;
3913
3136
  deprecated?: boolean;
3914
- default_value?: any;
3915
- /**
3916
- * Which group the attribute should appear in. Accepts group ID or group name
3917
- */
3137
+ default_value?: string | {
3138
+ [name: string]: any;
3139
+ } | number | number | boolean | any[];
3918
3140
  group?: string;
3919
- /**
3920
- * Attribute sort order (ascending) in group
3921
- * example:
3922
- * 0
3923
- */
3924
- order?: number;
3925
- /**
3926
- * example:
3927
- * full_width
3928
- */
3929
3141
  layout?: string;
3930
3142
  /**
3931
3143
  * When set to true, will hide the label of the field.
@@ -3944,7 +3156,6 @@ declare namespace Components {
3944
3156
  *
3945
3157
  */
3946
3158
  render_condition?: string;
3947
- _purpose?: ClassificationId /* uuid */[];
3948
3159
  /**
3949
3160
  * A set of constraints applicable to the attribute.
3950
3161
  * These constraints should and will be enforced by the attribute renderer.
@@ -4063,21 +3274,10 @@ declare namespace Components {
4063
3274
  required?: boolean;
4064
3275
  readonly?: boolean;
4065
3276
  deprecated?: boolean;
4066
- default_value?: any;
4067
- /**
4068
- * Which group the attribute should appear in. Accepts group ID or group name
4069
- */
3277
+ default_value?: string | {
3278
+ [name: string]: any;
3279
+ } | number | number | boolean | any[];
4070
3280
  group?: string;
4071
- /**
4072
- * Attribute sort order (ascending) in group
4073
- * example:
4074
- * 0
4075
- */
4076
- order?: number;
4077
- /**
4078
- * example:
4079
- * full_width
4080
- */
4081
3281
  layout?: string;
4082
3282
  /**
4083
3283
  * When set to true, will hide the label of the field.
@@ -4096,7 +3296,6 @@ declare namespace Components {
4096
3296
  *
4097
3297
  */
4098
3298
  render_condition?: string;
4099
- _purpose?: ClassificationId /* uuid */[];
4100
3299
  /**
4101
3300
  * A set of constraints applicable to the attribute.
4102
3301
  * These constraints should and will be enforced by the attribute renderer.
@@ -4135,45 +3334,6 @@ declare namespace Components {
4135
3334
  options?: string[];
4136
3335
  suggestions?: string[];
4137
3336
  }
4138
- export interface Taxonomy {
4139
- slug: /**
4140
- * URL-friendly name for taxonomy
4141
- * example:
4142
- * purpose
4143
- */
4144
- TaxonomySlug;
4145
- /**
4146
- * A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag
4147
- * example:
4148
- * Purpose
4149
- */
4150
- name: string;
4151
- /**
4152
- * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags
4153
- * example:
4154
- * Purposes
4155
- */
4156
- plural?: string;
4157
- created_at?: string; // date-time
4158
- updated_at?: string; // date-time
4159
- }
4160
- export interface TaxonomyClassification {
4161
- id?: ClassificationId /* uuid */;
4162
- /**
4163
- * example:
4164
- * Wallbox PV
4165
- */
4166
- name: string;
4167
- parents?: ClassificationId /* uuid */[];
4168
- created_at?: string; // date-time
4169
- updated_at?: string; // date-time
4170
- }
4171
- /**
4172
- * URL-friendly name for taxonomy
4173
- * example:
4174
- * purpose
4175
- */
4176
- export type TaxonomySlug = string;
4177
3337
  /**
4178
3338
  * Textarea or text input
4179
3339
  */
@@ -4192,21 +3352,10 @@ declare namespace Components {
4192
3352
  required?: boolean;
4193
3353
  readonly?: boolean;
4194
3354
  deprecated?: boolean;
4195
- default_value?: any;
4196
- /**
4197
- * Which group the attribute should appear in. Accepts group ID or group name
4198
- */
3355
+ default_value?: string | {
3356
+ [name: string]: any;
3357
+ } | number | number | boolean | any[];
4199
3358
  group?: string;
4200
- /**
4201
- * Attribute sort order (ascending) in group
4202
- * example:
4203
- * 0
4204
- */
4205
- order?: number;
4206
- /**
4207
- * example:
4208
- * full_width
4209
- */
4210
3359
  layout?: string;
4211
3360
  /**
4212
3361
  * When set to true, will hide the label of the field.
@@ -4225,7 +3374,6 @@ declare namespace Components {
4225
3374
  *
4226
3375
  */
4227
3376
  render_condition?: string;
4228
- _purpose?: ClassificationId /* uuid */[];
4229
3377
  /**
4230
3378
  * A set of constraints applicable to the attribute.
4231
3379
  * These constraints should and will be enforced by the attribute renderer.
@@ -4281,21 +3429,10 @@ declare namespace Components {
4281
3429
  required?: boolean;
4282
3430
  readonly?: boolean;
4283
3431
  deprecated?: boolean;
4284
- default_value?: any;
4285
- /**
4286
- * Which group the attribute should appear in. Accepts group ID or group name
4287
- */
3432
+ default_value?: string | {
3433
+ [name: string]: any;
3434
+ } | number | number | boolean | any[];
4288
3435
  group?: string;
4289
- /**
4290
- * Attribute sort order (ascending) in group
4291
- * example:
4292
- * 0
4293
- */
4294
- order?: number;
4295
- /**
4296
- * example:
4297
- * full_width
4298
- */
4299
3436
  layout?: string;
4300
3437
  /**
4301
3438
  * When set to true, will hide the label of the field.
@@ -4314,7 +3451,6 @@ declare namespace Components {
4314
3451
  *
4315
3452
  */
4316
3453
  render_condition?: string;
4317
- _purpose?: ClassificationId /* uuid */[];
4318
3454
  /**
4319
3455
  * A set of constraints applicable to the attribute.
4320
3456
  * These constraints should and will be enforced by the attribute renderer.
@@ -4357,7 +3493,6 @@ declare namespace Components {
4357
3493
  declare namespace Paths {
4358
3494
  namespace AddRelations {
4359
3495
  namespace Parameters {
4360
- export type Async = boolean;
4361
3496
  export type Id = Components.Schemas.EntityId /* uuid */;
4362
3497
  export type Slug = /**
4363
3498
  * URL-friendly identifier for the entity schema
@@ -4370,9 +3505,6 @@ declare namespace Paths {
4370
3505
  slug: Parameters.Slug;
4371
3506
  id: Parameters.Id;
4372
3507
  }
4373
- export interface QueryParameters {
4374
- async?: Parameters.Async;
4375
- }
4376
3508
  export type RequestBody = Components.Schemas.RelationItem[];
4377
3509
  namespace Responses {
4378
3510
  export type $200 = Components.Schemas.RelationItem;
@@ -4463,7 +3595,6 @@ declare namespace Paths {
4463
3595
  * 01F130Q52Q6MWSNS8N2AVXV4JN
4464
3596
  */
4465
3597
  Components.Schemas.ActivityId /* ulid */;
4466
- export type Async = boolean;
4467
3598
  export type Slug = /**
4468
3599
  * URL-friendly identifier for the entity schema
4469
3600
  * example:
@@ -4476,23 +3607,8 @@ declare namespace Paths {
4476
3607
  }
4477
3608
  export interface QueryParameters {
4478
3609
  activity_id?: Parameters.ActivityId;
4479
- async?: Parameters.Async;
4480
3610
  }
4481
- export type RequestBody = /**
4482
- * example:
4483
- * {
4484
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4485
- * "_org": "123",
4486
- * "_schema": "contact",
4487
- * "_tags": [
4488
- * "example",
4489
- * "mock"
4490
- * ],
4491
- * "_created_at": "2021-02-09T12:41:43.662Z",
4492
- * "_updated_at": "2021-02-09T12:41:43.662Z"
4493
- * }
4494
- */
4495
- Components.Schemas.Entity;
3611
+ export type RequestBody = Components.Schemas.Entity;
4496
3612
  namespace Responses {
4497
3613
  export type $201 = /**
4498
3614
  * example:
@@ -4502,8 +3618,6 @@ declare namespace Paths {
4502
3618
  * "_schema": "contact",
4503
3619
  * "_tags": [
4504
3620
  * "example",
4505
- * "mock",
4506
- * "example",
4507
3621
  * "mock"
4508
3622
  * ],
4509
3623
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -4513,10 +3627,25 @@ declare namespace Paths {
4513
3627
  Components.Schemas.EntityItem;
4514
3628
  }
4515
3629
  }
4516
- namespace CreateSavedView {
4517
- export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
3630
+ namespace CreateNewSchemaVersion {
3631
+ namespace Parameters {
3632
+ export type Draft = boolean;
3633
+ export type Slug = /**
3634
+ * URL-friendly identifier for the entity schema
3635
+ * example:
3636
+ * contact
3637
+ */
3638
+ Components.Schemas.EntitySlug;
3639
+ }
3640
+ export interface PathParameters {
3641
+ slug: Parameters.Slug;
3642
+ }
3643
+ export interface QueryParameters {
3644
+ draft?: Parameters.Draft;
3645
+ }
3646
+ export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
4518
3647
  namespace Responses {
4519
- export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
3648
+ export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
4520
3649
  }
4521
3650
  }
4522
3651
  namespace DeleteEntity {
@@ -4549,7 +3678,6 @@ declare namespace Paths {
4549
3678
  }
4550
3679
  namespace DeleteRelation {
4551
3680
  namespace Parameters {
4552
- export type Async = boolean;
4553
3681
  export type Attribute = string;
4554
3682
  export type EntityId = string;
4555
3683
  export type Id = Components.Schemas.EntityId /* uuid */;
@@ -4566,28 +3694,14 @@ declare namespace Paths {
4566
3694
  attribute: Parameters.Attribute;
4567
3695
  entity_id: Parameters.EntityId;
4568
3696
  }
4569
- export interface QueryParameters {
4570
- async?: Parameters.Async;
4571
- }
4572
3697
  namespace Responses {
4573
3698
  export interface $204 {
4574
3699
  }
4575
3700
  }
4576
3701
  }
4577
- namespace DeleteSavedView {
4578
- namespace Parameters {
4579
- export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
4580
- }
4581
- export interface PathParameters {
4582
- id: Parameters.Id;
4583
- }
4584
- namespace Responses {
4585
- export interface $200 {
4586
- }
4587
- }
4588
- }
4589
- namespace DeleteSchema {
3702
+ namespace DeleteSchemaById {
4590
3703
  namespace Parameters {
3704
+ export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
4591
3705
  export type Slug = /**
4592
3706
  * URL-friendly identifier for the entity schema
4593
3707
  * example:
@@ -4598,6 +3712,9 @@ declare namespace Paths {
4598
3712
  export interface PathParameters {
4599
3713
  slug: Parameters.Slug;
4600
3714
  }
3715
+ export interface QueryParameters {
3716
+ id: Parameters.Id;
3717
+ }
4601
3718
  namespace Responses {
4602
3719
  export interface $204 {
4603
3720
  }
@@ -4605,14 +3722,10 @@ declare namespace Paths {
4605
3722
  }
4606
3723
  namespace ExportEntities {
4607
3724
  namespace Parameters {
4608
- export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
4609
3725
  export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
4610
- export type Language = /* Export headers translation Language */ Components.Schemas.Language;
4611
3726
  }
4612
3727
  export interface QueryParameters {
4613
3728
  job_id?: Parameters.JobId;
4614
- is_template?: Parameters.IsTemplate;
4615
- language?: Parameters.Language;
4616
3729
  }
4617
3730
  export type RequestBody = Components.Schemas.EntitySearchParams;
4618
3731
  namespace Responses {
@@ -4628,16 +3741,10 @@ declare namespace Paths {
4628
3741
  * 01F130Q52Q6MWSNS8N2AVXV4JN
4629
3742
  */
4630
3743
  Components.Schemas.ActivityId /* ulid */;
4631
- export type OperationsFrom = number;
4632
- export type OperationsSize = number;
4633
3744
  }
4634
3745
  export interface PathParameters {
4635
3746
  id: Parameters.Id;
4636
3747
  }
4637
- export interface QueryParameters {
4638
- operations_size?: Parameters.OperationsSize;
4639
- operations_from?: Parameters.OperationsFrom;
4640
- }
4641
3748
  namespace Responses {
4642
3749
  export type $200 = Components.Schemas.ActivityItem;
4643
3750
  }
@@ -4670,8 +3777,6 @@ declare namespace Paths {
4670
3777
  * "_schema": "contact",
4671
3778
  * "_tags": [
4672
3779
  * "example",
4673
- * "mock",
4674
- * "example",
4675
3780
  * "mock"
4676
3781
  * ],
4677
3782
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -4687,8 +3792,6 @@ declare namespace Paths {
4687
3792
  * "_schema": "contact",
4688
3793
  * "_tags": [
4689
3794
  * "example",
4690
- * "mock",
4691
- * "example",
4692
3795
  * "mock"
4693
3796
  * ],
4694
3797
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -4748,7 +3851,6 @@ declare namespace Paths {
4748
3851
  namespace Parameters {
4749
3852
  export type Hydrate = boolean;
4750
3853
  export type Id = Components.Schemas.EntityId /* uuid */;
4751
- export type IncludeReverse = boolean;
4752
3854
  export type Slug = /**
4753
3855
  * URL-friendly identifier for the entity schema
4754
3856
  * example:
@@ -4762,29 +3864,14 @@ declare namespace Paths {
4762
3864
  }
4763
3865
  export interface QueryParameters {
4764
3866
  hydrate?: Parameters.Hydrate;
4765
- include_reverse?: Parameters.IncludeReverse;
4766
3867
  }
4767
3868
  namespace Responses {
4768
3869
  export type $200 = Components.Schemas.GetRelationsResp;
4769
3870
  }
4770
3871
  }
4771
- namespace GetRelationsV2 {
3872
+ namespace GetSchema {
4772
3873
  namespace Parameters {
4773
- /**
4774
- * example:
4775
- * [
4776
- * "_id",
4777
- * "_schema",
4778
- * "_title"
4779
- * ]
4780
- */
4781
- export type Fields = string[];
4782
- export type From = number;
4783
- export type Hydrate = boolean;
4784
- export type Id = Components.Schemas.EntityId /* uuid */;
4785
- export type IncludeReverse = boolean;
4786
- export type Query = string;
4787
- export type Size = number;
3874
+ export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
4788
3875
  export type Slug = /**
4789
3876
  * URL-friendly identifier for the entity schema
4790
3877
  * example:
@@ -4794,62 +3881,15 @@ declare namespace Paths {
4794
3881
  }
4795
3882
  export interface PathParameters {
4796
3883
  slug: Parameters.Slug;
4797
- id: Parameters.Id;
4798
3884
  }
4799
3885
  export interface QueryParameters {
4800
- hydrate?: Parameters.Hydrate;
4801
- query?: Parameters.Query;
4802
- include_reverse?: Parameters.IncludeReverse;
4803
- from?: Parameters.From;
4804
- size?: Parameters.Size;
4805
- fields?: /**
4806
- * example:
4807
- * [
4808
- * "_id",
4809
- * "_schema",
4810
- * "_title"
4811
- * ]
4812
- */
4813
- Parameters.Fields;
3886
+ id?: Parameters.Id;
4814
3887
  }
4815
3888
  namespace Responses {
4816
- export type $200 = Components.Schemas.GetRelationsRespWithPagination;
3889
+ export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
4817
3890
  }
4818
3891
  }
4819
- namespace GetSavedView {
4820
- namespace Parameters {
4821
- export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
4822
- }
4823
- export interface PathParameters {
4824
- id: Parameters.Id;
4825
- }
4826
- namespace Responses {
4827
- export interface $200 {
4828
- view?: /* A saved entity view */ Components.Schemas.SavedViewItem;
4829
- }
4830
- }
4831
- }
4832
- namespace GetSchema {
4833
- namespace Parameters {
4834
- export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
4835
- export type Slug = /**
4836
- * URL-friendly identifier for the entity schema
4837
- * example:
4838
- * contact
4839
- */
4840
- Components.Schemas.EntitySlug;
4841
- }
4842
- export interface PathParameters {
4843
- slug: Parameters.Slug;
4844
- }
4845
- export interface QueryParameters {
4846
- id?: Parameters.Id;
4847
- }
4848
- namespace Responses {
4849
- export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
4850
- }
4851
- }
4852
- namespace GetSchemaVersions {
3892
+ namespace GetSchemaVersions {
4853
3893
  namespace Parameters {
4854
3894
  export type Slug = /**
4855
3895
  * URL-friendly identifier for the entity schema
@@ -4868,42 +3908,6 @@ declare namespace Paths {
4868
3908
  }
4869
3909
  }
4870
3910
  }
4871
- namespace GetTaxonomy {
4872
- namespace Parameters {
4873
- export type TaxonomySlug = /**
4874
- * URL-friendly name for taxonomy
4875
- * example:
4876
- * purpose
4877
- */
4878
- Components.Schemas.TaxonomySlug;
4879
- }
4880
- export interface PathParameters {
4881
- taxonomySlug: Parameters.TaxonomySlug;
4882
- }
4883
- namespace Responses {
4884
- export type $200 = Components.Schemas.Taxonomy;
4885
- }
4886
- }
4887
- namespace ImportEntities {
4888
- namespace Parameters {
4889
- export type JobId = /* Export Job Id to get the result */ Components.Schemas.ExportJobId;
4890
- }
4891
- export interface QueryParameters {
4892
- job_id?: Parameters.JobId;
4893
- }
4894
- export type RequestBody = Components.Schemas.EntityImportParams;
4895
- namespace Responses {
4896
- export interface $201 {
4897
- }
4898
- }
4899
- }
4900
- namespace ListSavedViews {
4901
- namespace Responses {
4902
- export interface $200 {
4903
- results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
4904
- }
4905
- }
4906
- }
4907
3911
  namespace ListSchemaBlueprints {
4908
3912
  namespace Responses {
4909
3913
  export interface $200 {
@@ -4924,188 +3928,12 @@ declare namespace Paths {
4924
3928
  }
4925
3929
  }
4926
3930
  }
4927
- namespace ListTaxonomies {
4928
- namespace Responses {
4929
- export interface $200 {
4930
- results?: Components.Schemas.Taxonomy[];
4931
- }
4932
- }
4933
- }
4934
- namespace ListTaxonomyClassificationsForSchema {
4935
- namespace Parameters {
4936
- export type Query = string;
4937
- export type Size = number;
4938
- export type Slug = /**
4939
- * URL-friendly identifier for the entity schema
4940
- * example:
4941
- * contact
4942
- */
4943
- Components.Schemas.EntitySlug;
4944
- export type TaxonomySlug = /**
4945
- * URL-friendly name for taxonomy
4946
- * example:
4947
- * purpose
4948
- */
4949
- Components.Schemas.TaxonomySlug;
4950
- }
4951
- export interface PathParameters {
4952
- slug: Parameters.Slug;
4953
- taxonomySlug: Parameters.TaxonomySlug;
4954
- }
4955
- export interface QueryParameters {
4956
- query?: Parameters.Query;
4957
- size?: Parameters.Size;
4958
- }
4959
- namespace Responses {
4960
- export interface $200 {
4961
- results?: Components.Schemas.TaxonomyClassification[];
4962
- }
4963
- }
4964
- }
4965
- namespace PatchEntity {
4966
- namespace Parameters {
4967
- export type ActivityId = /**
4968
- * See https://github.com/ulid/spec
4969
- * example:
4970
- * 01F130Q52Q6MWSNS8N2AVXV4JN
4971
- */
4972
- Components.Schemas.ActivityId /* ulid */;
4973
- export type Async = boolean;
4974
- export type DryRun = boolean;
4975
- export type Id = Components.Schemas.EntityId /* uuid */;
4976
- export type Slug = /**
4977
- * URL-friendly identifier for the entity schema
4978
- * example:
4979
- * contact
4980
- */
4981
- Components.Schemas.EntitySlug;
4982
- }
4983
- export interface PathParameters {
4984
- slug: Parameters.Slug;
4985
- id: Parameters.Id;
4986
- }
4987
- export interface QueryParameters {
4988
- activity_id?: Parameters.ActivityId;
4989
- dry_run?: Parameters.DryRun;
4990
- async?: Parameters.Async;
4991
- }
4992
- export type RequestBody = /**
4993
- * example:
4994
- * {
4995
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4996
- * "_org": "123",
4997
- * "_schema": "contact",
4998
- * "_tags": [
4999
- * "example",
5000
- * "mock"
5001
- * ],
5002
- * "_created_at": "2021-02-09T12:41:43.662Z",
5003
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5004
- * }
5005
- */
5006
- Components.Schemas.Entity;
5007
- namespace Responses {
5008
- export type $200 = /**
5009
- * example:
5010
- * {
5011
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5012
- * "_org": "123",
5013
- * "_schema": "contact",
5014
- * "_tags": [
5015
- * "example",
5016
- * "mock",
5017
- * "example",
5018
- * "mock"
5019
- * ],
5020
- * "_created_at": "2021-02-09T12:41:43.662Z",
5021
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5022
- * }
5023
- */
5024
- Components.Schemas.EntityItem;
5025
- export interface $409 {
5026
- }
5027
- }
5028
- }
5029
- namespace PutSchema {
5030
- namespace Parameters {
5031
- export type Draft = boolean;
5032
- export type Slug = /**
5033
- * URL-friendly identifier for the entity schema
5034
- * example:
5035
- * contact
5036
- */
5037
- Components.Schemas.EntitySlug;
5038
- }
5039
- export interface PathParameters {
5040
- slug: Parameters.Slug;
5041
- }
5042
- export interface QueryParameters {
5043
- draft?: Parameters.Draft;
5044
- }
5045
- export type RequestBody = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchema;
5046
- namespace Responses {
5047
- export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
5048
- }
5049
- }
5050
3931
  namespace SearchEntities {
5051
3932
  export type RequestBody = Components.Schemas.EntitySearchParams;
5052
3933
  namespace Responses {
5053
3934
  export type $200 = Components.Schemas.EntitySearchResults;
5054
3935
  }
5055
3936
  }
5056
- namespace TaxonomiesClassificationsSearch {
5057
- namespace Parameters {
5058
- export type TaxonomySlug = string;
5059
- }
5060
- export interface QueryParameters {
5061
- taxonomySlug: Parameters.TaxonomySlug;
5062
- }
5063
- export interface RequestBody {
5064
- classificationIds?: Components.Schemas.ClassificationId /* uuid */[];
5065
- }
5066
- namespace Responses {
5067
- export interface $200 {
5068
- results?: Components.Schemas.TaxonomyClassification[];
5069
- }
5070
- }
5071
- }
5072
- namespace TaxonomyAutocomplete {
5073
- namespace Parameters {
5074
- export type Query = string;
5075
- export type Size = number;
5076
- export type TaxonomySlug = string;
5077
- }
5078
- export interface PathParameters {
5079
- taxonomySlug: Parameters.TaxonomySlug;
5080
- }
5081
- export interface QueryParameters {
5082
- query?: Parameters.Query;
5083
- size?: Parameters.Size;
5084
- }
5085
- namespace Responses {
5086
- export interface $200 {
5087
- results?: Components.Schemas.TaxonomyClassification[];
5088
- }
5089
- }
5090
- }
5091
- namespace UpdateClassificationsForTaxonomy {
5092
- namespace Parameters {
5093
- export type TaxonomySlug = string;
5094
- }
5095
- export interface PathParameters {
5096
- taxonomySlug: Parameters.TaxonomySlug;
5097
- }
5098
- export type RequestBody = Components.Schemas.ClassificationsUpdate;
5099
- namespace Responses {
5100
- export interface $200 {
5101
- created?: Components.Schemas.TaxonomyClassification[];
5102
- updated?: Components.Schemas.TaxonomyClassification[];
5103
- deleted?: {
5104
- [key: string]: any;
5105
- };
5106
- }
5107
- }
5108
- }
5109
3937
  namespace UpdateEntity {
5110
3938
  namespace Parameters {
5111
3939
  export type ActivityId = /**
@@ -5114,7 +3942,6 @@ declare namespace Paths {
5114
3942
  * 01F130Q52Q6MWSNS8N2AVXV4JN
5115
3943
  */
5116
3944
  Components.Schemas.ActivityId /* ulid */;
5117
- export type Async = boolean;
5118
3945
  export type Id = Components.Schemas.EntityId /* uuid */;
5119
3946
  export type Slug = /**
5120
3947
  * URL-friendly identifier for the entity schema
@@ -5129,23 +3956,8 @@ declare namespace Paths {
5129
3956
  }
5130
3957
  export interface QueryParameters {
5131
3958
  activity_id?: Parameters.ActivityId;
5132
- async?: Parameters.Async;
5133
3959
  }
5134
- export type RequestBody = /**
5135
- * example:
5136
- * {
5137
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5138
- * "_org": "123",
5139
- * "_schema": "contact",
5140
- * "_tags": [
5141
- * "example",
5142
- * "mock"
5143
- * ],
5144
- * "_created_at": "2021-02-09T12:41:43.662Z",
5145
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5146
- * }
5147
- */
5148
- Components.Schemas.Entity;
3960
+ export type RequestBody = Components.Schemas.Entity;
5149
3961
  namespace Responses {
5150
3962
  export type $200 = /**
5151
3963
  * example:
@@ -5155,8 +3967,6 @@ declare namespace Paths {
5155
3967
  * "_schema": "contact",
5156
3968
  * "_tags": [
5157
3969
  * "example",
5158
- * "mock",
5159
- * "example",
5160
3970
  * "mock"
5161
3971
  * ],
5162
3972
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -5168,7 +3978,6 @@ declare namespace Paths {
5168
3978
  }
5169
3979
  namespace UpdateRelation {
5170
3980
  namespace Parameters {
5171
- export type Async = boolean;
5172
3981
  export type Attribute = string;
5173
3982
  export type EntityId = string;
5174
3983
  export type Id = Components.Schemas.EntityId /* uuid */;
@@ -5185,9 +3994,6 @@ declare namespace Paths {
5185
3994
  attribute: Parameters.Attribute;
5186
3995
  entity_id: Parameters.EntityId;
5187
3996
  }
5188
- export interface QueryParameters {
5189
- async?: Parameters.Async;
5190
- }
5191
3997
  export interface RequestBody {
5192
3998
  _tags?: string[];
5193
3999
  }
@@ -5195,18 +4001,6 @@ declare namespace Paths {
5195
4001
  export type $200 = Components.Schemas.RelationItem;
5196
4002
  }
5197
4003
  }
5198
- namespace UpdateSavedView {
5199
- namespace Parameters {
5200
- export type Id = /* Generated uuid for a saved view */ Components.Schemas.SavedViewId /* uuid */;
5201
- }
5202
- export interface PathParameters {
5203
- id: Parameters.Id;
5204
- }
5205
- export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
5206
- namespace Responses {
5207
- export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
5208
- }
5209
- }
5210
4004
  namespace UpsertEntity {
5211
4005
  namespace Parameters {
5212
4006
  export type ActivityId = /**
@@ -5215,7 +4009,6 @@ declare namespace Paths {
5215
4009
  * 01F130Q52Q6MWSNS8N2AVXV4JN
5216
4010
  */
5217
4011
  Components.Schemas.ActivityId /* ulid */;
5218
- export type Async = boolean;
5219
4012
  export type DryRun = boolean;
5220
4013
  export type Slug = /**
5221
4014
  * URL-friendly identifier for the entity schema
@@ -5230,7 +4023,6 @@ declare namespace Paths {
5230
4023
  export interface QueryParameters {
5231
4024
  activity_id?: Parameters.ActivityId;
5232
4025
  dry_run?: Parameters.DryRun;
5233
- async?: Parameters.Async;
5234
4026
  }
5235
4027
  export interface RequestBody {
5236
4028
  /**
@@ -5240,21 +4032,7 @@ declare namespace Paths {
5240
4032
  * ]
5241
4033
  */
5242
4034
  unique_key: string[];
5243
- entity: /**
5244
- * example:
5245
- * {
5246
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5247
- * "_org": "123",
5248
- * "_schema": "contact",
5249
- * "_tags": [
5250
- * "example",
5251
- * "mock"
5252
- * ],
5253
- * "_created_at": "2021-02-09T12:41:43.662Z",
5254
- * "_updated_at": "2021-02-09T12:41:43.662Z"
5255
- * }
5256
- */
5257
- Components.Schemas.Entity;
4035
+ entity: Components.Schemas.Entity;
5258
4036
  }
5259
4037
  namespace Responses {
5260
4038
  export type $200 = /**
@@ -5265,8 +4043,6 @@ declare namespace Paths {
5265
4043
  * "_schema": "contact",
5266
4044
  * "_tags": [
5267
4045
  * "example",
5268
- * "mock",
5269
- * "example",
5270
4046
  * "mock"
5271
4047
  * ],
5272
4048
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -5282,8 +4058,6 @@ declare namespace Paths {
5282
4058
  * "_schema": "contact",
5283
4059
  * "_tags": [
5284
4060
  * "example",
5285
- * "mock",
5286
- * "example",
5287
4061
  * "mock"
5288
4062
  * ],
5289
4063
  * "_created_at": "2021-02-09T12:41:43.662Z",
@@ -5301,7 +4075,7 @@ export interface OperationMethods {
5301
4075
  /**
5302
4076
  * listSchemas - listSchemas
5303
4077
  *
5304
- * Get the latest versions of all schemas
4078
+ * Get the latest version of local schema
5305
4079
  */
5306
4080
  'listSchemas'(
5307
4081
  parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
@@ -5309,35 +4083,15 @@ export interface OperationMethods {
5309
4083
  config?: AxiosRequestConfig
5310
4084
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
5311
4085
  /**
5312
- * getSchema - getSchema
5313
- *
5314
- * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
5315
- */
5316
- 'getSchema'(
5317
- parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
5318
- data?: any,
5319
- config?: AxiosRequestConfig
5320
- ): OperationResponse<Paths.GetSchema.Responses.$200>
5321
- /**
5322
- * putSchema - putSchema
5323
- *
5324
- * Create or update a schema with a new version
5325
- */
5326
- 'putSchema'(
5327
- parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
5328
- data?: Paths.PutSchema.RequestBody,
5329
- config?: AxiosRequestConfig
5330
- ): OperationResponse<Paths.PutSchema.Responses.$200>
5331
- /**
5332
- * deleteSchema - deleteSchema
4086
+ * listSchemaBlueprints - listSchemaBlueprints
5333
4087
  *
5334
- * Delete a schema, or a specific version of a schema
4088
+ * List canonical versions of all available schemas
5335
4089
  */
5336
- 'deleteSchema'(
5337
- parameters?: Parameters<Paths.DeleteSchema.PathParameters> | null,
4090
+ 'listSchemaBlueprints'(
4091
+ parameters?: Parameters<UnknownParamsObject> | null,
5338
4092
  data?: any,
5339
4093
  config?: AxiosRequestConfig
5340
- ): OperationResponse<Paths.DeleteSchema.Responses.$204>
4094
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
5341
4095
  /**
5342
4096
  * getSchemaVersions - getSchemaVersions
5343
4097
  *
@@ -5349,25 +4103,35 @@ export interface OperationMethods {
5349
4103
  config?: AxiosRequestConfig
5350
4104
  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
5351
4105
  /**
5352
- * listSchemaBlueprints - listSchemaBlueprints
4106
+ * getSchema - getSchema
4107
+ *
4108
+ * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
4109
+ */
4110
+ 'getSchema'(
4111
+ parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
4112
+ data?: any,
4113
+ config?: AxiosRequestConfig
4114
+ ): OperationResponse<Paths.GetSchema.Responses.$200>
4115
+ /**
4116
+ * createNewSchemaVersion - createNewSchemaVersion
5353
4117
  *
5354
- * List canonical versions of all available schemas
4118
+ * Create new version of the schema and default draft is false.
5355
4119
  */
5356
- 'listSchemaBlueprints'(
5357
- parameters?: Parameters<UnknownParamsObject> | null,
5358
- data?: any,
4120
+ 'createNewSchemaVersion'(
4121
+ parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
4122
+ data?: Paths.CreateNewSchemaVersion.RequestBody,
5359
4123
  config?: AxiosRequestConfig
5360
- ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
4124
+ ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
5361
4125
  /**
5362
- * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
4126
+ * deleteSchemaById - deleteSchemaById
5363
4127
  *
5364
- * List taxonomy classifications for a given schema
4128
+ * Delete schema by Id
5365
4129
  */
5366
- 'listTaxonomyClassificationsForSchema'(
5367
- parameters?: Parameters<Paths.ListTaxonomyClassificationsForSchema.PathParameters & Paths.ListTaxonomyClassificationsForSchema.QueryParameters> | null,
4130
+ 'deleteSchemaById'(
4131
+ parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
5368
4132
  data?: any,
5369
4133
  config?: AxiosRequestConfig
5370
- ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
4134
+ ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
5371
4135
  /**
5372
4136
  * searchEntities - searchEntities
5373
4137
  *
@@ -5605,43 +4369,6 @@ export interface OperationMethods {
5605
4369
  data?: Paths.UpdateEntity.RequestBody,
5606
4370
  config?: AxiosRequestConfig
5607
4371
  ): OperationResponse<Paths.UpdateEntity.Responses.$200>
5608
- /**
5609
- * patchEntity - patchEntity
5610
- *
5611
- * Partially updates an entity with the passed in entity data.
5612
- *
5613
- * - If an _updated_at is passed and the server contains a newer version of the entity a `409` Error is returned
5614
- *
5615
- * ## Activity
5616
- *
5617
- * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated`
5618
- *
5619
- * ## Relations
5620
- *
5621
- * To create a relation, store a property that defines a `$relation` array.
5622
- *
5623
- * Example:
5624
- *
5625
- * ```json
5626
- * {
5627
- * "contacts": {
5628
- * "$relation": [
5629
- * { "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
5630
- * ]
5631
- * }
5632
- * }
5633
- * ```
5634
- *
5635
- * The items in `$relation` support two properties:
5636
- * - `entity_id` - The ID of the entity to link
5637
- * - `_tags` - Tags or labels for the relation (optional)
5638
- *
5639
- */
5640
- 'patchEntity'(
5641
- parameters?: Parameters<Paths.PatchEntity.PathParameters & Paths.PatchEntity.QueryParameters> | null,
5642
- data?: Paths.PatchEntity.RequestBody,
5643
- config?: AxiosRequestConfig
5644
- ): OperationResponse<Paths.PatchEntity.Responses.$200>
5645
4372
  /**
5646
4373
  * deleteEntity - deleteEntity
5647
4374
  *
@@ -5688,7 +4415,7 @@ export interface OperationMethods {
5688
4415
  * Get activity by id
5689
4416
  */
5690
4417
  'getActivity'(
5691
- parameters?: Parameters<Paths.GetActivity.PathParameters & Paths.GetActivity.QueryParameters> | null,
4418
+ parameters?: Parameters<Paths.GetActivity.PathParameters> | null,
5692
4419
  data?: any,
5693
4420
  config?: AxiosRequestConfig
5694
4421
  ): OperationResponse<Paths.GetActivity.Responses.$200>
@@ -5716,12 +4443,7 @@ export interface OperationMethods {
5716
4443
  /**
5717
4444
  * getRelations - getRelations
5718
4445
  *
5719
- * Returns 1st level direct relations for an entity.
5720
- *
5721
- * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
5722
- *
5723
- * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
5724
- *
4446
+ * It loads 1st level relations for the mentioned entity. You can control whether entire related entity is loaded or not via hydrate param.
5725
4447
  */
5726
4448
  'getRelations'(
5727
4449
  parameters?: Parameters<Paths.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
@@ -5731,45 +4453,30 @@ export interface OperationMethods {
5731
4453
  /**
5732
4454
  * addRelations - addRelations
5733
4455
  *
5734
- * Relates one or more entities to parent entity by adding items to a relation attribute
4456
+ * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
5735
4457
  */
5736
4458
  'addRelations'(
5737
- parameters?: Parameters<Paths.AddRelations.PathParameters & Paths.AddRelations.QueryParameters> | null,
4459
+ parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
5738
4460
  data?: Paths.AddRelations.RequestBody,
5739
4461
  config?: AxiosRequestConfig
5740
4462
  ): OperationResponse<Paths.AddRelations.Responses.$200>
5741
- /**
5742
- * getRelationsV2 - getRelationsV2
5743
- *
5744
- * Returns 1st level direct relations for an entity with pagination.
5745
- *
5746
- * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
5747
- *
5748
- * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
5749
- *
5750
- */
5751
- 'getRelationsV2'(
5752
- parameters?: Parameters<Paths.GetRelationsV2.PathParameters & Paths.GetRelationsV2.QueryParameters> | null,
5753
- data?: any,
5754
- config?: AxiosRequestConfig
5755
- ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
5756
4463
  /**
5757
4464
  * updateRelation - updateRelation
5758
4465
  *
5759
- * Updates an existing relation between two entities.
4466
+ * It updates a relation between two entities.
5760
4467
  */
5761
4468
  'updateRelation'(
5762
- parameters?: Parameters<Paths.UpdateRelation.PathParameters & Paths.UpdateRelation.QueryParameters> | null,
4469
+ parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
5763
4470
  data?: Paths.UpdateRelation.RequestBody,
5764
4471
  config?: AxiosRequestConfig
5765
4472
  ): OperationResponse<Paths.UpdateRelation.Responses.$200>
5766
4473
  /**
5767
4474
  * deleteRelation - deleteRelation
5768
4475
  *
5769
- * Removes relation between two entities
4476
+ * It deletes a relation between one entity and the other.
5770
4477
  */
5771
4478
  'deleteRelation'(
5772
- parameters?: Parameters<Paths.DeleteRelation.PathParameters & Paths.DeleteRelation.QueryParameters> | null,
4479
+ parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
5773
4480
  data?: any,
5774
4481
  config?: AxiosRequestConfig
5775
4482
  ): OperationResponse<Paths.DeleteRelation.Responses.$204>
@@ -5783,116 +4490,6 @@ export interface OperationMethods {
5783
4490
  data?: Paths.ExportEntities.RequestBody,
5784
4491
  config?: AxiosRequestConfig
5785
4492
  ): OperationResponse<Paths.ExportEntities.Responses.$201>
5786
- /**
5787
- * importEntities - importEntities
5788
- *
5789
- * import entity data from
5790
- */
5791
- 'importEntities'(
5792
- parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
5793
- data?: Paths.ImportEntities.RequestBody,
5794
- config?: AxiosRequestConfig
5795
- ): OperationResponse<Paths.ImportEntities.Responses.$201>
5796
- /**
5797
- * listSavedViews - listSavedViews
5798
- *
5799
- * Get the Saved Views based on the schema
5800
- */
5801
- 'listSavedViews'(
5802
- parameters?: Parameters<UnknownParamsObject> | null,
5803
- data?: any,
5804
- config?: AxiosRequestConfig
5805
- ): OperationResponse<Paths.ListSavedViews.Responses.$200>
5806
- /**
5807
- * createSavedView - createSavedView
5808
- *
5809
- * Creates a new saved view
5810
- */
5811
- 'createSavedView'(
5812
- parameters?: Parameters<UnknownParamsObject> | null,
5813
- data?: Paths.CreateSavedView.RequestBody,
5814
- config?: AxiosRequestConfig
5815
- ): OperationResponse<Paths.CreateSavedView.Responses.$201>
5816
- /**
5817
- * getSavedView - getSavedView
5818
- *
5819
- * Gets Saved View configuration by id.
5820
- */
5821
- 'getSavedView'(
5822
- parameters?: Parameters<Paths.GetSavedView.PathParameters> | null,
5823
- data?: any,
5824
- config?: AxiosRequestConfig
5825
- ): OperationResponse<Paths.GetSavedView.Responses.$200>
5826
- /**
5827
- * updateSavedView - updateSavedView
5828
- *
5829
- * Updates a saved view
5830
- */
5831
- 'updateSavedView'(
5832
- parameters?: Parameters<Paths.UpdateSavedView.PathParameters> | null,
5833
- data?: Paths.UpdateSavedView.RequestBody,
5834
- config?: AxiosRequestConfig
5835
- ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
5836
- /**
5837
- * deleteSavedView - deleteSavedView
5838
- *
5839
- * Deletes a saved view
5840
- */
5841
- 'deleteSavedView'(
5842
- parameters?: Parameters<Paths.DeleteSavedView.PathParameters> | null,
5843
- data?: any,
5844
- config?: AxiosRequestConfig
5845
- ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
5846
- /**
5847
- * listTaxonomies - listTaxonomies
5848
- *
5849
- * List taxonomies in an organisation
5850
- */
5851
- 'listTaxonomies'(
5852
- parameters?: Parameters<UnknownParamsObject> | null,
5853
- data?: any,
5854
- config?: AxiosRequestConfig
5855
- ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
5856
- /**
5857
- * getTaxonomy - getTaxonomy
5858
- *
5859
- * Get taxonomy by slug
5860
- */
5861
- 'getTaxonomy'(
5862
- parameters?: Parameters<Paths.GetTaxonomy.PathParameters> | null,
5863
- data?: any,
5864
- config?: AxiosRequestConfig
5865
- ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
5866
- /**
5867
- * taxonomyAutocomplete - taxonomyAutocomplete
5868
- *
5869
- * Taxonomies autocomplete
5870
- */
5871
- 'taxonomyAutocomplete'(
5872
- parameters?: Parameters<Paths.TaxonomyAutocomplete.PathParameters & Paths.TaxonomyAutocomplete.QueryParameters> | null,
5873
- data?: any,
5874
- config?: AxiosRequestConfig
5875
- ): OperationResponse<Paths.TaxonomyAutocomplete.Responses.$200>
5876
- /**
5877
- * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
5878
- *
5879
- * List taxonomy classifications in an organisation based on taxonomy slug
5880
- */
5881
- 'taxonomiesClassificationsSearch'(
5882
- parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
5883
- data?: Paths.TaxonomiesClassificationsSearch.RequestBody,
5884
- config?: AxiosRequestConfig
5885
- ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
5886
- /**
5887
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
5888
- *
5889
- * Update taxonomies in an organisation based in taxonomy slug
5890
- */
5891
- 'updateClassificationsForTaxonomy'(
5892
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
5893
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
5894
- config?: AxiosRequestConfig
5895
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
5896
4493
  }
5897
4494
 
5898
4495
  export interface PathsDictionary {
@@ -5900,7 +4497,7 @@ export interface PathsDictionary {
5900
4497
  /**
5901
4498
  * listSchemas - listSchemas
5902
4499
  *
5903
- * Get the latest versions of all schemas
4500
+ * Get the latest version of local schema
5904
4501
  */
5905
4502
  'get'(
5906
4503
  parameters?: Parameters<Paths.ListSchemas.QueryParameters> | null,
@@ -5908,37 +4505,17 @@ export interface PathsDictionary {
5908
4505
  config?: AxiosRequestConfig
5909
4506
  ): OperationResponse<Paths.ListSchemas.Responses.$200>
5910
4507
  }
5911
- ['/v1/entity/schemas/{slug}']: {
4508
+ ['/v1/entity/schemas/blueprints']: {
5912
4509
  /**
5913
- * getSchema - getSchema
4510
+ * listSchemaBlueprints - listSchemaBlueprints
5914
4511
  *
5915
- * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
4512
+ * List canonical versions of all available schemas
5916
4513
  */
5917
4514
  'get'(
5918
- parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
5919
- data?: any,
5920
- config?: AxiosRequestConfig
5921
- ): OperationResponse<Paths.GetSchema.Responses.$200>
5922
- /**
5923
- * putSchema - putSchema
5924
- *
5925
- * Create or update a schema with a new version
5926
- */
5927
- 'put'(
5928
- parameters?: Parameters<Paths.PutSchema.PathParameters & Paths.PutSchema.QueryParameters> | null,
5929
- data?: Paths.PutSchema.RequestBody,
5930
- config?: AxiosRequestConfig
5931
- ): OperationResponse<Paths.PutSchema.Responses.$200>
5932
- /**
5933
- * deleteSchema - deleteSchema
5934
- *
5935
- * Delete a schema, or a specific version of a schema
5936
- */
5937
- 'delete'(
5938
- parameters?: Parameters<Paths.DeleteSchema.PathParameters> | null,
4515
+ parameters?: Parameters<UnknownParamsObject> | null,
5939
4516
  data?: any,
5940
4517
  config?: AxiosRequestConfig
5941
- ): OperationResponse<Paths.DeleteSchema.Responses.$204>
4518
+ ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
5942
4519
  }
5943
4520
  ['/v1/entity/schemas/{slug}/versions']: {
5944
4521
  /**
@@ -5952,29 +4529,37 @@ export interface PathsDictionary {
5952
4529
  config?: AxiosRequestConfig
5953
4530
  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
5954
4531
  }
5955
- ['/v1/entity/schemas/blueprints']: {
4532
+ ['/v1/entity/schemas/{slug}']: {
5956
4533
  /**
5957
- * listSchemaBlueprints - listSchemaBlueprints
4534
+ * getSchema - getSchema
5958
4535
  *
5959
- * List canonical versions of all available schemas
4536
+ * By default gets the latest version of the Schema and to get the specific version of schema pass the id.
5960
4537
  */
5961
4538
  'get'(
5962
- parameters?: Parameters<UnknownParamsObject> | null,
4539
+ parameters?: Parameters<Paths.GetSchema.PathParameters & Paths.GetSchema.QueryParameters> | null,
5963
4540
  data?: any,
5964
4541
  config?: AxiosRequestConfig
5965
- ): OperationResponse<Paths.ListSchemaBlueprints.Responses.$200>
5966
- }
5967
- ['/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}']: {
4542
+ ): OperationResponse<Paths.GetSchema.Responses.$200>
5968
4543
  /**
5969
- * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
4544
+ * createNewSchemaVersion - createNewSchemaVersion
5970
4545
  *
5971
- * List taxonomy classifications for a given schema
4546
+ * Create new version of the schema and default draft is false.
5972
4547
  */
5973
- 'get'(
5974
- parameters?: Parameters<Paths.ListTaxonomyClassificationsForSchema.PathParameters & Paths.ListTaxonomyClassificationsForSchema.QueryParameters> | null,
4548
+ 'put'(
4549
+ parameters?: Parameters<Paths.CreateNewSchemaVersion.PathParameters & Paths.CreateNewSchemaVersion.QueryParameters> | null,
4550
+ data?: Paths.CreateNewSchemaVersion.RequestBody,
4551
+ config?: AxiosRequestConfig
4552
+ ): OperationResponse<Paths.CreateNewSchemaVersion.Responses.$200>
4553
+ /**
4554
+ * deleteSchemaById - deleteSchemaById
4555
+ *
4556
+ * Delete schema by Id
4557
+ */
4558
+ 'delete'(
4559
+ parameters?: Parameters<Paths.DeleteSchemaById.PathParameters & Paths.DeleteSchemaById.QueryParameters> | null,
5975
4560
  data?: any,
5976
4561
  config?: AxiosRequestConfig
5977
- ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
4562
+ ): OperationResponse<Paths.DeleteSchemaById.Responses.$204>
5978
4563
  }
5979
4564
  ['/v1/entity:search']: {
5980
4565
  /**
@@ -6220,43 +4805,6 @@ export interface PathsDictionary {
6220
4805
  data?: Paths.UpdateEntity.RequestBody,
6221
4806
  config?: AxiosRequestConfig
6222
4807
  ): OperationResponse<Paths.UpdateEntity.Responses.$200>
6223
- /**
6224
- * patchEntity - patchEntity
6225
- *
6226
- * Partially updates an entity with the passed in entity data.
6227
- *
6228
- * - If an _updated_at is passed and the server contains a newer version of the entity a `409` Error is returned
6229
- *
6230
- * ## Activity
6231
- *
6232
- * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityUpdated`
6233
- *
6234
- * ## Relations
6235
- *
6236
- * To create a relation, store a property that defines a `$relation` array.
6237
- *
6238
- * Example:
6239
- *
6240
- * ```json
6241
- * {
6242
- * "contacts": {
6243
- * "$relation": [
6244
- * { "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
6245
- * ]
6246
- * }
6247
- * }
6248
- * ```
6249
- *
6250
- * The items in `$relation` support two properties:
6251
- * - `entity_id` - The ID of the entity to link
6252
- * - `_tags` - Tags or labels for the relation (optional)
6253
- *
6254
- */
6255
- 'patch'(
6256
- parameters?: Parameters<Paths.PatchEntity.PathParameters & Paths.PatchEntity.QueryParameters> | null,
6257
- data?: Paths.PatchEntity.RequestBody,
6258
- config?: AxiosRequestConfig
6259
- ): OperationResponse<Paths.PatchEntity.Responses.$200>
6260
4808
  /**
6261
4809
  * deleteEntity - deleteEntity
6262
4810
  *
@@ -6309,7 +4857,7 @@ export interface PathsDictionary {
6309
4857
  * Get activity by id
6310
4858
  */
6311
4859
  'get'(
6312
- parameters?: Parameters<Paths.GetActivity.PathParameters & Paths.GetActivity.QueryParameters> | null,
4860
+ parameters?: Parameters<Paths.GetActivity.PathParameters> | null,
6313
4861
  data?: any,
6314
4862
  config?: AxiosRequestConfig
6315
4863
  ): OperationResponse<Paths.GetActivity.Responses.$200>
@@ -6343,12 +4891,7 @@ export interface PathsDictionary {
6343
4891
  /**
6344
4892
  * getRelations - getRelations
6345
4893
  *
6346
- * Returns 1st level direct relations for an entity.
6347
- *
6348
- * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
6349
- *
6350
- * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
6351
- *
4894
+ * It loads 1st level relations for the mentioned entity. You can control whether entire related entity is loaded or not via hydrate param.
6352
4895
  */
6353
4896
  'get'(
6354
4897
  parameters?: Parameters<Paths.GetRelations.PathParameters & Paths.GetRelations.QueryParameters> | null,
@@ -6358,49 +4901,32 @@ export interface PathsDictionary {
6358
4901
  /**
6359
4902
  * addRelations - addRelations
6360
4903
  *
6361
- * Relates one or more entities to parent entity by adding items to a relation attribute
4904
+ * It relates one or more entities to some parent entity, by providing meaning for relations via attribute field.
6362
4905
  */
6363
4906
  'post'(
6364
- parameters?: Parameters<Paths.AddRelations.PathParameters & Paths.AddRelations.QueryParameters> | null,
4907
+ parameters?: Parameters<Paths.AddRelations.PathParameters> | null,
6365
4908
  data?: Paths.AddRelations.RequestBody,
6366
4909
  config?: AxiosRequestConfig
6367
4910
  ): OperationResponse<Paths.AddRelations.Responses.$200>
6368
4911
  }
6369
- ['/v2/entity/{slug}/{id}/relations']: {
6370
- /**
6371
- * getRelationsV2 - getRelationsV2
6372
- *
6373
- * Returns 1st level direct relations for an entity with pagination.
6374
- *
6375
- * You can control whether to return the full entity or just the relation item with the `?hydrate` query param.
6376
- *
6377
- * Reverse relations i.e. entities referring to this entity are included with the `?include_reverse` query param.
6378
- *
6379
- */
6380
- 'get'(
6381
- parameters?: Parameters<Paths.GetRelationsV2.PathParameters & Paths.GetRelationsV2.QueryParameters> | null,
6382
- data?: any,
6383
- config?: AxiosRequestConfig
6384
- ): OperationResponse<Paths.GetRelationsV2.Responses.$200>
6385
- }
6386
4912
  ['/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}']: {
6387
4913
  /**
6388
4914
  * updateRelation - updateRelation
6389
4915
  *
6390
- * Updates an existing relation between two entities.
4916
+ * It updates a relation between two entities.
6391
4917
  */
6392
4918
  'put'(
6393
- parameters?: Parameters<Paths.UpdateRelation.PathParameters & Paths.UpdateRelation.QueryParameters> | null,
4919
+ parameters?: Parameters<Paths.UpdateRelation.PathParameters> | null,
6394
4920
  data?: Paths.UpdateRelation.RequestBody,
6395
4921
  config?: AxiosRequestConfig
6396
4922
  ): OperationResponse<Paths.UpdateRelation.Responses.$200>
6397
4923
  /**
6398
4924
  * deleteRelation - deleteRelation
6399
4925
  *
6400
- * Removes relation between two entities
4926
+ * It deletes a relation between one entity and the other.
6401
4927
  */
6402
4928
  'delete'(
6403
- parameters?: Parameters<Paths.DeleteRelation.PathParameters & Paths.DeleteRelation.QueryParameters> | null,
4929
+ parameters?: Parameters<Paths.DeleteRelation.PathParameters> | null,
6404
4930
  data?: any,
6405
4931
  config?: AxiosRequestConfig
6406
4932
  ): OperationResponse<Paths.DeleteRelation.Responses.$204>
@@ -6417,134 +4943,6 @@ export interface PathsDictionary {
6417
4943
  config?: AxiosRequestConfig
6418
4944
  ): OperationResponse<Paths.ExportEntities.Responses.$201>
6419
4945
  }
6420
- ['/v1/entity:import']: {
6421
- /**
6422
- * importEntities - importEntities
6423
- *
6424
- * import entity data from
6425
- */
6426
- 'post'(
6427
- parameters?: Parameters<Paths.ImportEntities.QueryParameters> | null,
6428
- data?: Paths.ImportEntities.RequestBody,
6429
- config?: AxiosRequestConfig
6430
- ): OperationResponse<Paths.ImportEntities.Responses.$201>
6431
- }
6432
- ['/v1/entity/views']: {
6433
- /**
6434
- * listSavedViews - listSavedViews
6435
- *
6436
- * Get the Saved Views based on the schema
6437
- */
6438
- 'get'(
6439
- parameters?: Parameters<UnknownParamsObject> | null,
6440
- data?: any,
6441
- config?: AxiosRequestConfig
6442
- ): OperationResponse<Paths.ListSavedViews.Responses.$200>
6443
- }
6444
- ['/v1/entity/view']: {
6445
- /**
6446
- * createSavedView - createSavedView
6447
- *
6448
- * Creates a new saved view
6449
- */
6450
- 'post'(
6451
- parameters?: Parameters<UnknownParamsObject> | null,
6452
- data?: Paths.CreateSavedView.RequestBody,
6453
- config?: AxiosRequestConfig
6454
- ): OperationResponse<Paths.CreateSavedView.Responses.$201>
6455
- }
6456
- ['/v1/entity/view/{id}']: {
6457
- /**
6458
- * getSavedView - getSavedView
6459
- *
6460
- * Gets Saved View configuration by id.
6461
- */
6462
- 'get'(
6463
- parameters?: Parameters<Paths.GetSavedView.PathParameters> | null,
6464
- data?: any,
6465
- config?: AxiosRequestConfig
6466
- ): OperationResponse<Paths.GetSavedView.Responses.$200>
6467
- /**
6468
- * updateSavedView - updateSavedView
6469
- *
6470
- * Updates a saved view
6471
- */
6472
- 'put'(
6473
- parameters?: Parameters<Paths.UpdateSavedView.PathParameters> | null,
6474
- data?: Paths.UpdateSavedView.RequestBody,
6475
- config?: AxiosRequestConfig
6476
- ): OperationResponse<Paths.UpdateSavedView.Responses.$200>
6477
- /**
6478
- * deleteSavedView - deleteSavedView
6479
- *
6480
- * Deletes a saved view
6481
- */
6482
- 'delete'(
6483
- parameters?: Parameters<Paths.DeleteSavedView.PathParameters> | null,
6484
- data?: any,
6485
- config?: AxiosRequestConfig
6486
- ): OperationResponse<Paths.DeleteSavedView.Responses.$200>
6487
- }
6488
- ['/v1/entity/listTaxonomies']: {
6489
- /**
6490
- * listTaxonomies - listTaxonomies
6491
- *
6492
- * List taxonomies in an organisation
6493
- */
6494
- 'get'(
6495
- parameters?: Parameters<UnknownParamsObject> | null,
6496
- data?: any,
6497
- config?: AxiosRequestConfig
6498
- ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
6499
- }
6500
- ['/v1/entity/taxonomies/{taxonomySlug}']: {
6501
- /**
6502
- * getTaxonomy - getTaxonomy
6503
- *
6504
- * Get taxonomy by slug
6505
- */
6506
- 'get'(
6507
- parameters?: Parameters<Paths.GetTaxonomy.PathParameters> | null,
6508
- data?: any,
6509
- config?: AxiosRequestConfig
6510
- ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
6511
- }
6512
- ['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
6513
- /**
6514
- * taxonomyAutocomplete - taxonomyAutocomplete
6515
- *
6516
- * Taxonomies autocomplete
6517
- */
6518
- 'get'(
6519
- parameters?: Parameters<Paths.TaxonomyAutocomplete.PathParameters & Paths.TaxonomyAutocomplete.QueryParameters> | null,
6520
- data?: any,
6521
- config?: AxiosRequestConfig
6522
- ): OperationResponse<Paths.TaxonomyAutocomplete.Responses.$200>
6523
- }
6524
- ['/v1/entity/taxonomies/classifications:search']: {
6525
- /**
6526
- * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
6527
- *
6528
- * List taxonomy classifications in an organisation based on taxonomy slug
6529
- */
6530
- 'post'(
6531
- parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
6532
- data?: Paths.TaxonomiesClassificationsSearch.RequestBody,
6533
- config?: AxiosRequestConfig
6534
- ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
6535
- }
6536
- ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
6537
- /**
6538
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
6539
- *
6540
- * Update taxonomies in an organisation based in taxonomy slug
6541
- */
6542
- 'post'(
6543
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
6544
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
6545
- config?: AxiosRequestConfig
6546
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
6547
- }
6548
4946
  }
6549
4947
 
6550
4948
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>