@epilot/sdk 2.20.56 → 2.20.58

package/dist/{validation-rules.d-Bbo90IYn.d.ts → validation-rules.d-ChX2VKqg.d.ts}

@@ -24,31 +24,28 @@ declare namespace Components {
              */
             operator: "equal" | "notEqual" | "greaterThan" | "greaterThanInclusive" | "lessThan" | "lessThanInclusive" | "isEmpty" | "isNotEmpty";
             /**
-             * Comparison value for binary operators: a static number, string or boolean, or an
-             * organisation environment variable (`Number`, `Text` or `Boolean`) so a precondition
-             * can act as a per-organisation switch or threshold.
+             * Comparison value for binary operators: a static number, string or boolean, or a
+             * reference resolved at evaluation time. Accepted reference source: `environment` (a
+             * `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
+             * can act as a per-organisation switch or threshold. Any other source is rejected at
+             * write time, and the reference must not carry an `adjust`.
              *
              */
             value?: /**
-             * Comparison value for binary operators: a static number, string or boolean, or an
-             * organisation environment variable (`Number`, `Text` or `Boolean`) so a precondition
-             * can act as a per-organisation switch or threshold.
+             * Comparison value for binary operators: a static number, string or boolean, or a
+             * reference resolved at evaluation time. Accepted reference source: `environment` (a
+             * `Number`, `Text` or `Boolean` organisation environment variable), so a precondition
+             * can act as a per-organisation switch or threshold. Any other source is rejected at
+             * write time, and the reference must not carry an `adjust`.
              *
              */
             number | string | boolean | /**
-             * A comparison value resolved at evaluation time from an organisation environment variable
-             * (environments-api). The rule stores the key, never the value, so one change to the variable
-             * reaches every rule that references it and a blueprint install never overwrites the
-             * organisation's own value.
-             *
-             * Only browser-safe variable types are allowed: `Number` for numeric comparisons, `Text` for
-             * text comparisons and for dates (ISO 8601 string), `Boolean` for `applies_when` values.
-             * `String` and `SecretString` variables are rejected at write time. Write-time validation also
-             * checks that the variable exists in the organisation; a variable that exists without a value
-             * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
+             * A value resolved at evaluation time instead of written into the rule, identified by
+             * `source`. Each field that accepts a reference lists the sources it allows; a rule using
+             * any other source is rejected when it is saved.
              *
              */
-            EnvironmentValue;
+            ValueReference;
         }
         /**
          * Declarative validation rule (schema version v2). Supports predefined comparison operators
@@ -133,8 +130,9 @@ declare namespace Components {
          * reaches every rule that references it and a blueprint install never overwrites the
          * organisation's own value.
          *
-         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, `Text` for
-         * text comparisons and for dates (ISO 8601 string), `Boolean` for `applies_when` values.
+         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, adjustment
+         * amounts and relative-date offsets, `Text` for text comparisons and for dates (ISO 8601
+         * string), `Boolean` for `applies_when` values.
          * `String` and `SecretString` variables are rejected at write time. Write-time validation also
          * checks that the variable exists in the organisation; a variable that exists without a value
          * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
@@ -354,8 +352,9 @@ declare namespace Components {
          * reaches every rule that references it and a blueprint install never overwrites the
          * organisation's own value.
          *
-         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, `Text` for
-         * text comparisons and for dates (ISO 8601 string), `Boolean` for `applies_when` values.
+         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, adjustment
+         * amounts and relative-date offsets, `Text` for text comparisons and for dates (ISO 8601
+         * string), `Boolean` for `applies_when` values.
          * `String` and `SecretString` variables are rejected at write time. Write-time validation also
          * checks that the variable exists in the organisation; a variable that exists without a value
          * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
@@ -812,8 +811,27 @@ declare namespace Components {
             source: "relative_date";
             /**
              * Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
+             * Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference source:
+             * `environment` (a `Number` organisation environment variable). Any other source is rejected at write
+             * time, and the reference must not carry an `adjust`. If the referenced value is missing or is not a
+             * whole number within ±36500, the comparison is unresolved.
+             *
+             */
+            offset: /**
+             * Offset from the anchor. Negative values are in the past, positive in the future, 0 is the anchor itself.
+             * Either a fixed whole number, or a reference resolved at evaluation time. Accepted reference source:
+             * `environment` (a `Number` organisation environment variable). Any other source is rejected at write
+             * time, and the reference must not carry an `adjust`. If the referenced value is missing or is not a
+             * whole number within ±36500, the comparison is unresolved.
+             *
+             */
+            number | /**
+             * A value resolved at evaluation time instead of written into the rule, identified by
+             * `source`. Each field that accepts a reference lists the sources it allows; a rule using
+             * any other source is rejected when it is saved.
+             *
              */
-            offset: number;
+            ValueReference;
             unit: "days" | "months" | "years";
             anchor?: "today";
         }
