@epilot/sdk 2.20.31 → 2.20.32

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.
Files changed (131) hide show
  1. package/definitions/entity-runtime.json +1 -1
  2. package/definitions/entity.json +118 -3
  3. package/dist/apis/access-token.cjs +6 -6
  4. package/dist/apis/access-token.js +1 -1
  5. package/dist/apis/address-suggestions.cjs +6 -6
  6. package/dist/apis/address-suggestions.js +1 -1
  7. package/dist/apis/address.cjs +6 -6
  8. package/dist/apis/address.js +1 -1
  9. package/dist/apis/ai-agents.cjs +6 -6
  10. package/dist/apis/ai-agents.js +1 -1
  11. package/dist/apis/app.cjs +6 -6
  12. package/dist/apis/app.js +1 -1
  13. package/dist/apis/audit-logs.cjs +6 -6
  14. package/dist/apis/audit-logs.js +1 -1
  15. package/dist/apis/automation.cjs +6 -6
  16. package/dist/apis/automation.js +1 -1
  17. package/dist/apis/billing.cjs +6 -6
  18. package/dist/apis/billing.js +1 -1
  19. package/dist/apis/blueprint-manifest.cjs +6 -6
  20. package/dist/apis/blueprint-manifest.js +1 -1
  21. package/dist/apis/calendar.cjs +6 -6
  22. package/dist/apis/calendar.js +1 -1
  23. package/dist/apis/chat.cjs +6 -6
  24. package/dist/apis/chat.js +1 -1
  25. package/dist/apis/configuration-hub.cjs +6 -6
  26. package/dist/apis/configuration-hub.js +1 -1
  27. package/dist/apis/consent.cjs +6 -6
  28. package/dist/apis/consent.js +1 -1
  29. package/dist/apis/customer-portal.cjs +6 -6
  30. package/dist/apis/customer-portal.js +1 -1
  31. package/dist/apis/dashboard.cjs +6 -6
  32. package/dist/apis/dashboard.js +1 -1
  33. package/dist/apis/data-governance.cjs +6 -6
  34. package/dist/apis/data-governance.js +1 -1
  35. package/dist/apis/deduplication.cjs +6 -6
  36. package/dist/apis/deduplication.js +1 -1
  37. package/dist/apis/design.cjs +6 -6
  38. package/dist/apis/design.js +1 -1
  39. package/dist/apis/document.cjs +6 -6
  40. package/dist/apis/document.js +1 -1
  41. package/dist/apis/email-settings.cjs +6 -6
  42. package/dist/apis/email-settings.js +1 -1
  43. package/dist/apis/email-template.cjs +6 -6
  44. package/dist/apis/email-template.js +1 -1
  45. package/dist/apis/entity-mapping.cjs +6 -6
  46. package/dist/apis/entity-mapping.js +1 -1
  47. package/dist/apis/entity.cjs +8 -8
  48. package/dist/apis/entity.d.cts +2 -2
  49. package/dist/apis/entity.d.ts +2 -2
  50. package/dist/apis/entity.js +2 -2
  51. package/dist/apis/environments.cjs +6 -6
  52. package/dist/apis/environments.js +1 -1
  53. package/dist/apis/event-catalog.cjs +6 -6
  54. package/dist/apis/event-catalog.js +1 -1
  55. package/dist/apis/file.cjs +6 -6
  56. package/dist/apis/file.js +1 -1
  57. package/dist/apis/iban.cjs +6 -6
  58. package/dist/apis/iban.js +1 -1
  59. package/dist/apis/integration-toolkit.cjs +6 -6
  60. package/dist/apis/integration-toolkit.js +1 -1
  61. package/dist/apis/journey.cjs +6 -6
  62. package/dist/apis/journey.js +1 -1
  63. package/dist/apis/kanban.cjs +6 -6
  64. package/dist/apis/kanban.js +1 -1
  65. package/dist/apis/message.cjs +6 -6
  66. package/dist/apis/message.js +1 -1
  67. package/dist/apis/metering.cjs +6 -6
  68. package/dist/apis/metering.js +1 -1
  69. package/dist/apis/notes.cjs +6 -6
  70. package/dist/apis/notes.js +1 -1
  71. package/dist/apis/notification.cjs +6 -6
  72. package/dist/apis/notification.js +1 -1
  73. package/dist/apis/organization.cjs +6 -6
  74. package/dist/apis/organization.js +1 -1
  75. package/dist/apis/partner-directory.cjs +6 -6
  76. package/dist/apis/partner-directory.js +1 -1
  77. package/dist/apis/permissions.cjs +6 -6
  78. package/dist/apis/permissions.js +1 -1
  79. package/dist/apis/pricing-tier.cjs +6 -6
  80. package/dist/apis/pricing-tier.js +1 -1
  81. package/dist/apis/pricing.cjs +6 -6
  82. package/dist/apis/pricing.js +1 -1
  83. package/dist/apis/purpose.cjs +6 -6
  84. package/dist/apis/purpose.js +1 -1
  85. package/dist/apis/query.cjs +6 -6
  86. package/dist/apis/query.js +1 -1
  87. package/dist/apis/sandbox.cjs +6 -6
  88. package/dist/apis/sandbox.js +1 -1
  89. package/dist/apis/sharing.cjs +6 -6
  90. package/dist/apis/sharing.js +1 -1
  91. package/dist/apis/snapshot.cjs +6 -6
  92. package/dist/apis/snapshot.js +1 -1
  93. package/dist/apis/submission.cjs +6 -6
  94. package/dist/apis/submission.js +1 -1
  95. package/dist/apis/target.cjs +6 -6
  96. package/dist/apis/target.js +1 -1
  97. package/dist/apis/targeting.cjs +6 -6
  98. package/dist/apis/targeting.js +1 -1
  99. package/dist/apis/template-variables.cjs +6 -6
  100. package/dist/apis/template-variables.js +1 -1
  101. package/dist/apis/user.cjs +6 -6
  102. package/dist/apis/user.js +1 -1
  103. package/dist/apis/validation-rules.cjs +6 -6
  104. package/dist/apis/validation-rules.js +1 -1
  105. package/dist/apis/webhooks.cjs +6 -6
  106. package/dist/apis/webhooks.js +1 -1
  107. package/dist/apis/workflow-definition.cjs +6 -6
  108. package/dist/apis/workflow-definition.js +1 -1
  109. package/dist/apis/workflow.cjs +6 -6
  110. package/dist/apis/workflow.js +1 -1
  111. package/dist/{chunk-BY67WVUK.cjs → chunk-A6FO6QAZ.cjs} +2 -2
  112. package/dist/{chunk-MCAD6CIA.js → chunk-E7DJRTMC.js} +2 -2
  113. package/dist/chunk-KXNPNC4J.js +14 -0
  114. package/dist/chunk-XT2XPHUH.cjs +14 -0
  115. package/dist/entity-3XUHHKA4.cjs +7 -0
  116. package/dist/entity-UEP5OY55.js +7 -0
  117. package/dist/entity-runtime-DYQQGB4F.cjs +5 -0
  118. package/dist/{entity-runtime-EBFSSNOM.js → entity-runtime-JRSXJKRV.js} +1 -1
  119. package/dist/{entity.d-GfKqzFGA.d.cts → entity.d-BHNaIrDi.d.cts} +215 -12
  120. package/dist/{entity.d-GfKqzFGA.d.ts → entity.d-BHNaIrDi.d.ts} +215 -12
  121. package/dist/index.cjs +10 -10
  122. package/dist/index.d.cts +1 -1
  123. package/dist/index.d.ts +1 -1
  124. package/dist/index.js +2 -2
  125. package/docs/entity.md +42 -22
  126. package/package.json +1 -1
  127. package/dist/chunk-XHTYJNOZ.cjs +0 -14
  128. package/dist/chunk-ZQU37FR3.js +0 -14
  129. package/dist/entity-7LYDUHKF.js +0 -7
  130. package/dist/entity-X6CXO437.cjs +0 -7
  131. package/dist/entity-runtime-7INAS2AX.cjs +0 -5
