@epilot/entity-client 7.2.1-rc2 → 7.3.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
@@ -20,6 +20,7 @@ declare namespace Components {
20
20
  * 01F130Q52Q6MWSNS8N2AVXV4JN
21
21
  */
22
22
  Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
23
+ export type AnonymizeQueryParam = boolean;
23
24
  export type ApplyChangesetsQueryParam = boolean;
24
25
  export type AsyncOperationQueryParam = boolean;
25
26
  export type DirectQueryParam = boolean;
@@ -77,6 +78,7 @@ declare namespace Components {
77
78
  ActivityIdPathParam?: Parameters.ActivityIdPathParam;
78
79
  }
79
80
  export interface QueryParameters {
81
+ AnonymizeQueryParam?: Parameters.AnonymizeQueryParam;
80
82
  TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
81
83
  TaxonomySlugQueryParamOptional?: Parameters.TaxonomySlugQueryParamOptional;
82
84
  AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
@@ -390,6 +392,13 @@ declare namespace Components {
390
392
  required?: boolean;
391
393
  readonly?: boolean;
392
394
  deprecated?: boolean;
395
+ /**
396
+ * Allow conditional variants of the entity to override this attribute's value.
397
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
398
+ * fixed on the base entity.
399
+ *
400
+ */
401
+ variant_overridable?: boolean;
393
402
  default_value?: any;
394
403
  /**
395
404
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -423,6 +432,16 @@ declare namespace Components {
423
432
  *
424
433
  */
425
434
  render_condition?: string;
435
+ /**
436
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
437
+ *
438
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
439
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
440
+ *
441
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
442
+ *
443
+ */
444
+ data_classification?: "public" | "pii";
426
445
  _purpose?: /**
427
446
  * example:
428
447
  * taxonomy-slug:classification-slug
@@ -608,6 +627,13 @@ declare namespace Components {
608
627
  required?: boolean;
609
628
  readonly?: boolean;
610
629
  deprecated?: boolean;
630
+ /**
631
+ * Allow conditional variants of the entity to override this attribute's value.
632
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
633
+ * fixed on the base entity.
634
+ *
635
+ */
636
+ variant_overridable?: boolean;
611
637
  default_value?: any;
612
638
  /**
613
639
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -641,6 +667,16 @@ declare namespace Components {
641
667
  *
642
668
  */
643
669
  render_condition?: string;
670
+ /**
671
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
672
+ *
673
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
674
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
675
+ *
676
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
677
+ *
678
+ */
679
+ data_classification?: "public" | "pii";
644
680
  _purpose?: /**
645
681
  * example:
646
682
  * taxonomy-slug:classification-slug
@@ -843,6 +879,13 @@ declare namespace Components {
843
879
  required?: boolean;
844
880
  readonly?: boolean;
845
881
  deprecated?: boolean;
882
+ /**
883
+ * Allow conditional variants of the entity to override this attribute's value.
884
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
885
+ * fixed on the base entity.
886
+ *
887
+ */
888
+ variant_overridable?: boolean;
846
889
  default_value?: any;
847
890
  /**
848
891
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -876,6 +919,16 @@ declare namespace Components {
876
919
  *
877
920
  */
878
921
  render_condition?: string;
922
+ /**
923
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
924
+ *
925
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
926
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
927
+ *
928
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
929
+ *
930
+ */
931
+ data_classification?: "public" | "pii";
879
932
  _purpose?: /**
880
933
  * example:
881
934
  * taxonomy-slug:classification-slug
@@ -1093,6 +1146,13 @@ declare namespace Components {
1093
1146
  required?: boolean;
1094
1147
  readonly?: boolean;
1095
1148
  deprecated?: boolean;
1149
+ /**
1150
+ * Allow conditional variants of the entity to override this attribute's value.
1151
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
1152
+ * fixed on the base entity.
1153
+ *
1154
+ */
1155
+ variant_overridable?: boolean;
1096
1156
  default_value?: any;
1097
1157
  /**
1098
1158
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -1126,6 +1186,16 @@ declare namespace Components {
1126
1186
  *
1127
1187
  */
1128
1188
  render_condition?: string;
1189
+ /**
1190
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
1191
+ *
1192
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
1193
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
1194
+ *
1195
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
1196
+ *
1197
+ */
1198
+ data_classification?: "public" | "pii";
1129
1199
  _purpose?: /**
1130
1200
  * example:
1131
1201
  * taxonomy-slug:classification-slug
@@ -1256,6 +1326,31 @@ declare namespace Components {
1256
1326
  FuzzyConfig;
1257
1327
  };
1258
1328
  }
1329
+ export interface BaseConditionDefinition {
1330
+ /**
1331
+ * Stable identity of the condition, generated by the client when the condition is
1332
+ * created. It is what makes a rename distinguishable from a remove + add, so it must
1333
+ * be round-tripped unchanged for the lifetime of the condition.
1334
+ *
1335
+ * example:
1336
+ * d5839b94-ba20-4225-a78e-76951d352bd6
1337
+ */
1338
+ id: string; // uuid
1339
+ /**
1340
+ * The key variant values are stored under. Unique within the schema and immutable
1341
+ * once the condition has been saved.
1342
+ *
1343
+ * example:
1344
+ * delivery_area
1345
+ */
1346
+ name: string; // ^[a-z0-9_]+$
1347
+ /**
1348
+ * Display label. Always editable.
1349
+ * example:
1350
+ * Delivery Area
1351
+ */
1352
+ label: string;
1353
+ }
1259
1354
  /**
1260
1355
  * example:
1261
1356
  * {
@@ -1383,6 +1478,13 @@ declare namespace Components {
1383
1478
  required?: boolean;
1384
1479
  readonly?: boolean;
1385
1480
  deprecated?: boolean;
1481
+ /**
1482
+ * Allow conditional variants of the entity to override this attribute's value.
1483
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
1484
+ * fixed on the base entity.
1485
+ *
1486
+ */
1487
+ variant_overridable?: boolean;
1386
1488
  default_value?: any;
1387
1489
  /**
1388
1490
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -1416,6 +1518,16 @@ declare namespace Components {
1416
1518
  *
1417
1519
  */
1418
1520
  render_condition?: string;
1521
+ /**
1522
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
1523
+ *
1524
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
1525
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
1526
+ *
1527
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
1528
+ *
1529
+ */
1530
+ data_classification?: "public" | "pii";
1419
1531
  _purpose?: /**
1420
1532
  * example:
1421
1533
  * taxonomy-slug:classification-slug
@@ -1678,6 +1790,13 @@ declare namespace Components {
1678
1790
  required?: boolean;
1679
1791
  readonly?: boolean;
1680
1792
  deprecated?: boolean;
1793
+ /**
1794
+ * Allow conditional variants of the entity to override this attribute's value.
1795
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
1796
+ * fixed on the base entity.
1797
+ *
1798
+ */
1799
+ variant_overridable?: boolean;
1681
1800
  default_value?: any;
1682
1801
  /**
1683
1802
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -1711,6 +1830,16 @@ declare namespace Components {
1711
1830
  *
1712
1831
  */
1713
1832
  render_condition?: string;
1833
+ /**
1834
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
1835
+ *
1836
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
1837
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
1838
+ *
1839
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
1840
+ *
1841
+ */
1842
+ data_classification?: "public" | "pii";
1714
1843
  _purpose?: /**
1715
1844
  * example:
1716
1845
  * taxonomy-slug:classification-slug
@@ -1861,6 +1990,19 @@ declare namespace Components {
1861
1990
  */
1862
1991
  currency_field?: string;
1863
1992
  }
1993
+ /**
1994
+ * One dimension that conditional variants of an entity type are keyed by. `type`
1995
+ * discriminates the variants: only a `select` condition carries `values`, and only a
1996
+ * `location` condition carries `format`.
1997
+ *
1998
+ */
1999
+ export type ConditionDefinition = /**
2000
+ * One dimension that conditional variants of an entity type are keyed by. `type`
2001
+ * discriminates the variants: only a `select` condition carries `values`, and only a
2002
+ * `location` condition carries `format`.
2003
+ *
2004
+ */
2005
+ /* A condition whose value is a plain scalar, with no further configuration. */ ScalarConditionDefinition | /* A condition whose value is one of a fixed set of options. */ SelectConditionDefinition | /* A condition whose value identifies a place. */ LocationConditionDefinition;
1864
2006
  /**
1865
2007
  * Consent Management
1866
2008
  */
@@ -1889,6 +2031,13 @@ declare namespace Components {
1889
2031
  required?: boolean;
1890
2032
  readonly?: boolean;
1891
2033
  deprecated?: boolean;
2034
+ /**
2035
+ * Allow conditional variants of the entity to override this attribute's value.
2036
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
2037
+ * fixed on the base entity.
2038
+ *
2039
+ */
2040
+ variant_overridable?: boolean;
1892
2041
  default_value?: any;
1893
2042
  /**
1894
2043
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -1922,6 +2071,16 @@ declare namespace Components {
1922
2071
  *
1923
2072
  */
1924
2073
  render_condition?: string;
2074
+ /**
2075
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
2076
+ *
2077
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
2078
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
2079
+ *
2080
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
2081
+ *
2082
+ */
2083
+ data_classification?: "public" | "pii";
1925
2084
  _purpose?: /**
1926
2085
  * example:
1927
2086
  * taxonomy-slug:classification-slug
@@ -2083,6 +2242,13 @@ declare namespace Components {
2083
2242
  required?: boolean;
2084
2243
  readonly?: boolean;
2085
2244
  deprecated?: boolean;
2245
+ /**
2246
+ * Allow conditional variants of the entity to override this attribute's value.
2247
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
2248
+ * fixed on the base entity.
2249
+ *
2250
+ */
2251
+ variant_overridable?: boolean;
2086
2252
  default_value?: any;
2087
2253
  /**
2088
2254
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -2116,6 +2282,16 @@ declare namespace Components {
2116
2282
  *
2117
2283
  */
2118
2284
  render_condition?: string;
2285
+ /**
2286
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
2287
+ *
2288
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
2289
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
2290
+ *
2291
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
2292
+ *
2293
+ */
2294
+ data_classification?: "public" | "pii";
2119
2295
  _purpose?: /**
2120
2296
  * example:
2121
2297
  * taxonomy-slug:classification-slug
@@ -2275,6 +2451,13 @@ declare namespace Components {
2275
2451
  required?: boolean;
2276
2452
  readonly?: boolean;
2277
2453
  deprecated?: boolean;
2454
+ /**
2455
+ * Allow conditional variants of the entity to override this attribute's value.
2456
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
2457
+ * fixed on the base entity.
2458
+ *
2459
+ */
2460
+ variant_overridable?: boolean;
2278
2461
  default_value?: any;
2279
2462
  /**
2280
2463
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -2308,6 +2491,16 @@ declare namespace Components {
2308
2491
  *
2309
2492
  */
2310
2493
  render_condition?: string;
2494
+ /**
2495
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
2496
+ *
2497
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
2498
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
2499
+ *
2500
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
2501
+ *
2502
+ */
2503
+ data_classification?: "public" | "pii";
2311
2504
  _purpose?: /**
2312
2505
  * example:
2313
2506
  * taxonomy-slug:classification-slug
@@ -2477,6 +2670,13 @@ declare namespace Components {
2477
2670
  required?: boolean;
2478
2671
  readonly?: boolean;
2479
2672
  deprecated?: boolean;
2673
+ /**
2674
+ * Allow conditional variants of the entity to override this attribute's value.
2675
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
2676
+ * fixed on the base entity.
2677
+ *
2678
+ */
2679
+ variant_overridable?: boolean;
2480
2680
  default_value?: any;
2481
2681
  /**
2482
2682
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -2510,6 +2710,16 @@ declare namespace Components {
2510
2710
  *
2511
2711
  */
2512
2712
  render_condition?: string;
2713
+ /**
2714
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
2715
+ *
2716
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
2717
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
2718
+ *
2719
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
2720
+ *
2721
+ */
2722
+ data_classification?: "public" | "pii";
2513
2723
  _purpose?: /**
2514
2724
  * example:
2515
2725
  * taxonomy-slug:classification-slug
@@ -2750,6 +2960,13 @@ declare namespace Components {
2750
2960
  required?: boolean;
2751
2961
  readonly?: boolean;
2752
2962
  deprecated?: boolean;
2963
+ /**
2964
+ * Allow conditional variants of the entity to override this attribute's value.
2965
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
2966
+ * fixed on the base entity.
2967
+ *
2968
+ */
2969
+ variant_overridable?: boolean;
2753
2970
  default_value?: any;
2754
2971
  /**
2755
2972
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -2783,6 +3000,16 @@ declare namespace Components {
2783
3000
  *
2784
3001
  */
2785
3002
  render_condition?: string;
3003
+ /**
3004
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
3005
+ *
3006
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
3007
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
3008
+ *
3009
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
3010
+ *
3011
+ */
3012
+ data_classification?: "public" | "pii";
2786
3013
  _purpose?: /**
2787
3014
  * example:
2788
3015
  * taxonomy-slug:classification-slug
@@ -3593,6 +3820,13 @@ declare namespace Components {
3593
3820
  * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
3594
3821
  */
3595
3822
  hydrate?: boolean;
3823
+ /**
3824
+ * When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
3825
+ * addresses are generalized and well-known free-text fields are redacted.
3826
+ * Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
3827
+ *
3828
+ */
3829
+ anonymize?: boolean;
3596
3830
  fields?: /**
3597
3831
  * List of entity fields to include or exclude in the response
3598
3832
  *
@@ -4102,6 +4336,7 @@ declare namespace Components {
4102
4336
  } | null;
4103
4337
  };
4104
4338
  };
4339
+ source_context?: /* Billing and audit source context for the operation event. */ EntityOperationSourceContext;
4105
4340
  /**
4106
4341
  * Internal property for workflow origin tracking and infinite loop prevention.
4107
4342
  * Populated when an entity update originates from a workflow execution.
@@ -4118,6 +4353,34 @@ declare namespace Components {
4118
4353
  */
4119
4354
  flow_template_id?: string;
4120
4355
  };
4356
+ /**
4357
+ * Ordered automation flow ids that caused this change; used to break multi-automation trigger loops.
4358
+ */
4359
+ _automation_chain?: string[];
4360
+ }
4361
+ /**
4362
+ * Billing and audit source context for the operation event.
4363
+ */
4364
+ export interface EntityOperationSourceContext {
4365
+ /**
4366
+ * Normalized source bucket for the operation.
4367
+ */
4368
+ source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown";
4369
+ /**
4370
+ * Original free-form source label from the caller or changeset, when available.
4371
+ */
4372
+ source_label?: string;
4373
+ /**
4374
+ * Optional upstream system label, for example an ERP system name.
4375
+ */
4376
+ source_system?: string;
4377
+ /**
4378
+ * Optional upstream change reference.
4379
+ */
4380
+ source_reference?: string;
4381
+ actor_type?: "user" | "portal_user" | "api_client" | "automation" | "system";
4382
+ actor_id?: string;
4383
+ effective_at?: string; // date-time
4121
4384
  }