@@ -832,8 +850,9 @@ declare namespace Components {
          * reaches every rule that references it and a blueprint install never overwrites the
          * organisation's own value.
          *
-         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, `Text` for
-         * text comparisons and for dates (ISO 8601 string), `Boolean` for `applies_when` values.
+         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, adjustment
+         * amounts and relative-date offsets, `Text` for text comparisons and for dates (ISO 8601
+         * string), `Boolean` for `applies_when` values.
          * `String` and `SecretString` variables are rejected at write time. Write-time validation also
          * checks that the variable exists in the organisation; a variable that exists without a value
          * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
@@ -1101,37 +1120,28 @@ declare namespace Components {
         export interface ValueAdjustment {
             type: "percent" | "absolute";
             /**
-             * The adjustment amount - a fixed number, or a context path resolving to a number
-             * (e.g. a per-contract percentage limit). Contextual adjustment values must not
-             * carry a nested adjustment.
+             * The adjustment amount - a fixed non-negative number, or a reference resolving to a
+             * number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
+             * percentage limit) and `environment` (a `Number` organisation environment variable).
+             * Any other source is rejected at write time, and the reference must not carry its own
+             * `adjust`.
              *
              */
             value: /**
-             * The adjustment amount - a fixed number, or a context path resolving to a number
-             * (e.g. a per-contract percentage limit). Contextual adjustment values must not
-             * carry a nested adjustment.
+             * The adjustment amount - a fixed non-negative number, or a reference resolving to a
+             * number at evaluation time. Accepted reference sources: `context` (e.g. a per-contract
+             * percentage limit) and `environment` (a `Number` organisation environment variable).
+             * Any other source is rejected at write time, and the reference must not carry its own
+             * `adjust`.
              *
              */
             number | /**
-             * A dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`
-             * or `previous_reading.value`. The first path segment must match the `name` of a declared
-             * context requirement.
-             *
-             */
-            ContextValue | /**
-             * A comparison value resolved at evaluation time from an organisation environment variable
-             * (environments-api). The rule stores the key, never the value, so one change to the variable
-             * reaches every rule that references it and a blueprint install never overwrites the
-             * organisation's own value.
-             *
-             * Only browser-safe variable types are allowed: `Number` for numeric comparisons, `Text` for
-             * text comparisons and for dates (ISO 8601 string), `Boolean` for `applies_when` values.
-             * `String` and `SecretString` variables are rejected at write time. Write-time validation also
-             * checks that the variable exists in the organisation; a variable that exists without a value
-             * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
+             * A value resolved at evaluation time instead of written into the rule, identified by
+             * `source`. Each field that accepts a reference lists the sources it allows; a rule using
+             * any other source is rejected when it is saved.
              *
              */
-            EnvironmentValue;
+            ValueReference;
             direction: "increase" | "decrease";
             /**
              * Rounds the adjusted result to a whole number - `up` (ceiling) or `down` (floor).
@@ -1140,6 +1150,52 @@ declare namespace Components {
              */
             rounding?: "up" | "down";
         }
+        /**
+         * A value resolved at evaluation time instead of written into the rule, identified by
+         * `source`. Each field that accepts a reference lists the sources it allows; a rule using
+         * any other source is rejected when it is saved.
+         *
+         */
+        export type ValueReference = /**
+         * A value resolved at evaluation time instead of written into the rule, identified by
+         * `source`. Each field that accepts a reference lists the sources it allows; a rule using
+         * any other source is rejected when it is saved.
+         *
+         */
+        /**
+         * A dynamic comparison value resolved from runtime context, e.g. `contract.installment_amount`
+         * or `previous_reading.value`. The first path segment must match the `name` of a declared
+         * context requirement.
+         *
+         */
+        ContextValue | /**
+         * A comparison value resolved at evaluation time from an organisation environment variable
+         * (environments-api). The rule stores the key, never the value, so one change to the variable
+         * reaches every rule that references it and a blueprint install never overwrites the
+         * organisation's own value.
+         *
+         * Only browser-safe variable types are allowed: `Number` for numeric comparisons, adjustment
+         * amounts and relative-date offsets, `Text` for text comparisons and for dates (ISO 8601
+         * string), `Boolean` for `applies_when` values.
+         * `String` and `SecretString` variables are rejected at write time. Write-time validation also
+         * checks that the variable exists in the organisation; a variable that exists without a value
+         * (for example seeded by a blueprint install) is accepted and resolves as unavailable until set.
+         *
+         */
+        EnvironmentValue | /**
+         * A comparison value produced at evaluation time by an External Values hook of an installed
+         * app (component type `EXTERNAL_VALUES`). The rule stores the reference only; the value is
+         * resolved server-side by the external-values-api, which executes the hook's HTTP call with
+         * the app's credentials and returns the typed result identified by `result_id`.
+         *
+         * Write-time validation checks that the app is installed in the organisation, that the hook
+         * and result exist, and that the result's type is compatible with the compared kind
+         * (`number` results for numeric comparisons, `text` for text, `date` for date). External values
+         * are resolved only for authenticated consumers (epilot 360 users and portal end customers);
+         * in public journeys the dependent conditions are skipped.
+         *
+         */
+        ExternalValue;
     }
 }
 declare namespace Paths {
@@ -1664,5 +1720,6 @@ type UsedBy = Components.Schemas.UsedBy;
 type ValidationRule = Components.Schemas.ValidationRule;
 type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
 type ValueAdjustment = Components.Schemas.ValueAdjustment;
+type ValueReference = Components.Schemas.ValueReference;
 
-export { type AppliesWhen as A, type RegexRuleType as B, type Client as C, type DocumentCheck as D, type EnvironmentValue as E, type FileTypesValue as F, type GetValidationRulesResponse as G, type RelativeDateValue as H, type StaticValue as I, type UsedBy as J, type ValidationRuleBase as K, type ValueAdjustment as L, type NoValue as N, type OperationMethods as O, Paths as P, 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 PatternCondition as t, type PatternFactCondition as u, type PatternNestedCondition as v, type PatternRuleType as w, type RegexCondition as x, type RegexFactCondition as y, type RegexNestedCondition as z };
+export { type AppliesWhen as A, type RegexRuleType as B, type Client as C, type DocumentCheck as D, type EnvironmentValue as E, type FileTypesValue as F, type GetValidationRulesResponse as G, type RelativeDateValue as H, type StaticValue as I, type UsedBy as J, type ValidationRuleBase as K, type ValueAdjustment as L, type ValueReference as M, type NoValue as N, type OperationMethods as O, Paths as P, 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 PatternCondition as t, type PatternFactCondition as u, type PatternNestedCondition as v, type PatternRuleType as w, type RegexCondition as x, type RegexFactCondition as y, type RegexNestedCondition as z };

package/docs/integration-toolkit.md

@@ -3722,8 +3722,15 @@ const { data } = await client.createErpImport(
               "entity": "string"
             }
           ],
