@epilot/entity-client 4.21.0-rc.2 → 4.21.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
@@ -31,6 +31,12 @@ declare namespace Components {
31
31
  * contact
32
32
  */
33
33
  Schemas.EntitySlug;
34
+ /**
35
+ * URL-friendly identifier for the entity schema
36
+ * example:
37
+ * price
38
+ */
39
+ export type EntitySlugPathPriceParam = string;
34
40
  export type ExcludeSchemasQueryParam = /**
35
41
  * URL-friendly identifier for the entity schema
36
42
  * example:
@@ -48,13 +54,21 @@ declare namespace Components {
48
54
  */
49
55
  Schemas.EntitySlug[];
50
56
  export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
57
+ export type TaxonomyClassificationSlugPathParam = string;
51
58
  export type TaxonomySlugPathParam = string;
52
59
  export type TaxonomySlugQueryParam = string;
53
60
  }
54
61
  export interface PathParameters {
55
62
  EntityIdPathParam?: Parameters.EntityIdPathParam;
56
63
  EntitySlugPathParam?: Parameters.EntitySlugPathParam;
64
+ EntitySlugPathPriceParam?: /**
65
+ * URL-friendly identifier for the entity schema
66
+ * example:
67
+ * price
68
+ */
69
+ Parameters.EntitySlugPathPriceParam;
57
70
  TaxonomySlugPathParam?: Parameters.TaxonomySlugPathParam;
71
+ TaxonomyClassificationSlugPathParam?: Parameters.TaxonomyClassificationSlugPathParam;
58
72
  SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
59
73
  ActivityIdPathParam?: Parameters.ActivityIdPathParam;
60
74
  }
@@ -281,11 +295,9 @@ declare namespace Components {
281
295
  */
282
296
  feature_flag?: string;
283
297
  /**
284
- * This attribute should only be active when the setting is enabled
285
- * example:
286
- * MY_SETTING
298
+ * This attribute should only be active when all the settings have the correct value
287
299
  */
288
- setting_flag?: string;
300
+ settings_flag?: SettingFlag[];
289
301
  value_formatter?: string;
290
302
  preview_value_formatter?: string;
291
303
  /**
@@ -407,11 +419,9 @@ declare namespace Components {
407
419
  */
408
420
  feature_flag?: string;
409
421
  /**
410
- * This attribute should only be active when the setting is enabled
411
- * example:
412
- * MY_SETTING
422
+ * This attribute should only be active when all the settings have the correct value
413
423
  */
414
- setting_flag?: string;
424
+ settings_flag?: SettingFlag[];
415
425
  value_formatter?: string;
416
426
  preview_value_formatter?: string;
417
427
  /**
@@ -528,11 +538,9 @@ declare namespace Components {
528
538
  */
529
539
  feature_flag?: string;
530
540
  /**
531
- * This attribute should only be active when the setting is enabled
532
- * example:
533
- * MY_SETTING
541
+ * This attribute should only be active when all the settings have the correct value
534
542
  */
535
- setting_flag?: string;
543
+ settings_flag?: SettingFlag[];
536
544
  value_formatter?: string;
537
545
  preview_value_formatter?: string;
538
546
  /**
@@ -716,11 +724,9 @@ declare namespace Components {
716
724
  */
717
725
  feature_flag?: string;
718
726
  /**
719
- * This attribute should only be active when the setting is enabled
720
- * example:
721
- * MY_SETTING
727
+ * This attribute should only be active when all the settings have the correct value
722
728
  */
723
- setting_flag?: string;
729
+ settings_flag?: SettingFlag[];
724
730
  value_formatter?: string;
725
731
  preview_value_formatter?: string;
726
732
  /**
@@ -846,11 +852,9 @@ declare namespace Components {
846
852
  */
847
853
  feature_flag?: string;
848
854
  /**
849
- * This attribute should only be active when the setting is enabled
850
- * example:
851
- * MY_SETTING
855
+ * This attribute should only be active when all the settings have the correct value
852
856
  */
853
- setting_flag?: string;
857
+ settings_flag?: SettingFlag[];
854
858
  value_formatter?: string;
855
859
  preview_value_formatter?: string;
856
860
  /**
@@ -970,11 +974,9 @@ declare namespace Components {
970
974
  */
971
975
  feature_flag?: string;
972
976
  /**
973
- * This attribute should only be active when the setting is enabled
974
- * example:
975
- * MY_SETTING
977
+ * This attribute should only be active when all the settings have the correct value
976
978
  */
977
- setting_flag?: string;
979
+ settings_flag?: SettingFlag[];
978
980
  value_formatter?: string;
979
981
  preview_value_formatter?: string;
980
982
  /**
@@ -1096,11 +1098,9 @@ declare namespace Components {
1096
1098
  */
1097
1099
  feature_flag?: string;
1098
1100
  /**
1099
- * This attribute should only be active when the setting is enabled
1100
- * example:
1101
- * MY_SETTING
1101
+ * This attribute should only be active when all the settings have the correct value
1102
1102
  */
1103
- setting_flag?: string;
1103
+ settings_flag?: SettingFlag[];
1104
1104
  value_formatter?: string;
1105
1105
  preview_value_formatter?: string;
1106
1106
  /**
@@ -1220,11 +1220,9 @@ declare namespace Components {
1220
1220
  */
1221
1221
  feature_flag?: string;
1222
1222
  /**
1223
- * This attribute should only be active when the setting is enabled
1224
- * example:
1225
- * MY_SETTING
1223
+ * This attribute should only be active when all the settings have the correct value
1226
1224
  */
1227
- setting_flag?: string;
1225
+ settings_flag?: SettingFlag[];
1228
1226
  value_formatter?: string;
1229
1227
  preview_value_formatter?: string;
1230
1228
  /**
@@ -1354,11 +1352,9 @@ declare namespace Components {
1354
1352
  */
1355
1353
  feature_flag?: string;
1356
1354
  /**
1357
- * This attribute should only be active when the setting is enabled
1358
- * example:
1359
- * MY_SETTING
1355
+ * This attribute should only be active when all the settings have the correct value
1360
1356
  */
1361
- setting_flag?: string;
1357
+ settings_flag?: SettingFlag[];
1362
1358
  value_formatter?: string;
1363
1359
  preview_value_formatter?: string;
1364
1360
  /**
@@ -1603,15 +1599,9 @@ declare namespace Components {
1603
1599
  */
1604
1600
  feature_flag?: string;
1605
1601
  /**
1606
- * This capability should only be active when the setting is enabled
1607
- * example:
1608
- * MY_SETTING
1609
- */
1610
- setting_flag?: string;
1611
- /**
1612
- * Only show capability for legacy tenants (ivy)
1602
+ * This capability should only be active when all the settings have the correct value
1613
1603
  */
1614
- legacy?: boolean;
1604
+ settings_flag?: SettingFlag[];
1615
1605
  }
