@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
package/docs/validation-rules.md
CHANGED
|
@@ -65,6 +65,13 @@ const { data } = await validationRulesClient.getValidationRules(...)
|
|
|
65
65
|
- [`RelativeDateValue`](#relativedatevalue)
|
|
66
66
|
- [`RangeValue`](#rangevalue)
|
|
67
67
|
- [`NoValue`](#novalue)
|
|
68
|
+
- [`DocumentRuleType`](#documentruletype)
|
|
69
|
+
- [`DocumentCheck`](#documentcheck)
|
|
70
|
+
- [`DocumentCondition`](#documentcondition)
|
|
71
|
+
- [`DocumentOperator`](#documentoperator)
|
|
72
|
+
- [`DocumentConditionValue`](#documentconditionvalue)
|
|
73
|
+
- [`FileTypesValue`](#filetypesvalue)
|
|
74
|
+
- [`CriteriaValue`](#criteriavalue)
|
|
68
75
|
- [`AppliesWhen`](#applieswhen)
|
|
69
76
|
- [`ContextRequirement`](#contextrequirement)
|
|
70
77
|
|
|
@@ -682,6 +689,18 @@ type UpdateValidationRuleRequest = {
|
|
|
682
689
|
applies_when?: { ... }
|
|
683
690
|
allow_failure?: { ... }
|
|
684
691
|
}>
|
|
692
|
+
} | {
|
|
693
|
+
input_type: "document"
|
|
694
|
+
check: {
|
|
695
|
+
level: { ... }
|
|
696
|
+
}
|
|
697
|
+
conditions: Array<{
|
|
698
|
+
id: { ... }
|
|
699
|
+
operator: { ... }
|
|
700
|
+
value: { ... }
|
|
701
|
+
error_message: { ... }
|
|
702
|
+
allow_failure?: { ... }
|
|
703
|
+
}>
|
|
685
704
|
}
|
|
686
705
|
contexts?: Array<{
|
|
687
706
|
schema: string
|
|
@@ -737,6 +756,18 @@ type ValidationRuleBase = {
|
|
|
737
756
|
applies_when?: { ... }
|
|
738
757
|
allow_failure?: { ... }
|
|
739
758
|
}>
|
|
759
|
+
} | {
|
|
760
|
+
input_type: "document"
|
|
761
|
+
check: {
|
|
762
|
+
level: { ... }
|
|
763
|
+
}
|
|
764
|
+
conditions: Array<{
|
|
765
|
+
id: { ... }
|
|
766
|
+
operator: { ... }
|
|
767
|
+
value: { ... }
|
|
768
|
+
error_message: { ... }
|
|
769
|
+
allow_failure?: { ... }
|
|
770
|
+
}>
|
|
740
771
|
}
|
|
741
772
|
contexts?: Array<{
|
|
742
773
|
schema: string
|
|
@@ -2261,6 +2292,261 @@ type NoValue = {
|
|
|
2261
2292
|
}
|
|
2262
2293
|
```
|
|
2263
2294
|
|
|
2295
|
+
### `DocumentRuleType`
|
|
2296
|
+
|
|
2297
|
+
Declarative validation rule (schema version v2) for uploaded files. The rule declares how deep
|
|
2298
|
+
the check goes (`check.level`) and the conditions the file must satisfy. Property conditions
|
|
2299
|
+
(file type, size, page count, image resolution, blank and password-protected detection) are
|
|
2300
|
+
deterministic and av
|
|
2301
|
+
|
|
2302
|
+
```ts
|
|
2303
|
+
type DocumentRuleType = {
|
|
2304
|
+
input_type: "document"
|
|
2305
|
+
check: {
|
|
2306
|
+
level: "basic" | "standard" | "advanced"
|
|
2307
|
+
}
|
|
2308
|
+
conditions: Array<{
|
|
2309
|
+
id: string
|
|
2310
|
+
operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
|
|
2311
|
+
value: {
|
|
2312
|
+
source: { ... }
|
|
2313
|
+
data: { ... }
|
|
2314
|
+
} | {
|
|
2315
|
+
source: { ... }
|
|
2316
|
+
min: { ... }
|
|
2317
|
+
max: { ... }
|
|
2318
|
+
} | {
|
|
2319
|
+
source: { ... }
|
|
2320
|
+
} | {
|
|
2321
|
+
source: { ... }
|
|
2322
|
+
types: { ... }
|
|
2323
|
+
} | {
|
|
2324
|
+
source: { ... }
|
|
2325
|
+
text: { ... }
|
|
2326
|
+
}
|
|
2327
|
+
error_message: string
|
|
2328
|
+
allow_failure?: boolean
|
|
2329
|
+
}>
|
|
2330
|
+
}
|
|
2331
|
+
```
|
|
2332
|
+
|
|
2333
|
+
### `DocumentCheck`
|
|
2334
|
+
|
|
2335
|
+
How deep the document check goes. Levels are cumulative.
|
|
2336
|
+
|
|
2337
|
+
```ts
|
|
2338
|
+
type DocumentCheck = {
|
|
2339
|
+
level: "basic" | "standard" | "advanced"
|
|
2340
|
+
}
|
|
2341
|
+
```
|
|
2342
|
+
|
|
2343
|
+
### `DocumentCondition`
|
|
2344
|
+
|
|
2345
|
+
A single check the uploaded file must satisfy.
|
|
2346
|
+
|
|
2347
|
+
```ts
|
|
2348
|
+
type DocumentCondition = {
|
|
2349
|
+
id: string
|
|
2350
|
+
operator: "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
|
|
2351
|
+
value: {
|
|
2352
|
+
source: "static"
|
|
2353
|
+
data: number | string | boolean
|
|
2354
|
+
} | {
|
|
2355
|
+
source: "range"
|
|
2356
|
+
min: {
|
|
2357
|
+
source: { ... }
|
|
2358
|
+
data: { ... }
|
|
2359
|
+
} | {
|
|
2360
|
+
source: { ... }
|
|
2361
|
+
path: { ... }
|
|
2362
|
+
adjust?: { ... }
|
|
2363
|
+
} | {
|
|
2364
|
+
source: { ... }
|
|
2365
|
+
offset: { ... }
|
|
2366
|
+
unit: { ... }
|
|
2367
|
+
anchor?: { ... }
|
|
2368
|
+
} | {
|
|
2369
|
+
source: { ... }
|
|
2370
|
+
key: { ... }
|
|
2371
|
+
adjust?: { ... }
|
|
2372
|
+
} | {
|
|
2373
|
+
source: { ... }
|
|
2374
|
+
app_id: { ... }
|
|
2375
|
+
hook_id: { ... }
|
|
2376
|
+
result_id: { ... }
|
|
2377
|
+
adjust?: { ... }
|
|
2378
|
+
}
|
|
2379
|
+
max: {
|
|
2380
|
+
source: { ... }
|
|
2381
|
+
data: { ... }
|
|
2382
|
+
} | {
|
|
2383
|
+
source: { ... }
|
|
2384
|
+
path: { ... }
|
|
2385
|
+
adjust?: { ... }
|
|
2386
|
+
} | {
|
|
2387
|
+
source: { ... }
|
|
2388
|
+
offset: { ... }
|
|
2389
|
+
unit: { ... }
|
|
2390
|
+
anchor?: { ... }
|
|
2391
|
+
} | {
|
|
2392
|
+
source: { ... }
|
|
2393
|
+
key: { ... }
|
|
2394
|
+
adjust?: { ... }
|
|
2395
|
+
} | {
|
|
2396
|
+
source: { ... }
|
|
2397
|
+
app_id: { ... }
|
|
2398
|
+
hook_id: { ... }
|
|
2399
|
+
result_id: { ... }
|
|
2400
|
+
adjust?: { ... }
|
|
2401
|
+
}
|
|
2402
|
+
} | {
|
|
2403
|
+
source: "none"
|
|
2404
|
+
} | {
|
|
2405
|
+
source: "file_types"
|
|
2406
|
+
types: "image" | "pdf" | "document" | "spreadsheet"[]
|
|
2407
|
+
} | {
|
|
2408
|
+
source: "criteria"
|
|
2409
|
+
text: string
|
|
2410
|
+
}
|
|
2411
|
+
error_message: string
|
|
2412
|
+
allow_failure?: boolean
|
|
2413
|
+
}
|
|
2414
|
+
```
|
|
2415
|
+
|
|
2416
|
+
### `DocumentOperator`
|
|
2417
|
+
|
|
2418
|
+
Predefined document check. Value compatibility (enforced at write time):
|
|
2419
|
+
- fileTypeIn: `file_types` value listing the accepted file categories.
|
|
2420
|
+
- sizeBelow: static integer, maximum file size in bytes.
|
|
2421
|
+
- pageCountBetween: `range` of static non-negative integers (inclusive).
|
|
2422
|
+
- resolutionAtLeast / reso
|
|
2423
|
+
|
|
2424
|
+
```ts
|
|
2425
|
+
type DocumentOperator = "fileTypeIn" | "sizeBelow" | "pageCountBetween" | "resolutionAtLeast" | "resolutionAtMost" | "isNotBlank" | "isNotPasswordProtected" | "meetsCriteria"
|
|
2426
|
+
```
|
|
2427
|
+
|
|
2428
|
+
### `DocumentConditionValue`
|
|
2429
|
+
|
|
2430
|
+
The value of a document condition - a static scalar, a range, nothing, accepted file categories, or a free-text criterion.
|
|
2431
|
+
|
|
2432
|
+
```ts
|
|
2433
|
+
type DocumentConditionValue = {
|
|
2434
|
+
source: "static"
|
|
2435
|
+
data: number | string | boolean
|
|
2436
|
+
} | {
|
|
2437
|
+
source: "range"
|
|
2438
|
+
min: {
|
|
2439
|
+
source: "static"
|
|
2440
|
+
data: number | string | boolean
|
|
2441
|
+
} | {
|
|
2442
|
+
source: "context"
|
|
2443
|
+
path: string
|
|
2444
|
+
adjust?: {
|
|
2445
|
+
type: { ... }
|
|
2446
|
+
value: { ... }
|
|
2447
|
+
direction: { ... }
|
|
2448
|
+
rounding?: { ... }
|
|
2449
|
+
}
|
|
2450
|
+
} | {
|
|
2451
|
+
source: "relative_date"
|
|
2452
|
+
offset: number
|
|
2453
|
+
unit: "days" | "months" | "years"
|
|
2454
|
+
anchor?: "today"
|
|
2455
|
+
} | {
|
|
2456
|
+
source: "environment"
|
|
2457
|
+
key: string
|
|
2458
|
+
adjust?: {
|
|
2459
|
+
type: { ... }
|
|
2460
|
+
value: { ... }
|
|
2461
|
+
direction: { ... }
|
|
2462
|
+
rounding?: { ... }
|
|
2463
|
+
}
|
|
2464
|
+
} | {
|
|
2465
|
+
source: "external"
|
|
2466
|
+
app_id: string
|
|
2467
|
+
hook_id: string
|
|
2468
|
+
result_id: string
|
|
2469
|
+
adjust?: {
|
|
2470
|
+
type: { ... }
|
|
2471
|
+
value: { ... }
|
|
2472
|
+
direction: { ... }
|
|
2473
|
+
rounding?: { ... }
|
|
2474
|
+
}
|
|
2475
|
+
}
|
|
2476
|
+
max: {
|
|
2477
|
+
source: "static"
|
|
2478
|
+
data: number | string | boolean
|
|
2479
|
+
} | {
|
|
2480
|
+
source: "context"
|
|
2481
|
+
path: string
|
|
2482
|
+
adjust?: {
|
|
2483
|
+
type: { ... }
|
|
2484
|
+
value: { ... }
|
|
2485
|
+
direction: { ... }
|
|
2486
|
+
rounding?: { ... }
|
|
2487
|
+
}
|
|
2488
|
+
} | {
|
|
2489
|
+
source: "relative_date"
|
|
2490
|
+
offset: number
|
|
2491
|
+
unit: "days" | "months" | "years"
|
|
2492
|
+
anchor?: "today"
|
|
2493
|
+
} | {
|
|
2494
|
+
source: "environment"
|
|
2495
|
+
key: string
|
|
2496
|
+
adjust?: {
|
|
2497
|
+
type: { ... }
|
|
2498
|
+
value: { ... }
|
|
2499
|
+
direction: { ... }
|
|
2500
|
+
rounding?: { ... }
|
|
2501
|
+
}
|
|
2502
|
+
} | {
|
|
2503
|
+
source: "external"
|
|
2504
|
+
app_id: string
|
|
2505
|
+
hook_id: string
|
|
2506
|
+
result_id: string
|
|
2507
|
+
adjust?: {
|
|
2508
|
+
type: { ... }
|
|
2509
|
+
value: { ... }
|
|
2510
|
+
direction: { ... }
|
|
2511
|
+
rounding?: { ... }
|
|
2512
|
+
}
|
|
2513
|
+
}
|
|
2514
|
+
} | {
|
|
2515
|
+
source: "none"
|
|
2516
|
+
} | {
|
|
2517
|
+
source: "file_types"
|
|
2518
|
+
types: "image" | "pdf" | "document" | "spreadsheet"[]
|
|
2519
|
+
} | {
|
|
2520
|
+
source: "criteria"
|
|
2521
|
+
text: string
|
|
2522
|
+
}
|
|
2523
|
+
```
|
|
2524
|
+
|
|
2525
|
+
### `FileTypesValue`
|
|
2526
|
+
|
|
2527
|
+
Accepted file categories; each category expands to a mime list at check time.
|
|
2528
|
+
|
|
2529
|
+
```ts
|
|
2530
|
+
type FileTypesValue = {
|
|
2531
|
+
source: "file_types"
|
|
2532
|
+
types: "image" | "pdf" | "document" | "spreadsheet"[]
|
|
2533
|
+
}
|
|
2534
|
+
```
|
|
2535
|
+
|
|
2536
|
+
### `CriteriaValue`
|
|
2537
|
+
|
|
2538
|
+
A free-text requirement judged against the document's extracted content, e.g. "The photo shows
|
|
2539
|
+
an electricity meter with the meter number and the current reading fully legible." One requirement
|
|
2540
|
+
per condition keeps results specific and lets each requirement be graded separately.
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
```ts
|
|
2544
|
+
type CriteriaValue = {
|
|
2545
|
+
source: "criteria"
|
|
2546
|
+
text: string
|
|
2547
|
+
}
|
|
2548
|
+
```
|
|
2549
|
+
|
|
2264
2550
|
### `AppliesWhen`
|
|
2265
2551
|
|
|
2266
2552
|
Optional precondition on a condition: the condition only takes part in the
|
package/package.json
CHANGED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/environments.json
|
|
4
|
-
var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`StringTranslations`](#stringtranslations)\n- [`MapEntry`](#mapentry)\n- [`MapValue`](#mapvalue)\n- [`JsonValue`](#jsonvalue)\n- [`LinkValue`](#linkvalue)\n- [`LinkFields`](#linkfields)\n- [`ListItemType`](#listitemtype)\n- [`ListOfText`](#listoftext)\n- [`ListOfNumber`](#listofnumber)\n- [`ListOfBoolean`](#listofboolean)\n- [`ListOfJson`](#listofjson)\n- [`ListOfLink`](#listoflink)\n- [`ListValue`](#listvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON`, `Link` and\n`List` may be served to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n```\n\n### `StringTranslations`\n\nA string translated per language. Keys are language codes (e.g. `de`,\n`en-US`), matching the hyphen-only BCP-47 form epilot\'s i18n stack uses\neverywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces\nthat with LANGUAGE_KEY_PATTERN in src/core/value-types.ts \u2014 the two are\nnot otherwise lin\n\n```ts\ntype StringTranslations = Record<string, string>\n```\n\n### `MapEntry`\n\nOne entry of a Map. `key` is the token a journey submits; `value` is\nwhat the customer reads \u2014 either one string, or one string per\nlanguage. Every entry of a Map must agree on which of the two it uses.\n\n\n```ts\ntype MapEntry = {\n key: string\n value: string | Record<string, string>\n}\n```\n\n### `MapValue`\n\n```ts\ntype MapValue = {\n fallbackLanguage?: string\n options: Array<{\n key: string\n value: string | Record<string, string>\n }>\n}\n```\n\n### `JsonValue`\n\nArbitrary JSON object, e.g. a flat key/value map used by integrations for\nenum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.\n\n\n```ts\ntype JsonValue = Record<string, unknown>\n```\n\n### `LinkValue`\n\nOne URL with a label and description a customer reads. `label` and\n`description` are each either a plain string or one string per language;\nthe two fields decide that independently \u2014 a plain string means "the\nsame in every language". A translated field must carry the fallback\nlanguage.\n\nThe URL must\n\n```ts\ntype LinkValue = {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n}\n```\n\n### `LinkFields`\n\nThe fields of a link, without a fallback language \u2014 the shape a `List`\nitem carries. Inside a list the fallback belongs to the wrapper, which\nowns the language tabs for every row.\n\nRestated rather than composed with `LinkValue`: `allOf` plus\n`additionalProperties: false` is rejected by most validato\n\n```ts\ntype LinkFields = {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n}\n```\n\n### `ListItemType`\n\nThe element type a `List` holds. `String` and `SecretString` are absent\ndeliberately: they are the two types never served to browser-facing\nconsumers, and a `List` is. `Map` is already a keyed collection, and a\nlist of lists has no consumer.\n\n\n```ts\ntype ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link"\n```\n\n### `ListOfText`\n\n```ts\ntype ListOfText = {\n itemType: "Text"\n items: string[]\n}\n```\n\n### `ListOfNumber`\n\n```ts\ntype ListOfNumber = {\n itemType: "Number"\n items: number[]\n}\n```\n\n### `ListOfBoolean`\n\n```ts\ntype ListOfBoolean = {\n itemType: "Boolean"\n items: boolean[]\n}\n```\n\n### `ListOfJson`\n\n```ts\ntype ListOfJson = {\n itemType: "JSON"\n items: Record<string, unknown>[]\n}\n```\n\n### `ListOfLink`\n\nA list of links. `fallbackLanguage` applies to every item\'s translated\n`label` and `description`; items may mix plain and translated fields\nfreely, since a plain string is a complete answer for any language.\n\n\n```ts\ntype ListOfLink = {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `ListValue`\n\nAn ordered collection of one declared element type. Items round-trip in\nthe order written; nothing sorts them. Holds at most 100 items.\n\nThe whole value is limited to 32768 characters when serialised \u2014 the\nserver enforces this, and it is not expressible per-property here.\n\n\n```ts\ntype ListValue = {\n itemType: "Text"\n items: string[]\n} | {\n itemType: "Number"\n items: number[]\n} | {\n itemType: "Boolean"\n items: boolean[]\n} | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n} | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.\nNumbers are IEEE 754 doubles; integers above 2^53 may lose precision on\nround-trip.\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: string\n value: string | Record<string, string>\n }>\n} | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n} | {\n itemType: "Text"\n items: string[]\n} | {\n itemType: "Number"\n items: number[]\n} | {\n itemType: "Boolean"\n items: boolean[]\n} | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n} | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n } | Record<string, unknown> | {\n url: { ... }\n label: { ... }\n description?: { ... }\n fallbackLanguage?: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n fallbackLanguage?: { ... }\n items: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = environments_default;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/environments.json
|
|
4
|
-
var environments_default = '# Environments API\n\n- **Base URL:** `https://environments.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/environments](https://docs.epilot.io/api/environments)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.environments.listEnvironmentVariables(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/environments\'\n\nconst environmentsClient = getClient()\nauthorize(environmentsClient, () => \'<token>\')\nconst { data } = await environmentsClient.listEnvironmentVariables(...)\n```\n\n## Operations\n\n**environments**\n- [`listEnvironmentVariables`](#listenvironmentvariables)\n- [`createEnvironmentVariable`](#createenvironmentvariable)\n- [`listEnvironmentGroups`](#listenvironmentgroups)\n- [`putEnvironmentGroup`](#putenvironmentgroup)\n- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)\n- [`getEnvironmentVariable`](#getenvironmentvariable)\n- [`updateEnvironmentVariable`](#updateenvironmentvariable)\n- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)\n\n**Schemas**\n- [`EnvironmentValueType`](#environmentvaluetype)\n- [`StringTranslations`](#stringtranslations)\n- [`MapEntry`](#mapentry)\n- [`MapValue`](#mapvalue)\n- [`JsonValue`](#jsonvalue)\n- [`LinkValue`](#linkvalue)\n- [`LinkFields`](#linkfields)\n- [`ListItemType`](#listitemtype)\n- [`ListOfText`](#listoftext)\n- [`ListOfNumber`](#listofnumber)\n- [`ListOfBoolean`](#listofboolean)\n- [`ListOfJson`](#listofjson)\n- [`ListOfLink`](#listoflink)\n- [`ListValue`](#listvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n null,\n {\n key: \'string\',\n type: \'String\',\n description: \'string\',\n group: \'string\',\n value: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n {\n name: \'example\',\n },\n {\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "description": "string",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n {\n key: \'example\',\n },\n {\n type: \'String\',\n value: \'string\',\n description: \'string\',\n group: \'string\',\n protected: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "key": "string",\n "type": "String",\n "description": "string",\n "group": "string",\n "value": "string",\n "protected": true,\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON`, `Link` and\n`List` may be served to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n```\n\n### `StringTranslations`\n\nA string translated per language. Keys are language codes (e.g. `de`,\n`en-US`), matching the hyphen-only BCP-47 form epilot\'s i18n stack uses\neverywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces\nthat with LANGUAGE_KEY_PATTERN in src/core/value-types.ts \u2014 the two are\nnot otherwise lin\n\n```ts\ntype StringTranslations = Record<string, string>\n```\n\n### `MapEntry`\n\nOne entry of a Map. `key` is the token a journey submits; `value` is\nwhat the customer reads \u2014 either one string, or one string per\nlanguage. Every entry of a Map must agree on which of the two it uses.\n\n\n```ts\ntype MapEntry = {\n key: string\n value: string | Record<string, string>\n}\n```\n\n### `MapValue`\n\n```ts\ntype MapValue = {\n fallbackLanguage?: string\n options: Array<{\n key: string\n value: string | Record<string, string>\n }>\n}\n```\n\n### `JsonValue`\n\nArbitrary JSON object, e.g. a flat key/value map used by integrations for\nenum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.\n\n\n```ts\ntype JsonValue = Record<string, unknown>\n```\n\n### `LinkValue`\n\nOne URL with a label and description a customer reads. `label` and\n`description` are each either a plain string or one string per language;\nthe two fields decide that independently \u2014 a plain string means "the\nsame in every language". A translated field must carry the fallback\nlanguage.\n\nThe URL must\n\n```ts\ntype LinkValue = {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n}\n```\n\n### `LinkFields`\n\nThe fields of a link, without a fallback language \u2014 the shape a `List`\nitem carries. Inside a list the fallback belongs to the wrapper, which\nowns the language tabs for every row.\n\nRestated rather than composed with `LinkValue`: `allOf` plus\n`additionalProperties: false` is rejected by most validato\n\n```ts\ntype LinkFields = {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n}\n```\n\n### `ListItemType`\n\nThe element type a `List` holds. `String` and `SecretString` are absent\ndeliberately: they are the two types never served to browser-facing\nconsumers, and a `List` is. `Map` is already a keyed collection, and a\nlist of lists has no consumer.\n\n\n```ts\ntype ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link"\n```\n\n### `ListOfText`\n\n```ts\ntype ListOfText = {\n itemType: "Text"\n items: string[]\n}\n```\n\n### `ListOfNumber`\n\n```ts\ntype ListOfNumber = {\n itemType: "Number"\n items: number[]\n}\n```\n\n### `ListOfBoolean`\n\n```ts\ntype ListOfBoolean = {\n itemType: "Boolean"\n items: boolean[]\n}\n```\n\n### `ListOfJson`\n\n```ts\ntype ListOfJson = {\n itemType: "JSON"\n items: Record<string, unknown>[]\n}\n```\n\n### `ListOfLink`\n\nA list of links. `fallbackLanguage` applies to every item\'s translated\n`label` and `description`; items may mix plain and translated fields\nfreely, since a plain string is a complete answer for any language.\n\n\n```ts\ntype ListOfLink = {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `ListValue`\n\nAn ordered collection of one declared element type. Items round-trip in\nthe order written; nothing sorts them. Holds at most 100 items.\n\nThe whole value is limited to 32768 characters when serialised \u2014 the\nserver enforces this, and it is not expressible per-property here.\n\n\n```ts\ntype ListValue = {\n itemType: "Text"\n items: string[]\n} | {\n itemType: "Number"\n items: number[]\n} | {\n itemType: "Boolean"\n items: boolean[]\n} | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n} | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.\nNumbers are IEEE 754 doubles; integers above 2^53 may lose precision on\nround-trip.\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: string\n value: string | Record<string, string>\n }>\n} | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n} | {\n itemType: "Text"\n items: string[]\n} | {\n itemType: "Number"\n items: number[]\n} | {\n itemType: "Boolean"\n items: boolean[]\n} | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n} | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n } | Record<string, unknown> | {\n url: { ... }\n label: { ... }\n description?: { ... }\n fallbackLanguage?: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\n fallbackLanguage?: { ... }\n items: { ... }\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n } | Record<string, unknown> | {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n fallbackLanguage?: string\n } | {\n itemType: "Text"\n items: string[]\n } | {\n itemType: "Number"\n items: number[]\n } | {\n itemType: "Boolean"\n items: boolean[]\n } | {\n itemType: "JSON"\n items: Record<string, unknown>[]\n } | {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: { ... }\n label: { ... }\n description?: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
environments_default as default
|
|
7
|
-
};
|