@@ -0,0 +1,5 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
+
3
+ var _chunkXT2XPHUHcjs = require('./chunk-XT2XPHUH.cjs');
4
+ require('./chunk-NJK5F5TF.cjs');
5
+ exports. default = _chunkXT2XPHUHcjs.require_entity_runtime.call(void 0, );
@@ -1,5 +1,5 @@
1
1
  import {
2
2
  require_entity_runtime
3
- } from "./chunk-ZQU37FR3.js";
3
+ } from "./chunk-KXNPNC4J.js";
4
4
  import "./chunk-YPSWSI3M.js";
5
5
  export default require_entity_runtime();
@@ -3352,14 +3352,23 @@ declare namespace Components {
3352
3352
  title?: string;
3353
3353
  attributes?: Attribute[];
3354
3354
  /**
3355
- * Allow conditional variants of the entity to override the values managed by this
3356
- * capability. Only meaningful on schemas that declare `conditions` and on capabilities
3357
- * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
3358
- * Attributes carried by the capability opt in individually via their own
3359
- * `overridable_attribute` flag.
3355
+ * Allow conditional variants to override the fields this capability manages. Only
3356
+ * meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
3357
+ * flag covers exactly what that lists, not the capability's name.
3360
3358
  *
3361
3359
  */
3362
3360
  overridable_attribute?: boolean;
3361
+ /**
3362
+ * Every entity field this capability writes, including one named after the capability
3363
+ * itself. With `overridable_attribute`, this is the definitive list of what a variant
3364
+ * may override through the capability, applied as a single patch.
3365
+ *
3366
+ * Fields, not attributes: a capability may write entity fields that have no attribute
3367
+ * definition, so entries need not resolve to one. Where an entry does resolve to an
3368
+ * attribute, `hidden` and `computed` do not disqualify it.
3369
+ *
3370
+ */
3371
+ managed_fields?: string /* ^[a-z0-9_]+$ */[];
3363
3372
  _purpose?: /**
3364
3373
  * example:
3365
3374
  * taxonomy-slug:classification-slug
@@ -3532,14 +3541,23 @@ declare namespace Components {
3532
3541
  title?: string;
3533
3542
  attributes?: Attribute[];
3534
3543
  /**
3535
- * Allow conditional variants of the entity to override the values managed by this
3536
- * capability. Only meaningful on schemas that declare `conditions` and on capabilities
3537
- * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
3538
- * Attributes carried by the capability opt in individually via their own
3539
- * `overridable_attribute` flag.
3544
+ * Allow conditional variants to override the fields this capability manages. Only
3545
+ * meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
3546
+ * flag covers exactly what that lists, not the capability's name.
3540
3547
  *
3541
3548
  */
3542
3549
  overridable_attribute?: boolean;
3550
+ /**
3551
+ * Every entity field this capability writes, including one named after the capability
3552
+ * itself. With `overridable_attribute`, this is the definitive list of what a variant
3553
+ * may override through the capability, applied as a single patch.
3554
+ *
3555
+ * Fields, not attributes: a capability may write entity fields that have no attribute
3556
+ * definition, so entries need not resolve to one. Where an entry does resolve to an
3557
+ * attribute, `hidden` and `computed` do not disqualify it.
3558
+ *
3559
+ */
3560
+ managed_fields?: string /* ^[a-z0-9_]+$ */[];
3543
3561
  _purpose?: /**
3544
3562
  * example:
3545
3563
  * taxonomy-slug:classification-slug
@@ -4701,6 +4719,83 @@ declare namespace Components {
4701
4719
  widget_widths?: {
4702
4720
  [name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
4703
4721
  };
4722
+ /**
4723
+ * Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
4724
+ * example:
4725
+ * [
4726
+ * {
4727
+ * "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
4728
+ * "slug": "sales-overview",
4729
+ * "title": "Sales Overview",
4730
+ * "order": 10,
4731
+ * "type": "widgets",
4732
+ * "widgets": [
4733
+ * {
4734
+ * "id": "next_best_action",
4735
+ * "width": "full_width"
4736
+ * },
4737
+ * {
4738
+ * "id": "recent_communications",
4739
+ * "width": "one_third_width"
4740
+ * }
4741
+ * ]
4742
+ * }
4743
+ * ]
4744
+ */
4745
+ custom_tabs?: {
4746
+ [name: string]: any;
4747
+ /**
4748
+ * Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
4749
+ * example:
4750
+ * 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
4751
+ */
4752
+ id: string;
4753
+ /**
4754
+ * URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
4755
+ * example:
4756
+ * sales-overview
4757
+ */
4758
+ slug: string;
4759
+ /**
4760
+ * Tab label, authored by the configuring user.
4761
+ * example:
4762
+ * Sales Overview
4763
+ */
4764
+ title: string;
4765
+ /**
4766
+ * Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
4767
+ * example:
4768
+ * 10
4769
+ */
4770
+ order: number;
4771
+ /**
4772
+ * Icon name from the existing entity icon set.
4773
+ * example:
4774
+ * person
4775
+ */
4776
+ icon?: string;
4777
+ /**
4778
+ * Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
4779
+ * example:
4780
+ * widgets
4781
+ */
4782
+ type: string;
4783
+ /**
4784
+ * Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
4785
+ */
4786
+ widgets?: {
4787
+ /**
4788
+ * Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
4789
+ * example:
4790
+ * next_best_action
4791
+ */
4792
+ id: string;
4793
+ /**
4794
+ * Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
4795
+ */
4796
+ width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
4797
+ }[];
4798
+ }[];
4704
4799
  };
