@epilot/entity-client 4.21.0-rc.3 → 4.22.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
@@ -54,8 +54,9 @@ declare namespace Components {
54
54
  */
55
55
  Schemas.EntitySlug[];
56
56
  export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
57
+ export type TaxonomyClassificationSlugPathParam = string;
57
58
  export type TaxonomySlugPathParam = string;
58
- export type TaxonomySlugQueryParam = string;
59
+ export type TaxonomySlugQueryParamOptional = string;
59
60
  }
60
61
  export interface PathParameters {
61
62
  EntityIdPathParam?: Parameters.EntityIdPathParam;
@@ -67,11 +68,12 @@ declare namespace Components {
67
68
  */
68
69
  Parameters.EntitySlugPathPriceParam;
69
70
  TaxonomySlugPathParam?: Parameters.TaxonomySlugPathParam;
71
+ TaxonomyClassificationSlugPathParam?: Parameters.TaxonomyClassificationSlugPathParam;
70
72
  SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
71
73
  ActivityIdPathParam?: Parameters.ActivityIdPathParam;
72
74
  }
73
75
  export interface QueryParameters {
74
- TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
76
+ TaxonomySlugQueryParamOptional?: Parameters.TaxonomySlugQueryParamOptional;
75
77
  AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
76
78
  HydrateEntitiesQueryParam?: Parameters.HydrateEntitiesQueryParam;
77
79
  ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
@@ -273,7 +275,11 @@ declare namespace Components {
273
275
  *
274
276
  */
275
277
  render_condition?: string;
276
- _purpose?: ClassificationId /* uuid */[];
278
+ _purpose?: /**
279
+ * example:
280
+ * taxonomy-slug:classification-slug
281
+ */
282
+ ClassificationId[];
277
283
  /**
278
284
  * A set of constraints applicable to the attribute.
279
285
  * These constraints should and will be enforced by the attribute renderer.
@@ -397,7 +403,11 @@ declare namespace Components {
397
403
  *
398
404
  */
399
405
  render_condition?: string;
400
- _purpose?: ClassificationId /* uuid */[];
406
+ _purpose?: /**
407
+ * example:
408
+ * taxonomy-slug:classification-slug
409
+ */
410
+ ClassificationId[];
401
411
  /**
402
412
  * A set of constraints applicable to the attribute.
403
413
  * These constraints should and will be enforced by the attribute renderer.
@@ -516,7 +526,11 @@ declare namespace Components {
516
526
  *
517
527
  */
518
528
  render_condition?: string;
519
- _purpose?: ClassificationId /* uuid */[];
529
+ _purpose?: /**
530
+ * example:
531
+ * taxonomy-slug:classification-slug
532
+ */
533
+ ClassificationId[];
520
534
  /**
521
535
  * A set of constraints applicable to the attribute.
522
536
  * These constraints should and will be enforced by the attribute renderer.
@@ -702,7 +716,11 @@ declare namespace Components {
702
716
  *
703
717
  */
704
718
  render_condition?: string;
705
- _purpose?: ClassificationId /* uuid */[];
719
+ _purpose?: /**
720
+ * example:
721
+ * taxonomy-slug:classification-slug
722
+ */
723
+ ClassificationId[];
706
724
  /**
707
725
  * A set of constraints applicable to the attribute.
708
726
  * These constraints should and will be enforced by the attribute renderer.
@@ -769,11 +787,19 @@ declare namespace Components {
769
787
  };
770
788
  type?: "boolean";
771
789
  }
772
- export type ClassificationId = string; // uuid
790
+ /**
791
+ * example:
792
+ * taxonomy-slug:classification-slug
793
+ */
794
+ export type ClassificationId = string;
773
795
  export interface ClassificationsUpdate {
774
796
  create?: TaxonomyClassification[];
775
797
  update?: TaxonomyClassification[];
776
- delete?: ClassificationId /* uuid */[];
798
+ delete?: (/**
799
+ * example:
800
+ * taxonomy-slug:classification-slug
801
+ */
802
+ ClassificationId | string)[];
777
803
  }
778
804
  /**
779
805
  * 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)
@@ -830,7 +856,11 @@ declare namespace Components {
830
856
  *
831
857
  */
832
858
  render_condition?: string;
833
- _purpose?: ClassificationId /* uuid */[];
859
+ _purpose?: /**
860
+ * example:
861
+ * taxonomy-slug:classification-slug
862
+ */
863
+ ClassificationId[];
834
864
  /**
835
865
  * A set of constraints applicable to the attribute.
836
866
  * These constraints should and will be enforced by the attribute renderer.
@@ -952,7 +982,11 @@ declare namespace Components {
952
982
  *
953
983
  */
954
984
  render_condition?: string;
955
- _purpose?: ClassificationId /* uuid */[];
985
+ _purpose?: /**
986
+ * example:
987
+ * taxonomy-slug:classification-slug
988
+ */
989
+ ClassificationId[];
956
990
  /**
957
991
  * A set of constraints applicable to the attribute.
958
992
  * These constraints should and will be enforced by the attribute renderer.
@@ -1076,7 +1110,11 @@ declare namespace Components {
1076
1110
  *
1077
1111
  */
1078
1112
  render_condition?: string;
1079
- _purpose?: ClassificationId /* uuid */[];
1113
+ _purpose?: /**
1114
+ * example:
1115
+ * taxonomy-slug:classification-slug
1116
+ */
1117
+ ClassificationId[];
1080
1118
  /**
1081
1119
  * A set of constraints applicable to the attribute.
1082
1120
  * These constraints should and will be enforced by the attribute renderer.
@@ -1198,7 +1236,11 @@ declare namespace Components {
1198
1236
  *
1199
1237
  */
1200
1238
  render_condition?: string;
1201
- _purpose?: ClassificationId /* uuid */[];
1239
+ _purpose?: /**
1240
+ * example:
1241
+ * taxonomy-slug:classification-slug
1242
+ */
1243
+ ClassificationId[];
1202
1244
  /**
1203
1245
  * A set of constraints applicable to the attribute.
1204
1246
  * These constraints should and will be enforced by the attribute renderer.
@@ -1330,7 +1372,11 @@ declare namespace Components {
1330
1372
  *
1331
1373
  */
1332
1374
  render_condition?: string;
1333
- _purpose?: ClassificationId /* uuid */[];
1375
+ _purpose?: /**
1376
+ * example:
1377
+ * taxonomy-slug:classification-slug
1378
+ */
1379
+ ClassificationId[];
1334
1380
  /**
1335
1381
  * A set of constraints applicable to the attribute.
1336
1382
  * These constraints should and will be enforced by the attribute renderer.
@@ -1513,7 +1559,11 @@ declare namespace Components {
1513
1559
  */
1514
1560
  title?: string;
1515
1561
  attributes?: Attribute[];
1516
- _purpose?: ClassificationId /* uuid */[];
1562
+ _purpose?: /**
1563
+ * example:
1564
+ * taxonomy-slug:classification-slug
1565
+ */
1566
+ ClassificationId[];
1517
1567
  ui_hooks?: {
1518
1568
  [name: string]: any;
1519
1569
  /**
@@ -2111,7 +2161,11 @@ declare namespace Components {
2111
2161
  key?: string;
2112
2162
  default?: string;
2113
2163
  };
2114
- _purpose?: ClassificationId /* uuid */[];
2164
+ _purpose?: /**
2165
+ * example:
2166
+ * taxonomy-slug:classification-slug
2167
+ */
2168
+ ClassificationId[];
2115
2169
  }[];
2116
2170
  /**
2117
2171
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
@@ -2366,7 +2420,11 @@ declare namespace Components {
2366
2420
  key?: string;
2367
2421
  default?: string;
2368
2422
  };
2369
- _purpose?: ClassificationId /* uuid */[];
2423
+ _purpose?: /**
2424
+ * example:
2425
+ * taxonomy-slug:classification-slug
2426
+ */
2427
+ ClassificationId[];
2370
2428
  }[];
2371
2429
  /**
2372
2430
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
@@ -2721,7 +2779,11 @@ declare namespace Components {
2721
2779
  *
2722
2780
  */
2723
2781
  render_condition?: string;
2724
- _purpose?: ClassificationId /* uuid */[];
2782
+ _purpose?: /**
2783
+ * example:
2784
+ * taxonomy-slug:classification-slug
2785
+ */
2786
+ ClassificationId[];
2725
2787
  /**
2726
2788
  * A set of constraints applicable to the attribute.
2727
2789
  * These constraints should and will be enforced by the attribute renderer.
@@ -2974,7 +3036,11 @@ declare namespace Components {
2974
3036
  *
2975
3037
  */
2976
3038
  render_condition?: string;
2977
- _purpose?: ClassificationId /* uuid */[];
3039
+ _purpose?: /**
3040
+ * example:
3041
+ * taxonomy-slug:classification-slug
3042
+ */
3043
+ ClassificationId[];
2978
3044
  /**
2979
3045
  * A set of constraints applicable to the attribute.
2980
3046
  * These constraints should and will be enforced by the attribute renderer.
@@ -3096,7 +3162,11 @@ declare namespace Components {
3096
3162
  *
3097
3163
  */
3098
3164
  render_condition?: string;
3099
- _purpose?: ClassificationId /* uuid */[];
3165
+ _purpose?: /**
3166
+ * example:
3167
+ * taxonomy-slug:classification-slug
3168
+ */
3169
+ ClassificationId[];
3100
3170
  /**
3101
3171
  * A set of constraints applicable to the attribute.
3102
3172
  * These constraints should and will be enforced by the attribute renderer.
@@ -3218,7 +3288,11 @@ declare namespace Components {
3218
3288
  *
3219
3289
  */
3220
3290
  render_condition?: string;
3221
- _purpose?: ClassificationId /* uuid */[];
3291
+ _purpose?: /**
3292
+ * example:
3293
+ * taxonomy-slug:classification-slug
3294
+ */
3295
+ ClassificationId[];
3222
3296
  /**
3223
3297
  * A set of constraints applicable to the attribute.
3224
3298
  * These constraints should and will be enforced by the attribute renderer.
@@ -3348,7 +3422,11 @@ declare namespace Components {
3348
3422
  *
3349
3423
  */
3350
3424
  render_condition?: string;
3351
- _purpose?: ClassificationId /* uuid */[];
3425
+ _purpose?: /**
3426
+ * example:
3427
+ * taxonomy-slug:classification-slug
3428
+ */
3429
+ ClassificationId[];
3352
3430
  /**
3353
3431
  * A set of constraints applicable to the attribute.
3354
3432
  * These constraints should and will be enforced by the attribute renderer.
@@ -3415,6 +3493,14 @@ declare namespace Components {
3415
3493
  };
3416
3494
  type?: "link";
3417
3495
  }
3496
+ export interface ListSavedViewsResults {
3497
+ /**
3498
+ * example:
3499
+ * 1
3500
+ */
3501
+ hits?: number;
3502
+ results?: /* A saved entity view */ SavedViewItem[];
3503
+ }
3418
3504
  /**
3419
3505
  * Multi Choice Selection
3420
3506
  */
@@ -3470,7 +3556,11 @@ declare namespace Components {
3470
3556
  *
3471
3557
  */
3472
3558
  render_condition?: string;
3473
- _purpose?: ClassificationId /* uuid */[];
3559
+ _purpose?: /**
3560
+ * example:
3561
+ * taxonomy-slug:classification-slug
3562
+ */
3563
+ ClassificationId[];
3474
3564
  /**
3475
3565
  * A set of constraints applicable to the attribute.
3476
3566
  * These constraints should and will be enforced by the attribute renderer.
@@ -3608,7 +3698,11 @@ declare namespace Components {
3608
3698
  *
3609
3699
  */
3610
3700
  render_condition?: string;
3611
- _purpose?: ClassificationId /* uuid */[];
3701
+ _purpose?: /**
3702
+ * example:
3703
+ * taxonomy-slug:classification-slug
3704
+ */
3705
+ ClassificationId[];
3612
3706
  /**
3613
3707
  * A set of constraints applicable to the attribute.
3614
3708
  * These constraints should and will be enforced by the attribute renderer.
@@ -3731,7 +3825,11 @@ declare namespace Components {
3731
3825
  *
3732
3826
  */
3733
3827
  render_condition?: string;
3734
- _purpose?: ClassificationId /* uuid */[];
3828
+ _purpose?: /**
3829
+ * example:
3830
+ * taxonomy-slug:classification-slug
3831
+ */
3832
+ ClassificationId[];
3735
3833
  /**
3736
3834
  * A set of constraints applicable to the attribute.
3737
3835
  * These constraints should and will be enforced by the attribute renderer.
@@ -3853,7 +3951,11 @@ declare namespace Components {
3853
3951
  *
3854
3952
  */
3855
3953
  render_condition?: string;
3856
- _purpose?: ClassificationId /* uuid */[];
3954
+ _purpose?: /**
3955
+ * example:
3956
+ * taxonomy-slug:classification-slug
3957
+ */
3958
+ ClassificationId[];
3857
3959
  /**
3858
3960
  * A set of constraints applicable to the attribute.
3859
3961
  * These constraints should and will be enforced by the attribute renderer.
@@ -3975,7 +4077,11 @@ declare namespace Components {
3975
4077
  *
3976
4078
  */
3977
4079
  render_condition?: string;
3978
- _purpose?: ClassificationId /* uuid */[];
4080
+ _purpose?: /**
4081
+ * example:
4082
+ * taxonomy-slug:classification-slug
4083
+ */
4084
+ ClassificationId[];
3979
4085
  /**
3980
4086
  * A set of constraints applicable to the attribute.
3981
4087
  * These constraints should and will be enforced by the attribute renderer.
@@ -4097,7 +4203,11 @@ declare namespace Components {
4097
4203
  *
4098
4204
  */
4099
4205
  render_condition?: string;
4100
- _purpose?: ClassificationId /* uuid */[];
4206
+ _purpose?: /**
4207
+ * example:
4208
+ * taxonomy-slug:classification-slug
4209
+ */
4210
+ ClassificationId[];
4101
4211
  /**
4102
4212
  * A set of constraints applicable to the attribute.
4103
4213
  * These constraints should and will be enforced by the attribute renderer.
@@ -4224,7 +4334,11 @@ declare namespace Components {
4224
4334
  *
4225
4335
  */
4226
4336
  render_condition?: string;
4227
- _purpose?: ClassificationId /* uuid */[];
4337
+ _purpose?: /**
4338
+ * example:
4339
+ * taxonomy-slug:classification-slug
4340
+ */
4341
+ ClassificationId[];
4228
4342
  /**
4229
4343
  * A set of constraints applicable to the attribute.
4230
4344
  * These constraints should and will be enforced by the attribute renderer.
@@ -4289,8 +4403,22 @@ declare namespace Components {
4289
4403
  */
4290
4404
  hint_tooltip_placement?: string;
4291
4405
  };
4292
- id?: ClassificationId /* uuid */;
4293
- parents?: ClassificationId /* uuid */[];
4406
+ id?: /**
4407
+ * example:
4408
+ * taxonomy-slug:classification-slug
4409
+ */
4410
+ ClassificationId;
4411
+ /**
4412
+ * URL-friendly identifier for the classification
4413
+ * example:
4414
+ * wallbox-pv
4415
+ */
4416
+ slug?: string;
4417
+ parents?: /**
4418
+ * example:
4419
+ * taxonomy-slug:classification-slug
4420
+ */
4421
+ ClassificationId[];
4294
4422
  created_at?: string; // date-time
4295
4423
  updated_at?: string; // date-time
4296
4424
  type?: "purpose";
@@ -4365,7 +4493,11 @@ declare namespace Components {
4365
4493
  *
4366
4494
  */
4367
4495
  render_condition?: string;
4368
- _purpose?: ClassificationId /* uuid */[];
4496
+ _purpose?: /**
4497
+ * example:
4498
+ * taxonomy-slug:classification-slug
4499
+ */
4500
+ ClassificationId[];
4369
4501
  /**
4370
4502
  * A set of constraints applicable to the attribute.
4371
4503
  * These constraints should and will be enforced by the attribute renderer.
@@ -4724,7 +4856,11 @@ declare namespace Components {
4724
4856
  *
4725
4857
  */
4726
4858
  render_condition?: string;
4727
- _purpose?: ClassificationId /* uuid */[];
4859
+ _purpose?: /**
4860
+ * example:
4861
+ * taxonomy-slug:classification-slug
4862
+ */
4863
+ ClassificationId[];
4728
4864
  /**
4729
4865
  * A set of constraints applicable to the attribute.
4730
4866
  * These constraints should and will be enforced by the attribute renderer.
@@ -5019,7 +5155,11 @@ declare namespace Components {
5019
5155
  *
5020
5156
  */
5021
5157
  render_condition?: string;
5022
- _purpose?: ClassificationId /* uuid */[];
5158
+ _purpose?: /**
5159
+ * example:
5160
+ * taxonomy-slug:classification-slug
5161
+ */
5162
+ ClassificationId[];
5023
5163
  /**
5024
5164
  * A set of constraints applicable to the attribute.
5025
5165
  * These constraints should and will be enforced by the attribute renderer.
@@ -5149,7 +5289,11 @@ declare namespace Components {
5149
5289
  *
5150
5290
  */
5151
5291
  render_condition?: string;
5152
- _purpose?: ClassificationId /* uuid */[];
5292
+ _purpose?: /**
5293
+ * example:
5294
+ * taxonomy-slug:classification-slug
5295
+ */
5296
+ ClassificationId[];
5153
5297
  /**
5154
5298
  * A set of constraints applicable to the attribute.
5155
5299
  * These constraints should and will be enforced by the attribute renderer.
@@ -5288,7 +5432,11 @@ declare namespace Components {
5288
5432
  *
5289
5433
  */
5290
5434
  render_condition?: string;
5291
- _purpose?: ClassificationId /* uuid */[];
5435
+ _purpose?: /**
5436
+ * example:
5437
+ * taxonomy-slug:classification-slug
5438
+ */
5439
+ ClassificationId[];
5292
5440
  /**
5293
5441
  * A set of constraints applicable to the attribute.
5294
5442
  * These constraints should and will be enforced by the attribute renderer.
@@ -5480,7 +5628,11 @@ declare namespace Components {
5480
5628
  *
5481
5629
  */
5482
5630
  render_condition?: string;
5483
- _purpose?: ClassificationId /* uuid */[];
5631
+ _purpose?: /**
5632
+ * example:
5633
+ * taxonomy-slug:classification-slug
5634
+ */
5635
+ ClassificationId[];
5484
5636
  /**
5485
5637
  * A set of constraints applicable to the attribute.
5486
5638
  * These constraints should and will be enforced by the attribute renderer.
@@ -5550,7 +5702,7 @@ declare namespace Components {
5550
5702
  suggestions?: string[];
5551
5703
  }
5552
5704
  export interface Taxonomy {
5553
- slug: /**
5705
+ slug?: /**
5554
5706
  * URL-friendly name for taxonomy
5555
5707
  * example:
5556
5708
  * purpose
@@ -5561,24 +5713,72 @@ declare namespace Components {
5561
5713
  * example:
5562
5714
  * Purpose
5563
5715
  */
5564
- name: string;
5716
+ name?: string;
5565
5717
  /**
5566
- * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags
5718
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
5567
5719
  * example:
5568
5720
  * Purposes
5569
5721
  */
5570
5722
  plural?: string;
5723
+ /**
5724
+ * Kind of taxonomy e.g. system or user_defined. By default, it's empty, which means 'user_defined'
5725
+ * example:
5726
+ * system
5727
+ */
5728
+ kind?: "system" | "user_defined";
5729
+ /**
5730
+ * Icon name for the taxonomy (from epilot360/icons icon set)
5731
+ * example:
5732
+ * purpose
5733
+ */
5734
+ icon?: string;
5735
+ /**
5736
+ * HEX Color code for the taxonomy
5737
+ * example:
5738
+ * #FF5733
5739
+ */
5740
+ color?: string;
5571
5741
  created_at?: string; // date-time
5572
5742
  updated_at?: string; // date-time
5743
+ /**
5744
+ * Date when the taxonomy was soft-deleted (enabled: false)
5745
+ */
5746
+ deleted_at?: string; // date-time
5747
+ /**
5748
+ * User ID of the creator
5749
+ * example:
5750
+ * 10598
5751
+ */
5752
+ created_by?: string;
5753
+ /**
5754
+ * Whether the taxonomy is enabled or not
5755
+ * example:
5756
+ * true
5757
+ */
5758
+ enabled?: boolean;
5573
5759
  }
5574
5760
  export interface TaxonomyClassification {
5575
- id?: ClassificationId /* uuid */;
5761
+ id?: /**
5762
+ * example:
5763
+ * taxonomy-slug:classification-slug
5764
+ */
5765
+ ClassificationId;
5766
+ /**
5767
+ * URL-friendly identifier for the classification
5768
+ * example:
5769
+ * wallbox-pv
5770
+ */
5771
+ slug?: string;
5576
5772
  /**
5577
5773
  * example:
5578
5774
  * Wallbox PV
5579
5775
  */
5580
5776
  name: string;
5581
- parents?: ClassificationId /* uuid */[];
5777
+ parents?: /**
5778
+ * example:
5779
+ * taxonomy-slug:classification-slug
5780
+ */
5781
+ ClassificationId[];
5582
5782
  created_at?: string; // date-time
5583
5783
  updated_at?: string; // date-time
5584
5784
  }
@@ -5643,7 +5843,11 @@ declare namespace Components {
5643
5843
  *
5644
5844
  */
5645
5845
  render_condition?: string;
5646
- _purpose?: ClassificationId /* uuid */[];
5846
+ _purpose?: /**
5847
+ * example:
5848
+ * taxonomy-slug:classification-slug
5849
+ */
5850
+ ClassificationId[];
5647
5851
  /**
5648
5852
  * A set of constraints applicable to the attribute.
5649
5853
  * These constraints should and will be enforced by the attribute renderer.
@@ -5766,7 +5970,11 @@ declare namespace Components {
5766
5970
  *
5767
5971
  */
5768
5972
  render_condition?: string;
5769
- _purpose?: ClassificationId /* uuid */[];
5973
+ _purpose?: /**
5974
+ * example:
5975
+ * taxonomy-slug:classification-slug
5976
+ */
5977
+ ClassificationId[];
5770
5978
  /**
5771
5979
  * A set of constraints applicable to the attribute.
5772
5980
  * These constraints should and will be enforced by the attribute renderer.
@@ -6052,6 +6260,69 @@ declare namespace Paths {
6052
6260
  export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
6053
6261
  }
6054
6262
  }
6263
+ namespace CreateTaxonomy {
6264
+ /**
6265
+ * example:
6266
+ * {
6267
+ * "slug": "product-category",
6268
+ * "name": "Product Category",
6269
+ * "plural": "Product Categories",
6270
+ * "icon": "product-hub",
6271
+ * "color": "#FF5733"
6272
+ * }
6273
+ */
6274
+ export interface RequestBody {
6275
+ slug: /**
6276
+ * URL-friendly name for taxonomy
6277
+ * example:
6278
+ * purpose
6279
+ */
6280
+ Components.Schemas.TaxonomySlug;
6281
+ /**
6282
+ * A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag
6283
+ * example:
6284
+ * Purpose
6285
+ */
6286
+ name: string;
6287
+ /**
6288
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
6289
+ * example:
6290
+ * Purposes
6291
+ */
6292
+ plural?: string;
6293
+ /**
6294
+ * Icon name for the taxonomy (from epilot360/icons icon set)
6295
+ * example:
6296
+ * purpose
6297
+ */
6298
+ icon?: string;
6299
+ /**
6300
+ * HEX Color code for the taxonomy
6301
+ * example:
6302
+ * #FF5733
6303
+ */
6304
+ color?: string;
6305
+ }
6306
+ namespace Responses {
6307
+ export type $201 = Components.Schemas.Taxonomy;
6308
+ export interface $409 {
6309
+ }
6310
+ }
6311
+ }
6312
+ namespace CreateTaxonomyClassification {
6313
+ namespace Parameters {
6314
+ export type TaxonomySlug = string;
6315
+ }
6316
+ export interface PathParameters {
6317
+ taxonomySlug: Parameters.TaxonomySlug;
6318
+ }
6319
+ export type RequestBody = Components.Schemas.TaxonomyClassification;
6320
+ namespace Responses {
6321
+ export type $201 = Components.Schemas.TaxonomyClassification;
6322
+ export interface $409 {
6323
+ }
6324
+ }
6325
+ }
6055
6326
  namespace DeleteEntity {
6056
6327
  namespace Parameters {
6057
6328
  export type ActivityId = /**
@@ -6143,6 +6414,40 @@ declare namespace Paths {
6143
6414
  }
6144
6415
  }
6145
6416
  }
6417
+ namespace DeleteTaxonomy {
6418
+ namespace Parameters {
6419
+ export type Permanent = boolean;
6420
+ export type TaxonomySlug = string;
6421
+ }
6422
+ export interface PathParameters {
6423
+ taxonomySlug: Parameters.TaxonomySlug;
6424
+ }
6425
+ export interface QueryParameters {
6426
+ permanent?: Parameters.Permanent;
6427
+ }
6428
+ namespace Responses {
6429
+ export interface $204 {
6430
+ }
6431
+ }
6432
+ }
6433
+ namespace DeleteTaxonomyClassification {
6434
+ namespace Parameters {
6435
+ export type ClassificationSlug = string;
6436
+ export type Permanent = boolean;
6437
+ export type TaxonomySlug = string;
6438
+ }
6439
+ export interface PathParameters {
6440
+ taxonomySlug: Parameters.TaxonomySlug;
6441
+ classificationSlug: Parameters.ClassificationSlug;
6442
+ }
6443
+ export interface QueryParameters {
6444
+ permanent?: Parameters.Permanent;
6445
+ }
6446
+ namespace Responses {
6447
+ export interface $204 {
6448
+ }
6449
+ }
6450
+ }
6146
6451
  namespace ExportEntities {
6147
6452
  namespace Parameters {
6148
6453
  export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
@@ -6596,9 +6901,7 @@ declare namespace Paths {
6596
6901
  id: Parameters.Id;
6597
6902
  }
6598
6903
  namespace Responses {
6599
- export interface $200 {
6600
- view?: /* A saved entity view */ Components.Schemas.SavedViewItem;
6601
- }
6904
+ export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
6602
6905
  }
6603
6906
  }
