@epilot/sdk 2.20.13-alpha.0 → 2.20.14
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 +5 -287
- package/definitions/integration-toolkit.json +112 -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 +221 -6
- package/dist/apis/integration-toolkit.d.cts +41 -3
- package/dist/apis/integration-toolkit.d.ts +41 -3
- package/dist/apis/integration-toolkit.js +216 -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.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/bin/cli.js +1 -1
- package/dist/{chunk-3OIZHXWK.cjs → chunk-ELW4V3ID.cjs} +2 -2
- package/dist/{chunk-ARX7EKG7.js → chunk-FONJD6VA.js} +2 -2
- package/dist/environments-EAVUY4FC.cjs +7 -0
- package/dist/environments-RNOROUFZ.js +7 -0
- package/dist/{environments.d-qL1urwAq.d.ts → environments.d-C_BTxz4W.d.cts} +22 -252
- package/dist/{environments.d-qL1urwAq.d.cts → environments.d-C_BTxz4W.d.ts} +22 -252
- 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/integration-toolkit-GOFVOMNH.js +7 -0
- package/dist/integration-toolkit-XMM5LLK6.cjs +7 -0
- package/dist/{integration-toolkit.d-rpj1kvB_.d.cts → integration-toolkit.d-bhpB79pc.d.cts} +37 -8
- package/dist/{integration-toolkit.d-rpj1kvB_.d.ts → integration-toolkit.d-bhpB79pc.d.ts} +37 -8
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/docs/environments.md +11 -327
- package/docs/integration-toolkit.md +24 -3
- package/package.json +1 -1
- package/dist/environments-OYCH6VUD.js +0 -7
- package/dist/environments-S3O6ASTY.cjs +0 -7
- package/dist/integration-toolkit-BHVL3SDT.js +0 -7
- package/dist/integration-toolkit-WWHOAH3S.cjs +0 -7
package/docs/environments.md
CHANGED
|
@@ -41,16 +41,6 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
41
41
|
- [`MapValue`](#mapvalue)
|
|
42
42
|
- [`JsonValue`](#jsonvalue)
|
|
43
43
|
- [`LinkValue`](#linkvalue)
|
|
44
|
-
- [`LinkFields`](#linkfields)
|
|
45
|
-
- [`ListItemType`](#listitemtype)
|
|
46
|
-
- [`ListOfText`](#listoftext)
|
|
47
|
-
- [`ListOfString`](#listofstring)
|
|
48
|
-
- [`ListOfSecretString`](#listofsecretstring)
|
|
49
|
-
- [`ListOfNumber`](#listofnumber)
|
|
50
|
-
- [`ListOfBoolean`](#listofboolean)
|
|
51
|
-
- [`ListOfJson`](#listofjson)
|
|
52
|
-
- [`ListOfLink`](#listoflink)
|
|
53
|
-
- [`ListValue`](#listvalue)
|
|
54
44
|
- [`EnvironmentValue`](#environmentvalue)
|
|
55
45
|
- [`EnvironmentVariable`](#environmentvariable)
|
|
56
46
|
- [`EnvironmentVariableListItem`](#environmentvariablelistitem)
|
|
@@ -80,7 +70,6 @@ const { data } = await client.listEnvironmentVariables()
|
|
|
80
70
|
{
|
|
81
71
|
"key": "string",
|
|
82
72
|
"type": "String",
|
|
83
|
-
"item_type": "String",
|
|
84
73
|
"description": "string",
|
|
85
74
|
"group": "string",
|
|
86
75
|
"value": "string",
|
|
@@ -123,7 +112,6 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
123
112
|
{
|
|
124
113
|
"key": "string",
|
|
125
114
|
"type": "String",
|
|
126
|
-
"item_type": "String",
|
|
127
115
|
"description": "string",
|
|
128
116
|
"group": "string",
|
|
129
117
|
"value": "string",
|
|
@@ -233,7 +221,6 @@ const { data } = await client.getEnvironmentVariable({
|
|
|
233
221
|
{
|
|
234
222
|
"key": "string",
|
|
235
223
|
"type": "String",
|
|
236
|
-
"item_type": "String",
|
|
237
224
|
"description": "string",
|
|
238
225
|
"group": "string",
|
|
239
226
|
"value": "string",
|
|
@@ -275,7 +262,6 @@ const { data } = await client.updateEnvironmentVariable(
|
|
|
275
262
|
{
|
|
276
263
|
"key": "string",
|
|
277
264
|
"type": "String",
|
|
278
|
-
"item_type": "String",
|
|
279
265
|
"description": "string",
|
|
280
266
|
"group": "string",
|
|
281
267
|
"value": "string",
|
|
@@ -309,11 +295,11 @@ const { data } = await client.deleteEnvironmentVariable({
|
|
|
309
295
|
|
|
310
296
|
The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
311
297
|
its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
312
|
-
may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
313
|
-
|
|
298
|
+
may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
299
|
+
|
|
314
300
|
|
|
315
301
|
```ts
|
|
316
|
-
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
302
|
+
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
317
303
|
```
|
|
318
304
|
|
|
319
305
|
### `StringTranslations`
|
|
@@ -383,160 +369,13 @@ type LinkValue = {
|
|
|
383
369
|
}
|
|
384
370
|
```
|
|
385
371
|
|
|
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
|
-
|
|
533
372
|
### `EnvironmentValue`
|
|
534
373
|
|
|
535
374
|
A variable's value. The JSON type corresponds to the variable's `type`:
|
|
536
375
|
`String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
537
|
-
`Boolean` is a boolean, and `Map`, `JSON
|
|
538
|
-
|
|
539
|
-
|
|
376
|
+
`Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
377
|
+
IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
378
|
+
|
|
540
379
|
|
|
541
380
|
```ts
|
|
542
381
|
type EnvironmentValue = string | number | boolean | {
|
|
@@ -550,32 +389,6 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
550
389
|
label: string | Record<string, string>
|
|
551
390
|
description?: string | Record<string, string>
|
|
552
391
|
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[]
|
|
579
392
|
}
|
|
580
393
|
```
|
|
581
394
|
|
|
@@ -584,8 +397,7 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
584
397
|
```ts
|
|
585
398
|
type EnvironmentVariable = {
|
|
586
399
|
key: string
|
|
587
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
588
|
-
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
400
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
589
401
|
description?: string
|
|
590
402
|
group?: string
|
|
591
403
|
value?: string | number | boolean | {
|
|
@@ -599,32 +411,6 @@ type EnvironmentVariable = {
|
|
|
599
411
|
label: string | Record<string, string>
|
|
600
412
|
description?: string | Record<string, string>
|
|
601
413
|
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[]
|
|
628
414
|
}
|
|
629
415
|
protected?: boolean
|
|
630
416
|
created_at: string // date-time
|
|
@@ -637,8 +423,7 @@ type EnvironmentVariable = {
|
|
|
637
423
|
```ts
|
|
638
424
|
type EnvironmentVariableListItem = {
|
|
639
425
|
key: string
|
|
640
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
641
|
-
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
426
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
642
427
|
description?: string
|
|
643
428
|
group?: string
|
|
644
429
|
value?: string | number | boolean | {
|
|
@@ -652,32 +437,6 @@ type EnvironmentVariableListItem = {
|
|
|
652
437
|
label: string | Record<string, string>
|
|
653
438
|
description?: string | Record<string, string>
|
|
654
439
|
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[]
|
|
681
440
|
}
|
|
682
441
|
protected?: boolean
|
|
683
442
|
created_at: string // date-time
|
|
@@ -691,8 +450,7 @@ type EnvironmentVariableListItem = {
|
|
|
691
450
|
type EnvironmentVariableList = {
|
|
692
451
|
items: Array<{
|
|
693
452
|
key: string
|
|
694
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
695
|
-
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
453
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
696
454
|
description?: string
|
|
697
455
|
group?: string
|
|
698
456
|
value?: string | number | boolean | {
|
|
@@ -703,28 +461,6 @@ type EnvironmentVariableList = {
|
|
|
703
461
|
label: { ... }
|
|
704
462
|
description?: { ... }
|
|
705
463
|
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: { ... }
|
|
728
464
|
}
|
|
729
465
|
protected?: boolean
|
|
730
466
|
created_at: string // date-time
|
|
@@ -738,7 +474,7 @@ type EnvironmentVariableList = {
|
|
|
738
474
|
```ts
|
|
739
475
|
type EnvironmentVariableCreateRequest = {
|
|
740
476
|
key: string
|
|
741
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
477
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
742
478
|
description?: string
|
|
743
479
|
group?: string
|
|
744
480
|
value?: string | number | boolean | {
|
|
@@ -752,32 +488,6 @@ type EnvironmentVariableCreateRequest = {
|
|
|
752
488
|
label: string | Record<string, string>
|
|
753
489
|
description?: string | Record<string, string>
|
|
754
490
|
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[]
|
|
781
491
|
}
|
|
782
492
|
protected?: boolean
|
|
783
493
|
}
|
|
@@ -787,7 +497,7 @@ type EnvironmentVariableCreateRequest = {
|
|
|
787
497
|
|
|
788
498
|
```ts
|
|
789
499
|
type EnvironmentVariableUpdateRequest = {
|
|
790
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
500
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
791
501
|
value?: string | number | boolean | {
|
|
792
502
|
fallbackLanguage?: string
|
|
793
503
|
options: Array<{
|
|
@@ -799,32 +509,6 @@ type EnvironmentVariableUpdateRequest = {
|
|
|
799
509
|
label: string | Record<string, string>
|
|
800
510
|
description?: string | Record<string, string>
|
|
801
511
|
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[]
|
|
828
512
|
}
|
|
829
513
|
description?: string
|
|
830
514
|
group?: string
|
|
@@ -308,6 +308,7 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
|
|
|
308
308
|
- [`IngestExternalMonitoringEventsRequest`](#ingestexternalmonitoringeventsrequest)
|
|
309
309
|
- [`IngestExternalMonitoringEventsResponse`](#ingestexternalmonitoringeventsresponse)
|
|
310
310
|
- [`MonitoringTraceResponse`](#monitoringtraceresponse)
|
|
311
|
+
- [`MonitoringCode`](#monitoringcode)
|
|
311
312
|
- [`MonitoringEventV2`](#monitoringeventv2)
|
|
312
313
|
- [`GetMonitoringStatsV2Request`](#getmonitoringstatsv2request)
|
|
313
314
|
- [`MonitoringStatsV2`](#monitoringstatsv2)
|
|
@@ -3202,6 +3203,7 @@ const { data } = await client.getMonitoringStatsV2(
|
|
|
3202
3203
|
"error_count": 0,
|
|
3203
3204
|
"warning_count": 0,
|
|
3204
3205
|
"skipped_count": 0,
|
|
3206
|
+
"info_count": 0,
|
|
3205
3207
|
"ack_timeout_count": 0,
|
|
3206
3208
|
"success_rate": 0,
|
|
3207
3209
|
"last_error_at": "1970-01-01T00:00:00.000Z",
|
|
@@ -3252,6 +3254,7 @@ const { data } = await client.getMonitoringTimeSeriesV2(
|
|
|
3252
3254
|
"error_count": 0,
|
|
3253
3255
|
"warning_count": 0,
|
|
3254
3256
|
"skipped_count": 0,
|
|
3257
|
+
"info_count": 0,
|
|
3255
3258
|
"total_count": 0,
|
|
3256
3259
|
"breakdown": [
|
|
3257
3260
|
{
|
|
@@ -3261,6 +3264,7 @@ const { data } = await client.getMonitoringTimeSeriesV2(
|
|
|
3261
3264
|
"error_count": 0,
|
|
3262
3265
|
"warning_count": 0,
|
|
3263
3266
|
"skipped_count": 0,
|
|
3267
|
+
"info_count": 0,
|
|
3264
3268
|
"total_count": 0
|
|
3265
3269
|
}
|
|
3266
3270
|
]
|
|
@@ -9291,7 +9295,7 @@ type InboundMonitoringEvent = {
|
|
|
9291
9295
|
type QueryMonitoringEventsV2Request = {
|
|
9292
9296
|
use_case_id?: string
|
|
9293
9297
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
|
|
9294
|
-
level?: "success" | "error" | "
|
|
9298
|
+
level?: "success" | "error" | "info" | "warning"
|
|
9295
9299
|
code?: string
|
|
9296
9300
|
event_id?: string
|
|
9297
9301
|
correlation_id?: string
|
|
@@ -9367,7 +9371,7 @@ type MonitoringTraceResponse = {
|
|
|
9367
9371
|
correlation_id?: string
|
|
9368
9372
|
use_case_id?: string
|
|
9369
9373
|
use_case_type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy" | ""
|
|
9370
|
-
level: "success" | "error" | "
|
|
9374
|
+
level: "success" | "error" | "info" | "warning"
|
|
9371
9375
|
code?: string
|
|
9372
9376
|
message?: string
|
|
9373
9377
|
detail?: Record<string, unknown>
|
|
@@ -9377,6 +9381,19 @@ type MonitoringTraceResponse = {
|
|
|
9377
9381
|
}
|
|
9378
9382
|
```
|
|
9379
9383
|
|
|
9384
|
+
### `MonitoringCode`
|
|
9385
|
+
|
|
9386
|
+
The monitoring code taxonomy — every code the Integration Toolkit itself emits,
|
|
9387
|
+
with a fixed level (see the published code reference at
|
|
9388
|
+
https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/codes).
|
|
9389
|
+
|
|
9390
|
+
This schema exists so consumers can import the union as a type. It is
|
|
9391
|
+
deliberately
|
|
9392
|
+
|
|
9393
|
+
```ts
|
|
9394
|
+
type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
|
|
9395
|
+
```
|
|
9396
|
+
|
|
9380
9397
|
### `MonitoringEventV2`
|
|
9381
9398
|
|
|
9382
9399
|
```ts
|
|
@@ -9388,7 +9405,7 @@ type MonitoringEventV2 = {
|
|
|
9388
9405
|
correlation_id?: string
|
|
9389
9406
|
use_case_id?: string
|
|
9390
9407
|
use_case_type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy" | ""
|
|
9391
|
-
level: "success" | "error" | "
|
|
9408
|
+
level: "success" | "error" | "info" | "warning"
|
|
9392
9409
|
code?: string
|
|
9393
9410
|
message?: string
|
|
9394
9411
|
detail?: Record<string, unknown>
|
|
@@ -9418,6 +9435,7 @@ type MonitoringStatsV2 = {
|
|
|
9418
9435
|
error_count: number
|
|
9419
9436
|
warning_count: number
|
|
9420
9437
|
skipped_count: number
|
|
9438
|
+
info_count: number
|
|
9421
9439
|
ack_timeout_count?: number
|
|
9422
9440
|
success_rate?: number
|
|
9423
9441
|
last_error_at?: string // date-time
|
|
@@ -9447,6 +9465,7 @@ type TimeSeriesBreakdownItemV2 = {
|
|
|
9447
9465
|
error_count: number
|
|
9448
9466
|
warning_count: number
|
|
9449
9467
|
skipped_count: number
|
|
9468
|
+
info_count: number
|
|
9450
9469
|
total_count: number
|
|
9451
9470
|
}
|
|
9452
9471
|
```
|
|
@@ -9460,6 +9479,7 @@ type TimeSeriesBucketV2 = {
|
|
|
9460
9479
|
error_count?: number
|
|
9461
9480
|
warning_count?: number
|
|
9462
9481
|
skipped_count?: number
|
|
9482
|
+
info_count?: number
|
|
9463
9483
|
total_count: number
|
|
9464
9484
|
breakdown?: Array<{
|
|
9465
9485
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy"
|
|
@@ -9468,6 +9488,7 @@ type TimeSeriesBucketV2 = {
|
|
|
9468
9488
|
error_count: number
|
|
9469
9489
|
warning_count: number
|
|
9470
9490
|
skipped_count: number
|
|
9491
|
+
info_count: number
|
|
9471
9492
|
total_count: number
|
|
9472
9493
|
}>
|
|
9473
9494
|
}
|
package/package.json
CHANGED
|
@@ -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- [`ListOfString`](#listofstring)\n- [`ListOfSecretString`](#listofsecretstring)\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 "item_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 "item_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 "item_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 "item_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. A\n`List` inherits this from its element type: a `List` is\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 \u2014 every value type except the\ncontainers. `Map` is already a keyed collection and a list of lists has\nno consumer. A list is exactly as client-safe and exactly as secret as\nits element type: a list of `SecretString` is encrypted per item and its\nvalue is never returne\n\n```ts\ntype ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"\n```\n\n### `ListOfText`\n\n```ts\ntype ListOfText = {\n itemType: "Text"\n items: string[]\n}\n```\n\n### `ListOfString`\n\n```ts\ntype ListOfString = {\n itemType: "String"\n items: string[]\n}\n```\n\n### `ListOfSecretString`\n\nWrite-only in effect: the items are encrypted per item at rest and the\nwhole value is omitted from every read response, exactly as a\n`SecretString` variable\'s value is. Read `item_type` to learn what a\nlist holds when its value is withheld.\n\n\n```ts\ntype ListOfSecretString = {\n itemType: "SecretString"\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 itemType: "String"\n items: string[]\n} | {\n itemType: "SecretString"\n items: 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`, `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 itemType: "String"\n items: string[]\n} | {\n itemType: "SecretString"\n items: string[]\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 item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "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 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 itemType: "String"\n items: string[]\n } | {\n itemType: "SecretString"\n items: 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" | "List"\n item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "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 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 itemType: "String"\n items: string[]\n } | {\n itemType: "SecretString"\n items: 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" | "List"\n item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "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 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 itemType: { ... }\n items: { ... }\n } | {\n itemType: { ... }\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 itemType: "String"\n items: string[]\n } | {\n itemType: "SecretString"\n items: 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" | "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 itemType: "String"\n items: string[]\n } | {\n itemType: "SecretString"\n items: 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
|
-
};
|