4122
4385
  /**
4123
4386
  * The user / organization owning this entity.
@@ -4271,6 +4534,27 @@ declare namespace Components {
4271
4534
  */
4272
4535
  show_sharing_button?: boolean;
4273
4536
  };
4537
+ /**
4538
+ * Widget-grid layout for the entity-details page (builder-authored); columns/cells drive the grid geometry.
4539
+ */
4540
+ grid_layout?: {
4541
+ /**
4542
+ * Identifier of the chosen grid-layout preset.
4543
+ */
4544
+ id?: string;
4545
+ /**
4546
+ * Number of columns in the widget grid.
4547
+ */
4548
+ columns?: number;
4549
+ /**
4550
+ * Per-cell column span, positionally paired with the widgets in order.
4551
+ */
4552
+ cells?: number[];
4553
+ };
4554
+ /**
4555
+ * Ordered list of widget ids controlling the entity-details widget-grid order. Each id is a capability widget's `component` (or `summary` for the synthesized summary card); widgets absent from the list keep their natural order at the end.
4556
+ */
4557
+ widget_order?: string[];
4274
4558
  };
4275
4559
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
4276
4560
  /**
@@ -4382,6 +4666,20 @@ declare namespace Components {
4382
4666
  */
4383
4667
  SearchMappings;
4384
4668
  group_headlines?: GroupHeadline[];
4669
+ /**
4670
+ * Dimensions that conditional variants of this entity type are keyed by.
4671
+ *
4672
+ * Absent or `null` means entities of this type are not conditional. Attributes whose
4673
+ * values a variant may override are marked with `variant_overridable`.
4674
+ *
4675
+ */
4676
+ conditions?: /**
4677
+ * One dimension that conditional variants of an entity type are keyed by. `type`
4678
+ * discriminates the variants: only a `select` condition carries `values`, and only a
4679
+ * `location` condition carries `format`.
4680
+ *
4681
+ */
4682
+ ConditionDefinition[] | null;
4385
4683
  }
4386
4684
  export interface EntitySchemaGroup {
4387
4685
  /**
@@ -4667,6 +4965,27 @@ declare namespace Components {
4667
4965
  */
4668
4966
  show_sharing_button?: boolean;
4669
4967
  };
