@epilot/sdk 2.15.6 → 2.15.7
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/definitions/entity-runtime.json +1 -1
- package/definitions/entity.json +373 -3
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-6DBGRVEF.js → chunk-4QHWT67K.js} +2 -2
- package/dist/{chunk-VBTUFDXY.cjs → chunk-Q7WEQVWP.cjs} +2 -2
- package/dist/chunk-XHTYJNOZ.cjs +14 -0
- package/dist/chunk-ZQU37FR3.js +14 -0
- package/dist/entity-K5HYURU7.js +7 -0
- package/dist/entity-V5375UNT.cjs +7 -0
- package/dist/entity-runtime-7INAS2AX.cjs +5 -0
- package/dist/{entity-runtime-LNAZILIN.js → entity-runtime-EBFSSNOM.js} +1 -1
- package/dist/{entity.d-fospShiN.d.cts → entity.d-CmQvgvyi.d.cts} +1038 -6
- package/dist/{entity.d-fospShiN.d.ts → entity.d-CmQvgvyi.d.ts} +1038 -6
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/entity.md +396 -56
- package/package.json +1 -1
- package/dist/chunk-M6Z6ES3I.js +0 -14
- package/dist/chunk-UBQCDPW6.cjs +0 -14
- package/dist/entity-SS36LQO6.cjs +0 -7
- package/dist/entity-Z4YWKDVG.js +0 -7
- package/dist/entity-runtime-3J5EDLXP.cjs +0 -5
|
@@ -17,6 +17,7 @@ declare namespace Components {
|
|
|
17
17
|
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
18
18
|
*/
|
|
19
19
|
Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
20
|
+
export type AnonymizeQueryParam = boolean;
|
|
20
21
|
export type ApplyChangesetsQueryParam = boolean;
|
|
21
22
|
export type AsyncOperationQueryParam = boolean;
|
|
22
23
|
export type DirectQueryParam = boolean;
|
|
@@ -74,6 +75,7 @@ declare namespace Components {
|
|
|
74
75
|
ActivityIdPathParam?: Parameters.ActivityIdPathParam;
|
|
75
76
|
}
|
|
76
77
|
export interface QueryParameters {
|
|
78
|
+
AnonymizeQueryParam?: Parameters.AnonymizeQueryParam;
|
|
77
79
|
TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
|
|
78
80
|
TaxonomySlugQueryParamOptional?: Parameters.TaxonomySlugQueryParamOptional;
|
|
79
81
|
AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
|
|
@@ -387,6 +389,13 @@ declare namespace Components {
|
|
|
387
389
|
required?: boolean;
|
|
388
390
|
readonly?: boolean;
|
|
389
391
|
deprecated?: boolean;
|
|
392
|
+
/**
|
|
393
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
394
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
395
|
+
* fixed on the base entity.
|
|
396
|
+
*
|
|
397
|
+
*/
|
|
398
|
+
variant_overridable?: boolean;
|
|
390
399
|
default_value?: any;
|
|
391
400
|
/**
|
|
392
401
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -420,6 +429,16 @@ declare namespace Components {
|
|
|
420
429
|
*
|
|
421
430
|
*/
|
|
422
431
|
render_condition?: string;
|
|
432
|
+
/**
|
|
433
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
434
|
+
*
|
|
435
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
436
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
437
|
+
*
|
|
438
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
439
|
+
*
|
|
440
|
+
*/
|
|
441
|
+
data_classification?: "public" | "pii";
|
|
423
442
|
_purpose?: /**
|
|
424
443
|
* example:
|
|
425
444
|
* taxonomy-slug:classification-slug
|
|
@@ -605,6 +624,13 @@ declare namespace Components {
|
|
|
605
624
|
required?: boolean;
|
|
606
625
|
readonly?: boolean;
|
|
607
626
|
deprecated?: boolean;
|
|
627
|
+
/**
|
|
628
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
629
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
630
|
+
* fixed on the base entity.
|
|
631
|
+
*
|
|
632
|
+
*/
|
|
633
|
+
variant_overridable?: boolean;
|
|
608
634
|
default_value?: any;
|
|
609
635
|
/**
|
|
610
636
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -638,6 +664,16 @@ declare namespace Components {
|
|
|
638
664
|
*
|
|
639
665
|
*/
|
|
640
666
|
render_condition?: string;
|
|
667
|
+
/**
|
|
668
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
669
|
+
*
|
|
670
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
671
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
672
|
+
*
|
|
673
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
674
|
+
*
|
|
675
|
+
*/
|
|
676
|
+
data_classification?: "public" | "pii";
|
|
641
677
|
_purpose?: /**
|
|
642
678
|
* example:
|
|
643
679
|
* taxonomy-slug:classification-slug
|
|
@@ -840,6 +876,13 @@ declare namespace Components {
|
|
|
840
876
|
required?: boolean;
|
|
841
877
|
readonly?: boolean;
|
|
842
878
|
deprecated?: boolean;
|
|
879
|
+
/**
|
|
880
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
881
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
882
|
+
* fixed on the base entity.
|
|
883
|
+
*
|
|
884
|
+
*/
|
|
885
|
+
variant_overridable?: boolean;
|
|
843
886
|
default_value?: any;
|
|
844
887
|
/**
|
|
845
888
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -873,6 +916,16 @@ declare namespace Components {
|
|
|
873
916
|
*
|
|
874
917
|
*/
|
|
875
918
|
render_condition?: string;
|
|
919
|
+
/**
|
|
920
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
921
|
+
*
|
|
922
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
923
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
924
|
+
*
|
|
925
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
926
|
+
*
|
|
927
|
+
*/
|
|
928
|
+
data_classification?: "public" | "pii";
|
|
876
929
|
_purpose?: /**
|
|
877
930
|
* example:
|
|
878
931
|
* taxonomy-slug:classification-slug
|
|
@@ -1090,6 +1143,13 @@ declare namespace Components {
|
|
|
1090
1143
|
required?: boolean;
|
|
1091
1144
|
readonly?: boolean;
|
|
1092
1145
|
deprecated?: boolean;
|
|
1146
|
+
/**
|
|
1147
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
1148
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1149
|
+
* fixed on the base entity.
|
|
1150
|
+
*
|
|
1151
|
+
*/
|
|
1152
|
+
variant_overridable?: boolean;
|
|
1093
1153
|
default_value?: any;
|
|
1094
1154
|
/**
|
|
1095
1155
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1123,6 +1183,16 @@ declare namespace Components {
|
|
|
1123
1183
|
*
|
|
1124
1184
|
*/
|
|
1125
1185
|
render_condition?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
1188
|
+
*
|
|
1189
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
1190
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
1191
|
+
*
|
|
1192
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
1193
|
+
*
|
|
1194
|
+
*/
|
|
1195
|
+
data_classification?: "public" | "pii";
|
|
1126
1196
|
_purpose?: /**
|
|
1127
1197
|
* example:
|
|
1128
1198
|
* taxonomy-slug:classification-slug
|
|
@@ -1253,6 +1323,31 @@ declare namespace Components {
|
|
|
1253
1323
|
FuzzyConfig;
|
|
1254
1324
|
};
|
|
1255
1325
|
}
|
|
1326
|
+
export interface BaseConditionDefinition {
|
|
1327
|
+
/**
|
|
1328
|
+
* Stable identity of the condition, generated by the client when the condition is
|
|
1329
|
+
* created. It is what makes a rename distinguishable from a remove + add, so it must
|
|
1330
|
+
* be round-tripped unchanged for the lifetime of the condition.
|
|
1331
|
+
*
|
|
1332
|
+
* example:
|
|
1333
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1334
|
+
*/
|
|
1335
|
+
id: string; // uuid
|
|
1336
|
+
/**
|
|
1337
|
+
* The key variant values are stored under. Unique within the schema and immutable
|
|
1338
|
+
* once the condition has been saved.
|
|
1339
|
+
*
|
|
1340
|
+
* example:
|
|
1341
|
+
* delivery_area
|
|
1342
|
+
*/
|
|
1343
|
+
name: string; // ^[a-z0-9_]+$
|
|
1344
|
+
/**
|
|
1345
|
+
* Display label. Always editable.
|
|
1346
|
+
* example:
|
|
1347
|
+
* Delivery Area
|
|
1348
|
+
*/
|
|
1349
|
+
label: string;
|
|
1350
|
+
}
|
|
1256
1351
|
/**
|
|
1257
1352
|
* example:
|
|
1258
1353
|
* {
|
|
@@ -1380,6 +1475,13 @@ declare namespace Components {
|
|
|
1380
1475
|
required?: boolean;
|
|
1381
1476
|
readonly?: boolean;
|
|
1382
1477
|
deprecated?: boolean;
|
|
1478
|
+
/**
|
|
1479
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
1480
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1481
|
+
* fixed on the base entity.
|
|
1482
|
+
*
|
|
1483
|
+
*/
|
|
1484
|
+
variant_overridable?: boolean;
|
|
1383
1485
|
default_value?: any;
|
|
1384
1486
|
/**
|
|
1385
1487
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1413,6 +1515,16 @@ declare namespace Components {
|
|
|
1413
1515
|
*
|
|
1414
1516
|
*/
|
|
1415
1517
|
render_condition?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
1520
|
+
*
|
|
1521
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
1522
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
1523
|
+
*
|
|
1524
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
1525
|
+
*
|
|
1526
|
+
*/
|
|
1527
|
+
data_classification?: "public" | "pii";
|
|
1416
1528
|
_purpose?: /**
|
|
1417
1529
|
* example:
|
|
1418
1530
|
* taxonomy-slug:classification-slug
|
|
@@ -1675,6 +1787,13 @@ declare namespace Components {
|
|
|
1675
1787
|
required?: boolean;
|
|
1676
1788
|
readonly?: boolean;
|
|
1677
1789
|
deprecated?: boolean;
|
|
1790
|
+
/**
|
|
1791
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
1792
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
1793
|
+
* fixed on the base entity.
|
|
1794
|
+
*
|
|
1795
|
+
*/
|
|
1796
|
+
variant_overridable?: boolean;
|
|
1678
1797
|
default_value?: any;
|
|
1679
1798
|
/**
|
|
1680
1799
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1708,6 +1827,16 @@ declare namespace Components {
|
|
|
1708
1827
|
*
|
|
1709
1828
|
*/
|
|
1710
1829
|
render_condition?: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
1832
|
+
*
|
|
1833
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
1834
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
1835
|
+
*
|
|
1836
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
1837
|
+
*
|
|
1838
|
+
*/
|
|
1839
|
+
data_classification?: "public" | "pii";
|
|
1711
1840
|
_purpose?: /**
|
|
1712
1841
|
* example:
|
|
1713
1842
|
* taxonomy-slug:classification-slug
|
|
@@ -1858,6 +1987,19 @@ declare namespace Components {
|
|
|
1858
1987
|
*/
|
|
1859
1988
|
currency_field?: string;
|
|
1860
1989
|
}
|
|
1990
|
+
/**
|
|
1991
|
+
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
1992
|
+
* discriminates the variants: only a `select` condition carries `values`, and only a
|
|
1993
|
+
* `location` condition carries `format`.
|
|
1994
|
+
*
|
|
1995
|
+
*/
|
|
1996
|
+
export type ConditionDefinition = /**
|
|
1997
|
+
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
1998
|
+
* discriminates the variants: only a `select` condition carries `values`, and only a
|
|
1999
|
+
* `location` condition carries `format`.
|
|
2000
|
+
*
|
|
2001
|
+
*/
|
|
2002
|
+
/* 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;
|
|
1861
2003
|
/**
|
|
1862
2004
|
* Consent Management
|
|
1863
2005
|
*/
|
|
@@ -1886,6 +2028,13 @@ declare namespace Components {
|
|
|
1886
2028
|
required?: boolean;
|
|
1887
2029
|
readonly?: boolean;
|
|
1888
2030
|
deprecated?: boolean;
|
|
2031
|
+
/**
|
|
2032
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
2033
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2034
|
+
* fixed on the base entity.
|
|
2035
|
+
*
|
|
2036
|
+
*/
|
|
2037
|
+
variant_overridable?: boolean;
|
|
1889
2038
|
default_value?: any;
|
|
1890
2039
|
/**
|
|
1891
2040
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -1919,6 +2068,16 @@ declare namespace Components {
|
|
|
1919
2068
|
*
|
|
1920
2069
|
*/
|
|
1921
2070
|
render_condition?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
2073
|
+
*
|
|
2074
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
2075
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
2076
|
+
*
|
|
2077
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
2078
|
+
*
|
|
2079
|
+
*/
|
|
2080
|
+
data_classification?: "public" | "pii";
|
|
1922
2081
|
_purpose?: /**
|
|
1923
2082
|
* example:
|
|
1924
2083
|
* taxonomy-slug:classification-slug
|
|
@@ -2080,6 +2239,13 @@ declare namespace Components {
|
|
|
2080
2239
|
required?: boolean;
|
|
2081
2240
|
readonly?: boolean;
|
|
2082
2241
|
deprecated?: boolean;
|
|
2242
|
+
/**
|
|
2243
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
2244
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2245
|
+
* fixed on the base entity.
|
|
2246
|
+
*
|
|
2247
|
+
*/
|
|
2248
|
+
variant_overridable?: boolean;
|
|
2083
2249
|
default_value?: any;
|
|
2084
2250
|
/**
|
|
2085
2251
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2113,6 +2279,16 @@ declare namespace Components {
|
|
|
2113
2279
|
*
|
|
2114
2280
|
*/
|
|
2115
2281
|
render_condition?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
2284
|
+
*
|
|
2285
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
2286
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
2287
|
+
*
|
|
2288
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
2289
|
+
*
|
|
2290
|
+
*/
|
|
2291
|
+
data_classification?: "public" | "pii";
|
|
2116
2292
|
_purpose?: /**
|
|
2117
2293
|
* example:
|
|
2118
2294
|
* taxonomy-slug:classification-slug
|
|
@@ -2272,6 +2448,13 @@ declare namespace Components {
|
|
|
2272
2448
|
required?: boolean;
|
|
2273
2449
|
readonly?: boolean;
|
|
2274
2450
|
deprecated?: boolean;
|
|
2451
|
+
/**
|
|
2452
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
2453
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2454
|
+
* fixed on the base entity.
|
|
2455
|
+
*
|
|
2456
|
+
*/
|
|
2457
|
+
variant_overridable?: boolean;
|
|
2275
2458
|
default_value?: any;
|
|
2276
2459
|
/**
|
|
2277
2460
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2305,6 +2488,16 @@ declare namespace Components {
|
|
|
2305
2488
|
*
|
|
2306
2489
|
*/
|
|
2307
2490
|
render_condition?: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
2493
|
+
*
|
|
2494
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
2495
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
2496
|
+
*
|
|
2497
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
2498
|
+
*
|
|
2499
|
+
*/
|
|
2500
|
+
data_classification?: "public" | "pii";
|
|
2308
2501
|
_purpose?: /**
|
|
2309
2502
|
* example:
|
|
2310
2503
|
* taxonomy-slug:classification-slug
|
|
@@ -2474,6 +2667,13 @@ declare namespace Components {
|
|
|
2474
2667
|
required?: boolean;
|
|
2475
2668
|
readonly?: boolean;
|
|
2476
2669
|
deprecated?: boolean;
|
|
2670
|
+
/**
|
|
2671
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
2672
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2673
|
+
* fixed on the base entity.
|
|
2674
|
+
*
|
|
2675
|
+
*/
|
|
2676
|
+
variant_overridable?: boolean;
|
|
2477
2677
|
default_value?: any;
|
|
2478
2678
|
/**
|
|
2479
2679
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2507,6 +2707,16 @@ declare namespace Components {
|
|
|
2507
2707
|
*
|
|
2508
2708
|
*/
|
|
2509
2709
|
render_condition?: string;
|
|
2710
|
+
/**
|
|
2711
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
2712
|
+
*
|
|
2713
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
2714
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
2715
|
+
*
|
|
2716
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
2717
|
+
*
|
|
2718
|
+
*/
|
|
2719
|
+
data_classification?: "public" | "pii";
|
|
2510
2720
|
_purpose?: /**
|
|
2511
2721
|
* example:
|
|
2512
2722
|
* taxonomy-slug:classification-slug
|
|
@@ -2747,6 +2957,13 @@ declare namespace Components {
|
|
|
2747
2957
|
required?: boolean;
|
|
2748
2958
|
readonly?: boolean;
|
|
2749
2959
|
deprecated?: boolean;
|
|
2960
|
+
/**
|
|
2961
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
2962
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
2963
|
+
* fixed on the base entity.
|
|
2964
|
+
*
|
|
2965
|
+
*/
|
|
2966
|
+
variant_overridable?: boolean;
|
|
2750
2967
|
default_value?: any;
|
|
2751
2968
|
/**
|
|
2752
2969
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -2780,6 +2997,16 @@ declare namespace Components {
|
|
|
2780
2997
|
*
|
|
2781
2998
|
*/
|
|
2782
2999
|
render_condition?: string;
|
|
3000
|
+
/**
|
|
3001
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
3002
|
+
*
|
|
3003
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
3004
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
3005
|
+
*
|
|
3006
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
3007
|
+
*
|
|
3008
|
+
*/
|
|
3009
|
+
data_classification?: "public" | "pii";
|
|
2783
3010
|
_purpose?: /**
|
|
2784
3011
|
* example:
|
|
2785
3012
|
* taxonomy-slug:classification-slug
|
|
@@ -3590,6 +3817,13 @@ declare namespace Components {
|
|
|
3590
3817
|
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
3591
3818
|
*/
|
|
3592
3819
|
hydrate?: boolean;
|
|
3820
|
+
/**
|
|
3821
|
+
* When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
|
|
3822
|
+
* addresses are generalized and well-known free-text fields are redacted.
|
|
3823
|
+
* Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
|
|
3824
|
+
*
|
|
3825
|
+
*/
|
|
3826
|
+
anonymize?: boolean;
|
|
3593
3827
|
fields?: /**
|
|
3594
3828
|
* List of entity fields to include or exclude in the response
|
|
3595
3829
|
*
|
|
@@ -4099,6 +4333,7 @@ declare namespace Components {
|
|
|
4099
4333
|
} | null;
|
|
4100
4334
|
};
|
|
4101
4335
|
};
|
|
4336
|
+
source_context?: /* Billing and audit source context for the operation event. */ EntityOperationSourceContext;
|
|
4102
4337
|
/**
|
|
4103
4338
|
* Internal property for workflow origin tracking and infinite loop prevention.
|
|
4104
4339
|
* Populated when an entity update originates from a workflow execution.
|
|
@@ -4115,6 +4350,34 @@ declare namespace Components {
|
|
|
4115
4350
|
*/
|
|
4116
4351
|
flow_template_id?: string;
|
|
4117
4352
|
};
|
|
4353
|
+
/**
|
|
4354
|
+
* Ordered automation flow ids that caused this change; used to break multi-automation trigger loops.
|
|
4355
|
+
*/
|
|
4356
|
+
_automation_chain?: string[];
|
|
4357
|
+
}
|
|
4358
|
+
/**
|
|
4359
|
+
* Billing and audit source context for the operation event.
|
|
4360
|
+
*/
|
|
4361
|
+
export interface EntityOperationSourceContext {
|
|
4362
|
+
/**
|
|
4363
|
+
* Normalized source bucket for the operation.
|
|
4364
|
+
*/
|
|
4365
|
+
source: "portal" | "epilot" | "erp" | "system" | "api" | "external" | "journey" | "automation" | "unknown";
|
|
4366
|
+
/**
|
|
4367
|
+
* Original free-form source label from the caller or changeset, when available.
|
|
4368
|
+
*/
|
|
4369
|
+
source_label?: string;
|
|
4370
|
+
/**
|
|
4371
|
+
* Optional upstream system label, for example an ERP system name.
|
|
4372
|
+
*/
|
|
4373
|
+
source_system?: string;
|
|
4374
|
+
/**
|
|
4375
|
+
* Optional upstream change reference.
|
|
4376
|
+
*/
|
|
4377
|
+
source_reference?: string;
|
|
4378
|
+
actor_type?: "user" | "portal_user" | "api_client" | "automation" | "system";
|
|
4379
|
+
actor_id?: string;
|
|
4380
|
+
effective_at?: string; // date-time
|
|
4118
4381
|
}
|
|
4119
4382
|
/**
|
|
4120
4383
|
* The user / organization owning this entity.
|
|
@@ -4268,6 +4531,27 @@ declare namespace Components {
|
|
|
4268
4531
|
*/
|
|
4269
4532
|
show_sharing_button?: boolean;
|
|
4270
4533
|
};
|
|
4534
|
+
/**
|
|
4535
|
+
* Widget-grid layout for the entity-details page (builder-authored); columns/cells drive the grid geometry.
|
|
4536
|
+
*/
|
|
4537
|
+
grid_layout?: {
|
|
4538
|
+
/**
|
|
4539
|
+
* Identifier of the chosen grid-layout preset.
|
|
4540
|
+
*/
|
|
4541
|
+
id?: string;
|
|
4542
|
+
/**
|
|
4543
|
+
* Number of columns in the widget grid.
|
|
4544
|
+
*/
|
|
4545
|
+
columns?: number;
|
|
4546
|
+
/**
|
|
4547
|
+
* Per-cell column span, positionally paired with the widgets in order.
|
|
4548
|
+
*/
|
|
4549
|
+
cells?: number[];
|
|
4550
|
+
};
|
|
4551
|
+
/**
|
|
4552
|
+
* 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.
|
|
4553
|
+
*/
|
|
4554
|
+
widget_order?: string[];
|
|
4271
4555
|
};
|
|
4272
4556
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
4273
4557
|
/**
|
|
@@ -4379,6 +4663,20 @@ declare namespace Components {
|
|
|
4379
4663
|
*/
|
|
4380
4664
|
SearchMappings;
|
|
4381
4665
|
group_headlines?: GroupHeadline[];
|
|
4666
|
+
/**
|
|
4667
|
+
* Dimensions that conditional variants of this entity type are keyed by.
|
|
4668
|
+
*
|
|
4669
|
+
* Absent or `null` means entities of this type are not conditional. Attributes whose
|
|
4670
|
+
* values a variant may override are marked with `variant_overridable`.
|
|
4671
|
+
*
|
|
4672
|
+
*/
|
|
4673
|
+
conditions?: /**
|
|
4674
|
+
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
4675
|
+
* discriminates the variants: only a `select` condition carries `values`, and only a
|
|
4676
|
+
* `location` condition carries `format`.
|
|
4677
|
+
*
|
|
4678
|
+
*/
|
|
4679
|
+
ConditionDefinition[] | null;
|
|
4382
4680
|
}
|
|
4383
4681
|
export interface EntitySchemaGroup {
|
|
4384
4682
|
/**
|
|
@@ -4664,6 +4962,27 @@ declare namespace Components {
|
|
|
4664
4962
|
*/
|
|
4665
4963
|
show_sharing_button?: boolean;
|
|
4666
4964
|
};
|
|
4965
|
+
/**
|
|
4966
|
+
* Widget-grid layout for the entity-details page (builder-authored); columns/cells drive the grid geometry.
|
|
4967
|
+
*/
|
|
4968
|
+
grid_layout?: {
|
|
4969
|
+
/**
|
|
4970
|
+
* Identifier of the chosen grid-layout preset.
|
|
4971
|
+
*/
|
|
4972
|
+
id?: string;
|
|
4973
|
+
/**
|
|
4974
|
+
* Number of columns in the widget grid.
|
|
4975
|
+
*/
|
|
4976
|
+
columns?: number;
|
|
4977
|
+
/**
|
|
4978
|
+
* Per-cell column span, positionally paired with the widgets in order.
|
|
4979
|
+
*/
|
|
4980
|
+
cells?: number[];
|
|
4981
|
+
};
|
|
4982
|
+
/**
|
|
4983
|
+
* 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.
|
|
4984
|
+
*/
|
|
4985
|
+
widget_order?: string[];
|
|
4667
4986
|
};
|
|
4668
4987
|
capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
|
|
4669
4988
|
/**
|
|
@@ -4775,6 +5094,20 @@ declare namespace Components {
|
|
|
4775
5094
|
*/
|
|
4776
5095
|
SearchMappings;
|
|
4777
5096
|
group_headlines?: GroupHeadline[];
|
|
5097
|
+
/**
|
|
5098
|
+
* Dimensions that conditional variants of this entity type are keyed by.
|
|
5099
|
+
*
|
|
5100
|
+
* Absent or `null` means entities of this type are not conditional. Attributes whose
|
|
5101
|
+
* values a variant may override are marked with `variant_overridable`.
|
|
5102
|
+
*
|
|
5103
|
+
*/
|
|
5104
|
+
conditions?: /**
|
|
5105
|
+
* One dimension that conditional variants of an entity type are keyed by. `type`
|
|
5106
|
+
* discriminates the variants: only a `select` condition carries `values`, and only a
|
|
5107
|
+
* `location` condition carries `format`.
|
|
5108
|
+
*
|
|
5109
|
+
*/
|
|
5110
|
+
ConditionDefinition[] | null;
|
|
4778
5111
|
}
|
|
4779
5112
|
/**
|
|
4780
5113
|
* Whether to include deleted entities in the search results
|
|
@@ -4805,6 +5138,13 @@ declare namespace Components {
|
|
|
4805
5138
|
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
4806
5139
|
*/
|
|
4807
5140
|
hydrate?: boolean;
|
|
5141
|
+
/**
|
|
5142
|
+
* When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
|
|
5143
|
+
* addresses are generalized and well-known free-text fields are redacted.
|
|
5144
|
+
* Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
|
|
5145
|
+
*
|
|
5146
|
+
*/
|
|
5147
|
+
anonymize?: boolean;
|
|
4808
5148
|
fields?: /**
|
|
4809
5149
|
* List of entity fields to include or exclude in the response
|
|
4810
5150
|
*
|
|
@@ -4905,6 +5245,13 @@ declare namespace Components {
|
|
|
4905
5245
|
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
4906
5246
|
*/
|
|
4907
5247
|
hydrate?: boolean;
|
|
5248
|
+
/**
|
|
5249
|
+
* When true, anonymizes PII in the response: identifiers are replaced with deterministic pseudonyms,
|
|
5250
|
+
* addresses are generalized and well-known free-text fields are redacted.
|
|
5251
|
+
* Anonymization is forced (regardless of this parameter) when the access token was created with `anonymize: true`.
|
|
5252
|
+
*
|
|
5253
|
+
*/
|
|
5254
|
+
anonymize?: boolean;
|
|
4908
5255
|
fields?: /**
|
|
4909
5256
|
* List of entity fields to include or exclude in the response
|
|
4910
5257
|
*
|
|
@@ -5305,6 +5652,13 @@ declare namespace Components {
|
|
|
5305
5652
|
required?: boolean;
|
|
5306
5653
|
readonly?: boolean;
|
|
5307
5654
|
deprecated?: boolean;
|
|
5655
|
+
/**
|
|
5656
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
5657
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
5658
|
+
* fixed on the base entity.
|
|
5659
|
+
*
|
|
5660
|
+
*/
|
|
5661
|
+
variant_overridable?: boolean;
|
|
5308
5662
|
default_value?: any;
|
|
5309
5663
|
/**
|
|
5310
5664
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -5338,6 +5692,16 @@ declare namespace Components {
|
|
|
5338
5692
|
*
|
|
5339
5693
|
*/
|
|
5340
5694
|
render_condition?: string;
|
|
5695
|
+
/**
|
|
5696
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
5697
|
+
*
|
|
5698
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
5699
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
5700
|
+
*
|
|
5701
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
5702
|
+
*
|
|
5703
|
+
*/
|
|
5704
|
+
data_classification?: "public" | "pii";
|
|
5341
5705
|
_purpose?: /**
|
|
5342
5706
|
* example:
|
|
5343
5707
|
* taxonomy-slug:classification-slug
|
|
@@ -6182,6 +6546,13 @@ declare namespace Components {
|
|
|
6182
6546
|
required?: boolean;
|
|
6183
6547
|
readonly?: boolean;
|
|
6184
6548
|
deprecated?: boolean;
|
|
6549
|
+
/**
|
|
6550
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
6551
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
6552
|
+
* fixed on the base entity.
|
|
6553
|
+
*
|
|
6554
|
+
*/
|
|
6555
|
+
variant_overridable?: boolean;
|
|
6185
6556
|
default_value?: any;
|
|
6186
6557
|
/**
|
|
6187
6558
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6215,6 +6586,16 @@ declare namespace Components {
|
|
|
6215
6586
|
*
|
|
6216
6587
|
*/
|
|
6217
6588
|
render_condition?: string;
|
|
6589
|
+
/**
|
|
6590
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
6591
|
+
*
|
|
6592
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
6593
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
6594
|
+
*
|
|
6595
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
6596
|
+
*
|
|
6597
|
+
*/
|
|
6598
|
+
data_classification?: "public" | "pii";
|
|
6218
6599
|
_purpose?: /**
|
|
6219
6600
|
* example:
|
|
6220
6601
|
* taxonomy-slug:classification-slug
|
|
@@ -6374,6 +6755,13 @@ declare namespace Components {
|
|
|
6374
6755
|
required?: boolean;
|
|
6375
6756
|
readonly?: boolean;
|
|
6376
6757
|
deprecated?: boolean;
|
|
6758
|
+
/**
|
|
6759
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
6760
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
6761
|
+
* fixed on the base entity.
|
|
6762
|
+
*
|
|
6763
|
+
*/
|
|
6764
|
+
variant_overridable?: boolean;
|
|
6377
6765
|
default_value?: any;
|
|
6378
6766
|
/**
|
|
6379
6767
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6407,6 +6795,16 @@ declare namespace Components {
|
|
|
6407
6795
|
*
|
|
6408
6796
|
*/
|
|
6409
6797
|
render_condition?: string;
|
|
6798
|
+
/**
|
|
6799
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
6800
|
+
*
|
|
6801
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
6802
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
6803
|
+
*
|
|
6804
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
6805
|
+
*
|
|
6806
|
+
*/
|
|
6807
|
+
data_classification?: "public" | "pii";
|
|
6410
6808
|
_purpose?: /**
|
|
6411
6809
|
* example:
|
|
6412
6810
|
* taxonomy-slug:classification-slug
|
|
@@ -6566,6 +6964,13 @@ declare namespace Components {
|
|
|
6566
6964
|
required?: boolean;
|
|
6567
6965
|
readonly?: boolean;
|
|
6568
6966
|
deprecated?: boolean;
|
|
6967
|
+
/**
|
|
6968
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
6969
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
6970
|
+
* fixed on the base entity.
|
|
6971
|
+
*
|
|
6972
|
+
*/
|
|
6973
|
+
variant_overridable?: boolean;
|
|
6569
6974
|
default_value?: any;
|
|
6570
6975
|
/**
|
|
6571
6976
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6599,6 +7004,16 @@ declare namespace Components {
|
|
|
6599
7004
|
*
|
|
6600
7005
|
*/
|
|
6601
7006
|
render_condition?: string;
|
|
7007
|
+
/**
|
|
7008
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
7009
|
+
*
|
|
7010
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
7011
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
7012
|
+
*
|
|
7013
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
7014
|
+
*
|
|
7015
|
+
*/
|
|
7016
|
+
data_classification?: "public" | "pii";
|
|
6602
7017
|
_purpose?: /**
|
|
6603
7018
|
* example:
|
|
6604
7019
|
* taxonomy-slug:classification-slug
|
|
@@ -6766,6 +7181,13 @@ declare namespace Components {
|
|
|
6766
7181
|
required?: boolean;
|
|
6767
7182
|
readonly?: boolean;
|
|
6768
7183
|
deprecated?: boolean;
|
|
7184
|
+
/**
|
|
7185
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
7186
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7187
|
+
* fixed on the base entity.
|
|
7188
|
+
*
|
|
7189
|
+
*/
|
|
7190
|
+
variant_overridable?: boolean;
|
|
6769
7191
|
default_value?: any;
|
|
6770
7192
|
/**
|
|
6771
7193
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -6799,6 +7221,16 @@ declare namespace Components {
|
|
|
6799
7221
|
*
|
|
6800
7222
|
*/
|
|
6801
7223
|
render_condition?: string;
|
|
7224
|
+
/**
|
|
7225
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
7226
|
+
*
|
|
7227
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
7228
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
7229
|
+
*
|
|
7230
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
7231
|
+
*
|
|
7232
|
+
*/
|
|
7233
|
+
data_classification?: "public" | "pii";
|
|
6802
7234
|
_purpose?: /**
|
|
6803
7235
|
* example:
|
|
6804
7236
|
* taxonomy-slug:classification-slug
|
|
@@ -6938,6 +7370,42 @@ declare namespace Components {
|
|
|
6938
7370
|
hits?: number;
|
|
6939
7371
|
results?: /* A saved entity view */ SavedViewItem[];
|
|
6940
7372
|
}
|
|
7373
|
+
/**
|
|
7374
|
+
* A condition whose value identifies a place.
|
|
7375
|
+
*/
|
|
7376
|
+
export interface LocationConditionDefinition {
|
|
7377
|
+
/**
|
|
7378
|
+
* Stable identity of the condition, generated by the client when the condition is
|
|
7379
|
+
* created. It is what makes a rename distinguishable from a remove + add, so it must
|
|
7380
|
+
* be round-tripped unchanged for the lifetime of the condition.
|
|
7381
|
+
*
|
|
7382
|
+
* example:
|
|
7383
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
7384
|
+
*/
|
|
7385
|
+
id: string; // uuid
|
|
7386
|
+
/**
|
|
7387
|
+
* The key variant values are stored under. Unique within the schema and immutable
|
|
7388
|
+
* once the condition has been saved.
|
|
7389
|
+
*
|
|
7390
|
+
* example:
|
|
7391
|
+
* delivery_area
|
|
7392
|
+
*/
|
|
7393
|
+
name: string; // ^[a-z0-9_]+$
|
|
7394
|
+
/**
|
|
7395
|
+
* Display label. Always editable.
|
|
7396
|
+
* example:
|
|
7397
|
+
* Delivery Area
|
|
7398
|
+
*/
|
|
7399
|
+
label: string;
|
|
7400
|
+
/**
|
|
7401
|
+
* Immutable once the condition has been saved.
|
|
7402
|
+
*/
|
|
7403
|
+
type: "location";
|
|
7404
|
+
/**
|
|
7405
|
+
* The shape of the location value. Immutable once the condition has been saved.
|
|
7406
|
+
*/
|
|
7407
|
+
format?: "zipcode" | "zipcode_town";
|
|
7408
|
+
}
|
|
6941
7409
|
/**
|
|
6942
7410
|
* Strategy for auto-clearing a changeset on an `edit_mode: external` attribute
|
|
6943
7411
|
* when a direct write (`?direct=true`) arrives — typically an ERP inbound sync.
|
|
@@ -6977,6 +7445,13 @@ declare namespace Components {
|
|
|
6977
7445
|
required?: boolean;
|
|
6978
7446
|
readonly?: boolean;
|
|
6979
7447
|
deprecated?: boolean;
|
|
7448
|
+
/**
|
|
7449
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
7450
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7451
|
+
* fixed on the base entity.
|
|
7452
|
+
*
|
|
7453
|
+
*/
|
|
7454
|
+
variant_overridable?: boolean;
|
|
6980
7455
|
default_value?: any;
|
|
6981
7456
|
/**
|
|
6982
7457
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7010,6 +7485,16 @@ declare namespace Components {
|
|
|
7010
7485
|
*
|
|
7011
7486
|
*/
|
|
7012
7487
|
render_condition?: string;
|
|
7488
|
+
/**
|
|
7489
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
7490
|
+
*
|
|
7491
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
7492
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
7493
|
+
*
|
|
7494
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
7495
|
+
*
|
|
7496
|
+
*/
|
|
7497
|
+
data_classification?: "public" | "pii";
|
|
7013
7498
|
_purpose?: /**
|
|
7014
7499
|
* example:
|
|
7015
7500
|
* taxonomy-slug:classification-slug
|
|
@@ -7256,6 +7741,13 @@ declare namespace Components {
|
|
|
7256
7741
|
required?: boolean;
|
|
7257
7742
|
readonly?: boolean;
|
|
7258
7743
|
deprecated?: boolean;
|
|
7744
|
+
/**
|
|
7745
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
7746
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
7747
|
+
* fixed on the base entity.
|
|
7748
|
+
*
|
|
7749
|
+
*/
|
|
7750
|
+
variant_overridable?: boolean;
|
|
7259
7751
|
default_value?: any;
|
|
7260
7752
|
/**
|
|
7261
7753
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7289,6 +7781,16 @@ declare namespace Components {
|
|
|
7289
7781
|
*
|
|
7290
7782
|
*/
|
|
7291
7783
|
render_condition?: string;
|
|
7784
|
+
/**
|
|
7785
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
7786
|
+
*
|
|
7787
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
7788
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
7789
|
+
*
|
|
7790
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
7791
|
+
*
|
|
7792
|
+
*/
|
|
7793
|
+
data_classification?: "public" | "pii";
|
|
7292
7794
|
_purpose?: /**
|
|
7293
7795
|
* example:
|
|
7294
7796
|
* taxonomy-slug:classification-slug
|
|
@@ -7559,6 +8061,13 @@ declare namespace Components {
|
|
|
7559
8061
|
required?: boolean;
|
|
7560
8062
|
readonly?: boolean;
|
|
7561
8063
|
deprecated?: boolean;
|
|
8064
|
+
/**
|
|
8065
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
8066
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8067
|
+
* fixed on the base entity.
|
|
8068
|
+
*
|
|
8069
|
+
*/
|
|
8070
|
+
variant_overridable?: boolean;
|
|
7562
8071
|
default_value?: any;
|
|
7563
8072
|
/**
|
|
7564
8073
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7592,6 +8101,16 @@ declare namespace Components {
|
|
|
7592
8101
|
*
|
|
7593
8102
|
*/
|
|
7594
8103
|
render_condition?: string;
|
|
8104
|
+
/**
|
|
8105
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
8106
|
+
*
|
|
8107
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
8108
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
8109
|
+
*
|
|
8110
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
8111
|
+
*
|
|
8112
|
+
*/
|
|
8113
|
+
data_classification?: "public" | "pii";
|
|
7595
8114
|
_purpose?: /**
|
|
7596
8115
|
* example:
|
|
7597
8116
|
* taxonomy-slug:classification-slug
|
|
@@ -7760,6 +8279,13 @@ declare namespace Components {
|
|
|
7760
8279
|
required?: boolean;
|
|
7761
8280
|
readonly?: boolean;
|
|
7762
8281
|
deprecated?: boolean;
|
|
8282
|
+
/**
|
|
8283
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
8284
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8285
|
+
* fixed on the base entity.
|
|
8286
|
+
*
|
|
8287
|
+
*/
|
|
8288
|
+
variant_overridable?: boolean;
|
|
7763
8289
|
default_value?: any;
|
|
7764
8290
|
/**
|
|
7765
8291
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7793,6 +8319,16 @@ declare namespace Components {
|
|
|
7793
8319
|
*
|
|
7794
8320
|
*/
|
|
7795
8321
|
render_condition?: string;
|
|
8322
|
+
/**
|
|
8323
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
8324
|
+
*
|
|
8325
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
8326
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
8327
|
+
*
|
|
8328
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
8329
|
+
*
|
|
8330
|
+
*/
|
|
8331
|
+
data_classification?: "public" | "pii";
|
|
7796
8332
|
_purpose?: /**
|
|
7797
8333
|
* example:
|
|
7798
8334
|
* taxonomy-slug:classification-slug
|
|
@@ -7952,6 +8488,13 @@ declare namespace Components {
|
|
|
7952
8488
|
required?: boolean;
|
|
7953
8489
|
readonly?: boolean;
|
|
7954
8490
|
deprecated?: boolean;
|
|
8491
|
+
/**
|
|
8492
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
8493
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8494
|
+
* fixed on the base entity.
|
|
8495
|
+
*
|
|
8496
|
+
*/
|
|
8497
|
+
variant_overridable?: boolean;
|
|
7955
8498
|
default_value?: any;
|
|
7956
8499
|
/**
|
|
7957
8500
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -7985,6 +8528,16 @@ declare namespace Components {
|
|
|
7985
8528
|
*
|
|
7986
8529
|
*/
|
|
7987
8530
|
render_condition?: string;
|
|
8531
|
+
/**
|
|
8532
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
8533
|
+
*
|
|
8534
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
8535
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
8536
|
+
*
|
|
8537
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
8538
|
+
*
|
|
8539
|
+
*/
|
|
8540
|
+
data_classification?: "public" | "pii";
|
|
7988
8541
|
_purpose?: /**
|
|
7989
8542
|
* example:
|
|
7990
8543
|
* taxonomy-slug:classification-slug
|
|
@@ -8144,6 +8697,13 @@ declare namespace Components {
|
|
|
8144
8697
|
required?: boolean;
|
|
8145
8698
|
readonly?: boolean;
|
|
8146
8699
|
deprecated?: boolean;
|
|
8700
|
+
/**
|
|
8701
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
8702
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8703
|
+
* fixed on the base entity.
|
|
8704
|
+
*
|
|
8705
|
+
*/
|
|
8706
|
+
variant_overridable?: boolean;
|
|
8147
8707
|
default_value?: any;
|
|
8148
8708
|
/**
|
|
8149
8709
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8177,6 +8737,16 @@ declare namespace Components {
|
|
|
8177
8737
|
*
|
|
8178
8738
|
*/
|
|
8179
8739
|
render_condition?: string;
|
|
8740
|
+
/**
|
|
8741
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
8742
|
+
*
|
|
8743
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
8744
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
8745
|
+
*
|
|
8746
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
8747
|
+
*
|
|
8748
|
+
*/
|
|
8749
|
+
data_classification?: "public" | "pii";
|
|
8180
8750
|
_purpose?: /**
|
|
8181
8751
|
* example:
|
|
8182
8752
|
* taxonomy-slug:classification-slug
|
|
@@ -8336,6 +8906,13 @@ declare namespace Components {
|
|
|
8336
8906
|
required?: boolean;
|
|
8337
8907
|
readonly?: boolean;
|
|
8338
8908
|
deprecated?: boolean;
|
|
8909
|
+
/**
|
|
8910
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
8911
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
8912
|
+
* fixed on the base entity.
|
|
8913
|
+
*
|
|
8914
|
+
*/
|
|
8915
|
+
variant_overridable?: boolean;
|
|
8339
8916
|
default_value?: any;
|
|
8340
8917
|
/**
|
|
8341
8918
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8369,6 +8946,16 @@ declare namespace Components {
|
|
|
8369
8946
|
*
|
|
8370
8947
|
*/
|
|
8371
8948
|
render_condition?: string;
|
|
8949
|
+
/**
|
|
8950
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
8951
|
+
*
|
|
8952
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
8953
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
8954
|
+
*
|
|
8955
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
8956
|
+
*
|
|
8957
|
+
*/
|
|
8958
|
+
data_classification?: "public" | "pii";
|
|
8372
8959
|
_purpose?: /**
|
|
8373
8960
|
* example:
|
|
8374
8961
|
* taxonomy-slug:classification-slug
|
|
@@ -8528,6 +9115,13 @@ declare namespace Components {
|
|
|
8528
9115
|
required?: boolean;
|
|
8529
9116
|
readonly?: boolean;
|
|
8530
9117
|
deprecated?: boolean;
|
|
9118
|
+
/**
|
|
9119
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
9120
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9121
|
+
* fixed on the base entity.
|
|
9122
|
+
*
|
|
9123
|
+
*/
|
|
9124
|
+
variant_overridable?: boolean;
|
|
8531
9125
|
default_value?: any;
|
|
8532
9126
|
/**
|
|
8533
9127
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8561,6 +9155,16 @@ declare namespace Components {
|
|
|
8561
9155
|
*
|
|
8562
9156
|
*/
|
|
8563
9157
|
render_condition?: string;
|
|
9158
|
+
/**
|
|
9159
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
9160
|
+
*
|
|
9161
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
9162
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
9163
|
+
*
|
|
9164
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
9165
|
+
*
|
|
9166
|
+
*/
|
|
9167
|
+
data_classification?: "public" | "pii";
|
|
8564
9168
|
_purpose?: /**
|
|
8565
9169
|
* example:
|
|
8566
9170
|
* taxonomy-slug:classification-slug
|
|
@@ -8720,6 +9324,13 @@ declare namespace Components {
|
|
|
8720
9324
|
required?: boolean;
|
|
8721
9325
|
readonly?: boolean;
|
|
8722
9326
|
deprecated?: boolean;
|
|
9327
|
+
/**
|
|
9328
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
9329
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9330
|
+
* fixed on the base entity.
|
|
9331
|
+
*
|
|
9332
|
+
*/
|
|
9333
|
+
variant_overridable?: boolean;
|
|
8723
9334
|
default_value?: any;
|
|
8724
9335
|
/**
|
|
8725
9336
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8753,6 +9364,16 @@ declare namespace Components {
|
|
|
8753
9364
|
*
|
|
8754
9365
|
*/
|
|
8755
9366
|
render_condition?: string;
|
|
9367
|
+
/**
|
|
9368
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
9369
|
+
*
|
|
9370
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
9371
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
9372
|
+
*
|
|
9373
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
9374
|
+
*
|
|
9375
|
+
*/
|
|
9376
|
+
data_classification?: "public" | "pii";
|
|
8756
9377
|
_purpose?: /**
|
|
8757
9378
|
* example:
|
|
8758
9379
|
* taxonomy-slug:classification-slug
|
|
@@ -8912,6 +9533,13 @@ declare namespace Components {
|
|
|
8912
9533
|
required?: boolean;
|
|
8913
9534
|
readonly?: boolean;
|
|
8914
9535
|
deprecated?: boolean;
|
|
9536
|
+
/**
|
|
9537
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
9538
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9539
|
+
* fixed on the base entity.
|
|
9540
|
+
*
|
|
9541
|
+
*/
|
|
9542
|
+
variant_overridable?: boolean;
|
|
8915
9543
|
default_value?: any;
|
|
8916
9544
|
/**
|
|
8917
9545
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -8945,6 +9573,16 @@ declare namespace Components {
|
|
|
8945
9573
|
*
|
|
8946
9574
|
*/
|
|
8947
9575
|
render_condition?: string;
|
|
9576
|
+
/**
|
|
9577
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
9578
|
+
*
|
|
9579
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
9580
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
9581
|
+
*
|
|
9582
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
9583
|
+
*
|
|
9584
|
+
*/
|
|
9585
|
+
data_classification?: "public" | "pii";
|
|
8948
9586
|
_purpose?: /**
|
|
8949
9587
|
* example:
|
|
8950
9588
|
* taxonomy-slug:classification-slug
|
|
@@ -9104,6 +9742,13 @@ declare namespace Components {
|
|
|
9104
9742
|
required?: boolean;
|
|
9105
9743
|
readonly?: boolean;
|
|
9106
9744
|
deprecated?: boolean;
|
|
9745
|
+
/**
|
|
9746
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
9747
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9748
|
+
* fixed on the base entity.
|
|
9749
|
+
*
|
|
9750
|
+
*/
|
|
9751
|
+
variant_overridable?: boolean;
|
|
9107
9752
|
default_value?: any;
|
|
9108
9753
|
/**
|
|
9109
9754
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9137,6 +9782,16 @@ declare namespace Components {
|
|
|
9137
9782
|
*
|
|
9138
9783
|
*/
|
|
9139
9784
|
render_condition?: string;
|
|
9785
|
+
/**
|
|
9786
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
9787
|
+
*
|
|
9788
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
9789
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
9790
|
+
*
|
|
9791
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
9792
|
+
*
|
|
9793
|
+
*/
|
|
9794
|
+
data_classification?: "public" | "pii";
|
|
9140
9795
|
_purpose?: /**
|
|
9141
9796
|
* example:
|
|
9142
9797
|
* taxonomy-slug:classification-slug
|
|
@@ -9296,6 +9951,13 @@ declare namespace Components {
|
|
|
9296
9951
|
required?: boolean;
|
|
9297
9952
|
readonly?: boolean;
|
|
9298
9953
|
deprecated?: boolean;
|
|
9954
|
+
/**
|
|
9955
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
9956
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
9957
|
+
* fixed on the base entity.
|
|
9958
|
+
*
|
|
9959
|
+
*/
|
|
9960
|
+
variant_overridable?: boolean;
|
|
9299
9961
|
default_value?: any;
|
|
9300
9962
|
/**
|
|
9301
9963
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9329,6 +9991,16 @@ declare namespace Components {
|
|
|
9329
9991
|
*
|
|
9330
9992
|
*/
|
|
9331
9993
|
render_condition?: string;
|
|
9994
|
+
/**
|
|
9995
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
9996
|
+
*
|
|
9997
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
9998
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
9999
|
+
*
|
|
10000
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
10001
|
+
*
|
|
10002
|
+
*/
|
|
10003
|
+
data_classification?: "public" | "pii";
|
|
9332
10004
|
_purpose?: /**
|
|
9333
10005
|
* example:
|
|
9334
10006
|
* taxonomy-slug:classification-slug
|
|
@@ -9503,6 +10175,13 @@ declare namespace Components {
|
|
|
9503
10175
|
required?: boolean;
|
|
9504
10176
|
readonly?: boolean;
|
|
9505
10177
|
deprecated?: boolean;
|
|
10178
|
+
/**
|
|
10179
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
10180
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
10181
|
+
* fixed on the base entity.
|
|
10182
|
+
*
|
|
10183
|
+
*/
|
|
10184
|
+
variant_overridable?: boolean;
|
|
9506
10185
|
default_value?: any;
|
|
9507
10186
|
/**
|
|
9508
10187
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9536,6 +10215,16 @@ declare namespace Components {
|
|
|
9536
10215
|
*
|
|
9537
10216
|
*/
|
|
9538
10217
|
render_condition?: string;
|
|
10218
|
+
/**
|
|
10219
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
10220
|
+
*
|
|
10221
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
10222
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
10223
|
+
*
|
|
10224
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
10225
|
+
*
|
|
10226
|
+
*/
|
|
10227
|
+
data_classification?: "public" | "pii";
|
|
9539
10228
|
_purpose?: /**
|
|
9540
10229
|
* example:
|
|
9541
10230
|
* taxonomy-slug:classification-slug
|
|
@@ -9921,6 +10610,13 @@ declare namespace Components {
|
|
|
9921
10610
|
required?: boolean;
|
|
9922
10611
|
readonly?: boolean;
|
|
9923
10612
|
deprecated?: boolean;
|
|
10613
|
+
/**
|
|
10614
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
10615
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
10616
|
+
* fixed on the base entity.
|
|
10617
|
+
*
|
|
10618
|
+
*/
|
|
10619
|
+
variant_overridable?: boolean;
|
|
9924
10620
|
default_value?: any;
|
|
9925
10621
|
/**
|
|
9926
10622
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -9954,6 +10650,16 @@ declare namespace Components {
|
|
|
9954
10650
|
*
|
|
9955
10651
|
*/
|
|
9956
10652
|
render_condition?: string;
|
|
10653
|
+
/**
|
|
10654
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
10655
|
+
*
|
|
10656
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
10657
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
10658
|
+
*
|
|
10659
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
10660
|
+
*
|
|
10661
|
+
*/
|
|
10662
|
+
data_classification?: "public" | "pii";
|
|
9957
10663
|
_purpose?: /**
|
|
9958
10664
|
* example:
|
|
9959
10665
|
* taxonomy-slug:classification-slug
|
|
@@ -10125,6 +10831,12 @@ declare namespace Components {
|
|
|
10125
10831
|
* 10598
|
|
10126
10832
|
*/
|
|
10127
10833
|
user_id?: string;
|
|
10834
|
+
/**
|
|
10835
|
+
* The organization ID of the user who created the view. Used for partner access control.
|
|
10836
|
+
* example:
|
|
10837
|
+
* 739224
|
|
10838
|
+
*/
|
|
10839
|
+
org_id?: string;
|
|
10128
10840
|
} | {
|
|
10129
10841
|
[name: string]: any;
|
|
10130
10842
|
source?: "SYSTEM" | "BLUEPRINT";
|
|
@@ -10202,6 +10914,12 @@ declare namespace Components {
|
|
|
10202
10914
|
* 10598
|
|
10203
10915
|
*/
|
|
10204
10916
|
user_id?: string;
|
|
10917
|
+
/**
|
|
10918
|
+
* The organization ID of the user who created the view. Used for partner access control.
|
|
10919
|
+
* example:
|
|
10920
|
+
* 739224
|
|
10921
|
+
*/
|
|
10922
|
+
org_id?: string;
|
|
10205
10923
|
} | {
|
|
10206
10924
|
[name: string]: any;
|
|
10207
10925
|
source?: "SYSTEM" | "BLUEPRINT";
|
|
@@ -10272,6 +10990,12 @@ declare namespace Components {
|
|
|
10272
10990
|
* 10598
|
|
10273
10991
|
*/
|
|
10274
10992
|
user_id?: string;
|
|
10993
|
+
/**
|
|
10994
|
+
* The organization ID of the user who created the view. Used for partner access control.
|
|
10995
|
+
* example:
|
|
10996
|
+
* 739224
|
|
10997
|
+
*/
|
|
10998
|
+
org_id?: string;
|
|
10275
10999
|
} | {
|
|
10276
11000
|
[name: string]: any;
|
|
10277
11001
|
source?: "SYSTEM" | "BLUEPRINT";
|
|
@@ -10301,6 +11025,38 @@ declare namespace Components {
|
|
|
10301
11025
|
*/
|
|
10302
11026
|
shared_with?: string[];
|
|
10303
11027
|
}
|
|
11028
|
+
/**
|
|
11029
|
+
* A condition whose value is a plain scalar, with no further configuration.
|
|
11030
|
+
*/
|
|
11031
|
+
export interface ScalarConditionDefinition {
|
|
11032
|
+
/**
|
|
11033
|
+
* Stable identity of the condition, generated by the client when the condition is
|
|
11034
|
+
* created. It is what makes a rename distinguishable from a remove + add, so it must
|
|
11035
|
+
* be round-tripped unchanged for the lifetime of the condition.
|
|
11036
|
+
*
|
|
11037
|
+
* example:
|
|
11038
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
11039
|
+
*/
|
|
11040
|
+
id: string; // uuid
|
|
11041
|
+
/**
|
|
11042
|
+
* The key variant values are stored under. Unique within the schema and immutable
|
|
11043
|
+
* once the condition has been saved.
|
|
11044
|
+
*
|
|
11045
|
+
* example:
|
|
11046
|
+
* delivery_area
|
|
11047
|
+
*/
|
|
11048
|
+
name: string; // ^[a-z0-9_]+$
|
|
11049
|
+
/**
|
|
11050
|
+
* Display label. Always editable.
|
|
11051
|
+
* example:
|
|
11052
|
+
* Delivery Area
|
|
11053
|
+
*/
|
|
11054
|
+
label: string;
|
|
11055
|
+
/**
|
|
11056
|
+
* Immutable once the condition has been saved.
|
|
11057
|
+
*/
|
|
11058
|
+
type: "string" | "number" | "date" | "daterange" | "boolean";
|
|
11059
|
+
}
|
|
10304
11060
|
/**
|
|
10305
11061
|
* Generated uuid for schema
|
|
10306
11062
|
*/
|
|
@@ -10517,6 +11273,13 @@ declare namespace Components {
|
|
|
10517
11273
|
required?: boolean;
|
|
10518
11274
|
readonly?: boolean;
|
|
10519
11275
|
deprecated?: boolean;
|
|
11276
|
+
/**
|
|
11277
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
11278
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11279
|
+
* fixed on the base entity.
|
|
11280
|
+
*
|
|
11281
|
+
*/
|
|
11282
|
+
variant_overridable?: boolean;
|
|
10520
11283
|
default_value?: any;
|
|
10521
11284
|
/**
|
|
10522
11285
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10550,6 +11313,16 @@ declare namespace Components {
|
|
|
10550
11313
|
*
|
|
10551
11314
|
*/
|
|
10552
11315
|
render_condition?: string;
|
|
11316
|
+
/**
|
|
11317
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
11318
|
+
*
|
|
11319
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
11320
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
11321
|
+
*
|
|
11322
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
11323
|
+
*
|
|
11324
|
+
*/
|
|
11325
|
+
data_classification?: "public" | "pii";
|
|
10553
11326
|
_purpose?: /**
|
|
10554
11327
|
* example:
|
|
10555
11328
|
* taxonomy-slug:classification-slug
|
|
@@ -10689,6 +11462,47 @@ declare namespace Components {
|
|
|
10689
11462
|
*/
|
|
10690
11463
|
allow_any?: boolean;
|
|
10691
11464
|
}
|
|
11465
|
+
/**
|
|
11466
|
+
* A condition whose value is one of a fixed set of options.
|
|
11467
|
+
*/
|
|
11468
|
+
export interface SelectConditionDefinition {
|
|
11469
|
+
/**
|
|
11470
|
+
* Stable identity of the condition, generated by the client when the condition is
|
|
11471
|
+
* created. It is what makes a rename distinguishable from a remove + add, so it must
|
|
11472
|
+
* be round-tripped unchanged for the lifetime of the condition.
|
|
11473
|
+
*
|
|
11474
|
+
* example:
|
|
11475
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
11476
|
+
*/
|
|
11477
|
+
id: string; // uuid
|
|
11478
|
+
/**
|
|
11479
|
+
* The key variant values are stored under. Unique within the schema and immutable
|
|
11480
|
+
* once the condition has been saved.
|
|
11481
|
+
*
|
|
11482
|
+
* example:
|
|
11483
|
+
* delivery_area
|
|
11484
|
+
*/
|
|
11485
|
+
name: string; // ^[a-z0-9_]+$
|
|
11486
|
+
/**
|
|
11487
|
+
* Display label. Always editable.
|
|
11488
|
+
* example:
|
|
11489
|
+
* Delivery Area
|
|
11490
|
+
*/
|
|
11491
|
+
label: string;
|
|
11492
|
+
/**
|
|
11493
|
+
* Immutable once the condition has been saved.
|
|
11494
|
+
*/
|
|
11495
|
+
type: "select";
|
|
11496
|
+
/**
|
|
11497
|
+
* Selectable options. May be empty while the condition is being configured.
|
|
11498
|
+
* example:
|
|
11499
|
+
* [
|
|
11500
|
+
* "12_months",
|
|
11501
|
+
* "24_months"
|
|
11502
|
+
* ]
|
|
11503
|
+
*/
|
|
11504
|
+
values?: string[];
|
|
11505
|
+
}
|
|
10692
11506
|
/**
|
|
10693
11507
|
* Sequence of unique identifiers
|
|
10694
11508
|
*/
|
|
@@ -10717,6 +11531,13 @@ declare namespace Components {
|
|
|
10717
11531
|
required?: boolean;
|
|
10718
11532
|
readonly?: boolean;
|
|
10719
11533
|
deprecated?: boolean;
|
|
11534
|
+
/**
|
|
11535
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
11536
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11537
|
+
* fixed on the base entity.
|
|
11538
|
+
*
|
|
11539
|
+
*/
|
|
11540
|
+
variant_overridable?: boolean;
|
|
10720
11541
|
default_value?: any;
|
|
10721
11542
|
/**
|
|
10722
11543
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10750,6 +11571,16 @@ declare namespace Components {
|
|
|
10750
11571
|
*
|
|
10751
11572
|
*/
|
|
10752
11573
|
render_condition?: string;
|
|
11574
|
+
/**
|
|
11575
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
11576
|
+
*
|
|
11577
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
11578
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
11579
|
+
*
|
|
11580
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
11581
|
+
*
|
|
11582
|
+
*/
|
|
11583
|
+
data_classification?: "public" | "pii";
|
|
10753
11584
|
_purpose?: /**
|
|
10754
11585
|
* example:
|
|
10755
11586
|
* taxonomy-slug:classification-slug
|
|
@@ -10926,6 +11757,13 @@ declare namespace Components {
|
|
|
10926
11757
|
required?: boolean;
|
|
10927
11758
|
readonly?: boolean;
|
|
10928
11759
|
deprecated?: boolean;
|
|
11760
|
+
/**
|
|
11761
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
11762
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
11763
|
+
* fixed on the base entity.
|
|
11764
|
+
*
|
|
11765
|
+
*/
|
|
11766
|
+
variant_overridable?: boolean;
|
|
10929
11767
|
default_value?: any;
|
|
10930
11768
|
/**
|
|
10931
11769
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -10959,6 +11797,16 @@ declare namespace Components {
|
|
|
10959
11797
|
*
|
|
10960
11798
|
*/
|
|
10961
11799
|
render_condition?: string;
|
|
11800
|
+
/**
|
|
11801
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
11802
|
+
*
|
|
11803
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
11804
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
11805
|
+
*
|
|
11806
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
11807
|
+
*
|
|
11808
|
+
*/
|
|
11809
|
+
data_classification?: "public" | "pii";
|
|
10962
11810
|
_purpose?: /**
|
|
10963
11811
|
* example:
|
|
10964
11812
|
* taxonomy-slug:classification-slug
|
|
@@ -11214,6 +12062,13 @@ declare namespace Components {
|
|
|
11214
12062
|
required?: boolean;
|
|
11215
12063
|
readonly?: boolean;
|
|
11216
12064
|
deprecated?: boolean;
|
|
12065
|
+
/**
|
|
12066
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
12067
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12068
|
+
* fixed on the base entity.
|
|
12069
|
+
*
|
|
12070
|
+
*/
|
|
12071
|
+
variant_overridable?: boolean;
|
|
11217
12072
|
default_value?: any;
|
|
11218
12073
|
/**
|
|
11219
12074
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11247,6 +12102,16 @@ declare namespace Components {
|
|
|
11247
12102
|
*
|
|
11248
12103
|
*/
|
|
11249
12104
|
render_condition?: string;
|
|
12105
|
+
/**
|
|
12106
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
12107
|
+
*
|
|
12108
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
12109
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
12110
|
+
*
|
|
12111
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
12112
|
+
*
|
|
12113
|
+
*/
|
|
12114
|
+
data_classification?: "public" | "pii";
|
|
11250
12115
|
_purpose?: /**
|
|
11251
12116
|
* example:
|
|
11252
12117
|
* taxonomy-slug:classification-slug
|
|
@@ -11462,6 +12327,13 @@ declare namespace Components {
|
|
|
11462
12327
|
required?: boolean;
|
|
11463
12328
|
readonly?: boolean;
|
|
11464
12329
|
deprecated?: boolean;
|
|
12330
|
+
/**
|
|
12331
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
12332
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12333
|
+
* fixed on the base entity.
|
|
12334
|
+
*
|
|
12335
|
+
*/
|
|
12336
|
+
variant_overridable?: boolean;
|
|
11465
12337
|
default_value?: any;
|
|
11466
12338
|
/**
|
|
11467
12339
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11495,6 +12367,16 @@ declare namespace Components {
|
|
|
11495
12367
|
*
|
|
11496
12368
|
*/
|
|
11497
12369
|
render_condition?: string;
|
|
12370
|
+
/**
|
|
12371
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
12372
|
+
*
|
|
12373
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
12374
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
12375
|
+
*
|
|
12376
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
12377
|
+
*
|
|
12378
|
+
*/
|
|
12379
|
+
data_classification?: "public" | "pii";
|
|
11498
12380
|
_purpose?: /**
|
|
11499
12381
|
* example:
|
|
11500
12382
|
* taxonomy-slug:classification-slug
|
|
@@ -11811,7 +12693,7 @@ declare namespace Components {
|
|
|
11811
12693
|
*/
|
|
11812
12694
|
_manifest?: string /* uuid */[] | null;
|
|
11813
12695
|
}
|
|
11814
|
-
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";
|
|
12696
|
+
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";
|
|
11815
12697
|
/**
|
|
11816
12698
|
* Whether to include archived labels in the search results
|
|
11817
12699
|
* - `true`: include archived labels
|
|
@@ -11856,6 +12738,13 @@ declare namespace Components {
|
|
|
11856
12738
|
required?: boolean;
|
|
11857
12739
|
readonly?: boolean;
|
|
11858
12740
|
deprecated?: boolean;
|
|
12741
|
+
/**
|
|
12742
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
12743
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12744
|
+
* fixed on the base entity.
|
|
12745
|
+
*
|
|
12746
|
+
*/
|
|
12747
|
+
variant_overridable?: boolean;
|
|
11859
12748
|
default_value?: any;
|
|
11860
12749
|
/**
|
|
11861
12750
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -11889,6 +12778,16 @@ declare namespace Components {
|
|
|
11889
12778
|
*
|
|
11890
12779
|
*/
|
|
11891
12780
|
render_condition?: string;
|
|
12781
|
+
/**
|
|
12782
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
12783
|
+
*
|
|
12784
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
12785
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
12786
|
+
*
|
|
12787
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
12788
|
+
*
|
|
12789
|
+
*/
|
|
12790
|
+
data_classification?: "public" | "pii";
|
|
11892
12791
|
_purpose?: /**
|
|
11893
12792
|
* example:
|
|
11894
12793
|
* taxonomy-slug:classification-slug
|
|
@@ -12061,6 +12960,13 @@ declare namespace Components {
|
|
|
12061
12960
|
required?: boolean;
|
|
12062
12961
|
readonly?: boolean;
|
|
12063
12962
|
deprecated?: boolean;
|
|
12963
|
+
/**
|
|
12964
|
+
* Allow conditional variants of the entity to override this attribute's value.
|
|
12965
|
+
* Only meaningful on schemas that declare `conditions`. Unflagged attributes stay
|
|
12966
|
+
* fixed on the base entity.
|
|
12967
|
+
*
|
|
12968
|
+
*/
|
|
12969
|
+
variant_overridable?: boolean;
|
|
12064
12970
|
default_value?: any;
|
|
12065
12971
|
/**
|
|
12066
12972
|
* Which group the attribute should appear in. Accepts group ID or group name
|
|
@@ -12094,6 +13000,16 @@ declare namespace Components {
|
|
|
12094
13000
|
*
|
|
12095
13001
|
*/
|
|
12096
13002
|
render_condition?: string;
|
|
13003
|
+
/**
|
|
13004
|
+
* Data classification of the attribute, used by anonymized responses (`?anonymize=true` or tokens minted with `anonymize: true`).
|
|
13005
|
+
*
|
|
13006
|
+
* - `pii`: the attribute value is always anonymized in anonymized responses (use to opt in free-text fields containing personal data)
|
|
13007
|
+
* - `public`: the attribute value is never anonymized (use to opt out fields matched by built-in defaults, e.g. non-personal identifiers)
|
|
13008
|
+
*
|
|
13009
|
+
* When unset, built-in defaults apply based on the attribute type (email, phone, address, payment) and a curated list of well-known PII fields.
|
|
13010
|
+
*
|
|
13011
|
+
*/
|
|
13012
|
+
data_classification?: "public" | "pii";
|
|
12097
13013
|
_purpose?: /**
|
|
12098
13014
|
* example:
|
|
12099
13015
|
* taxonomy-slug:classification-slug
|
|
@@ -12229,6 +13145,45 @@ declare namespace Components {
|
|
|
12229
13145
|
}
|
|
12230
13146
|
}
|
|
12231
13147
|
declare namespace Paths {
|
|
13148
|
+
namespace AbortEntityImport {
|
|
13149
|
+
namespace Parameters {
|
|
13150
|
+
export type JobId = /**
|
|
13151
|
+
* The unique identifier of the import job.
|
|
13152
|
+
* example:
|
|
13153
|
+
* abc123
|
|
13154
|
+
*/
|
|
13155
|
+
Components.Schemas.ExportJobId;
|
|
13156
|
+
export type Schema = string;
|
|
13157
|
+
}
|
|
13158
|
+
export interface QueryParameters {
|
|
13159
|
+
job_id: Parameters.JobId;
|
|
13160
|
+
schema: Parameters.Schema;
|
|
13161
|
+
}
|
|
13162
|
+
namespace Responses {
|
|
13163
|
+
export interface $202 {
|
|
13164
|
+
/**
|
|
13165
|
+
* The job status at the time of the request.
|
|
13166
|
+
*/
|
|
13167
|
+
status?: string;
|
|
13168
|
+
jobPollId?: string;
|
|
13169
|
+
}
|
|
13170
|
+
export interface $400 {
|
|
13171
|
+
}
|
|
13172
|
+
export interface $403 {
|
|
13173
|
+
}
|
|
13174
|
+
export interface $404 {
|
|
13175
|
+
}
|
|
13176
|
+
export type $429 = /**
|
|
13177
|
+
* A generic error returned by the API
|
|
13178
|
+
* example:
|
|
13179
|
+
* {
|
|
13180
|
+
* "status": 429,
|
|
13181
|
+
* "error": "Too many requests. Try again later."
|
|
13182
|
+
* }
|
|
13183
|
+
*/
|
|
13184
|
+
Components.Responses.TooManyRequestsError;
|
|
13185
|
+
}
|
|
13186
|
+
}
|
|
12232
13187
|
namespace AddRelations {
|
|
12233
13188
|
namespace Parameters {
|
|
12234
13189
|
export type ActivityId = /**
|
|
@@ -12383,6 +13338,7 @@ declare namespace Paths {
|
|
|
12383
13338
|
}
|
|
12384
13339
|
namespace Autocomplete {
|
|
12385
13340
|
namespace Parameters {
|
|
13341
|
+
export type Anonymize = boolean;
|
|
12386
13342
|
/**
|
|
12387
13343
|
* example:
|
|
12388
13344
|
* _tags
|
|
@@ -12398,6 +13354,7 @@ declare namespace Paths {
|
|
|
12398
13354
|
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12399
13355
|
}
|
|
12400
13356
|
export interface QueryParameters {
|
|
13357
|
+
anonymize?: Parameters.Anonymize;
|
|
12401
13358
|
input?: Parameters.Input;
|
|
12402
13359
|
attribute: /**
|
|
12403
13360
|
* example:
|
|
@@ -12913,6 +13870,15 @@ declare namespace Paths {
|
|
|
12913
13870
|
namespace Responses {
|
|
12914
13871
|
export interface $200 {
|
|
12915
13872
|
}
|
|
13873
|
+
export type $404 = /**
|
|
13874
|
+
* A generic error returned by the API
|
|
13875
|
+
* example:
|
|
13876
|
+
* {
|
|
13877
|
+
* "status": 404,
|
|
13878
|
+
* "error": "Not Found"
|
|
13879
|
+
* }
|
|
13880
|
+
*/
|
|
13881
|
+
Components.Responses.NotFoundError;
|
|
12916
13882
|
export type $429 = /**
|
|
12917
13883
|
* A generic error returned by the API
|
|
12918
13884
|
* example:
|
|
@@ -13254,6 +14220,7 @@ declare namespace Paths {
|
|
|
13254
14220
|
}
|
|
13255
14221
|
namespace GetActivity {
|
|
13256
14222
|
namespace Parameters {
|
|
14223
|
+
export type Anonymize = boolean;
|
|
13257
14224
|
export type Id = /**
|
|
13258
14225
|
* See https://github.com/ulid/spec
|
|
13259
14226
|
* example:
|
|
@@ -13267,6 +14234,7 @@ declare namespace Paths {
|
|
|
13267
14234
|
id: Parameters.Id;
|
|
13268
14235
|
}
|
|
13269
14236
|
export interface QueryParameters {
|
|
14237
|
+
anonymize?: Parameters.Anonymize;
|
|
13270
14238
|
operations_size?: Parameters.OperationsSize;
|
|
13271
14239
|
operations_from?: Parameters.OperationsFrom;
|
|
13272
14240
|
}
|
|
@@ -13285,6 +14253,7 @@ declare namespace Paths {
|
|
|
13285
14253
|
}
|
|
13286
14254
|
namespace GetEntity {
|
|
13287
14255
|
namespace Parameters {
|
|
14256
|
+
export type Anonymize = boolean;
|
|
13288
14257
|
export type Hydrate = boolean;
|
|
13289
14258
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
13290
14259
|
export type Slug = /**
|
|
@@ -13300,6 +14269,7 @@ declare namespace Paths {
|
|
|
13300
14269
|
}
|
|
13301
14270
|
export interface QueryParameters {
|
|
13302
14271
|
hydrate?: Parameters.Hydrate;
|
|
14272
|
+
anonymize?: Parameters.Anonymize;
|
|
13303
14273
|
}
|
|
13304
14274
|
namespace Responses {
|
|
13305
14275
|
export interface $200 {
|
|
@@ -13412,6 +14382,7 @@ declare namespace Paths {
|
|
|
13412
14382
|
namespace GetEntityActivityFeed {
|
|
13413
14383
|
namespace Parameters {
|
|
13414
14384
|
export type After = string; // date-time
|
|
14385
|
+
export type Anonymize = boolean;
|
|
13415
14386
|
export type Before = string; // date-time
|
|
13416
14387
|
export type EndDate = string; // date-time
|
|
13417
14388
|
/**
|
|
@@ -13449,6 +14420,7 @@ declare namespace Paths {
|
|
|
13449
14420
|
id: Parameters.Id;
|
|
13450
14421
|
}
|
|
13451
14422
|
export interface QueryParameters {
|
|
14423
|
+
anonymize?: Parameters.Anonymize;
|
|
13452
14424
|
after?: Parameters.After /* date-time */;
|
|
13453
14425
|
before?: Parameters.Before /* date-time */;
|
|
13454
14426
|
start_date?: Parameters.StartDate /* date-time */;
|
|
@@ -13497,6 +14469,7 @@ declare namespace Paths {
|
|
|
13497
14469
|
}
|
|
13498
14470
|
namespace GetEntityV2 {
|
|
13499
14471
|
namespace Parameters {
|
|
14472
|
+
export type Anonymize = boolean;
|
|
13500
14473
|
export type ApplyChangesets = boolean;
|
|
13501
14474
|
export type Fields = /**
|
|
13502
14475
|
* List of entity fields to include or exclude in the response
|
|
@@ -13531,6 +14504,7 @@ declare namespace Paths {
|
|
|
13531
14504
|
}
|
|
13532
14505
|
export interface QueryParameters {
|
|
13533
14506
|
hydrate?: Parameters.Hydrate;
|
|
14507
|
+
anonymize?: Parameters.Anonymize;
|
|
13534
14508
|
fields?: Parameters.Fields;
|
|
13535
14509
|
apply_changesets?: Parameters.ApplyChangesets;
|
|
13536
14510
|
}
|
|
@@ -13951,6 +14925,7 @@ declare namespace Paths {
|
|
|
13951
14925
|
}
|
|
13952
14926
|
namespace GetRelations {
|
|
13953
14927
|
namespace Parameters {
|
|
14928
|
+
export type Anonymize = boolean;
|
|
13954
14929
|
export type ExcludeSchemas = /**
|
|
13955
14930
|
* URL-friendly identifier for the entity schema
|
|
13956
14931
|
* example:
|
|
@@ -13981,6 +14956,7 @@ declare namespace Paths {
|
|
|
13981
14956
|
}
|
|
13982
14957
|
export interface QueryParameters {
|
|
13983
14958
|
hydrate?: Parameters.Hydrate;
|
|
14959
|
+
anonymize?: Parameters.Anonymize;
|
|
13984
14960
|
include_reverse?: Parameters.IncludeReverse;
|
|
13985
14961
|
from?: Parameters.From;
|
|
13986
14962
|
size?: Parameters.Size;
|
|
@@ -14002,6 +14978,7 @@ declare namespace Paths {
|
|
|
14002
14978
|
}
|
|
14003
14979
|
namespace GetRelationsV2 {
|
|
14004
14980
|
namespace Parameters {
|
|
14981
|
+
export type Anonymize = boolean;
|
|
14005
14982
|
export type Fields = /**
|
|
14006
14983
|
* List of entity fields to include or exclude in the response
|
|
14007
14984
|
*
|
|
@@ -14039,6 +15016,7 @@ declare namespace Paths {
|
|
|
14039
15016
|
}
|
|
14040
15017
|
export interface QueryParameters {
|
|
14041
15018
|
hydrate?: Parameters.Hydrate;
|
|
15019
|
+
anonymize?: Parameters.Anonymize;
|
|
14042
15020
|
query?: Parameters.Query;
|
|
14043
15021
|
include_reverse?: Parameters.IncludeReverse;
|
|
14044
15022
|
from?: Parameters.From;
|
|
@@ -14060,6 +15038,7 @@ declare namespace Paths {
|
|
|
14060
15038
|
}
|
|
14061
15039
|
namespace GetRelationsV3 {
|
|
14062
15040
|
namespace Parameters {
|
|
15041
|
+
export type Anonymize = boolean;
|
|
14063
15042
|
export type ExcludeSchemas = /**
|
|
14064
15043
|
* URL-friendly identifier for the entity schema
|
|
14065
15044
|
* example:
|
|
@@ -14119,6 +15098,7 @@ declare namespace Paths {
|
|
|
14119
15098
|
}
|
|
14120
15099
|
export interface QueryParameters {
|
|
14121
15100
|
hydrate?: Parameters.Hydrate;
|
|
15101
|
+
anonymize?: Parameters.Anonymize;
|
|
14122
15102
|
include_reverse?: Parameters.IncludeReverse;
|
|
14123
15103
|
from?: Parameters.From;
|
|
14124
15104
|
size?: Parameters.Size;
|
|
@@ -14437,7 +15417,7 @@ declare namespace Paths {
|
|
|
14437
15417
|
/**
|
|
14438
15418
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
14439
15419
|
* example:
|
|
14440
|
-
* 2023-01-01T00:00:
|
|
15420
|
+
* 2023-01-01T00:00:00.000Z
|
|
14441
15421
|
*/
|
|
14442
15422
|
export type CreatedAfter = string; // date-time
|
|
14443
15423
|
/**
|
|
@@ -14463,7 +15443,7 @@ declare namespace Paths {
|
|
|
14463
15443
|
created_after?: /**
|
|
14464
15444
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
14465
15445
|
* example:
|
|
14466
|
-
* 2023-01-01T00:00:
|
|
15446
|
+
* 2023-01-01T00:00:00.000Z
|
|
14467
15447
|
*/
|
|
14468
15448
|
Parameters.CreatedAfter /* date-time */;
|
|
14469
15449
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -14552,6 +15532,7 @@ declare namespace Paths {
|
|
|
14552
15532
|
}
|
|
14553
15533
|
namespace ListChangesets {
|
|
14554
15534
|
namespace Parameters {
|
|
15535
|
+
export type Anonymize = boolean;
|
|
14555
15536
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
14556
15537
|
export type Slug = /**
|
|
14557
15538
|
* URL-friendly identifier for the entity schema
|
|
@@ -14564,6 +15545,9 @@ declare namespace Paths {
|
|
|
14564
15545
|
slug: Parameters.Slug;
|
|
14565
15546
|
id: Parameters.Id;
|
|
14566
15547
|
}
|
|
15548
|
+
export interface QueryParameters {
|
|
15549
|
+
anonymize?: Parameters.Anonymize;
|
|
15550
|
+
}
|
|
14567
15551
|
namespace Responses {
|
|
14568
15552
|
export type $200 = /* Map of attribute name to pending changeset. At most one changeset per attribute. */ Components.Schemas.ChangesetMap;
|
|
14569
15553
|
export type $404 = /**
|
|
@@ -14620,6 +15604,7 @@ declare namespace Paths {
|
|
|
14620
15604
|
*/
|
|
14621
15605
|
Components.Schemas.FieldsParam;
|
|
14622
15606
|
export type From = number;
|
|
15607
|
+
export type Q = string;
|
|
14623
15608
|
export type Size = number;
|
|
14624
15609
|
export type Slug = /**
|
|
14625
15610
|
* URL-friendly identifier for the entity schema
|
|
@@ -14634,6 +15619,7 @@ declare namespace Paths {
|
|
|
14634
15619
|
sort?: Parameters.Sort;
|
|
14635
15620
|
from?: Parameters.From;
|
|
14636
15621
|
size?: Parameters.Size;
|
|
15622
|
+
q?: Parameters.Q;
|
|
14637
15623
|
fields?: Parameters.Fields;
|
|
14638
15624
|
}
|
|
14639
15625
|
namespace Responses {
|
|
@@ -16516,7 +17502,7 @@ interface OperationMethods {
|
|
|
16516
17502
|
* Returns all pending changesets for an entity.
|
|
16517
17503
|
*/
|
|
16518
17504
|
'listChangesets'(
|
|
16519
|
-
parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
|
|
17505
|
+
parameters?: Parameters<Paths.ListChangesets.QueryParameters & Paths.ListChangesets.PathParameters> | null,
|
|
16520
17506
|
data?: any,
|
|
16521
17507
|
config?: AxiosRequestConfig
|
|
16522
17508
|
): OperationResponse<Paths.ListChangesets.Responses.$200>
|
|
@@ -16654,6 +17640,25 @@ interface OperationMethods {
|
|
|
16654
17640
|
data?: Paths.ImportEntities.RequestBody,
|
|
16655
17641
|
config?: AxiosRequestConfig
|
|
16656
17642
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
17643
|
+
/**
|
|
17644
|
+
* abortEntityImport - Abort a running entity import
|
|
17645
|
+
*
|
|
17646
|
+
* Asks a running import to stop. Rows already imported are **kept** - this is a stop, not a
|
|
17647
|
+
* rollback - and the job still produces its result reports for everything that landed before
|
|
17648
|
+
* the stop, then reaches the terminal status `CANCELLED`.
|
|
17649
|
+
*
|
|
17650
|
+
* The stop is cooperative: the worker notices the request at its next batch boundary, so the
|
|
17651
|
+
* job typically reaches `CANCELLED` within seconds. Poll `POST /v1/entity:import` with the
|
|
17652
|
+
* `job_id` as usual to observe it.
|
|
17653
|
+
*
|
|
17654
|
+
* Idempotent - aborting an already-aborted or already-finished job is not an error.
|
|
17655
|
+
*
|
|
17656
|
+
*/
|
|
17657
|
+
'abortEntityImport'(
|
|
17658
|
+
parameters?: Parameters<Paths.AbortEntityImport.QueryParameters> | null,
|
|
17659
|
+
data?: any,
|
|
17660
|
+
config?: AxiosRequestConfig
|
|
17661
|
+
): OperationResponse<Paths.AbortEntityImport.Responses.$202>
|
|
16657
17662
|
/**
|
|
16658
17663
|
* listSavedViews - listSavedViews
|
|
16659
17664
|
*
|
|
@@ -17750,7 +18755,7 @@ interface PathsDictionary {
|
|
|
17750
18755
|
* Returns all pending changesets for an entity.
|
|
17751
18756
|
*/
|
|
17752
18757
|
'get'(
|
|
17753
|
-
parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
|
|
18758
|
+
parameters?: Parameters<Paths.ListChangesets.QueryParameters & Paths.ListChangesets.PathParameters> | null,
|
|
17754
18759
|
data?: any,
|
|
17755
18760
|
config?: AxiosRequestConfig
|
|
17756
18761
|
): OperationResponse<Paths.ListChangesets.Responses.$200>
|
|
@@ -17905,6 +18910,27 @@ interface PathsDictionary {
|
|
|
17905
18910
|
config?: AxiosRequestConfig
|
|
17906
18911
|
): OperationResponse<Paths.ImportEntities.Responses.$201>
|
|
17907
18912
|
}
|
|
18913
|
+
['/v1/entity:abortImport']: {
|
|
18914
|
+
/**
|
|
18915
|
+
* abortEntityImport - Abort a running entity import
|
|
18916
|
+
*
|
|
18917
|
+
* Asks a running import to stop. Rows already imported are **kept** - this is a stop, not a
|
|
18918
|
+
* rollback - and the job still produces its result reports for everything that landed before
|
|
18919
|
+
* the stop, then reaches the terminal status `CANCELLED`.
|
|
18920
|
+
*
|
|
18921
|
+
* The stop is cooperative: the worker notices the request at its next batch boundary, so the
|
|
18922
|
+
* job typically reaches `CANCELLED` within seconds. Poll `POST /v1/entity:import` with the
|
|
18923
|
+
* `job_id` as usual to observe it.
|
|
18924
|
+
*
|
|
18925
|
+
* Idempotent - aborting an already-aborted or already-finished job is not an error.
|
|
18926
|
+
*
|
|
18927
|
+
*/
|
|
18928
|
+
'post'(
|
|
18929
|
+
parameters?: Parameters<Paths.AbortEntityImport.QueryParameters> | null,
|
|
18930
|
+
data?: any,
|
|
18931
|
+
config?: AxiosRequestConfig
|
|
18932
|
+
): OperationResponse<Paths.AbortEntityImport.Responses.$202>
|
|
18933
|
+
}
|
|
17908
18934
|
['/v1/entity/views']: {
|
|
17909
18935
|
/**
|
|
17910
18936
|
* listSavedViews - listSavedViews
|
|
@@ -18412,6 +19438,7 @@ type AttributeWithCompositeID = Components.Schemas.AttributeWithCompositeID;
|
|
|
18412
19438
|
type AutomationAttribute = Components.Schemas.AutomationAttribute;
|
|
18413
19439
|
type BaseActivityItem = Components.Schemas.BaseActivityItem;
|
|
18414
19440
|
type BaseAttribute = Components.Schemas.BaseAttribute;
|
|
19441
|
+
type BaseConditionDefinition = Components.Schemas.BaseConditionDefinition;
|
|
18415
19442
|
type BaseEntity = Components.Schemas.BaseEntity;
|
|
18416
19443
|
type BlueprintEntityId = Components.Schemas.BlueprintEntityId;
|
|
18417
19444
|
type BooleanAttribute = Components.Schemas.BooleanAttribute;
|
|
@@ -18423,6 +19450,7 @@ type ClassificationIdOrPattern = Components.Schemas.ClassificationIdOrPattern;
|
|
|
18423
19450
|
type ClassificationSlug = Components.Schemas.ClassificationSlug;
|
|
18424
19451
|
type ClassificationsUpdate = Components.Schemas.ClassificationsUpdate;
|
|
18425
19452
|
type ComputedAttribute = Components.Schemas.ComputedAttribute;
|
|
19453
|
+
type ConditionDefinition = Components.Schemas.ConditionDefinition;
|
|
18426
19454
|
type ConsentAttribute = Components.Schemas.ConsentAttribute;
|
|
18427
19455
|
type CountryAttribute = Components.Schemas.CountryAttribute;
|
|
18428
19456
|
type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
|
|
@@ -18445,6 +19473,7 @@ type EntityImportParams = Components.Schemas.EntityImportParams;
|
|
|
18445
19473
|
type EntityItem = Components.Schemas.EntityItem;
|
|
18446
19474
|
type EntityListParams = Components.Schemas.EntityListParams;
|
|
18447
19475
|
type EntityOperation = Components.Schemas.EntityOperation;
|
|
19476
|
+
type EntityOperationSourceContext = Components.Schemas.EntityOperationSourceContext;
|
|
18448
19477
|
type EntityOwner = Components.Schemas.EntityOwner;
|
|
18449
19478
|
type EntitySchema = Components.Schemas.EntitySchema;
|
|
18450
19479
|
type EntitySchemaGroup = Components.Schemas.EntitySchemaGroup;
|
|
@@ -18493,6 +19522,7 @@ type IsTemplate = Components.Schemas.IsTemplate;
|
|
|
18493
19522
|
type Language = Components.Schemas.Language;
|
|
18494
19523
|
type LinkAttribute = Components.Schemas.LinkAttribute;
|
|
18495
19524
|
type ListSavedViewsResults = Components.Schemas.ListSavedViewsResults;
|
|
19525
|
+
type LocationConditionDefinition = Components.Schemas.LocationConditionDefinition;
|
|
18496
19526
|
type MatchStrategy = Components.Schemas.MatchStrategy;
|
|
18497
19527
|
type MessageEmailAddressAttribute = Components.Schemas.MessageEmailAddressAttribute;
|
|
18498
19528
|
type MeterReadingChangesetEntry = Components.Schemas.MeterReadingChangesetEntry;
|
|
@@ -18517,11 +19547,13 @@ type SavedView = Components.Schemas.SavedView;
|
|
|
18517
19547
|
type SavedViewId = Components.Schemas.SavedViewId;
|
|
18518
19548
|
type SavedViewItem = Components.Schemas.SavedViewItem;
|
|
18519
19549
|
type SavedViewPartial = Components.Schemas.SavedViewPartial;
|
|
19550
|
+
type ScalarConditionDefinition = Components.Schemas.ScalarConditionDefinition;
|
|
18520
19551
|
type SchemaId = Components.Schemas.SchemaId;
|
|
18521
19552
|
type SearchFilter = Components.Schemas.SearchFilter;
|
|
18522
19553
|
type SearchFilterValue = Components.Schemas.SearchFilterValue;
|
|
18523
19554
|
type SearchMappings = Components.Schemas.SearchMappings;
|
|
18524
19555
|
type SelectAttribute = Components.Schemas.SelectAttribute;
|
|
19556
|
+
type SelectConditionDefinition = Components.Schemas.SelectConditionDefinition;
|
|
18525
19557
|
type SequenceAttribute = Components.Schemas.SequenceAttribute;
|
|
18526
19558
|
type SettingFlag = Components.Schemas.SettingFlag;
|
|
18527
19559
|
type StatusAttribute = Components.Schemas.StatusAttribute;
|
|
@@ -18541,4 +19573,4 @@ type TaxonomySlug = Components.Schemas.TaxonomySlug;
|
|
|
18541
19573
|
type TextAttribute = Components.Schemas.TextAttribute;
|
|
18542
19574
|
type UserRelationAttribute = Components.Schemas.UserRelationAttribute;
|
|
18543
19575
|
|
|
18544
|
-
export { type
|
|
19576
|
+
export { type EntityOwner as $, type Activity as A, type BaseActivityItem as B, type Client as C, type CountryAttribute as D, type CurrencyAttribute as E, type DateAttribute as F, type DefaultAddressFields as G, type ESClusterAssignment as H, type EditMode as I, type EditModeConfig as J, type EmailAttribute as K, type Entity as L, type EntityAcl as M, type EntityAction as N, type OperationMethods as O, Paths as P, type EntityCapability as Q, type EntityCapabilityWithCompositeID as R, type EntityDefaultCreate as S, type EntityDefaultEdit as T, type EntityDefaultTable as U, type EntityId as V, type EntityImportParams as W, type EntityItem as X, type EntityListParams as Y, type EntityOperation as Z, type EntityOperationSourceContext as _, Components as a, type RedirectEntityView as a$, type EntitySchema as a0, type EntitySchemaGroup as a1, type EntitySchemaGroupWithCompositeID as a2, type EntitySchemaItem as a3, type EntitySearchIncludeDeletedParam as a4, type EntitySearchOptions as a5, type EntitySearchParams as a6, type EntitySearchResults as a7, type EntitySlug as a8, type EntityTableFilterOption as a9, type GroupHeadline as aA, type GroupHeadlineWithCompositeID as aB, type HydratedEntity as aC, type HydratedEntityItem as aD, type InternalAttribute as aE, type InternalUserAttribute as aF, type InvitationEmailAttribute as aG, type IsTemplate as aH, type Language as aI, type LinkAttribute as aJ, type ListSavedViewsResults as aK, type LocationConditionDefinition as aL, type MatchStrategy as aM, type MessageEmailAddressAttribute as aN, type MeterReadingChangesetEntry as aO, type MultiSelectAttribute as aP, type NullableEntity as aQ, type NumberAttribute as aR, type OrderedListAttribute as aS, type PartnerOrganisationAttribute as aT, type PartnerStatusAttribute as aU, type PaymentAttribute as aV, type PaymentMethodRelationAttribute as aW, type PhoneAttribute as aX, type PortalAccessAttribute as aY, type PriceComponentAttribute as aZ, type PurposeAttribute as a_, type EntityTableFilterSearch as aa, type EntityValidationError as ab, type EntityValidationResult as ac, type EntityValidationResultError as ad, type EntityValidationResultSuccess as ae, type EntityValidationV2Error as af, type EntityValidationV2Result as ag, type EntityValidationV2ResultError as ah, type EntityValidationV2ResultSuccess as ai, type EntityViewDisabled as aj, type ErrorObject as ak, type ExportJobId as al, type FieldsParam as am, type FileAttribute as an, type FuzzyConfig as ao, type GenerateEntityTableAIFiltersRequest as ap, type GenerateEntityTableAIFiltersResponse as aq, GetRelatedEntitiesCount as ar, type GetRelationsResp as as, type GetRelationsRespWithPagination as at, type GraphDefinition as au, type GraphEdge as av, type GraphNode as aw, type GraphQueryRequest as ax, type GraphQueryResponse as ay, type GraphSeed as az, type PathsDictionary as b, type RelationAttribute as b0, type RelationEntity as b1, type RelationItem as b2, type RepeatableAttribute as b3, type SavedView as b4, type SavedViewId as b5, type SavedViewItem as b6, type SavedViewPartial as b7, type ScalarConditionDefinition as b8, type SchemaId as b9, type SearchFilter as ba, type SearchFilterValue as bb, type SearchMappings as bc, type SelectAttribute as bd, type SelectConditionDefinition as be, type SequenceAttribute as bf, type SettingFlag as bg, type StatusAttribute as bh, type SummaryAttribute as bi, type SummaryField as bj, type TableAttribute as bk, type TagsAttribute as bl, type Taxonomy as bm, type TaxonomyBulkJob as bn, type TaxonomyBulkJobActionType as bo, type TaxonomyBulkJobStatus as bp, type TaxonomyBulkJobTriggerResponse as bq, type TaxonomyClassification as br, type TaxonomyLocationId as bs, type TaxonomySearchIncludeArchivedParam as bt, type TaxonomySlug as bu, type TextAttribute as bv, type UserRelationAttribute as bw, type ActivityCallerContext as c, type ActivityId as d, type ActivityItem as e, type ActivityType as f, type AddressAttribute as g, type AddressRelationAttribute as h, type Attribute as i, type AttributeWithCompositeID as j, type AutomationAttribute as k, type BaseAttribute as l, type BaseConditionDefinition as m, type BaseEntity as n, type BlueprintEntityId as o, type BooleanAttribute as p, type Changeset as q, type ChangesetCreator as r, type ChangesetMap as s, type ClassificationId as t, type ClassificationIdOrPattern as u, type ClassificationSlug as v, type ClassificationsUpdate as w, type ComputedAttribute as x, type ConditionDefinition as y, type ConsentAttribute as z };
|