4705
4800
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
4706
4801
  /**
@@ -5156,6 +5251,83 @@ declare namespace Components {
5156
5251
  widget_widths?: {
5157
5252
  [name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
5158
5253
  };
5254
+ /**
5255
+ * Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
5256
+ * example:
5257
+ * [
5258
+ * {
5259
+ * "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
5260
+ * "slug": "sales-overview",
5261
+ * "title": "Sales Overview",
5262
+ * "order": 10,
5263
+ * "type": "widgets",
5264
+ * "widgets": [
5265
+ * {
5266
+ * "id": "next_best_action",
5267
+ * "width": "full_width"
5268
+ * },
5269
+ * {
5270
+ * "id": "recent_communications",
5271
+ * "width": "one_third_width"
5272
+ * }
5273
+ * ]
5274
+ * }
5275
+ * ]
5276
+ */
5277
+ custom_tabs?: {
5278
+ [name: string]: any;
5279
+ /**
5280
+ * Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
5281
+ * example:
5282
+ * 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
5283
+ */
5284
+ id: string;
5285
+ /**
5286
+ * URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
5287
+ * example:
5288
+ * sales-overview
5289
+ */
5290
+ slug: string;
5291
+ /**
5292
+ * Tab label, authored by the configuring user.
5293
+ * example:
5294
+ * Sales Overview
5295
+ */
5296
+ title: string;
5297
+ /**
5298
+ * Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
5299
+ * example:
5300
+ * 10
5301
+ */
5302
+ order: number;
5303
+ /**
5304
+ * Icon name from the existing entity icon set.
5305
+ * example:
5306
+ * person
5307
+ */
5308
+ icon?: string;
5309
+ /**
5310
+ * Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
5311
+ * example:
5312
+ * widgets
5313
+ */
5314
+ type: string;
5315
+ /**
5316
+ * Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
5317
+ */
5318
+ widgets?: {
5319
+ /**
5320
+ * Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
5321
+ * example:
5322
+ * next_best_action
5323
+ */
5324
+ id: string;
5325
+ /**
5326
+ * Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
5327
+ */
5328
+ width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
5329
+ }[];
5330
+ }[];
5159
5331
  };