4968
+ /**
4969
+ * Widget-grid layout for the entity-details page (builder-authored); columns/cells drive the grid geometry.
4970
+ */
4971
+ grid_layout?: {
4972
+ /**
4973
+ * Identifier of the chosen grid-layout preset.
4974
+ */
4975
+ id?: string;
4976
+ /**
4977
+ * Number of columns in the widget grid.
4978
+ */
4979
+ columns?: number;
4980
+ /**
4981
+ * Per-cell column span, positionally paired with the widgets in order.
4982
+ */
4983
+ cells?: number[];
4984
+ };
4985
+ /**
4986
+ * Ordered list of widget ids controlling the entity-details widget-grid order. Each id is a capability widget's `component` (or `summary` for the synthesized summary card); widgets absent from the list keep their natural order at the end.
4987
+ */
4988
+ widget_order?: string[];
4670
4989
  };
4671
4990
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
4672
4991
  /**
@@ -4778,6 +5097,20 @@ declare namespace Components {
4778
5097
  */
4779
5098
  SearchMappings;
4780
5099
  group_headlines?: GroupHeadline[];
5100
+ /**
5101
+ * Dimensions that conditional variants of this entity type are keyed by.
5102
+ *
5103
+ * Absent or `null` means entities of this type are not conditional. Attributes whose
5104
+ * values a variant may override are marked with `variant_overridable`.
5105
+ *
5106
+ */
5107
+ conditions?: /**
5108
+ * One dimension that conditional variants of an entity type are keyed by. `type`
5109
+ * discriminates the variants: only a `select` condition carries `values`, and only a
5110
+ * `location` condition carries `format`.
5111
+ *
5112
+ */
5113
+ ConditionDefinition[] | null;
4781
5114
  }
4782
5115
  /**
4783
5116
  * Whether to include deleted entities in the search results
@@ -4808,6 +5141,13 @@ declare namespace Components {
4808
5141
  * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
4809
5142
  */
4810
5143
  hydrate?: boolean;
5144
+ /**
5145
+ * When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
5146
+ * addresses are generalized and well-known free-text fields are redacted.
5147
+ * Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
5148
+ *
5149
+ */
5150
+ anonymize?: boolean;
4811
5151
  fields?: /**
4812
5152
  * List of entity fields to include or exclude in the response
4813
5153
  *
@@ -4908,6 +5248,13 @@ declare namespace Components {
4908
5248
  * When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
4909
5249
  */
4910
5250
  hydrate?: boolean;
5251
+ /**
5252
+ * When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
5253
+ * addresses are generalized and well-known free-text fields are redacted.
5254
+ * Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
5255
+ *
5256
+ */
5257
+ anonymize?: boolean;
4911
5258
  fields?: /**
4912
5259
  * List of entity fields to include or exclude in the response
4913
5260
  *
@@ -5308,6 +5655,13 @@ declare namespace Components {
5308
5655
  required?: boolean;
5309
5656
  readonly?: boolean;
5310
5657
  deprecated?: boolean;
5658
+ /**
5659
+ * Allow conditional variants of the entity to override this attribute's value.
5660
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
5661
+ * fixed on the base entity.
5662
+ *
5663
+ */
5664
+ variant_overridable?: boolean;
5311
5665
  default_value?: any;
5312
5666
  /**
5313
5667
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -5341,6 +5695,16 @@ declare namespace Components {
5341
5695
  *
5342
5696
  */
5343
5697
  render_condition?: string;
5698
+ /**
5699
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
5700
+ *
5701
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
5702
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
5703
+ *
5704
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
5705
+ *
5706
+ */
5707
+ data_classification?: "public" | "pii";
5344
5708
  _purpose?: /**
5345
5709
  * example:
5346
5710
  * taxonomy-slug:classification-slug
@@ -6185,6 +6549,13 @@ declare namespace Components {
6185
6549
  required?: boolean;
6186
6550
  readonly?: boolean;
6187
6551
  deprecated?: boolean;
6552
+ /**
6553
+ * Allow conditional variants of the entity to override this attribute's value.
6554
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
6555
+ * fixed on the base entity.
6556
+ *
6557
+ */
6558
+ variant_overridable?: boolean;
6188
6559
  default_value?: any;
6189
6560
  /**
6190
6561
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -6218,6 +6589,16 @@ declare namespace Components {
6218
6589
  *
6219
6590
  */
6220
6591
  render_condition?: string;
6592
+ /**
6593
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
6594
+ *
6595
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
6596
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
6597
+ *
6598
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
6599
+ *
6600
+ */
6601
+ data_classification?: "public" | "pii";
6221
6602
  _purpose?: /**
6222
6603
  * example:
6223
6604
  * taxonomy-slug:classification-slug
@@ -6377,6 +6758,13 @@ declare namespace Components {
6377
6758
  required?: boolean;
6378
6759
  readonly?: boolean;
6379
6760
  deprecated?: boolean;
6761
+ /**
6762
+ * Allow conditional variants of the entity to override this attribute's value.
6763
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
6764
+ * fixed on the base entity.
6765
+ *
6766
+ */
6767
+ variant_overridable?: boolean;
6380
6768
  default_value?: any;
6381
6769
  /**
6382
6770
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -6410,6 +6798,16 @@ declare namespace Components {
6410
6798
  *
6411
6799
  */
6412
6800
  render_condition?: string;
6801
+ /**
6802
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
6803
+ *
6804
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
6805
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
6806
+ *
6807
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
6808
+ *
6809
+ */
6810
+ data_classification?: "public" | "pii";
6413
6811
  _purpose?: /**
6414
6812
  * example:
6415
6813
  * taxonomy-slug:classification-slug
@@ -6569,6 +6967,13 @@ declare namespace Components {
6569
6967
  required?: boolean;
6570
6968
  readonly?: boolean;
6571
6969
  deprecated?: boolean;
6970
+ /**
6971
+ * Allow conditional variants of the entity to override this attribute's value.
6972
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
6973
+ * fixed on the base entity.
6974
+ *
6975
+ */
6976
+ variant_overridable?: boolean;
6572
6977
  default_value?: any;
6573
6978
  /**
6574
6979
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -6602,6 +7007,16 @@ declare namespace Components {
6602
7007
  *
6603
7008
  */
6604
7009
  render_condition?: string;
7010
+ /**
7011
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
7012
+ *
7013
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
7014
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
7015
+ *
7016
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
7017
+ *
7018
+ */
7019
+ data_classification?: "public" | "pii";
6605
7020
  _purpose?: /**
6606
7021
  * example:
6607
7022
  * taxonomy-slug:classification-slug
@@ -6769,6 +7184,13 @@ declare namespace Components {
6769
7184
  required?: boolean;
6770
7185
  readonly?: boolean;
6771
7186
  deprecated?: boolean;
7187
+ /**
7188
+ * Allow conditional variants of the entity to override this attribute's value.
7189
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
7190
+ * fixed on the base entity.
7191
+ *
7192
+ */
7193
+ variant_overridable?: boolean;
6772
7194
  default_value?: any;
6773
7195
  /**
6774
7196
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -6802,6 +7224,16 @@ declare namespace Components {
6802
7224
  *
6803
7225
  */
6804
7226
  render_condition?: string;
7227
+ /**
7228
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
7229
+ *
7230
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
7231
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
7232
+ *
7233
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
7234
+ *
7235
+ */
7236
+ data_classification?: "public" | "pii";
6805
7237
  _purpose?: /**
6806
7238
  * example:
6807
7239
  * taxonomy-slug:classification-slug
@@ -6941,6 +7373,42 @@ declare namespace Components {
6941
7373
  hits?: number;
6942
7374
  results?: /* A saved entity view */ SavedViewItem[];
6943
7375
  }
7376
+ /**
7377
+ * A condition whose value identifies a place.
7378
+ */
7379
+ export interface LocationConditionDefinition {
7380
+ /**
7381
+ * Stable identity of the condition, generated by the client when the condition is
7382
+ * created. It is what makes a rename distinguishable from a remove + add, so it must
7383
+ * be round-tripped unchanged for the lifetime of the condition.
7384
+ *
7385
+ * example:
7386
+ * d5839b94-ba20-4225-a78e-76951d352bd6
7387
+ */
7388
+ id: string; // uuid
7389
+ /**
7390
+ * The key variant values are stored under. Unique within the schema and immutable
7391
+ * once the condition has been saved.
7392
+ *
7393
+ * example:
7394
+ * delivery_area
7395
+ */
7396
+ name: string; // ^[a-z0-9_]+$
7397
+ /**
7398
+ * Display label. Always editable.
7399
+ * example:
7400
+ * Delivery Area
7401
+ */
7402
+ label: string;
7403
+ /**
7404
+ * Immutable once the condition has been saved.
7405
+ */
7406
+ type: "location";
7407
+ /**
7408
+ * The shape of the location value. Immutable once the condition has been saved.
7409
+ */
7410
+ format?: "zipcode" | "zipcode_town";
7411
+ }
6944
7412
  /**
6945
7413
  * Strategy for auto-clearing a changeset on an `edit_mode: external` attribute
6946
7414
  * when a direct write (`?direct=true`) arrives — typically an ERP inbound sync.
@@ -6980,6 +7448,13 @@ declare namespace Components {
6980
7448
  required?: boolean;
6981
7449
  readonly?: boolean;
6982
7450
  deprecated?: boolean;
7451
+ /**
7452
+ * Allow conditional variants of the entity to override this attribute's value.
7453
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
7454
+ * fixed on the base entity.
7455
+ *
7456
+ */
7457
+ variant_overridable?: boolean;
6983
7458
  default_value?: any;
