@epilot/sdk 2.20.16 → 2.20.18
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 +290 -5
- package/definitions/file.json +3 -2
- package/definitions/pricing.json +77 -9
- 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 +6 -6
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-BV7UB72B.cjs → chunk-5SYOSYED.cjs} +3 -3
- package/dist/{chunk-2LP3UTEA.js → chunk-XV6GVGUN.js} +3 -3
- package/dist/environments-OYCH6VUD.js +7 -0
- package/dist/environments-S3O6ASTY.cjs +7 -0
- package/dist/{environments.d-C_BTxz4W.d.cts → environments.d-qL1urwAq.d.cts} +252 -22
- package/dist/{environments.d-C_BTxz4W.d.ts → environments.d-qL1urwAq.d.ts} +252 -22
- package/dist/{file-LFOTXMRJ.cjs → file-2KT6MMMG.cjs} +1 -1
- package/dist/{file-ND2JH5EM.js → file-N3SGGI6E.js} +1 -1
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/{pricing-PFTFDGZ3.cjs → pricing-WMGQHFJV.cjs} +1 -1
- package/dist/{pricing-YZHONV3M.js → pricing-WNSMDD5D.js} +1 -1
- package/dist/{pricing.d-CvcYBm8A.d.cts → pricing.d-CuF7KcXt.d.cts} +80 -67
- package/dist/{pricing.d-CvcYBm8A.d.ts → pricing.d-CuF7KcXt.d.ts} +80 -67
- package/docs/environments.md +327 -11
- package/docs/file.md +1 -1
- package/docs/pricing.md +2 -2
- package/package.json +1 -1
- package/dist/environments-EAVUY4FC.cjs +0 -7
- package/dist/environments-RNOROUFZ.js +0 -7
package/docs/environments.md
CHANGED
|
@@ -41,6 +41,16 @@ 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
|
+
- [`ListOfString`](#listofstring)
|
|
48
|
+
- [`ListOfSecretString`](#listofsecretstring)
|
|
49
|
+
- [`ListOfNumber`](#listofnumber)
|
|
50
|
+
- [`ListOfBoolean`](#listofboolean)
|
|
51
|
+
- [`ListOfJson`](#listofjson)
|
|
52
|
+
- [`ListOfLink`](#listoflink)
|
|
53
|
+
- [`ListValue`](#listvalue)
|
|
44
54
|
- [`EnvironmentValue`](#environmentvalue)
|
|
45
55
|
- [`EnvironmentVariable`](#environmentvariable)
|
|
46
56
|
- [`EnvironmentVariableListItem`](#environmentvariablelistitem)
|
|
@@ -70,6 +80,7 @@ const { data } = await client.listEnvironmentVariables()
|
|
|
70
80
|
{
|
|
71
81
|
"key": "string",
|
|
72
82
|
"type": "String",
|
|
83
|
+
"item_type": "String",
|
|
73
84
|
"description": "string",
|
|
74
85
|
"group": "string",
|
|
75
86
|
"value": "string",
|
|
@@ -112,6 +123,7 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
112
123
|
{
|
|
113
124
|
"key": "string",
|
|
114
125
|
"type": "String",
|
|
126
|
+
"item_type": "String",
|
|
115
127
|
"description": "string",
|
|
116
128
|
"group": "string",
|
|
117
129
|
"value": "string",
|
|
@@ -221,6 +233,7 @@ const { data } = await client.getEnvironmentVariable({
|
|
|
221
233
|
{
|
|
222
234
|
"key": "string",
|
|
223
235
|
"type": "String",
|
|
236
|
+
"item_type": "String",
|
|
224
237
|
"description": "string",
|
|
225
238
|
"group": "string",
|
|
226
239
|
"value": "string",
|
|
@@ -262,6 +275,7 @@ const { data } = await client.updateEnvironmentVariable(
|
|
|
262
275
|
{
|
|
263
276
|
"key": "string",
|
|
264
277
|
"type": "String",
|
|
278
|
+
"item_type": "String",
|
|
265
279
|
"description": "string",
|
|
266
280
|
"group": "string",
|
|
267
281
|
"value": "string",
|
|
@@ -295,11 +309,11 @@ const { data } = await client.deleteEnvironmentVariable({
|
|
|
295
309
|
|
|
296
310
|
The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
297
311
|
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.
|
|
299
|
-
|
|
312
|
+
may be served to browser-facing consumers; `String` and `SecretString` may not. A
|
|
313
|
+
`List` inherits this from its element type: a `List` is
|
|
300
314
|
|
|
301
315
|
```ts
|
|
302
|
-
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
316
|
+
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
303
317
|
```
|
|
304
318
|
|
|
305
319
|
### `StringTranslations`
|
|
@@ -369,13 +383,160 @@ type LinkValue = {
|
|
|
369
383
|
}
|
|
370
384
|
```
|
|
371
385
|
|
|
386
|
+
### `LinkFields`
|
|
387
|
+
|
|
388
|
+
The fields of a link, without a fallback language — the shape a `List`
|
|
389
|
+
item carries. Inside a list the fallback belongs to the wrapper, which
|
|
390
|
+
owns the language tabs for every row.
|
|
391
|
+
|
|
392
|
+
Restated rather than composed with `LinkValue`: `allOf` plus
|
|
393
|
+
`additionalProperties: false` is rejected by most validato
|
|
394
|
+
|
|
395
|
+
```ts
|
|
396
|
+
type LinkFields = {
|
|
397
|
+
url: string
|
|
398
|
+
label: string | Record<string, string>
|
|
399
|
+
description?: string | Record<string, string>
|
|
400
|
+
}
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### `ListItemType`
|
|
404
|
+
|
|
405
|
+
The element type a `List` holds — every value type except the
|
|
406
|
+
containers. `Map` is already a keyed collection and a list of lists has
|
|
407
|
+
no consumer. A list is exactly as client-safe and exactly as secret as
|
|
408
|
+
its element type: a list of `SecretString` is encrypted per item and its
|
|
409
|
+
value is never returne
|
|
410
|
+
|
|
411
|
+
```ts
|
|
412
|
+
type ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
### `ListOfText`
|
|
416
|
+
|
|
417
|
+
```ts
|
|
418
|
+
type ListOfText = {
|
|
419
|
+
itemType: "Text"
|
|
420
|
+
items: string[]
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### `ListOfString`
|
|
425
|
+
|
|
426
|
+
```ts
|
|
427
|
+
type ListOfString = {
|
|
428
|
+
itemType: "String"
|
|
429
|
+
items: string[]
|
|
430
|
+
}
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### `ListOfSecretString`
|
|
434
|
+
|
|
435
|
+
Write-only in effect: the items are encrypted per item at rest and the
|
|
436
|
+
whole value is omitted from every read response, exactly as a
|
|
437
|
+
`SecretString` variable's value is. Read `item_type` to learn what a
|
|
438
|
+
list holds when its value is withheld.
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
```ts
|
|
442
|
+
type ListOfSecretString = {
|
|
443
|
+
itemType: "SecretString"
|
|
444
|
+
items: string[]
|
|
445
|
+
}
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### `ListOfNumber`
|
|
449
|
+
|
|
450
|
+
```ts
|
|
451
|
+
type ListOfNumber = {
|
|
452
|
+
itemType: "Number"
|
|
453
|
+
items: number[]
|
|
454
|
+
}
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### `ListOfBoolean`
|
|
458
|
+
|
|
459
|
+
```ts
|
|
460
|
+
type ListOfBoolean = {
|
|
461
|
+
itemType: "Boolean"
|
|
462
|
+
items: boolean[]
|
|
463
|
+
}
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
### `ListOfJson`
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
type ListOfJson = {
|
|
470
|
+
itemType: "JSON"
|
|
471
|
+
items: Record<string, unknown>[]
|
|
472
|
+
}
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### `ListOfLink`
|
|
476
|
+
|
|
477
|
+
A list of links. `fallbackLanguage` applies to every item's translated
|
|
478
|
+
`label` and `description`; items may mix plain and translated fields
|
|
479
|
+
freely, since a plain string is a complete answer for any language.
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
```ts
|
|
483
|
+
type ListOfLink = {
|
|
484
|
+
itemType: "Link"
|
|
485
|
+
fallbackLanguage?: string
|
|
486
|
+
items: Array<{
|
|
487
|
+
url: string
|
|
488
|
+
label: string | Record<string, string>
|
|
489
|
+
description?: string | Record<string, string>
|
|
490
|
+
}>
|
|
491
|
+
}
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### `ListValue`
|
|
495
|
+
|
|
496
|
+
An ordered collection of one declared element type. Items round-trip in
|
|
497
|
+
the order written; nothing sorts them. Holds at most 100 items.
|
|
498
|
+
|
|
499
|
+
The whole value is limited to 32768 characters when serialised — the
|
|
500
|
+
server enforces this, and it is not expressible per-property here.
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
```ts
|
|
504
|
+
type ListValue = {
|
|
505
|
+
itemType: "Text"
|
|
506
|
+
items: string[]
|
|
507
|
+
} | {
|
|
508
|
+
itemType: "Number"
|
|
509
|
+
items: number[]
|
|
510
|
+
} | {
|
|
511
|
+
itemType: "Boolean"
|
|
512
|
+
items: boolean[]
|
|
513
|
+
} | {
|
|
514
|
+
itemType: "JSON"
|
|
515
|
+
items: Record<string, unknown>[]
|
|
516
|
+
} | {
|
|
517
|
+
itemType: "Link"
|
|
518
|
+
fallbackLanguage?: string
|
|
519
|
+
items: Array<{
|
|
520
|
+
url: string
|
|
521
|
+
label: string | Record<string, string>
|
|
522
|
+
description?: string | Record<string, string>
|
|
523
|
+
}>
|
|
524
|
+
} | {
|
|
525
|
+
itemType: "String"
|
|
526
|
+
items: string[]
|
|
527
|
+
} | {
|
|
528
|
+
itemType: "SecretString"
|
|
529
|
+
items: string[]
|
|
530
|
+
}
|
|
531
|
+
```
|
|
532
|
+
|
|
372
533
|
### `EnvironmentValue`
|
|
373
534
|
|
|
374
535
|
A variable's value. The JSON type corresponds to the variable's `type`:
|
|
375
536
|
`String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
376
|
-
`Boolean` is a boolean, and `Map`, `JSON` and `
|
|
377
|
-
IEEE 754 doubles; integers above 2^53 may lose precision on
|
|
378
|
-
|
|
537
|
+
`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
|
|
538
|
+
Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
|
|
539
|
+
round-trip.
|
|
379
540
|
|
|
380
541
|
```ts
|
|
381
542
|
type EnvironmentValue = string | number | boolean | {
|
|
@@ -389,6 +550,32 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
389
550
|
label: string | Record<string, string>
|
|
390
551
|
description?: string | Record<string, string>
|
|
391
552
|
fallbackLanguage?: string
|
|
553
|
+
} | {
|
|
554
|
+
itemType: "Text"
|
|
555
|
+
items: string[]
|
|
556
|
+
} | {
|
|
557
|
+
itemType: "Number"
|
|
558
|
+
items: number[]
|
|
559
|
+
} | {
|
|
560
|
+
itemType: "Boolean"
|
|
561
|
+
items: boolean[]
|
|
562
|
+
} | {
|
|
563
|
+
itemType: "JSON"
|
|
564
|
+
items: Record<string, unknown>[]
|
|
565
|
+
} | {
|
|
566
|
+
itemType: "Link"
|
|
567
|
+
fallbackLanguage?: string
|
|
568
|
+
items: Array<{
|
|
569
|
+
url: string
|
|
570
|
+
label: string | Record<string, string>
|
|
571
|
+
description?: string | Record<string, string>
|
|
572
|
+
}>
|
|
573
|
+
} | {
|
|
574
|
+
itemType: "String"
|
|
575
|
+
items: string[]
|
|
576
|
+
} | {
|
|
577
|
+
itemType: "SecretString"
|
|
578
|
+
items: string[]
|
|
392
579
|
}
|
|
393
580
|
```
|
|
394
581
|
|
|
@@ -397,7 +584,8 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
397
584
|
```ts
|
|
398
585
|
type EnvironmentVariable = {
|
|
399
586
|
key: string
|
|
400
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
587
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
588
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
401
589
|
description?: string
|
|
402
590
|
group?: string
|
|
403
591
|
value?: string | number | boolean | {
|
|
@@ -411,6 +599,32 @@ type EnvironmentVariable = {
|
|
|
411
599
|
label: string | Record<string, string>
|
|
412
600
|
description?: string | Record<string, string>
|
|
413
601
|
fallbackLanguage?: string
|
|
602
|
+
} | {
|
|
603
|
+
itemType: "Text"
|
|
604
|
+
items: string[]
|
|
605
|
+
} | {
|
|
606
|
+
itemType: "Number"
|
|
607
|
+
items: number[]
|
|
608
|
+
} | {
|
|
609
|
+
itemType: "Boolean"
|
|
610
|
+
items: boolean[]
|
|
611
|
+
} | {
|
|
612
|
+
itemType: "JSON"
|
|
613
|
+
items: Record<string, unknown>[]
|
|
614
|
+
} | {
|
|
615
|
+
itemType: "Link"
|
|
616
|
+
fallbackLanguage?: string
|
|
617
|
+
items: Array<{
|
|
618
|
+
url: { ... }
|
|
619
|
+
label: { ... }
|
|
620
|
+
description?: { ... }
|
|
621
|
+
}>
|
|
622
|
+
} | {
|
|
623
|
+
itemType: "String"
|
|
624
|
+
items: string[]
|
|
625
|
+
} | {
|
|
626
|
+
itemType: "SecretString"
|
|
627
|
+
items: string[]
|
|
414
628
|
}
|
|
415
629
|
protected?: boolean
|
|
416
630
|
created_at: string // date-time
|
|
@@ -423,7 +637,8 @@ type EnvironmentVariable = {
|
|
|
423
637
|
```ts
|
|
424
638
|
type EnvironmentVariableListItem = {
|
|
425
639
|
key: string
|
|
426
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
640
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
641
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
427
642
|
description?: string
|
|
428
643
|
group?: string
|
|
429
644
|
value?: string | number | boolean | {
|
|
@@ -437,6 +652,32 @@ type EnvironmentVariableListItem = {
|
|
|
437
652
|
label: string | Record<string, string>
|
|
438
653
|
description?: string | Record<string, string>
|
|
439
654
|
fallbackLanguage?: string
|
|
655
|
+
} | {
|
|
656
|
+
itemType: "Text"
|
|
657
|
+
items: string[]
|
|
658
|
+
} | {
|
|
659
|
+
itemType: "Number"
|
|
660
|
+
items: number[]
|
|
661
|
+
} | {
|
|
662
|
+
itemType: "Boolean"
|
|
663
|
+
items: boolean[]
|
|
664
|
+
} | {
|
|
665
|
+
itemType: "JSON"
|
|
666
|
+
items: Record<string, unknown>[]
|
|
667
|
+
} | {
|
|
668
|
+
itemType: "Link"
|
|
669
|
+
fallbackLanguage?: string
|
|
670
|
+
items: Array<{
|
|
671
|
+
url: { ... }
|
|
672
|
+
label: { ... }
|
|
673
|
+
description?: { ... }
|
|
674
|
+
}>
|
|
675
|
+
} | {
|
|
676
|
+
itemType: "String"
|
|
677
|
+
items: string[]
|
|
678
|
+
} | {
|
|
679
|
+
itemType: "SecretString"
|
|
680
|
+
items: string[]
|
|
440
681
|
}
|
|
441
682
|
protected?: boolean
|
|
442
683
|
created_at: string // date-time
|
|
@@ -450,7 +691,8 @@ type EnvironmentVariableListItem = {
|
|
|
450
691
|
type EnvironmentVariableList = {
|
|
451
692
|
items: Array<{
|
|
452
693
|
key: string
|
|
453
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
694
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
695
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
454
696
|
description?: string
|
|
455
697
|
group?: string
|
|
456
698
|
value?: string | number | boolean | {
|
|
@@ -461,6 +703,28 @@ type EnvironmentVariableList = {
|
|
|
461
703
|
label: { ... }
|
|
462
704
|
description?: { ... }
|
|
463
705
|
fallbackLanguage?: { ... }
|
|
706
|
+
} | {
|
|
707
|
+
itemType: { ... }
|
|
708
|
+
items: { ... }
|
|
709
|
+
} | {
|
|
710
|
+
itemType: { ... }
|
|
711
|
+
items: { ... }
|
|
712
|
+
} | {
|
|
713
|
+
itemType: { ... }
|
|
714
|
+
items: { ... }
|
|
715
|
+
} | {
|
|
716
|
+
itemType: { ... }
|
|
717
|
+
items: { ... }
|
|
718
|
+
} | {
|
|
719
|
+
itemType: { ... }
|
|
720
|
+
fallbackLanguage?: { ... }
|
|
721
|
+
items: { ... }
|
|
722
|
+
} | {
|
|
723
|
+
itemType: { ... }
|
|
724
|
+
items: { ... }
|
|
725
|
+
} | {
|
|
726
|
+
itemType: { ... }
|
|
727
|
+
items: { ... }
|
|
464
728
|
}
|
|
465
729
|
protected?: boolean
|
|
466
730
|
created_at: string // date-time
|
|
@@ -474,7 +738,7 @@ type EnvironmentVariableList = {
|
|
|
474
738
|
```ts
|
|
475
739
|
type EnvironmentVariableCreateRequest = {
|
|
476
740
|
key: string
|
|
477
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
741
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
478
742
|
description?: string
|
|
479
743
|
group?: string
|
|
480
744
|
value?: string | number | boolean | {
|
|
@@ -488,6 +752,32 @@ type EnvironmentVariableCreateRequest = {
|
|
|
488
752
|
label: string | Record<string, string>
|
|
489
753
|
description?: string | Record<string, string>
|
|
490
754
|
fallbackLanguage?: string
|
|
755
|
+
} | {
|
|
756
|
+
itemType: "Text"
|
|
757
|
+
items: string[]
|
|
758
|
+
} | {
|
|
759
|
+
itemType: "Number"
|
|
760
|
+
items: number[]
|
|
761
|
+
} | {
|
|
762
|
+
itemType: "Boolean"
|
|
763
|
+
items: boolean[]
|
|
764
|
+
} | {
|
|
765
|
+
itemType: "JSON"
|
|
766
|
+
items: Record<string, unknown>[]
|
|
767
|
+
} | {
|
|
768
|
+
itemType: "Link"
|
|
769
|
+
fallbackLanguage?: string
|
|
770
|
+
items: Array<{
|
|
771
|
+
url: { ... }
|
|
772
|
+
label: { ... }
|
|
773
|
+
description?: { ... }
|
|
774
|
+
}>
|
|
775
|
+
} | {
|
|
776
|
+
itemType: "String"
|
|
777
|
+
items: string[]
|
|
778
|
+
} | {
|
|
779
|
+
itemType: "SecretString"
|
|
780
|
+
items: string[]
|
|
491
781
|
}
|
|
492
782
|
protected?: boolean
|
|
493
783
|
}
|
|
@@ -497,7 +787,7 @@ type EnvironmentVariableCreateRequest = {
|
|
|
497
787
|
|
|
498
788
|
```ts
|
|
499
789
|
type EnvironmentVariableUpdateRequest = {
|
|
500
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
790
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
501
791
|
value?: string | number | boolean | {
|
|
502
792
|
fallbackLanguage?: string
|
|
503
793
|
options: Array<{
|
|
@@ -509,6 +799,32 @@ type EnvironmentVariableUpdateRequest = {
|
|
|
509
799
|
label: string | Record<string, string>
|
|
510
800
|
description?: string | Record<string, string>
|
|
511
801
|
fallbackLanguage?: string
|
|
802
|
+
} | {
|
|
803
|
+
itemType: "Text"
|
|
804
|
+
items: string[]
|
|
805
|
+
} | {
|
|
806
|
+
itemType: "Number"
|
|
807
|
+
items: number[]
|
|
808
|
+
} | {
|
|
809
|
+
itemType: "Boolean"
|
|
810
|
+
items: boolean[]
|
|
811
|
+
} | {
|
|
812
|
+
itemType: "JSON"
|
|
813
|
+
items: Record<string, unknown>[]
|
|
814
|
+
} | {
|
|
815
|
+
itemType: "Link"
|
|
816
|
+
fallbackLanguage?: string
|
|
817
|
+
items: Array<{
|
|
818
|
+
url: { ... }
|
|
819
|
+
label: { ... }
|
|
820
|
+
description?: { ... }
|
|
821
|
+
}>
|
|
822
|
+
} | {
|
|
823
|
+
itemType: "String"
|
|
824
|
+
items: string[]
|
|
825
|
+
} | {
|
|
826
|
+
itemType: "SecretString"
|
|
827
|
+
items: string[]
|
|
512
828
|
}
|
|
513
829
|
description?: string
|
|
514
830
|
group?: string
|
package/docs/file.md
CHANGED
|
@@ -1525,7 +1525,7 @@ type FileValidationFileReference = {
|
|
|
1525
1525
|
```ts
|
|
1526
1526
|
type FileValidation = {
|
|
1527
1527
|
id: string
|
|
1528
|
-
status: "completed" | "pending" | "failed"
|
|
1528
|
+
status: "completed" | "pending" | "failed" | "skipped"
|
|
1529
1529
|
file: {
|
|
1530
1530
|
entity_id?: string | string // uuid
|
|
1531
1531
|
s3ref?: unknown
|
package/docs/pricing.md
CHANGED
|
@@ -3115,8 +3115,8 @@ type PinnedConditions = Record<string, unknown>
|
|
|
3115
3115
|
The attribute values this version overrides on the base entity, keyed by attribute name.
|
|
3116
3116
|
|
|
3117
3117
|
Only attributes currently declaring `overridable_attribute` are applied. Metadata fields
|
|
3118
|
-
(anything underscore-prefixed), readonly attributes, hidden attributes, computed attributes
|
|
3119
|
-
|
|
3118
|
+
(anything underscore-prefixed), readonly attributes, hidden attributes, computed attributes,
|
|
3119
|
+
attributes of a type no vari
|
|
3120
3120
|
|
|
3121
3121
|
```ts
|
|
3122
3122
|
type VariantValues = Record<string, unknown>
|
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- [`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` and `Link`\nmay 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"\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### `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` and `Link` are objects. Numbers are\nIEEE 754 doubles; integers above 2^53 may lose precision on round-trip.\n\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```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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 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"\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 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"\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 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"\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 protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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 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- [`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` and `Link`\nmay 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"\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### `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` and `Link` are objects. Numbers are\nIEEE 754 doubles; integers above 2^53 may lose precision on round-trip.\n\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```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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 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"\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 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"\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 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"\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 protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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 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
|
-
};
|