5160
5332
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
5161
5333
  /**
@@ -13658,6 +13830,7 @@ declare namespace Paths {
13658
13830
  * _tags
13659
13831
  */
13660
13832
  export type Attribute = string;
13833
+ export type From = number;
13661
13834
  export type Input = string;
13662
13835
  export type Size = number;
13663
13836
  export type Slug = /**
@@ -13677,10 +13850,14 @@ declare namespace Paths {
13677
13850
  Parameters.Attribute;
13678
13851
  slug?: Parameters.Slug;
13679
13852
  size?: Parameters.Size;
13853
+ from?: Parameters.From;
13680
13854
  }
13681
13855
  namespace Responses {
13682
13856
  export interface $200 {
13683
13857
  /**
13858
+ * Number of distinct values matching the input. Exact (independent of `size`, capped at 1000) for
13859
+ * `_tags`; for other attributes the number of distinct values collected so far, which may grow with `size`.
13860
+ *
13684
13861
  * example:
13685
13862
  * 1
13686
13863
  */
@@ -17733,7 +17910,20 @@ interface OperationMethods {
17733
17910
  /**
17734
17911
  * autocomplete - autocomplete
17735
17912
  *
17736
- * Autocomplete entity attributes
17913
+ * Autocomplete entity attributes.
17914
+ *
17915
+ * Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
17916
+ * A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
17917
+ * configuration.
17918
+ *
17919
+ * To enumerate the label catalogue managed in the Label Builder (including labels that are not
17920
+ * assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
17921
+ * `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
17922
+ * `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
17923
+ *
17924
+ * For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
17925
+ * number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
17926
+ * 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
17737
17927
  *
17738
17928
  */
17739
17929
  'autocomplete'(
@@ -18971,7 +19161,20 @@ interface PathsDictionary {
18971
19161
  /**
18972
19162
  * autocomplete - autocomplete
18973
19163
  *
18974
- * Autocomplete entity attributes
19164
+ * Autocomplete entity attributes.
19165
+ *
19166
+ * Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
19167
+ * A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
19168
+ * configuration.
19169
+ *
19170
+ * To enumerate the label catalogue managed in the Label Builder (including labels that are not
19171
+ * assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
19172
+ * `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
19173
+ * `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
19174
+ *
19175
+ * For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
19176
+ * number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
19177
+ * 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
18975
19178
  *
18976
19179
  */
18977
19180
  'get'(
@@ -3352,14 +3352,23 @@ declare namespace Components {
3352
3352
  title?: string;
3353
3353
  attributes?: Attribute[];
3354
3354
  /**
3355
- * Allow conditional variants of the entity to override the values managed by this
3356
- * capability. Only meaningful on schemas that declare `conditions` and on capabilities
3357
- * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
3358
- * Attributes carried by the capability opt in individually via their own
3359
- * `overridable_attribute` flag.
3355
+ * Allow conditional variants to override the fields this capability manages. Only
3356
+ * meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
3357
+ * flag covers exactly what that lists, not the capability's name.
3360
3358
  *
3361
3359
  */
3362
3360
  overridable_attribute?: boolean;
3361
+ /**
3362
+ * Every entity field this capability writes, including one named after the capability
3363
+ * itself. With `overridable_attribute`, this is the definitive list of what a variant
3364
+ * may override through the capability, applied as a single patch.
3365
+ *
3366
+ * Fields, not attributes: a capability may write entity fields that have no attribute
3367
+ * definition, so entries need not resolve to one. Where an entry does resolve to an
3368
+ * attribute, `hidden` and `computed` do not disqualify it.
3369
+ *
3370
+ */
3371
+ managed_fields?: string /* ^[a-z0-9_]+$ */[];
3363
3372
  _purpose?: /**
3364
3373
  * example:
3365
3374
  * taxonomy-slug:classification-slug
@@ -3532,14 +3541,23 @@ declare namespace Components {
3532
3541
  title?: string;
3533
3542
  attributes?: Attribute[];
3534
3543
  /**
3535
- * Allow conditional variants of the entity to override the values managed by this
3536
- * capability. Only meaningful on schemas that declare `conditions` and on capabilities
3537
- * that render an attribute group (`EntityAttributes:Group` ui hook), e.g. pricing tiers.
3538
- * Attributes carried by the capability opt in individually via their own
3539
- * `overridable_attribute` flag.
3544
+ * Allow conditional variants to override the fields this capability manages. Only
3545
+ * meaningful on schemas that declare `conditions`, and requires `managed_fields`: the
3546
+ * flag covers exactly what that lists, not the capability's name.
3540
3547
  *
3541
3548
  */
3542
3549
  overridable_attribute?: boolean;
3550
+ /**
3551
+ * Every entity field this capability writes, including one named after the capability
3552
+ * itself. With `overridable_attribute`, this is the definitive list of what a variant
3553
+ * may override through the capability, applied as a single patch.
3554
+ *
3555
+ * Fields, not attributes: a capability may write entity fields that have no attribute
3556
+ * definition, so entries need not resolve to one. Where an entry does resolve to an
3557
+ * attribute, `hidden` and `computed` do not disqualify it.
3558
+ *
3559
+ */
3560
+ managed_fields?: string /* ^[a-z0-9_]+$ */[];
3543
3561
  _purpose?: /**
3544
3562
  * example:
3545
3563
  * taxonomy-slug:classification-slug
@@ -4701,6 +4719,83 @@ declare namespace Components {
4701
4719
  widget_widths?: {
4702
4720
  [name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
4703
4721
  };
4722
+ /**
4723
+ * Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
4724
+ * example:
4725
+ * [
4726
+ * {
4727
+ * "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
4728
+ * "slug": "sales-overview",
4729
+ * "title": "Sales Overview",
4730
+ * "order": 10,
4731
+ * "type": "widgets",
4732
+ * "widgets": [
4733
+ * {
4734
+ * "id": "next_best_action",
4735
+ * "width": "full_width"
4736
+ * },
4737
+ * {
4738
+ * "id": "recent_communications",
4739
+ * "width": "one_third_width"
4740
+ * }
4741
+ * ]
4742
+ * }
4743
+ * ]
4744
+ */
4745
+ custom_tabs?: {
4746
+ [name: string]: any;
4747
+ /**
4748
+ * Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
4749
+ * example:
4750
+ * 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
4751
+ */
4752
+ id: string;
4753
+ /**
4754
+ * URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
4755
+ * example:
4756
+ * sales-overview
4757
+ */
4758
+ slug: string;
4759
+ /**
4760
+ * Tab label, authored by the configuring user.
4761
+ * example:
4762
+ * Sales Overview
4763
+ */
4764
+ title: string;
4765
+ /**
4766
+ * Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
4767
+ * example:
4768
+ * 10
4769
+ */
4770
+ order: number;
4771
+ /**
4772
+ * Icon name from the existing entity icon set.
4773
+ * example:
4774
+ * person
4775
+ */
4776
+ icon?: string;
4777
+ /**
4778
+ * Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
4779
+ * example:
4780
+ * widgets
4781
+ */
4782
+ type: string;
4783
+ /**
4784
+ * Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
4785
+ */
4786
+ widgets?: {
4787
+ /**
4788
+ * Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
4789
+ * example:
4790
+ * next_best_action
4791
+ */
4792
+ id: string;
4793
+ /**
4794
+ * Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
4795
+ */
4796
+ width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
4797
+ }[];
4798
+ }[];
4704
4799
  };
4705
4800
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
4706
4801
  /**
@@ -5156,6 +5251,83 @@ declare namespace Components {
5156
5251
  widget_widths?: {
5157
5252
  [name: string]: "one_third_width" | "half_width" | "two_third_width" | "full_width";
5158
5253
  };
5254
+ /**
5255
+ * Configured tabs that host widgets, shown alongside capability tabs in entity details. Interleaves with capability `EntityDetailsV2:Tab` ui_hooks on a shared `order`: the host merges both lists and sorts by `order`, with capability tabs winning ties. Unlike the header grid, a tab's `widgets` list is the entire membership — a widget's ui_hook `default_visible` is never consulted for tab placement.
5256
+ * example:
5257
+ * [
5258
+ * {
5259
+ * "id": "8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d",
5260
+ * "slug": "sales-overview",
5261
+ * "title": "Sales Overview",
5262
+ * "order": 10,
5263
+ * "type": "widgets",
5264
+ * "widgets": [
5265
+ * {
5266
+ * "id": "next_best_action",
5267
+ * "width": "full_width"
5268
+ * },
5269
+ * {
5270
+ * "id": "recent_communications",
5271
+ * "width": "one_third_width"
5272
+ * }
5273
+ * ]
5274
+ * }
5275
+ * ]
5276
+ */
5277
+ custom_tabs?: {
5278
+ [name: string]: any;
5279
+ /**
5280
+ * Generated when the tab is created and never edited afterward, so a blueprint-authored tab and a customer-authored tab can never collide and identity survives a rename.
5281
+ * example:
5282
+ * 8f14e45f-ceea-467e-a0d6-c8a4ea1c9e6d
5283
+ */
5284
+ id: string;
5285
+ /**
5286
+ * URL route segment for the tab, derived from `title`. Unique within the schema, and against capability tab ids, since both share one route-segment namespace.
5287
+ * example:
5288
+ * sales-overview
5289
+ */
5290
+ slug: string;
5291
+ /**
5292
+ * Tab label, authored by the configuring user.
5293
+ * example:
5294
+ * Sales Overview
5295
+ */
5296
+ title: string;
5297
+ /**
5298
+ * Authoritative render position; array position carries no meaning. Shares one ordering space with capability tab ui_hook `order` — at equal `order`, capability tabs sort first.
5299
+ * example:
5300
+ * 10
5301
+ */
5302
+ order: number;
5303
+ /**
5304
+ * Icon name from the existing entity icon set.
5305
+ * example:
5306
+ * person
5307
+ */
5308
+ icon?: string;
5309
+ /**
5310
+ * Discriminator for the tab's payload. Currently `widgets`, carried by the `widgets` property below; a future tab kind adds its own payload property rather than reusing this one. Deliberately not an enum, so a type introduced by a newer host still round-trips through an older one instead of failing validation.
5311
+ * example:
5312
+ * widgets
5313
+ */
5314
+ type: string;
5315
+ /**
5316
+ * Payload for `type: widgets`. Membership in this list IS the tab's widget set, in render order — there is no separate visibility map, and a widget's ui_hook `default_visible` is not consulted.
5317
+ */
5318
+ widgets?: {
5319
+ /**
5320
+ * Widget id — a capability widget's `component`, or `summary` for the synthesized summary card.
5321
+ * example:
5322
+ * next_best_action
5323
+ */
5324
+ id: string;
5325
+ /**
5326
+ * Width for this widget within the tab's grid. Falls back the same way as the header's `widget_widths` when omitted: widget's ui_hook `default_width`, then `full_width`.
5327
+ */
5328
+ width?: "one_third_width" | "half_width" | "two_third_width" | "full_width";
5329
+ }[];
5330
+ }[];
5159
5331
  };
5160
5332
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
5161
5333
  /**
@@ -13658,6 +13830,7 @@ declare namespace Paths {
13658
13830
  * _tags
13659
13831
  */
13660
13832
  export type Attribute = string;
13833
+ export type From = number;
13661
13834
  export type Input = string;
13662
13835
  export type Size = number;
13663
13836
  export type Slug = /**
@@ -13677,10 +13850,14 @@ declare namespace Paths {
13677
13850
  Parameters.Attribute;
13678
13851
  slug?: Parameters.Slug;
13679
13852
  size?: Parameters.Size;
13853
+ from?: Parameters.From;
13680
13854
  }
13681
13855
  namespace Responses {
13682
13856
  export interface $200 {
13683
13857
  /**
13858
+ * Number of distinct values matching the input. Exact (independent of `size`, capped at 1000) for
13859
+ * `_tags`; for other attributes the number of distinct values collected so far, which may grow with `size`.
13860
+ *
13684
13861
  * example:
13685
13862
  * 1
13686
13863
  */
@@ -17733,7 +17910,20 @@ interface OperationMethods {
17733
17910
  /**
17734
17911
  * autocomplete - autocomplete
17735
17912
  *
17736
- * Autocomplete entity attributes
17913
+ * Autocomplete entity attributes.
17914
+ *
17915
+ * Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
17916
+ * A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
17917
+ * configuration.
17918
+ *
17919
+ * To enumerate the label catalogue managed in the Label Builder (including labels that are not
17920
+ * assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
17921
+ * `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
17922
+ * `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
17923
+ *
17924
+ * For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
17925
+ * number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
17926
+ * 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
17737
17927
  *
17738
17928
  */
17739
17929
  'autocomplete'(
@@ -18971,7 +19161,20 @@ interface PathsDictionary {
18971
19161
  /**
18972
19162
  * autocomplete - autocomplete
18973
19163
  *
18974
- * Autocomplete entity attributes
19164
+ * Autocomplete entity attributes.
19165
+ *
19166
+ * Suggestions are derived from the values **currently stored on entities** the caller is allowed to read.
19167
+ * A value only shows up while at least one entity carries it, so this endpoint reflects usage, not
19168
+ * configuration.
19169
+ *
19170
+ * To enumerate the label catalogue managed in the Label Builder (including labels that are not
19171
+ * assigned to any entity yet, and excluding archived ones), use the Taxonomy endpoints instead:
19172
+ * `POST /v1/entity/taxonomies/classifications:search` (`taxonomiesClassificationsSearch`) or
19173
+ * `GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete` (`taxonomyAutocomplete`).
19174
+ *
19175
+ * For `attribute=_tags` the distinct values are aggregated across all matching entities, `hits` is the exact
19176
+ * number of distinct values (capped at 1000) and results are ordered by usage. For other attributes the
19177
+ * 1000 most recently updated entities are scanned and `hits` is the number of distinct values found so far.
18975
19178
  *
18976
19179
  */
18977
19180
  'get'(