6984
7459
  /**
6985
7460
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -7013,6 +7488,16 @@ declare namespace Components {
7013
7488
  *
7014
7489
  */
7015
7490
  render_condition?: string;
7491
+ /**
7492
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
7493
+ *
7494
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
7495
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
7496
+ *
7497
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
7498
+ *
7499
+ */
7500
+ data_classification?: "public" | "pii";
7016
7501
  _purpose?: /**
7017
7502
  * example:
7018
7503
  * taxonomy-slug:classification-slug
@@ -7259,6 +7744,13 @@ declare namespace Components {
7259
7744
  required?: boolean;
7260
7745
  readonly?: boolean;
7261
7746
  deprecated?: boolean;
7747
+ /**
7748
+ * Allow conditional variants of the entity to override this attribute's value.
7749
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
7750
+ * fixed on the base entity.
7751
+ *
7752
+ */
7753
+ variant_overridable?: boolean;
7262
7754
  default_value?: any;
7263
7755
  /**
7264
7756
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -7292,6 +7784,16 @@ declare namespace Components {
7292
7784
  *
7293
7785
  */
7294
7786
  render_condition?: string;
7787
+ /**
7788
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
7789
+ *
7790
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
7791
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
7792
+ *
7793
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
7794
+ *
7795
+ */
7796
+ data_classification?: "public" | "pii";
7295
7797
  _purpose?: /**
7296
7798
  * example:
7297
7799
  * taxonomy-slug:classification-slug
@@ -7562,6 +8064,13 @@ declare namespace Components {
7562
8064
  required?: boolean;
7563
8065
  readonly?: boolean;
7564
8066
  deprecated?: boolean;
8067
+ /**
8068
+ * Allow conditional variants of the entity to override this attribute's value.
8069
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
8070
+ * fixed on the base entity.
8071
+ *
8072
+ */
8073
+ variant_overridable?: boolean;
7565
8074
  default_value?: any;
7566
8075
  /**
7567
8076
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -7595,6 +8104,16 @@ declare namespace Components {
7595
8104
  *
7596
8105
  */
7597
8106
  render_condition?: string;
8107
+ /**
8108
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
8109
+ *
8110
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
8111
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
8112
+ *
8113
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
8114
+ *
8115
+ */
8116
+ data_classification?: "public" | "pii";
7598
8117
  _purpose?: /**
7599
8118
  * example:
7600
8119
  * taxonomy-slug:classification-slug
@@ -7763,6 +8282,13 @@ declare namespace Components {
7763
8282
  required?: boolean;
7764
8283
  readonly?: boolean;
7765
8284
  deprecated?: boolean;
8285
+ /**
8286
+ * Allow conditional variants of the entity to override this attribute's value.
8287
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
8288
+ * fixed on the base entity.
8289
+ *
8290
+ */
8291
+ variant_overridable?: boolean;
7766
8292
  default_value?: any;
7767
8293
  /**
7768
8294
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -7796,6 +8322,16 @@ declare namespace Components {
7796
8322
  *
7797
8323
  */
7798
8324
  render_condition?: string;
8325
+ /**
8326
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
8327
+ *
8328
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
8329
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
8330
+ *
8331
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
8332
+ *
8333
+ */
8334
+ data_classification?: "public" | "pii";
7799
8335
  _purpose?: /**
7800
8336
  * example:
7801
8337
  * taxonomy-slug:classification-slug
@@ -7955,6 +8491,13 @@ declare namespace Components {
7955
8491
  required?: boolean;
7956
8492
  readonly?: boolean;
7957
8493
  deprecated?: boolean;
8494
+ /**
8495
+ * Allow conditional variants of the entity to override this attribute's value.
8496
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
8497
+ * fixed on the base entity.
8498
+ *
8499
+ */
8500
+ variant_overridable?: boolean;
7958
8501
  default_value?: any;
7959
8502
  /**
7960
8503
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -7988,6 +8531,16 @@ declare namespace Components {
7988
8531
  *
7989
8532
  */
7990
8533
  render_condition?: string;
8534
+ /**
8535
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
8536
+ *
8537
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
8538
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
8539
+ *
8540
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
8541
+ *
8542
+ */
8543
+ data_classification?: "public" | "pii";
7991
8544
  _purpose?: /**
7992
8545
  * example:
7993
8546
  * taxonomy-slug:classification-slug
@@ -8147,6 +8700,13 @@ declare namespace Components {
8147
8700
  required?: boolean;
8148
8701
  readonly?: boolean;
8149
8702
  deprecated?: boolean;
8703
+ /**
8704
+ * Allow conditional variants of the entity to override this attribute's value.
8705
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
8706
+ * fixed on the base entity.
8707
+ *
8708
+ */
8709
+ variant_overridable?: boolean;
8150
8710
  default_value?: any;
8151
8711
  /**
8152
8712
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -8180,6 +8740,16 @@ declare namespace Components {
8180
8740
  *
8181
8741
  */
8182
8742
  render_condition?: string;
8743
+ /**
8744
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
8745
+ *
8746
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
8747
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
8748
+ *
8749
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
8750
+ *
8751
+ */
8752
+ data_classification?: "public" | "pii";
8183
8753
  _purpose?: /**
8184
8754
  * example:
8185
8755
  * taxonomy-slug:classification-slug
@@ -8339,6 +8909,13 @@ declare namespace Components {
8339
8909
  required?: boolean;
8340
8910
  readonly?: boolean;
8341
8911
  deprecated?: boolean;
8912
+ /**
8913
+ * Allow conditional variants of the entity to override this attribute's value.
8914
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
8915
+ * fixed on the base entity.
8916
+ *
8917
+ */
8918
+ variant_overridable?: boolean;
8342
8919
  default_value?: any;
8343
8920
  /**
8344
8921
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -8372,6 +8949,16 @@ declare namespace Components {
8372
8949
  *
8373
8950
  */
8374
8951
  render_condition?: string;
8952
+ /**
8953
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
8954
+ *
8955
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
8956
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
8957
+ *
8958
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
8959
+ *
8960
+ */
8961
+ data_classification?: "public" | "pii";
8375
8962
  _purpose?: /**
8376
8963
  * example:
8377
8964
  * taxonomy-slug:classification-slug
@@ -8531,6 +9118,13 @@ declare namespace Components {
8531
9118
  required?: boolean;
8532
9119
  readonly?: boolean;
8533
9120
  deprecated?: boolean;
9121
+ /**
9122
+ * Allow conditional variants of the entity to override this attribute's value.
9123
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
9124
+ * fixed on the base entity.
9125
+ *
9126
+ */
9127
+ variant_overridable?: boolean;
8534
9128
  default_value?: any;
8535
9129
  /**
8536
9130
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -8564,6 +9158,16 @@ declare namespace Components {
8564
9158
  *
8565
9159
  */
8566
9160
  render_condition?: string;
9161
+ /**
9162
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
9163
+ *
9164
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
9165
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
9166
+ *
9167
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
9168
+ *
9169
+ */
9170
+ data_classification?: "public" | "pii";
8567
9171
  _purpose?: /**
8568
9172
  * example:
8569
9173
  * taxonomy-slug:classification-slug
@@ -8723,6 +9327,13 @@ declare namespace Components {
8723
9327
  required?: boolean;
8724
9328
  readonly?: boolean;
8725
9329
  deprecated?: boolean;
9330
+ /**
9331
+ * Allow conditional variants of the entity to override this attribute's value.
9332
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
9333
+ * fixed on the base entity.
9334
+ *
9335
+ */
9336
+ variant_overridable?: boolean;
8726
9337
  default_value?: any;
8727
9338
  /**
8728
9339
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -8756,6 +9367,16 @@ declare namespace Components {
8756
9367
  *
8757
9368
  */
8758
9369
  render_condition?: string;
