@epilot/sdk 2.20.69 → 2.20.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/identity-runtime.json +1 -1
- package/definitions/identity.json +219 -34
- package/definitions/validation-rules-runtime.json +1 -1
- package/definitions/validation-rules.json +56 -10
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.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 +6 -6
- package/dist/apis/entity.js +1 -1
- 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/external-values.cjs +6 -6
- package/dist/apis/external-values.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/identity.cjs +8 -8
- package/dist/apis/identity.js +2 -2
- 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/phone-integration.cjs +6 -6
- package/dist/apis/phone-integration.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +8 -8
- package/dist/apis/validation-rules.d.cts +2 -2
- package/dist/apis/validation-rules.d.ts +2 -2
- package/dist/apis/validation-rules.js +2 -2
- 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-7IKQIVUS.js +14 -0
- package/dist/{chunk-3IBAPVLY.js → chunk-DSYS22AC.js} +1 -1
- package/dist/chunk-JIUTCNTB.cjs +14 -0
- package/dist/{chunk-PAMXQWNL.cjs → chunk-M6RNRDA3.cjs} +4 -4
- package/dist/{chunk-BVDXJ4QV.js → chunk-N2IV6QYZ.js} +4 -4
- package/dist/{chunk-RPWTWCDC.cjs → chunk-TKRZK7V2.cjs} +1 -1
- package/dist/identity-F5XHYPXY.js +7 -0
- package/dist/identity-JDTGYAOV.cjs +7 -0
- package/dist/{identity-runtime-PFM5KQWA.js → identity-runtime-A4LSC77N.js} +1 -1
- package/dist/{identity-runtime-57DQPQWX.cjs → identity-runtime-GNE4EC7V.cjs} +2 -2
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -3
- package/dist/validation-rules-D4OW6VYI.js +7 -0
- package/dist/validation-rules-QYVRILMT.cjs +7 -0
- package/dist/{validation-rules-runtime-VGLVHV36.js → validation-rules-runtime-6MRCS5X2.js} +1 -1
- package/dist/{validation-rules-runtime-DENVKYLF.cjs → validation-rules-runtime-X7M3QE5I.cjs} +2 -2
- package/dist/{validation-rules.d-ChX2VKqg.d.cts → validation-rules.d-C1OtLama.d.cts} +129 -29
- package/dist/{validation-rules.d-ChX2VKqg.d.ts → validation-rules.d-C1OtLama.d.ts} +129 -29
- package/docs/identity.md +58 -64
- package/docs/validation-rules.md +336 -177
- package/package.json +1 -1
- package/dist/chunk-HRSCAD3W.cjs +0 -14
- package/dist/chunk-PPX45U34.js +0 -14
- package/dist/identity-EG35NBZW.js +0 -7
- package/dist/identity-XMX3VFXR.cjs +0 -7
- package/dist/validation-rules-2XSKTPDC.js +0 -7
- package/dist/validation-rules-PHF3RPTN.cjs +0 -7
package/dist/{validation-rules-runtime-DENVKYLF.cjs → validation-rules-runtime-X7M3QE5I.cjs}
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkJIUTCNTBcjs = require('./chunk-JIUTCNTB.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkJIUTCNTBcjs.require_validation_rules_runtime.call(void 0, );
|
|
@@ -25,18 +25,20 @@ declare namespace Components {
|
|
|
25
25
|
operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty";
|
|
26
26
|
/**
|
|
27
27
|
* Comparison value for binary operators: a static number, string or boolean, or a
|
|
28
|
-
* reference resolved at evaluation time. Accepted reference
|
|
28
|
+
* reference resolved at evaluation time. Accepted reference sources: `environment` (a
|
|
29
29
|
* `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
|
|
30
|
-
* can act as a per-organisation switch or threshold
|
|
31
|
-
*
|
|
30
|
+
* can act as a per-organisation switch or threshold, and `parameter` (a value the
|
|
31
|
+
* consuming surface supplies, e.g. another field's answer). Any other source is rejected
|
|
32
|
+
* at write time, and the reference must not carry an `adjust`.
|
|
32
33
|
*
|
|
33
34
|
*/
|
|
34
35
|
value?: /**
|
|
35
36
|
* Comparison value for binary operators: a static number, string or boolean, or a
|
|
36
|
-
* reference resolved at evaluation time. Accepted reference
|
|
37
|
+
* reference resolved at evaluation time. Accepted reference sources: `environment` (a
|
|
37
38
|
* `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
|
|
38
|
-
* can act as a per-organisation switch or threshold
|
|
39
|
-
*
|
|
39
|
+
* can act as a per-organisation switch or threshold, and `parameter` (a value the
|
|
40
|
+
* consuming surface supplies, e.g. another field's answer). Any other source is rejected
|
|
41
|
+
* at write time, and the reference must not carry an `adjust`.
|
|
40
42
|
*
|
|
41
43
|
*/
|
|
42
44
|
number | string | boolean | /**
|
|
@@ -151,7 +153,21 @@ declare namespace Components {
|
|
|
151
153
|
* in public journeys the dependent conditions are skipped.
|
|
152
154
|
*
|
|
153
155
|
*/
|
|
154
|
-
ExternalValue |
|
|
156
|
+
ExternalValue | /**
|
|
157
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
158
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
159
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
160
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
161
|
+
* and stays reusable across journeys and forms.
|
|
162
|
+
*
|
|
163
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
164
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
165
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
166
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
167
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
168
|
+
*
|
|
169
|
+
*/
|
|
170
|
+
ParameterValue | /* A lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive. */ RangeValue | /* No comparison value - used by unary operators such as notInFuture / notInPast. */ NoValue;
|
|
155
171
|
/**
|
|
156
172
|
* An entity context source the rule needs at evaluation time, referenced by `context`
|
|
157
173
|
* value paths via the schema slug as their first segment (e.g. `contract.installment_amount`).
|
|
@@ -580,6 +596,33 @@ declare namespace Components {
|
|
|
580
596
|
*
|
|
581
597
|
*/
|
|
582
598
|
export type Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals";
|
|
599
|
+
/**
|
|
600
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
601
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
602
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
603
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
604
|
+
* and stays reusable across journeys and forms.
|
|
605
|
+
*
|
|
606
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
607
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
608
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
609
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
610
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
611
|
+
*
|
|
612
|
+
*/
|
|
613
|
+
export interface ParameterValue {
|
|
614
|
+
source: "parameter";
|
|
615
|
+
/**
|
|
616
|
+
* Parameter name, e.g. `start_date`.
|
|
617
|
+
*/
|
|
618
|
+
name: string; // ^[a-z][a-z0-9_]{0,63}$
|
|
619
|
+
adjust?: /**
|
|
620
|
+
* Adjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".
|
|
621
|
+
* Used to express tolerance bands such as "at most 10% above the current instalment amount".
|
|
622
|
+
*
|
|
623
|
+
*/
|
|
624
|
+
ValueAdjustment;
|
|
625
|
+
}
|
|
583
626
|
/**
|
|
584
627
|
* Condition definition for a pattern-based validation rule (2 levels deep)
|
|
585
628
|
*/
|
|
@@ -742,8 +785,8 @@ declare namespace Components {
|
|
|
742
785
|
*/
|
|
743
786
|
export interface RangeValue {
|
|
744
787
|
source: "range";
|
|
745
|
-
min: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
746
|
-
max: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
788
|
+
min: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ ScalarValue;
|
|
789
|
+
max: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ ScalarValue;
|
|
747
790
|
}
|
|
748
791
|
/**
|
|
749
792
|
* Condition definition for a regex-based validation rule (2 levels deep)
|
|
@@ -811,18 +854,20 @@ declare namespace Components {
|
|
|
811
854
|
source: "relative_date";
|
|
812
855
|
/**
|
|
813
856
|
* Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
|
|
814
|
-
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference
|
|
815
|
-
* `environment` (a `Number` organisation environment variable)
|
|
816
|
-
* time, and the reference must not carry an
|
|
817
|
-
* whole number within ±36500, the comparison
|
|
857
|
+
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference sources:
|
|
858
|
+
* `environment` (a `Number` organisation environment variable) and `parameter` (a number the consuming
|
|
859
|
+
* surface supplies). Any other source is rejected at write time, and the reference must not carry an
|
|
860
|
+
* `adjust`. If the referenced value is missing or is not a whole number within ±36500, the comparison
|
|
861
|
+
* is unresolved.
|
|
818
862
|
*
|
|
819
863
|
*/
|
|
820
864
|
offset: /**
|
|
821
865
|
* Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
|
|
822
|
-
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference
|
|
823
|
-
* `environment` (a `Number` organisation environment variable)
|
|
824
|
-
* time, and the reference must not carry an
|
|
825
|
-
* whole number within ±36500, the comparison
|
|
866
|
+
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference sources:
|
|
867
|
+
* `environment` (a `Number` organisation environment variable) and `parameter` (a number the consuming
|
|
868
|
+
* surface supplies). Any other source is rejected at write time, and the reference must not carry an
|
|
869
|
+
* `adjust`. If the referenced value is missing or is not a whole number within ±36500, the comparison
|
|
870
|
+
* is unresolved.
|
|
826
871
|
*
|
|
827
872
|
*/
|
|
828
873
|
number | /**
|
|
@@ -833,12 +878,38 @@ declare namespace Components {
|
|
|
833
878
|
*/
|
|
834
879
|
ValueReference;
|
|
835
880
|
unit: "days" | "months" | "years";
|
|
836
|
-
|
|
881
|
+
/**
|
|
882
|
+
* The date the offset is applied to. `today` (the default) is the evaluation moment. A
|
|
883
|
+
* reference resolves to a date at evaluation time - for example a `parameter` bound to
|
|
884
|
+
* another field's date, so "at least one day after the start date" is `offset: 1`,
|
|
885
|
+
* `unit: days` on that anchor. Accepted reference sources: `context`, `environment` (a
|
|
886
|
+
* `Text` variable holding an ISO 8601 date), `external` (a `date` result) and `parameter`.
|
|
887
|
+
* The reference must not carry an `adjust`; if it does not resolve to a date, the
|
|
888
|
+
* comparison is unresolved.
|
|
889
|
+
*
|
|
890
|
+
*/
|
|
891
|
+
anchor?: /**
|
|
892
|
+
* The date the offset is applied to. `today` (the default) is the evaluation moment. A
|
|
893
|
+
* reference resolves to a date at evaluation time - for example a `parameter` bound to
|
|
894
|
+
* another field's date, so "at least one day after the start date" is `offset: 1`,
|
|
895
|
+
* `unit: days` on that anchor. Accepted reference sources: `context`, `environment` (a
|
|
896
|
+
* `Text` variable holding an ISO 8601 date), `external` (a `date` result) and `parameter`.
|
|
897
|
+
* The reference must not carry an `adjust`; if it does not resolve to a date, the
|
|
898
|
+
* comparison is unresolved.
|
|
899
|
+
*
|
|
900
|
+
*/
|
|
901
|
+
("today") | /**
|
|
902
|
+
* A value resolved at evaluation time instead of written into the rule, identified by
|
|
903
|
+
* `source`. Each field that accepts a reference lists the sources it allows; a rule using
|
|
904
|
+
* any other source is rejected when it is saved.
|
|
905
|
+
*
|
|
906
|
+
*/
|
|
907
|
+
ValueReference;
|
|
837
908
|
}
|
|
838
909
|
/**
|
|
839
|
-
* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
910
|
+
* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies.
|
|
840
911
|
*/
|
|
841
|
-
export type ScalarValue = /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
912
|
+
export type ScalarValue = /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ /* A fixed comparison value. */ StaticValue | /**
|
|
842
913
|
* A dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`
|
|
843
914
|
* or `previous_reading.value`. The first path segment must match the `name` of a declared
|
|
844
915
|
* context requirement.
|
|
@@ -871,7 +942,21 @@ declare namespace Components {
|
|
|
871
942
|
* in public journeys the dependent conditions are skipped.
|
|
872
943
|
*
|
|
873
944
|
*/
|
|
874
|
-
ExternalValue
|
|
945
|
+
ExternalValue | /**
|
|
946
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
947
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
948
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
949
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
950
|
+
* and stays reusable across journeys and forms.
|
|
951
|
+
*
|
|
952
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
953
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
954
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
955
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
956
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
957
|
+
*
|
|
958
|
+
*/
|
|
959
|
+
ParameterValue;
|
|
875
960
|
/**
|
|
876
961
|
* A fixed comparison value.
|
|
877
962
|
*/
|
|
@@ -1122,17 +1207,17 @@ declare namespace Components {
|
|
|
1122
1207
|
/**
|
|
1123
1208
|
* The adjustment amount - a fixed non-negative number, or a reference resolving to a
|
|
1124
1209
|
* number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
|
|
1125
|
-
* percentage limit)
|
|
1126
|
-
*
|
|
1127
|
-
* `adjust`.
|
|
1210
|
+
* percentage limit), `environment` (a `Number` organisation environment variable) and
|
|
1211
|
+
* `parameter` (a number the consuming surface supplies). Any other source is rejected at
|
|
1212
|
+
* write time, and the reference must not carry its own `adjust`.
|
|
1128
1213
|
*
|
|
1129
1214
|
*/
|
|
1130
1215
|
value: /**
|
|
1131
1216
|
* The adjustment amount - a fixed non-negative number, or a reference resolving to a
|
|
1132
1217
|
* number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
|
|
1133
|
-
* percentage limit)
|
|
1134
|
-
*
|
|
1135
|
-
* `adjust`.
|
|
1218
|
+
* percentage limit), `environment` (a `Number` organisation environment variable) and
|
|
1219
|
+
* `parameter` (a number the consuming surface supplies). Any other source is rejected at
|
|
1220
|
+
* write time, and the reference must not carry its own `adjust`.
|
|
1136
1221
|
*
|
|
1137
1222
|
*/
|
|
1138
1223
|
number | /**
|
|
@@ -1195,7 +1280,21 @@ declare namespace Components {
|
|
|
1195
1280
|
* in public journeys the dependent conditions are skipped.
|
|
1196
1281
|
*
|
|
1197
1282
|
*/
|
|
1198
|
-
ExternalValue
|
|
1283
|
+
ExternalValue | /**
|
|
1284
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
1285
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
1286
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
1287
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
1288
|
+
* and stays reusable across journeys and forms.
|
|
1289
|
+
*
|
|
1290
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
1291
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
1292
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
1293
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
1294
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
1295
|
+
*
|
|
1296
|
+
*/
|
|
1297
|
+
ParameterValue;
|
|
1199
1298
|
}
|
|
1200
1299
|
}
|
|
1201
1300
|
declare namespace Paths {
|
|
@@ -1703,6 +1802,7 @@ type NumericFactCondition = Components.Schemas.NumericFactCondition;
|
|
|
1703
1802
|
type NumericNestedCondition = Components.Schemas.NumericNestedCondition;
|
|
1704
1803
|
type NumericRuleType = Components.Schemas.NumericRuleType;
|
|
1705
1804
|
type Operator = Components.Schemas.Operator;
|
|
1805
|
+
type ParameterValue = Components.Schemas.ParameterValue;
|
|
1706
1806
|
type PatternCondition = Components.Schemas.PatternCondition;
|
|
1707
1807
|
type PatternFactCondition = Components.Schemas.PatternFactCondition;
|
|
1708
1808
|
type PatternNestedCondition = Components.Schemas.PatternNestedCondition;
|
|
@@ -1722,4 +1822,4 @@ type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
|
|
|
1722
1822
|
type ValueAdjustment = Components.Schemas.ValueAdjustment;
|
|
1723
1823
|
type ValueReference = Components.Schemas.ValueReference;
|
|
1724
1824
|
|
|
1725
|
-
export { type AppliesWhen as A, type
|
|
1825
|
+
export { type AppliesWhen as A, type RegexNestedCondition as B, type Client as C, type DocumentCheck as D, type EnvironmentValue as E, type FileTypesValue as F, type GetValidationRulesResponse as G, type RegexRuleType as H, type RelativeDateValue as I, type StaticValue as J, type UsedBy as K, type ValidationRuleBase as L, type ValueAdjustment as M, type NoValue as N, type OperationMethods as O, Paths as P, type ValueReference as Q, type RangeValue as R, type ScalarValue as S, type UpdateValidationRuleRequest as U, type ValidationRule as V, Components as a, type PathsDictionary as b, type ComparisonRuleType as c, type Condition as d, type ConditionValue as e, type ContextRequirement as f, type ContextValue as g, type CreateValidationRuleRequest as h, type CriteriaValue as i, type DocumentCondition as j, type DocumentConditionValue as k, type DocumentOperator as l, type DocumentRuleType as m, type ExternalValue as n, type NumericCondition as o, type NumericFactCondition as p, type NumericNestedCondition as q, type NumericRuleType as r, type Operator as s, type ParameterValue as t, type PatternCondition as u, type PatternFactCondition as v, type PatternNestedCondition as w, type PatternRuleType as x, type RegexCondition as y, type RegexFactCondition as z };
|
|
@@ -25,18 +25,20 @@ declare namespace Components {
|
|
|
25
25
|
operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty";
|
|
26
26
|
/**
|
|
27
27
|
* Comparison value for binary operators: a static number, string or boolean, or a
|
|
28
|
-
* reference resolved at evaluation time. Accepted reference
|
|
28
|
+
* reference resolved at evaluation time. Accepted reference sources: `environment` (a
|
|
29
29
|
* `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
|
|
30
|
-
* can act as a per-organisation switch or threshold
|
|
31
|
-
*
|
|
30
|
+
* can act as a per-organisation switch or threshold, and `parameter` (a value the
|
|
31
|
+
* consuming surface supplies, e.g. another field's answer). Any other source is rejected
|
|
32
|
+
* at write time, and the reference must not carry an `adjust`.
|
|
32
33
|
*
|
|
33
34
|
*/
|
|
34
35
|
value?: /**
|
|
35
36
|
* Comparison value for binary operators: a static number, string or boolean, or a
|
|
36
|
-
* reference resolved at evaluation time. Accepted reference
|
|
37
|
+
* reference resolved at evaluation time. Accepted reference sources: `environment` (a
|
|
37
38
|
* `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
|
|
38
|
-
* can act as a per-organisation switch or threshold
|
|
39
|
-
*
|
|
39
|
+
* can act as a per-organisation switch or threshold, and `parameter` (a value the
|
|
40
|
+
* consuming surface supplies, e.g. another field's answer). Any other source is rejected
|
|
41
|
+
* at write time, and the reference must not carry an `adjust`.
|
|
40
42
|
*
|
|
41
43
|
*/
|
|
42
44
|
number | string | boolean | /**
|
|
@@ -151,7 +153,21 @@ declare namespace Components {
|
|
|
151
153
|
* in public journeys the dependent conditions are skipped.
|
|
152
154
|
*
|
|
153
155
|
*/
|
|
154
|
-
ExternalValue |
|
|
156
|
+
ExternalValue | /**
|
|
157
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
158
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
159
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
160
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
161
|
+
* and stays reusable across journeys and forms.
|
|
162
|
+
*
|
|
163
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
164
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
165
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
166
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
167
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
168
|
+
*
|
|
169
|
+
*/
|
|
170
|
+
ParameterValue | /* A lower and upper bound for range operators (between, dateBetween, lengthBetween). Bounds are inclusive. */ RangeValue | /* No comparison value - used by unary operators such as notInFuture / notInPast. */ NoValue;
|
|
155
171
|
/**
|
|
156
172
|
* An entity context source the rule needs at evaluation time, referenced by `context`
|
|
157
173
|
* value paths via the schema slug as their first segment (e.g. `contract.installment_amount`).
|
|
@@ -580,6 +596,33 @@ declare namespace Components {
|
|
|
580
596
|
*
|
|
581
597
|
*/
|
|
582
598
|
export type Operator = "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "between" | "dateBefore" | "dateOnOrBefore" | "dateAfter" | "dateOnOrAfter" | "dateBetween" | "notInFuture" | "notInPast" | "contains" | "doesNotContain" | "startsWith" | "endsWith" | "regexMatch" | "lengthBetween" | "maxDigits" | "maxDecimals";
|
|
599
|
+
/**
|
|
600
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
601
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
602
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
603
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
604
|
+
* and stays reusable across journeys and forms.
|
|
605
|
+
*
|
|
606
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
607
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
608
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
609
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
610
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
611
|
+
*
|
|
612
|
+
*/
|
|
613
|
+
export interface ParameterValue {
|
|
614
|
+
source: "parameter";
|
|
615
|
+
/**
|
|
616
|
+
* Parameter name, e.g. `start_date`.
|
|
617
|
+
*/
|
|
618
|
+
name: string; // ^[a-z][a-z0-9_]{0,63}$
|
|
619
|
+
adjust?: /**
|
|
620
|
+
* Adjusts a context-resolved numeric value before comparison, e.g. "context value plus 10 percent".
|
|
621
|
+
* Used to express tolerance bands such as "at most 10% above the current instalment amount".
|
|
622
|
+
*
|
|
623
|
+
*/
|
|
624
|
+
ValueAdjustment;
|
|
625
|
+
}
|
|
583
626
|
/**
|
|
584
627
|
* Condition definition for a pattern-based validation rule (2 levels deep)
|
|
585
628
|
*/
|
|
@@ -742,8 +785,8 @@ declare namespace Components {
|
|
|
742
785
|
*/
|
|
743
786
|
export interface RangeValue {
|
|
744
787
|
source: "range";
|
|
745
|
-
min: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
746
|
-
max: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
788
|
+
min: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ ScalarValue;
|
|
789
|
+
max: /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ ScalarValue;
|
|
747
790
|
}
|
|
748
791
|
/**
|
|
749
792
|
* Condition definition for a regex-based validation rule (2 levels deep)
|
|
@@ -811,18 +854,20 @@ declare namespace Components {
|
|
|
811
854
|
source: "relative_date";
|
|
812
855
|
/**
|
|
813
856
|
* Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
|
|
814
|
-
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference
|
|
815
|
-
* `environment` (a `Number` organisation environment variable)
|
|
816
|
-
* time, and the reference must not carry an
|
|
817
|
-
* whole number within ±36500, the comparison
|
|
857
|
+
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference sources:
|
|
858
|
+
* `environment` (a `Number` organisation environment variable) and `parameter` (a number the consuming
|
|
859
|
+
* surface supplies). Any other source is rejected at write time, and the reference must not carry an
|
|
860
|
+
* `adjust`. If the referenced value is missing or is not a whole number within ±36500, the comparison
|
|
861
|
+
* is unresolved.
|
|
818
862
|
*
|
|
819
863
|
*/
|
|
820
864
|
offset: /**
|
|
821
865
|
* Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
|
|
822
|
-
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference
|
|
823
|
-
* `environment` (a `Number` organisation environment variable)
|
|
824
|
-
* time, and the reference must not carry an
|
|
825
|
-
* whole number within ±36500, the comparison
|
|
866
|
+
* Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference sources:
|
|
867
|
+
* `environment` (a `Number` organisation environment variable) and `parameter` (a number the consuming
|
|
868
|
+
* surface supplies). Any other source is rejected at write time, and the reference must not carry an
|
|
869
|
+
* `adjust`. If the referenced value is missing or is not a whole number within ±36500, the comparison
|
|
870
|
+
* is unresolved.
|
|
826
871
|
*
|
|
827
872
|
*/
|
|
828
873
|
number | /**
|
|
@@ -833,12 +878,38 @@ declare namespace Components {
|
|
|
833
878
|
*/
|
|
834
879
|
ValueReference;
|
|
835
880
|
unit: "days" | "months" | "years";
|
|
836
|
-
|
|
881
|
+
/**
|
|
882
|
+
* The date the offset is applied to. `today` (the default) is the evaluation moment. A
|
|
883
|
+
* reference resolves to a date at evaluation time - for example a `parameter` bound to
|
|
884
|
+
* another field's date, so "at least one day after the start date" is `offset: 1`,
|
|
885
|
+
* `unit: days` on that anchor. Accepted reference sources: `context`, `environment` (a
|
|
886
|
+
* `Text` variable holding an ISO 8601 date), `external` (a `date` result) and `parameter`.
|
|
887
|
+
* The reference must not carry an `adjust`; if it does not resolve to a date, the
|
|
888
|
+
* comparison is unresolved.
|
|
889
|
+
*
|
|
890
|
+
*/
|
|
891
|
+
anchor?: /**
|
|
892
|
+
* The date the offset is applied to. `today` (the default) is the evaluation moment. A
|
|
893
|
+
* reference resolves to a date at evaluation time - for example a `parameter` bound to
|
|
894
|
+
* another field's date, so "at least one day after the start date" is `offset: 1`,
|
|
895
|
+
* `unit: days` on that anchor. Accepted reference sources: `context`, `environment` (a
|
|
896
|
+
* `Text` variable holding an ISO 8601 date), `external` (a `date` result) and `parameter`.
|
|
897
|
+
* The reference must not carry an `adjust`; if it does not resolve to a date, the
|
|
898
|
+
* comparison is unresolved.
|
|
899
|
+
*
|
|
900
|
+
*/
|
|
901
|
+
("today") | /**
|
|
902
|
+
* A value resolved at evaluation time instead of written into the rule, identified by
|
|
903
|
+
* `source`. Each field that accepts a reference lists the sources it allows; a rule using
|
|
904
|
+
* any other source is rejected when it is saved.
|
|
905
|
+
*
|
|
906
|
+
*/
|
|
907
|
+
ValueReference;
|
|
837
908
|
}
|
|
838
909
|
/**
|
|
839
|
-
* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
910
|
+
* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies.
|
|
840
911
|
*/
|
|
841
|
-
export type ScalarValue = /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable,
|
|
912
|
+
export type ScalarValue = /* A single comparison value - static, resolved from context, a relative date, an organisation environment variable, an external value, or a parameter the consuming surface supplies. */ /* A fixed comparison value. */ StaticValue | /**
|
|
842
913
|
* A dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`
|
|
843
914
|
* or `previous_reading.value`. The first path segment must match the `name` of a declared
|
|
844
915
|
* context requirement.
|
|
@@ -871,7 +942,21 @@ declare namespace Components {
|
|
|
871
942
|
* in public journeys the dependent conditions are skipped.
|
|
872
943
|
*
|
|
873
944
|
*/
|
|
874
|
-
ExternalValue
|
|
945
|
+
ExternalValue | /**
|
|
946
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
947
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
948
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
949
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
950
|
+
* and stays reusable across journeys and forms.
|
|
951
|
+
*
|
|
952
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
953
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
954
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
955
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
956
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
957
|
+
*
|
|
958
|
+
*/
|
|
959
|
+
ParameterValue;
|
|
875
960
|
/**
|
|
876
961
|
* A fixed comparison value.
|
|
877
962
|
*/
|
|
@@ -1122,17 +1207,17 @@ declare namespace Components {
|
|
|
1122
1207
|
/**
|
|
1123
1208
|
* The adjustment amount - a fixed non-negative number, or a reference resolving to a
|
|
1124
1209
|
* number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
|
|
1125
|
-
* percentage limit)
|
|
1126
|
-
*
|
|
1127
|
-
* `adjust`.
|
|
1210
|
+
* percentage limit), `environment` (a `Number` organisation environment variable) and
|
|
1211
|
+
* `parameter` (a number the consuming surface supplies). Any other source is rejected at
|
|
1212
|
+
* write time, and the reference must not carry its own `adjust`.
|
|
1128
1213
|
*
|
|
1129
1214
|
*/
|
|
1130
1215
|
value: /**
|
|
1131
1216
|
* The adjustment amount - a fixed non-negative number, or a reference resolving to a
|
|
1132
1217
|
* number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
|
|
1133
|
-
* percentage limit)
|
|
1134
|
-
*
|
|
1135
|
-
* `adjust`.
|
|
1218
|
+
* percentage limit), `environment` (a `Number` organisation environment variable) and
|
|
1219
|
+
* `parameter` (a number the consuming surface supplies). Any other source is rejected at
|
|
1220
|
+
* write time, and the reference must not carry its own `adjust`.
|
|
1136
1221
|
*
|
|
1137
1222
|
*/
|
|
1138
1223
|
number | /**
|
|
@@ -1195,7 +1280,21 @@ declare namespace Components {
|
|
|
1195
1280
|
* in public journeys the dependent conditions are skipped.
|
|
1196
1281
|
*
|
|
1197
1282
|
*/
|
|
1198
|
-
ExternalValue
|
|
1283
|
+
ExternalValue | /**
|
|
1284
|
+
* A comparison value supplied by the surface that evaluates the rule, identified by a name
|
|
1285
|
+
* the rule chooses (e.g. `start_date`). The rule stores the name only. The consuming surface
|
|
1286
|
+
* binds the name to a source of its own - a journey binds it to the value of another block -
|
|
1287
|
+
* and resolves it at evaluation time, so the rule never references the surface's objects
|
|
1288
|
+
* and stays reusable across journeys and forms.
|
|
1289
|
+
*
|
|
1290
|
+
* The kind a parameter is compared as follows from the field it sits in: `number`, `text`
|
|
1291
|
+
* or `date` for comparison values, range bounds, adjustment amounts and relative date
|
|
1292
|
+
* offsets, or a number, string or boolean as an `applies_when` value. One name is compared
|
|
1293
|
+
* as one kind throughout a rule; a rule using a name as two kinds is rejected at write time.
|
|
1294
|
+
* A parameter the surface leaves unbound or empty leaves the comparison unresolved.
|
|
1295
|
+
*
|
|
1296
|
+
*/
|
|
1297
|
+
ParameterValue;
|
|
1199
1298
|
}
|
|
1200
1299
|
}
|
|
1201
1300
|
declare namespace Paths {
|
|
@@ -1703,6 +1802,7 @@ type NumericFactCondition = Components.Schemas.NumericFactCondition;
|
|
|
1703
1802
|
type NumericNestedCondition = Components.Schemas.NumericNestedCondition;
|
|
1704
1803
|
type NumericRuleType = Components.Schemas.NumericRuleType;
|
|
1705
1804
|
type Operator = Components.Schemas.Operator;
|
|
1805
|
+
type ParameterValue = Components.Schemas.ParameterValue;
|
|
1706
1806
|
type PatternCondition = Components.Schemas.PatternCondition;
|
|
1707
1807
|
type PatternFactCondition = Components.Schemas.PatternFactCondition;
|
|
1708
1808
|
type PatternNestedCondition = Components.Schemas.PatternNestedCondition;
|
|
@@ -1722,4 +1822,4 @@ type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
|
|
|
1722
1822
|
type ValueAdjustment = Components.Schemas.ValueAdjustment;
|
|
1723
1823
|
type ValueReference = Components.Schemas.ValueReference;
|
|
1724
1824
|
|
|
1725
|
-
export { type AppliesWhen as A, type
|
|
1825
|
+
export { type AppliesWhen as A, type RegexNestedCondition as B, type Client as C, type DocumentCheck as D, type EnvironmentValue as E, type FileTypesValue as F, type GetValidationRulesResponse as G, type RegexRuleType as H, type RelativeDateValue as I, type StaticValue as J, type UsedBy as K, type ValidationRuleBase as L, type ValueAdjustment as M, type NoValue as N, type OperationMethods as O, Paths as P, type ValueReference as Q, type RangeValue as R, type ScalarValue as S, type UpdateValidationRuleRequest as U, type ValidationRule as V, Components as a, type PathsDictionary as b, type ComparisonRuleType as c, type Condition as d, type ConditionValue as e, type ContextRequirement as f, type ContextValue as g, type CreateValidationRuleRequest as h, type CriteriaValue as i, type DocumentCondition as j, type DocumentConditionValue as k, type DocumentOperator as l, type DocumentRuleType as m, type ExternalValue as n, type NumericCondition as o, type NumericFactCondition as p, type NumericNestedCondition as q, type NumericRuleType as r, type Operator as s, type ParameterValue as t, type PatternCondition as u, type PatternFactCondition as v, type PatternNestedCondition as w, type PatternRuleType as x, type RegexCondition as y, type RegexFactCondition as z };
|