+          "attributes": [
+            {
+              "name": "string"
+            }
+          ],
+          "lines": [0],
           "subject": "string",
-          "row": 0
+          "row": 0,
+          "expected": "number"
         }
       ]
     },
@@ -3812,8 +3819,15 @@ const { data } = await client.listErpImports({
                 "entity": "string"
               }
             ],
+            "attributes": [
+              {
+                "name": "string"
+              }
+            ],
+            "lines": [0],
             "subject": "string",
-            "row": 0
+            "row": 0,
+            "expected": "number"
           }
         ]
       },
@@ -3895,8 +3909,15 @@ const { data } = await client.getErpImport({
             "entity": "string"
           }
         ],
+        "attributes": [
+          {
+            "name": "string"
+          }
+        ],
+        "lines": [0],
         "subject": "string",
-        "row": 0
+        "row": 0,
+        "expected": "number"
       }
     ]
   },
@@ -4159,19 +4180,24 @@ A problem found during validation, scoped to the file as a whole rather than to
 individual rows.
 
 `code` is the translation key and the other fields are its parameters — there is
-deliberately no message to display. Each code appears at most once, with
-everything it has to say aggregated into that on
+deliberately no message to display. Each code appears at most once (once per
+`expected` for `VALUE_FORMAT_INVALID`), with
 
 ```ts
 type ErpImportIssue = {
-  code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED"
+  code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED" | "VALUE_FORMAT_INVALID" | "MAPPING_EXPRESSION_FAILED" | "FROM_ROWS_EXPRESSION_FAILED"
   severity: "warning" | "blocking"
   columns?: Array<{
     name: string
     entity?: string
   }>
+  attributes?: Array<{
+    name: string
+  }>
+  lines?: number[]
   subject?: string
   row?: number
+  expected?: "number" | "text" | "decimal" | "date"
 }
 ```
 
@@ -4195,14 +4221,19 @@ type ErpImportValidation = {
     version_attribute?: string
   }>
   issues?: Array<{
-    code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED"
+    code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED" | "VALUE_FORMAT_INVALID" | "MAPPING_EXPRESSION_FAILED" | "FROM_ROWS_EXPRESSION_FAILED"
     severity: "warning" | "blocking"
     columns?: Array<{
       name: { ... }
       entity?: { ... }
     }>
+    attributes?: Array<{
+      name: { ... }
+    }>
+    lines?: number[]
     subject?: string
     row?: number
+    expected?: "number" | "text" | "decimal" | "date"
   }>
 }
 ```
@@ -4348,8 +4379,11 @@ type ErpImportJob = {
       code: { ... }
       severity: { ... }
       columns?: { ... }
+      attributes?: { ... }
+      lines?: { ... }
       subject?: { ... }
       row?: { ... }
+      expected?: { ... }
     }>
   }
   progress?: {