9370
+ /**
9371
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
9372
+ *
9373
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
9374
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
9375
+ *
9376
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
9377
+ *
9378
+ */
9379
+ data_classification?: "public" | "pii";
8759
9380
  _purpose?: /**
8760
9381
  * example:
8761
9382
  * taxonomy-slug:classification-slug
@@ -8915,6 +9536,13 @@ declare namespace Components {
8915
9536
  required?: boolean;
8916
9537
  readonly?: boolean;
8917
9538
  deprecated?: boolean;
9539
+ /**
9540
+ * Allow conditional variants of the entity to override this attribute's value.
9541
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
9542
+ * fixed on the base entity.
9543
+ *
9544
+ */
9545
+ variant_overridable?: boolean;
8918
9546
  default_value?: any;
8919
9547
  /**
8920
9548
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -8948,6 +9576,16 @@ declare namespace Components {
8948
9576
  *
8949
9577
  */
8950
9578
  render_condition?: string;
9579
+ /**
9580
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
9581
+ *
9582
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
9583
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
9584
+ *
9585
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
9586
+ *
9587
+ */
9588
+ data_classification?: "public" | "pii";
8951
9589
  _purpose?: /**
8952
9590
  * example:
8953
9591
  * taxonomy-slug:classification-slug
@@ -9107,6 +9745,13 @@ declare namespace Components {
9107
9745
  required?: boolean;
9108
9746
  readonly?: boolean;
9109
9747
  deprecated?: boolean;
9748
+ /**
9749
+ * Allow conditional variants of the entity to override this attribute's value.
9750
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
9751
+ * fixed on the base entity.
9752
+ *
9753
+ */
9754
+ variant_overridable?: boolean;
9110
9755
  default_value?: any;
9111
9756
  /**
9112
9757
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -9140,6 +9785,16 @@ declare namespace Components {
9140
9785
  *
9141
9786
  */
9142
9787
  render_condition?: string;
9788
+ /**
9789
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
9790
+ *
9791
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
9792
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
9793
+ *
9794
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
9795
+ *
9796
+ */
9797
+ data_classification?: "public" | "pii";
9143
9798
  _purpose?: /**
9144
9799
  * example:
9145
9800
  * taxonomy-slug:classification-slug
@@ -9299,6 +9954,13 @@ declare namespace Components {
9299
9954
  required?: boolean;
9300
9955
  readonly?: boolean;
9301
9956
  deprecated?: boolean;
9957
+ /**
9958
+ * Allow conditional variants of the entity to override this attribute's value.
9959
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
9960
+ * fixed on the base entity.
9961
+ *
9962
+ */
9963
+ variant_overridable?: boolean;
9302
9964
  default_value?: any;
9303
9965
  /**
9304
9966
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -9332,6 +9994,16 @@ declare namespace Components {
9332
9994
  *
9333
9995
  */
9334
9996
  render_condition?: string;
9997
+ /**
9998
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
9999
+ *
10000
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
10001
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
10002
+ *
10003
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
10004
+ *
10005
+ */
10006
+ data_classification?: "public" | "pii";
9335
10007
  _purpose?: /**
9336
10008
  * example:
9337
10009
  * taxonomy-slug:classification-slug
@@ -9506,6 +10178,13 @@ declare namespace Components {
9506
10178
  required?: boolean;
9507
10179
  readonly?: boolean;
9508
10180
  deprecated?: boolean;
10181
+ /**
10182
+ * Allow conditional variants of the entity to override this attribute's value.
10183
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
10184
+ * fixed on the base entity.
10185
+ *
10186
+ */
10187
+ variant_overridable?: boolean;
9509
10188
  default_value?: any;
9510
10189
  /**
9511
10190
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -9539,6 +10218,16 @@ declare namespace Components {
9539
10218
  *
9540
10219
  */
9541
10220
  render_condition?: string;
10221
+ /**
10222
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
10223
+ *
10224
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
10225
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
10226
+ *
10227
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
10228
+ *
10229
+ */
10230
+ data_classification?: "public" | "pii";
9542
10231
  _purpose?: /**
9543
10232
  * example:
9544
10233
  * taxonomy-slug:classification-slug
@@ -9924,6 +10613,13 @@ declare namespace Components {
9924
10613
  required?: boolean;
9925
10614
  readonly?: boolean;
9926
10615
  deprecated?: boolean;
10616
+ /**
10617
+ * Allow conditional variants of the entity to override this attribute's value.
10618
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
10619
+ * fixed on the base entity.
10620
+ *
10621
+ */
10622
+ variant_overridable?: boolean;
9927
10623
  default_value?: any;
9928
10624
  /**
9929
10625
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -9957,6 +10653,16 @@ declare namespace Components {
9957
10653
  *
9958
10654
  */
9959
10655
  render_condition?: string;
10656
+ /**
10657
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
10658
+ *
10659
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
10660
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
10661
+ *
10662
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
10663
+ *
10664
+ */
10665
+ data_classification?: "public" | "pii";
9960
10666
  _purpose?: /**
9961
10667
  * example:
9962
10668
  * taxonomy-slug:classification-slug
@@ -10128,6 +10834,12 @@ declare namespace Components {
10128
10834
  * 10598
10129
10835
  */
10130
10836
  user_id?: string;
