@epilot/entity-client 4.21.0 → 4.23.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.
@@ -56,7 +56,7 @@ declare namespace Components {
56
56
  export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
57
57
  export type TaxonomyClassificationSlugPathParam = string;
58
58
  export type TaxonomySlugPathParam = string;
59
- export type TaxonomySlugQueryParam = string;
59
+ export type TaxonomySlugQueryParamOptional = string;
60
60
  }
61
61
  export interface PathParameters {
62
62
  EntityIdPathParam?: Parameters.EntityIdPathParam;
@@ -73,7 +73,7 @@ declare namespace Components {
73
73
  ActivityIdPathParam?: Parameters.ActivityIdPathParam;
74
74
  }
75
75
  export interface QueryParameters {
76
- TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
76
+ TaxonomySlugQueryParamOptional?: Parameters.TaxonomySlugQueryParamOptional;
77
77
  AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
78
78
  HydrateEntitiesQueryParam?: Parameters.HydrateEntitiesQueryParam;
79
79
  ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
@@ -275,7 +275,11 @@ declare namespace Components {
275
275
  *
276
276
  */
277
277
  render_condition?: string;
278
- _purpose?: ClassificationId /* uuid */[];
278
+ _purpose?: /**
279
+ * example:
280
+ * taxonomy-slug:classification-slug
281
+ */
282
+ ClassificationId[];
279
283
  /**
280
284
  * A set of constraints applicable to the attribute.
281
285
  * These constraints should and will be enforced by the attribute renderer.
@@ -344,6 +348,16 @@ declare namespace Components {
344
348
  has_primary?: boolean;
345
349
  }
346
350
  export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute;
351
+ /**
352
+ * a readonly computed ID for the attribute including schema slug and the attribute ID
353
+ */
354
+ export type AttributeWithCompositeID = {
355
+ /**
356
+ * example:
357
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
358
+ */
359
+ composite_id?: string;
360
+ } & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute);
347
361
  /**
348
362
  * Automation entity
349
363
  */
@@ -399,7 +413,11 @@ declare namespace Components {
399
413
  *
400
414
  */
401
415
  render_condition?: string;
402
- _purpose?: ClassificationId /* uuid */[];
416
+ _purpose?: /**
417
+ * example:
418
+ * taxonomy-slug:classification-slug
419
+ */
420
+ ClassificationId[];
403
421
  /**
404
422
  * A set of constraints applicable to the attribute.
405
423
  * These constraints should and will be enforced by the attribute renderer.
@@ -466,6 +484,45 @@ declare namespace Components {
466
484
  };
467
485
  type?: "automation";
468
486
  }
487
+ export interface BaseActivityItem {
488
+ _id?: /**
489
+ * See https://github.com/ulid/spec
490
+ * example:
491
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
492
+ */
493
+ ActivityId /* ulid */;
494
+ timestamp?: string; // date-time
495
+ /**
496
+ * example:
497
+ * MyCustomActivity
498
+ */
499
+ type: string;
500
+ /**
501
+ * Title for activity. Supports handlebars syntax.
502
+ * example:
503
+ * My custom activity
504
+ */
505
+ title: string;
506
+ /**
507
+ * Message for activity. Supports handlebars syntax.
508
+ * example:
509
+ * {{caller}} did something with {{entity payload.entity.id}}.
510
+ */
511
+ message: string;
512
+ /**
513
+ * example:
514
+ * {
515
+ * "entity": {
516
+ * "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
517
+ * "schema": "contact"
518
+ * }
519
+ * }
520
+ */
521
+ payload?: {
522
+ [name: string]: any;
523
+ };
524
+ caller?: ActivityCallerContext;
525
+ }
469
526
  export interface BaseAttribute {
470
527
  name: string;
471
528
  label: string;
@@ -518,7 +575,11 @@ declare namespace Components {
518
575
  *
519
576
  */
520
577
  render_condition?: string;
521
- _purpose?: ClassificationId /* uuid */[];
578
+ _purpose?: /**
579
+ * example:
580
+ * taxonomy-slug:classification-slug
581
+ */
582
+ ClassificationId[];
522
583
  /**
523
584
  * A set of constraints applicable to the attribute.
524
585
  * These constraints should and will be enforced by the attribute renderer.
@@ -704,7 +765,11 @@ declare namespace Components {
704
765
  *
705
766
  */
706
767
  render_condition?: string;
707
- _purpose?: ClassificationId /* uuid */[];
768
+ _purpose?: /**
769
+ * example:
770
+ * taxonomy-slug:classification-slug
771
+ */
772
+ ClassificationId[];
708
773
  /**
709
774
  * A set of constraints applicable to the attribute.
710
775
  * These constraints should and will be enforced by the attribute renderer.
@@ -771,11 +836,19 @@ declare namespace Components {
771
836
  };
772
837
  type?: "boolean";
773
838
  }
774
- export type ClassificationId = string; // uuid
839
+ /**
840
+ * example:
841
+ * taxonomy-slug:classification-slug
842
+ */
843
+ export type ClassificationId = string;
775
844
  export interface ClassificationsUpdate {
776
845
  create?: TaxonomyClassification[];
777
846
  update?: TaxonomyClassification[];
778
- delete?: ClassificationId /* uuid */[];
847
+ delete?: (/**
848
+ * example:
849
+ * taxonomy-slug:classification-slug
850
+ */
851
+ ClassificationId | string)[];
779
852
  }
780
853
  /**
781
854
  * 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)
@@ -832,7 +905,11 @@ declare namespace Components {
832
905
  *
833
906
  */
834
907
  render_condition?: string;
835
- _purpose?: ClassificationId /* uuid */[];
908
+ _purpose?: /**
909
+ * example:
910
+ * taxonomy-slug:classification-slug
911
+ */
912
+ ClassificationId[];
836
913
  /**
837
914
  * A set of constraints applicable to the attribute.
838
915
  * These constraints should and will be enforced by the attribute renderer.
@@ -954,7 +1031,11 @@ declare namespace Components {
954
1031
  *
955
1032
  */
956
1033
  render_condition?: string;
957
- _purpose?: ClassificationId /* uuid */[];
1034
+ _purpose?: /**
1035
+ * example:
1036
+ * taxonomy-slug:classification-slug
1037
+ */
1038
+ ClassificationId[];
958
1039
  /**
959
1040
  * A set of constraints applicable to the attribute.
960
1041
  * These constraints should and will be enforced by the attribute renderer.
@@ -1078,7 +1159,11 @@ declare namespace Components {
1078
1159
  *
1079
1160
  */
1080
1161
  render_condition?: string;
1081
- _purpose?: ClassificationId /* uuid */[];
1162
+ _purpose?: /**
1163
+ * example:
1164
+ * taxonomy-slug:classification-slug
1165
+ */
1166
+ ClassificationId[];
1082
1167
  /**
1083
1168
  * A set of constraints applicable to the attribute.
1084
1169
  * These constraints should and will be enforced by the attribute renderer.
@@ -1200,7 +1285,11 @@ declare namespace Components {
1200
1285
  *
1201
1286
  */
1202
1287
  render_condition?: string;
1203
- _purpose?: ClassificationId /* uuid */[];
1288
+ _purpose?: /**
1289
+ * example:
1290
+ * taxonomy-slug:classification-slug
1291
+ */
1292
+ ClassificationId[];
1204
1293
  /**
1205
1294
  * A set of constraints applicable to the attribute.
1206
1295
  * These constraints should and will be enforced by the attribute renderer.
@@ -1332,7 +1421,11 @@ declare namespace Components {
1332
1421
  *
1333
1422
  */
1334
1423
  render_condition?: string;
1335
- _purpose?: ClassificationId /* uuid */[];
1424
+ _purpose?: /**
1425
+ * example:
1426
+ * taxonomy-slug:classification-slug
1427
+ */
1428
+ ClassificationId[];
1336
1429
  /**
1337
1430
  * A set of constraints applicable to the attribute.
1338
1431
  * These constraints should and will be enforced by the attribute renderer.
@@ -1515,7 +1608,120 @@ declare namespace Components {
1515
1608
  */
1516
1609
  title?: string;
1517
1610
  attributes?: Attribute[];
1518
- _purpose?: ClassificationId /* uuid */[];
1611
+ _purpose?: /**
1612
+ * example:
1613
+ * taxonomy-slug:classification-slug
1614
+ */
1615
+ ClassificationId[];
1616
+ ui_hooks?: {
1617
+ [name: string]: any;
1618
+ /**
1619
+ * name of the hook to use
1620
+ * example:
1621
+ * EntityDetailsV2:Tab
1622
+ */
1623
+ hook: string;
1624
+ /**
1625
+ * example:
1626
+ * _is_composite_price = "false"
1627
+ */
1628
+ render_condition?: string;
1629
+ /**
1630
+ * render order (ascending)
1631
+ * example:
1632
+ * 10
1633
+ */
1634
+ order?: number;
1635
+ /**
1636
+ * example:
1637
+ * Notes
1638
+ */
1639
+ title?: string;
1640
+ /**
1641
+ * Sets the group expand/collapse default state
1642
+ */
1643
+ group_expanded?: boolean;
1644
+ /**
1645
+ * package to be imported
1646
+ * example:
1647
+ * @epilot360/notes
1648
+ */
1649
+ import?: string;
1650
+ /**
1651
+ * the component to be dynamically loaded
1652
+ * example:
1653
+ * PricingItems
1654
+ */
1655
+ component?: string;
1656
+ /**
1657
+ * route for specified capability
1658
+ * example:
1659
+ * notes
1660
+ */
1661
+ route?: string;
1662
+ /**
1663
+ * Preview icon name(As in Base elements) for the capability
1664
+ * example:
1665
+ * email
1666
+ */
1667
+ icon?: string;
1668
+ /**
1669
+ * Whether capability should be disabled
1670
+ */
1671
+ disabled?: boolean;
1672
+ /**
1673
+ * Specific to Activity pilot
1674
+ */
1675
+ header?: boolean;
1676
+ /**
1677
+ * Require a permission to display UI hook
1678
+ */
1679
+ requiredPermission?: {
1680
+ /**
1681
+ * example:
1682
+ * note:view
1683
+ */
1684
+ action: string;
1685
+ /**
1686
+ * example:
1687
+ * 123
1688
+ */
1689
+ resource?: string;
1690
+ };
1691
+ }[];
1692
+ /**
1693
+ * This capability should only be active when the feature flag is enabled
1694
+ * example:
1695
+ * FF_MY_FEATURE_FLAG
1696
+ */
1697
+ feature_flag?: string;
1698
+ /**
1699
+ * This capability should only be active when all the settings have the correct value
1700
+ */
1701
+ settings_flag?: SettingFlag[];
1702
+ }
1703
+ /**
1704
+ * a readonly computed ID for the entity capability including schema slug and the capability ID
1705
+ */
1706
+ export interface EntityCapabilityWithCompositeID {
1707
+ /**
1708
+ * Unique name for the capability
1709
+ * example:
1710
+ * customer_messaging
1711
+ */
1712
+ name: string;
1713
+ /**
1714
+ * Human readable title of the capability
1715
+ * example:
1716
+ * Messaging
1717
+ */
1718
+ title?: string;
1719
+ attributes?: Attribute[];
1720
+ _purpose?: /**
1721
+ * example:
1722
+ * taxonomy-slug:classification-slug
1723
+ */
1724
+ ClassificationId[];
1519
1725
  ui_hooks?: {
1520
1726
  [name: string]: any;
1521
1727
  /**
@@ -1602,6 +1808,11 @@ declare namespace Components {
1602
1808
  * This capability should only be active when all the settings have the correct value
1603
1809
  */
1604
1810
  settings_flag?: SettingFlag[];
1811
+ /**
1812
+ * example:
1813
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
1814
+ */
1815
+ composite_id?: string;
1605
1816
  }
1606
1817
  export interface EntityDefaultCreate {
1607
1818
  view_type?: "default";
@@ -2113,7 +2324,11 @@ declare namespace Components {
2113
2324
  key?: string;
2114
2325
  default?: string;
2115
2326
  };
2116
- _purpose?: ClassificationId /* uuid */[];
2327
+ _purpose?: /**
2328
+ * example:
2329
+ * taxonomy-slug:classification-slug
2330
+ */
2331
+ ClassificationId[];
2117
2332
  }[];
2118
2333
  /**
2119
2334
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
@@ -2368,7 +2583,11 @@ declare namespace Components {
2368
2583
  key?: string;
2369
2584
  default?: string;
2370
2585
  };
2371
- _purpose?: ClassificationId /* uuid */[];
2586
+ _purpose?: /**
2587
+ * example:
2588
+ * taxonomy-slug:classification-slug
2589
+ */
2590
+ ClassificationId[];
2372
2591
  }[];
2373
2592
  /**
2374
2593
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
@@ -2723,7 +2942,11 @@ declare namespace Components {
2723
2942
  *
2724
2943
  */
2725
2944
  render_condition?: string;
2726
- _purpose?: ClassificationId /* uuid */[];
2945
+ _purpose?: /**
2946
+ * example:
2947
+ * taxonomy-slug:classification-slug
2948
+ */
2949
+ ClassificationId[];
2727
2950
  /**
2728
2951
  * A set of constraints applicable to the attribute.
2729
2952
  * These constraints should and will be enforced by the attribute renderer.
@@ -2854,73 +3077,6 @@ declare namespace Components {
2854
3077
  hits?: number;
2855
3078
  relations?: GetRelationsResp;
2856
3079
  }
2857
- /**
2858
- * Entity with relation data resolved into the attribute values
2859
- * example:
2860
- * {
2861
- * "_relations": [
2862
- * {
2863
- * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2864
- * }
2865
- * ],
2866
- * "status": "active",
2867
- * "customer_number": "abc123",
2868
- * "email": [
2869
- * {
2870
- * "label": "work",
2871
- * "email": "user@example.com"
2872
- * }
2873
- * ],
2874
- * "phone": [
2875
- * {
2876
- * "label": "work",
2877
- * "phone": "+49123456789"
2878
- * }
2879
- * ],
2880
- * "first_name": "First Name",
2881
- * "middle_name": "Middle Name",
2882
- * "last_name": "Last Name",
2883
- * "date_of_birth": "2019-08-24",
2884
- * "title": "Mr.",
2885
- * "account": [
2886
- * {
2887
- * "status": "active",
2888
- * "name": "Company name",
2889
- * "company_email": [
2890
- * {
2891
- * "label": "Company email",
2892
- * "email": "company@example.com"
2893
- * }
2894
- * ],
2895
- * "company_phone": [
2896
- * {
2897
- * "label": "Support phone",
2898
- * "phone": "+49123456789"
2899
- * }
2900
- * ],
2901
- * "company_website": "https://example.com",
2902
- * "tax_id": "DE123456789",
2903
- * "tax_exemption": "2019-08-24",
2904
- * "contacts": {
2905
- * "$relation": [
2906
- * {
2907
- * "_tags": [
2908
- * "CEO"
2909
- * ],
2910
- * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2911
- * }
2912
- * ]
2913
- * }
2914
- * }
2915
- * ]
2916
- * }
2917
- */
2918
- export interface HydratedEntity {
2919
- [name: string]: any;
2920
- _relations: {
2921
- entity_id: EntityId /* uuid */;
2922
- }[];
2923
- }
2924
3080
  /**
2925
3081
  * No UI representation
2926
3082
  */
@@ -2976,7 +3132,11 @@ declare namespace Components {
2976
3132
  *
2977
3133
  */
2978
3134
  render_condition?: string;
2979
- _purpose?: ClassificationId /* uuid */[];
3135
+ _purpose?: /**
3136
+ * example:
3137
+ * taxonomy-slug:classification-slug
3138
+ */
3139
+ ClassificationId[];
2980
3140
  /**
2981
3141
  * A set of constraints applicable to the attribute.
2982
3142
  * These constraints should and will be enforced by the attribute renderer.
@@ -3098,7 +3258,11 @@ declare namespace Components {
3098
3258
  *
3099
3259
  */
3100
3260
  render_condition?: string;
3101
- _purpose?: ClassificationId /* uuid */[];
3261
+ _purpose?: /**
3262
+ * example:
3263
+ * taxonomy-slug:classification-slug
3264
+ */
3265
+ ClassificationId[];
3102
3266
  /**
3103
3267
  * A set of constraints applicable to the attribute.
3104
3268
  * These constraints should and will be enforced by the attribute renderer.
@@ -3220,7 +3384,11 @@ declare namespace Components {
3220
3384
  *
3221
3385
  */
3222
3386
  render_condition?: string;
3223
- _purpose?: ClassificationId /* uuid */[];
3387
+ _purpose?: /**
3388
+ * example:
3389
+ * taxonomy-slug:classification-slug
3390
+ */
3391
+ ClassificationId[];
3224
3392
  /**
3225
3393
  * A set of constraints applicable to the attribute.
3226
3394
  * These constraints should and will be enforced by the attribute renderer.
@@ -3350,7 +3518,11 @@ declare namespace Components {
3350
3518
  *
3351
3519
  */
3352
3520
  render_condition?: string;
3353
- _purpose?: ClassificationId /* uuid */[];
3521
+ _purpose?: /**
3522
+ * example:
3523
+ * taxonomy-slug:classification-slug
3524
+ */
3525
+ ClassificationId[];
3354
3526
  /**
3355
3527
  * A set of constraints applicable to the attribute.
3356
3528
  * These constraints should and will be enforced by the attribute renderer.
@@ -3417,6 +3589,14 @@ declare namespace Components {
3417
3589
  };
3418
3590
  type?: "link";
3419
3591
  }
3592
+ export interface ListSavedViewsResults {
3593
+ /**
3594
+ * example:
3595
+ * 1
3596
+ */
3597
+ hits?: number;
3598
+ results?: /* A saved entity view */ SavedViewItem[];
3599
+ }
3420
3600
  /**
3421
3601
  * Multi Choice Selection
3422
3602
  */
@@ -3472,7 +3652,11 @@ declare namespace Components {
3472
3652
  *
3473
3653
  */
3474
3654
  render_condition?: string;
3475
- _purpose?: ClassificationId /* uuid */[];
3655
+ _purpose?: /**
3656
+ * example:
3657
+ * taxonomy-slug:classification-slug
3658
+ */
3659
+ ClassificationId[];
3476
3660
  /**
3477
3661
  * A set of constraints applicable to the attribute.
3478
3662
  * These constraints should and will be enforced by the attribute renderer.
@@ -3610,7 +3794,11 @@ declare namespace Components {
3610
3794
  *
3611
3795
  */
3612
3796
  render_condition?: string;
3613
- _purpose?: ClassificationId /* uuid */[];
3797
+ _purpose?: /**
3798
+ * example:
3799
+ * taxonomy-slug:classification-slug
3800
+ */
3801
+ ClassificationId[];
3614
3802
  /**
3615
3803
  * A set of constraints applicable to the attribute.
3616
3804
  * These constraints should and will be enforced by the attribute renderer.
@@ -3677,6 +3865,10 @@ declare namespace Components {
3677
3865
  };
3678
3866
  type?: "number";
3679
3867
  format?: string;
3868
+ /**
3869
+ * Whether or not to show a thousands separator
3870
+ */
3871
+ show_separator?: boolean;
3680
3872
  }
3681
3873
  /**
3682
3874
  * Type of attribute to render N number of ordered fields
@@ -3733,7 +3925,11 @@ declare namespace Components {
3733
3925
  *
3734
3926
  */
3735
3927
  render_condition?: string;
3736
- _purpose?: ClassificationId /* uuid */[];
3928
+ _purpose?: /**
3929
+ * example:
3930
+ * taxonomy-slug:classification-slug
3931
+ */
3932
+ ClassificationId[];
3737
3933
  /**
3738
3934
  * A set of constraints applicable to the attribute.
3739
3935
  * These constraints should and will be enforced by the attribute renderer.
@@ -3855,7 +4051,11 @@ declare namespace Components {
3855
4051
  *
3856
4052
  */
3857
4053
  render_condition?: string;
3858
- _purpose?: ClassificationId /* uuid */[];
4054
+ _purpose?: /**
4055
+ * example:
4056
+ * taxonomy-slug:classification-slug
4057
+ */
4058
+ ClassificationId[];
3859
4059
  /**
3860
4060
  * A set of constraints applicable to the attribute.
3861
4061
  * These constraints should and will be enforced by the attribute renderer.
@@ -3977,7 +4177,11 @@ declare namespace Components {
3977
4177
  *
3978
4178
  */
3979
4179
  render_condition?: string;
3980
- _purpose?: ClassificationId /* uuid */[];
4180
+ _purpose?: /**
4181
+ * example:
4182
+ * taxonomy-slug:classification-slug
4183
+ */
4184
+ ClassificationId[];
3981
4185
  /**
3982
4186
  * A set of constraints applicable to the attribute.
3983
4187
  * These constraints should and will be enforced by the attribute renderer.
@@ -4099,7 +4303,11 @@ declare namespace Components {
4099
4303
  *
4100
4304
  */
4101
4305
  render_condition?: string;
4102
- _purpose?: ClassificationId /* uuid */[];
4306
+ _purpose?: /**
4307
+ * example:
4308
+ * taxonomy-slug:classification-slug
4309
+ */
4310
+ ClassificationId[];
4103
4311
  /**
4104
4312
  * A set of constraints applicable to the attribute.
4105
4313
  * These constraints should and will be enforced by the attribute renderer.
@@ -4226,7 +4434,11 @@ declare namespace Components {
4226
4434
  *
4227
4435
  */
4228
4436
  render_condition?: string;
4229
- _purpose?: ClassificationId /* uuid */[];
4437
+ _purpose?: /**
4438
+ * example:
4439
+ * taxonomy-slug:classification-slug
4440
+ */
4441
+ ClassificationId[];
4230
4442
  /**
4231
4443
  * A set of constraints applicable to the attribute.
4232
4444
  * These constraints should and will be enforced by the attribute renderer.
@@ -4291,14 +4503,22 @@ declare namespace Components {
4291
4503
  */
4292
4504
  hint_tooltip_placement?: string;
4293
4505
  };
4294
- id?: ClassificationId /* uuid */;
4506
+ id?: /**
4507
+ * example:
4508
+ * taxonomy-slug:classification-slug
4509
+ */
4510
+ ClassificationId;
4295
4511
  /**
4296
4512
  * URL-friendly identifier for the classification
4297
4513
  * example:
4298
4514
  * wallbox-pv
4299
4515
  */
4300
4516
  slug?: string;
4301
- parents?: ClassificationId /* uuid */[];
4517
+ parents?: /**
4518
+ * example:
4519
+ * taxonomy-slug:classification-slug
4520
+ */
4521
+ ClassificationId[];
4302
4522
  created_at?: string; // date-time
4303
4523
  updated_at?: string; // date-time
4304
4524
  type?: "purpose";
@@ -4373,7 +4593,11 @@ declare namespace Components {
4373
4593
  *
4374
4594
  */
4375
4595
  render_condition?: string;
4376
- _purpose?: ClassificationId /* uuid */[];
4596
+ _purpose?: /**
4597
+ * example:
4598
+ * taxonomy-slug:classification-slug
4599
+ */
4600
+ ClassificationId[];
4377
4601
  /**
4378
4602
  * A set of constraints applicable to the attribute.
4379
4603
  * These constraints should and will be enforced by the attribute renderer.
@@ -4732,7 +4956,11 @@ declare namespace Components {
4732
4956
  *
4733
4957
  */
4734
4958
  render_condition?: string;
4735
- _purpose?: ClassificationId /* uuid */[];
4959
+ _purpose?: /**
4960
+ * example:
4961
+ * taxonomy-slug:classification-slug
4962
+ */
4963
+ ClassificationId[];
4736
4964
  /**
4737
4965
  * A set of constraints applicable to the attribute.
4738
4966
  * These constraints should and will be enforced by the attribute renderer.
@@ -5027,7 +5255,11 @@ declare namespace Components {
5027
5255
  *
5028
5256
  */
5029
5257
  render_condition?: string;
5030
- _purpose?: ClassificationId /* uuid */[];
5258
+ _purpose?: /**
5259
+ * example:
5260
+ * taxonomy-slug:classification-slug
5261
+ */
5262
+ ClassificationId[];
5031
5263
  /**
5032
5264
  * A set of constraints applicable to the attribute.
5033
5265
  * These constraints should and will be enforced by the attribute renderer.
@@ -5157,7 +5389,11 @@ declare namespace Components {
5157
5389
  *
5158
5390
  */
5159
5391
  render_condition?: string;
5160
- _purpose?: ClassificationId /* uuid */[];
5392
+ _purpose?: /**
5393
+ * example:
5394
+ * taxonomy-slug:classification-slug
5395
+ */
5396
+ ClassificationId[];
5161
5397
  /**
5162
5398
  * A set of constraints applicable to the attribute.
5163
5399
  * These constraints should and will be enforced by the attribute renderer.
@@ -5296,7 +5532,11 @@ declare namespace Components {
5296
5532
  *
5297
5533
  */
5298
5534
  render_condition?: string;
5299
- _purpose?: ClassificationId /* uuid */[];
5535
+ _purpose?: /**
5536
+ * example:
5537
+ * taxonomy-slug:classification-slug
5538
+ */
5539
+ ClassificationId[];
5300
5540
  /**
5301
5541
  * A set of constraints applicable to the attribute.
5302
5542
  * These constraints should and will be enforced by the attribute renderer.
@@ -5488,7 +5728,11 @@ declare namespace Components {
5488
5728
  *
5489
5729
  */
5490
5730
  render_condition?: string;
5491
- _purpose?: ClassificationId /* uuid */[];
5731
+ _purpose?: /**
5732
+ * example:
5733
+ * taxonomy-slug:classification-slug
5734
+ */
5735
+ ClassificationId[];
5492
5736
  /**
5493
5737
  * A set of constraints applicable to the attribute.
5494
5738
  * These constraints should and will be enforced by the attribute renderer.
@@ -5614,7 +5858,11 @@ declare namespace Components {
5614
5858
  enabled?: boolean;
5615
5859
  }
5616
5860
  export interface TaxonomyClassification {
5617
- id?: ClassificationId /* uuid */;
5861
+ id?: /**
5862
+ * example:
5863
+ * taxonomy-slug:classification-slug
5864
+ */
5865
+ ClassificationId;
5618
5866
  /**
5619
5867
  * URL-friendly identifier for the classification
5620
5868
  * example:
@@ -5626,7 +5874,11 @@ declare namespace Components {
5626
5874
  * Wallbox PV
5627
5875
  */
5628
5876
  name: string;
5629
- parents?: ClassificationId /* uuid */[];
5877
+ parents?: /**
5878
+ * example:
5879
+ * taxonomy-slug:classification-slug
5880
+ */
5881
+ ClassificationId[];
5630
5882
  created_at?: string; // date-time
5631
5883
  updated_at?: string; // date-time
5632
5884
  }
@@ -5691,7 +5943,11 @@ declare namespace Components {
5691
5943
  *
5692
5944
  */
5693
5945
  render_condition?: string;
5694
- _purpose?: ClassificationId /* uuid */[];
5946
+ _purpose?: /**
5947
+ * example:
5948
+ * taxonomy-slug:classification-slug
5949
+ */
5950
+ ClassificationId[];
5695
5951
  /**
5696
5952
  * A set of constraints applicable to the attribute.
5697
5953
  * These constraints should and will be enforced by the attribute renderer.
@@ -5814,7 +6070,11 @@ declare namespace Components {
5814
6070
  *
5815
6071
  */
5816
6072
  render_condition?: string;
5817
- _purpose?: ClassificationId /* uuid */[];
6073
+ _purpose?: /**
6074
+ * example:
6075
+ * taxonomy-slug:classification-slug
6076
+ */
6077
+ ClassificationId[];
5818
6078
  /**
5819
6079
  * A set of constraints applicable to the attribute.
5820
6080
  * These constraints should and will be enforced by the attribute renderer.
@@ -5932,7 +6192,7 @@ declare namespace Paths {
5932
6192
  entities?: Parameters.Entities;
5933
6193
  }
5934
6194
  namespace Responses {
5935
- export type $200 = Components.Schemas.ActivityItem;
6195
+ export type $200 = Components.Schemas.BaseActivityItem;
5936
6196
  }
5937
6197
  }
5938
6198
  namespace Autocomplete {
@@ -5989,7 +6249,7 @@ declare namespace Paths {
5989
6249
  }
5990
6250
  export type RequestBody = Components.Schemas.Activity;
5991
6251
  namespace Responses {
5992
- export type $200 = Components.Schemas.ActivityItem;
6252
+ export type $200 = Components.Schemas.BaseActivityItem;
5993
6253
  }
5994
6254
  }
5995
6255
  namespace CreateEntity {
@@ -6157,6 +6417,11 @@ declare namespace Paths {
6157
6417
  taxonomySlug: Parameters.TaxonomySlug;
6158
6418
  }
6159
6419
  export type RequestBody = Components.Schemas.TaxonomyClassification;
6420
+ namespace Responses {
6421
+ export type $201 = Components.Schemas.TaxonomyClassification;
6422
+ export interface $409 {
6423
+ }
6424
+ }
6160
6425
  }
6161
6426
  namespace DeleteEntity {
6162
6427
  namespace Parameters {
@@ -6249,6 +6514,44 @@ declare namespace Paths {
6249
6514
  }
6250
6515
  }
6251
6516
  }
6517
+ namespace DeleteSchemaAttribute {
6518
+ namespace Parameters {
6519
+ /**
6520
+ * example:
6521
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
6522
+ */
6523
+ export type CompositeId = string; // ^.+:.+$
6524
+ }
6525
+ export interface PathParameters {
6526
+ composite_id: /**
6527
+ * example:
6528
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
6529
+ */
6530
+ Parameters.CompositeId /* ^.+:.+$ */;
6531
+ }
6532
+ namespace Responses {
6533
+ export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
6534
+ }
6535
+ }
6536
+ namespace DeleteSchemaCapability {
6537
+ namespace Parameters {
6538
+ /**
6539
+ * example:
6540
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
6541
+ */
6542
+ export type CompositeId = string; // ^.+:.+$
6543
+ }
6544
+ export interface PathParameters {
6545
+ composite_id: /**
6546
+ * example:
6547
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
6548
+ */
6549
+ Parameters.CompositeId /* ^.+:.+$ */;
6550
+ }
6551
+ namespace Responses {
6552
+ export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
6553
+ }
6554
+ }
6252
6555
  namespace DeleteTaxonomy {
6253
6556
  namespace Parameters {
6254
6557
  export type Permanent = boolean;
@@ -6267,17 +6570,21 @@ declare namespace Paths {
6267
6570
  }
6268
6571
  namespace DeleteTaxonomyClassification {
6269
6572
  namespace Parameters {
6270
- export type ClassificationId = Components.Schemas.ClassificationId /* uuid */;
6573
+ export type ClassificationSlug = string;
6271
6574
  export type Permanent = boolean;
6272
6575
  export type TaxonomySlug = string;
6273
6576
  }
6274
6577
  export interface PathParameters {
6275
6578
  taxonomySlug: Parameters.TaxonomySlug;
6276
- classificationId: Parameters.ClassificationId;
6579
+ classificationSlug: Parameters.ClassificationSlug;
6277
6580
  }
6278
6581
  export interface QueryParameters {
6279
6582
  permanent?: Parameters.Permanent;
6280
6583
  }
6584
+ namespace Responses {
6585
+ export interface $204 {
6586
+ }
6587
+ }
6281
6588
  }
6282
6589
  namespace ExportEntities {
6283
6590
  namespace Parameters {
@@ -6732,9 +7039,7 @@ declare namespace Paths {
6732
7039
  id: Parameters.Id;
6733
7040
  }
6734
7041
  namespace Responses {
6735
- export interface $200 {
6736
- view?: /* A saved entity view */ Components.Schemas.SavedViewItem;
6737
- }
7042
+ export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
6738
7043
  }
6739
7044
  }
6740
7045
  namespace GetSchema {
@@ -6757,6 +7062,44 @@ declare namespace Paths {
6757
7062
  export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
6758
7063
  }
6759
7064
  }
7065
+ namespace GetSchemaAttribute {
7066
+ namespace Parameters {
7067
+ /**
7068
+ * example:
7069
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7070
+ */
7071
+ export type CompositeId = string; // ^.+:.+$
7072
+ }
7073
+ export interface PathParameters {
7074
+ composite_id: /**
7075
+ * example:
7076
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7077
+ */
7078
+ Parameters.CompositeId /* ^.+:.+$ */;
7079
+ }
7080
+ namespace Responses {
7081
+ export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
7082
+ }
7083
+ }
7084
+ namespace GetSchemaCapability {
7085
+ namespace Parameters {
7086
+ /**
7087
+ * example:
7088
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7089
+ */
7090
+ export type CompositeId = string; // ^.+:.+$
7091
+ }
7092
+ export interface PathParameters {
7093
+ composite_id: /**
7094
+ * example:
7095
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7096
+ */
7097
+ Parameters.CompositeId /* ^.+:.+$ */;
7098
+ }
7099
+ namespace Responses {
7100
+ export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
7101
+ }
7102
+ }
6760
7103
  namespace GetSchemaVersions {
6761
7104
  namespace Parameters {
6762
7105
  export type DraftsFrom = number;
@@ -6815,21 +7158,6 @@ declare namespace Paths {
6815
7158
  export type $200 = Components.Schemas.Taxonomy;
6816
7159
  }
6817
7160
  }
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
- }
6833
7161
  namespace ImportEntities {
6834
7162
  namespace Parameters {
6835
7163
  export type JobId = /**
@@ -6857,20 +7185,43 @@ declare namespace Paths {
6857
7185
  }
6858
7186
  namespace ListSavedViews {
6859
7187
  namespace Parameters {
7188
+ export type Fields = /**
7189
+ * List of entity fields to include or exclude in the response
7190
+ *
7191
+ * Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
7192
+ *
7193
+ * Globbing and globstart (**) is supported for nested fields.
7194
+ *
7195
+ * example:
7196
+ * [
7197
+ * "_id",
7198
+ * "_title",
7199
+ * "first_name",
7200
+ * "account",
7201
+ * "!account.*._files",
7202
+ * "**._product"
7203
+ * ]
7204
+ */
7205
+ Components.Schemas.FieldsParam;
7206
+ export type From = number;
7207
+ export type Size = number;
6860
7208
  export type Slug = /**
6861
7209
  * URL-friendly identifier for the entity schema
6862
7210
  * example:
6863
7211
  * contact
6864
7212
  */
6865
7213
  Components.Schemas.EntitySlug;
7214
+ export type Sort = string;
6866
7215
  }
6867
7216
  export interface QueryParameters {
6868
7217
  slug?: Parameters.Slug;
7218
+ sort?: Parameters.Sort;
7219
+ from?: Parameters.From;
7220
+ size?: Parameters.Size;
7221
+ fields?: Parameters.Fields;
6869
7222
  }
6870
7223
  namespace Responses {
6871
- export interface $200 {
6872
- results?: /* A saved entity view */ Components.Schemas.SavedViewItem[];
6873
- }
7224
+ export type $200 = Components.Schemas.ListSavedViewsResults;
6874
7225
  }
6875
7226
  }
6876
7227
  namespace ListSchemaBlueprints {
@@ -7061,6 +7412,46 @@ declare namespace Paths {
7061
7412
  export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
7062
7413
  }
7063
7414
  }
7415
+ namespace PutSchemaAttribute {
7416
+ namespace Parameters {
7417
+ /**
7418
+ * example:
7419
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7420
+ */
7421
+ export type CompositeId = string; // ^.+:.+$
7422
+ }
7423
+ export interface PathParameters {
7424
+ composite_id: /**
7425
+ * example:
7426
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7427
+ */
7428
+ Parameters.CompositeId /* ^.+:.+$ */;
7429
+ }
7430
+ export type RequestBody = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
7431
+ namespace Responses {
7432
+ export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
7433
+ }
7434
+ }
7435
+ namespace PutSchemaCapability {
7436
+ namespace Parameters {
7437
+ /**
7438
+ * example:
7439
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7440
+ */
7441
+ export type CompositeId = string; // ^.+:.+$
7442
+ }
7443
+ export interface PathParameters {
7444
+ composite_id: /**
7445
+ * example:
7446
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7447
+ */
7448
+ Parameters.CompositeId /* ^.+:.+$ */;
7449
+ }
7450
+ export type RequestBody = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
7451
+ namespace Responses {
7452
+ export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
7453
+ }
7454
+ }
7064
7455
  namespace SearchEntities {
7065
7456
  export type RequestBody = Components.Schemas.EntitySearchParams;
7066
7457
  namespace Responses {
@@ -7069,13 +7460,27 @@ declare namespace Paths {
7069
7460
  }
7070
7461
  namespace TaxonomiesClassificationsSearch {
7071
7462
  namespace Parameters {
7463
+ /**
7464
+ * example:
7465
+ * sales
7466
+ */
7467
+ export type Query = string;
7072
7468
  export type TaxonomySlug = string;
7073
7469
  }
7074
7470
  export interface QueryParameters {
7075
- taxonomySlug: Parameters.TaxonomySlug;
7471
+ taxonomySlug?: Parameters.TaxonomySlug;
7472
+ query?: /**
7473
+ * example:
7474
+ * sales
7475
+ */
7476
+ Parameters.Query;
7076
7477
  }
7077
7478
  export interface RequestBody {
7078
- classificationIds?: Components.Schemas.ClassificationId /* uuid */[];
7479
+ classificationIds?: /**
7480
+ * example:
7481
+ * taxonomy-slug:classification-slug
7482
+ */
7483
+ Components.Schemas.ClassificationId[];
7079
7484
  }
7080
7485
  namespace Responses {
7081
7486
  export interface $200 {
@@ -7327,12 +7732,19 @@ declare namespace Paths {
7327
7732
  }
7328
7733
  namespace UpdateTaxonomyClassification {
7329
7734
  namespace Parameters {
7735
+ export type ClassificationSlug = string;
7330
7736
  export type TaxonomySlug = string;
7331
7737
  }
7332
7738
  export interface PathParameters {
7333
7739
  taxonomySlug: Parameters.TaxonomySlug;
7740
+ classificationSlug: Parameters.ClassificationSlug;
7334
7741
  }
7335
7742
  export type RequestBody = Components.Schemas.TaxonomyClassification;
7743
+ namespace Responses {
7744
+ export type $200 = Components.Schemas.TaxonomyClassification;
7745
+ export interface $404 {
7746
+ }
7747
+ }
7336
7748
  }
7337
7749
  namespace UpsertEntity {
7338
7750
  namespace Parameters {
@@ -8248,15 +8660,15 @@ export interface OperationMethods {
8248
8660
  config?: AxiosRequestConfig
8249
8661
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
8250
8662
  /**
8251
- * getTaxonomyClassification - getTaxonomyClassification
8663
+ * createTaxonomyClassification - createTaxonomyClassification
8252
8664
  *
8253
- * Gets the classification of a taxonomy
8665
+ * Create a new classification for a taxonomy
8254
8666
  */
8255
- 'getTaxonomyClassification'(
8256
- parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
8257
- data?: any,
8667
+ 'createTaxonomyClassification'(
8668
+ parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
8669
+ data?: Paths.CreateTaxonomyClassification.RequestBody,
8258
8670
  config?: AxiosRequestConfig
8259
- ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
8671
+ ): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
8260
8672
  /**
8261
8673
  * updateTaxonomyClassification - updateTaxonomyClassification
8262
8674
  *
@@ -8266,17 +8678,7 @@ export interface OperationMethods {
8266
8678
  parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
8267
8679
  data?: Paths.UpdateTaxonomyClassification.RequestBody,
8268
8680
  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>
8681
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
8280
8682
  /**
8281
8683
  * deleteTaxonomyClassification - deleteTaxonomyClassification
8282
8684
  *
@@ -8286,7 +8688,67 @@ export interface OperationMethods {
8286
8688
  parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
8287
8689
  data?: any,
8288
8690
  config?: AxiosRequestConfig
8289
- ): OperationResponse<any>
8691
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
8692
+ /**
8693
+ * getSchemaAttribute - getSchemaAttribute
8694
+ *
8695
+ * Get a schema attribute from given attribute ID
8696
+ */
8697
+ 'getSchemaAttribute'(
8698
+ parameters?: Parameters<Paths.GetSchemaAttribute.PathParameters> | null,
8699
+ data?: any,
8700
+ config?: AxiosRequestConfig
8701
+ ): OperationResponse<Paths.GetSchemaAttribute.Responses.$200>
8702
+ /**
8703
+ * putSchemaAttribute - putSchemaAttribute
8704
+ *
8705
+ * Adds or updates an attribute in the schema
8706
+ */
8707
+ 'putSchemaAttribute'(
8708
+ parameters?: Parameters<Paths.PutSchemaAttribute.PathParameters> | null,
8709
+ data?: Paths.PutSchemaAttribute.RequestBody,
8710
+ config?: AxiosRequestConfig
8711
+ ): OperationResponse<Paths.PutSchemaAttribute.Responses.$200>
8712
+ /**
8713
+ * deleteSchemaAttribute - deleteSchemaAttribute
8714
+ *
8715
+ * Deletes an attribute from a schema
8716
+ */
8717
+ 'deleteSchemaAttribute'(
8718
+ parameters?: Parameters<Paths.DeleteSchemaAttribute.PathParameters> | null,
8719
+ data?: any,
8720
+ config?: AxiosRequestConfig
8721
+ ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
8722
+ /**
8723
+ * getSchemaCapability - getSchemaCapability
8724
+ *
8725
+ * Get a schema capability from given capability ID
8726
+ */
8727
+ 'getSchemaCapability'(
8728
+ parameters?: Parameters<Paths.GetSchemaCapability.PathParameters> | null,
8729
+ data?: any,
8730
+ config?: AxiosRequestConfig
8731
+ ): OperationResponse<Paths.GetSchemaCapability.Responses.$200>
8732
+ /**
8733
+ * putSchemaCapability - putSchemaCapability
8734
+ *
8735
+ * Adds or updates an capability in the schema
8736
+ */
8737
+ 'putSchemaCapability'(
8738
+ parameters?: Parameters<Paths.PutSchemaCapability.PathParameters> | null,
8739
+ data?: Paths.PutSchemaCapability.RequestBody,
8740
+ config?: AxiosRequestConfig
8741
+ ): OperationResponse<Paths.PutSchemaCapability.Responses.$200>
8742
+ /**
8743
+ * deleteSchemaCapability - deleteSchemaCapability
8744
+ *
8745
+ * Deletes a Capability from a schema
8746
+ */
8747
+ 'deleteSchemaCapability'(
8748
+ parameters?: Parameters<Paths.DeleteSchemaCapability.PathParameters> | null,
8749
+ data?: any,
8750
+ config?: AxiosRequestConfig
8751
+ ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
8290
8752
  }
8291
8753
 
8292
8754
  export interface PathsDictionary {
@@ -9053,17 +9515,7 @@ export interface PathsDictionary {
9053
9515
  config?: AxiosRequestConfig
9054
9516
  ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
9055
9517
  }
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>
9518
+ ['/v2/entity/taxonomies/{taxonomySlug}/classifications']: {
9067
9519
  /**
9068
9520
  * createTaxonomyClassification - createTaxonomyClassification
9069
9521
  *
@@ -9073,7 +9525,9 @@ export interface PathsDictionary {
9073
9525
  parameters?: Parameters<Paths.CreateTaxonomyClassification.PathParameters> | null,
9074
9526
  data?: Paths.CreateTaxonomyClassification.RequestBody,
9075
9527
  config?: AxiosRequestConfig
9076
- ): OperationResponse<any>
9528
+ ): OperationResponse<Paths.CreateTaxonomyClassification.Responses.$201>
9529
+ }
9530
+ ['/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}']: {
9077
9531
  /**
9078
9532
  * updateTaxonomyClassification - updateTaxonomyClassification
9079
9533
  *
@@ -9083,7 +9537,7 @@ export interface PathsDictionary {
9083
9537
  parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
9084
9538
  data?: Paths.UpdateTaxonomyClassification.RequestBody,
9085
9539
  config?: AxiosRequestConfig
9086
- ): OperationResponse<any>
9540
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
9087
9541
  /**
9088
9542
  * deleteTaxonomyClassification - deleteTaxonomyClassification
9089
9543
  *
@@ -9093,7 +9547,71 @@ export interface PathsDictionary {
9093
9547
  parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters & Paths.DeleteTaxonomyClassification.QueryParameters> | null,
9094
9548
  data?: any,
9095
9549
  config?: AxiosRequestConfig
9096
- ): OperationResponse<any>
9550
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$204>
9551
+ }
9552
+ ['/v1/entity/schemas/attributes/{composite_id}']: {
9553
+ /**
9554
+ * getSchemaAttribute - getSchemaAttribute
9555
+ *
9556
+ * Get a schema attribute from given attribute ID
9557
+ */
9558
+ 'get'(
9559
+ parameters?: Parameters<Paths.GetSchemaAttribute.PathParameters> | null,
9560
+ data?: any,
9561
+ config?: AxiosRequestConfig
9562
+ ): OperationResponse<Paths.GetSchemaAttribute.Responses.$200>
9563
+ /**
9564
+ * putSchemaAttribute - putSchemaAttribute
9565
+ *
9566
+ * Adds or updates an attribute in the schema
9567
+ */
9568
+ 'put'(
9569
+ parameters?: Parameters<Paths.PutSchemaAttribute.PathParameters> | null,
9570
+ data?: Paths.PutSchemaAttribute.RequestBody,
9571
+ config?: AxiosRequestConfig
9572
+ ): OperationResponse<Paths.PutSchemaAttribute.Responses.$200>
9573
+ /**
9574
+ * deleteSchemaAttribute - deleteSchemaAttribute
9575
+ *
9576
+ * Deletes an attribute from a schema
9577
+ */
9578
+ 'delete'(
9579
+ parameters?: Parameters<Paths.DeleteSchemaAttribute.PathParameters> | null,
9580
+ data?: any,
9581
+ config?: AxiosRequestConfig
9582
+ ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
9583
+ }
9584
+ ['/v1/entity/schemas/capabilities/{composite_id}']: {
9585
+ /**
9586
+ * getSchemaCapability - getSchemaCapability
9587
+ *
9588
+ * Get a schema capability from given capability ID
9589
+ */
9590
+ 'get'(
9591
+ parameters?: Parameters<Paths.GetSchemaCapability.PathParameters> | null,
9592
+ data?: any,
9593
+ config?: AxiosRequestConfig
9594
+ ): OperationResponse<Paths.GetSchemaCapability.Responses.$200>
9595
+ /**
9596
+ * putSchemaCapability - putSchemaCapability
9597
+ *
9598
+ * Adds or updates an capability in the schema
9599
+ */
9600
+ 'put'(
9601
+ parameters?: Parameters<Paths.PutSchemaCapability.PathParameters> | null,
9602
+ data?: Paths.PutSchemaCapability.RequestBody,
9603
+ config?: AxiosRequestConfig
9604
+ ): OperationResponse<Paths.PutSchemaCapability.Responses.$200>
9605
+ /**
9606
+ * deleteSchemaCapability - deleteSchemaCapability
9607
+ *
9608
+ * Deletes a Capability from a schema
9609
+ */
9610
+ 'delete'(
9611
+ parameters?: Parameters<Paths.DeleteSchemaCapability.PathParameters> | null,
9612
+ data?: any,
9613
+ config?: AxiosRequestConfig
9614
+ ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
9097
9615
  }
9098
9616
  }
9099
9617