@epilot/entity-client 4.31.2 → 4.33.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 {
@@ -2476,6 +2478,16 @@ declare namespace Components {
2476
2478
  * Contacts
2477
2479
  */
2478
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
2479
2491
  /**
2480
2492
  * example:
2481
2493
  * false
@@ -2835,6 +2847,16 @@ declare namespace Components {
2835
2847
  * Contacts
2836
2848
  */
2837
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
2838
2860
  /**
2839
2861
  * example:
2840
2862
  * false
@@ -3335,6 +3357,71 @@ declare namespace Components {
3335
3357
  errors: [
3336
3358
  ];
3337
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
+ }
3338
3425
  export interface EntityViewDisabled {
3339
3426
  view_type?: "disabled";
3340
3427
  }
@@ -3597,6 +3684,11 @@ declare namespace Components {
3597
3684
  type: "headline";
3598
3685
  enable_divider?: boolean;
3599
3686
  divider?: "top_divider" | "bottom_divider";
3687
+ _purpose?: /**
3688
+ * example:
3689
+ * taxonomy-slug:classification-slug
3690
+ */
3691
+ ClassificationId[];
3600
3692
  /**
3601
3693
  * Manifest ID used to create/update the schema group headline
3602
3694
  */
@@ -3621,6 +3713,11 @@ declare namespace Components {
3621
3713
  type: "headline";
3622
3714
  enable_divider?: boolean;
3623
3715
  divider?: "top_divider" | "bottom_divider";
3716
+ _purpose?: /**
3717
+ * example:
3718
+ * taxonomy-slug:classification-slug
3719
+ */
3720
+ ClassificationId[];
3624
3721
  /**
3625
3722
  * Manifest ID used to create/update the schema group headline
3626
3723
  */
@@ -6968,6 +7065,20 @@ declare namespace Components {
6968
7065
  */
6969
7066
  enabled_locations?: TaxonomyLocationId[];
6970
7067
  }
7068
+ export interface TaxonomyBulkJob {
7069
+ job_id?: string; // uuid
7070
+ status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7071
+ type?: TaxonomyBulkJobType;
7072
+ }
7073
+ /**
7074
+ * The status of the bulk job
7075
+ */
7076
+ export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
7077
+ export interface TaxonomyBulkJobTriggerResponse {
7078
+ job_id?: string; // uuid
7079
+ status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7080
+ }
7081
+ export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
6971
7082
  export interface TaxonomyClassification {
6972
7083
  id?: /**
6973
7084
  * example:
@@ -7140,6 +7251,7 @@ declare namespace Components {
7140
7251
  };
7141
7252
  type?: "string";
7142
7253
  multiline?: boolean;
7254
+ rich_text?: boolean;
7143
7255
  }
7144
7256
  /**
7145
7257
  * User Relationship
@@ -7376,6 +7488,47 @@ declare namespace Paths {
7376
7488
  }
7377
7489
  }
7378
7490
  }
7491
+ namespace BulkDeleteClassifications {
7492
+ namespace Parameters {
7493
+ export type Permanent = boolean;
7494
+ }
7495
+ export interface QueryParameters {
7496
+ permanent?: Parameters.Permanent;
7497
+ }
7498
+ export interface RequestBody {
7499
+ classification_ids?: /**
7500
+ * example:
7501
+ * taxonomy-slug:classification-slug
7502
+ */
7503
+ Components.Schemas.ClassificationId[];
7504
+ }
7505
+ namespace Responses {
7506
+ export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
7507
+ }
7508
+ }
7509
+ namespace BulkMoveClassifications {
7510
+ namespace Parameters {
7511
+ export type TargetTaxonomy = /**
7512
+ * URL-friendly name for taxonomy
7513
+ * example:
7514
+ * purpose
7515
+ */
7516
+ Components.Schemas.TaxonomySlug;
7517
+ }
7518
+ export interface QueryParameters {
7519
+ target_taxonomy?: Parameters.TargetTaxonomy;
7520
+ }
7521
+ export interface RequestBody {
7522
+ classification_ids?: /**
7523
+ * example:
7524
+ * taxonomy-slug:classification-slug
7525
+ */
7526
+ Components.Schemas.ClassificationId[];
7527
+ }
7528
+ namespace Responses {
7529
+ export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
7530
+ }
7531
+ }
7379
7532
  namespace CreateActivity {
7380
7533
  namespace Parameters {
7381
7534
  export type Entities = Components.Schemas.EntityId /* uuid */[];
@@ -7404,6 +7557,7 @@ declare namespace Paths {
7404
7557
  * contact
7405
7558
  */
7406
7559
  Components.Schemas.EntitySlug;
7560
+ export type Validate = boolean;
7407
7561
  }
7408
7562
  export interface PathParameters {
7409
7563
  slug: Parameters.Slug;
@@ -7412,6 +7566,7 @@ declare namespace Paths {
7412
7566
  activity_id?: Parameters.ActivityId;
7413
7567
  fill_activity?: Parameters.FillActivity;
7414
7568
  async?: Parameters.Async;
7569
+ validate?: Parameters.Validate;
7415
7570
  }
7416
7571
  export type RequestBody = /**
7417
7572
  * example:
@@ -7497,6 +7652,7 @@ declare namespace Paths {
7497
7652
  * }
7498
7653
  */
7499
7654
  Components.Schemas.EntityItem;
7655
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
7500
7656
  }
7501
7657
  }
7502
7658
  namespace CreateSavedView {
@@ -8028,6 +8184,17 @@ declare namespace Paths {
8028
8184
  Components.Schemas.EntityItem;
8029
8185
  }
8030
8186
  }
8187
+ namespace GetJobs {
8188
+ namespace Parameters {
8189
+ export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
8190
+ }
8191
+ export interface QueryParameters {
8192
+ status?: Parameters.Status;
8193
+ }
8194
+ namespace Responses {
8195
+ export type $200 = Components.Schemas.TaxonomyBulkJob[];
8196
+ }
8197
+ }
8031
8198
  namespace GetJsonSchema {
8032
8199
  namespace Parameters {
8033
8200
  export type Slug = /**
@@ -8847,6 +9014,7 @@ declare namespace Paths {
8847
9014
  * contact
8848
9015
  */
8849
9016
  Components.Schemas.EntitySlug;
9017
+ export type Validate = boolean;
8850
9018
  }
8851
9019
  export interface PathParameters {
8852
9020
  slug: Parameters.Slug;
@@ -8857,6 +9025,7 @@ declare namespace Paths {
8857
9025
  fill_activity?: Parameters.FillActivity;
8858
9026
  dry_run?: Parameters.DryRun;
8859
9027
  async?: Parameters.Async;
9028
+ validate?: Parameters.Validate;
8860
9029
  }
8861
9030
  export type RequestBody = /**
8862
9031
  * example:
@@ -8944,6 +9113,7 @@ declare namespace Paths {
8944
9113
  Components.Schemas.EntityItem;
8945
9114
  export interface $409 {
8946
9115
  }
9116
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
8947
9117
  }
8948
9118
  }
8949
9119
  namespace PutSchema {
@@ -9250,6 +9420,7 @@ declare namespace Paths {
9250
9420
  * contact
9251
9421
  */
9252
9422
  Components.Schemas.EntitySlug;
9423
+ export type Validate = boolean;
9253
9424
  }
9254
9425
  export interface PathParameters {
9255
9426
  slug: Parameters.Slug;
@@ -9259,6 +9430,7 @@ declare namespace Paths {
9259
9430
  activity_id?: Parameters.ActivityId;
9260
9431
  fill_activity?: Parameters.FillActivity;
9261
9432
  async?: Parameters.Async;
9433
+ validate?: Parameters.Validate;
9262
9434
  }
9263
9435
  export type RequestBody = /**
9264
9436
  * example:
@@ -9344,6 +9516,7 @@ declare namespace Paths {
9344
9516
  * }
9345
9517
  */
9346
9518
  Components.Schemas.EntityItem;
9519
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9347
9520
  }
9348
9521
  }
9349
9522
  namespace UpdateRelation {
@@ -9438,6 +9611,7 @@ declare namespace Paths {
9438
9611
  */
9439
9612
  Components.Schemas.EntitySlug;
9440
9613
  export type Strict = boolean;
9614
+ export type Validate = boolean;
9441
9615
  }
9442
9616
  export interface PathParameters {
9443
9617
  slug: Parameters.Slug;
@@ -9447,6 +9621,7 @@ declare namespace Paths {
9447
9621
  fill_activity?: Parameters.FillActivity;
9448
9622
  dry_run?: Parameters.DryRun;
9449
9623
  async?: Parameters.Async;
9624
+ validate?: Parameters.Validate;
9450
9625
  strict?: Parameters.Strict;
9451
9626
  }
9452
9627
  export interface RequestBody {
@@ -9593,6 +9768,7 @@ declare namespace Paths {
9593
9768
  }
9594
9769
  export interface $409 {
9595
9770
  }
9771
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9596
9772
  }
9597
9773
  }
9598
9774
  namespace ValidateEntity {
@@ -9653,6 +9829,64 @@ declare namespace Paths {
9653
9829
  export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
9654
9830
  }
9655
9831
  }
9832
+ namespace ValidateEntityV2 {
9833
+ namespace Parameters {
9834
+ /**
9835
+ * URL-friendly identifier for the entity schema
9836
+ * example:
9837
+ * price
9838
+ */
9839
+ export type Slug = string;
9840
+ }
9841
+ export interface PathParameters {
9842
+ slug: /**
9843
+ * URL-friendly identifier for the entity schema
9844
+ * example:
9845
+ * price
9846
+ */
9847
+ Parameters.Slug;
9848
+ }
9849
+ export type RequestBody = /**
9850
+ * example:
9851
+ * {
9852
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9853
+ * "_org": "123",
9854
+ * "_owners": [
9855
+ * {
9856
+ * "org_id": "123",
9857
+ * "user_id": "123"
9858
+ * }
9859
+ * ],
9860
+ * "_schema": "contact",
9861
+ * "_tags": [
9862
+ * "example",
9863
+ * "mock"
9864
+ * ],
9865
+ * "_created_at": "2021-02-09T12:41:43.662Z",
9866
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
9867
+ * "_acl": {
9868
+ * "view": [
9869
+ * "org:456",
9870
+ * "org:789"
9871
+ * ],
9872
+ * "edit": [
9873
+ * "org:456"
9874
+ * ],
9875
+ * "delete": [
9876
+ * "org:456"
9877
+ * ]
9878
+ * },
9879
+ * "_manifest": [
9880
+ * "123e4567-e89b-12d3-a456-426614174000"
9881
+ * ]
9882
+ * }
9883
+ */
9884
+ Components.Schemas.Entity;
9885
+ namespace Responses {
9886
+ export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationV2ResultSuccess;
9887
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9888
+ }
9889
+ }
9656
9890
  }
9657
9891
 
9658
9892
  export interface OperationMethods {
@@ -9869,6 +10103,16 @@ export interface OperationMethods {
9869
10103
  data?: Paths.ValidateEntity.RequestBody,
9870
10104
  config?: AxiosRequestConfig
9871
10105
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10106
+ /**
10107
+ * validateEntityV2 - validateEntityV2
10108
+ *
10109
+ * Validates an entity against the schema.
10110
+ */
10111
+ 'validateEntityV2'(
10112
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
10113
+ data?: Paths.ValidateEntityV2.RequestBody,
10114
+ config?: AxiosRequestConfig
10115
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
9872
10116
  /**
9873
10117
  * upsertEntity - upsertEntity
9874
10118
  *
@@ -10234,7 +10478,11 @@ export interface OperationMethods {
10234
10478
  /**
10235
10479
  * exportEntities - exportEntities
10236
10480
  *
10237
- * create export file of entities
10481
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
10482
+ * The values exported as in some cases, transformed to human-readable values.
10483
+ *
10484
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
10485
+ *
10238
10486
  */
10239
10487
  'exportEntities'(
10240
10488
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -10364,6 +10612,46 @@ export interface OperationMethods {
10364
10612
  data?: any,
10365
10613
  config?: AxiosRequestConfig
10366
10614
  ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
10615
+ /**
10616
+ * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
10617
+ *
10618
+ * Update the classifications for a taxonomy
10619
+ */
10620
+ 'updateClassificationsForTaxonomy'(
10621
+ parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
10622
+ data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
10623
+ config?: AxiosRequestConfig
10624
+ ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
10625
+ /**
10626
+ * getTaxonomyClassification - getTaxonomyClassification
10627
+ *
10628
+ * Get a classification for a taxonomy
10629
+ */
10630
+ 'getTaxonomyClassification'(
10631
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
10632
+ data?: any,
10633
+ config?: AxiosRequestConfig
10634
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
10635
+ /**
10636
+ * updateTaxonomyClassification - updateTaxonomyClassification
10637
+ *
10638
+ * Update a classification for a taxonomy
10639
+ */
10640
+ 'updateTaxonomyClassification'(
10641
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
10642
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
10643
+ config?: AxiosRequestConfig
10644
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
10645
+ /**
10646
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
10647
+ *
10648
+ * Delete a classification for a taxonomy
10649
+ */
10650
+ 'deleteTaxonomyClassification'(
10651
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
10652
+ data?: any,
10653
+ config?: AxiosRequestConfig
10654
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
10367
10655
  /**
10368
10656
  * taxonomyAutocomplete - taxonomyAutocomplete
10369
10657
  *
@@ -10384,16 +10672,6 @@ export interface OperationMethods {
10384
10672
  data?: Paths.TaxonomiesClassificationsSearch.RequestBody,
10385
10673
  config?: AxiosRequestConfig
10386
10674
  ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
10387
- /**
10388
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
10389
- *
10390
- * Update the classifications for a taxonomy
10391
- */
10392
- 'updateClassificationsForTaxonomy'(
10393
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
10394
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
10395
- config?: AxiosRequestConfig
10396
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
10397
10675
  /**
10398
10676
  * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
10399
10677
  *
@@ -10405,35 +10683,39 @@ export interface OperationMethods {
10405
10683
  config?: AxiosRequestConfig
10406
10684
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
10407
10685
  /**
10408
- * getTaxonomyClassification - getTaxonomyClassification
10686
+ * getJobs - getJobs
10409
10687
  *
10410
- * Get a classification for a taxonomy
10688
+ * Gets bulk jobs by job status
10411
10689
  */
10412
- 'getTaxonomyClassification'(
10413
- parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
10690
+ 'getJobs'(
10691
+ parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
10414
10692
  data?: any,
10415
10693
  config?: AxiosRequestConfig
10416
- ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
10694
+ ): OperationResponse<Paths.GetJobs.Responses.$200>
10417
10695
  /**
10418
- * updateTaxonomyClassification - updateTaxonomyClassification
10696
+ * bulkMoveClassifications - bulkMoveClassifications
10697
+ *
10698
+ * Moves classifications from one taxonomy to another, through a bulk async operation which
10699
+ * also updates all references from the old classification to the new one under the target taxonomy.
10419
10700
  *
10420
- * Update a classification for a taxonomy
10421
10701
  */
10422
- 'updateTaxonomyClassification'(
10423
- parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
10424
- data?: Paths.UpdateTaxonomyClassification.RequestBody,
10702
+ 'bulkMoveClassifications'(
10703
+ parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
10704
+ data?: Paths.BulkMoveClassifications.RequestBody,
10425
10705
  config?: AxiosRequestConfig
10426
- ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
10706
+ ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
10427
10707
  /**
10428
- * deleteTaxonomyClassification - deleteTaxonomyClassification
10708
+ * bulkDeleteClassifications - bulkDeleteClassifications
10709
+ *
10710
+ * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
10711
+ * async operation which also deletes all references of the deleted classifications from the entities referencing them.
10429
10712
  *
10430
- * Delete a classification for a taxonomy
10431
10713
  */
10432
- 'deleteTaxonomyClassification'(
10433
- parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
10434
- data?: any,
10714
+ 'bulkDeleteClassifications'(
10715
+ parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
10716
+ data?: Paths.BulkDeleteClassifications.RequestBody,
10435
10717
  config?: AxiosRequestConfig
10436
- ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
10718
+ ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
10437
10719
  /**
10438
10720
  * createSchemaAttribute - createSchemaAttribute
10439
10721
  *
@@ -10830,6 +11112,18 @@ export interface PathsDictionary {
10830
11112
  config?: AxiosRequestConfig
10831
11113
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10832
11114
  }
11115
+ ['/v2/entity/{slug}:validate']: {
11116
+ /**
11117
+ * validateEntityV2 - validateEntityV2
11118
+ *
11119
+ * Validates an entity against the schema.
11120
+ */
11121
+ 'post'(
11122
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
11123
+ data?: Paths.ValidateEntityV2.RequestBody,
11124
+ config?: AxiosRequestConfig
11125
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
11126
+ }
10833
11127
  ['/v1/entity/{slug}:upsert']: {
10834
11128
  /**
10835
11129
  * upsertEntity - upsertEntity
@@ -11224,7 +11518,11 @@ export interface PathsDictionary {
11224
11518
  /**
11225
11519
  * exportEntities - exportEntities
11226
11520
  *
11227
- * create export file of entities
11521
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
11522
+ * The values exported as in some cases, transformed to human-readable values.
11523
+ *
11524
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
11525
+ *
11228
11526
  */
11229
11527
  'post'(
11230
11528
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -11369,6 +11667,50 @@ export interface PathsDictionary {
11369
11667
  config?: AxiosRequestConfig
11370
11668
  ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
11371
11669
  }
11670
+ ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
11671
+ /**
11672
+ * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
11673
+ *
11674
+ * Update the classifications for a taxonomy
11675
+ */
11676
+ 'post'(
11677
+ parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
11678
+ data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
11679
+ config?: AxiosRequestConfig
11680
+ ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
11681
+ }
11682
+ ['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
11683
+ /**
11684
+ * getTaxonomyClassification - getTaxonomyClassification
11685
+ *
11686
+ * Get a classification for a taxonomy
11687
+ */
11688
+ 'get'(
11689
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
11690
+ data?: any,
11691
+ config?: AxiosRequestConfig
11692
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
11693
+ /**
11694
+ * updateTaxonomyClassification - updateTaxonomyClassification
11695
+ *
11696
+ * Update a classification for a taxonomy
11697
+ */
11698
+ 'put'(
11699
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
11700
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
11701
+ config?: AxiosRequestConfig
11702
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
11703
+ /**
11704
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
11705
+ *
11706
+ * Delete a classification for a taxonomy
11707
+ */
11708
+ 'delete'(
11709
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
11710
+ data?: any,
11711
+ config?: AxiosRequestConfig
11712
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
11713
+ }
11372
11714
  ['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
11373
11715
  /**
11374
11716
  * taxonomyAutocomplete - taxonomyAutocomplete
@@ -11393,18 +11735,6 @@ export interface PathsDictionary {
11393
11735
  config?: AxiosRequestConfig
11394
11736
  ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
11395
11737
  }
11396
- ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
11397
- /**
11398
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
11399
- *
11400
- * Update the classifications for a taxonomy
11401
- */
11402
- 'post'(
11403
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
11404
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
11405
- config?: AxiosRequestConfig
11406
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
11407
- }
11408
11738
  ['/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}']: {
11409
11739
  /**
11410
11740
  * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
@@ -11417,37 +11747,45 @@ export interface PathsDictionary {
11417
11747
  config?: AxiosRequestConfig
11418
11748
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
11419
11749
  }
11420
- ['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
11750
+ ['/v1/entity/taxonomies/jobs']: {
11421
11751
  /**
11422
- * getTaxonomyClassification - getTaxonomyClassification
11752
+ * getJobs - getJobs
11423
11753
  *
11424
- * Get a classification for a taxonomy
11754
+ * Gets bulk jobs by job status
11425
11755
  */
11426
11756
  'get'(
11427
- parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
11757
+ parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
11428
11758
  data?: any,
11429
11759
  config?: AxiosRequestConfig
11430
- ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
11760
+ ): OperationResponse<Paths.GetJobs.Responses.$200>
11761
+ }
11762
+ ['/v1/entity/taxonomies/classifications:move']: {
11431
11763
  /**
11432
- * updateTaxonomyClassification - updateTaxonomyClassification
11764
+ * bulkMoveClassifications - bulkMoveClassifications
11765
+ *
11766
+ * Moves classifications from one taxonomy to another, through a bulk async operation which
11767
+ * also updates all references from the old classification to the new one under the target taxonomy.
11433
11768
  *
11434
- * Update a classification for a taxonomy
11435
11769
  */
11436
- 'put'(
11437
- parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
11438
- data?: Paths.UpdateTaxonomyClassification.RequestBody,
11770
+ 'post'(
11771
+ parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
11772
+ data?: Paths.BulkMoveClassifications.RequestBody,
11439
11773
  config?: AxiosRequestConfig
11440
- ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
11774
+ ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
11775
+ }
11776
+ ['/v1/entity/taxonomies/classifications:delete']: {
11441
11777
  /**
11442
- * deleteTaxonomyClassification - deleteTaxonomyClassification
11778
+ * bulkDeleteClassifications - bulkDeleteClassifications
11779
+ *
11780
+ * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
11781
+ * async operation which also deletes all references of the deleted classifications from the entities referencing them.
11443
11782
  *
11444
- * Delete a classification for a taxonomy
11445
11783
  */
11446
- 'delete'(
11447
- parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
11448
- data?: any,
11784
+ 'post'(
11785
+ parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
11786
+ data?: Paths.BulkDeleteClassifications.RequestBody,
11449
11787
  config?: AxiosRequestConfig
11450
- ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
11788
+ ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
11451
11789
  }
11452
11790
  ['/v1/entity/schemas/attributes']: {
11453
11791
  /**
@@ -11680,6 +12018,10 @@ export type EntityValidationError = Components.Schemas.EntityValidationError;
11680
12018
  export type EntityValidationResult = Components.Schemas.EntityValidationResult;
11681
12019
  export type EntityValidationResultError = Components.Schemas.EntityValidationResultError;
11682
12020
  export type EntityValidationResultSuccess = Components.Schemas.EntityValidationResultSuccess;
12021
+ export type EntityValidationV2Error = Components.Schemas.EntityValidationV2Error;
12022
+ export type EntityValidationV2Result = Components.Schemas.EntityValidationV2Result;
12023
+ export type EntityValidationV2ResultError = Components.Schemas.EntityValidationV2ResultError;
12024
+ export type EntityValidationV2ResultSuccess = Components.Schemas.EntityValidationV2ResultSuccess;
11683
12025
  export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
11684
12026
  export type ExportJobId = Components.Schemas.ExportJobId;
11685
12027
  export type FieldsParam = Components.Schemas.FieldsParam;
@@ -11727,6 +12069,10 @@ export type SummaryAttribute = Components.Schemas.SummaryAttribute;
11727
12069
  export type SummaryField = Components.Schemas.SummaryField;
11728
12070
  export type TagsAttribute = Components.Schemas.TagsAttribute;
11729
12071
  export type Taxonomy = Components.Schemas.Taxonomy;
12072
+ export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
12073
+ export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
12074
+ export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
12075
+ export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
11730
12076
  export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
11731
12077
  export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
11732
12078
  export type TaxonomySlug = Components.Schemas.TaxonomySlug;