@epilot/entity-client 4.31.1 → 4.32.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
@@ -60,6 +60,7 @@ declare namespace Components {
60
60
  export type TaxonomySlugPathParam = string;
61
61
  export type TaxonomySlugQueryParam = string;
62
62
  export type TaxonomySlugQueryParamOptional = string;
63
+ export type ValidateEntityQueryParam = boolean;
63
64
  }
64
65
  export interface PathParameters {
65
66
  EntityIdPathParam?: Parameters.EntityIdPathParam;
@@ -89,6 +90,7 @@ declare namespace Components {
89
90
  EntityRelationsModeQueryParam?: Parameters.EntityRelationsModeQueryParam;
90
91
  DryRunQueryParam?: Parameters.DryRunQueryParam;
91
92
  FillActivityQueryParam?: Parameters.FillActivityQueryParam;
93
+ ValidateEntityQueryParam?: Parameters.ValidateEntityQueryParam;
92
94
  }
93
95
  namespace Schemas {
94
96
  export interface Activity {
@@ -303,6 +305,10 @@ declare namespace Components {
303
305
  * taxonomy-slug:classification-slug
304
306
  */
305
307
  ClassificationId[];
308
+ /**
309
+ * Manifest ID used to create/update the schema attribute
310
+ */
311
+ _manifest?: string /* uuid */[] | null;
306
312
  /**
307
313
  * A set of constraints applicable to the attribute.
308
314
  * These constraints should and will be enforced by the attribute renderer.
@@ -453,6 +459,10 @@ declare namespace Components {
453
459
  * taxonomy-slug:classification-slug
454
460
  */
455
461
  ClassificationId[];
462
+ /**
463
+ * Manifest ID used to create/update the schema attribute
464
+ */
465
+ _manifest?: string /* uuid */[] | null;
456
466
  /**
457
467
  * A set of constraints applicable to the attribute.
458
468
  * These constraints should and will be enforced by the attribute renderer.
@@ -627,6 +637,10 @@ declare namespace Components {
627
637
  * taxonomy-slug:classification-slug
628
638
  */
629
639
  ClassificationId[];
640
+ /**
641
+ * Manifest ID used to create/update the schema attribute
642
+ */
643
+ _manifest?: string /* uuid */[] | null;
630
644
  /**
631
645
  * A set of constraints applicable to the attribute.
632
646
  * These constraints should and will be enforced by the attribute renderer.
@@ -831,6 +845,10 @@ declare namespace Components {
831
845
  * taxonomy-slug:classification-slug
832
846
  */
833
847
  ClassificationId[];
848
+ /**
849
+ * Manifest ID used to create/update the schema attribute
850
+ */
851
+ _manifest?: string /* uuid */[] | null;
834
852
  /**
835
853
  * A set of constraints applicable to the attribute.
836
854
  * These constraints should and will be enforced by the attribute renderer.
@@ -983,6 +1001,10 @@ declare namespace Components {
983
1001
  * taxonomy-slug:classification-slug
984
1002
  */
985
1003
  ClassificationId[];
1004
+ /**
1005
+ * Manifest ID used to create/update the schema attribute
1006
+ */
1007
+ _manifest?: string /* uuid */[] | null;
986
1008
  /**
987
1009
  * A set of constraints applicable to the attribute.
988
1010
  * These constraints should and will be enforced by the attribute renderer.
@@ -1115,6 +1137,10 @@ declare namespace Components {
1115
1137
  * taxonomy-slug:classification-slug
1116
1138
  */
1117
1139
  ClassificationId[];
1140
+ /**
1141
+ * Manifest ID used to create/update the schema attribute
1142
+ */
1143
+ _manifest?: string /* uuid */[] | null;
1118
1144
  /**
1119
1145
  * A set of constraints applicable to the attribute.
1120
1146
  * These constraints should and will be enforced by the attribute renderer.
@@ -1249,6 +1275,10 @@ declare namespace Components {
1249
1275
  * taxonomy-slug:classification-slug
1250
1276
  */
1251
1277
  ClassificationId[];
1278
+ /**
1279
+ * Manifest ID used to create/update the schema attribute
1280
+ */
1281
+ _manifest?: string /* uuid */[] | null;
1252
1282
  /**
1253
1283
  * A set of constraints applicable to the attribute.
1254
1284
  * These constraints should and will be enforced by the attribute renderer.
@@ -1381,6 +1411,10 @@ declare namespace Components {
1381
1411
  * taxonomy-slug:classification-slug
1382
1412
  */
1383
1413
  ClassificationId[];
1414
+ /**
1415
+ * Manifest ID used to create/update the schema attribute
1416
+ */
1417
+ _manifest?: string /* uuid */[] | null;
1384
1418
  /**
1385
1419
  * A set of constraints applicable to the attribute.
1386
1420
  * These constraints should and will be enforced by the attribute renderer.
@@ -1523,6 +1557,10 @@ declare namespace Components {
1523
1557
  * taxonomy-slug:classification-slug
1524
1558
  */
1525
1559
  ClassificationId[];
1560
+ /**
1561
+ * Manifest ID used to create/update the schema attribute
1562
+ */
1563
+ _manifest?: string /* uuid */[] | null;
1526
1564
  /**
1527
1565
  * A set of constraints applicable to the attribute.
1528
1566
  * These constraints should and will be enforced by the attribute renderer.
@@ -1734,6 +1772,10 @@ declare namespace Components {
1734
1772
  * taxonomy-slug:classification-slug
1735
1773
  */
1736
1774
  ClassificationId[];
1775
+ /**
1776
+ * Manifest ID used to create/update the schema capabilility
1777
+ */
1778
+ _manifest?: string /* uuid */[] | null;
1737
1779
  ui_hooks?: {
1738
1780
  [name: string]: any;
1739
1781
  /**
@@ -1849,6 +1891,10 @@ declare namespace Components {
1849
1891
  * taxonomy-slug:classification-slug
1850
1892
  */
1851
1893
  ClassificationId[];
1894
+ /**
1895
+ * Manifest ID used to create/update the schema capabilility
1896
+ */
1897
+ _manifest?: string /* uuid */[] | null;
1852
1898
  ui_hooks?: {
1853
1899
  [name: string]: any;
1854
1900
  /**
@@ -2432,6 +2478,16 @@ declare namespace Components {
2432
2478
  * Contacts
2433
2479
  */
2434
2480
  plural: string;
2481
+ /**
2482
+ * example:
2483
+ * Example description
2484
+ */
2485
+ description?: string;
2486
+ /**
2487
+ * example:
2488
+ * https://docs.epilot.io/docs/pricing/entities
2489
+ */
2490
+ docs_url?: string; // uri
2435
2491
  /**
2436
2492
  * example:
2437
2493
  * false
@@ -2653,6 +2709,10 @@ declare namespace Components {
2653
2709
  * taxonomy-slug:classification-slug
2654
2710
  */
2655
2711
  ClassificationId[];
2712
+ /**
2713
+ * Manifest ID used to create/update the schema group
2714
+ */
2715
+ _manifest?: string /* uuid */[] | null;
2656
2716
  /**
2657
2717
  * This group should only be active when the feature flag is enabled
2658
2718
  * example:
@@ -2710,6 +2770,10 @@ declare namespace Components {
2710
2770
  * taxonomy-slug:classification-slug
2711
2771
  */
2712
2772
  ClassificationId[];
2773
+ /**
2774
+ * Manifest ID used to create/update the schema group
2775
+ */
2776
+ _manifest?: string /* uuid */[] | null;
2713
2777
  /**
2714
2778
  * This group should only be active when the feature flag is enabled
2715
2779
  * example:
@@ -2783,6 +2847,16 @@ declare namespace Components {
2783
2847
  * Contacts
2784
2848
  */
2785
2849
  plural: string;
2850
+ /**
2851
+ * example:
2852
+ * Example description
2853
+ */
2854
+ description?: string;
2855
+ /**
2856
+ * example:
2857
+ * https://docs.epilot.io/docs/pricing/entities
2858
+ */
2859
+ docs_url?: string; // uri
2786
2860
  /**
2787
2861
  * example:
2788
2862
  * false
@@ -3283,6 +3357,71 @@ declare namespace Components {
3283
3357
  errors: [
3284
3358
  ];
3285
3359
  }
3360
+ export interface EntityValidationV2Error {
3361
+ /**
3362
+ * validation keyword.
3363
+ */
3364
+ keyword: string;
3365
+ /**
3366
+ * JSON Pointer to the location in the data instance (e.g., `"/prop/1/subProp"`).
3367
+ */
3368
+ instance_path: string;
3369
+ /**
3370
+ * JSON Pointer to the location of the failing keyword in the schema.
3371
+ */
3372
+ schema_path: string;
3373
+ /**
3374
+ * Additional information about error.
3375
+ */
3376
+ params: {
3377
+ [name: string]: any;
3378
+ };
3379
+ /**
3380
+ * Set for errors in `propertyNames` keyword schema. `instance_path` still points to the object in this case.
3381
+ */
3382
+ property_name?: string;
3383
+ /**
3384
+ * The error message.
3385
+ */
3386
+ message?: string;
3387
+ /**
3388
+ * The value of the failing keyword in the schema.
3389
+ */
3390
+ schema?: {
3391
+ [key: string]: any;
3392
+ };
3393
+ /**
3394
+ * The schema containing the keyword.
3395
+ */
3396
+ parent_schema?: {
3397
+ [name: string]: any;
3398
+ };
3399
+ /**
3400
+ * The data validated by the keyword.
3401
+ */
3402
+ data?: {
3403
+ [name: string]: any;
3404
+ };
3405
+ }
3406
+ export type EntityValidationV2Result = /* Validation result for a successful validation */ EntityValidationV2ResultSuccess | /* Validation result for a failed validation */ EntityValidationV2ResultError;
3407
+ /**
3408
+ * Validation result for a failed validation
3409
+ */
3410
+ export interface EntityValidationV2ResultError {
3411
+ status: "error";
3412
+ errors: [
3413
+ EntityValidationV2Error,
3414
+ ...EntityValidationV2Error[]
3415
+ ];
3416
+ }
3417
+ /**
3418
+ * Validation result for a successful validation
3419
+ */
3420
+ export interface EntityValidationV2ResultSuccess {
3421
+ status: "success";
3422
+ errors: [
3423
+ ];
3424
+ }
3286
3425
  export interface EntityViewDisabled {
3287
3426
  view_type?: "disabled";
3288
3427
  }
@@ -3376,6 +3515,10 @@ declare namespace Components {
3376
3515
  * taxonomy-slug:classification-slug
3377
3516
  */
3378
3517
  ClassificationId[];
3518
+ /**
3519
+ * Manifest ID used to create/update the schema attribute
3520
+ */
3521
+ _manifest?: string /* uuid */[] | null;
3379
3522
  /**
3380
3523
  * A set of constraints applicable to the attribute.
3381
3524
  * These constraints should and will be enforced by the attribute renderer.
@@ -3526,7 +3669,7 @@ declare namespace Components {
3526
3669
  relations?: GetRelationsResp;
3527
3670
  }
3528
3671
  export interface GroupHeadline {
3529
- id: string; // uuid
3672
+ id?: string; // uuid
3530
3673
  name: string;
3531
3674
  label: string;
3532
3675
  layout?: string;
@@ -3541,12 +3684,21 @@ declare namespace Components {
3541
3684
  type: "headline";
3542
3685
  enable_divider?: boolean;
3543
3686
  divider?: "top_divider" | "bottom_divider";
3687
+ _purpose?: /**
3688
+ * example:
3689
+ * taxonomy-slug:classification-slug
3690
+ */
3691
+ ClassificationId[];
3692
+ /**
3693
+ * Manifest ID used to create/update the schema group headline
3694
+ */
3695
+ _manifest?: string /* uuid */[] | null;
3544
3696
  }
3545
3697
  /**
3546
3698
  * a readonly computed ID for the entity group headline including schema slug and the headline ID
3547
3699
  */
3548
3700
  export interface GroupHeadlineWithCompositeID {
3549
- id: string; // uuid
3701
+ id?: string; // uuid
3550
3702
  name: string;
3551
3703
  label: string;
3552
3704
  layout?: string;
@@ -3561,6 +3713,15 @@ declare namespace Components {
3561
3713
  type: "headline";
3562
3714
  enable_divider?: boolean;
3563
3715
  divider?: "top_divider" | "bottom_divider";
3716
+ _purpose?: /**
3717
+ * example:
3718
+ * taxonomy-slug:classification-slug
3719
+ */
3720
+ ClassificationId[];
3721
+ /**
3722
+ * Manifest ID used to create/update the schema group headline
3723
+ */
3724
+ _manifest?: string /* uuid */[] | null;
3564
3725
  /**
3565
3726
  * example:
3566
3727
  * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
@@ -3834,6 +3995,10 @@ declare namespace Components {
3834
3995
  * taxonomy-slug:classification-slug
3835
3996
  */
3836
3997
  ClassificationId[];
3998
+ /**
3999
+ * Manifest ID used to create/update the schema attribute
4000
+ */
4001
+ _manifest?: string /* uuid */[] | null;
3837
4002
  /**
3838
4003
  * A set of constraints applicable to the attribute.
3839
4004
  * These constraints should and will be enforced by the attribute renderer.
@@ -3966,6 +4131,10 @@ declare namespace Components {
3966
4131
  * taxonomy-slug:classification-slug
3967
4132
  */
3968
4133
  ClassificationId[];
4134
+ /**
4135
+ * Manifest ID used to create/update the schema attribute
4136
+ */
4137
+ _manifest?: string /* uuid */[] | null;
3969
4138
  /**
3970
4139
  * A set of constraints applicable to the attribute.
3971
4140
  * These constraints should and will be enforced by the attribute renderer.
@@ -4098,6 +4267,10 @@ declare namespace Components {
4098
4267
  * taxonomy-slug:classification-slug
4099
4268
  */
4100
4269
  ClassificationId[];
4270
+ /**
4271
+ * Manifest ID used to create/update the schema attribute
4272
+ */
4273
+ _manifest?: string /* uuid */[] | null;
4101
4274
  /**
4102
4275
  * A set of constraints applicable to the attribute.
4103
4276
  * These constraints should and will be enforced by the attribute renderer.
@@ -4238,6 +4411,10 @@ declare namespace Components {
4238
4411
  * taxonomy-slug:classification-slug
4239
4412
  */
4240
4413
  ClassificationId[];
4414
+ /**
4415
+ * Manifest ID used to create/update the schema attribute
4416
+ */
4417
+ _manifest?: string /* uuid */[] | null;
4241
4418
  /**
4242
4419
  * A set of constraints applicable to the attribute.
4243
4420
  * These constraints should and will be enforced by the attribute renderer.
@@ -4378,6 +4555,10 @@ declare namespace Components {
4378
4555
  * taxonomy-slug:classification-slug
4379
4556
  */
4380
4557
  ClassificationId[];
4558
+ /**
4559
+ * Manifest ID used to create/update the schema attribute
4560
+ */
4561
+ _manifest?: string /* uuid */[] | null;
4381
4562
  /**
4382
4563
  * A set of constraints applicable to the attribute.
4383
4564
  * These constraints should and will be enforced by the attribute renderer.
@@ -4526,6 +4707,10 @@ declare namespace Components {
4526
4707
  * taxonomy-slug:classification-slug
4527
4708
  */
4528
4709
  ClassificationId[];
4710
+ /**
4711
+ * Manifest ID used to create/update the schema attribute
4712
+ */
4713
+ _manifest?: string /* uuid */[] | null;
4529
4714
  /**
4530
4715
  * A set of constraints applicable to the attribute.
4531
4716
  * These constraints should and will be enforced by the attribute renderer.
@@ -4663,6 +4848,10 @@ declare namespace Components {
4663
4848
  * taxonomy-slug:classification-slug
4664
4849
  */
4665
4850
  ClassificationId[];
4851
+ /**
4852
+ * Manifest ID used to create/update the schema attribute
4853
+ */
4854
+ _manifest?: string /* uuid */[] | null;
4666
4855
  /**
4667
4856
  * A set of constraints applicable to the attribute.
4668
4857
  * These constraints should and will be enforced by the attribute renderer.
@@ -4795,6 +4984,10 @@ declare namespace Components {
4795
4984
  * taxonomy-slug:classification-slug
4796
4985
  */
4797
4986
  ClassificationId[];
4987
+ /**
4988
+ * Manifest ID used to create/update the schema attribute
4989
+ */
4990
+ _manifest?: string /* uuid */[] | null;
4798
4991
  /**
4799
4992
  * A set of constraints applicable to the attribute.
4800
4993
  * These constraints should and will be enforced by the attribute renderer.
@@ -4927,6 +5120,10 @@ declare namespace Components {
4927
5120
  * taxonomy-slug:classification-slug
4928
5121
  */
4929
5122
  ClassificationId[];
5123
+ /**
5124
+ * Manifest ID used to create/update the schema attribute
5125
+ */
5126
+ _manifest?: string /* uuid */[] | null;
4930
5127
  /**
4931
5128
  * A set of constraints applicable to the attribute.
4932
5129
  * These constraints should and will be enforced by the attribute renderer.
@@ -5059,6 +5256,10 @@ declare namespace Components {
5059
5256
  * taxonomy-slug:classification-slug
5060
5257
  */
5061
5258
  ClassificationId[];
5259
+ /**
5260
+ * Manifest ID used to create/update the schema attribute
5261
+ */
5262
+ _manifest?: string /* uuid */[] | null;
5062
5263
  /**
5063
5264
  * A set of constraints applicable to the attribute.
5064
5265
  * These constraints should and will be enforced by the attribute renderer.
@@ -5200,6 +5401,10 @@ declare namespace Components {
5200
5401
  * taxonomy-slug:classification-slug
5201
5402
  */
5202
5403
  ClassificationId[];
5404
+ /**
5405
+ * Manifest ID used to create/update the taxonomy classification
5406
+ */
5407
+ _manifest?: string /* uuid */[] | null;
5203
5408
  /**
5204
5409
  * A set of constraints applicable to the attribute.
5205
5410
  * These constraints should and will be enforced by the attribute renderer.
@@ -5360,6 +5565,10 @@ declare namespace Components {
5360
5565
  * taxonomy-slug:classification-slug
5361
5566
  */
5362
5567
  ClassificationId[];
5568
+ /**
5569
+ * Manifest ID used to create/update the schema attribute
5570
+ */
5571
+ _manifest?: string /* uuid */[] | null;
5363
5572
  /**
5364
5573
  * A set of constraints applicable to the attribute.
5365
5574
  * These constraints should and will be enforced by the attribute renderer.
@@ -5746,6 +5955,10 @@ declare namespace Components {
5746
5955
  * taxonomy-slug:classification-slug
5747
5956
  */
5748
5957
  ClassificationId[];
5958
+ /**
5959
+ * Manifest ID used to create/update the schema attribute
5960
+ */
5961
+ _manifest?: string /* uuid */[] | null;
5749
5962
  /**
5750
5963
  * A set of constraints applicable to the attribute.
5751
5964
  * These constraints should and will be enforced by the attribute renderer.
@@ -6211,6 +6424,10 @@ declare namespace Components {
6211
6424
  * taxonomy-slug:classification-slug
6212
6425
  */
6213
6426
  ClassificationId[];
6427
+ /**
6428
+ * Manifest ID used to create/update the schema attribute
6429
+ */
6430
+ _manifest?: string /* uuid */[] | null;
6214
6431
  /**
6215
6432
  * A set of constraints applicable to the attribute.
6216
6433
  * These constraints should and will be enforced by the attribute renderer.
@@ -6351,6 +6568,10 @@ declare namespace Components {
6351
6568
  * taxonomy-slug:classification-slug
6352
6569
  */
6353
6570
  ClassificationId[];
6571
+ /**
6572
+ * Manifest ID used to create/update the schema attribute
6573
+ */
6574
+ _manifest?: string /* uuid */[] | null;
6354
6575
  /**
6355
6576
  * A set of constraints applicable to the attribute.
6356
6577
  * These constraints should and will be enforced by the attribute renderer.
@@ -6500,6 +6721,10 @@ declare namespace Components {
6500
6721
  * taxonomy-slug:classification-slug
6501
6722
  */
6502
6723
  ClassificationId[];
6724
+ /**
6725
+ * Manifest ID used to create/update the schema attribute
6726
+ */
6727
+ _manifest?: string /* uuid */[] | null;
6503
6728
  /**
6504
6729
  * A set of constraints applicable to the attribute.
6505
6730
  * These constraints should and will be enforced by the attribute renderer.
@@ -6702,6 +6927,10 @@ declare namespace Components {
6702
6927
  * taxonomy-slug:classification-slug
6703
6928
  */
6704
6929
  ClassificationId[];
6930
+ /**
6931
+ * Manifest ID used to create/update the schema attribute
6932
+ */
6933
+ _manifest?: string /* uuid */[] | null;
6705
6934
  /**
6706
6935
  * A set of constraints applicable to the attribute.
6707
6936
  * These constraints should and will be enforced by the attribute renderer.
@@ -6860,6 +7089,10 @@ declare namespace Components {
6860
7089
  ClassificationId[];
6861
7090
  created_at?: string; // date-time
6862
7091
  updated_at?: string; // date-time
7092
+ /**
7093
+ * Manifest ID used to create/update the taxonomy classification
7094
+ */
7095
+ _manifest?: string /* uuid */[] | null;
6863
7096
  }
6864
7097
  export type TaxonomyLocationId = "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment";
6865
7098
  /**
@@ -6934,6 +7167,10 @@ declare namespace Components {
6934
7167
  * taxonomy-slug:classification-slug
6935
7168
  */
6936
7169
  ClassificationId[];
7170
+ /**
7171
+ * Manifest ID used to create/update the schema attribute
7172
+ */
7173
+ _manifest?: string /* uuid */[] | null;
6937
7174
  /**
6938
7175
  * A set of constraints applicable to the attribute.
6939
7176
  * These constraints should and will be enforced by the attribute renderer.
@@ -7067,6 +7304,10 @@ declare namespace Components {
7067
7304
  * taxonomy-slug:classification-slug
7068
7305
  */
7069
7306
  ClassificationId[];
7307
+ /**
7308
+ * Manifest ID used to create/update the schema attribute
7309
+ */
7310
+ _manifest?: string /* uuid */[] | null;
7070
7311
  /**
7071
7312
  * A set of constraints applicable to the attribute.
7072
7313
  * These constraints should and will be enforced by the attribute renderer.
@@ -7260,6 +7501,7 @@ declare namespace Paths {
7260
7501
  * contact
7261
7502
  */
7262
7503
  Components.Schemas.EntitySlug;
7504
+ export type Validate = boolean;
7263
7505
  }
7264
7506
  export interface PathParameters {
7265
7507
  slug: Parameters.Slug;
@@ -7268,6 +7510,7 @@ declare namespace Paths {
7268
7510
  activity_id?: Parameters.ActivityId;
7269
7511
  fill_activity?: Parameters.FillActivity;
7270
7512
  async?: Parameters.Async;
7513
+ validate?: Parameters.Validate;
7271
7514
  }
7272
7515
  export type RequestBody = /**
7273
7516
  * example:
@@ -7353,6 +7596,7 @@ declare namespace Paths {
7353
7596
  * }
7354
7597
  */
7355
7598
  Components.Schemas.EntityItem;
7599
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
7356
7600
  }
7357
7601
  }
7358
7602
  namespace CreateSavedView {
@@ -8703,6 +8947,7 @@ declare namespace Paths {
8703
8947
  * contact
8704
8948
  */
8705
8949
  Components.Schemas.EntitySlug;
8950
+ export type Validate = boolean;
8706
8951
  }
8707
8952
  export interface PathParameters {
8708
8953
  slug: Parameters.Slug;
@@ -8713,6 +8958,7 @@ declare namespace Paths {
8713
8958
  fill_activity?: Parameters.FillActivity;
8714
8959
  dry_run?: Parameters.DryRun;
8715
8960
  async?: Parameters.Async;
8961
+ validate?: Parameters.Validate;
8716
8962
  }
8717
8963
  export type RequestBody = /**
8718
8964
  * example:
@@ -8800,6 +9046,7 @@ declare namespace Paths {
8800
9046
  Components.Schemas.EntityItem;
8801
9047
  export interface $409 {
8802
9048
  }
9049
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
8803
9050
  }
8804
9051
  }
8805
9052
  namespace PutSchema {
@@ -9106,6 +9353,7 @@ declare namespace Paths {
9106
9353
  * contact
9107
9354
  */
9108
9355
  Components.Schemas.EntitySlug;
9356
+ export type Validate = boolean;
9109
9357
  }
9110
9358
  export interface PathParameters {
9111
9359
  slug: Parameters.Slug;
@@ -9115,6 +9363,7 @@ declare namespace Paths {
9115
9363
  activity_id?: Parameters.ActivityId;
9116
9364
  fill_activity?: Parameters.FillActivity;
9117
9365
  async?: Parameters.Async;
9366
+ validate?: Parameters.Validate;
9118
9367
  }
9119
9368
  export type RequestBody = /**
9120
9369
  * example:
@@ -9200,6 +9449,7 @@ declare namespace Paths {
9200
9449
  * }
9201
9450
  */
9202
9451
  Components.Schemas.EntityItem;
9452
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9203
9453
  }
9204
9454
  }
9205
9455
  namespace UpdateRelation {
@@ -9294,6 +9544,7 @@ declare namespace Paths {
9294
9544
  */
9295
9545
  Components.Schemas.EntitySlug;
9296
9546
  export type Strict = boolean;
9547
+ export type Validate = boolean;
9297
9548
  }
9298
9549
  export interface PathParameters {
9299
9550
  slug: Parameters.Slug;
@@ -9303,6 +9554,7 @@ declare namespace Paths {
9303
9554
  fill_activity?: Parameters.FillActivity;
9304
9555
  dry_run?: Parameters.DryRun;
9305
9556
  async?: Parameters.Async;
9557
+ validate?: Parameters.Validate;
9306
9558
  strict?: Parameters.Strict;
9307
9559
  }
9308
9560
  export interface RequestBody {
@@ -9449,6 +9701,7 @@ declare namespace Paths {
9449
9701
  }
9450
9702
  export interface $409 {
9451
9703
  }
9704
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9452
9705
  }
9453
9706
  }
9454
9707
  namespace ValidateEntity {
@@ -9509,6 +9762,64 @@ declare namespace Paths {
9509
9762
  export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
9510
9763
  }
9511
9764
  }
9765
+ namespace ValidateEntityV2 {
9766
+ namespace Parameters {
9767
+ /**
9768
+ * URL-friendly identifier for the entity schema
9769
+ * example:
9770
+ * price
9771
+ */
9772
+ export type Slug = string;
9773
+ }
9774
+ export interface PathParameters {
9775
+ slug: /**
9776
+ * URL-friendly identifier for the entity schema
9777
+ * example:
9778
+ * price
9779
+ */
9780
+ Parameters.Slug;
9781
+ }
9782
+ export type RequestBody = /**
9783
+ * example:
9784
+ * {
9785
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9786
+ * "_org": "123",
9787
+ * "_owners": [
9788
+ * {
9789
+ * "org_id": "123",
9790
+ * "user_id": "123"
9791
+ * }
9792
+ * ],
9793
+ * "_schema": "contact",
9794
+ * "_tags": [
9795
+ * "example",
9796
+ * "mock"
9797
+ * ],
9798
+ * "_created_at": "2021-02-09T12:41:43.662Z",
9799
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
9800
+ * "_acl": {
9801
+ * "view": [
9802
+ * "org:456",
9803
+ * "org:789"
9804
+ * ],
9805
+ * "edit": [
9806
+ * "org:456"
9807
+ * ],
9808
+ * "delete": [
9809
+ * "org:456"
9810
+ * ]
9811
+ * },
9812
+ * "_manifest": [
9813
+ * "123e4567-e89b-12d3-a456-426614174000"
9814
+ * ]
9815
+ * }
9816
+ */
9817
+ Components.Schemas.Entity;
9818
+ namespace Responses {
9819
+ export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationV2ResultSuccess;
9820
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9821
+ }
9822
+ }
9512
9823
  }
9513
9824
 
9514
9825
  export interface OperationMethods {
@@ -9725,6 +10036,16 @@ export interface OperationMethods {
9725
10036
  data?: Paths.ValidateEntity.RequestBody,
9726
10037
  config?: AxiosRequestConfig
9727
10038
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10039
+ /**
10040
+ * validateEntityV2 - validateEntityV2
10041
+ *
10042
+ * Validates an entity against the schema.
10043
+ */
10044
+ 'validateEntityV2'(
10045
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
10046
+ data?: Paths.ValidateEntityV2.RequestBody,
10047
+ config?: AxiosRequestConfig
10048
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
9728
10049
  /**
9729
10050
  * upsertEntity - upsertEntity
9730
10051
  *
@@ -10090,7 +10411,11 @@ export interface OperationMethods {
10090
10411
  /**
10091
10412
  * exportEntities - exportEntities
10092
10413
  *
10093
- * create export file of entities
10414
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
10415
+ * The values exported as in some cases, transformed to human-readable values.
10416
+ *
10417
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
10418
+ *
10094
10419
  */
10095
10420
  'exportEntities'(
10096
10421
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -10686,6 +11011,18 @@ export interface PathsDictionary {
10686
11011
  config?: AxiosRequestConfig
10687
11012
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10688
11013
  }
11014
+ ['/v2/entity/{slug}:validate']: {
11015
+ /**
11016
+ * validateEntityV2 - validateEntityV2
11017
+ *
11018
+ * Validates an entity against the schema.
11019
+ */
11020
+ 'post'(
11021
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
11022
+ data?: Paths.ValidateEntityV2.RequestBody,
11023
+ config?: AxiosRequestConfig
11024
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
11025
+ }
10689
11026
  ['/v1/entity/{slug}:upsert']: {
10690
11027
  /**
10691
11028
  * upsertEntity - upsertEntity
@@ -11080,7 +11417,11 @@ export interface PathsDictionary {
11080
11417
  /**
11081
11418
  * exportEntities - exportEntities
11082
11419
  *
11083
- * create export file of entities
11420
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
11421
+ * The values exported as in some cases, transformed to human-readable values.
11422
+ *
11423
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
11424
+ *
11084
11425
  */
11085
11426
  'post'(
11086
11427
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -11536,6 +11877,10 @@ export type EntityValidationError = Components.Schemas.EntityValidationError;
11536
11877
  export type EntityValidationResult = Components.Schemas.EntityValidationResult;
11537
11878
  export type EntityValidationResultError = Components.Schemas.EntityValidationResultError;
11538
11879
  export type EntityValidationResultSuccess = Components.Schemas.EntityValidationResultSuccess;
11880
+ export type EntityValidationV2Error = Components.Schemas.EntityValidationV2Error;
11881
+ export type EntityValidationV2Result = Components.Schemas.EntityValidationV2Result;
11882
+ export type EntityValidationV2ResultError = Components.Schemas.EntityValidationV2ResultError;
11883
+ export type EntityValidationV2ResultSuccess = Components.Schemas.EntityValidationV2ResultSuccess;
11539
11884
  export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
11540
11885
  export type ExportJobId = Components.Schemas.ExportJobId;
11541
11886
  export type FieldsParam = Components.Schemas.FieldsParam;