6604
6907
  namespace GetSchema {
@@ -6706,20 +7009,43 @@ declare namespace Paths {
6706
7009
  }
6707
7010
  namespace ListSavedViews {
6708
7011
  namespace Parameters {
7012
+ export type Fields = /**
7013
+ * List of entity fields to include or exclude in the response
7014
+ *
7015
+ * Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
7016
+ *
7017
+ * Globbing and globstart (**) is supported for nested fields.
7018
+ *
7019
+ * example:
7020
+ * [
7021
+ * "_id",
7022
+ * "_title",
7023
+ * "first_name",
7024
+ * "account",
7025
+ * "!account.*._files",
7026
+ * "**._product"
7027
+ * ]
7028
+ */
7029
+ Components.Schemas.FieldsParam;
7030
+ export type From = number;
7031
+ export type Size = number;
6709
7032
  export type Slug = /**
6710
7033
  * URL-friendly identifier for the entity schema
6711
7034
  * example:
6712
7035
  * contact
6713
7036
  */
6714
7037
  Components.Schemas.EntitySlug;
7038
+ export type Sort = string;
6715
7039
  }
6716
7040
  export interface QueryParameters {
6717
7041
  slug?: Parameters.Slug;
7042
+ sort?: Parameters.Sort;
7043
+ from?: Parameters.From;
7044
+ size?: Parameters.Size;
7045
+ fields?: Parameters.Fields;
6718
7046
  }
6719
7047
  namespace Responses {
6720
- export interface $200 {
6721
- results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
6722
- }
7048
+ export type $200 = Components.Schemas.ListSavedViewsResults;
6723
7049
  }
6724
7050
  }
6725
7051
  namespace ListSchemaBlueprints {
@@ -6743,6 +7069,12 @@ declare namespace Paths {
6743
7069
  }
6744
7070
  }
6745
7071
  namespace ListTaxonomies {
7072
+ namespace Parameters {
7073
+ export type IncludeDisabled = boolean;
7074
+ }
7075
+ export interface QueryParameters {
7076
+ include_disabled?: Parameters.IncludeDisabled;
7077
+ }
6746
7078
  namespace Responses {
6747
7079
  export interface $200 {
6748
7080
  results?: Components.Schemas.Taxonomy[];
@@ -6912,13 +7244,27 @@ declare namespace Paths {
6912
7244
  }
6913
7245
  namespace TaxonomiesClassificationsSearch {
6914
7246
  namespace Parameters {
7247
+ /**
7248
+ * example:
7249
+ * sales
7250
+ */
7251
+ export type Query = string;
6915
7252
  export type TaxonomySlug = string;
6916
7253
  }
6917
7254
  export interface QueryParameters {
6918
- taxonomySlug: Parameters.TaxonomySlug;
7255
+ taxonomySlug?: Parameters.TaxonomySlug;
7256
+ query?: /**
7257
+ * example:
7258
+ * sales
7259
+ */
7260
+ Parameters.Query;
6919
7261
  }
6920
7262
  export interface RequestBody {
6921
- classificationIds?: Components.Schemas.ClassificationId /* uuid */[];
7263
+ classificationIds?: /**
7264
+ * example:
7265
+ * taxonomy-slug:classification-slug
7266
+ */
7267
+ Components.Schemas.ClassificationId[];
6922
7268
  }
6923
7269
  namespace Responses {
6924
7270
  export interface $200 {
@@ -7115,6 +7461,75 @@ declare namespace Paths {
7115
7461
  export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
7116
7462
  }
7117
7463
  }
7464
+ namespace UpdateTaxonomy {
7465
+ namespace Parameters {
7466
+ export type TaxonomySlug = string;
7467
+ }
7468
+ export interface PathParameters {
7469
+ taxonomySlug: Parameters.TaxonomySlug;
7470
+ }
7471
+ /**
7472
+ * example:
7473
+ * {
7474
+ * "name": "Product Category",
7475
+ * "plural": "Product Categories",
7476
+ * "icon": "product-hub",
7477
+ * "color": "#FF5733",
7478
+ * "enabled": true
7479
+ * }
7480
+ */
7481
+ export interface RequestBody {
7482
+ /**
7483
+ * A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag
7484
+ * example:
7485
+ * Purpose
7486
+ */
7487
+ name?: string;
7488
+ /**
7489
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
7490
+ * example:
7491
+ * Purposes
7492
+ */
7493
+ plural?: string;
7494
+ /**
7495
+ * Icon name for the taxonomy (from epilot360/icons icon set)
7496
+ * example:
7497
+ * purpose
7498
+ */
7499
+ icon?: string;
7500
+ /**
7501
+ * HEX Color code for the taxonomy
7502
+ * example:
7503
+ * #FF5733
7504
+ */
7505
+ color?: string;
7506
+ /**
7507
+ * Whether the taxonomy is enabled or not
7508
+ * example:
7509
+ * true
7510
+ */
7511
+ enabled?: boolean;
7512
+ }
7513
+ namespace Responses {
7514
+ export type $200 = Components.Schemas.Taxonomy;
7515
+ }
7516
+ }
7517
+ namespace UpdateTaxonomyClassification {
7518
+ namespace Parameters {
7519
+ export type ClassificationSlug = string;
7520
+ export type TaxonomySlug = string;
7521
+ }
7522
+ export interface PathParameters {
7523
+ taxonomySlug: Parameters.TaxonomySlug;
7524
+ classificationSlug: Parameters.ClassificationSlug;
7525
+ }
7526
+ export type RequestBody = Components.Schemas.TaxonomyClassification;
7527
+ namespace Responses {
7528
+ export type $200 = Components.Schemas.TaxonomyClassification;
7529
+ export interface $404 {
7530
+ }
7531
+ }
7532
+ }
7118
7533
  namespace UpsertEntity {
7119
7534
  namespace Parameters {
7120
7535
  export type ActivityId = /**
@@ -7944,10 +8359,30 @@ export interface OperationMethods {
7944
8359
  * List taxonomies in an organisation
7945
8360
  */
7946
8361
  'listTaxonomies'(
7947
- parameters?: Parameters<UnknownParamsObject> | null,
8362
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
7948
8363
  data?: any,
7949
8364
  config?: AxiosRequestConfig
7950
8365
  ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8366
+ /**
8367
+ * listTaxonomies - listTaxonomies
8368
+ *
8369
+ * List taxonomies in an organization
8370
+ */
8371
+ 'listTaxonomies'(
8372
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8373
+ data?: any,
8374
+ config?: AxiosRequestConfig
8375
+ ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8376
+ /**
8377
+ * createTaxonomy - createTaxonomy
8378
+ *
8379
+ * Create a new taxonomy
8380
+ */
8381
+ 'createTaxonomy'(
8382
+ parameters?: Parameters<UnknownParamsObject> | null,
8383
+ data?: Paths.CreateTaxonomy.RequestBody,
8384
+ config?: AxiosRequestConfig
8385
+ ): OperationResponse<Paths.CreateTaxonomy.Responses.$201>
7951
8386
  /**
7952
8387
  * getTaxonomy - getTaxonomy
7953
8388
  *
@@ -7958,6 +8393,26 @@ export interface OperationMethods {
7958
8393
  data?: any,
7959
8394
  config?: AxiosRequestConfig
7960
8395
  ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
8396
+ /**
8397
+ * updateTaxonomy - updateTaxonomy
8398
+ *
8399
+ * Update a taxonomy
8400
+ */
8401
+ 'updateTaxonomy'(
8402
+ parameters?: Parameters<Paths.UpdateTaxonomy.PathParameters> | null,
8403
+ data?: Paths.UpdateTaxonomy.RequestBody,
8404
+ config?: AxiosRequestConfig
8405
+ ): OperationResponse<Paths.UpdateTaxonomy.Responses.$200>
8406
+ /**
8407
+ * deleteTaxonomy - deleteTaxonomy
8408
+ *
8409
+ * Delete a taxonomy
8410
+ */
8411
+ 'deleteTaxonomy'(
8412
+ parameters?: Parameters<Paths.DeleteTaxonomy.PathParameters & Paths.DeleteTaxonomy.QueryParameters> | null,
8413
+ data?: any,
8414
+ config?: AxiosRequestConfig
8415
+ ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
7961
8416
  /**
7962
8417
  * taxonomyAutocomplete - taxonomyAutocomplete
7963
8418
  *
@@ -7971,7 +8426,7 @@ export interface OperationMethods {
7971
8426
  /**
7972
8427
  * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
7973
8428
  *
7974
- * List taxonomy classifications in an organisation based on taxonomy slug
8429
+ * List taxonomy classifications in an organization based on taxonomy slug
7975
8430
  */
7976
8431
  'taxonomiesClassificationsSearch'(
7977
8432
  parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
@@ -7981,13 +8436,43 @@ export interface OperationMethods {
7981
8436
  /**
7982
8437
  * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
7983
8438
  *
7984
- * Update taxonomies in an organisation based in taxonomy slug
8439
+ * Update the classifications for a taxonomy
7985
8440
  */
7986
8441
  'updateClassificationsForTaxonomy'(
7987
8442
  parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
7988
8443
  data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
7989
8444
  config?: AxiosRequestConfig
7990
8445
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
8446
+ /**
8447
+ * createTaxonomyClassification - createTaxonomyClassification
8448
+ *
8449
+ * Create a new classification for a taxonomy
8450
+ */
8451
+ 'createTaxonomyClassification'(
8452
+ parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
8453
+ data?: Paths.CreateTaxonomyClassification.RequestBody,
8454
+ config?: AxiosRequestConfig
8455
+ ): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
8456
+ /**
8457
+ * updateTaxonomyClassification - updateTaxonomyClassification
8458
+ *
8459
+ * Update a classification for a taxonomy
8460
+ */
8461
+ 'updateTaxonomyClassification'(
8462
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
8463
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
8464
+ config?: AxiosRequestConfig
8465
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
8466
+ /**
8467
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
8468
+ *
8469
+ * Delete a classification for a taxonomy
8470
+ */
8471
+ 'deleteTaxonomyClassification'(
8472
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
8473
+ data?: any,
8474
+ config?: AxiosRequestConfig
8475
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
7991
8476
  }
7992
8477
 
7993
8478
  export interface PathsDictionary {
@@ -8659,11 +9144,33 @@ export interface PathsDictionary {
8659
9144
  * List taxonomies in an organisation
8660
9145
  */
8661
9146
  'get'(
8662
- parameters?: Parameters<UnknownParamsObject> | null,
9147
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8663
9148
  data?: any,
8664
9149
  config?: AxiosRequestConfig
8665
9150
  ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8666
9151
  }
9152
+ ['/v1/entity/taxonomies']: {
9153
+ /**
9154
+ * listTaxonomies - listTaxonomies
9155
+ *
9156
+ * List taxonomies in an organization
9157
+ */
9158
+ 'get'(
9159
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
9160
+ data?: any,
9161
+ config?: AxiosRequestConfig
9162
+ ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
9163
+ /**
9164
+ * createTaxonomy - createTaxonomy
9165
+ *
9166
+ * Create a new taxonomy
9167
+ */
9168
+ 'post'(
9169
+ parameters?: Parameters<UnknownParamsObject> | null,
9170
+ data?: Paths.CreateTaxonomy.RequestBody,
9171
+ config?: AxiosRequestConfig
9172
+ ): OperationResponse<Paths.CreateTaxonomy.Responses.$201>
9173
+ }
8667
9174
  ['/v1/entity/taxonomies/{taxonomySlug}']: {
8668
9175
  /**
8669
9176
  * getTaxonomy - getTaxonomy
@@ -8675,6 +9182,26 @@ export interface PathsDictionary {
8675
9182
  data?: any,
8676
9183
  config?: AxiosRequestConfig
8677
9184
  ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
9185
+ /**
9186
+ * updateTaxonomy - updateTaxonomy
9187
+ *
9188
+ * Update a taxonomy
9189
+ */
9190
+ 'put'(
9191
+ parameters?: Parameters<Paths.UpdateTaxonomy.PathParameters> | null,
9192
+ data?: Paths.UpdateTaxonomy.RequestBody,
9193
+ config?: AxiosRequestConfig
9194
+ ): OperationResponse<Paths.UpdateTaxonomy.Responses.$200>
9195
+ /**
9196
+ * deleteTaxonomy - deleteTaxonomy
9197
+ *
9198
+ * Delete a taxonomy
9199
+ */
9200
+ 'delete'(
9201
+ parameters?: Parameters<Paths.DeleteTaxonomy.PathParameters & Paths.DeleteTaxonomy.QueryParameters> | null,
9202
+ data?: any,
9203
+ config?: AxiosRequestConfig
9204
+ ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
8678
9205
  }
8679
9206
  ['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
8680
9207
  /**
@@ -8692,7 +9219,7 @@ export interface PathsDictionary {
8692
9219
  /**
8693
9220
  * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
8694
9221
  *
8695
- * List taxonomy classifications in an organisation based on taxonomy slug
9222
+ * List taxonomy classifications in an organization based on taxonomy slug
8696
9223
  */
8697
9224
  'post'(
8698
9225
  parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
@@ -8704,7 +9231,7 @@ export interface PathsDictionary {
8704
9231
  /**
8705
9232
  * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
8706
9233
  *
8707
- * Update taxonomies in an organisation based in taxonomy slug
9234
+ * Update the classifications for a taxonomy
8708
9235
  */
8709
9236
  'post'(
8710
9237
  parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
@@ -8712,6 +9239,40 @@ export interface PathsDictionary {
8712
9239
  config?: AxiosRequestConfig
8713
9240
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
8714
9241
  }
9242
+ ['/v2/entity/taxonomies/{taxonomySlug}/classifications']: {
9243
+ /**
9244
+ * createTaxonomyClassification - createTaxonomyClassification
9245
+ *
9246
+ * Create a new classification for a taxonomy
9247
+ */
9248
+ 'post'(
9249
+ parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
9250
+ data?: Paths.CreateTaxonomyClassification.RequestBody,
9251
+ config?: AxiosRequestConfig
9252
+ ): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
9253
+ }
9254
+ ['/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}']: {
9255
+ /**
9256
+ * updateTaxonomyClassification - updateTaxonomyClassification
9257
+ *
9258
+ * Update a classification for a taxonomy
9259
+ */
9260
+ 'put'(
9261
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
9262
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
9263
+ config?: AxiosRequestConfig
9264
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
9265
+ /**
9266
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
9267
+ *
9268
+ * Delete a classification for a taxonomy
9269
+ */
9270
+ 'delete'(
9271
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
9272
+ data?: any,
9273
+ config?: AxiosRequestConfig
9274
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
9275
+ }
8715
9276
  }
8716
9277
 
8717
9278
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>