10837
+ /**
10838
+ * The organization ID of the user who created the view. Used for partner access control.
10839
+ * example:
10840
+ * 739224
10841
+ */
10842
+ org_id?: string;
10131
10843
  } | {
10132
10844
  [name: string]: any;
10133
10845
  source?: "SYSTEM" | "BLUEPRINT";
@@ -10205,6 +10917,12 @@ declare namespace Components {
10205
10917
  * 10598
10206
10918
  */
10207
10919
  user_id?: string;
10920
+ /**
10921
+ * The organization ID of the user who created the view. Used for partner access control.
10922
+ * example:
10923
+ * 739224
10924
+ */
10925
+ org_id?: string;
10208
10926
  } | {
10209
10927
  [name: string]: any;
10210
10928
  source?: "SYSTEM" | "BLUEPRINT";
@@ -10275,6 +10993,12 @@ declare namespace Components {
10275
10993
  * 10598
10276
10994
  */
10277
10995
  user_id?: string;
10996
+ /**
10997
+ * The organization ID of the user who created the view. Used for partner access control.
10998
+ * example:
10999
+ * 739224
11000
+ */
11001
+ org_id?: string;
10278
11002
  } | {
10279
11003
  [name: string]: any;
10280
11004
  source?: "SYSTEM" | "BLUEPRINT";
@@ -10304,6 +11028,38 @@ declare namespace Components {
10304
11028
  */
10305
11029
  shared_with?: string[];
10306
11030
  }
11031
+ /**
11032
+ * A condition whose value is a plain scalar, with no further configuration.
11033
+ */
11034
+ export interface ScalarConditionDefinition {
11035
+ /**
11036
+ * Stable identity of the condition, generated by the client when the condition is
11037
+ * created. It is what makes a rename distinguishable from a remove + add, so it must
11038
+ * be round-tripped unchanged for the lifetime of the condition.
11039
+ *
11040
+ * example:
11041
+ * d5839b94-ba20-4225-a78e-76951d352bd6
11042
+ */
11043
+ id: string; // uuid
11044
+ /**
11045
+ * The key variant values are stored under. Unique within the schema and immutable
11046
+ * once the condition has been saved.
11047
+ *
11048
+ * example:
11049
+ * delivery_area
11050
+ */
11051
+ name: string; // ^[a-z0-9_]+$
11052
+ /**
11053
+ * Display label. Always editable.
11054
+ * example:
11055
+ * Delivery Area
11056
+ */
11057
+ label: string;
11058
+ /**
11059
+ * Immutable once the condition has been saved.
11060
+ */
11061
+ type: "string" | "number" | "date" | "daterange" | "boolean";
11062
+ }
10307
11063
  /**
10308
11064
  * Generated uuid for schema
10309
11065
  */
@@ -10520,6 +11276,13 @@ declare namespace Components {
10520
11276
  required?: boolean;
10521
11277
  readonly?: boolean;
10522
11278
  deprecated?: boolean;
11279
+ /**
11280
+ * Allow conditional variants of the entity to override this attribute's value.
11281
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
11282
+ * fixed on the base entity.
11283
+ *
11284
+ */
11285
+ variant_overridable?: boolean;
10523
11286
  default_value?: any;
10524
11287
  /**
10525
11288
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -10553,6 +11316,16 @@ declare namespace Components {
10553
11316
  *
10554
11317
  */
10555
11318
  render_condition?: string;
11319
+ /**
11320
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
11321
+ *
11322
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
11323
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
11324
+ *
11325
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
11326
+ *
11327
+ */
11328
+ data_classification?: "public" | "pii";
10556
11329
  _purpose?: /**
10557
11330
  * example:
10558
11331
  * taxonomy-slug:classification-slug
@@ -10692,6 +11465,47 @@ declare namespace Components {
10692
11465
  */
10693
11466
  allow_any?: boolean;
10694
11467
  }
11468
+ /**
11469
+ * A condition whose value is one of a fixed set of options.
11470
+ */
11471
+ export interface SelectConditionDefinition {
11472
+ /**
11473
+ * Stable identity of the condition, generated by the client when the condition is
11474
+ * created. It is what makes a rename distinguishable from a remove + add, so it must
11475
+ * be round-tripped unchanged for the lifetime of the condition.
11476
+ *
11477
+ * example:
11478
+ * d5839b94-ba20-4225-a78e-76951d352bd6
11479
+ */
11480
+ id: string; // uuid
11481
+ /**
11482
+ * The key variant values are stored under. Unique within the schema and immutable
11483
+ * once the condition has been saved.
11484
+ *
11485
+ * example:
11486
+ * delivery_area
11487
+ */
11488
+ name: string; // ^[a-z0-9_]+$
11489
+ /**
11490
+ * Display label. Always editable.
11491
+ * example:
11492
+ * Delivery Area
11493
+ */
11494
+ label: string;
11495
+ /**
11496
+ * Immutable once the condition has been saved.
11497
+ */
11498
+ type: "select";
11499
+ /**
11500
+ * Selectable options. May be empty while the condition is being configured.
11501
+ * example:
11502
+ * [
11503
+ * "12_months",
11504
+ * "24_months"
11505
+ * ]
11506
+ */
11507
+ values?: string[];
11508
+ }
10695
11509
  /**
10696
11510
  * Sequence of unique identifiers
10697
11511
  */
@@ -10720,6 +11534,13 @@ declare namespace Components {
10720
11534
  required?: boolean;
10721
11535
  readonly?: boolean;
10722
11536
  deprecated?: boolean;
11537
+ /**
11538
+ * Allow conditional variants of the entity to override this attribute's value.
11539
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
11540
+ * fixed on the base entity.
11541
+ *
11542
+ */
11543
+ variant_overridable?: boolean;
10723
11544
  default_value?: any;
10724
11545
  /**
10725
11546
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -10753,6 +11574,16 @@ declare namespace Components {
10753
11574
  *
10754
11575
  */
10755
11576
  render_condition?: string;
11577
+ /**
11578
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
11579
+ *
11580
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
11581
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
11582
+ *
11583
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
11584
+ *
11585
+ */
11586
+ data_classification?: "public" | "pii";
10756
11587
  _purpose?: /**
10757
11588
  * example:
10758
11589
  * taxonomy-slug:classification-slug
@@ -10929,6 +11760,13 @@ declare namespace Components {
10929
11760
  required?: boolean;
10930
11761
  readonly?: boolean;
10931
11762
  deprecated?: boolean;
11763
+ /**
11764
+ * Allow conditional variants of the entity to override this attribute's value.
11765
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
11766
+ * fixed on the base entity.
11767
+ *
11768
+ */
11769
+ variant_overridable?: boolean;
10932
11770
  default_value?: any;
10933
11771
  /**
10934
11772
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -10962,6 +11800,16 @@ declare namespace Components {
10962
11800
  *
10963
11801
  */
10964
11802
  render_condition?: string;
11803
+ /**
11804
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
11805
+ *
11806
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
11807
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
11808
+ *
11809
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
11810
+ *
11811
+ */
11812
+ data_classification?: "public" | "pii";
10965
11813
  _purpose?: /**
10966
11814
  * example:
10967
11815
  * taxonomy-slug:classification-slug
@@ -11217,6 +12065,13 @@ declare namespace Components {
11217
12065
  required?: boolean;
11218
12066
  readonly?: boolean;
11219
12067
  deprecated?: boolean;
12068
+ /**
12069
+ * Allow conditional variants of the entity to override this attribute's value.
12070
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
12071
+ * fixed on the base entity.
12072
+ *
12073
+ */
12074
+ variant_overridable?: boolean;
11220
12075
  default_value?: any;
11221
12076
  /**
11222
12077
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -11250,6 +12105,16 @@ declare namespace Components {
11250
12105
  *
11251
12106
  */
11252
12107
  render_condition?: string;
12108
+ /**
12109
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
12110
+ *
12111
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
12112
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
12113
+ *
12114
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
12115
+ *
12116
+ */
12117
+ data_classification?: "public" | "pii";
11253
12118
  _purpose?: /**
11254
12119
  * example:
11255
12120
  * taxonomy-slug:classification-slug
@@ -11465,6 +12330,13 @@ declare namespace Components {
11465
12330
  required?: boolean;
11466
12331
  readonly?: boolean;
11467
12332
  deprecated?: boolean;
12333
+ /**
12334
+ * Allow conditional variants of the entity to override this attribute's value.
12335
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
12336
+ * fixed on the base entity.
12337
+ *
12338
+ */
12339
+ variant_overridable?: boolean;
11468
12340
  default_value?: any;
11469
12341
  /**
11470
12342
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -11498,6 +12370,16 @@ declare namespace Components {
11498
12370
  *
11499
12371
  */
11500
12372
  render_condition?: string;
12373
+ /**
12374
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
12375
+ *
12376
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
12377
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
12378
+ *
12379
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
12380
+ *
12381
+ */
12382
+ data_classification?: "public" | "pii";
11501
12383
  _purpose?: /**
11502
12384
  * example:
11503
12385
  * taxonomy-slug:classification-slug
@@ -11814,7 +12696,7 @@ declare namespace Components {
11814
12696
  */
11815
12697
  _manifest?: string /* uuid */[] | null;
11816
12698
  }
11817
- export type TaxonomyLocationId = "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment";
12699
+ export type TaxonomyLocationId = "account" | "contact" | "contract" | "email_template" | "file" | "journey" | "meter_counter" | "meter" | "opportunity" | "order" | "partner" | "price" | "product" | "submission" | "tax" | "message" | "portal_user" | "request" | "comment" | "user";
11818
12700
  /**
11819
12701
  * Whether to include archived labels in the search results
11820
12702
  * - `true`: include archived labels
@@ -11859,6 +12741,13 @@ declare namespace Components {
11859
12741
  required?: boolean;
11860
12742
  readonly?: boolean;
11861
12743
  deprecated?: boolean;
12744
+ /**
12745
+ * Allow conditional variants of the entity to override this attribute's value.
12746
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
12747
+ * fixed on the base entity.
12748
+ *
12749
+ */
12750
+ variant_overridable?: boolean;
11862
12751
  default_value?: any;
11863
12752
  /**
11864
12753
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -11892,6 +12781,16 @@ declare namespace Components {
11892
12781
  *
11893
12782
  */
11894
12783
  render_condition?: string;
12784
+ /**
12785
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
12786
+ *
12787
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
12788
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
12789
+ *
12790
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
12791
+ *
12792
+ */
12793
+ data_classification?: "public" | "pii";
11895
12794
  _purpose?: /**
11896
12795
  * example:
11897
12796
  * taxonomy-slug:classification-slug
@@ -12064,6 +12963,13 @@ declare namespace Components {
12064
12963
  required?: boolean;
12065
12964
  readonly?: boolean;
12066
12965
  deprecated?: boolean;
12966
+ /**
12967
+ * Allow conditional variants of the entity to override this attribute's value.
12968
+ * Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
12969
+ * fixed on the base entity.
12970
+ *
12971
+ */
12972
+ variant_overridable?: boolean;
12067
12973
  default_value?: any;
12068
12974
  /**
12069
12975
  * Which group the attribute should appear in. Accepts group ID or group name
@@ -12097,6 +13003,16 @@ declare namespace Components {
12097
13003
  *
12098
13004
  */
12099
13005
  render_condition?: string;
13006
+ /**
13007
+ * Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
13008
+ *
13009
+ * - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
13010
+ * - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
13011
+ *
13012
+ * When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
13013
+ *
13014
+ */
13015
+ data_classification?: "public" | "pii";
12100
13016
  _purpose?: /**
12101
13017
  * example:
12102
13018
  * taxonomy-slug:classification-slug
@@ -12232,6 +13148,45 @@ declare namespace Components {
12232
13148
  }
12233
13149
  }
12234
13150
  declare namespace Paths {
13151
+ namespace AbortEntityImport {
13152
+ namespace Parameters {
13153
+ export type JobId = /**
13154
+ * The unique identifier of the import job.
13155
+ * example:
13156
+ * abc123
13157
+ */
13158
+ Components.Schemas.ExportJobId;
13159
+ export type Schema = string;
13160
+ }
13161
+ export interface QueryParameters {
13162
+ job_id: Parameters.JobId;
13163
+ schema: Parameters.Schema;
13164
+ }
13165
+ namespace Responses {
13166
+ export interface $202 {
13167
+ /**
13168
+ * The job status at the time of the request.
13169
+ */
13170
+ status?: string;
13171
+ jobPollId?: string;
13172
+ }
13173
+ export interface $400 {
13174
+ }
13175
+ export interface $403 {
13176
+ }
13177
+ export interface $404 {
13178
+ }
13179
+ export type $429 = /**
13180
+ * A generic error returned by the API
13181
+ * example:
13182
+ * {
13183
+ * "status": 429,
13184
+ * "error": "Too many requests. Try again later."
13185
+ * }
13186
+ */
13187
+ Components.Responses.TooManyRequestsError;
13188
+ }
13189
+ }
12235
13190
  namespace AddRelations {
12236
13191
  namespace Parameters {
12237
13192
  export type ActivityId = /**
@@ -12386,6 +13341,7 @@ declare namespace Paths {
12386
13341
  }
12387
13342
  namespace Autocomplete {
12388
13343
  namespace Parameters {
13344
+ export type Anonymize = boolean;
12389
13345
  /**
12390
13346
  * example:
12391
13347
  * _tags
@@ -12401,6 +13357,7 @@ declare namespace Paths {
12401
13357
  Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
12402
13358
  }
12403
13359
  export interface QueryParameters {
13360
+ anonymize?: Parameters.Anonymize;
12404
13361
  input?: Parameters.Input;
12405
13362
  attribute: /**
12406
13363
  * example:
@@ -12916,6 +13873,15 @@ declare namespace Paths {
12916
13873
  namespace Responses {
12917
13874
  export interface $200 {
12918
13875
  }
13876
+ export type $404 = /**
13877
+ * A generic error returned by the API
13878
+ * example:
13879
+ * {
13880
+ * "status": 404,
13881
+ * "error": "Not Found"
13882
+ * }
13883
+ */
13884
+ Components.Responses.NotFoundError;
12919
13885
  export type $429 = /**
12920
13886
  * A generic error returned by the API
12921
13887
  * example:
@@ -13257,6 +14223,7 @@ declare namespace Paths {
13257
14223
  }
13258
14224
  namespace GetActivity {
13259
14225
  namespace Parameters {
14226
+ export type Anonymize = boolean;
13260
14227
  export type Id = /**
13261
14228
  * See https://github.com/ulid/spec
13262
14229
  * example:
@@ -13270,6 +14237,7 @@ declare namespace Paths {
13270
14237
  id: Parameters.Id;
13271
14238
  }
13272
14239
  export interface QueryParameters {
14240
+ anonymize?: Parameters.Anonymize;
13273
14241
  operations_size?: Parameters.OperationsSize;
13274
14242
  operations_from?: Parameters.OperationsFrom;
13275
14243
  }
@@ -13288,6 +14256,7 @@ declare namespace Paths {
13288
14256
  }
13289
14257
  namespace GetEntity {
13290
14258
  namespace Parameters {
14259
+ export type Anonymize = boolean;
13291
14260
  export type Hydrate = boolean;
13292
14261
  export type Id = Components.Schemas.EntityId /* uuid */;
13293
14262
  export type Slug = /**
@@ -13303,6 +14272,7 @@ declare namespace Paths {
13303
14272
  }
13304
14273
  export interface QueryParameters {
13305
14274
  hydrate?: Parameters.Hydrate;
14275
+ anonymize?: Parameters.Anonymize;
13306
14276
  }
13307
14277
  namespace Responses {
13308
14278
  export interface $200 {
@@ -13415,6 +14385,7 @@ declare namespace Paths {
13415
14385
  namespace GetEntityActivityFeed {
13416
14386
  namespace Parameters {
13417
14387
  export type After = string; // date-time
14388
+ export type Anonymize = boolean;
13418
14389
  export type Before = string; // date-time
13419
14390
  export type EndDate = string; // date-time
13420
14391
  /**
@@ -13452,6 +14423,7 @@ declare namespace Paths {
13452
14423
  id: Parameters.Id;
13453
14424
  }
13454
14425
  export interface QueryParameters {
14426
+ anonymize?: Parameters.Anonymize;
13455
14427
  after?: Parameters.After /* date-time */;
13456
14428
  before?: Parameters.Before /* date-time */;
13457
14429
  start_date?: Parameters.StartDate /* date-time */;
@@ -13500,6 +14472,7 @@ declare namespace Paths {
13500
14472
  }
13501
14473
  namespace GetEntityV2 {
13502
14474
  namespace Parameters {
14475
+ export type Anonymize = boolean;
13503
14476
  export type ApplyChangesets = boolean;
13504
14477
  export type Fields = /**
13505
14478
  * List of entity fields to include or exclude in the response
@@ -13534,6 +14507,7 @@ declare namespace Paths {
13534
14507
  }
13535
14508
  export interface QueryParameters {
13536
14509
  hydrate?: Parameters.Hydrate;
14510
+ anonymize?: Parameters.Anonymize;
13537
14511
  fields?: Parameters.Fields;
13538
14512
  apply_changesets?: Parameters.ApplyChangesets;
13539
14513
  }
@@ -13954,6 +14928,7 @@ declare namespace Paths {
13954
14928
  }
13955
14929
  namespace GetRelations {
13956
14930
  namespace Parameters {
14931
+ export type Anonymize = boolean;
13957
14932
  export type ExcludeSchemas = /**
13958
14933
  * URL-friendly identifier for the entity schema
13959
14934
  * example:
@@ -13984,6 +14959,7 @@ declare namespace Paths {
13984
14959
  }
13985
14960
  export interface QueryParameters {
13986
14961
  hydrate?: Parameters.Hydrate;
14962
+ anonymize?: Parameters.Anonymize;
13987
14963
  include_reverse?: Parameters.IncludeReverse;
13988
14964
  from?: Parameters.From;
13989
14965
  size?: Parameters.Size;
@@ -14005,6 +14981,7 @@ declare namespace Paths {
14005
14981
  }
14006
14982
  namespace GetRelationsV2 {
14007
14983
  namespace Parameters {
14984
+ export type Anonymize = boolean;
14008
14985
  export type Fields = /**
14009
14986
  * List of entity fields to include or exclude in the response
14010
14987
  *
@@ -14042,6 +15019,7 @@ declare namespace Paths {
14042
15019
  }
14043
15020
  export interface QueryParameters {
14044
15021
  hydrate?: Parameters.Hydrate;
15022
+ anonymize?: Parameters.Anonymize;
14045
15023
  query?: Parameters.Query;
14046
15024
  include_reverse?: Parameters.IncludeReverse;
14047
15025
  from?: Parameters.From;
@@ -14063,6 +15041,7 @@ declare namespace Paths {
14063
15041
  }
14064
15042
  namespace GetRelationsV3 {
14065
15043
  namespace Parameters {
15044
+ export type Anonymize = boolean;
14066
15045
  export type ExcludeSchemas = /**
14067
15046
  * URL-friendly identifier for the entity schema
14068
15047
  * example:
@@ -14122,6 +15101,7 @@ declare namespace Paths {
14122
15101
  }
14123
15102
  export interface QueryParameters {
14124
15103
  hydrate?: Parameters.Hydrate;
15104
+ anonymize?: Parameters.Anonymize;
14125
15105
  include_reverse?: Parameters.IncludeReverse;
14126
15106
  from?: Parameters.From;
14127
15107
  size?: Parameters.Size;
@@ -14440,7 +15420,7 @@ declare namespace Paths {
14440
15420
  /**
14441
15421
  * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
14442
15422
  * example:
14443
- * 2023-01-01T00:00:00Z
15423
+ * 2023-01-01T00:00:00.000Z
14444
15424
  */
14445
15425
  export type CreatedAfter = string; // date-time
14446
15426
  /**
@@ -14466,7 +15446,7 @@ declare namespace Paths {
14466
15446
  created_after?: /**
14467
15447
  * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
14468
15448
  * example:
14469
- * 2023-01-01T00:00:00Z
15449
+ * 2023-01-01T00:00:00.000Z
14470
15450
  */
14471
15451
  Parameters.CreatedAfter /* date-time */;
14472
15452
  sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
@@ -14555,6 +15535,7 @@ declare namespace Paths {
14555
15535
  }
14556
15536
  namespace ListChangesets {
14557
15537
  namespace Parameters {
15538
+ export type Anonymize = boolean;
14558
15539
  export type Id = Components.Schemas.EntityId /* uuid */;
14559
15540
  export type Slug = /**
14560
15541
  * URL-friendly identifier for the entity schema
@@ -14567,6 +15548,9 @@ declare namespace Paths {
14567
15548
  slug: Parameters.Slug;
14568
15549
  id: Parameters.Id;
14569
15550
  }
15551
+ export interface QueryParameters {
15552
+ anonymize?: Parameters.Anonymize;
15553
+ }
14570
15554
  namespace Responses {
14571
15555
  export type $200 = /* Map of attribute name to pending changeset. At most one changeset per attribute. */ Components.Schemas.ChangesetMap;
14572
15556
  export type $404 = /**
@@ -14623,6 +15607,7 @@ declare namespace Paths {
14623
15607
  */
14624
15608
  Components.Schemas.FieldsParam;
14625
15609
  export type From = number;
15610
+ export type Q = string;
14626
15611
  export type Size = number;
14627
15612
  export type Slug = /**
14628
15613
  * URL-friendly identifier for the entity schema
@@ -14637,6 +15622,7 @@ declare namespace Paths {
14637
15622
  sort?: Parameters.Sort;
14638
15623
  from?: Parameters.From;
14639
15624
  size?: Parameters.Size;
15625
+ q?: Parameters.Q;
14640
15626
  fields?: Parameters.Fields;
14641
15627
  }
14642
15628
  namespace Responses {
@@ -16519,7 +17505,7 @@ export interface OperationMethods {
16519
17505
  * Returns all pending changesets for an entity.
16520
17506
  */
16521
17507
  'listChangesets'(
16522
- parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
17508
+ parameters?: Parameters<Paths.ListChangesets.QueryParameters & Paths.ListChangesets.PathParameters> | null,
16523
17509
  data?: any,
16524
17510
  config?: AxiosRequestConfig
16525
17511
  ): OperationResponse<Paths.ListChangesets.Responses.$200>
@@ -16657,6 +17643,25 @@ export interface OperationMethods {
16657
17643
  data?: Paths.ImportEntities.RequestBody,
16658
17644
  config?: AxiosRequestConfig
16659
17645
  ): OperationResponse<Paths.ImportEntities.Responses.$201>
17646
+ /**
17647
+ * abortEntityImport - Abort a running entity import
17648
+ *
17649
+ * Asks a running import to stop. Rows already imported are **kept** - this is a stop, not a
17650
+ * rollback - and the job still produces its result reports for everything that landed before
17651
+ * the stop, then reaches the terminal status `CANCELLED`.
17652
+ *
17653
+ * The stop is cooperative: the worker notices the request at its next batch boundary, so the
17654
+ * job typically reaches `CANCELLED` within seconds. Poll `POST /v1/entity:import` with the
17655
+ * `job_id` as usual to observe it.
17656
+ *
17657
+ * Idempotent - aborting an already-aborted or already-finished job is not an error.
17658
+ *
17659
+ */
17660
+ 'abortEntityImport'(
17661
+ parameters?: Parameters<Paths.AbortEntityImport.QueryParameters> | null,
17662
+ data?: any,
17663
+ config?: AxiosRequestConfig
17664
+ ): OperationResponse<Paths.AbortEntityImport.Responses.$202>
16660
17665
  /**
16661
17666
  * listSavedViews - listSavedViews
16662
17667
  *
@@ -17753,7 +18758,7 @@ export interface PathsDictionary {
17753
18758
  * Returns all pending changesets for an entity.
17754
18759
  */
17755
18760
  'get'(
17756
- parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
18761
+ parameters?: Parameters<Paths.ListChangesets.QueryParameters & Paths.ListChangesets.PathParameters> | null,
17757
18762
  data?: any,
17758
18763
  config?: AxiosRequestConfig
17759
18764
  ): OperationResponse<Paths.ListChangesets.Responses.$200>
@@ -17908,6 +18913,27 @@ export interface PathsDictionary {
17908
18913
  config?: AxiosRequestConfig
17909
18914
  ): OperationResponse<Paths.ImportEntities.Responses.$201>
17910
18915
  }
18916
+ ['/v1/entity:abortImport']: {
18917
+ /**
18918
+ * abortEntityImport - Abort a running entity import
18919
+ *
18920
+ * Asks a running import to stop. Rows already imported are **kept** - this is a stop, not a
18921
+ * rollback - and the job still produces its result reports for everything that landed before
18922
+ * the stop, then reaches the terminal status `CANCELLED`.
18923
+ *
18924
+ * The stop is cooperative: the worker notices the request at its next batch boundary, so the
18925
+ * job typically reaches `CANCELLED` within seconds. Poll `POST /v1/entity:import` with the
18926
+ * `job_id` as usual to observe it.
18927
+ *
18928
+ * Idempotent - aborting an already-aborted or already-finished job is not an error.
18929
+ *
18930
+ */
18931
+ 'post'(
18932
+ parameters?: Parameters<Paths.AbortEntityImport.QueryParameters> | null,
18933
+ data?: any,
18934
+ config?: AxiosRequestConfig
18935
+ ): OperationResponse<Paths.AbortEntityImport.Responses.$202>
18936
+ }
17911
18937
  ['/v1/entity/views']: {
17912
18938
  /**
17913
18939
  * listSavedViews - listSavedViews
@@ -18415,6 +19441,7 @@ export type AttributeWithCompositeID = Components.Schemas.AttributeWithComposite
18415
19441
  export type AutomationAttribute = Components.Schemas.AutomationAttribute;
18416
19442
  export type BaseActivityItem = Components.Schemas.BaseActivityItem;
18417
19443
  export type BaseAttribute = Components.Schemas.BaseAttribute;
19444
+ export type BaseConditionDefinition = Components.Schemas.BaseConditionDefinition;
18418
19445
  export type BaseEntity = Components.Schemas.BaseEntity;
18419
19446
  export type BlueprintEntityId = Components.Schemas.BlueprintEntityId;
18420
19447
  export type BooleanAttribute = Components.Schemas.BooleanAttribute;
@@ -18426,6 +19453,7 @@ export type ClassificationIdOrPattern = Components.Schemas.ClassificationIdOrPat
18426
19453
  export type ClassificationSlug = Components.Schemas.ClassificationSlug;
18427
19454
  export type ClassificationsUpdate = Components.Schemas.ClassificationsUpdate;
18428
19455
  export type ComputedAttribute = Components.Schemas.ComputedAttribute;
19456
+ export type ConditionDefinition = Components.Schemas.ConditionDefinition;
18429
19457
  export type ConsentAttribute = Components.Schemas.ConsentAttribute;
18430
19458
  export type CountryAttribute = Components.Schemas.CountryAttribute;
18431
19459
  export type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
@@ -18448,6 +19476,7 @@ export type EntityImportParams = Components.Schemas.EntityImportParams;
18448
19476
  export type EntityItem = Components.Schemas.EntityItem;
18449
19477
  export type EntityListParams = Components.Schemas.EntityListParams;
18450
19478
  export type EntityOperation = Components.Schemas.EntityOperation;
19479
+ export type EntityOperationSourceContext = Components.Schemas.EntityOperationSourceContext;
18451
19480
  export type EntityOwner = Components.Schemas.EntityOwner;
18452
19481
  export type EntitySchema = Components.Schemas.EntitySchema;
18453
19482
  export type EntitySchemaGroup = Components.Schemas.EntitySchemaGroup;
@@ -18496,6 +19525,7 @@ export type IsTemplate = Components.Schemas.IsTemplate;
18496
19525
  export type Language = Components.Schemas.Language;
18497
19526
  export type LinkAttribute = Components.Schemas.LinkAttribute;
18498
19527
  export type ListSavedViewsResults = Components.Schemas.ListSavedViewsResults;
19528
+ export type LocationConditionDefinition = Components.Schemas.LocationConditionDefinition;
18499
19529
  export type MatchStrategy = Components.Schemas.MatchStrategy;
18500
19530
  export type MessageEmailAddressAttribute = Components.Schemas.MessageEmailAddressAttribute;
18501
19531
  export type MeterReadingChangesetEntry = Components.Schemas.MeterReadingChangesetEntry;
@@ -18520,11 +19550,13 @@ export type SavedView = Components.Schemas.SavedView;
18520
19550
  export type SavedViewId = Components.Schemas.SavedViewId;
18521
19551
  export type SavedViewItem = Components.Schemas.SavedViewItem;
18522
19552
  export type SavedViewPartial = Components.Schemas.SavedViewPartial;
19553
+ export type ScalarConditionDefinition = Components.Schemas.ScalarConditionDefinition;
18523
19554
  export type SchemaId = Components.Schemas.SchemaId;
18524
19555
  export type SearchFilter = Components.Schemas.SearchFilter;
18525
19556
  export type SearchFilterValue = Components.Schemas.SearchFilterValue;
18526
19557
  export type SearchMappings = Components.Schemas.SearchMappings;
18527
19558
  export type SelectAttribute = Components.Schemas.SelectAttribute;
19559
+ export type SelectConditionDefinition = Components.Schemas.SelectConditionDefinition;
18528
19560
  export type SequenceAttribute = Components.Schemas.SequenceAttribute;
18529
19561
  export type SettingFlag = Components.Schemas.SettingFlag;
18530
19562
  export type StatusAttribute = Components.Schemas.StatusAttribute;