@epilot/sdk 2.20.8-alpha.0 → 2.20.9
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/environments.json +3 -211
- package/definitions/pricing-runtime.json +1 -1
- package/definitions/pricing.json +3489 -757
- package/definitions/validation-rules.json +184 -6
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- 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 +8 -8
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +2 -2
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.cts +2 -2
- package/dist/apis/validation-rules.d.ts +2 -2
- 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/bin/cli.js +1 -1
- package/dist/{chunk-OHYTCUUB.js → chunk-7Q3JW72Y.js} +1 -1
- package/dist/{chunk-PFO4HNPR.js → chunk-JBFTKLP2.js} +4 -4
- package/dist/{chunk-UKHR33EL.cjs → chunk-QLWDOKGE.cjs} +1 -1
- package/dist/{chunk-4FP7EKQT.cjs → chunk-VCD3C4UW.cjs} +4 -4
- package/dist/environments-EAVUY4FC.cjs +7 -0
- package/dist/environments-RNOROUFZ.js +7 -0
- package/dist/{environments.d-Cr-oj1fN.d.cts → environments.d-C_BTxz4W.d.cts} +22 -193
- package/dist/{environments.d-Cr-oj1fN.d.ts → environments.d-C_BTxz4W.d.ts} +22 -193
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/pricing-PFTFDGZ3.cjs +7 -0
- package/dist/pricing-YZHONV3M.js +7 -0
- package/dist/{pricing-runtime-AT27C3BP.js → pricing-runtime-MJAIO4AY.js} +1 -1
- package/dist/{pricing-runtime-PFVTRERK.cjs → pricing-runtime-NMRZO6J4.cjs} +2 -2
- package/dist/{pricing.d-CSVO1WCD.d.cts → pricing.d-CvcYBm8A.d.cts} +9979 -1422
- package/dist/{pricing.d-CSVO1WCD.d.ts → pricing.d-CvcYBm8A.d.ts} +9979 -1422
- package/dist/validation-rules-2JQLB6PH.cjs +7 -0
- package/dist/validation-rules-VQXUQSMC.js +7 -0
- package/dist/{validation-rules.d-D8X9MYTc.d.ts → validation-rules.d-Bbo90IYn.d.cts} +178 -7
- package/dist/{validation-rules.d-D8X9MYTc.d.cts → validation-rules.d-Bbo90IYn.d.ts} +178 -7
- package/docs/environments.md +11 -252
- package/docs/pricing.md +1372 -204
- package/docs/validation-rules.md +286 -0
- package/package.json +1 -1
- package/dist/environments-DBHM4GKI.cjs +0 -7
- package/dist/environments-JVPK6LSD.js +0 -7
- package/dist/pricing-5EKKEZSL.js +0 -7
- package/dist/pricing-N4Z2CHGZ.cjs +0 -7
- package/dist/validation-rules-ETOO45CW.js +0 -7
- package/dist/validation-rules-MZZ7YMJM.cjs +0 -7
|
@@ -216,7 +216,20 @@ declare namespace Components {
|
|
|
216
216
|
* external (app-provided) comparison values.
|
|
217
217
|
*
|
|
218
218
|
*/
|
|
219
|
-
ComparisonRuleType
|
|
219
|
+
ComparisonRuleType | /**
|
|
220
|
+
* Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
221
|
+
* the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
222
|
+
* (file type, size, page count, image resolution, blank and password-protected detection) are
|
|
223
|
+
* deterministic and available at every level; the `meetsCriteria` condition judges a free-text
|
|
224
|
+
* requirement against the document's extracted content and is available from level `standard`.
|
|
225
|
+
*
|
|
226
|
+
* Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
|
|
227
|
+
* pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
|
|
228
|
+
* result is always reported as advisory and never fails the input, regardless of `allow_failure`.
|
|
229
|
+
* Document rules carry no `contexts` yet.
|
|
230
|
+
*
|
|
231
|
+
*/
|
|
232
|
+
DocumentRuleType;
|
|
220
233
|
/**
|
|
221
234
|
* Declares the dynamic context a v2 rule needs at evaluation time.
|
|
222
235
|
* `context` condition values reference these sources by using the schema slug
|
|
@@ -233,6 +246,108 @@ declare namespace Components {
|
|
|
233
246
|
*/
|
|
234
247
|
ContextRequirement[];
|
|
235
248
|
}
|
|
249
|
+
/**
|
|
250
|
+
* A free-text requirement judged against the document's extracted content, e.g. "The photo shows
|
|
251
|
+
* an electricity meter with the meter number and the current reading fully legible." One requirement
|
|
252
|
+
* per condition keeps results specific and lets each requirement be graded separately.
|
|
253
|
+
*
|
|
254
|
+
*/
|
|
255
|
+
export interface CriteriaValue {
|
|
256
|
+
source: "criteria";
|
|
257
|
+
text: string;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* How deep the document check goes. Levels are cumulative.
|
|
261
|
+
*/
|
|
262
|
+
export interface DocumentCheck {
|
|
263
|
+
/**
|
|
264
|
+
* - `basic`: file properties only (type, size, page count, resolution, blank, password). Instant, no extraction.
|
|
265
|
+
* - `standard`: basic checks plus a quick scan of the content. A few seconds.
|
|
266
|
+
* - `advanced`: basic checks plus a thorough reading of the fully extracted content. Roughly 5 to 10 seconds.
|
|
267
|
+
*
|
|
268
|
+
*/
|
|
269
|
+
level: "basic" | "standard" | "advanced";
|
|
270
|
+
}
|
|
271
|
+
/**
|
|
272
|
+
* A single check the uploaded file must satisfy.
|
|
273
|
+
*/
|
|
274
|
+
export interface DocumentCondition {
|
|
275
|
+
/**
|
|
276
|
+
* Stable identifier of the condition within the rule, used for editing and error reporting.
|
|
277
|
+
*/
|
|
278
|
+
id: string;
|
|
279
|
+
operator: /**
|
|
280
|
+
* Predefined document check. Value compatibility (enforced at write time):
|
|
281
|
+
* - fileTypeIn: `file_types` value listing the accepted file categories.
|
|
282
|
+
* - sizeBelow: static integer, maximum file size in bytes.
|
|
283
|
+
* - pageCountBetween: `range` of static non-negative integers (inclusive).
|
|
284
|
+
* - resolutionAtLeast / resolutionAtMost: static positive integer, the image's longer edge in pixels.
|
|
285
|
+
* - isNotBlank / isNotPasswordProtected: `none` value (unary).
|
|
286
|
+
* - meetsCriteria: `criteria` value with the free-text requirement. Requires check level `standard` or `advanced`.
|
|
287
|
+
*
|
|
288
|
+
*/
|
|
289
|
+
DocumentOperator;
|
|
290
|
+
value: /* The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion. */ DocumentConditionValue;
|
|
291
|
+
/**
|
|
292
|
+
* Message shown to the end user when this condition fails.
|
|
293
|
+
*/
|
|
294
|
+
error_message: string;
|
|
295
|
+
/**
|
|
296
|
+
* When true, the condition is advisory: a failure is reported but never takes part in the
|
|
297
|
+
* validity verdict. Recommended for `meetsCriteria` until the organisation has reviewed
|
|
298
|
+
* results on real files.
|
|
299
|
+
*
|
|
300
|
+
*/
|
|
301
|
+
allow_failure?: boolean;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.
|
|
305
|
+
*/
|
|
306
|
+
export type DocumentConditionValue = /* The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion. */ /* A fixed comparison value. */ StaticValue | /* 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 | /* Accepted file categories; each category expands to a mime list at check time. */ FileTypesValue | /**
|
|
307
|
+
* A free-text requirement judged against the document's extracted content, e.g. "The photo shows
|
|
308
|
+
* an electricity meter with the meter number and the current reading fully legible." One requirement
|
|
309
|
+
* per condition keeps results specific and lets each requirement be graded separately.
|
|
310
|
+
*
|
|
311
|
+
*/
|
|
312
|
+
CriteriaValue;
|
|
313
|
+
/**
|
|
314
|
+
* Predefined document check. Value compatibility (enforced at write time):
|
|
315
|
+
* - fileTypeIn: `file_types` value listing the accepted file categories.
|
|
316
|
+
* - sizeBelow: static integer, maximum file size in bytes.
|
|
317
|
+
* - pageCountBetween: `range` of static non-negative integers (inclusive).
|
|
318
|
+
* - resolutionAtLeast / resolutionAtMost: static positive integer, the image's longer edge in pixels.
|
|
319
|
+
* - isNotBlank / isNotPasswordProtected: `none` value (unary).
|
|
320
|
+
* - meetsCriteria: `criteria` value with the free-text requirement. Requires check level `standard` or `advanced`.
|
|
321
|
+
*
|
|
322
|
+
*/
|
|
323
|
+
export type DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria";
|
|
324
|
+
/**
|
|
325
|
+
* Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
326
|
+
* the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
327
|
+
* (file type, size, page count, image resolution, blank and password-protected detection) are
|
|
328
|
+
* deterministic and available at every level; the `meetsCriteria` condition judges a free-text
|
|
329
|
+
* requirement against the document's extracted content and is available from level `standard`.
|
|
330
|
+
*
|
|
331
|
+
* Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
|
|
332
|
+
* pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
|
|
333
|
+
* result is always reported as advisory and never fails the input, regardless of `allow_failure`.
|
|
334
|
+
* Document rules carry no `contexts` yet.
|
|
335
|
+
*
|
|
336
|
+
*/
|
|
337
|
+
export interface DocumentRuleType {
|
|
338
|
+
/**
|
|
339
|
+
* Identifies the rule as a document rule. Determines which operators are allowed.
|
|
340
|
+
*/
|
|
341
|
+
input_type: "document";
|
|
342
|
+
check: /* How deep the document check goes. Levels are cumulative. */ DocumentCheck;
|
|
343
|
+
/**
|
|
344
|
+
* The checks the uploaded file must satisfy. All blocking conditions must pass for the
|
|
345
|
+
* file to be valid; `allow_failure` conditions are advisory. Must contain at least one
|
|
346
|
+
* condition (enforced at write time).
|
|
347
|
+
*
|
|
348
|
+
*/
|
|
349
|
+
conditions: /* A single check the uploaded file must satisfy. */ DocumentCondition[];
|
|
350
|
+
}
|
|
236
351
|
/**
|
|
237
352
|
* A comparison value resolved at evaluation time from an organisation environment variable
|
|
238
353
|
* (environments-api). The rule stores the key, never the value, so one change to the variable
|
|
@@ -293,6 +408,16 @@ declare namespace Components {
|
|
|
293
408
|
*/
|
|
294
409
|
ValueAdjustment;
|
|
295
410
|
}
|
|
411
|
+
/**
|
|
412
|
+
* Accepted file categories; each category expands to a mime list at check time.
|
|
413
|
+
*/
|
|
414
|
+
export interface FileTypesValue {
|
|
415
|
+
source: "file_types";
|
|
416
|
+
types: [
|
|
417
|
+
("image" | "pdf" | "document" | "spreadsheet"),
|
|
418
|
+
...("image" | "pdf" | "document" | "spreadsheet")[]
|
|
419
|
+
];
|
|
420
|
+
}
|
|
296
421
|
/**
|
|
297
422
|
* Response envelope for listing all validation rules within an organization.
|
|
298
423
|
*/
|
|
@@ -765,7 +890,20 @@ declare namespace Components {
|
|
|
765
890
|
* external (app-provided) comparison values.
|
|
766
891
|
*
|
|
767
892
|
*/
|
|
768
|
-
ComparisonRuleType
|
|
893
|
+
ComparisonRuleType | /**
|
|
894
|
+
* Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
895
|
+
* the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
896
|
+
* (file type, size, page count, image resolution, blank and password-protected detection) are
|
|
897
|
+
* deterministic and available at every level; the `meetsCriteria` condition judges a free-text
|
|
898
|
+
* requirement against the document's extracted content and is available from level `standard`.
|
|
899
|
+
*
|
|
900
|
+
* Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
|
|
901
|
+
* pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
|
|
902
|
+
* result is always reported as advisory and never fails the input, regardless of `allow_failure`.
|
|
903
|
+
* Document rules carry no `contexts` yet.
|
|
904
|
+
*
|
|
905
|
+
*/
|
|
906
|
+
DocumentRuleType;
|
|
769
907
|
/**
|
|
770
908
|
* Declares the dynamic context a v2 rule needs at evaluation time.
|
|
771
909
|
* `context` condition values reference these sources by using the schema slug
|
|
@@ -840,7 +978,20 @@ declare namespace Components {
|
|
|
840
978
|
* external (app-provided) comparison values.
|
|
841
979
|
*
|
|
842
980
|
*/
|
|
843
|
-
ComparisonRuleType
|
|
981
|
+
ComparisonRuleType | /**
|
|
982
|
+
* Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
983
|
+
* the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
984
|
+
* (file type, size, page count, image resolution, blank and password-protected detection) are
|
|
985
|
+
* deterministic and available at every level; the `meetsCriteria` condition judges a free-text
|
|
986
|
+
* requirement against the document's extracted content and is available from level `standard`.
|
|
987
|
+
*
|
|
988
|
+
* Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
|
|
989
|
+
* pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
|
|
990
|
+
* result is always reported as advisory and never fails the input, regardless of `allow_failure`.
|
|
991
|
+
* Document rules carry no `contexts` yet.
|
|
992
|
+
*
|
|
993
|
+
*/
|
|
994
|
+
DocumentRuleType;
|
|
844
995
|
/**
|
|
845
996
|
* Declares the dynamic context a v2 rule needs at evaluation time.
|
|
846
997
|
* `context` condition values reference these sources by using the schema slug
|
|
@@ -912,7 +1063,20 @@ declare namespace Components {
|
|
|
912
1063
|
* external (app-provided) comparison values.
|
|
913
1064
|
*
|
|
914
1065
|
*/
|
|
915
|
-
ComparisonRuleType
|
|
1066
|
+
ComparisonRuleType | /**
|
|
1067
|
+
* Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
1068
|
+
* the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
1069
|
+
* (file type, size, page count, image resolution, blank and password-protected detection) are
|
|
1070
|
+
* deterministic and available at every level; the `meetsCriteria` condition judges a free-text
|
|
1071
|
+
* requirement against the document's extracted content and is available from level `standard`.
|
|
1072
|
+
*
|
|
1073
|
+
* Evaluation semantics for content conditions differ from scalar rules: each condition resolves to
|
|
1074
|
+
* pass, fail or uncertain. A confident fail on a blocking condition fails the input; an uncertain
|
|
1075
|
+
* result is always reported as advisory and never fails the input, regardless of `allow_failure`.
|
|
1076
|
+
* Document rules carry no `contexts` yet.
|
|
1077
|
+
*
|
|
1078
|
+
*/
|
|
1079
|
+
DocumentRuleType;
|
|
916
1080
|
/**
|
|
917
1081
|
* Declares the dynamic context a v2 rule needs at evaluation time.
|
|
918
1082
|
* `context` condition values reference these sources by using the schema slug
|
|
@@ -1044,7 +1208,7 @@ declare namespace Paths {
|
|
|
1044
1208
|
* Invalid request body
|
|
1045
1209
|
*/
|
|
1046
1210
|
message?: string;
|
|
1047
|
-
code?: "external_value_not_found" | "external_value_incompatible";
|
|
1211
|
+
code?: "external_value_not_found" | "external_value_incompatible" | "environment_variable_not_found" | "environment_variable_incompatible";
|
|
1048
1212
|
}
|
|
1049
1213
|
export interface $401 {
|
|
1050
1214
|
/**
|
|
@@ -1252,7 +1416,7 @@ declare namespace Paths {
|
|
|
1252
1416
|
* Invalid request body
|
|
1253
1417
|
*/
|
|
1254
1418
|
message?: string;
|
|
1255
|
-
code?: "external_value_not_found" | "external_value_incompatible";
|
|
1419
|
+
code?: "external_value_not_found" | "external_value_incompatible" | "environment_variable_not_found" | "environment_variable_incompatible";
|
|
1256
1420
|
}
|
|
1257
1421
|
export interface $401 {
|
|
1258
1422
|
/**
|
|
@@ -1467,8 +1631,15 @@ type ConditionValue = Components.Schemas.ConditionValue;
|
|
|
1467
1631
|
type ContextRequirement = Components.Schemas.ContextRequirement;
|
|
1468
1632
|
type ContextValue = Components.Schemas.ContextValue;
|
|
1469
1633
|
type CreateValidationRuleRequest = Components.Schemas.CreateValidationRuleRequest;
|
|
1634
|
+
type CriteriaValue = Components.Schemas.CriteriaValue;
|
|
1635
|
+
type DocumentCheck = Components.Schemas.DocumentCheck;
|
|
1636
|
+
type DocumentCondition = Components.Schemas.DocumentCondition;
|
|
1637
|
+
type DocumentConditionValue = Components.Schemas.DocumentConditionValue;
|
|
1638
|
+
type DocumentOperator = Components.Schemas.DocumentOperator;
|
|
1639
|
+
type DocumentRuleType = Components.Schemas.DocumentRuleType;
|
|
1470
1640
|
type EnvironmentValue = Components.Schemas.EnvironmentValue;
|
|
1471
1641
|
type ExternalValue = Components.Schemas.ExternalValue;
|
|
1642
|
+
type FileTypesValue = Components.Schemas.FileTypesValue;
|
|
1472
1643
|
type GetValidationRulesResponse = Components.Schemas.GetValidationRulesResponse;
|
|
1473
1644
|
type NoValue = Components.Schemas.NoValue;
|
|
1474
1645
|
type NumericCondition = Components.Schemas.NumericCondition;
|
|
@@ -1494,4 +1665,4 @@ type ValidationRule = Components.Schemas.ValidationRule;
|
|
|
1494
1665
|
type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
|
|
1495
1666
|
type ValueAdjustment = Components.Schemas.ValueAdjustment;
|
|
1496
1667
|
|
|
1497
|
-
export { type AppliesWhen as A, type
|
|
1668
|
+
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 };
|
package/docs/environments.md
CHANGED
|
@@ -41,14 +41,6 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
41
41
|
- [`MapValue`](#mapvalue)
|
|
42
42
|
- [`JsonValue`](#jsonvalue)
|
|
43
43
|
- [`LinkValue`](#linkvalue)
|
|
44
|
-
- [`LinkFields`](#linkfields)
|
|
45
|
-
- [`ListItemType`](#listitemtype)
|
|
46
|
-
- [`ListOfText`](#listoftext)
|
|
47
|
-
- [`ListOfNumber`](#listofnumber)
|
|
48
|
-
- [`ListOfBoolean`](#listofboolean)
|
|
49
|
-
- [`ListOfJson`](#listofjson)
|
|
50
|
-
- [`ListOfLink`](#listoflink)
|
|
51
|
-
- [`ListValue`](#listvalue)
|
|
52
44
|
- [`EnvironmentValue`](#environmentvalue)
|
|
53
45
|
- [`EnvironmentVariable`](#environmentvariable)
|
|
54
46
|
- [`EnvironmentVariableListItem`](#environmentvariablelistitem)
|
|
@@ -302,12 +294,12 @@ const { data } = await client.deleteEnvironmentVariable({
|
|
|
302
294
|
### `EnvironmentValueType`
|
|
303
295
|
|
|
304
296
|
The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
305
|
-
its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
306
|
-
|
|
297
|
+
its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
298
|
+
may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
307
299
|
|
|
308
300
|
|
|
309
301
|
```ts
|
|
310
|
-
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
302
|
+
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
311
303
|
```
|
|
312
304
|
|
|
313
305
|
### `StringTranslations`
|
|
@@ -377,130 +369,13 @@ type LinkValue = {
|
|
|
377
369
|
}
|
|
378
370
|
```
|
|
379
371
|
|
|
380
|
-
### `LinkFields`
|
|
381
|
-
|
|
382
|
-
The fields of a link, without a fallback language — the shape a `List`
|
|
383
|
-
item carries. Inside a list the fallback belongs to the wrapper, which
|
|
384
|
-
owns the language tabs for every row.
|
|
385
|
-
|
|
386
|
-
Restated rather than composed with `LinkValue`: `allOf` plus
|
|
387
|
-
`additionalProperties: false` is rejected by most validato
|
|
388
|
-
|
|
389
|
-
```ts
|
|
390
|
-
type LinkFields = {
|
|
391
|
-
url: string
|
|
392
|
-
label: string | Record<string, string>
|
|
393
|
-
description?: string | Record<string, string>
|
|
394
|
-
}
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
### `ListItemType`
|
|
398
|
-
|
|
399
|
-
The element type a `List` holds. `String` and `SecretString` are absent
|
|
400
|
-
deliberately: they are the two types never served to browser-facing
|
|
401
|
-
consumers, and a `List` is. `Map` is already a keyed collection, and a
|
|
402
|
-
list of lists has no consumer.
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
```ts
|
|
406
|
-
type ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
407
|
-
```
|
|
408
|
-
|
|
409
|
-
### `ListOfText`
|
|
410
|
-
|
|
411
|
-
```ts
|
|
412
|
-
type ListOfText = {
|
|
413
|
-
itemType: "Text"
|
|
414
|
-
items: string[]
|
|
415
|
-
}
|
|
416
|
-
```
|
|
417
|
-
|
|
418
|
-
### `ListOfNumber`
|
|
419
|
-
|
|
420
|
-
```ts
|
|
421
|
-
type ListOfNumber = {
|
|
422
|
-
itemType: "Number"
|
|
423
|
-
items: number[]
|
|
424
|
-
}
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
### `ListOfBoolean`
|
|
428
|
-
|
|
429
|
-
```ts
|
|
430
|
-
type ListOfBoolean = {
|
|
431
|
-
itemType: "Boolean"
|
|
432
|
-
items: boolean[]
|
|
433
|
-
}
|
|
434
|
-
```
|
|
435
|
-
|
|
436
|
-
### `ListOfJson`
|
|
437
|
-
|
|
438
|
-
```ts
|
|
439
|
-
type ListOfJson = {
|
|
440
|
-
itemType: "JSON"
|
|
441
|
-
items: Record<string, unknown>[]
|
|
442
|
-
}
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
### `ListOfLink`
|
|
446
|
-
|
|
447
|
-
A list of links. `fallbackLanguage` applies to every item's translated
|
|
448
|
-
`label` and `description`; items may mix plain and translated fields
|
|
449
|
-
freely, since a plain string is a complete answer for any language.
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
```ts
|
|
453
|
-
type ListOfLink = {
|
|
454
|
-
itemType: "Link"
|
|
455
|
-
fallbackLanguage?: string
|
|
456
|
-
items: Array<{
|
|
457
|
-
url: string
|
|
458
|
-
label: string | Record<string, string>
|
|
459
|
-
description?: string | Record<string, string>
|
|
460
|
-
}>
|
|
461
|
-
}
|
|
462
|
-
```
|
|
463
|
-
|
|
464
|
-
### `ListValue`
|
|
465
|
-
|
|
466
|
-
An ordered collection of one declared element type. Items round-trip in
|
|
467
|
-
the order written; nothing sorts them. Holds at most 100 items.
|
|
468
|
-
|
|
469
|
-
The whole value is limited to 32768 characters when serialised — the
|
|
470
|
-
server enforces this, and it is not expressible per-property here.
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
```ts
|
|
474
|
-
type ListValue = {
|
|
475
|
-
itemType: "Text"
|
|
476
|
-
items: string[]
|
|
477
|
-
} | {
|
|
478
|
-
itemType: "Number"
|
|
479
|
-
items: number[]
|
|
480
|
-
} | {
|
|
481
|
-
itemType: "Boolean"
|
|
482
|
-
items: boolean[]
|
|
483
|
-
} | {
|
|
484
|
-
itemType: "JSON"
|
|
485
|
-
items: Record<string, unknown>[]
|
|
486
|
-
} | {
|
|
487
|
-
itemType: "Link"
|
|
488
|
-
fallbackLanguage?: string
|
|
489
|
-
items: Array<{
|
|
490
|
-
url: string
|
|
491
|
-
label: string | Record<string, string>
|
|
492
|
-
description?: string | Record<string, string>
|
|
493
|
-
}>
|
|
494
|
-
}
|
|
495
|
-
```
|
|
496
|
-
|
|
497
372
|
### `EnvironmentValue`
|
|
498
373
|
|
|
499
374
|
A variable's value. The JSON type corresponds to the variable's `type`:
|
|
500
375
|
`String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
501
|
-
`Boolean` is a boolean, and `Map`, `JSON
|
|
502
|
-
|
|
503
|
-
|
|
376
|
+
`Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
377
|
+
IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
378
|
+
|
|
504
379
|
|
|
505
380
|
```ts
|
|
506
381
|
type EnvironmentValue = string | number | boolean | {
|
|
@@ -514,26 +389,6 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
514
389
|
label: string | Record<string, string>
|
|
515
390
|
description?: string | Record<string, string>
|
|
516
391
|
fallbackLanguage?: string
|
|
517
|
-
} | {
|
|
518
|
-
itemType: "Text"
|
|
519
|
-
items: string[]
|
|
520
|
-
} | {
|
|
521
|
-
itemType: "Number"
|
|
522
|
-
items: number[]
|
|
523
|
-
} | {
|
|
524
|
-
itemType: "Boolean"
|
|
525
|
-
items: boolean[]
|
|
526
|
-
} | {
|
|
527
|
-
itemType: "JSON"
|
|
528
|
-
items: Record<string, unknown>[]
|
|
529
|
-
} | {
|
|
530
|
-
itemType: "Link"
|
|
531
|
-
fallbackLanguage?: string
|
|
532
|
-
items: Array<{
|
|
533
|
-
url: string
|
|
534
|
-
label: string | Record<string, string>
|
|
535
|
-
description?: string | Record<string, string>
|
|
536
|
-
}>
|
|
537
392
|
}
|
|
538
393
|
```
|
|
539
394
|
|
|
@@ -542,7 +397,7 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
542
397
|
```ts
|
|
543
398
|
type EnvironmentVariable = {
|
|
544
399
|
key: string
|
|
545
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
400
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
546
401
|
description?: string
|
|
547
402
|
group?: string
|
|
548
403
|
value?: string | number | boolean | {
|
|
@@ -556,26 +411,6 @@ type EnvironmentVariable = {
|
|
|
556
411
|
label: string | Record<string, string>
|
|
557
412
|
description?: string | Record<string, string>
|
|
558
413
|
fallbackLanguage?: string
|
|
559
|
-
} | {
|
|
560
|
-
itemType: "Text"
|
|
561
|
-
items: string[]
|
|
562
|
-
} | {
|
|
563
|
-
itemType: "Number"
|
|
564
|
-
items: number[]
|
|
565
|
-
} | {
|
|
566
|
-
itemType: "Boolean"
|
|
567
|
-
items: boolean[]
|
|
568
|
-
} | {
|
|
569
|
-
itemType: "JSON"
|
|
570
|
-
items: Record<string, unknown>[]
|
|
571
|
-
} | {
|
|
572
|
-
itemType: "Link"
|
|
573
|
-
fallbackLanguage?: string
|
|
574
|
-
items: Array<{
|
|
575
|
-
url: { ... }
|
|
576
|
-
label: { ... }
|
|
577
|
-
description?: { ... }
|
|
578
|
-
}>
|
|
579
414
|
}
|
|
580
415
|
protected?: boolean
|
|
581
416
|
created_at: string // date-time
|
|
@@ -588,7 +423,7 @@ type EnvironmentVariable = {
|
|
|
588
423
|
```ts
|
|
589
424
|
type EnvironmentVariableListItem = {
|
|
590
425
|
key: string
|
|
591
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
426
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
592
427
|
description?: string
|
|
593
428
|
group?: string
|
|
594
429
|
value?: string | number | boolean | {
|
|
@@ -602,26 +437,6 @@ type EnvironmentVariableListItem = {
|
|
|
602
437
|
label: string | Record<string, string>
|
|
603
438
|
description?: string | Record<string, string>
|
|
604
439
|
fallbackLanguage?: string
|
|
605
|
-
} | {
|
|
606
|
-
itemType: "Text"
|
|
607
|
-
items: string[]
|
|
608
|
-
} | {
|
|
609
|
-
itemType: "Number"
|
|
610
|
-
items: number[]
|
|
611
|
-
} | {
|
|
612
|
-
itemType: "Boolean"
|
|
613
|
-
items: boolean[]
|
|
614
|
-
} | {
|
|
615
|
-
itemType: "JSON"
|
|
616
|
-
items: Record<string, unknown>[]
|
|
617
|
-
} | {
|
|
618
|
-
itemType: "Link"
|
|
619
|
-
fallbackLanguage?: string
|
|
620
|
-
items: Array<{
|
|
621
|
-
url: { ... }
|
|
622
|
-
label: { ... }
|
|
623
|
-
description?: { ... }
|
|
624
|
-
}>
|
|
625
440
|
}
|
|
626
441
|
protected?: boolean
|
|
627
442
|
created_at: string // date-time
|
|
@@ -635,7 +450,7 @@ type EnvironmentVariableListItem = {
|
|
|
635
450
|
type EnvironmentVariableList = {
|
|
636
451
|
items: Array<{
|
|
637
452
|
key: string
|
|
638
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
453
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
639
454
|
description?: string
|
|
640
455
|
group?: string
|
|
641
456
|
value?: string | number | boolean | {
|
|
@@ -646,22 +461,6 @@ type EnvironmentVariableList = {
|
|
|
646
461
|
label: { ... }
|
|
647
462
|
description?: { ... }
|
|
648
463
|
fallbackLanguage?: { ... }
|
|
649
|
-
} | {
|
|
650
|
-
itemType: { ... }
|
|
651
|
-
items: { ... }
|
|
652
|
-
} | {
|
|
653
|
-
itemType: { ... }
|
|
654
|
-
items: { ... }
|
|
655
|
-
} | {
|
|
656
|
-
itemType: { ... }
|
|
657
|
-
items: { ... }
|
|
658
|
-
} | {
|
|
659
|
-
itemType: { ... }
|
|
660
|
-
items: { ... }
|
|
661
|
-
} | {
|
|
662
|
-
itemType: { ... }
|
|
663
|
-
fallbackLanguage?: { ... }
|
|
664
|
-
items: { ... }
|
|
665
464
|
}
|
|
666
465
|
protected?: boolean
|
|
667
466
|
created_at: string // date-time
|
|
@@ -675,7 +474,7 @@ type EnvironmentVariableList = {
|
|
|
675
474
|
```ts
|
|
676
475
|
type EnvironmentVariableCreateRequest = {
|
|
677
476
|
key: string
|
|
678
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
477
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
679
478
|
description?: string
|
|
680
479
|
group?: string
|
|
681
480
|
value?: string | number | boolean | {
|
|
@@ -689,26 +488,6 @@ type EnvironmentVariableCreateRequest = {
|
|
|
689
488
|
label: string | Record<string, string>
|
|
690
489
|
description?: string | Record<string, string>
|
|
691
490
|
fallbackLanguage?: string
|
|
692
|
-
} | {
|
|
693
|
-
itemType: "Text"
|
|
694
|
-
items: string[]
|
|
695
|
-
} | {
|
|
696
|
-
itemType: "Number"
|
|
697
|
-
items: number[]
|
|
698
|
-
} | {
|
|
699
|
-
itemType: "Boolean"
|
|
700
|
-
items: boolean[]
|
|
701
|
-
} | {
|
|
702
|
-
itemType: "JSON"
|
|
703
|
-
items: Record<string, unknown>[]
|
|
704
|
-
} | {
|
|
705
|
-
itemType: "Link"
|
|
706
|
-
fallbackLanguage?: string
|
|
707
|
-
items: Array<{
|
|
708
|
-
url: { ... }
|
|
709
|
-
label: { ... }
|
|
710
|
-
description?: { ... }
|
|
711
|
-
}>
|
|
712
491
|
}
|
|
713
492
|
protected?: boolean
|
|
714
493
|
}
|
|
@@ -718,7 +497,7 @@ type EnvironmentVariableCreateRequest = {
|
|
|
718
497
|
|
|
719
498
|
```ts
|
|
720
499
|
type EnvironmentVariableUpdateRequest = {
|
|
721
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
500
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
722
501
|
value?: string | number | boolean | {
|
|
723
502
|
fallbackLanguage?: string
|
|
724
503
|
options: Array<{
|
|
@@ -730,26 +509,6 @@ type EnvironmentVariableUpdateRequest = {
|
|
|
730
509
|
label: string | Record<string, string>
|
|
731
510
|
description?: string | Record<string, string>
|
|
732
511
|
fallbackLanguage?: string
|
|
733
|
-
} | {
|
|
734
|
-
itemType: "Text"
|
|
735
|
-
items: string[]
|
|
736
|
-
} | {
|
|
737
|
-
itemType: "Number"
|
|
738
|
-
items: number[]
|
|
739
|
-
} | {
|
|
740
|
-
itemType: "Boolean"
|
|
741
|
-
items: boolean[]
|
|
742
|
-
} | {
|
|
743
|
-
itemType: "JSON"
|
|
744
|
-
items: Record<string, unknown>[]
|
|
745
|
-
} | {
|
|
746
|
-
itemType: "Link"
|
|
747
|
-
fallbackLanguage?: string
|
|
748
|
-
items: Array<{
|
|
749
|
-
url: { ... }
|
|
750
|
-
label: { ... }
|
|
751
|
-
description?: { ... }
|
|
752
|
-
}>
|
|
753
512
|
}
|
|
754
513
|
description?: string
|
|
755
514
|
group?: string
|