@epilot/sdk 2.19.5 → 2.19.6-alpha.0

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.
Files changed (123) hide show
  1. package/definitions/environments.json +135 -17
  2. package/dist/apis/access-token.cjs +6 -6
  3. package/dist/apis/access-token.js +1 -1
  4. package/dist/apis/address-suggestions.cjs +6 -6
  5. package/dist/apis/address-suggestions.js +1 -1
  6. package/dist/apis/address.cjs +6 -6
  7. package/dist/apis/address.js +1 -1
  8. package/dist/apis/ai-agents.cjs +6 -6
  9. package/dist/apis/ai-agents.js +1 -1
  10. package/dist/apis/app.cjs +6 -6
  11. package/dist/apis/app.js +1 -1
  12. package/dist/apis/audit-logs.cjs +6 -6
  13. package/dist/apis/audit-logs.js +1 -1
  14. package/dist/apis/automation.cjs +6 -6
  15. package/dist/apis/automation.js +1 -1
  16. package/dist/apis/billing.cjs +6 -6
  17. package/dist/apis/billing.js +1 -1
  18. package/dist/apis/blueprint-manifest.cjs +6 -6
  19. package/dist/apis/blueprint-manifest.js +1 -1
  20. package/dist/apis/calendar.cjs +6 -6
  21. package/dist/apis/calendar.js +1 -1
  22. package/dist/apis/configuration-hub.cjs +6 -6
  23. package/dist/apis/configuration-hub.js +1 -1
  24. package/dist/apis/consent.cjs +6 -6
  25. package/dist/apis/consent.js +1 -1
  26. package/dist/apis/customer-portal.cjs +6 -6
  27. package/dist/apis/customer-portal.js +1 -1
  28. package/dist/apis/dashboard.cjs +6 -6
  29. package/dist/apis/dashboard.js +1 -1
  30. package/dist/apis/data-governance.cjs +6 -6
  31. package/dist/apis/data-governance.js +1 -1
  32. package/dist/apis/deduplication.cjs +6 -6
  33. package/dist/apis/deduplication.js +1 -1
  34. package/dist/apis/design.cjs +6 -6
  35. package/dist/apis/design.js +1 -1
  36. package/dist/apis/document.cjs +6 -6
  37. package/dist/apis/document.js +1 -1
  38. package/dist/apis/email-settings.cjs +6 -6
  39. package/dist/apis/email-settings.js +1 -1
  40. package/dist/apis/email-template.cjs +6 -6
  41. package/dist/apis/email-template.js +1 -1
  42. package/dist/apis/entity-mapping.cjs +6 -6
  43. package/dist/apis/entity-mapping.js +1 -1
  44. package/dist/apis/entity.cjs +6 -6
  45. package/dist/apis/entity.js +1 -1
  46. package/dist/apis/environments.cjs +6 -6
  47. package/dist/apis/environments.d.cts +2 -2
  48. package/dist/apis/environments.d.ts +2 -2
  49. package/dist/apis/environments.js +1 -1
  50. package/dist/apis/event-catalog.cjs +6 -6
  51. package/dist/apis/event-catalog.js +1 -1
  52. package/dist/apis/file.cjs +6 -6
  53. package/dist/apis/file.js +1 -1
  54. package/dist/apis/iban.cjs +6 -6
  55. package/dist/apis/iban.js +1 -1
  56. package/dist/apis/integration-toolkit.cjs +6 -6
  57. package/dist/apis/integration-toolkit.js +1 -1
  58. package/dist/apis/journey.cjs +6 -6
  59. package/dist/apis/journey.js +1 -1
  60. package/dist/apis/kanban.cjs +6 -6
  61. package/dist/apis/kanban.js +1 -1
  62. package/dist/apis/message.cjs +6 -6
  63. package/dist/apis/message.js +1 -1
  64. package/dist/apis/metering.cjs +6 -6
  65. package/dist/apis/metering.js +1 -1
  66. package/dist/apis/notes.cjs +6 -6
  67. package/dist/apis/notes.js +1 -1
  68. package/dist/apis/notification.cjs +6 -6
  69. package/dist/apis/notification.js +1 -1
  70. package/dist/apis/organization.cjs +6 -6
  71. package/dist/apis/organization.js +1 -1
  72. package/dist/apis/partner-directory.cjs +6 -6
  73. package/dist/apis/partner-directory.js +1 -1
  74. package/dist/apis/permissions.cjs +6 -6
  75. package/dist/apis/permissions.js +1 -1
  76. package/dist/apis/pricing-tier.cjs +6 -6
  77. package/dist/apis/pricing-tier.js +1 -1
  78. package/dist/apis/pricing.cjs +6 -6
  79. package/dist/apis/pricing.js +1 -1
  80. package/dist/apis/purpose.cjs +6 -6
  81. package/dist/apis/purpose.js +1 -1
  82. package/dist/apis/query.cjs +6 -6
  83. package/dist/apis/query.js +1 -1
  84. package/dist/apis/sandbox.cjs +6 -6
  85. package/dist/apis/sandbox.js +1 -1
  86. package/dist/apis/sharing.cjs +6 -6
  87. package/dist/apis/sharing.js +1 -1
  88. package/dist/apis/snapshot.cjs +6 -6
  89. package/dist/apis/snapshot.js +1 -1
  90. package/dist/apis/submission.cjs +6 -6
  91. package/dist/apis/submission.js +1 -1
  92. package/dist/apis/target.cjs +6 -6
  93. package/dist/apis/target.js +1 -1
  94. package/dist/apis/targeting.cjs +6 -6
  95. package/dist/apis/targeting.js +1 -1
  96. package/dist/apis/template-variables.cjs +6 -6
  97. package/dist/apis/template-variables.js +1 -1
  98. package/dist/apis/user.cjs +6 -6
  99. package/dist/apis/user.js +1 -1
  100. package/dist/apis/validation-rules.cjs +6 -6
  101. package/dist/apis/validation-rules.js +1 -1
  102. package/dist/apis/webhooks.cjs +6 -6
  103. package/dist/apis/webhooks.js +1 -1
  104. package/dist/apis/workflow-definition.cjs +6 -6
  105. package/dist/apis/workflow-definition.js +1 -1
  106. package/dist/apis/workflow.cjs +6 -6
  107. package/dist/apis/workflow.js +1 -1
  108. package/dist/bin/cli.js +1 -1
  109. package/dist/{chunk-VB6VABGZ.cjs → chunk-F4OENWBE.cjs} +1 -1
  110. package/dist/{chunk-HWPPR3IM.js → chunk-JCBXIJ45.js} +1 -1
  111. package/dist/environments-JP2CPDH2.cjs +7 -0
  112. package/dist/environments-PGRMZY5G.js +7 -0
  113. package/dist/{environments.d-BvqvN-PD.d.cts → environments.d-840_mC07.d.cts} +144 -32
  114. package/dist/{environments.d-BvqvN-PD.d.ts → environments.d-840_mC07.d.ts} +144 -32
  115. package/dist/index.cjs +8 -8
  116. package/dist/index.d.cts +1 -1
  117. package/dist/index.d.ts +1 -1
  118. package/dist/index.js +1 -1
  119. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  120. package/docs/environments.md +128 -20
  121. package/package.json +12 -11
  122. package/dist/environments-PXJOTQVM.js +0 -7
  123. package/dist/environments-QJ4UMJ5C.cjs +0 -7
