@epilot/sdk 2.3.10 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/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/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/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-W7YCS4FU.js → chunk-DAFBUTK6.js} +2 -2
- package/dist/chunk-M6Z6ES3I.js +14 -0
- package/dist/chunk-UBQCDPW6.cjs +14 -0
- package/dist/{chunk-MDLNRFJV.cjs → chunk-Z33PZNHV.cjs} +2 -2
- package/dist/entity-VDUN7SYC.cjs +7 -0
- package/dist/entity-WWM2Z7BU.js +7 -0
- package/dist/entity-runtime-3J5EDLXP.cjs +5 -0
- package/dist/{entity-runtime-D4DV5XRM.js → entity-runtime-LNAZILIN.js} +1 -1
- package/dist/{entity.d-ByufVI16.d.cts → entity.d-B43ezu-V.d.cts} +1336 -9
- package/dist/{entity.d-ByufVI16.d.ts → entity.d-B43ezu-V.d.ts} +1336 -9
- 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 +965 -39
- package/package.json +1 -1
- package/definitions/access-token-runtime.json +0 -1
- package/definitions/access-token.json +0 -663
- package/definitions/address-runtime.json +0 -1
- package/definitions/address-suggestions-runtime.json +0 -1
- package/definitions/address-suggestions.json +0 -582
- package/definitions/address.json +0 -578
- package/definitions/ai-agents-runtime.json +0 -1
- package/definitions/ai-agents.json +0 -1711
- package/definitions/app-runtime.json +0 -1
- package/definitions/app.json +0 -4493
- package/definitions/audit-logs-runtime.json +0 -1
- package/definitions/audit-logs.json +0 -305
- package/definitions/automation-runtime.json +0 -1
- package/definitions/automation.json +0 -5028
- package/definitions/billing-runtime.json +0 -1
- package/definitions/billing.json +0 -837
- package/definitions/blueprint-manifest-runtime.json +0 -1
- package/definitions/blueprint-manifest.json +0 -4846
- package/definitions/configuration-hub-runtime.json +0 -1
- package/definitions/configuration-hub.json +0 -611
- package/definitions/consent-runtime.json +0 -1
- package/definitions/consent.json +0 -344
- package/definitions/customer-portal-runtime.json +0 -1
- package/definitions/customer-portal.json +0 -16045
- package/definitions/dashboard-runtime.json +0 -1
- package/definitions/dashboard.json +0 -484
- package/definitions/data-governance-runtime.json +0 -1
- package/definitions/data-governance.json +0 -1126
- package/definitions/deduplication-runtime.json +0 -1
- package/definitions/deduplication.json +0 -314
- package/definitions/design-runtime.json +0 -1
- package/definitions/design.json +0 -1722
- package/definitions/document-runtime.json +0 -1
- package/definitions/document.json +0 -758
- package/definitions/email-settings-runtime.json +0 -1
- package/definitions/email-settings.json +0 -2777
- package/definitions/email-template-runtime.json +0 -1
- package/definitions/email-template.json +0 -1441
- package/definitions/entity-mapping-runtime.json +0 -1
- package/definitions/entity-mapping.json +0 -1642
- package/definitions/entity-runtime.json +0 -1
- package/definitions/entity.json +0 -10474
- package/definitions/environments-runtime.json +0 -1
- package/definitions/environments.json +0 -539
- package/definitions/event-catalog-runtime.json +0 -1
- package/definitions/event-catalog.json +0 -1051
- package/definitions/file-runtime.json +0 -1
- package/definitions/file.json +0 -2842
- package/definitions/iban-runtime.json +0 -1
- package/definitions/iban.json +0 -132
- package/definitions/integration-toolkit-runtime.json +0 -1
- package/definitions/integration-toolkit.json +0 -7998
- package/definitions/journey-runtime.json +0 -1
- package/definitions/journey.json +0 -2603
- package/definitions/kanban-runtime.json +0 -1
- package/definitions/kanban.json +0 -1505
- package/definitions/message-runtime.json +0 -1
- package/definitions/message.json +0 -2872
- package/definitions/metering-runtime.json +0 -1
- package/definitions/metering.json +0 -2321
- package/definitions/notes-runtime.json +0 -1
- package/definitions/notes.json +0 -1531
- package/definitions/notification-runtime.json +0 -1
- package/definitions/notification.json +0 -1425
- package/definitions/organization-runtime.json +0 -1
- package/definitions/organization.json +0 -1192
- package/definitions/partner-directory-runtime.json +0 -1
- package/definitions/partner-directory.json +0 -2284
- package/definitions/permissions-runtime.json +0 -1
- package/definitions/permissions.json +0 -1515
- package/definitions/pricing-runtime.json +0 -1
- package/definitions/pricing-tier-runtime.json +0 -1
- package/definitions/pricing-tier.json +0 -105
- package/definitions/pricing.json +0 -9884
- package/definitions/purpose-runtime.json +0 -1
- package/definitions/purpose.json +0 -524
- package/definitions/query-runtime.json +0 -1
- package/definitions/query.json +0 -3178
- package/definitions/sandbox-runtime.json +0 -1
- package/definitions/sandbox.json +0 -453
- package/definitions/sharing-runtime.json +0 -1
- package/definitions/sharing.json +0 -956
- package/definitions/submission-runtime.json +0 -1
- package/definitions/submission.json +0 -313
- package/definitions/targeting-runtime.json +0 -1
- package/definitions/targeting.json +0 -1474
- package/definitions/template-variables-runtime.json +0 -1
- package/definitions/template-variables.json +0 -1416
- package/definitions/user-runtime.json +0 -1
- package/definitions/user.json +0 -2460
- package/definitions/validation-rules-runtime.json +0 -1
- package/definitions/validation-rules.json +0 -1491
- package/definitions/webhooks-runtime.json +0 -1
- package/definitions/webhooks.json +0 -1634
- package/definitions/workflow-definition-runtime.json +0 -1
- package/definitions/workflow-definition.json +0 -3354
- package/definitions/workflow-runtime.json +0 -1
- package/definitions/workflow.json +0 -4272
- package/dist/chunk-F7W62NKV.js +0 -14
- package/dist/chunk-QA2OYK7N.cjs +0 -14
- package/dist/entity-CK76MXVN.js +0 -7
- package/dist/entity-TFMH5VTZ.cjs +0 -7
- package/dist/entity-runtime-DUJTRYLQ.cjs +0 -5
|
@@ -17,7 +17,9 @@ declare namespace Components {
|
|
|
17
17
|
* 01F130Q52Q6MWSNS8N2AVXV4JN
|
|
18
18
|
*/
|
|
19
19
|
Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
20
|
+
export type ApplyChangesetsQueryParam = boolean;
|
|
20
21
|
export type AsyncOperationQueryParam = boolean;
|
|
22
|
+
export type DirectQueryParam = boolean;
|
|
21
23
|
export type DryRunQueryParam = boolean;
|
|
22
24
|
export type EntityIdPathParam = Schemas.EntityId /* uuid */;
|
|
23
25
|
export type EntityRelationsModeQueryParam = "direct" | "reverse" | "both";
|
|
@@ -86,6 +88,8 @@ declare namespace Components {
|
|
|
86
88
|
DryRunQueryParam?: Parameters.DryRunQueryParam;
|
|
87
89
|
FillActivityQueryParam?: Parameters.FillActivityQueryParam;
|
|
88
90
|
ValidateEntityQueryParam?: Parameters.ValidateEntityQueryParam;
|
|
91
|
+
DirectQueryParam?: Parameters.DirectQueryParam;
|
|
92
|
+
ApplyChangesetsQueryParam?: Parameters.ApplyChangesetsQueryParam;
|
|
89
93
|
}
|
|
90
94
|
namespace Responses {
|
|
91
95
|
/**
|
|
@@ -171,6 +175,10 @@ declare namespace Components {
|
|
|
171
175
|
* - RelationsSoftDeleted
|
|
172
176
|
* - RelationsRestored
|
|
173
177
|
* - RelationsDeleted
|
|
178
|
+
* - ChangesetCreated
|
|
179
|
+
* - ChangesetAutoCleared
|
|
180
|
+
* - ChangesetApplied
|
|
181
|
+
* - ChangesetDismissed
|
|
174
182
|
*
|
|
175
183
|
*/
|
|
176
184
|
ActivityType;
|
|
@@ -284,6 +292,10 @@ declare namespace Components {
|
|
|
284
292
|
* - RelationsSoftDeleted
|
|
285
293
|
* - RelationsRestored
|
|
286
294
|
* - RelationsDeleted
|
|
295
|
+
* - ChangesetCreated
|
|
296
|
+
* - ChangesetAutoCleared
|
|
297
|
+
* - ChangesetApplied
|
|
298
|
+
* - ChangesetDismissed
|
|
287
299
|
*
|
|
288
300
|
*/
|
|
289
301
|
ActivityType;
|
|
@@ -340,6 +352,10 @@ declare namespace Components {
|
|
|
340
352
|
* - RelationsSoftDeleted
|
|
341
353
|
* - RelationsRestored
|
|
342
354
|
* - RelationsDeleted
|
|
355
|
+
* - ChangesetCreated
|
|
356
|
+
* - ChangesetAutoCleared
|
|
357
|
+
* - ChangesetApplied
|
|
358
|
+
* - ChangesetDismissed
|
|
343
359
|
*
|
|
344
360
|
*/
|
|
345
361
|
export type ActivityType = string;
|
|
@@ -496,6 +512,28 @@ declare namespace Components {
|
|
|
496
512
|
*/
|
|
497
513
|
repeatable?: boolean;
|
|
498
514
|
has_primary?: boolean;
|
|
515
|
+
/**
|
|
516
|
+
* Controls how updates to this attribute are handled.
|
|
517
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
518
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
519
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
520
|
+
*
|
|
521
|
+
*/
|
|
522
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
523
|
+
/**
|
|
524
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
525
|
+
*/
|
|
526
|
+
edit_mode_config?: {
|
|
527
|
+
match_strategy?: /**
|
|
528
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
529
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
530
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
531
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
532
|
+
*
|
|
533
|
+
*/
|
|
534
|
+
MatchStrategy;
|
|
535
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
536
|
+
};
|
|
499
537
|
type: "address";
|
|
500
538
|
default_address_fields?: /**
|
|
501
539
|
* Default fields visible on addresses
|
|
@@ -677,6 +715,28 @@ declare namespace Components {
|
|
|
677
715
|
*/
|
|
678
716
|
repeatable?: boolean;
|
|
679
717
|
has_primary?: boolean;
|
|
718
|
+
/**
|
|
719
|
+
* Controls how updates to this attribute are handled.
|
|
720
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
721
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
722
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
723
|
+
*
|
|
724
|
+
*/
|
|
725
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
726
|
+
/**
|
|
727
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
728
|
+
*/
|
|
729
|
+
edit_mode_config?: {
|
|
730
|
+
match_strategy?: /**
|
|
731
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
732
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
733
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
734
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
735
|
+
*
|
|
736
|
+
*/
|
|
737
|
+
MatchStrategy;
|
|
738
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
739
|
+
};
|
|
680
740
|
type: "relation_address";
|
|
681
741
|
default_address_fields?: /**
|
|
682
742
|
* Default fields visible on addresses
|
|
@@ -875,6 +935,28 @@ declare namespace Components {
|
|
|
875
935
|
*/
|
|
876
936
|
repeatable?: boolean;
|
|
877
937
|
has_primary?: boolean;
|
|
938
|
+
/**
|
|
939
|
+
* Controls how updates to this attribute are handled.
|
|
940
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
941
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
942
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
943
|
+
*
|
|
944
|
+
*/
|
|
945
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
946
|
+
/**
|
|
947
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
948
|
+
*/
|
|
949
|
+
edit_mode_config?: {
|
|
950
|
+
match_strategy?: /**
|
|
951
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
952
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
953
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
954
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
955
|
+
*
|
|
956
|
+
*/
|
|
957
|
+
MatchStrategy;
|
|
958
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
959
|
+
};
|
|
878
960
|
type: "automation";
|
|
879
961
|
}
|
|
880
962
|
export interface BaseActivityItem {
|
|
@@ -899,6 +981,10 @@ declare namespace Components {
|
|
|
899
981
|
* - RelationsSoftDeleted
|
|
900
982
|
* - RelationsRestored
|
|
901
983
|
* - RelationsDeleted
|
|
984
|
+
* - ChangesetCreated
|
|
985
|
+
* - ChangesetAutoCleared
|
|
986
|
+
* - ChangesetApplied
|
|
987
|
+
* - ChangesetDismissed
|
|
902
988
|
*
|
|
903
989
|
*/
|
|
904
990
|
ActivityType;
|
|
@@ -1084,6 +1170,28 @@ declare namespace Components {
|
|
|
1084
1170
|
*/
|
|
1085
1171
|
repeatable?: boolean;
|
|
1086
1172
|
has_primary?: boolean;
|
|
1173
|
+
/**
|
|
1174
|
+
* Controls how updates to this attribute are handled.
|
|
1175
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
1176
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
1177
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
1178
|
+
*
|
|
1179
|
+
*/
|
|
1180
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
1181
|
+
/**
|
|
1182
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
1183
|
+
*/
|
|
1184
|
+
edit_mode_config?: {
|
|
1185
|
+
match_strategy?: /**
|
|
1186
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
1187
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
1188
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
1189
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
1190
|
+
*
|
|
1191
|
+
*/
|
|
1192
|
+
MatchStrategy;
|
|
1193
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
1194
|
+
};
|
|
1087
1195
|
}
|
|
1088
1196
|
/**
|
|
1089
1197
|
* example:
|
|
@@ -1166,6 +1274,15 @@ declare namespace Components {
|
|
|
1166
1274
|
* Manifest ID used to create/update the entity
|
|
1167
1275
|
*/
|
|
1168
1276
|
_manifest?: string /* uuid */[] | null;
|
|
1277
|
+
/**
|
|
1278
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
1279
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
1280
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
1281
|
+
*
|
|
1282
|
+
*/
|
|
1283
|
+
_changesets?: {
|
|
1284
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
1285
|
+
} | null;
|
|
1169
1286
|
}
|
|
1170
1287
|
/**
|
|
1171
1288
|
* Reference to blueprint
|
|
@@ -1324,9 +1441,99 @@ declare namespace Components {
|
|
|
1324
1441
|
*/
|
|
1325
1442
|
repeatable?: boolean;
|
|
1326
1443
|
has_primary?: boolean;
|
|
1444
|
+
/**
|
|
1445
|
+
* Controls how updates to this attribute are handled.
|
|
1446
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
1447
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
1448
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
1449
|
+
*
|
|
1450
|
+
*/
|
|
1451
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
1452
|
+
/**
|
|
1453
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
1454
|
+
*/
|
|
1455
|
+
edit_mode_config?: {
|
|
1456
|
+
match_strategy?: /**
|
|
1457
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
1458
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
1459
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
1460
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
1461
|
+
*
|
|
1462
|
+
*/
|
|
1463
|
+
MatchStrategy;
|
|
1464
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
1465
|
+
};
|
|
1327
1466
|
type: "boolean";
|
|
1328
1467
|
display_type?: "switch" | "checkbox";
|
|
1329
1468
|
}
|
|
1469
|
+
/**
|
|
1470
|
+
* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval.
|
|
1471
|
+
*/
|
|
1472
|
+
export interface Changeset {
|
|
1473
|
+
/**
|
|
1474
|
+
* The proposed new value for the attribute. Type matches the attribute type.
|
|
1475
|
+
*/
|
|
1476
|
+
proposed_value: any;
|
|
1477
|
+
/**
|
|
1478
|
+
* The attribute value at the time the changeset was created. Stored for reference.
|
|
1479
|
+
*/
|
|
1480
|
+
previous_value?: any;
|
|
1481
|
+
/**
|
|
1482
|
+
* Timestamp when the changeset was created
|
|
1483
|
+
*/
|
|
1484
|
+
created_at: string; // date-time
|
|
1485
|
+
created_by?: /* Identifies the actor that created the changeset. */ ChangesetCreator;
|
|
1486
|
+
/**
|
|
1487
|
+
* The edit mode that triggered this changeset
|
|
1488
|
+
*/
|
|
1489
|
+
edit_mode: "external" | "approval";
|
|
1490
|
+
match_strategy?: /**
|
|
1491
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
1492
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
1493
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
1494
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
1495
|
+
*
|
|
1496
|
+
*/
|
|
1497
|
+
MatchStrategy;
|
|
1498
|
+
/**
|
|
1499
|
+
* Optional label indicating where the change originated (e.g. end_customer_portal, installer_portal, journey, automation)
|
|
1500
|
+
*/
|
|
1501
|
+
source?: string;
|
|
1502
|
+
/**
|
|
1503
|
+
* Proposed and previous values for related fields in a multi-field attribute group (e.g. currency _decimal/_currency suffixes). Keyed by full field name.
|
|
1504
|
+
*/
|
|
1505
|
+
related_values?: {
|
|
1506
|
+
[name: string]: {
|
|
1507
|
+
/**
|
|
1508
|
+
* The proposed new value for the related field.
|
|
1509
|
+
*/
|
|
1510
|
+
proposed_value?: any;
|
|
1511
|
+
/**
|
|
1512
|
+
* The value of the related field when the changeset was created.
|
|
1513
|
+
*/
|
|
1514
|
+
previous_value?: any;
|
|
1515
|
+
};
|
|
1516
|
+
};
|
|
1517
|
+
}
|
|
1518
|
+
/**
|
|
1519
|
+
* Identifies the actor that created the changeset.
|
|
1520
|
+
*/
|
|
1521
|
+
export interface ChangesetCreator {
|
|
1522
|
+
/**
|
|
1523
|
+
* Type of actor that created the changeset
|
|
1524
|
+
*/
|
|
1525
|
+
type?: "user" | "portal_user" | "api_client" | "automation";
|
|
1526
|
+
/**
|
|
1527
|
+
* ID of the actor (user ID, portal user ID, API client ID, etc.)
|
|
1528
|
+
*/
|
|
1529
|
+
id?: string;
|
|
1530
|
+
}
|
|
1531
|
+
/**
|
|
1532
|
+
* Map of attribute name to pending changeset. At most one changeset per attribute.
|
|
1533
|
+
*/
|
|
1534
|
+
export interface ChangesetMap {
|
|
1535
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
1536
|
+
}
|
|
1330
1537
|
/**
|
|
1331
1538
|
* example:
|
|
1332
1539
|
* taxonomy-slug:classification-slug
|
|
@@ -1522,6 +1729,28 @@ declare namespace Components {
|
|
|
1522
1729
|
*/
|
|
1523
1730
|
repeatable?: boolean;
|
|
1524
1731
|
has_primary?: boolean;
|
|
1732
|
+
/**
|
|
1733
|
+
* Controls how updates to this attribute are handled.
|
|
1734
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
1735
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
1736
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
1737
|
+
*
|
|
1738
|
+
*/
|
|
1739
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
1740
|
+
/**
|
|
1741
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
1742
|
+
*/
|
|
1743
|
+
edit_mode_config?: {
|
|
1744
|
+
match_strategy?: /**
|
|
1745
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
1746
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
1747
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
1748
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
1749
|
+
*
|
|
1750
|
+
*/
|
|
1751
|
+
MatchStrategy;
|
|
1752
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
1753
|
+
};
|
|
1525
1754
|
type: "computed";
|
|
1526
1755
|
computed?: boolean;
|
|
1527
1756
|
/**
|
|
@@ -1686,6 +1915,28 @@ declare namespace Components {
|
|
|
1686
1915
|
*/
|
|
1687
1916
|
repeatable?: boolean;
|
|
1688
1917
|
has_primary?: boolean;
|
|
1918
|
+
/**
|
|
1919
|
+
* Controls how updates to this attribute are handled.
|
|
1920
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
1921
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
1922
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
1923
|
+
*
|
|
1924
|
+
*/
|
|
1925
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
1926
|
+
/**
|
|
1927
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
1928
|
+
*/
|
|
1929
|
+
edit_mode_config?: {
|
|
1930
|
+
match_strategy?: /**
|
|
1931
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
1932
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
1933
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
1934
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
1935
|
+
*
|
|
1936
|
+
*/
|
|
1937
|
+
MatchStrategy;
|
|
1938
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
1939
|
+
};
|
|
1689
1940
|
type: "consent";
|
|
1690
1941
|
topic: string;
|
|
1691
1942
|
identifiers?: string[];
|
|
@@ -1843,6 +2094,28 @@ declare namespace Components {
|
|
|
1843
2094
|
*/
|
|
1844
2095
|
repeatable?: boolean;
|
|
1845
2096
|
has_primary?: boolean;
|
|
2097
|
+
/**
|
|
2098
|
+
* Controls how updates to this attribute are handled.
|
|
2099
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
2100
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
2101
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
2102
|
+
*
|
|
2103
|
+
*/
|
|
2104
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
2105
|
+
/**
|
|
2106
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
2107
|
+
*/
|
|
2108
|
+
edit_mode_config?: {
|
|
2109
|
+
match_strategy?: /**
|
|
2110
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
2111
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
2112
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
2113
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
2114
|
+
*
|
|
2115
|
+
*/
|
|
2116
|
+
MatchStrategy;
|
|
2117
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
2118
|
+
};
|
|
1846
2119
|
type: "country";
|
|
1847
2120
|
}
|
|
1848
2121
|
/**
|
|
@@ -1998,6 +2271,28 @@ declare namespace Components {
|
|
|
1998
2271
|
*/
|
|
1999
2272
|
repeatable?: boolean;
|
|
2000
2273
|
has_primary?: boolean;
|
|
2274
|
+
/**
|
|
2275
|
+
* Controls how updates to this attribute are handled.
|
|
2276
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
2277
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
2278
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
2279
|
+
*
|
|
2280
|
+
*/
|
|
2281
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
2282
|
+
/**
|
|
2283
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
2284
|
+
*/
|
|
2285
|
+
edit_mode_config?: {
|
|
2286
|
+
match_strategy?: /**
|
|
2287
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
2288
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
2289
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
2290
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
2291
|
+
*
|
|
2292
|
+
*/
|
|
2293
|
+
MatchStrategy;
|
|
2294
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
2295
|
+
};
|
|
2001
2296
|
type: "currency";
|
|
2002
2297
|
currency_selector_only?: boolean;
|
|
2003
2298
|
/**
|
|
@@ -2163,6 +2458,28 @@ declare namespace Components {
|
|
|
2163
2458
|
*/
|
|
2164
2459
|
repeatable?: boolean;
|
|
2165
2460
|
has_primary?: boolean;
|
|
2461
|
+
/**
|
|
2462
|
+
* Controls how updates to this attribute are handled.
|
|
2463
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
2464
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
2465
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
2466
|
+
*
|
|
2467
|
+
*/
|
|
2468
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
2469
|
+
/**
|
|
2470
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
2471
|
+
*/
|
|
2472
|
+
edit_mode_config?: {
|
|
2473
|
+
match_strategy?: /**
|
|
2474
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
2475
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
2476
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
2477
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
2478
|
+
*
|
|
2479
|
+
*/
|
|
2480
|
+
MatchStrategy;
|
|
2481
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
2482
|
+
};
|
|
2166
2483
|
type: "date" | "datetime";
|
|
2167
2484
|
}
|
|
2168
2485
|
/**
|
|
@@ -2201,6 +2518,20 @@ declare namespace Components {
|
|
|
2201
2518
|
*/
|
|
2202
2519
|
cluster?: string;
|
|
2203
2520
|
}
|
|
2521
|
+
/**
|
|
2522
|
+
* Configuration for non-direct edit modes on an entity attribute.
|
|
2523
|
+
*/
|
|
2524
|
+
export interface EditModeConfig {
|
|
2525
|
+
match_strategy?: /**
|
|
2526
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
2527
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
2528
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
2529
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
2530
|
+
*
|
|
2531
|
+
*/
|
|
2532
|
+
MatchStrategy;
|
|
2533
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
2534
|
+
}
|
|
2204
2535
|
/**
|
|
2205
2536
|
* Email address
|
|
2206
2537
|
*/
|
|
@@ -2354,6 +2685,28 @@ declare namespace Components {
|
|
|
2354
2685
|
*/
|
|
2355
2686
|
repeatable?: boolean;
|
|
2356
2687
|
has_primary?: boolean;
|
|
2688
|
+
/**
|
|
2689
|
+
* Controls how updates to this attribute are handled.
|
|
2690
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
2691
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
2692
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
2693
|
+
*
|
|
2694
|
+
*/
|
|
2695
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
2696
|
+
/**
|
|
2697
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
2698
|
+
*/
|
|
2699
|
+
edit_mode_config?: {
|
|
2700
|
+
match_strategy?: /**
|
|
2701
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
2702
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
2703
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
2704
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
2705
|
+
*
|
|
2706
|
+
*/
|
|
2707
|
+
MatchStrategy;
|
|
2708
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
2709
|
+
};
|
|
2357
2710
|
type: "email";
|
|
2358
2711
|
}
|
|
2359
2712
|
/**
|
|
@@ -2437,6 +2790,15 @@ declare namespace Components {
|
|
|
2437
2790
|
* Manifest ID used to create/update the entity
|
|
2438
2791
|
*/
|
|
2439
2792
|
_manifest?: string /* uuid */[] | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
2795
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
2796
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
2797
|
+
*
|
|
2798
|
+
*/
|
|
2799
|
+
_changesets?: {
|
|
2800
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
2801
|
+
} | null;
|
|
2440
2802
|
}
|
|
2441
2803
|
/**
|
|
2442
2804
|
* Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
|
|
@@ -2932,6 +3294,15 @@ declare namespace Components {
|
|
|
2932
3294
|
* Manifest ID used to create/update the entity
|
|
2933
3295
|
*/
|
|
2934
3296
|
_manifest?: string /* uuid */[] | null;
|
|
3297
|
+
/**
|
|
3298
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
3299
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
3300
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
3301
|
+
*
|
|
3302
|
+
*/
|
|
3303
|
+
_changesets?: {
|
|
3304
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
3305
|
+
} | null;
|
|
2935
3306
|
}
|
|
2936
3307
|
export interface EntityListParams {
|
|
2937
3308
|
/**
|
|
@@ -3108,6 +3479,10 @@ declare namespace Components {
|
|
|
3108
3479
|
* - RelationsSoftDeleted
|
|
3109
3480
|
* - RelationsRestored
|
|
3110
3481
|
* - RelationsDeleted
|
|
3482
|
+
* - ChangesetCreated
|
|
3483
|
+
* - ChangesetAutoCleared
|
|
3484
|
+
* - ChangesetApplied
|
|
3485
|
+
* - ChangesetDismissed
|
|
3111
3486
|
*
|
|
3112
3487
|
*/
|
|
3113
3488
|
ActivityType;
|
|
@@ -3210,6 +3585,15 @@ declare namespace Components {
|
|
|
3210
3585
|
* Manifest ID used to create/update the entity
|
|
3211
3586
|
*/
|
|
3212
3587
|
_manifest?: string /* uuid */[] | null;
|
|
3588
|
+
/**
|
|
3589
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
3590
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
3591
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
3592
|
+
*
|
|
3593
|
+
*/
|
|
3594
|
+
_changesets?: {
|
|
3595
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
3596
|
+
} | null;
|
|
3213
3597
|
};
|
|
3214
3598
|
diff?: {
|
|
3215
3599
|
/**
|
|
@@ -3294,6 +3678,15 @@ declare namespace Components {
|
|
|
3294
3678
|
* Manifest ID used to create/update the entity
|
|
3295
3679
|
*/
|
|
3296
3680
|
_manifest?: string /* uuid */[] | null;
|
|
3681
|
+
/**
|
|
3682
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
3683
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
3684
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
3685
|
+
*
|
|
3686
|
+
*/
|
|
3687
|
+
_changesets?: {
|
|
3688
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
3689
|
+
} | null;
|
|
3297
3690
|
};
|
|
3298
3691
|
/**
|
|
3299
3692
|
* Attributes updated in the entity. Note: These values contain the previous values before the update!
|
|
@@ -3377,6 +3770,15 @@ declare namespace Components {
|
|
|
3377
3770
|
* Manifest ID used to create/update the entity
|
|
3378
3771
|
*/
|
|
3379
3772
|
_manifest?: string /* uuid */[] | null;
|
|
3773
|
+
/**
|
|
3774
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
3775
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
3776
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
3777
|
+
*
|
|
3778
|
+
*/
|
|
3779
|
+
_changesets?: {
|
|
3780
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
3781
|
+
} | null;
|
|
3380
3782
|
};
|
|
3381
3783
|
/**
|
|
3382
3784
|
* Attributes removed from the entity as part of the operation
|
|
@@ -3460,6 +3862,15 @@ declare namespace Components {
|
|
|
3460
3862
|
* Manifest ID used to create/update the entity
|
|
3461
3863
|
*/
|
|
3462
3864
|
_manifest?: string /* uuid */[] | null;
|
|
3865
|
+
/**
|
|
3866
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
3867
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
3868
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
3869
|
+
*
|
|
3870
|
+
*/
|
|
3871
|
+
_changesets?: {
|
|
3872
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
3873
|
+
} | null;
|
|
3463
3874
|
};
|
|
3464
3875
|
};
|
|
3465
3876
|
/**
|
|
@@ -4793,6 +5204,28 @@ declare namespace Components {
|
|
|
4793
5204
|
*/
|
|
4794
5205
|
repeatable?: boolean;
|
|
4795
5206
|
has_primary?: boolean;
|
|
5207
|
+
/**
|
|
5208
|
+
* Controls how updates to this attribute are handled.
|
|
5209
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
5210
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
5211
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
5212
|
+
*
|
|
5213
|
+
*/
|
|
5214
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
5215
|
+
/**
|
|
5216
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
5217
|
+
*/
|
|
5218
|
+
edit_mode_config?: {
|
|
5219
|
+
match_strategy?: /**
|
|
5220
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
5221
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
5222
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
5223
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
5224
|
+
*
|
|
5225
|
+
*/
|
|
5226
|
+
MatchStrategy;
|
|
5227
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
5228
|
+
};
|
|
4796
5229
|
type: "image" | "file";
|
|
4797
5230
|
multiple?: boolean;
|
|
4798
5231
|
/**
|
|
@@ -4817,6 +5250,39 @@ declare namespace Components {
|
|
|
4817
5250
|
*/
|
|
4818
5251
|
file_size_bytes?: number;
|
|
4819
5252
|
}
|
|
5253
|
+
/**
|
|
5254
|
+
* Configuration for fuzzy match strategies on changeset auto-clearing.
|
|
5255
|
+
*/
|
|
5256
|
+
export interface FuzzyConfig {
|
|
5257
|
+
/**
|
|
5258
|
+
* Which fuzzy algorithm to apply.
|
|
5259
|
+
*/
|
|
5260
|
+
type: "suffix" | "digits_only" | "normalize_phone" | "ignore_fields" | "contains_entry" | "regex";
|
|
5261
|
+
/**
|
|
5262
|
+
* For type=suffix: number of characters to compare from end of string.
|
|
5263
|
+
*/
|
|
5264
|
+
suffix_length?: number;
|
|
5265
|
+
/**
|
|
5266
|
+
* For type=ignore_fields: field names to exclude when comparing array entries.
|
|
5267
|
+
*/
|
|
5268
|
+
fields_to_ignore?: string[];
|
|
5269
|
+
/**
|
|
5270
|
+
* For type=regex: flags to apply to the regex (e.g. 'i' for case-insensitive).
|
|
5271
|
+
*/
|
|
5272
|
+
regex_flags?: string;
|
|
5273
|
+
/**
|
|
5274
|
+
* For type=normalize_phone: country dialing code digits to strip (e.g. '49' for Germany). No '+' prefix.
|
|
5275
|
+
*/
|
|
5276
|
+
country_code?: string;
|
|
5277
|
+
/**
|
|
5278
|
+
* For type=normalize_phone and type=contains_entry: attribute key(s) within array entries to compare on.
|
|
5279
|
+
*/
|
|
5280
|
+
match_on?: string;
|
|
5281
|
+
/**
|
|
5282
|
+
* For type=regex: regular expression pattern to test the incoming value against.
|
|
5283
|
+
*/
|
|
5284
|
+
pattern?: string;
|
|
5285
|
+
}
|
|
4820
5286
|
export interface GenerateEntityTableAIFiltersRequest {
|
|
4821
5287
|
/**
|
|
4822
5288
|
* The prompt to generate the filters
|
|
@@ -4984,6 +5450,10 @@ declare namespace Components {
|
|
|
4984
5450
|
* If true, return full entity objects in entityNodes instead of just entity IDs in nodes
|
|
4985
5451
|
*/
|
|
4986
5452
|
hydrate?: boolean;
|
|
5453
|
+
/**
|
|
5454
|
+
* When true and hydrate is also true, entity objects in entityNodes have pending changeset proposed values applied in-place. The _changesets field is still included in the response.
|
|
5455
|
+
*/
|
|
5456
|
+
apply_changesets?: boolean;
|
|
4987
5457
|
}
|
|
4988
5458
|
export interface GraphQueryResponse {
|
|
4989
5459
|
/**
|
|
@@ -5400,6 +5870,15 @@ declare namespace Components {
|
|
|
5400
5870
|
* Manifest ID used to create/update the entity
|
|
5401
5871
|
*/
|
|
5402
5872
|
_manifest?: string /* uuid */[] | null;
|
|
5873
|
+
/**
|
|
5874
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
5875
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
5876
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
5877
|
+
*
|
|
5878
|
+
*/
|
|
5879
|
+
_changesets?: {
|
|
5880
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
5881
|
+
} | null;
|
|
5403
5882
|
_relations: {
|
|
5404
5883
|
entity_id: EntityId /* uuid */;
|
|
5405
5884
|
}[];
|
|
@@ -5557,6 +6036,28 @@ declare namespace Components {
|
|
|
5557
6036
|
*/
|
|
5558
6037
|
repeatable?: boolean;
|
|
5559
6038
|
has_primary?: boolean;
|
|
6039
|
+
/**
|
|
6040
|
+
* Controls how updates to this attribute are handled.
|
|
6041
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6042
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6043
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6044
|
+
*
|
|
6045
|
+
*/
|
|
6046
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6047
|
+
/**
|
|
6048
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6049
|
+
*/
|
|
6050
|
+
edit_mode_config?: {
|
|
6051
|
+
match_strategy?: /**
|
|
6052
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6053
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6054
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6055
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6056
|
+
*
|
|
6057
|
+
*/
|
|
6058
|
+
MatchStrategy;
|
|
6059
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6060
|
+
};
|
|
5560
6061
|
type: "internal";
|
|
5561
6062
|
}
|
|
5562
6063
|
/**
|
|
@@ -5712,6 +6213,28 @@ declare namespace Components {
|
|
|
5712
6213
|
*/
|
|
5713
6214
|
repeatable?: boolean;
|
|
5714
6215
|
has_primary?: boolean;
|
|
6216
|
+
/**
|
|
6217
|
+
* Controls how updates to this attribute are handled.
|
|
6218
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6219
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6220
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6221
|
+
*
|
|
6222
|
+
*/
|
|
6223
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6224
|
+
/**
|
|
6225
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6226
|
+
*/
|
|
6227
|
+
edit_mode_config?: {
|
|
6228
|
+
match_strategy?: /**
|
|
6229
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6230
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6231
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6232
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6233
|
+
*
|
|
6234
|
+
*/
|
|
6235
|
+
MatchStrategy;
|
|
6236
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6237
|
+
};
|
|
5715
6238
|
type: "internal_user";
|
|
5716
6239
|
}
|
|
5717
6240
|
/**
|
|
@@ -5867,6 +6390,28 @@ declare namespace Components {
|
|
|
5867
6390
|
*/
|
|
5868
6391
|
repeatable?: boolean;
|
|
5869
6392
|
has_primary?: boolean;
|
|
6393
|
+
/**
|
|
6394
|
+
* Controls how updates to this attribute are handled.
|
|
6395
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6396
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6397
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6398
|
+
*
|
|
6399
|
+
*/
|
|
6400
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6401
|
+
/**
|
|
6402
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6403
|
+
*/
|
|
6404
|
+
edit_mode_config?: {
|
|
6405
|
+
match_strategy?: /**
|
|
6406
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6407
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6408
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6409
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6410
|
+
*
|
|
6411
|
+
*/
|
|
6412
|
+
MatchStrategy;
|
|
6413
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6414
|
+
};
|
|
5870
6415
|
type: "invitation_email";
|
|
5871
6416
|
}
|
|
5872
6417
|
/**
|
|
@@ -6030,6 +6575,28 @@ declare namespace Components {
|
|
|
6030
6575
|
*/
|
|
6031
6576
|
repeatable?: boolean;
|
|
6032
6577
|
has_primary?: boolean;
|
|
6578
|
+
/**
|
|
6579
|
+
* Controls how updates to this attribute are handled.
|
|
6580
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6581
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6582
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6583
|
+
*
|
|
6584
|
+
*/
|
|
6585
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6586
|
+
/**
|
|
6587
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6588
|
+
*/
|
|
6589
|
+
edit_mode_config?: {
|
|
6590
|
+
match_strategy?: /**
|
|
6591
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6592
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6593
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6594
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6595
|
+
*
|
|
6596
|
+
*/
|
|
6597
|
+
MatchStrategy;
|
|
6598
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6599
|
+
};
|
|
6033
6600
|
type: "link";
|
|
6034
6601
|
}
|
|
6035
6602
|
export interface ListSavedViewsResults {
|
|
@@ -6040,6 +6607,14 @@ declare namespace Components {
|
|
|
6040
6607
|
hits?: number;
|
|
6041
6608
|
results?: /* A saved entity view */ SavedViewItem[];
|
|
6042
6609
|
}
|
|
6610
|
+
/**
|
|
6611
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6612
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6613
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6614
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6615
|
+
*
|
|
6616
|
+
*/
|
|
6617
|
+
export type MatchStrategy = "exact" | "fuzzy" | "any";
|
|
6043
6618
|
/**
|
|
6044
6619
|
* Message emil address
|
|
6045
6620
|
*/
|
|
@@ -6193,6 +6768,28 @@ declare namespace Components {
|
|
|
6193
6768
|
*/
|
|
6194
6769
|
repeatable?: boolean;
|
|
6195
6770
|
has_primary?: boolean;
|
|
6771
|
+
/**
|
|
6772
|
+
* Controls how updates to this attribute are handled.
|
|
6773
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6774
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6775
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6776
|
+
*
|
|
6777
|
+
*/
|
|
6778
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6779
|
+
/**
|
|
6780
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6781
|
+
*/
|
|
6782
|
+
edit_mode_config?: {
|
|
6783
|
+
match_strategy?: /**
|
|
6784
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6785
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6786
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6787
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6788
|
+
*
|
|
6789
|
+
*/
|
|
6790
|
+
MatchStrategy;
|
|
6791
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6792
|
+
};
|
|
6196
6793
|
type: "message_email_address";
|
|
6197
6794
|
address?: string;
|
|
6198
6795
|
send_status?: string;
|
|
@@ -6351,6 +6948,28 @@ declare namespace Components {
|
|
|
6351
6948
|
*/
|
|
6352
6949
|
repeatable?: boolean;
|
|
6353
6950
|
has_primary?: boolean;
|
|
6951
|
+
/**
|
|
6952
|
+
* Controls how updates to this attribute are handled.
|
|
6953
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
6954
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
6955
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
6956
|
+
*
|
|
6957
|
+
*/
|
|
6958
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
6959
|
+
/**
|
|
6960
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
6961
|
+
*/
|
|
6962
|
+
edit_mode_config?: {
|
|
6963
|
+
match_strategy?: /**
|
|
6964
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
6965
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
6966
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
6967
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
6968
|
+
*
|
|
6969
|
+
*/
|
|
6970
|
+
MatchStrategy;
|
|
6971
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
6972
|
+
};
|
|
6354
6973
|
type: "multiselect" | "checkbox";
|
|
6355
6974
|
/**
|
|
6356
6975
|
* controls if the matching of values against the options is case sensitive or not
|
|
@@ -6450,6 +7069,15 @@ declare namespace Components {
|
|
|
6450
7069
|
* Manifest ID used to create/update the entity
|
|
6451
7070
|
*/
|
|
6452
7071
|
_manifest?: string /* uuid */[] | null;
|
|
7072
|
+
/**
|
|
7073
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
7074
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
7075
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
7076
|
+
*
|
|
7077
|
+
*/
|
|
7078
|
+
_changesets?: {
|
|
7079
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
7080
|
+
} | null;
|
|
6453
7081
|
} | null;
|
|
6454
7082
|
/**
|
|
6455
7083
|
* Numeric input
|
|
@@ -6604,6 +7232,28 @@ declare namespace Components {
|
|
|
6604
7232
|
*/
|
|
6605
7233
|
repeatable?: boolean;
|
|
6606
7234
|
has_primary?: boolean;
|
|
7235
|
+
/**
|
|
7236
|
+
* Controls how updates to this attribute are handled.
|
|
7237
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
7238
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
7239
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
7240
|
+
*
|
|
7241
|
+
*/
|
|
7242
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
7243
|
+
/**
|
|
7244
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
7245
|
+
*/
|
|
7246
|
+
edit_mode_config?: {
|
|
7247
|
+
match_strategy?: /**
|
|
7248
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
7249
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
7250
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
7251
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
7252
|
+
*
|
|
7253
|
+
*/
|
|
7254
|
+
MatchStrategy;
|
|
7255
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
7256
|
+
};
|
|
6607
7257
|
type: "number";
|
|
6608
7258
|
/**
|
|
6609
7259
|
* Optional data type override. When set to 'number', the value is stored as a number instead of a string. Defaults to 'string'.
|
|
@@ -6768,6 +7418,28 @@ declare namespace Components {
|
|
|
6768
7418
|
*/
|
|
6769
7419
|
repeatable?: boolean;
|
|
6770
7420
|
has_primary?: boolean;
|
|
7421
|
+
/**
|
|
7422
|
+
* Controls how updates to this attribute are handled.
|
|
7423
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
7424
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
7425
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
7426
|
+
*
|
|
7427
|
+
*/
|
|
7428
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
7429
|
+
/**
|
|
7430
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
7431
|
+
*/
|
|
7432
|
+
edit_mode_config?: {
|
|
7433
|
+
match_strategy?: /**
|
|
7434
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
7435
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
7436
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
7437
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
7438
|
+
*
|
|
7439
|
+
*/
|
|
7440
|
+
MatchStrategy;
|
|
7441
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
7442
|
+
};
|
|
6771
7443
|
type: "ordered_list";
|
|
6772
7444
|
}
|
|
6773
7445
|
/**
|
|
@@ -6923,6 +7595,28 @@ declare namespace Components {
|
|
|
6923
7595
|
*/
|
|
6924
7596
|
repeatable?: boolean;
|
|
6925
7597
|
has_primary?: boolean;
|
|
7598
|
+
/**
|
|
7599
|
+
* Controls how updates to this attribute are handled.
|
|
7600
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
7601
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
7602
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
7603
|
+
*
|
|
7604
|
+
*/
|
|
7605
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
7606
|
+
/**
|
|
7607
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
7608
|
+
*/
|
|
7609
|
+
edit_mode_config?: {
|
|
7610
|
+
match_strategy?: /**
|
|
7611
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
7612
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
7613
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
7614
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
7615
|
+
*
|
|
7616
|
+
*/
|
|
7617
|
+
MatchStrategy;
|
|
7618
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
7619
|
+
};
|
|
6926
7620
|
type: "partner_organisation";
|
|
6927
7621
|
}
|
|
6928
7622
|
/**
|
|
@@ -7078,6 +7772,28 @@ declare namespace Components {
|
|
|
7078
7772
|
*/
|
|
7079
7773
|
repeatable?: boolean;
|
|
7080
7774
|
has_primary?: boolean;
|
|
7775
|
+
/**
|
|
7776
|
+
* Controls how updates to this attribute are handled.
|
|
7777
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
7778
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
7779
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
7780
|
+
*
|
|
7781
|
+
*/
|
|
7782
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
7783
|
+
/**
|
|
7784
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
7785
|
+
*/
|
|
7786
|
+
edit_mode_config?: {
|
|
7787
|
+
match_strategy?: /**
|
|
7788
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
7789
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
7790
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
7791
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
7792
|
+
*
|
|
7793
|
+
*/
|
|
7794
|
+
MatchStrategy;
|
|
7795
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
7796
|
+
};
|
|
7081
7797
|
type: "partner_status";
|
|
7082
7798
|
}
|
|
7083
7799
|
/**
|
|
@@ -7233,6 +7949,28 @@ declare namespace Components {
|
|
|
7233
7949
|
*/
|
|
7234
7950
|
repeatable?: boolean;
|
|
7235
7951
|
has_primary?: boolean;
|
|
7952
|
+
/**
|
|
7953
|
+
* Controls how updates to this attribute are handled.
|
|
7954
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
7955
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
7956
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
7957
|
+
*
|
|
7958
|
+
*/
|
|
7959
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
7960
|
+
/**
|
|
7961
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
7962
|
+
*/
|
|
7963
|
+
edit_mode_config?: {
|
|
7964
|
+
match_strategy?: /**
|
|
7965
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
7966
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
7967
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
7968
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
7969
|
+
*
|
|
7970
|
+
*/
|
|
7971
|
+
MatchStrategy;
|
|
7972
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
7973
|
+
};
|
|
7236
7974
|
type: "payment";
|
|
7237
7975
|
}
|
|
7238
7976
|
/**
|
|
@@ -7388,6 +8126,28 @@ declare namespace Components {
|
|
|
7388
8126
|
*/
|
|
7389
8127
|
repeatable?: boolean;
|
|
7390
8128
|
has_primary?: boolean;
|
|
8129
|
+
/**
|
|
8130
|
+
* Controls how updates to this attribute are handled.
|
|
8131
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
8132
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
8133
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
8134
|
+
*
|
|
8135
|
+
*/
|
|
8136
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
8137
|
+
/**
|
|
8138
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
8139
|
+
*/
|
|
8140
|
+
edit_mode_config?: {
|
|
8141
|
+
match_strategy?: /**
|
|
8142
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
8143
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
8144
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
8145
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
8146
|
+
*
|
|
8147
|
+
*/
|
|
8148
|
+
MatchStrategy;
|
|
8149
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
8150
|
+
};
|
|
7391
8151
|
type: "relation_payment_method";
|
|
7392
8152
|
}
|
|
7393
8153
|
/**
|
|
@@ -7543,6 +8303,28 @@ declare namespace Components {
|
|
|
7543
8303
|
*/
|
|
7544
8304
|
repeatable?: boolean;
|
|
7545
8305
|
has_primary?: boolean;
|
|
8306
|
+
/**
|
|
8307
|
+
* Controls how updates to this attribute are handled.
|
|
8308
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
8309
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
8310
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
8311
|
+
*
|
|
8312
|
+
*/
|
|
8313
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
8314
|
+
/**
|
|
8315
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
8316
|
+
*/
|
|
8317
|
+
edit_mode_config?: {
|
|
8318
|
+
match_strategy?: /**
|
|
8319
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
8320
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
8321
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
8322
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
8323
|
+
*
|
|
8324
|
+
*/
|
|
8325
|
+
MatchStrategy;
|
|
8326
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
8327
|
+
};
|
|
7546
8328
|
type: "phone";
|
|
7547
8329
|
}
|
|
7548
8330
|
/**
|
|
@@ -7698,6 +8480,28 @@ declare namespace Components {
|
|
|
7698
8480
|
*/
|
|
7699
8481
|
repeatable?: boolean;
|
|
7700
8482
|
has_primary?: boolean;
|
|
8483
|
+
/**
|
|
8484
|
+
* Controls how updates to this attribute are handled.
|
|
8485
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
8486
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
8487
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
8488
|
+
*
|
|
8489
|
+
*/
|
|
8490
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
8491
|
+
/**
|
|
8492
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
8493
|
+
*/
|
|
8494
|
+
edit_mode_config?: {
|
|
8495
|
+
match_strategy?: /**
|
|
8496
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
8497
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
8498
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
8499
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
8500
|
+
*
|
|
8501
|
+
*/
|
|
8502
|
+
MatchStrategy;
|
|
8503
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
8504
|
+
};
|
|
7701
8505
|
type: "portal_access";
|
|
7702
8506
|
}
|
|
7703
8507
|
/**
|
|
@@ -7853,6 +8657,28 @@ declare namespace Components {
|
|
|
7853
8657
|
*/
|
|
7854
8658
|
repeatable?: boolean;
|
|
7855
8659
|
has_primary?: boolean;
|
|
8660
|
+
/**
|
|
8661
|
+
* Controls how updates to this attribute are handled.
|
|
8662
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
8663
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
8664
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
8665
|
+
*
|
|
8666
|
+
*/
|
|
8667
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
8668
|
+
/**
|
|
8669
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
8670
|
+
*/
|
|
8671
|
+
edit_mode_config?: {
|
|
8672
|
+
match_strategy?: /**
|
|
8673
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
8674
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
8675
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
8676
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
8677
|
+
*
|
|
8678
|
+
*/
|
|
8679
|
+
MatchStrategy;
|
|
8680
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
8681
|
+
};
|
|
7856
8682
|
type: "price_component";
|
|
7857
8683
|
}
|
|
7858
8684
|
/**
|
|
@@ -8008,6 +8834,28 @@ declare namespace Components {
|
|
|
8008
8834
|
*/
|
|
8009
8835
|
repeatable?: boolean;
|
|
8010
8836
|
has_primary?: boolean;
|
|
8837
|
+
/**
|
|
8838
|
+
* Controls how updates to this attribute are handled.
|
|
8839
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
8840
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
8841
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
8842
|
+
*
|
|
8843
|
+
*/
|
|
8844
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
8845
|
+
/**
|
|
8846
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
8847
|
+
*/
|
|
8848
|
+
edit_mode_config?: {
|
|
8849
|
+
match_strategy?: /**
|
|
8850
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
8851
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
8852
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
8853
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
8854
|
+
*
|
|
8855
|
+
*/
|
|
8856
|
+
MatchStrategy;
|
|
8857
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
8858
|
+
};
|
|
8011
8859
|
type: "purpose";
|
|
8012
8860
|
}
|
|
8013
8861
|
/**
|
|
@@ -8178,6 +9026,28 @@ declare namespace Components {
|
|
|
8178
9026
|
*/
|
|
8179
9027
|
repeatable?: boolean;
|
|
8180
9028
|
has_primary?: boolean;
|
|
9029
|
+
/**
|
|
9030
|
+
* Controls how updates to this attribute are handled.
|
|
9031
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
9032
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
9033
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
9034
|
+
*
|
|
9035
|
+
*/
|
|
9036
|
+
edit_mode?: "direct" | "external" | "approval" | "list-view";
|
|
9037
|
+
/**
|
|
9038
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
9039
|
+
*/
|
|
9040
|
+
edit_mode_config?: {
|
|
9041
|
+
match_strategy?: /**
|
|
9042
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
9043
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
9044
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
9045
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
9046
|
+
*
|
|
9047
|
+
*/
|
|
9048
|
+
MatchStrategy;
|
|
9049
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
9050
|
+
};
|
|
8181
9051
|
type: "relation";
|
|
8182
9052
|
relation_type?: "has_many" | "has_one";
|
|
8183
9053
|
/**
|
|
@@ -8199,7 +9069,6 @@ declare namespace Components {
|
|
|
8199
9069
|
* When enable_relation_picker is set to true the user will be able to pick existing relations as values. Otherwise, the user will need to create new relation to link.
|
|
8200
9070
|
*/
|
|
8201
9071
|
enable_relation_picker?: boolean;
|
|
8202
|
-
edit_mode?: "list-view";
|
|
8203
9072
|
/**
|
|
8204
9073
|
* Enables the preview, edition, and creation of relation items on a Master-Details view mode.
|
|
8205
9074
|
*/
|
|
@@ -8373,6 +9242,15 @@ declare namespace Components {
|
|
|
8373
9242
|
* Manifest ID used to create/update the entity
|
|
8374
9243
|
*/
|
|
8375
9244
|
_manifest?: string /* uuid */[] | null;
|
|
9245
|
+
/**
|
|
9246
|
+
* Pending attribute changesets for attributes configured with external or approval edit mode.
|
|
9247
|
+
* Read-only via normal entity PATCH/PUT operations — cannot be set directly.
|
|
9248
|
+
* Use the changeset management endpoints to apply or dismiss changesets.
|
|
9249
|
+
*
|
|
9250
|
+
*/
|
|
9251
|
+
_changesets?: {
|
|
9252
|
+
[name: string]: /* A pending proposed change for a single entity attribute, awaiting external confirmation or human approval. */ Changeset;
|
|
9253
|
+
} | null;
|
|
8376
9254
|
$relation?: RelationItem;
|
|
8377
9255
|
}
|
|
8378
9256
|
export interface RelationItem {
|
|
@@ -8547,6 +9425,28 @@ declare namespace Components {
|
|
|
8547
9425
|
*/
|
|
8548
9426
|
repeatable?: boolean;
|
|
8549
9427
|
has_primary?: boolean;
|
|
9428
|
+
/**
|
|
9429
|
+
* Controls how updates to this attribute are handled.
|
|
9430
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
9431
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
9432
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
9433
|
+
*
|
|
9434
|
+
*/
|
|
9435
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
9436
|
+
/**
|
|
9437
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
9438
|
+
*/
|
|
9439
|
+
edit_mode_config?: {
|
|
9440
|
+
match_strategy?: /**
|
|
9441
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
9442
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
9443
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
9444
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
9445
|
+
*
|
|
9446
|
+
*/
|
|
9447
|
+
MatchStrategy;
|
|
9448
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
9449
|
+
};
|
|
8550
9450
|
}
|
|
8551
9451
|
/**
|
|
8552
9452
|
* A saved entity view
|
|
@@ -8943,10 +9843,14 @@ declare namespace Components {
|
|
|
8943
9843
|
export interface SearchMappings {
|
|
8944
9844
|
[name: string]: {
|
|
8945
9845
|
index?: boolean;
|
|
8946
|
-
type?: "keyword" | "text" | "boolean" | "integer" | "long" | "float" | "date" | "flattened" | "nested";
|
|
9846
|
+
type?: "keyword" | "text" | "boolean" | "integer" | "long" | "float" | "date" | "flattened" | "nested" | "object";
|
|
8947
9847
|
fields?: {
|
|
8948
9848
|
[name: string]: any;
|
|
8949
9849
|
};
|
|
9850
|
+
/**
|
|
9851
|
+
* When false, prevents ES from inferring types for nested fields. Used for _changesets where values can be any type.
|
|
9852
|
+
*/
|
|
9853
|
+
dynamic?: boolean;
|
|
8950
9854
|
};
|
|
8951
9855
|
}
|
|
8952
9856
|
/**
|
|
@@ -9102,6 +10006,28 @@ declare namespace Components {
|
|
|
9102
10006
|
*/
|
|
9103
10007
|
repeatable?: boolean;
|
|
9104
10008
|
has_primary?: boolean;
|
|
10009
|
+
/**
|
|
10010
|
+
* Controls how updates to this attribute are handled.
|
|
10011
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
10012
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
10013
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
10014
|
+
*
|
|
10015
|
+
*/
|
|
10016
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
10017
|
+
/**
|
|
10018
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
10019
|
+
*/
|
|
10020
|
+
edit_mode_config?: {
|
|
10021
|
+
match_strategy?: /**
|
|
10022
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
10023
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
10024
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
10025
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
10026
|
+
*
|
|
10027
|
+
*/
|
|
10028
|
+
MatchStrategy;
|
|
10029
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
10030
|
+
};
|
|
9105
10031
|
type: "select" | "radio";
|
|
9106
10032
|
options?: ({
|
|
9107
10033
|
value: string;
|
|
@@ -9265,6 +10191,28 @@ declare namespace Components {
|
|
|
9265
10191
|
*/
|
|
9266
10192
|
repeatable?: boolean;
|
|
9267
10193
|
has_primary?: boolean;
|
|
10194
|
+
/**
|
|
10195
|
+
* Controls how updates to this attribute are handled.
|
|
10196
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
10197
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
10198
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
10199
|
+
*
|
|
10200
|
+
*/
|
|
10201
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
10202
|
+
/**
|
|
10203
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
10204
|
+
*/
|
|
10205
|
+
edit_mode_config?: {
|
|
10206
|
+
match_strategy?: /**
|
|
10207
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
10208
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
10209
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
10210
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
10211
|
+
*
|
|
10212
|
+
*/
|
|
10213
|
+
MatchStrategy;
|
|
10214
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
10215
|
+
};
|
|
9268
10216
|
type: "sequence";
|
|
9269
10217
|
/**
|
|
9270
10218
|
* Prefix added before the sequence number
|
|
@@ -9431,12 +10379,34 @@ declare namespace Components {
|
|
|
9431
10379
|
* such as internal hashes or identifiers that might accidentally match search terms.
|
|
9432
10380
|
*
|
|
9433
10381
|
*/
|
|
9434
|
-
exclude_from_search?: boolean;
|
|
10382
|
+
exclude_from_search?: boolean;
|
|
10383
|
+
/**
|
|
10384
|
+
* The attribute is a repeatable
|
|
10385
|
+
*/
|
|
10386
|
+
repeatable?: boolean;
|
|
10387
|
+
has_primary?: boolean;
|
|
10388
|
+
/**
|
|
10389
|
+
* Controls how updates to this attribute are handled.
|
|
10390
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
10391
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
10392
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
10393
|
+
*
|
|
10394
|
+
*/
|
|
10395
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
9435
10396
|
/**
|
|
9436
|
-
*
|
|
10397
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
9437
10398
|
*/
|
|
9438
|
-
|
|
9439
|
-
|
|
10399
|
+
edit_mode_config?: {
|
|
10400
|
+
match_strategy?: /**
|
|
10401
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
10402
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
10403
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
10404
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
10405
|
+
*
|
|
10406
|
+
*/
|
|
10407
|
+
MatchStrategy;
|
|
10408
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
10409
|
+
};
|
|
9440
10410
|
type: "status";
|
|
9441
10411
|
options?: ((string | null) | {
|
|
9442
10412
|
/**
|
|
@@ -9688,6 +10658,28 @@ declare namespace Components {
|
|
|
9688
10658
|
*/
|
|
9689
10659
|
repeatable?: boolean;
|
|
9690
10660
|
has_primary?: boolean;
|
|
10661
|
+
/**
|
|
10662
|
+
* Controls how updates to this attribute are handled.
|
|
10663
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
10664
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
10665
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
10666
|
+
*
|
|
10667
|
+
*/
|
|
10668
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
10669
|
+
/**
|
|
10670
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
10671
|
+
*/
|
|
10672
|
+
edit_mode_config?: {
|
|
10673
|
+
match_strategy?: /**
|
|
10674
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
10675
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
10676
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
10677
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
10678
|
+
*
|
|
10679
|
+
*/
|
|
10680
|
+
MatchStrategy;
|
|
10681
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
10682
|
+
};
|
|
9691
10683
|
type: "table";
|
|
9692
10684
|
/**
|
|
9693
10685
|
* Column definitions for the table
|
|
@@ -9899,6 +10891,28 @@ declare namespace Components {
|
|
|
9899
10891
|
*/
|
|
9900
10892
|
repeatable?: boolean;
|
|
9901
10893
|
has_primary?: boolean;
|
|
10894
|
+
/**
|
|
10895
|
+
* Controls how updates to this attribute are handled.
|
|
10896
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
10897
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
10898
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
10899
|
+
*
|
|
10900
|
+
*/
|
|
10901
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
10902
|
+
/**
|
|
10903
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
10904
|
+
*/
|
|
10905
|
+
edit_mode_config?: {
|
|
10906
|
+
match_strategy?: /**
|
|
10907
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
10908
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
10909
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
10910
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
10911
|
+
*
|
|
10912
|
+
*/
|
|
10913
|
+
MatchStrategy;
|
|
10914
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
10915
|
+
};
|
|
9902
10916
|
type: "tags";
|
|
9903
10917
|
options?: string[];
|
|
9904
10918
|
suggestions?: string[];
|
|
@@ -10256,6 +11270,28 @@ declare namespace Components {
|
|
|
10256
11270
|
*/
|
|
10257
11271
|
repeatable?: boolean;
|
|
10258
11272
|
has_primary?: boolean;
|
|
11273
|
+
/**
|
|
11274
|
+
* Controls how updates to this attribute are handled.
|
|
11275
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
11276
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
11277
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
11278
|
+
*
|
|
11279
|
+
*/
|
|
11280
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
11281
|
+
/**
|
|
11282
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
11283
|
+
*/
|
|
11284
|
+
edit_mode_config?: {
|
|
11285
|
+
match_strategy?: /**
|
|
11286
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
11287
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
11288
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
11289
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
11290
|
+
*
|
|
11291
|
+
*/
|
|
11292
|
+
MatchStrategy;
|
|
11293
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
11294
|
+
};
|
|
10259
11295
|
type: "string";
|
|
10260
11296
|
multiline?: boolean;
|
|
10261
11297
|
rich_text?: boolean;
|
|
@@ -10424,6 +11460,28 @@ declare namespace Components {
|
|
|
10424
11460
|
*/
|
|
10425
11461
|
repeatable?: boolean;
|
|
10426
11462
|
has_primary?: boolean;
|
|
11463
|
+
/**
|
|
11464
|
+
* Controls how updates to this attribute are handled.
|
|
11465
|
+
* - `direct` (default): update is applied immediately. No changeset created.
|
|
11466
|
+
* - `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).
|
|
11467
|
+
* - `approval`: update creates a changeset, requires explicit human approval.
|
|
11468
|
+
*
|
|
11469
|
+
*/
|
|
11470
|
+
edit_mode?: "direct" | "external" | "approval";
|
|
11471
|
+
/**
|
|
11472
|
+
* Configuration for non-direct edit modes. Required when edit_mode is external or approval with fuzzy match strategy.
|
|
11473
|
+
*/
|
|
11474
|
+
edit_mode_config?: {
|
|
11475
|
+
match_strategy?: /**
|
|
11476
|
+
* Strategy for auto-clearing the changeset when an external update is received.
|
|
11477
|
+
* - `exact`: The inbound value must exactly match the proposed value (deep equality).
|
|
11478
|
+
* - `fuzzy`: The inbound value is compared using the configured fuzzy algorithm.
|
|
11479
|
+
* - `any`: Any update to the attribute clears the changeset, regardless of value.
|
|
11480
|
+
*
|
|
11481
|
+
*/
|
|
11482
|
+
MatchStrategy;
|
|
11483
|
+
fuzzy_config?: /* Configuration for fuzzy match strategies on changeset auto-clearing. */ FuzzyConfig;
|
|
11484
|
+
};
|
|
10427
11485
|
type: "relation_user";
|
|
10428
11486
|
multiple?: boolean;
|
|
10429
11487
|
}
|
|
@@ -10469,6 +11527,81 @@ declare namespace Paths {
|
|
|
10469
11527
|
Components.Responses.NotFoundError;
|
|
10470
11528
|
}
|
|
10471
11529
|
}
|
|
11530
|
+
namespace ApplyChangeset {
|
|
11531
|
+
namespace Parameters {
|
|
11532
|
+
export type Attribute = string;
|
|
11533
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
11534
|
+
export type Slug = /**
|
|
11535
|
+
* URL-friendly identifier for the entity schema
|
|
11536
|
+
* example:
|
|
11537
|
+
* contact
|
|
11538
|
+
*/
|
|
11539
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11540
|
+
}
|
|
11541
|
+
export interface PathParameters {
|
|
11542
|
+
slug: Parameters.Slug;
|
|
11543
|
+
id: Parameters.Id;
|
|
11544
|
+
attribute: Parameters.Attribute;
|
|
11545
|
+
}
|
|
11546
|
+
namespace Responses {
|
|
11547
|
+
export type $200 = /**
|
|
11548
|
+
* example:
|
|
11549
|
+
* {
|
|
11550
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
11551
|
+
* "_org": "123",
|
|
11552
|
+
* "_owners": [
|
|
11553
|
+
* {
|
|
11554
|
+
* "org_id": "123",
|
|
11555
|
+
* "user_id": "123"
|
|
11556
|
+
* },
|
|
11557
|
+
* {
|
|
11558
|
+
* "org_id": "123",
|
|
11559
|
+
* "user_id": "123"
|
|
11560
|
+
* }
|
|
11561
|
+
* ],
|
|
11562
|
+
* "_schema": "contact",
|
|
11563
|
+
* "_tags": [
|
|
11564
|
+
* "example",
|
|
11565
|
+
* "mock",
|
|
11566
|
+
* "example",
|
|
11567
|
+
* "mock"
|
|
11568
|
+
* ],
|
|
11569
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
11570
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
11571
|
+
* "_acl": {
|
|
11572
|
+
* "view": [
|
|
11573
|
+
* "org:456",
|
|
11574
|
+
* "org:789",
|
|
11575
|
+
* "org:456",
|
|
11576
|
+
* "org:789"
|
|
11577
|
+
* ],
|
|
11578
|
+
* "edit": [
|
|
11579
|
+
* "org:456",
|
|
11580
|
+
* "org:456"
|
|
11581
|
+
* ],
|
|
11582
|
+
* "delete": [
|
|
11583
|
+
* "org:456",
|
|
11584
|
+
* "org:456"
|
|
11585
|
+
* ]
|
|
11586
|
+
* },
|
|
11587
|
+
* "_manifest": [
|
|
11588
|
+
* "123e4567-e89b-12d3-a456-426614174000",
|
|
11589
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
11590
|
+
* ]
|
|
11591
|
+
* }
|
|
11592
|
+
*/
|
|
11593
|
+
Components.Schemas.EntityItem;
|
|
11594
|
+
export type $404 = /**
|
|
11595
|
+
* A generic error returned by the API
|
|
11596
|
+
* example:
|
|
11597
|
+
* {
|
|
11598
|
+
* "status": 404,
|
|
11599
|
+
* "error": "Not Found"
|
|
11600
|
+
* }
|
|
11601
|
+
*/
|
|
11602
|
+
Components.Responses.NotFoundError;
|
|
11603
|
+
}
|
|
11604
|
+
}
|
|
10472
11605
|
namespace AttachActivity {
|
|
10473
11606
|
namespace Parameters {
|
|
10474
11607
|
export type Entities = Components.Schemas.EntityId /* uuid */[];
|
|
@@ -11235,6 +12368,87 @@ declare namespace Paths {
|
|
|
11235
12368
|
Components.Responses.TooManyRequestsError;
|
|
11236
12369
|
}
|
|
11237
12370
|
}
|
|
12371
|
+
namespace DismissChangeset {
|
|
12372
|
+
namespace Parameters {
|
|
12373
|
+
export type Attribute = string;
|
|
12374
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
12375
|
+
export type Slug = /**
|
|
12376
|
+
* URL-friendly identifier for the entity schema
|
|
12377
|
+
* example:
|
|
12378
|
+
* contact
|
|
12379
|
+
*/
|
|
12380
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
12381
|
+
}
|
|
12382
|
+
export interface PathParameters {
|
|
12383
|
+
slug: Parameters.Slug;
|
|
12384
|
+
id: Parameters.Id;
|
|
12385
|
+
attribute: Parameters.Attribute;
|
|
12386
|
+
}
|
|
12387
|
+
export interface RequestBody {
|
|
12388
|
+
/**
|
|
12389
|
+
* Optional reason for dismissing the changeset
|
|
12390
|
+
*/
|
|
12391
|
+
reason?: string;
|
|
12392
|
+
}
|
|
12393
|
+
namespace Responses {
|
|
12394
|
+
export type $200 = /**
|
|
12395
|
+
* example:
|
|
12396
|
+
* {
|
|
12397
|
+
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
12398
|
+
* "_org": "123",
|
|
12399
|
+
* "_owners": [
|
|
12400
|
+
* {
|
|
12401
|
+
* "org_id": "123",
|
|
12402
|
+
* "user_id": "123"
|
|
12403
|
+
* },
|
|
12404
|
+
* {
|
|
12405
|
+
* "org_id": "123",
|
|
12406
|
+
* "user_id": "123"
|
|
12407
|
+
* }
|
|
12408
|
+
* ],
|
|
12409
|
+
* "_schema": "contact",
|
|
12410
|
+
* "_tags": [
|
|
12411
|
+
* "example",
|
|
12412
|
+
* "mock",
|
|
12413
|
+
* "example",
|
|
12414
|
+
* "mock"
|
|
12415
|
+
* ],
|
|
12416
|
+
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
12417
|
+
* "_updated_at": "2021-02-09T12:41:43.662Z",
|
|
12418
|
+
* "_acl": {
|
|
12419
|
+
* "view": [
|
|
12420
|
+
* "org:456",
|
|
12421
|
+
* "org:789",
|
|
12422
|
+
* "org:456",
|
|
12423
|
+
* "org:789"
|
|
12424
|
+
* ],
|
|
12425
|
+
* "edit": [
|
|
12426
|
+
* "org:456",
|
|
12427
|
+
* "org:456"
|
|
12428
|
+
* ],
|
|
12429
|
+
* "delete": [
|
|
12430
|
+
* "org:456",
|
|
12431
|
+
* "org:456"
|
|
12432
|
+
* ]
|
|
12433
|
+
* },
|
|
12434
|
+
* "_manifest": [
|
|
12435
|
+
* "123e4567-e89b-12d3-a456-426614174000",
|
|
12436
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
12437
|
+
* ]
|
|
12438
|
+
* }
|
|
12439
|
+
*/
|
|
12440
|
+
Components.Schemas.EntityItem;
|
|
12441
|
+
export type $404 = /**
|
|
12442
|
+
* A generic error returned by the API
|
|
12443
|
+
* example:
|
|
12444
|
+
* {
|
|
12445
|
+
* "status": 404,
|
|
12446
|
+
* "error": "Not Found"
|
|
12447
|
+
* }
|
|
12448
|
+
*/
|
|
12449
|
+
Components.Responses.NotFoundError;
|
|
12450
|
+
}
|
|
12451
|
+
}
|
|
11238
12452
|
namespace ExportEntities {
|
|
11239
12453
|
namespace Parameters {
|
|
11240
12454
|
export type IsTemplate = /* Pass 'true' to generate import template */ Components.Schemas.IsTemplate;
|
|
@@ -11542,6 +12756,7 @@ declare namespace Paths {
|
|
|
11542
12756
|
}
|
|
11543
12757
|
namespace GetEntityV2 {
|
|
11544
12758
|
namespace Parameters {
|
|
12759
|
+
export type ApplyChangesets = boolean;
|
|
11545
12760
|
export type Fields = /**
|
|
11546
12761
|
* List of entity fields to include or exclude in the response
|
|
11547
12762
|
*
|
|
@@ -11576,6 +12791,7 @@ declare namespace Paths {
|
|
|
11576
12791
|
export interface QueryParameters {
|
|
11577
12792
|
hydrate?: Parameters.Hydrate;
|
|
11578
12793
|
fields?: Parameters.Fields;
|
|
12794
|
+
apply_changesets?: Parameters.ApplyChangesets;
|
|
11579
12795
|
}
|
|
11580
12796
|
namespace Responses {
|
|
11581
12797
|
export type $200 = /**
|
|
@@ -12480,7 +13696,7 @@ declare namespace Paths {
|
|
|
12480
13696
|
/**
|
|
12481
13697
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
12482
13698
|
* example:
|
|
12483
|
-
* 2023-01-01T00:00:
|
|
13699
|
+
* 2023-01-01T00:00:00Z
|
|
12484
13700
|
*/
|
|
12485
13701
|
export type CreatedAfter = string; // date-time
|
|
12486
13702
|
/**
|
|
@@ -12506,7 +13722,7 @@ declare namespace Paths {
|
|
|
12506
13722
|
created_after?: /**
|
|
12507
13723
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
12508
13724
|
* example:
|
|
12509
|
-
* 2023-01-01T00:00:
|
|
13725
|
+
* 2023-01-01T00:00:00Z
|
|
12510
13726
|
*/
|
|
12511
13727
|
Parameters.CreatedAfter /* date-time */;
|
|
12512
13728
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -12593,6 +13809,33 @@ declare namespace Paths {
|
|
|
12593
13809
|
}
|
|
12594
13810
|
}
|
|
12595
13811
|
}
|
|
13812
|
+
namespace ListChangesets {
|
|
13813
|
+
namespace Parameters {
|
|
13814
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
13815
|
+
export type Slug = /**
|
|
13816
|
+
* URL-friendly identifier for the entity schema
|
|
13817
|
+
* example:
|
|
13818
|
+
* contact
|
|
13819
|
+
*/
|
|
13820
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
13821
|
+
}
|
|
13822
|
+
export interface PathParameters {
|
|
13823
|
+
slug: Parameters.Slug;
|
|
13824
|
+
id: Parameters.Id;
|
|
13825
|
+
}
|
|
13826
|
+
namespace Responses {
|
|
13827
|
+
export type $200 = /* Map of attribute name to pending changeset. At most one changeset per attribute. */ Components.Schemas.ChangesetMap;
|
|
13828
|
+
export type $404 = /**
|
|
13829
|
+
* A generic error returned by the API
|
|
13830
|
+
* example:
|
|
13831
|
+
* {
|
|
13832
|
+
* "status": 404,
|
|
13833
|
+
* "error": "Not Found"
|
|
13834
|
+
* }
|
|
13835
|
+
*/
|
|
13836
|
+
Components.Responses.NotFoundError;
|
|
13837
|
+
}
|
|
13838
|
+
}
|
|
12596
13839
|
namespace ListEntities {
|
|
12597
13840
|
export type RequestBody = Components.Schemas.EntityListParams;
|
|
12598
13841
|
namespace Responses {
|
|
@@ -12753,6 +13996,7 @@ declare namespace Paths {
|
|
|
12753
13996
|
*/
|
|
12754
13997
|
Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
12755
13998
|
export type Async = boolean;
|
|
13999
|
+
export type Direct = boolean;
|
|
12756
14000
|
export type DryRun = boolean;
|
|
12757
14001
|
export type FillActivity = boolean;
|
|
12758
14002
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
@@ -12774,6 +14018,7 @@ declare namespace Paths {
|
|
|
12774
14018
|
dry_run?: Parameters.DryRun;
|
|
12775
14019
|
async?: Parameters.Async;
|
|
12776
14020
|
validate?: Parameters.Validate;
|
|
14021
|
+
direct?: Parameters.Direct;
|
|
12777
14022
|
}
|
|
12778
14023
|
export type RequestBody = /**
|
|
12779
14024
|
* example:
|
|
@@ -13401,6 +14646,7 @@ declare namespace Paths {
|
|
|
13401
14646
|
*/
|
|
13402
14647
|
Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
13403
14648
|
export type Async = boolean;
|
|
14649
|
+
export type Direct = boolean;
|
|
13404
14650
|
export type FillActivity = boolean;
|
|
13405
14651
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
13406
14652
|
export type Slug = /**
|
|
@@ -13420,6 +14666,7 @@ declare namespace Paths {
|
|
|
13420
14666
|
fill_activity?: Parameters.FillActivity;
|
|
13421
14667
|
async?: Parameters.Async;
|
|
13422
14668
|
validate?: Parameters.Validate;
|
|
14669
|
+
direct?: Parameters.Direct;
|
|
13423
14670
|
}
|
|
13424
14671
|
export type RequestBody = /**
|
|
13425
14672
|
* example:
|
|
@@ -13928,6 +15175,7 @@ declare namespace Paths {
|
|
|
13928
15175
|
}
|
|
13929
15176
|
}
|
|
13930
15177
|
|
|
15178
|
+
|
|
13931
15179
|
interface OperationMethods {
|
|
13932
15180
|
/**
|
|
13933
15181
|
* listSchemas - listSchemas
|
|
@@ -14498,6 +15746,39 @@ interface OperationMethods {
|
|
|
14498
15746
|
data?: any,
|
|
14499
15747
|
config?: AxiosRequestConfig
|
|
14500
15748
|
): OperationResponse<Paths.AttachActivity.Responses.$200>
|
|
15749
|
+
/**
|
|
15750
|
+
* applyChangeset - applyChangeset
|
|
15751
|
+
*
|
|
15752
|
+
* Applies the proposed value from a pending changeset to the entity attribute
|
|
15753
|
+
* and removes the changeset. Used for human approval of pending changes.
|
|
15754
|
+
*
|
|
15755
|
+
*/
|
|
15756
|
+
'applyChangeset'(
|
|
15757
|
+
parameters?: Parameters<Paths.ApplyChangeset.PathParameters> | null,
|
|
15758
|
+
data?: any,
|
|
15759
|
+
config?: AxiosRequestConfig
|
|
15760
|
+
): OperationResponse<Paths.ApplyChangeset.Responses.$200>
|
|
15761
|
+
/**
|
|
15762
|
+
* dismissChangeset - dismissChangeset
|
|
15763
|
+
*
|
|
15764
|
+
* Removes a pending changeset without applying it. The attribute value remains unchanged.
|
|
15765
|
+
*
|
|
15766
|
+
*/
|
|
15767
|
+
'dismissChangeset'(
|
|
15768
|
+
parameters?: Parameters<Paths.DismissChangeset.PathParameters> | null,
|
|
15769
|
+
data?: Paths.DismissChangeset.RequestBody,
|
|
15770
|
+
config?: AxiosRequestConfig
|
|
15771
|
+
): OperationResponse<Paths.DismissChangeset.Responses.$200>
|
|
15772
|
+
/**
|
|
15773
|
+
* listChangesets - listChangesets
|
|
15774
|
+
*
|
|
15775
|
+
* Returns all pending changesets for an entity.
|
|
15776
|
+
*/
|
|
15777
|
+
'listChangesets'(
|
|
15778
|
+
parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
|
|
15779
|
+
data?: any,
|
|
15780
|
+
config?: AxiosRequestConfig
|
|
15781
|
+
): OperationResponse<Paths.ListChangesets.Responses.$200>
|
|
14501
15782
|
/**
|
|
14502
15783
|
* getEntityActivityFeed - getEntityActivityFeed
|
|
14503
15784
|
*
|
|
@@ -15694,6 +16975,45 @@ interface PathsDictionary {
|
|
|
15694
16975
|
config?: AxiosRequestConfig
|
|
15695
16976
|
): OperationResponse<Paths.AttachActivity.Responses.$200>
|
|
15696
16977
|
}
|
|
16978
|
+
['/v1/entity/{slug}/{id}/changesets/{attribute}:apply']: {
|
|
16979
|
+
/**
|
|
16980
|
+
* applyChangeset - applyChangeset
|
|
16981
|
+
*
|
|
16982
|
+
* Applies the proposed value from a pending changeset to the entity attribute
|
|
16983
|
+
* and removes the changeset. Used for human approval of pending changes.
|
|
16984
|
+
*
|
|
16985
|
+
*/
|
|
16986
|
+
'post'(
|
|
16987
|
+
parameters?: Parameters<Paths.ApplyChangeset.PathParameters> | null,
|
|
16988
|
+
data?: any,
|
|
16989
|
+
config?: AxiosRequestConfig
|
|
16990
|
+
): OperationResponse<Paths.ApplyChangeset.Responses.$200>
|
|
16991
|
+
}
|
|
16992
|
+
['/v1/entity/{slug}/{id}/changesets/{attribute}:dismiss']: {
|
|
16993
|
+
/**
|
|
16994
|
+
* dismissChangeset - dismissChangeset
|
|
16995
|
+
*
|
|
16996
|
+
* Removes a pending changeset without applying it. The attribute value remains unchanged.
|
|
16997
|
+
*
|
|
16998
|
+
*/
|
|
16999
|
+
'post'(
|
|
17000
|
+
parameters?: Parameters<Paths.DismissChangeset.PathParameters> | null,
|
|
17001
|
+
data?: Paths.DismissChangeset.RequestBody,
|
|
17002
|
+
config?: AxiosRequestConfig
|
|
17003
|
+
): OperationResponse<Paths.DismissChangeset.Responses.$200>
|
|
17004
|
+
}
|
|
17005
|
+
['/v1/entity/{slug}/{id}/changesets']: {
|
|
17006
|
+
/**
|
|
17007
|
+
* listChangesets - listChangesets
|
|
17008
|
+
*
|
|
17009
|
+
* Returns all pending changesets for an entity.
|
|
17010
|
+
*/
|
|
17011
|
+
'get'(
|
|
17012
|
+
parameters?: Parameters<Paths.ListChangesets.PathParameters> | null,
|
|
17013
|
+
data?: any,
|
|
17014
|
+
config?: AxiosRequestConfig
|
|
17015
|
+
): OperationResponse<Paths.ListChangesets.Responses.$200>
|
|
17016
|
+
}
|
|
15697
17017
|
['/v1/entity/{slug}/{id}/activity']: {
|
|
15698
17018
|
/**
|
|
15699
17019
|
* getEntityActivityFeed - getEntityActivityFeed
|
|
@@ -16338,6 +17658,7 @@ interface PathsDictionary {
|
|
|
16338
17658
|
|
|
16339
17659
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
16340
17660
|
|
|
17661
|
+
|
|
16341
17662
|
type Activity = Components.Schemas.Activity;
|
|
16342
17663
|
type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
|
|
16343
17664
|
type ActivityId = Components.Schemas.ActivityId;
|
|
@@ -16353,6 +17674,9 @@ type BaseAttribute = Components.Schemas.BaseAttribute;
|
|
|
16353
17674
|
type BaseEntity = Components.Schemas.BaseEntity;
|
|
16354
17675
|
type BlueprintEntityId = Components.Schemas.BlueprintEntityId;
|
|
16355
17676
|
type BooleanAttribute = Components.Schemas.BooleanAttribute;
|
|
17677
|
+
type Changeset = Components.Schemas.Changeset;
|
|
17678
|
+
type ChangesetCreator = Components.Schemas.ChangesetCreator;
|
|
17679
|
+
type ChangesetMap = Components.Schemas.ChangesetMap;
|
|
16356
17680
|
type ClassificationId = Components.Schemas.ClassificationId;
|
|
16357
17681
|
type ClassificationIdOrPattern = Components.Schemas.ClassificationIdOrPattern;
|
|
16358
17682
|
type ClassificationSlug = Components.Schemas.ClassificationSlug;
|
|
@@ -16364,6 +17688,7 @@ type CurrencyAttribute = Components.Schemas.CurrencyAttribute;
|
|
|
16364
17688
|
type DateAttribute = Components.Schemas.DateAttribute;
|
|
16365
17689
|
type DefaultAddressFields = Components.Schemas.DefaultAddressFields;
|
|
16366
17690
|
type ESClusterAssignment = Components.Schemas.ESClusterAssignment;
|
|
17691
|
+
type EditModeConfig = Components.Schemas.EditModeConfig;
|
|
16367
17692
|
type EmailAttribute = Components.Schemas.EmailAttribute;
|
|
16368
17693
|
type Entity = Components.Schemas.Entity;
|
|
16369
17694
|
type EntityAcl = Components.Schemas.EntityAcl;
|
|
@@ -16403,6 +17728,7 @@ type ErrorObject = Components.Schemas.ErrorObject;
|
|
|
16403
17728
|
type ExportJobId = Components.Schemas.ExportJobId;
|
|
16404
17729
|
type FieldsParam = Components.Schemas.FieldsParam;
|
|
16405
17730
|
type FileAttribute = Components.Schemas.FileAttribute;
|
|
17731
|
+
type FuzzyConfig = Components.Schemas.FuzzyConfig;
|
|
16406
17732
|
type GenerateEntityTableAIFiltersRequest = Components.Schemas.GenerateEntityTableAIFiltersRequest;
|
|
16407
17733
|
type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEntityTableAIFiltersResponse;
|
|
16408
17734
|
type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
|
@@ -16425,6 +17751,7 @@ type IsTemplate = Components.Schemas.IsTemplate;
|
|
|
16425
17751
|
type Language = Components.Schemas.Language;
|
|
16426
17752
|
type LinkAttribute = Components.Schemas.LinkAttribute;
|
|
16427
17753
|
type ListSavedViewsResults = Components.Schemas.ListSavedViewsResults;
|
|
17754
|
+
type MatchStrategy = Components.Schemas.MatchStrategy;
|
|
16428
17755
|
type MessageEmailAddressAttribute = Components.Schemas.MessageEmailAddressAttribute;
|
|
16429
17756
|
type MultiSelectAttribute = Components.Schemas.MultiSelectAttribute;
|
|
16430
17757
|
type NullableEntity = Components.Schemas.NullableEntity;
|
|
@@ -16471,4 +17798,4 @@ type TaxonomySlug = Components.Schemas.TaxonomySlug;
|
|
|
16471
17798
|
type TextAttribute = Components.Schemas.TextAttribute;
|
|
16472
17799
|
type UserRelationAttribute = Components.Schemas.UserRelationAttribute;
|
|
16473
17800
|
|
|
16474
|
-
export { type
|
|
17801
|
+
export { type EntitySchemaItem as $, type Activity as A, type BaseActivityItem as B, type Client as C, type DateAttribute as D, type DefaultAddressFields as E, type ESClusterAssignment as F, type EditModeConfig as G, type EmailAttribute as H, type Entity as I, type EntityAcl as J, type EntityAction as K, type EntityCapability as L, type EntityCapabilityWithCompositeID as M, type EntityDefaultCreate as N, type OperationMethods as O, Paths as P, type EntityDefaultEdit as Q, type EntityDefaultTable as R, type EntityId as S, type EntityImportParams as T, type EntityItem as U, type EntityListParams as V, type EntityOperation as W, type EntityOwner as X, type EntitySchema as Y, type EntitySchemaGroup as Z, type EntitySchemaGroupWithCompositeID as _, Components as a, type SavedViewId as a$, type EntitySearchIncludeDeletedParam as a0, type EntitySearchOptions as a1, type EntitySearchParams as a2, type EntitySearchResults as a3, type EntitySlug as a4, type EntityTableFilterOption as a5, type EntityTableFilterSearch as a6, type EntityValidationError as a7, type EntityValidationResult as a8, type EntityValidationResultError as a9, type InternalAttribute as aA, type InternalUserAttribute as aB, type InvitationEmailAttribute as aC, type IsTemplate as aD, type Language as aE, type LinkAttribute as aF, type ListSavedViewsResults as aG, type MatchStrategy as aH, type MessageEmailAddressAttribute as aI, type MultiSelectAttribute as aJ, type NullableEntity as aK, type NumberAttribute as aL, type OrderedListAttribute as aM, type PartnerOrganisationAttribute as aN, type PartnerStatusAttribute as aO, type PaymentAttribute as aP, type PaymentMethodRelationAttribute as aQ, type PhoneAttribute as aR, type PortalAccessAttribute as aS, type PriceComponentAttribute as aT, type PurposeAttribute as aU, type RedirectEntityView as aV, type RelationAttribute as aW, type RelationEntity as aX, type RelationItem as aY, type RepeatableAttribute as aZ, type SavedView as a_, type EntityValidationResultSuccess as aa, type EntityValidationV2Error as ab, type EntityValidationV2Result as ac, type EntityValidationV2ResultError as ad, type EntityValidationV2ResultSuccess as ae, type EntityViewDisabled as af, type ErrorObject as ag, type ExportJobId as ah, type FieldsParam as ai, type FileAttribute as aj, type FuzzyConfig as ak, type GenerateEntityTableAIFiltersRequest as al, type GenerateEntityTableAIFiltersResponse as am, GetRelatedEntitiesCount as an, type GetRelationsResp as ao, type GetRelationsRespWithPagination as ap, type GraphDefinition as aq, type GraphEdge as ar, type GraphNode as as, type GraphQueryRequest as at, type GraphQueryResponse as au, type GraphSeed as av, type GroupHeadline as aw, type GroupHeadlineWithCompositeID as ax, type HydratedEntity as ay, type HydratedEntityItem as az, type PathsDictionary as b, type SavedViewItem as b0, type SavedViewPartial as b1, type SchemaId as b2, type SearchFilter as b3, type SearchFilterValue as b4, type SearchMappings as b5, type SelectAttribute as b6, type SequenceAttribute as b7, type SettingFlag as b8, type StatusAttribute as b9, type SummaryAttribute as ba, type SummaryField as bb, type TableAttribute as bc, type TagsAttribute as bd, type Taxonomy as be, type TaxonomyBulkJob as bf, type TaxonomyBulkJobActionType as bg, type TaxonomyBulkJobStatus as bh, type TaxonomyBulkJobTriggerResponse as bi, type TaxonomyClassification as bj, type TaxonomyLocationId as bk, type TaxonomySearchIncludeArchivedParam as bl, type TaxonomySlug as bm, type TextAttribute as bn, type UserRelationAttribute as bo, 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 BaseEntity as m, type BlueprintEntityId as n, type BooleanAttribute as o, type Changeset as p, type ChangesetCreator as q, type ChangesetMap as r, type ClassificationId as s, type ClassificationIdOrPattern as t, type ClassificationSlug as u, type ClassificationsUpdate as v, type ComputedAttribute as w, type ConsentAttribute as x, type CountryAttribute as y, type CurrencyAttribute as z };
|