@epilot/sdk 2.20.6 → 2.20.7
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 +63 -8
- 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.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-72CUHWUC.cjs → chunk-22IGZ7VQ.cjs} +1 -1
- package/dist/{chunk-SJTMU4I2.js → chunk-QRC6XEXV.js} +1 -1
- package/dist/environments-EAVUY4FC.cjs +7 -0
- package/dist/environments-RNOROUFZ.js +7 -0
- package/dist/{environments.d-DVgvq0wo.d.cts → environments.d-C_BTxz4W.d.cts} +175 -26
- package/dist/{environments.d-DVgvq0wo.d.ts → environments.d-C_BTxz4W.d.ts} +175 -26
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/environments.md +74 -13
- package/package.json +1 -1
- package/dist/environments-4YS2MZ3G.js +0 -7
- package/dist/environments-EJSSTDDU.cjs +0 -7
|
@@ -20,31 +20,59 @@ declare namespace Components {
|
|
|
20
20
|
/**
|
|
21
21
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
22
22
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
23
|
-
* `Boolean` is a boolean, and `Map`
|
|
24
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
23
|
+
* `Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
24
|
+
* IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export type EnvironmentValue = /**
|
|
28
28
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
29
29
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
30
|
-
* `Boolean` is a boolean, and `Map`
|
|
31
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
30
|
+
* `Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
31
|
+
* IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
|
-
string | number | boolean | MapValue
|
|
34
|
+
string | number | boolean | MapValue | /**
|
|
35
|
+
* Arbitrary JSON object, e.g. a flat key/value map used by integrations for
|
|
36
|
+
* enum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
JsonValue | /**
|
|
40
|
+
* One URL with a label and description a customer reads. `label` and
|
|
41
|
+
* `description` are each either a plain string or one string per language;
|
|
42
|
+
* the two fields decide that independently — a plain string means "the
|
|
43
|
+
* same in every language". A translated field must carry the fallback
|
|
44
|
+
* language.
|
|
45
|
+
*
|
|
46
|
+
* The URL must be absolute and `http`/`https` only. This value is served
|
|
47
|
+
* to browser-facing consumers, so `javascript:` and `data:` URLs are
|
|
48
|
+
* rejected at write time.
|
|
49
|
+
*
|
|
50
|
+
* Written flat rather than composed from a shared field set: `allOf` plus
|
|
51
|
+
* `additionalProperties: false` is rejected by most validators, because
|
|
52
|
+
* each branch sees the sibling's properties as unknown. The composition
|
|
53
|
+
* lives in zod (LinkFieldsSchema) — see src/core/value-types.ts.
|
|
54
|
+
*
|
|
55
|
+
* Each translated value of `label` and `description` is also limited to
|
|
56
|
+
* the same maximum as the plain-string form above — 255 characters for
|
|
57
|
+
* `label`, 1024 for `description`. The limit is enforced by the server
|
|
58
|
+
* even though the shared `StringTranslations` schema referenced below
|
|
59
|
+
* does not itself declare it.
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
LinkValue;
|
|
35
63
|
/**
|
|
36
64
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
37
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `
|
|
38
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
65
|
+
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
66
|
+
* may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
39
67
|
*
|
|
40
68
|
*/
|
|
41
|
-
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map";
|
|
69
|
+
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
42
70
|
export interface EnvironmentVariable {
|
|
43
71
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
44
72
|
type: /**
|
|
45
73
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
46
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `
|
|
47
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
74
|
+
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
75
|
+
* may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
48
76
|
*
|
|
49
77
|
*/
|
|
50
78
|
EnvironmentValueType;
|
|
@@ -65,7 +93,35 @@ declare namespace Components {
|
|
|
65
93
|
* install, which syncs a variable's key and type but never its value.
|
|
66
94
|
*
|
|
67
95
|
*/
|
|
68
|
-
string | number | boolean | MapValue
|
|
96
|
+
string | number | boolean | MapValue | /**
|
|
97
|
+
* Arbitrary JSON object, e.g. a flat key/value map used by integrations for
|
|
98
|
+
* enum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.
|
|
99
|
+
*
|
|
100
|
+
*/
|
|
101
|
+
JsonValue | /**
|
|
102
|
+
* One URL with a label and description a customer reads. `label` and
|
|
103
|
+
* `description` are each either a plain string or one string per language;
|
|
104
|
+
* the two fields decide that independently — a plain string means "the
|
|
105
|
+
* same in every language". A translated field must carry the fallback
|
|
106
|
+
* language.
|
|
107
|
+
*
|
|
108
|
+
* The URL must be absolute and `http`/`https` only. This value is served
|
|
109
|
+
* to browser-facing consumers, so `javascript:` and `data:` URLs are
|
|
110
|
+
* rejected at write time.
|
|
111
|
+
*
|
|
112
|
+
* Written flat rather than composed from a shared field set: `allOf` plus
|
|
113
|
+
* `additionalProperties: false` is rejected by most validators, because
|
|
114
|
+
* each branch sees the sibling's properties as unknown. The composition
|
|
115
|
+
* lives in zod (LinkFieldsSchema) — see src/core/value-types.ts.
|
|
116
|
+
*
|
|
117
|
+
* Each translated value of `label` and `description` is also limited to
|
|
118
|
+
* the same maximum as the plain-string form above — 255 characters for
|
|
119
|
+
* `label`, 1024 for `description`. The limit is enforced by the server
|
|
120
|
+
* even though the shared `StringTranslations` schema referenced below
|
|
121
|
+
* does not itself declare it.
|
|
122
|
+
*
|
|
123
|
+
*/
|
|
124
|
+
LinkValue;
|
|
69
125
|
/**
|
|
70
126
|
* Whether the variable is protected from editing
|
|
71
127
|
*/
|
|
@@ -77,8 +133,8 @@ declare namespace Components {
|
|
|
77
133
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
78
134
|
type: /**
|
|
79
135
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
80
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `
|
|
81
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
136
|
+
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
137
|
+
* may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
82
138
|
*
|
|
83
139
|
*/
|
|
84
140
|
EnvironmentValueType;
|
|
@@ -87,8 +143,8 @@ declare namespace Components {
|
|
|
87
143
|
value?: /**
|
|
88
144
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
89
145
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
90
|
-
* `Boolean` is a boolean, and `Map`
|
|
91
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
146
|
+
* `Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
147
|
+
* IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
92
148
|
*
|
|
93
149
|
*/
|
|
94
150
|
EnvironmentValue;
|
|
@@ -104,8 +160,8 @@ declare namespace Components {
|
|
|
104
160
|
key: string;
|
|
105
161
|
type: /**
|
|
106
162
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
107
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `
|
|
108
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
163
|
+
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
164
|
+
* may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
109
165
|
*
|
|
110
166
|
*/
|
|
111
167
|
EnvironmentValueType;
|
|
@@ -126,7 +182,35 @@ declare namespace Components {
|
|
|
126
182
|
* install, which syncs a variable's key and type but never its value.
|
|
127
183
|
*
|
|
128
184
|
*/
|
|
129
|
-
string | number | boolean | MapValue
|
|
185
|
+
string | number | boolean | MapValue | /**
|
|
186
|
+
* Arbitrary JSON object, e.g. a flat key/value map used by integrations for
|
|
187
|
+
* enum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
JsonValue | /**
|
|
191
|
+
* One URL with a label and description a customer reads. `label` and
|
|
192
|
+
* `description` are each either a plain string or one string per language;
|
|
193
|
+
* the two fields decide that independently — a plain string means "the
|
|
194
|
+
* same in every language". A translated field must carry the fallback
|
|
195
|
+
* language.
|
|
196
|
+
*
|
|
197
|
+
* The URL must be absolute and `http`/`https` only. This value is served
|
|
198
|
+
* to browser-facing consumers, so `javascript:` and `data:` URLs are
|
|
199
|
+
* rejected at write time.
|
|
200
|
+
*
|
|
201
|
+
* Written flat rather than composed from a shared field set: `allOf` plus
|
|
202
|
+
* `additionalProperties: false` is rejected by most validators, because
|
|
203
|
+
* each branch sees the sibling's properties as unknown. The composition
|
|
204
|
+
* lives in zod (LinkFieldsSchema) — see src/core/value-types.ts.
|
|
205
|
+
*
|
|
206
|
+
* Each translated value of `label` and `description` is also limited to
|
|
207
|
+
* the same maximum as the plain-string form above — 255 characters for
|
|
208
|
+
* `label`, 1024 for `description`. The limit is enforced by the server
|
|
209
|
+
* even though the shared `StringTranslations` schema referenced below
|
|
210
|
+
* does not itself declare it.
|
|
211
|
+
*
|
|
212
|
+
*/
|
|
213
|
+
LinkValue;
|
|
130
214
|
/**
|
|
131
215
|
* Whether the variable is protected from editing
|
|
132
216
|
*/
|
|
@@ -138,12 +222,12 @@ declare namespace Components {
|
|
|
138
222
|
/**
|
|
139
223
|
* Type of variable. Used when creating a new variable. Defaults to String.
|
|
140
224
|
*/
|
|
141
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map";
|
|
225
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
142
226
|
value?: /**
|
|
143
227
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
144
228
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
145
|
-
* `Boolean` is a boolean, and `Map`
|
|
146
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
229
|
+
* `Boolean` is a boolean, and `Map`, `JSON` and `Link` are objects. Numbers are
|
|
230
|
+
* IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
|
|
147
231
|
*
|
|
148
232
|
*/
|
|
149
233
|
EnvironmentValue;
|
|
@@ -154,6 +238,63 @@ declare namespace Components {
|
|
|
154
238
|
*/
|
|
155
239
|
protected?: boolean;
|
|
156
240
|
}
|
|
241
|
+
/**
|
|
242
|
+
* Arbitrary JSON object, e.g. a flat key/value map used by integrations for
|
|
243
|
+
* enum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.
|
|
244
|
+
*
|
|
245
|
+
*/
|
|
246
|
+
export interface JsonValue {
|
|
247
|
+
[name: string]: any;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* One URL with a label and description a customer reads. `label` and
|
|
251
|
+
* `description` are each either a plain string or one string per language;
|
|
252
|
+
* the two fields decide that independently — a plain string means "the
|
|
253
|
+
* same in every language". A translated field must carry the fallback
|
|
254
|
+
* language.
|
|
255
|
+
*
|
|
256
|
+
* The URL must be absolute and `http`/`https` only. This value is served
|
|
257
|
+
* to browser-facing consumers, so `javascript:` and `data:` URLs are
|
|
258
|
+
* rejected at write time.
|
|
259
|
+
*
|
|
260
|
+
* Written flat rather than composed from a shared field set: `allOf` plus
|
|
261
|
+
* `additionalProperties: false` is rejected by most validators, because
|
|
262
|
+
* each branch sees the sibling's properties as unknown. The composition
|
|
263
|
+
* lives in zod (LinkFieldsSchema) — see src/core/value-types.ts.
|
|
264
|
+
*
|
|
265
|
+
* Each translated value of `label` and `description` is also limited to
|
|
266
|
+
* the same maximum as the plain-string form above — 255 characters for
|
|
267
|
+
* `label`, 1024 for `description`. The limit is enforced by the server
|
|
268
|
+
* even though the shared `StringTranslations` schema referenced below
|
|
269
|
+
* does not itself declare it.
|
|
270
|
+
*
|
|
271
|
+
*/
|
|
272
|
+
export interface LinkValue {
|
|
273
|
+
url: string;
|
|
274
|
+
label: string | /**
|
|
275
|
+
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
276
|
+
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
277
|
+
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
278
|
+
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
279
|
+
* not otherwise linked. The pattern is documented rather than declared
|
|
280
|
+
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
281
|
+
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
282
|
+
*
|
|
283
|
+
*/
|
|
284
|
+
StringTranslations;
|
|
285
|
+
description?: string | /**
|
|
286
|
+
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
287
|
+
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
288
|
+
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
289
|
+
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
290
|
+
* not otherwise linked. The pattern is documented rather than declared
|
|
291
|
+
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
292
|
+
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
293
|
+
*
|
|
294
|
+
*/
|
|
295
|
+
StringTranslations;
|
|
296
|
+
fallbackLanguage?: string;
|
|
297
|
+
}
|
|
157
298
|
/**
|
|
158
299
|
* One entry of a Map. `key` is the token a journey submits; `value` is
|
|
159
300
|
* what the customer reads — either one string, or one string per
|
|
@@ -165,8 +306,11 @@ declare namespace Components {
|
|
|
165
306
|
value: string | /**
|
|
166
307
|
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
167
308
|
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
168
|
-
* everywhere else
|
|
169
|
-
* src/core/value-types.ts — the two are
|
|
309
|
+
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
310
|
+
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
311
|
+
* not otherwise linked. The pattern is documented rather than declared
|
|
312
|
+
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
313
|
+
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
170
314
|
*
|
|
171
315
|
*/
|
|
172
316
|
StringTranslations;
|
|
@@ -193,8 +337,11 @@ declare namespace Components {
|
|
|
193
337
|
/**
|
|
194
338
|
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
195
339
|
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
196
|
-
* everywhere else
|
|
197
|
-
* src/core/value-types.ts — the two are
|
|
340
|
+
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
341
|
+
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
342
|
+
* not otherwise linked. The pattern is documented rather than declared
|
|
343
|
+
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
344
|
+
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
198
345
|
*
|
|
199
346
|
*/
|
|
200
347
|
export interface StringTranslations {
|
|
@@ -518,8 +665,10 @@ type EnvironmentVariableCreateRequest = Components.Schemas.EnvironmentVariableCr
|
|
|
518
665
|
type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
|
|
519
666
|
type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
|
|
520
667
|
type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
|
|
668
|
+
type JsonValue = Components.Schemas.JsonValue;
|
|
669
|
+
type LinkValue = Components.Schemas.LinkValue;
|
|
521
670
|
type MapEntry = Components.Schemas.MapEntry;
|
|
522
671
|
type MapValue = Components.Schemas.MapValue;
|
|
523
672
|
type StringTranslations = Components.Schemas.StringTranslations;
|
|
524
673
|
|
|
525
|
-
export { type Client as C, type EnvironmentGroup as E, type MapEntry as M, type OperationMethods as O, Paths as P, type StringTranslations as S, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type EnvironmentValue as e, type EnvironmentValueType as f, type EnvironmentVariable as g, type EnvironmentVariableCreateRequest as h, type EnvironmentVariableList as i, type EnvironmentVariableListItem as j, type EnvironmentVariableUpdateRequest as k, type MapValue as l };
|
|
674
|
+
export { type Client as C, type EnvironmentGroup as E, type JsonValue as J, type LinkValue as L, type MapEntry as M, type OperationMethods as O, Paths as P, type StringTranslations as S, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type EnvironmentValue as e, type EnvironmentValueType as f, type EnvironmentVariable as g, type EnvironmentVariableCreateRequest as h, type EnvironmentVariableList as i, type EnvironmentVariableListItem as j, type EnvironmentVariableUpdateRequest as k, type MapValue as l };
|
package/dist/index.cjs
CHANGED
|
@@ -158,7 +158,7 @@ var _chunkWOUASZJWcjs = require('./chunk-WOUASZJW.cjs');
|
|
|
158
158
|
|
|
159
159
|
|
|
160
160
|
|
|
161
|
-
var
|
|
161
|
+
var _chunk22IGZ7VQcjs = require('./chunk-22IGZ7VQ.cjs');
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
|
|
|
225
225
|
}
|
|
226
226
|
if (!entry.instance) {
|
|
227
227
|
const definition = entry.loader();
|
|
228
|
-
entry.instance =
|
|
228
|
+
entry.instance = _chunk22IGZ7VQcjs.createApiClient.call(void 0, {
|
|
229
229
|
definition,
|
|
230
230
|
token: state.token,
|
|
231
231
|
headers: state.globalHeaders,
|
|
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
|
|
|
258
258
|
};
|
|
259
259
|
|
|
260
260
|
// src/apis/_registry.ts
|
|
261
|
-
var expandDef = (mod) =>
|
|
261
|
+
var expandDef = (mod) => _chunk22IGZ7VQcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
262
262
|
var registerBuiltinApis = (registry) => {
|
|
263
263
|
registerApi({
|
|
264
264
|
registry,
|
|
@@ -601,9 +601,9 @@ var createSDK = () => {
|
|
|
601
601
|
const available = [...registry.keys()].join(", ");
|
|
602
602
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
603
603
|
}
|
|
604
|
-
return
|
|
604
|
+
return _chunk22IGZ7VQcjs.createApiHandle.call(void 0, {
|
|
605
605
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
606
|
-
createClient: () =>
|
|
606
|
+
createClient: () => _chunk22IGZ7VQcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
607
607
|
apiName: name
|
|
608
608
|
});
|
|
609
609
|
};
|
|
@@ -651,9 +651,9 @@ var createSDK = () => {
|
|
|
651
651
|
return interceptorUse;
|
|
652
652
|
}
|
|
653
653
|
case "help":
|
|
654
|
-
return (apiName) =>
|
|
654
|
+
return (apiName) => _chunk22IGZ7VQcjs.help.call(void 0, apiName);
|
|
655
655
|
case "openapi":
|
|
656
|
-
return (apiName) =>
|
|
656
|
+
return (apiName) => _chunk22IGZ7VQcjs.openapi.call(void 0, apiName);
|
|
657
657
|
case "then":
|
|
658
658
|
case "catch":
|
|
659
659
|
case "finally":
|
|
@@ -683,4 +683,4 @@ var epilot = createSDK();
|
|
|
683
683
|
|
|
684
684
|
|
|
685
685
|
|
|
686
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
686
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunk22IGZ7VQcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunk22IGZ7VQcjs.help; exports.openapi = _chunk22IGZ7VQcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -25,7 +25,7 @@ import { C as Client$i } from './email-settings.d-DViLYaOl.cjs';
|
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.cjs';
|
|
26
26
|
import { C as Client$k } from './entity.d-GfKqzFGA.cjs';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-CQv75o8M.cjs';
|
|
28
|
-
import { C as Client$m } from './environments.d-
|
|
28
|
+
import { C as Client$m } from './environments.d-C_BTxz4W.cjs';
|
|
29
29
|
import { C as Client$n } from './event-catalog.d-Bd2wmtlZ.cjs';
|
|
30
30
|
import { C as Client$o } from './file.d-CBsXF4W8.cjs';
|
|
31
31
|
import { C as Client$p } from './iban.d-BwdiGbxi.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ import { C as Client$i } from './email-settings.d-DViLYaOl.js';
|
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.js';
|
|
26
26
|
import { C as Client$k } from './entity.d-GfKqzFGA.js';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-CQv75o8M.js';
|
|
28
|
-
import { C as Client$m } from './environments.d-
|
|
28
|
+
import { C as Client$m } from './environments.d-C_BTxz4W.js';
|
|
29
29
|
import { C as Client$n } from './event-catalog.d-Bd2wmtlZ.js';
|
|
30
30
|
import { C as Client$o } from './file.d-CBsXF4W8.js';
|
|
31
31
|
import { C as Client$p } from './iban.d-BwdiGbxi.js';
|
package/dist/index.js
CHANGED
package/docs/environments.md
CHANGED
|
@@ -39,6 +39,8 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
39
39
|
- [`StringTranslations`](#stringtranslations)
|
|
40
40
|
- [`MapEntry`](#mapentry)
|
|
41
41
|
- [`MapValue`](#mapvalue)
|
|
42
|
+
- [`JsonValue`](#jsonvalue)
|
|
43
|
+
- [`LinkValue`](#linkvalue)
|
|
42
44
|
- [`EnvironmentValue`](#environmentvalue)
|
|
43
45
|
- [`EnvironmentVariable`](#environmentvariable)
|
|
44
46
|
- [`EnvironmentVariableListItem`](#environmentvariablelistitem)
|
|
@@ -292,21 +294,21 @@ const { data } = await client.deleteEnvironmentVariable({
|
|
|
292
294
|
### `EnvironmentValueType`
|
|
293
295
|
|
|
294
296
|
The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
295
|
-
its value is never returned. `Text`, `Number`, `Boolean` and `
|
|
296
|
-
served to browser-facing consumers; `String` and `SecretString` may not.
|
|
297
|
+
its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
298
|
+
may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
297
299
|
|
|
298
300
|
|
|
299
301
|
```ts
|
|
300
|
-
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
302
|
+
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
301
303
|
```
|
|
302
304
|
|
|
303
305
|
### `StringTranslations`
|
|
304
306
|
|
|
305
307
|
A string translated per language. Keys are language codes (e.g. `de`,
|
|
306
308
|
`en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
307
|
-
everywhere else
|
|
308
|
-
src/core/value-types.ts — the two are
|
|
309
|
-
|
|
309
|
+
everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
310
|
+
that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
311
|
+
not otherwise lin
|
|
310
312
|
|
|
311
313
|
```ts
|
|
312
314
|
type StringTranslations = Record<string, string>
|
|
@@ -338,12 +340,41 @@ type MapValue = {
|
|
|
338
340
|
}
|
|
339
341
|
```
|
|
340
342
|
|
|
343
|
+
### `JsonValue`
|
|
344
|
+
|
|
345
|
+
Arbitrary JSON object, e.g. a flat key/value map used by integrations for
|
|
346
|
+
enum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
```ts
|
|
350
|
+
type JsonValue = Record<string, unknown>
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### `LinkValue`
|
|
354
|
+
|
|
355
|
+
One URL with a label and description a customer reads. `label` and
|
|
356
|
+
`description` are each either a plain string or one string per language;
|
|
357
|
+
the two fields decide that independently — a plain string means "the
|
|
358
|
+
same in every language". A translated field must carry the fallback
|
|
359
|
+
language.
|
|
360
|
+
|
|
361
|
+
The URL must
|
|
362
|
+
|
|
363
|
+
```ts
|
|
364
|
+
type LinkValue = {
|
|
365
|
+
url: string
|
|
366
|
+
label: string | Record<string, string>
|
|
367
|
+
description?: string | Record<string, string>
|
|
368
|
+
fallbackLanguage?: string
|
|
369
|
+
}
|
|
370
|
+
```
|
|
371
|
+
|
|
341
372
|
### `EnvironmentValue`
|
|
342
373
|
|
|
343
374
|
A variable's value. The JSON type corresponds to the variable's `type`:
|
|
344
375
|
`String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
345
|
-
`Boolean` is a boolean, and `Map`
|
|
346
|
-
doubles; integers above 2^53 may lose precision on round-trip.
|
|
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.
|
|
347
378
|
|
|
348
379
|
|
|
349
380
|
```ts
|
|
@@ -353,6 +384,11 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
353
384
|
key: string
|
|
354
385
|
value: string | Record<string, string>
|
|
355
386
|
}>
|
|
387
|
+
} | Record<string, unknown> | {
|
|
388
|
+
url: string
|
|
389
|
+
label: string | Record<string, string>
|
|
390
|
+
description?: string | Record<string, string>
|
|
391
|
+
fallbackLanguage?: string
|
|
356
392
|
}
|
|
357
393
|
```
|
|
358
394
|
|
|
@@ -361,7 +397,7 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
361
397
|
```ts
|
|
362
398
|
type EnvironmentVariable = {
|
|
363
399
|
key: string
|
|
364
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
400
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
365
401
|
description?: string
|
|
366
402
|
group?: string
|
|
367
403
|
value?: string | number | boolean | {
|
|
@@ -370,6 +406,11 @@ type EnvironmentVariable = {
|
|
|
370
406
|
key: { ... }
|
|
371
407
|
value: { ... }
|
|
372
408
|
}>
|
|
409
|
+
} | Record<string, unknown> | {
|
|
410
|
+
url: string
|
|
411
|
+
label: string | Record<string, string>
|
|
412
|
+
description?: string | Record<string, string>
|
|
413
|
+
fallbackLanguage?: string
|
|
373
414
|
}
|
|
374
415
|
protected?: boolean
|
|
375
416
|
created_at: string // date-time
|
|
@@ -382,7 +423,7 @@ type EnvironmentVariable = {
|
|
|
382
423
|
```ts
|
|
383
424
|
type EnvironmentVariableListItem = {
|
|
384
425
|
key: string
|
|
385
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
426
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
386
427
|
description?: string
|
|
387
428
|
group?: string
|
|
388
429
|
value?: string | number | boolean | {
|
|
@@ -391,6 +432,11 @@ type EnvironmentVariableListItem = {
|
|
|
391
432
|
key: { ... }
|
|
392
433
|
value: { ... }
|
|
393
434
|
}>
|
|
435
|
+
} | Record<string, unknown> | {
|
|
436
|
+
url: string
|
|
437
|
+
label: string | Record<string, string>
|
|
438
|
+
description?: string | Record<string, string>
|
|
439
|
+
fallbackLanguage?: string
|
|
394
440
|
}
|
|
395
441
|
protected?: boolean
|
|
396
442
|
created_at: string // date-time
|
|
@@ -404,12 +450,17 @@ type EnvironmentVariableListItem = {
|
|
|
404
450
|
type EnvironmentVariableList = {
|
|
405
451
|
items: Array<{
|
|
406
452
|
key: string
|
|
407
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
453
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
408
454
|
description?: string
|
|
409
455
|
group?: string
|
|
410
456
|
value?: string | number | boolean | {
|
|
411
457
|
fallbackLanguage?: { ... }
|
|
412
458
|
options: { ... }
|
|
459
|
+
} | Record<string, unknown> | {
|
|
460
|
+
url: { ... }
|
|
461
|
+
label: { ... }
|
|
462
|
+
description?: { ... }
|
|
463
|
+
fallbackLanguage?: { ... }
|
|
413
464
|
}
|
|
414
465
|
protected?: boolean
|
|
415
466
|
created_at: string // date-time
|
|
@@ -423,7 +474,7 @@ type EnvironmentVariableList = {
|
|
|
423
474
|
```ts
|
|
424
475
|
type EnvironmentVariableCreateRequest = {
|
|
425
476
|
key: string
|
|
426
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
477
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
427
478
|
description?: string
|
|
428
479
|
group?: string
|
|
429
480
|
value?: string | number | boolean | {
|
|
@@ -432,6 +483,11 @@ type EnvironmentVariableCreateRequest = {
|
|
|
432
483
|
key: { ... }
|
|
433
484
|
value: { ... }
|
|
434
485
|
}>
|
|
486
|
+
} | Record<string, unknown> | {
|
|
487
|
+
url: string
|
|
488
|
+
label: string | Record<string, string>
|
|
489
|
+
description?: string | Record<string, string>
|
|
490
|
+
fallbackLanguage?: string
|
|
435
491
|
}
|
|
436
492
|
protected?: boolean
|
|
437
493
|
}
|
|
@@ -441,13 +497,18 @@ type EnvironmentVariableCreateRequest = {
|
|
|
441
497
|
|
|
442
498
|
```ts
|
|
443
499
|
type EnvironmentVariableUpdateRequest = {
|
|
444
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"
|
|
500
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
445
501
|
value?: string | number | boolean | {
|
|
446
502
|
fallbackLanguage?: string
|
|
447
503
|
options: Array<{
|
|
448
504
|
key: { ... }
|
|
449
505
|
value: { ... }
|
|
450
506
|
}>
|
|
507
|
+
} | Record<string, unknown> | {
|
|
508
|
+
url: string
|
|
509
|
+
label: string | Record<string, string>
|
|
510
|
+
description?: string | Record<string, string>
|
|
511
|
+
fallbackLanguage?: string
|
|
451
512
|
}
|
|
452
513
|
description?: string
|
|
453
514
|
group?: string
|
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- [`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` and `Map` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\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. Must match LANGUAGE_KEY_PATTERN in\nsrc/core/value-types.ts \u2014 the two are not otherwise linked.\n\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### `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` is an object. Numbers are IEEE 754\ndoubles; 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}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\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"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
environments_default as default
|
|
7
|
-
};
|
|
@@ -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- [`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` and `Map` may be\nserved to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\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. Must match LANGUAGE_KEY_PATTERN in\nsrc/core/value-types.ts \u2014 the two are not otherwise linked.\n\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### `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` is an object. Numbers are IEEE 754\ndoubles; 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}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n items: Array<{\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\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"\n description?: string\n group?: string\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map"\n value?: string | number | boolean | {\n fallbackLanguage?: string\n options: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n description?: string\n group?: string\n protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n items: Array<{\n name: string\n description?: string\n created_at: string // date-time\n updated_at: string // date-time\n }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n description?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = environments_default;
|