@@ -36,6 +36,9 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
36
36
 
37
37
  **Schemas**
38
38
  - [`EnvironmentValueType`](#environmentvaluetype)
39
+ - [`EnvironmentOption`](#environmentoption)
40
+ - [`OptionsValue`](#optionsvalue)
41
+ - [`EnvironmentValue`](#environmentvalue)
39
42
  - [`EnvironmentVariable`](#environmentvariable)
40
43
  - [`EnvironmentVariableListItem`](#environmentvariablelistitem)
41
44
  - [`EnvironmentVariableList`](#environmentvariablelist)
@@ -47,7 +50,7 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
47
50
 
48
51
  ### `listEnvironmentVariables`
49
52
 
50
- List environment variables
53
+ List all environment variables for the organization. Returns metadata only, no secret values.
51
54
 
52
55
  `GET /v1/environments`
53
56
 
@@ -67,6 +70,7 @@ const { data } = await client.listEnvironmentVariables()
67
70
  "description": "string",
68
71
  "group": "string",
69
72
  "value": "string",
73
+ "protected": true,
70
74
  "created_at": "1970-01-01T00:00:00.000Z",
71
75
  "updated_at": "1970-01-01T00:00:00.000Z"
72
76
  }
@@ -80,7 +84,7 @@ const { data } = await client.listEnvironmentVariables()
80
84
 
81
85
  ### `createEnvironmentVariable`
82
86
 
83
- Create environment variable
87
+ Create a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.
84
88
 
85
89
  `POST /v1/environments`
86
90
 
@@ -92,7 +96,8 @@ const { data } = await client.createEnvironmentVariable(
92
96
  type: 'String',
93
97
  description: 'string',
94
98
  group: 'string',
95
- value: 'string'
99
+ value: 'string',
100
+ protected: true
96
101
  },
97
102
  )
98
103
  ```
@@ -107,6 +112,7 @@ const { data } = await client.createEnvironmentVariable(
107
112
  "description": "string",
108
113
  "group": "string",
109
114
  "value": "string",
115
+ "protected": true,
110
116
  "created_at": "1970-01-01T00:00:00.000Z",
111
117
  "updated_at": "1970-01-01T00:00:00.000Z"
112
118
  }
@@ -118,7 +124,7 @@ const { data } = await client.createEnvironmentVariable(
118
124
 
119
125
  ### `listEnvironmentGroups`
120
126
 
121
- List environment groups
127
+ List all environment groups for the organization.
122
128
 
123
129
  `GET /v1/environments/groups`
124
130
 
@@ -148,6 +154,8 @@ const { data } = await client.listEnvironmentGroups()
148
154
 
149
155
  ### `putEnvironmentGroup`
150
156
 
157
+ Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
158
+
151
159
  `PUT /v1/environments/groups/{name}`
152
160
 
153
161
  ```ts
@@ -179,7 +187,7 @@ const { data } = await client.putEnvironmentGroup(
179
187
 
180
188
  ### `deleteEnvironmentGroup`
181
189
 
182
- Delete an environment group
190
+ Deletes a group. Variables assigned to this group become ungrouped.
183
191
 
184
192
  `DELETE /v1/environments/groups/{name}`
185
193
 
@@ -193,7 +201,7 @@ const { data } = await client.deleteEnvironmentGroup({
193
201
 
194
202
  ### `getEnvironmentVariable`
195
203
 
196
- Get environment variable
204
+ Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.
197
205
 
198
206
  `GET /v1/environments/{key}`
199
207
 
@@ -213,6 +221,7 @@ const { data } = await client.getEnvironmentVariable({
213
221
  "description": "string",
214
222
  "group": "string",
215
223
  "value": "string",
224
+ "protected": true,
216
225
  "created_at": "1970-01-01T00:00:00.000Z",
217
226
  "updated_at": "1970-01-01T00:00:00.000Z"
218
227
  }
@@ -224,7 +233,7 @@ const { data } = await client.getEnvironmentVariable({
224
233
 
225
234
  ### `updateEnvironmentVariable`
226
235
 
227
- Update environment variable
236
+ Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.
228
237
 
229
238
  `PUT /v1/environments/{key}`
230
239
 
@@ -237,7 +246,8 @@ const { data } = await client.updateEnvironmentVariable(
237
246
  type: 'String',
238
247
  value: 'string',
239
248
  description: 'string',
240
- group: 'string'
249
+ group: 'string',
250
+ protected: true
241
251
  },
242
252
  )
243
253
  ```
@@ -252,6 +262,7 @@ const { data } = await client.updateEnvironmentVariable(
252
262
  "description": "string",
253
263
  "group": "string",
254
264
  "value": "string",
265
+ "protected": true,
255
266
  "created_at": "1970-01-01T00:00:00.000Z",
256
267
  "updated_at": "1970-01-01T00:00:00.000Z"
257
268
  }
@@ -263,7 +274,7 @@ const { data } = await client.updateEnvironmentVariable(
263
274
 
264
275
  ### `deleteEnvironmentVariable`
265
276
 
266
- Delete environment variable
277
+ Delete an environment variable by key.
267
278
 
268
279
  `DELETE /v1/environments/{key}`
269
280
 
@@ -279,8 +290,61 @@ const { data } = await client.deleteEnvironmentVariable({
279
290
 
280
291
  ### `EnvironmentValueType`
281
292
 
293
+ The structure a variable's value holds. `SecretString` is encrypted at rest and
294
+ its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
295
+ served to browser-facing consumers; `String` and `SecretString` may not.
296
+
297
+
282
298
  ```ts
283
- type EnvironmentValueType = "String" | "SecretString"
299
+ type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
300
+ ```
301
+
302
+ ### `EnvironmentOption`
303
+
304
+ ```ts
305
+ type EnvironmentOption = {
306
+ value: string
307
+ label: string
308
+ } | {
309
+ value: string
310
+ labels: Record<string, string>
311
+ }
312
+ ```
313
+
314
+ ### `OptionsValue`
315
+
316
+ ```ts
317
+ type OptionsValue = {
318
+ fallbackLanguage?: string
319
+ options: Array<{
320
+ value: string
321
+ label: string
322
+ } | {
323
+ value: string
324
+ labels: Record<string, string>
325
+ }>
326
+ }
327
+ ```
328
+
329
+ ### `EnvironmentValue`
330
+
331
+ A variable's value. The JSON type corresponds to the variable's `type`:
332
+ `String`, `SecretString` and `Text` are strings, `Number` is a number,
333
+ `Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
334
+ doubles; integers above 2^53 may lose precision on round-trip.
335
+
336
+
337
+ ```ts
338
+ type EnvironmentValue = string | number | boolean | {
339
+ fallbackLanguage?: string
340
+ options: Array<{
341
+ value: string
342
+ label: string
343
+ } | {
344
+ value: string
345
+ labels: Record<string, string>
346
+ }>
347
+ }
284
348
  ```
285
349
 
286
350
  ### `EnvironmentVariable`
@@ -288,10 +352,20 @@ type EnvironmentValueType = "String" | "SecretString"
288
352
  ```ts
289
353
  type EnvironmentVariable = {
290
354
  key: string
291
- type: "String" | "SecretString"
355
+ type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
292
356
  description?: string
293
357
  group?: string
294
- value?: string
358
+ value?: string | number | boolean | {
359
+ fallbackLanguage?: string
360
+ options: Array<{
361
+ value: { ... }
362
+ label: { ... }
363
+ } | {
364
+ value: { ... }
365
+ labels: { ... }
366
+ }>
367
+ }
368
+ protected?: boolean
295
369
  created_at: string // date-time
296
370
  updated_at: string // date-time
297
371
  }
@@ -302,10 +376,20 @@ type EnvironmentVariable = {
302
376
  ```ts
303
377
  type EnvironmentVariableListItem = {
304
378
  key: string
305
- type: "String" | "SecretString"
379
+ type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
306
380
  description?: string
307
381
  group?: string
308
- value?: string
382
+ value?: string | number | boolean | {
383
+ fallbackLanguage?: string
384
+ options: Array<{
385
+ value: { ... }
386
+ label: { ... }
387
+ } | {
388
+ value: { ... }
389
+ labels: { ... }
390
+ }>
391
+ }
392
+ protected?: boolean
309
393
  created_at: string // date-time
310
394
  updated_at: string // date-time
311
395
  }
@@ -317,10 +401,14 @@ type EnvironmentVariableListItem = {
317
401
  type EnvironmentVariableList = {
318
402
  items: Array<{
319
403
  key: string
320
- type: "String" | "SecretString"
404
+ type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
321
405
  description?: string
322
406
  group?: string
323
- value?: string
407
+ value?: string | number | boolean | {
408
+ fallbackLanguage?: { ... }
409
+ options: { ... }
410
+ }
411
+ protected?: boolean
324
412
  created_at: string // date-time
325
413
  updated_at: string // date-time
326
414
  }>
@@ -332,10 +420,20 @@ type EnvironmentVariableList = {
332
420
  ```ts
333
421
  type EnvironmentVariableCreateRequest = {
334
422
  key: string
335
- type: "String" | "SecretString"
423
+ type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
336
424
  description?: string
337
425
  group?: string
338
- value?: string
426
+ value?: string | number | boolean | {
427
+ fallbackLanguage?: string
428
+ options: Array<{
429
+ value: { ... }
430
+ label: { ... }
431
+ } | {
432
+ value: { ... }
433
+ labels: { ... }
434
+ }>
435
+ }
436
+ protected?: boolean
339
437
  }
340
438
  ```
341
439
 
@@ -343,10 +441,20 @@ type EnvironmentVariableCreateRequest = {
343
441
 
344
442
  ```ts
345
443
  type EnvironmentVariableUpdateRequest = {
346
- type?: "String" | "SecretString"
347
- value?: string
444
+ type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
445
+ value?: string | number | boolean | {
446
+ fallbackLanguage?: string
447
+ options: Array<{
448
+ value: { ... }
449
+ label: { ... }
450
+ } | {
451
+ value: { ... }
452
+ labels: { ... }
453
+ }>
454
+ }
348
455
  description?: string
349
456
  group?: string
457
+ protected?: boolean
350
458
  }
351
459
  ```
352
460
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/sdk",
3
- "version": "2.19.5",
3
+ "version": "2.19.6-alpha.0",
4
4
  "description": "JavaScript/TypeScript SDK for epilot APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -322,6 +322,16 @@
322
322
  },
323
323
  "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
324
324
  },
325
+ "scripts": {
326
+ "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
327
+ "build": "tsup",
328
+ "build:watch": "tsup --watch",
329
+ "test": "vitest run",
330
+ "test:watch": "vitest",
331
+ "lint": "biome check src",
332
+ "lint:fix": "biome check src --fix",
333
+ "prepublishOnly": "npm run build"
334
+ },
325
335
  "keywords": [
326
336
  "epilot",
327
337
  "sdk",
@@ -515,14 +525,5 @@
515
525
  "./dist/apis/workflow-definition.d.ts"
516
526
  ]
517
527
  }
518
- },
519
- "scripts": {
520
- "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
521
- "build": "tsup",
522
- "build:watch": "tsup --watch",
523
- "test": "vitest run",
524
- "test:watch": "vitest",
525
- "lint": "biome check src",
526
- "lint:fix": "biome check src --fix"
527
528
  }
528
- }
529
+ }
@@ -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- [`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 environment variables\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 "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 environment variable\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 },\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 "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 environment groups\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\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\nDelete an environment group\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 environment variable\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 "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\nUpdate environment variable\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 },\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 "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 environment variable\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\n```ts\ntype EnvironmentValueType = "String" | "SecretString"\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString"\n value?: string\n description?: string\n group?: string\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- [`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 environment variables\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 "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 environment variable\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 },\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 "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 environment groups\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\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\nDelete an environment group\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 environment variable\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 "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\nUpdate environment variable\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 },\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 "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 environment variable\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\n```ts\ntype EnvironmentValueType = "String" | "SecretString"\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\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"\n description?: string\n group?: string\n value?: string\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString"\n value?: string\n description?: string\n group?: string\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;