1616
1606
  export interface EntityDefaultCreate {
1617
1607
  view_type?: "default";
@@ -1631,44 +1621,8 @@ declare namespace Components {
1631
1621
  }
1632
1622
  export interface EntityDefaultTable {
1633
1623
  view_type?: "default";
1634
- dropdown_items?: ({
1635
- type?: "entity";
1636
- entity?: /**
1637
- * URL-friendly identifier for the entity schema
1638
- * example:
1639
- * contact
1640
- */
1641
- EntitySlug;
1642
- /**
1643
- * This dropdown item should only be active when the feature flag is enabled
1644
- * example:
1645
- * FF_MY_FEATURE_FLAG
1646
- */
1647
- feature_flag?: string;
1648
- /**
1649
- * Only show item for legacy tenants (ivy)
1650
- */
1651
- legacy?: boolean;
1652
- } | {
1653
- type?: "link";
1654
- /**
1655
- * example:
1656
- * Opportunities
1657
- */
1658
- title?: string;
1659
- uri?: string; // uri-reference
1660
- /**
1661
- * This dropdown item should only be active when the feature flag is enabled
1662
- * example:
1663
- * FF_MY_FEATURE_FLAG
1664
- */
1665
- feature_flag?: string;
1666
- /**
1667
- * Only show item for legacy tenants (ivy)
1668
- */
1669
- legacy?: boolean;
1670
- })[];
1671
1624
  row_actions?: (string | /* An entity action configured from the entity schema */ EntityAction)[];
1625
+ bulk_actions?: (string | /* An entity action configured from the entity schema */ EntityAction)[];
1672
1626
  navbar_actions?: {
1673
1627
  type: string;
1674
1628
  options?: {
@@ -2152,11 +2106,9 @@ declare namespace Components {
2152
2106
  */
2153
2107
  feature_flag?: string;
2154
2108
  /**
2155
- * This group should only be active when the setting is enabled
2156
- * example:
2157
- * MY_SETTING
2109
+ * This group should only be active when all the settings have the correct value
2158
2110
  */
2159
- setting_flag?: string;
2111
+ settings_flag?: SettingFlag[];
2160
2112
  info_tooltip_title?: {
2161
2113
  key?: string;
2162
2114
  default?: string;
@@ -2409,11 +2361,9 @@ declare namespace Components {
2409
2361
  */
2410
2362
  feature_flag?: string;
2411
2363
  /**
2412
- * This group should only be active when the setting is enabled
2413
- * example:
2414
- * MY_SETTING
2364
+ * This group should only be active when all the settings have the correct value
2415
2365
  */
2416
- setting_flag?: string;
2366
+ settings_flag?: SettingFlag[];
2417
2367
  info_tooltip_title?: {
2418
2368
  key?: string;
2419
2369
  default?: string;
@@ -2637,6 +2587,60 @@ declare namespace Components {
2637
2587
  * contact
2638
2588
  */
2639
2589
  export type EntitySlug = string;
2590
+ /**
2591
+ * Validation error for an entity attribute
2592
+ */
2593
+ export interface EntityValidationError {
2594
+ /**
2595
+ * Error code identifier
2596
+ * example:
2597
+ * custom
2598
+ */
2599
+ code: string;
2600
+ /**
2601
+ * Additional parameters for the error
2602
+ */
2603
+ params: {
2604
+ /**
2605
+ * The type of the error
2606
+ * example:
2607
+ * missing_field
2608
+ */
2609
+ type?: string;
2610
+ };
2611
+ /**
2612
+ * The path to the attribute that failed validation
2613
+ * example:
2614
+ * [
2615
+ * "first_name"
2616
+ * ]
2617
+ */
2618
+ path: string[];
2619
+ /**
2620
+ * A human-readable message describing the error
2621
+ * example:
2622
+ * Invalid input
2623
+ */
2624
+ message: string;
2625
+ }
2626
+ /**
2627
+ * Validation result for a failed validation
2628
+ */
2629
+ export interface EntityValidationResultError {
2630
+ status: "error";
2631
+ errors: [
2632
+ /* Validation error for an entity attribute */ EntityValidationError,
2633
+ .../* Validation error for an entity attribute */ EntityValidationError[]
2634
+ ];
2635
+ }
2636
+ /**
2637
+ * Validation result for a successful validation
2638
+ */
2639
+ export interface EntityValidationResultSuccess {
2640
+ status: "success";
2641
+ errors: [
2642
+ ];
2643
+ }
2640
2644
  export interface EntityViewDisabled {
2641
2645
  view_type?: "disabled";
2642
2646
  }
@@ -2739,11 +2743,9 @@ declare namespace Components {
2739
2743
  */
2740
2744
  feature_flag?: string;
2741
2745
  /**
2742
- * This attribute should only be active when the setting is enabled
2743
- * example:
2744
- * MY_SETTING
2746
+ * This attribute should only be active when all the settings have the correct value
2745
2747
  */
2746
- setting_flag?: string;
2748
+ settings_flag?: SettingFlag[];
2747
2749
  value_formatter?: string;
2748
2750
  preview_value_formatter?: string;
2749
2751
  /**
@@ -2919,126 +2921,6 @@ declare namespace Components {
2919
2921
  entity_id: EntityId /* uuid */;
2920
2922
  }[];
2921
2923
  }
2922
- /**
2923
- * Entity with relation data resolved into the attribute values
2924
- * example:
2925
- * {
2926
- * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2927
- * "_org": "123",
2928
- * "_owners": [
2929
- * {
2930
- * "org_id": "123",
2931
- * "user_id": "123"
2932
- * }
2933
- * ],
2934
- * "_schema": "contact",
2935
- * "_tags": [
2936
- * "example",
2937
- * "mock"
2938
- * ],
2939
- * "_created_at": "2021-02-09T12:41:43.662Z",
2940
- * "_updated_at": "2021-02-09T12:41:43.662Z",
2941
- * "_acl": {
2942
- * "view": [
2943
- * "org:456",
2944
- * "org:789"
2945
- * ],
2946
- * "edit": [
2947
- * "org:456"
2948
- * ],
2949
- * "delete": [
2950
- * "org:456"
2951
- * ]
2952
- * },
2953
- * "_relations": [
2954
- * {
2955
- * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2956
- * }
2957
- * ],
2958
- * "status": "active",
2959
- * "customer_number": "abc123",
2960
- * "email": [
2961
- * {
2962
- * "label": "work",
2963
- * "email": "user@example.com"
2964
- * }
2965
- * ],
2966
- * "phone": [
2967
- * {
2968
- * "label": "work",
2969
- * "phone": "+49123456789"
2970
- * }
2971
- * ],
2972
- * "first_name": "First Name",
2973
- * "middle_name": "Middle Name",
2974
- * "last_name": "Last Name",
2975
- * "date_of_birth": "2019-08-24",
2976
- * "title": "Mr.",
2977
- * "account": [
2978
- * {
2979
- * "status": "active",
2980
- * "name": "Company name",
2981
- * "company_email": [
2982
- * {
2983
- * "label": "Company email",
2984
- * "email": "company@example.com"
2985
- * }
2986
- * ],
2987
- * "company_phone": [
2988
- * {
2989
- * "label": "Support phone",
2990
- * "phone": "+49123456789"
2991
- * }
2992
- * ],
2993
- * "company_website": "https://example.com",
2994
- * "tax_id": "DE123456789",
2995
- * "tax_exemption": "2019-08-24",
2996
- * "contacts": {
2997
- * "$relation": [
2998
- * {
2999
- * "_tags": [
3000
- * "CEO"
3001
- * ],
3002
- * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3003
- * }
3004
- * ]
3005
- * }
3006
- * }
3007
- * ]
3008
- * }
3009
- */
3010
- export interface HydratedEntityItem {
3011
- [name: string]: any;
3012
- _id: EntityId /* uuid */;
3013
- /**
3014
- * Organization Id the entity belongs to
3015
- */
3016
- _org: string;
3017
- _owners?: /**
3018
- * The user / organization owning this entity.
3019
- *
3020
- * Note: Owner implicitly has access to the entity regardless of ACLs.
3021
- *
3022
- */
3023
- EntityOwner[];
3024
- _schema: /**
3025
- * URL-friendly identifier for the entity schema
3026
- * example:
3027
- * contact
3028
- */
3029
- EntitySlug;
3030
- /**
3031
- * Title of entity
3032
- */
3033
- _title: string | null;
3034
- _tags?: string[] | null;
3035
- _created_at: string | null; // date-time
3036
- _updated_at: string | null; // date-time
3037
- _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
3038
- _relations: {
3039
- entity_id: EntityId /* uuid */;
3040
- }[];
3041
- }
3042
2924
  /**
3043
2925
  * No UI representation
3044
2926
  */
@@ -3114,11 +2996,9 @@ declare namespace Components {
3114
2996
  */
3115
2997
  feature_flag?: string;
3116
2998
  /**
3117
- * This attribute should only be active when the setting is enabled
3118
- * example:
3119
- * MY_SETTING
2999
+ * This attribute should only be active when all the settings have the correct value
3120
3000
  */
3121
- setting_flag?: string;
3001
+ settings_flag?: SettingFlag[];
3122
3002
  value_formatter?: string;
3123
3003
  preview_value_formatter?: string;
3124
3004
  /**
@@ -3238,11 +3118,9 @@ declare namespace Components {
3238
3118
  */
3239
3119
  feature_flag?: string;
3240
3120
  /**
3241
- * This attribute should only be active when the setting is enabled
3242
- * example:
3243
- * MY_SETTING
3121
+ * This attribute should only be active when all the settings have the correct value
3244
3122
  */
3245
- setting_flag?: string;
3123
+ settings_flag?: SettingFlag[];
3246
3124
  value_formatter?: string;
3247
3125
  preview_value_formatter?: string;
3248
3126
  /**
@@ -3362,11 +3240,9 @@ declare namespace Components {
3362
3240
  */
3363
3241
  feature_flag?: string;
3364
3242
  /**
3365
- * This attribute should only be active when the setting is enabled
3366
- * example:
3367
- * MY_SETTING
3243
+ * This attribute should only be active when all the settings have the correct value
3368
3244
  */
3369
- setting_flag?: string;
3245
+ settings_flag?: SettingFlag[];
3370
3246
  value_formatter?: string;
3371
3247
  preview_value_formatter?: string;
3372
3248
  /**
@@ -3494,11 +3370,9 @@ declare namespace Components {
3494
3370
  */
3495
3371
  feature_flag?: string;
3496
3372
  /**
3497
- * This attribute should only be active when the setting is enabled
3498
- * example:
3499
- * MY_SETTING
3373
+ * This attribute should only be active when all the settings have the correct value
3500
3374
  */
3501
- setting_flag?: string;
3375
+ settings_flag?: SettingFlag[];
3502
3376
  value_formatter?: string;
3503
3377
  preview_value_formatter?: string;
3504
3378
  /**
@@ -3618,11 +3492,9 @@ declare namespace Components {
3618
3492
  */
3619
3493
  feature_flag?: string;
3620
3494
  /**
3621
- * This attribute should only be active when the setting is enabled
3622
- * example:
3623
- * MY_SETTING
3495
+ * This attribute should only be active when all the settings have the correct value
3624
3496
  */
3625
- setting_flag?: string;
3497
+ settings_flag?: SettingFlag[];
3626
3498
  value_formatter?: string;
3627
3499
  preview_value_formatter?: string;
3628
3500
  /**
@@ -3758,11 +3630,9 @@ declare namespace Components {
3758
3630
  */
3759
3631
  feature_flag?: string;
3760
3632
  /**
3761
- * This attribute should only be active when the setting is enabled
3762
- * example:
3763
- * MY_SETTING
3633
+ * This attribute should only be active when all the settings have the correct value
3764
3634
  */
3765
- setting_flag?: string;
3635
+ settings_flag?: SettingFlag[];
3766
3636
  value_formatter?: string;
3767
3637
  preview_value_formatter?: string;
3768
3638
  /**
@@ -3883,11 +3753,9 @@ declare namespace Components {
3883
3753
  */
3884
3754
  feature_flag?: string;
3885
3755
  /**
3886
- * This attribute should only be active when the setting is enabled
3887
- * example:
3888
- * MY_SETTING
3756
+ * This attribute should only be active when all the settings have the correct value
3889
3757
  */
3890
- setting_flag?: string;
3758
+ settings_flag?: SettingFlag[];
3891
3759
  value_formatter?: string;
3892
3760
  preview_value_formatter?: string;
3893
3761
  /**
@@ -4007,11 +3875,9 @@ declare namespace Components {
4007
3875
  */
4008
3876
  feature_flag?: string;
4009
3877
  /**
4010
- * This attribute should only be active when the setting is enabled
4011
- * example:
4012
- * MY_SETTING
3878
+ * This attribute should only be active when all the settings have the correct value
4013
3879
  */
4014
- setting_flag?: string;
3880
+ settings_flag?: SettingFlag[];
4015
3881
  value_formatter?: string;
4016
3882
  preview_value_formatter?: string;
4017
3883
  /**
@@ -4131,11 +3997,9 @@ declare namespace Components {
4131
3997
  */
4132
3998
  feature_flag?: string;
4133
3999
  /**
4134
- * This attribute should only be active when the setting is enabled
4135
- * example:
4136
- * MY_SETTING
4000
+ * This attribute should only be active when all the settings have the correct value
4137
4001
  */
4138
- setting_flag?: string;
4002
+ settings_flag?: SettingFlag[];
4139
4003
  value_formatter?: string;
4140
4004
  preview_value_formatter?: string;
4141
4005
  /**
@@ -4255,11 +4119,9 @@ declare namespace Components {
4255
4119
  */
4256
4120
  feature_flag?: string;
4257
4121
  /**
4258
- * This attribute should only be active when the setting is enabled
4259
- * example:
4260
- * MY_SETTING
4122
+ * This attribute should only be active when all the settings have the correct value
4261
4123
  */
4262
- setting_flag?: string;
4124
+ settings_flag?: SettingFlag[];
4263
4125
  value_formatter?: string;
4264
4126
  preview_value_formatter?: string;
4265
4127
  /**
@@ -4384,11 +4246,9 @@ declare namespace Components {
4384
4246
  */
4385
4247
  feature_flag?: string;
4386
4248
  /**
4387
- * This attribute should only be active when the setting is enabled
4388
- * example:
4389
- * MY_SETTING
4249
+ * This attribute should only be active when all the settings have the correct value
4390
4250
  */
4391
- setting_flag?: string;
4251
+ settings_flag?: SettingFlag[];
4392
4252
  value_formatter?: string;
4393
4253
  preview_value_formatter?: string;
4394
4254
  /**
@@ -4432,6 +4292,12 @@ declare namespace Components {
4432
4292
  hint_tooltip_placement?: string;
4433
4293
  };
4434
4294
  id?: ClassificationId /* uuid */;
4295
+ /**
4296
+ * URL-friendly identifier for the classification
4297
+ * example:
4298
+ * wallbox-pv
4299
+ */
4300
+ slug?: string;
4435
4301
  parents?: ClassificationId /* uuid */[];
4436
4302
  created_at?: string; // date-time
4437
4303
  updated_at?: string; // date-time
@@ -4527,11 +4393,9 @@ declare namespace Components {
4527
4393
  */
4528
4394
  feature_flag?: string;
4529
4395
  /**
4530
- * This attribute should only be active when the setting is enabled
4531
- * example:
4532
- * MY_SETTING
4396
+ * This attribute should only be active when all the settings have the correct value
4533
4397
  */
4534
- setting_flag?: string;
4398
+ settings_flag?: SettingFlag[];
4535
4399
  value_formatter?: string;
4536
4400
  preview_value_formatter?: string;
4537
4401
  /**
@@ -4645,9 +4509,9 @@ declare namespace Components {
4645
4509
  */
4646
4510
  feature_flag?: string;
4647
4511
  /**
4648
- * Name of the setting flag that enables this action
4512
+ * This action should only be active when all the settings have the correct value
4649
4513
  */
4650
- setting_flag?: string;
4514
+ settings_flag?: SettingFlag[];
4651
4515
  /**
4652
4516
  * example:
4653
4517
  * {
@@ -4888,11 +4752,9 @@ declare namespace Components {
4888
4752
  */
4889
4753
  feature_flag?: string;
4890
4754
  /**
4891
- * This attribute should only be active when the setting is enabled
4892
- * example:
4893
- * MY_SETTING
4755
+ * This attribute should only be active when all the settings have the correct value
4894
4756
  */
4895
- setting_flag?: string;
4757
+ settings_flag?: SettingFlag[];
4896
4758
  value_formatter?: string;
4897
4759
  preview_value_formatter?: string;
4898
4760
  /**
@@ -5185,11 +5047,9 @@ declare namespace Components {
5185
5047
  */
5186
5048
  feature_flag?: string;
5187
5049
  /**
5188
- * This attribute should only be active when the setting is enabled
5189
- * example:
5190
- * MY_SETTING
5050
+ * This attribute should only be active when all the settings have the correct value
5191
5051
  */
5192
- setting_flag?: string;
5052
+ settings_flag?: SettingFlag[];
5193
5053
  value_formatter?: string;
5194
5054
  preview_value_formatter?: string;
5195
5055
  /**
@@ -5317,11 +5177,9 @@ declare namespace Components {
5317
5177
  */
5318
5178
  feature_flag?: string;
5319
5179
  /**
5320
- * This attribute should only be active when the setting is enabled
5321
- * example:
5322
- * MY_SETTING
5180
+ * This attribute should only be active when all the settings have the correct value
5323
5181
  */
5324
- setting_flag?: string;
5182
+ settings_flag?: SettingFlag[];
5325
5183
  value_formatter?: string;
5326
5184
  preview_value_formatter?: string;
5327
5185
  /**
@@ -5373,6 +5231,16 @@ declare namespace Components {
5373
5231
  prefix?: string;
5374
5232
  start_number?: number;
5375
5233
  }
5234
+ export interface SettingFlag {
5235
+ /**
5236
+ * The name of the organization setting to check
5237
+ */
5238
+ name?: string;
5239
+ /**
5240
+ * Whether the setting should be enabled or not
5241
+ */
5242
+ enabled?: boolean;
5243
+ }
5376
5244
  /**
5377
5245
  * Status select
5378
5246
  */
@@ -5448,11 +5316,9 @@ declare namespace Components {
5448
5316
  */
5449
5317
  feature_flag?: string;
5450
5318
  /**
5451
- * This attribute should only be active when the setting is enabled
5452
- * example:
5453
- * MY_SETTING
5319
+ * This attribute should only be active when all the settings have the correct value
5454
5320
  */
5455
- setting_flag?: string;
5321
+ settings_flag?: SettingFlag[];
5456
5322
  value_formatter?: string;
5457
5323
  preview_value_formatter?: string;
5458
5324
  /**
@@ -5550,9 +5416,9 @@ declare namespace Components {
5550
5416
  */
5551
5417
  feature_flag?: string;
5552
5418
  /**
5553
- * Binds summary field visibility to the setting flag state.
5419
+ * This summary attribute should only be visible when all the settings have the correct value
5554
5420
  */
5555
- setting_flag?: string;
5421
+ settings_flag?: SettingFlag[];
5556
5422
  }
5557
5423
  /**
5558
5424
  * Summary Fields are displayed inside list view as a resume of the relation entity.
@@ -5642,11 +5508,9 @@ declare namespace Components {
5642
5508
  */
5643
5509
  feature_flag?: string;
5644
5510
  /**
5645
- * This attribute should only be active when the setting is enabled
5646
- * example:
5647
- * MY_SETTING
5511
+ * This attribute should only be active when all the settings have the correct value
5648
5512
  */
5649
- setting_flag?: string;
5513
+ settings_flag?: SettingFlag[];
5650
5514
  value_formatter?: string;
5651
5515
  preview_value_formatter?: string;
5652
5516
  /**
@@ -5694,7 +5558,7 @@ declare namespace Components {
5694
5558
  suggestions?: string[];
5695
5559
  }
5696
5560
  export interface Taxonomy {
5697
- slug: /**
5561
+ slug?: /**
5698
5562
  * URL-friendly name for taxonomy
5699
5563
  * example:
5700
5564
  * purpose
@@ -5705,18 +5569,58 @@ declare namespace Components {
5705
5569
  * example:
5706
5570
  * Purpose
5707
5571
  */
5708
- name: string;
5572
+ name?: string;
5709
5573
  /**
5710
- * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags
5574
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
5711
5575
  * example:
5712
5576
  * Purposes
5713
5577
  */
5714
5578
  plural?: string;
5579
+ /**
5580
+ * Kind of taxonomy e.g. system or user_defined. By default, it's empty, which means 'user_defined'
5581
+ * example:
5582
+ * system
5583
+ */
5584
+ kind?: "system" | "user_defined";
5585
+ /**
5586
+ * Icon name for the taxonomy (from epilot360/icons icon set)
5587
+ * example:
5588
+ * purpose
5589
+ */
5590
+ icon?: string;
5591
+ /**
5592
+ * HEX Color code for the taxonomy
5593
+ * example:
5594
+ * #FF5733
5595
+ */
5596
+ color?: string;
5715
5597
  created_at?: string; // date-time
5716
5598
  updated_at?: string; // date-time
5599
+ /**
5600
+ * Date when the taxonomy was soft-deleted (enabled: false)
5601
+ */
5602
+ deleted_at?: string; // date-time
5603
+ /**
5604
+ * User ID of the creator
5605
+ * example:
5606
+ * 10598
5607
+ */
5608
+ created_by?: string;
5609
+ /**
5610
+ * Whether the taxonomy is enabled or not
5611
+ * example:
5612
+ * true
5613
+ */
5614
+ enabled?: boolean;
5717
5615
  }
5718
5616
  export interface TaxonomyClassification {
5719
5617
  id?: ClassificationId /* uuid */;
5618
+ /**
5619
+ * URL-friendly identifier for the classification
5620
+ * example:
5621
+ * wallbox-pv
5622
+ */
5623
+ slug?: string;
5720
5624
  /**
5721
5625
  * example:
5722
5626
  * Wallbox PV
@@ -5807,11 +5711,9 @@ declare namespace Components {
5807
5711
  */
5808
5712
  feature_flag?: string;
5809
5713
  /**
5810
- * This attribute should only be active when the setting is enabled
5811
- * example:
5812
- * MY_SETTING
5714
+ * This attribute should only be active when all the settings have the correct value
5813
5715
  */
5814
- setting_flag?: string;
5716
+ settings_flag?: SettingFlag[];
5815
5717
  value_formatter?: string;
5816
5718
  preview_value_formatter?: string;
5817
5719
  /**
@@ -5932,11 +5834,9 @@ declare namespace Components {
5932
5834
  */
5933
5835
  feature_flag?: string;
5934
5836
  /**
5935
- * This attribute should only be active when the setting is enabled
5936
- * example:
5937
- * MY_SETTING
5837
+ * This attribute should only be active when all the settings have the correct value
5938
5838
  */
5939
- setting_flag?: string;
5839
+ settings_flag?: SettingFlag[];
5940
5840
  value_formatter?: string;
5941
5841
  preview_value_formatter?: string;
5942
5842
  /**
@@ -6200,16 +6100,74 @@ declare namespace Paths {
6200
6100
  export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
6201
6101
  }
6202
6102
  }
6203
- namespace DeleteEntity {
6204
- namespace Parameters {
6205
- export type ActivityId = /**
6206
- * See https://github.com/ulid/spec
6207
- * example:
6208
- * 01F130Q52Q6MWSNS8N2AVXV4JN
6209
- */
6210
- Components.Schemas.ActivityId /* ulid */;
6211
- export type Id = Components.Schemas.EntityId /* uuid */;
6212
- export type Slug = /**
6103
+ namespace CreateTaxonomy {
6104
+ /**
6105
+ * example:
6106
+ * {
6107
+ * "slug": "product-category",
6108
+ * "name": "Product Category",
6109
+ * "plural": "Product Categories",
6110
+ * "icon": "product-hub",
6111
+ * "color": "#FF5733"
6112
+ * }
6113
+ */
6114
+ export interface RequestBody {
6115
+ slug: /**
6116
+ * URL-friendly name for taxonomy
6117
+ * example:
6118
+ * purpose
6119
+ */
6120
+ Components.Schemas.TaxonomySlug;
6121
+ /**
6122
+ * A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag
6123
+ * example:
6124
+ * Purpose
6125
+ */
6126
+ name: string;
6127
+ /**
6128
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
6129
+ * example:
6130
+ * Purposes
6131
+ */
6132
+ plural?: string;
6133
+ /**
6134
+ * Icon name for the taxonomy (from epilot360/icons icon set)
6135
+ * example:
6136
+ * purpose
6137
+ */
6138
+ icon?: string;
6139
+ /**
6140
+ * HEX Color code for the taxonomy
6141
+ * example:
6142
+ * #FF5733
6143
+ */
6144
+ color?: string;
6145
+ }
6146
+ namespace Responses {
6147
+ export type $201 = Components.Schemas.Taxonomy;
6148
+ export interface $409 {
6149
+ }
6150
+ }
6151
+ }
6152
+ namespace CreateTaxonomyClassification {
6153
+ namespace Parameters {
6154
+ export type TaxonomySlug = string;
6155
+ }
6156
+ export interface PathParameters {
6157
+ taxonomySlug: Parameters.TaxonomySlug;
6158
+ }
6159
+ export type RequestBody = Components.Schemas.TaxonomyClassification;
6160
+ }
6161
+ namespace DeleteEntity {
6162
+ namespace Parameters {
6163
+ export type ActivityId = /**
6164
+ * See https://github.com/ulid/spec
6165
+ * example:
6166
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
6167
+ */
6168
+ Components.Schemas.ActivityId /* ulid */;
6169
+ export type Id = Components.Schemas.EntityId /* uuid */;
6170
+ export type Slug = /**
6213
6171
  * URL-friendly identifier for the entity schema
6214
6172
  * example:
6215
6173
  * contact
@@ -6291,6 +6249,36 @@ declare namespace Paths {
6291
6249
  }
6292
6250
  }
6293
6251
  }
6252
+ namespace DeleteTaxonomy {
6253
+ namespace Parameters {
6254
+ export type Permanent = boolean;
6255
+ export type TaxonomySlug = string;
6256
+ }
6257
+ export interface PathParameters {
6258
+ taxonomySlug: Parameters.TaxonomySlug;
6259
+ }
6260
+ export interface QueryParameters {
6261
+ permanent?: Parameters.Permanent;
6262
+ }
6263
+ namespace Responses {
6264
+ export interface $204 {
6265
+ }
6266
+ }
6267
+ }
6268
+ namespace DeleteTaxonomyClassification {
6269
+ namespace Parameters {
6270
+ export type ClassificationId = Components.Schemas.ClassificationId /* uuid */;
6271
+ export type Permanent = boolean;
6272
+ export type TaxonomySlug = string;
6273
+ }
6274
+ export interface PathParameters {
6275
+ taxonomySlug: Parameters.TaxonomySlug;
6276
+ classificationId: Parameters.ClassificationId;
6277
+ }
6278
+ export interface QueryParameters {
6279
+ permanent?: Parameters.Permanent;
6280
+ }
6281
+ }
6294
6282
  namespace ExportEntities {
6295
6283
  namespace Parameters {
6296
6284
  export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
@@ -6773,6 +6761,15 @@ declare namespace Paths {
6773
6761
  namespace Parameters {
6774
6762
  export type DraftsFrom = number;
6775
6763
  export type DraftsSize = number;
6764
+ /**
6765
+ * example:
6766
+ * [
6767
+ * "id",
6768
+ * "attributes",
6769
+ * "capabilites"
6770
+ * ]
6771
+ */
6772
+ export type Fields = string[];
6776
6773
  export type Slug = /**
6777
6774
  * URL-friendly identifier for the entity schema
6778
6775
  * example:
@@ -6790,6 +6787,15 @@ declare namespace Paths {
6790
6787
  versions_size?: Parameters.VersionsSize;
6791
6788
  drafts_from?: Parameters.DraftsFrom;
6792
6789
  drafts_size?: Parameters.DraftsSize;
6790
+ fields?: /**
6791
+ * example:
6792
+ * [
6793
+ * "id",
6794
+ * "attributes",
6795
+ * "capabilites"
6796
+ * ]
6797
+ */
6798
+ Parameters.Fields;
6793
6799
  }
6794
6800
  namespace Responses {
6795
6801
  export interface $200 {
@@ -6809,6 +6815,21 @@ declare namespace Paths {
6809
6815
  export type $200 = Components.Schemas.Taxonomy;
6810
6816
  }
6811
6817
  }
6818
+ namespace GetTaxonomyClassification {
6819
+ namespace Parameters {
6820
+ export type TaxonomyClassificationSlug = string;
6821
+ export type TaxonomySlug = string;
6822
+ }
6823
+ export interface PathParameters {
6824
+ taxonomySlug: Parameters.TaxonomySlug;
6825
+ taxonomyClassificationSlug: Parameters.TaxonomyClassificationSlug;
6826
+ }
6827
+ namespace Responses {
6828
+ export type $200 = Components.Schemas.TaxonomyClassification;
6829
+ export interface $404 {
6830
+ }
6831
+ }
6832
+ }
6812
6833
  namespace ImportEntities {
6813
6834
  namespace Parameters {
6814
6835
  export type JobId = /**
@@ -6873,6 +6894,12 @@ declare namespace Paths {
6873
6894
  }
6874
6895
  }
6875
6896
  namespace ListTaxonomies {
6897
+ namespace Parameters {
6898
+ export type IncludeDisabled = boolean;
6899
+ }
6900
+ export interface QueryParameters {
6901
+ include_disabled?: Parameters.IncludeDisabled;
6902
+ }
6876
6903
  namespace Responses {
6877
6904
  export interface $200 {
6878
6905
  results?: Components.Schemas.Taxonomy[];
@@ -7245,6 +7272,68 @@ declare namespace Paths {
7245
7272
  export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
7246
7273
  }
7247
7274
  }
7275
+ namespace UpdateTaxonomy {
7276
+ namespace Parameters {
7277
+ export type TaxonomySlug = string;
7278
+ }
7279
+ export interface PathParameters {
7280
+ taxonomySlug: Parameters.TaxonomySlug;
7281
+ }
7282
+ /**
7283
+ * example:
7284
+ * {
7285
+ * "name": "Product Category",
7286
+ * "plural": "Product Categories",
7287
+ * "icon": "product-hub",
7288
+ * "color": "#FF5733",
7289
+ * "enabled": true
7290
+ * }
7291
+ */
7292
+ export interface RequestBody {
7293
+ /**
7294
+ * A human friendly name of a Taxonomy e.g. Purpose, Product Category, Folder, Tag
7295
+ * example:
7296
+ * Purpose
7297
+ */
7298
+ name?: string;
7299
+ /**
7300
+ * Plural name of a Taxonomy e.g. Purposes, Product Categories, Folders, Tags. Defaults to name is not provided.
7301
+ * example:
7302
+ * Purposes
7303
+ */
7304
+ plural?: string;
7305
+ /**
7306
+ * Icon name for the taxonomy (from epilot360/icons icon set)
7307
+ * example:
7308
+ * purpose
7309
+ */
7310
+ icon?: string;
7311
+ /**
7312
+ * HEX Color code for the taxonomy
7313
+ * example:
7314
+ * #FF5733
7315
+ */
7316
+ color?: string;
7317
+ /**
7318
+ * Whether the taxonomy is enabled or not
7319
+ * example:
7320
+ * true
7321
+ */
7322
+ enabled?: boolean;
7323
+ }
7324
+ namespace Responses {
7325
+ export type $200 = Components.Schemas.Taxonomy;
7326
+ }
7327
+ }
7328
+ namespace UpdateTaxonomyClassification {
7329
+ namespace Parameters {
7330
+ export type TaxonomySlug = string;
7331
+ }
7332
+ export interface PathParameters {
7333
+ taxonomySlug: Parameters.TaxonomySlug;
7334
+ }
7335
+ export type RequestBody = Components.Schemas.TaxonomyClassification;
7336
+ }
7248
7337
  namespace UpsertEntity {
7249
7338
  namespace Parameters {
7250
7339
  export type ActivityId = /**
@@ -7403,6 +7492,61 @@ declare namespace Paths {
7403
7492
  }
7404
7493
  }
7405
7494
  }
7495
+ namespace ValidateEntity {
7496
+ namespace Parameters {
7497
+ /**
7498
+ * URL-friendly identifier for the entity schema
7499
+ * example:
7500
+ * price
7501
+ */
7502
+ export type Slug = string;
7503
+ }
7504
+ export interface PathParameters {
7505
+ slug: /**
7506
+ * URL-friendly identifier for the entity schema
7507
+ * example:
7508
+ * price
7509
+ */
7510
+ Parameters.Slug;
7511
+ }
7512
+ export type RequestBody = /**
7513
+ * example:
7514
+ * {
7515
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
7516
+ * "_org": "123",
7517
+ * "_owners": [
7518
+ * {
7519
+ * "org_id": "123",
7520
+ * "user_id": "123"
7521
+ * }
7522
+ * ],
7523
+ * "_schema": "contact",
7524
+ * "_tags": [
7525
+ * "example",
7526
+ * "mock"
7527
+ * ],
7528
+ * "_created_at": "2021-02-09T12:41:43.662Z",
7529
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
7530
+ * "_acl": {
7531
+ * "view": [
7532
+ * "org:456",
7533
+ * "org:789"
7534
+ * ],
7535
+ * "edit": [
7536
+ * "org:456"
7537
+ * ],
7538
+ * "delete": [
7539
+ * "org:456"
7540
+ * ]
7541
+ * }
7542
+ * }
7543
+ */
7544
+ Components.Schemas.Entity;
7545
+ namespace Responses {
7546
+ export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationResultSuccess;
7547
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
7548
+ }
7549
+ }
7406
7550
  }
7407
7551
 
7408
7552
  export interface OperationMethods {
@@ -7586,6 +7730,16 @@ export interface OperationMethods {
7586
7730
  data?: Paths.CreateEntity.RequestBody,
7587
7731
  config?: AxiosRequestConfig
7588
7732
  ): OperationResponse<Paths.CreateEntity.Responses.$201>
7733
+ /**
7734
+ * validateEntity - validateEntity
7735
+ *
7736
+ * Validates an entity against the schema.
7737
+ */
7738
+ 'validateEntity'(
7739
+ parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
7740
+ data?: Paths.ValidateEntity.RequestBody,
7741
+ config?: AxiosRequestConfig
7742
+ ): OperationResponse<Paths.ValidateEntity.Responses.$200>
7589
7743
  /**
7590
7744
  * upsertEntity - upsertEntity
7591
7745
  *
@@ -8009,10 +8163,30 @@ export interface OperationMethods {
8009
8163
  * List taxonomies in an organisation
8010
8164
  */
8011
8165
  'listTaxonomies'(
8012
- parameters?: Parameters<UnknownParamsObject> | null,
8166
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8013
8167
  data?: any,
8014
8168
  config?: AxiosRequestConfig
8015
8169
  ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8170
+ /**
8171
+ * listTaxonomies - listTaxonomies
8172
+ *
8173
+ * List taxonomies in an organization
8174
+ */
8175
+ 'listTaxonomies'(
8176
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8177
+ data?: any,
8178
+ config?: AxiosRequestConfig
8179
+ ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8180
+ /**
8181
+ * createTaxonomy - createTaxonomy
8182
+ *
8183
+ * Create a new taxonomy
8184
+ */
8185
+ 'createTaxonomy'(
8186
+ parameters?: Parameters<UnknownParamsObject> | null,
8187
+ data?: Paths.CreateTaxonomy.RequestBody,
8188
+ config?: AxiosRequestConfig
8189
+ ): OperationResponse<Paths.CreateTaxonomy.Responses.$201>
8016
8190
  /**
8017
8191
  * getTaxonomy - getTaxonomy
8018
8192
  *
@@ -8023,6 +8197,26 @@ export interface OperationMethods {
8023
8197
  data?: any,
8024
8198
  config?: AxiosRequestConfig
8025
8199
  ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
8200
+ /**
8201
+ * updateTaxonomy - updateTaxonomy
8202
+ *
8203
+ * Update a taxonomy
8204
+ */
8205
+ 'updateTaxonomy'(
8206
+ parameters?: Parameters<Paths.UpdateTaxonomy.PathParameters> | null,
8207
+ data?: Paths.UpdateTaxonomy.RequestBody,
8208
+ config?: AxiosRequestConfig
8209
+ ): OperationResponse<Paths.UpdateTaxonomy.Responses.$200>
8210
+ /**
8211
+ * deleteTaxonomy - deleteTaxonomy
8212
+ *
8213
+ * Delete a taxonomy
8214
+ */
8215
+ 'deleteTaxonomy'(
8216
+ parameters?: Parameters<Paths.DeleteTaxonomy.PathParameters & Paths.DeleteTaxonomy.QueryParameters> | null,
8217
+ data?: any,
8218
+ config?: AxiosRequestConfig
8219
+ ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
8026
8220
  /**
8027
8221
  * taxonomyAutocomplete - taxonomyAutocomplete
8028
8222
  *
@@ -8036,7 +8230,7 @@ export interface OperationMethods {
8036
8230
  /**
8037
8231
  * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
8038
8232
  *
8039
- * List taxonomy classifications in an organisation based on taxonomy slug
8233
+ * List taxonomy classifications in an organization based on taxonomy slug
8040
8234
  */
8041
8235
  'taxonomiesClassificationsSearch'(
8042
8236
  parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
@@ -8046,13 +8240,53 @@ export interface OperationMethods {
8046
8240
  /**
8047
8241
  * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
8048
8242
  *
8049
- * Update taxonomies in an organisation based in taxonomy slug
8243
+ * Update the classifications for a taxonomy
8050
8244
  */
8051
8245
  'updateClassificationsForTaxonomy'(
8052
8246
  parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
8053
8247
  data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
8054
8248
  config?: AxiosRequestConfig
8055
8249
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
8250
+ /**
8251
+ * getTaxonomyClassification - getTaxonomyClassification
8252
+ *
8253
+ * Gets the classification of a taxonomy
8254
+ */
8255
+ 'getTaxonomyClassification'(
8256
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
8257
+ data?: any,
8258
+ config?: AxiosRequestConfig
8259
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
8260
+ /**
8261
+ * updateTaxonomyClassification - updateTaxonomyClassification
8262
+ *
8263
+ * Update a classification for a taxonomy
8264
+ */
8265
+ 'updateTaxonomyClassification'(
8266
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
8267
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
8268
+ config?: AxiosRequestConfig
8269
+ ): OperationResponse<any>
8270
+ /**
8271
+ * createTaxonomyClassification - createTaxonomyClassification
8272
+ *
8273
+ * Create a new classification for a taxonomy
8274
+ */
8275
+ 'createTaxonomyClassification'(
8276
+ parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
8277
+ data?: Paths.CreateTaxonomyClassification.RequestBody,
8278
+ config?: AxiosRequestConfig
8279
+ ): OperationResponse<any>
8280
+ /**
8281
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
8282
+ *
8283
+ * Delete a classification for a taxonomy
8284
+ */
8285
+ 'deleteTaxonomyClassification'(
8286
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
8287
+ data?: any,
8288
+ config?: AxiosRequestConfig
8289
+ ): OperationResponse<any>
8056
8290
  }
8057
8291
 
8058
8292
  export interface PathsDictionary {
@@ -8250,6 +8484,18 @@ export interface PathsDictionary {
8250
8484
  config?: AxiosRequestConfig
8251
8485
  ): OperationResponse<Paths.CreateEntity.Responses.$201>
8252
8486
  }
8487
+ ['/v1/entity/{slug}:validate']: {
8488
+ /**
8489
+ * validateEntity - validateEntity
8490
+ *
8491
+ * Validates an entity against the schema.
8492
+ */
8493
+ 'post'(
8494
+ parameters?: Parameters<Paths.ValidateEntity.PathParameters> | null,
8495
+ data?: Paths.ValidateEntity.RequestBody,
8496
+ config?: AxiosRequestConfig
8497
+ ): OperationResponse<Paths.ValidateEntity.Responses.$200>
8498
+ }
8253
8499
  ['/v1/entity/{slug}:upsert']: {
8254
8500
  /**
8255
8501
  * upsertEntity - upsertEntity
@@ -8712,11 +8958,33 @@ export interface PathsDictionary {
8712
8958
  * List taxonomies in an organisation
8713
8959
  */
8714
8960
  'get'(
8715
- parameters?: Parameters<UnknownParamsObject> | null,
8961
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8716
8962
  data?: any,
8717
8963
  config?: AxiosRequestConfig
8718
8964
  ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8719
8965
  }
8966
+ ['/v1/entity/taxonomies']: {
8967
+ /**
8968
+ * listTaxonomies - listTaxonomies
8969
+ *
8970
+ * List taxonomies in an organization
8971
+ */
8972
+ 'get'(
8973
+ parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
8974
+ data?: any,
8975
+ config?: AxiosRequestConfig
8976
+ ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
8977
+ /**
8978
+ * createTaxonomy - createTaxonomy
8979
+ *
8980
+ * Create a new taxonomy
8981
+ */
8982
+ 'post'(
8983
+ parameters?: Parameters<UnknownParamsObject> | null,
8984
+ data?: Paths.CreateTaxonomy.RequestBody,
8985
+ config?: AxiosRequestConfig
8986
+ ): OperationResponse<Paths.CreateTaxonomy.Responses.$201>
8987
+ }
8720
8988
  ['/v1/entity/taxonomies/{taxonomySlug}']: {
8721
8989
  /**
8722
8990
  * getTaxonomy - getTaxonomy
@@ -8728,6 +8996,26 @@ export interface PathsDictionary {
8728
8996
  data?: any,
8729
8997
  config?: AxiosRequestConfig
8730
8998
  ): OperationResponse<Paths.GetTaxonomy.Responses.$200>
8999
+ /**
9000
+ * updateTaxonomy - updateTaxonomy
9001
+ *
9002
+ * Update a taxonomy
9003
+ */
9004
+ 'put'(
9005
+ parameters?: Parameters<Paths.UpdateTaxonomy.PathParameters> | null,
9006
+ data?: Paths.UpdateTaxonomy.RequestBody,
9007
+ config?: AxiosRequestConfig
9008
+ ): OperationResponse<Paths.UpdateTaxonomy.Responses.$200>
9009
+ /**
9010
+ * deleteTaxonomy - deleteTaxonomy
9011
+ *
9012
+ * Delete a taxonomy
9013
+ */
9014
+ 'delete'(
9015
+ parameters?: Parameters<Paths.DeleteTaxonomy.PathParameters & Paths.DeleteTaxonomy.QueryParameters> | null,
9016
+ data?: any,
9017
+ config?: AxiosRequestConfig
9018
+ ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
8731
9019
  }
8732
9020
  ['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
8733
9021
  /**
@@ -8745,7 +9033,7 @@ export interface PathsDictionary {
8745
9033
  /**
8746
9034
  * taxonomiesClassificationsSearch - taxonomiesClassificationsSearch
8747
9035
  *
8748
- * List taxonomy classifications in an organisation based on taxonomy slug
9036
+ * List taxonomy classifications in an organization based on taxonomy slug
8749
9037
  */
8750
9038
  'post'(
8751
9039
  parameters?: Parameters<Paths.TaxonomiesClassificationsSearch.QueryParameters> | null,
@@ -8757,7 +9045,7 @@ export interface PathsDictionary {
8757
9045
  /**
8758
9046
  * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
8759
9047
  *
8760
- * Update taxonomies in an organisation based in taxonomy slug
9048
+ * Update the classifications for a taxonomy
8761
9049
  */
8762
9050
  'post'(
8763
9051
  parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
@@ -8765,6 +9053,48 @@ export interface PathsDictionary {
8765
9053
  config?: AxiosRequestConfig
8766
9054
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
8767
9055
  }
9056
+ ['/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}']: {
9057
+ /**
9058
+ * getTaxonomyClassification - getTaxonomyClassification
9059
+ *
9060
+ * Gets the classification of a taxonomy
9061
+ */
9062
+ 'get'(
9063
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
9064
+ data?: any,
9065
+ config?: AxiosRequestConfig
9066
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
9067
+ /**
9068
+ * createTaxonomyClassification - createTaxonomyClassification
9069
+ *
9070
+ * Create a new classification for a taxonomy
9071
+ */
9072
+ 'post'(
9073
+ parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
9074
+ data?: Paths.CreateTaxonomyClassification.RequestBody,
9075
+ config?: AxiosRequestConfig
9076
+ ): OperationResponse<any>
9077
+ /**
9078
+ * updateTaxonomyClassification - updateTaxonomyClassification
9079
+ *
9080
+ * Update a classification for a taxonomy
9081
+ */
9082
+ 'put'(
9083
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
9084
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
9085
+ config?: AxiosRequestConfig
9086
+ ): OperationResponse<any>
9087
+ /**
9088
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
9089
+ *
9090
+ * Delete a classification for a taxonomy
9091
+ */
9092
+ 'delete'(
9093
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
9094
+ data?: any,
9095
+ config?: AxiosRequestConfig
9096
+ ): OperationResponse<any>
9097
+ }
8768
9098
  }
8769
9099
 
8770
9100
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>