@epilot/sdk 2.19.4 → 2.19.6-alpha.0

package/docs/environments.md

@@ -36,6 +36,9 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
 
 **Schemas**
 - [`EnvironmentValueType`](#environmentvaluetype)
+- [`EnvironmentOption`](#environmentoption)
+- [`OptionsValue`](#optionsvalue)
+- [`EnvironmentValue`](#environmentvalue)
 - [`EnvironmentVariable`](#environmentvariable)
 - [`EnvironmentVariableListItem`](#environmentvariablelistitem)
 - [`EnvironmentVariableList`](#environmentvariablelist)
@@ -47,7 +50,7 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
 
 ### `listEnvironmentVariables`
 
-List environment variables
+List all environment variables for the organization. Returns metadata only, no secret values.
 
 `GET /v1/environments`
 
@@ -67,6 +70,7 @@ const { data } = await client.listEnvironmentVariables()
       "description": "string",
       "group": "string",
       "value": "string",
+      "protected": true,
       "created_at": "1970-01-01T00:00:00.000Z",
       "updated_at": "1970-01-01T00:00:00.000Z"
     }
@@ -80,7 +84,7 @@ const { data } = await client.listEnvironmentVariables()
 
 ### `createEnvironmentVariable`
 
-Create environment variable
+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.
 
 `POST /v1/environments`
 
@@ -92,7 +96,8 @@ const { data } = await client.createEnvironmentVariable(
     type: 'String',
     description: 'string',
     group: 'string',
-    value: 'string'
+    value: 'string',
+    protected: true
   },
 )
 ```
@@ -107,6 +112,7 @@ const { data } = await client.createEnvironmentVariable(
   "description": "string",
   "group": "string",
   "value": "string",
+  "protected": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z"
 }
@@ -118,7 +124,7 @@ const { data } = await client.createEnvironmentVariable(
 
 ### `listEnvironmentGroups`
 
-List environment groups
+List all environment groups for the organization.
 
 `GET /v1/environments/groups`
 
@@ -148,6 +154,8 @@ const { data } = await client.listEnvironmentGroups()
 
 ### `putEnvironmentGroup`
 
+Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
+
 `PUT /v1/environments/groups/{name}`
 
 ```ts
@@ -179,7 +187,7 @@ const { data } = await client.putEnvironmentGroup(
 
 ### `deleteEnvironmentGroup`
 
-Delete an environment group
+Deletes a group. Variables assigned to this group become ungrouped.
 
 `DELETE /v1/environments/groups/{name}`
 
@@ -193,7 +201,7 @@ const { data } = await client.deleteEnvironmentGroup({
 
 ### `getEnvironmentVariable`
 
-Get environment variable
+Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.
 
 `GET /v1/environments/{key}`
 
@@ -213,6 +221,7 @@ const { data } = await client.getEnvironmentVariable({
   "description": "string",
   "group": "string",
   "value": "string",
+  "protected": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z"
 }
@@ -224,7 +233,7 @@ const { data } = await client.getEnvironmentVariable({
 
 ### `updateEnvironmentVariable`
 
-Update environment variable
+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.
 
 `PUT /v1/environments/{key}`
 
@@ -237,7 +246,8 @@ const { data } = await client.updateEnvironmentVariable(
     type: 'String',
     value: 'string',
     description: 'string',
-    group: 'string'
+    group: 'string',
+    protected: true
   },
 )
 ```
@@ -252,6 +262,7 @@ const { data } = await client.updateEnvironmentVariable(
   "description": "string",
   "group": "string",
   "value": "string",
+  "protected": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "updated_at": "1970-01-01T00:00:00.000Z"
 }
@@ -263,7 +274,7 @@ const { data } = await client.updateEnvironmentVariable(
 
 ### `deleteEnvironmentVariable`
 
-Delete environment variable
+Delete an environment variable by key.
 
 `DELETE /v1/environments/{key}`
 
@@ -279,8 +290,61 @@ const { data } = await client.deleteEnvironmentVariable({
 
 ### `EnvironmentValueType`
 
+The structure a variable's value holds. `SecretString` is encrypted at rest and
+its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
+served to browser-facing consumers; `String` and `SecretString` may not.
+
+
 ```ts
-type EnvironmentValueType = "String" | "SecretString"
+type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
+```
+
+### `EnvironmentOption`
+
+```ts
+type EnvironmentOption = {
+  value: string
+  label: string
+} | {
+  value: string
+  labels: Record<string, string>
+}
+```
+
+### `OptionsValue`
+
+```ts
+type OptionsValue = {
+  fallbackLanguage?: string
+  options: Array<{
+    value: string
+    label: string
+  } | {
+    value: string
+    labels: Record<string, string>
+  }>
+}
+```
+
+### `EnvironmentValue`
+
+A variable's value. The JSON type corresponds to the variable's `type`:
+`String`, `SecretString` and `Text` are strings, `Number` is a number,
+`Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
+doubles; integers above 2^53 may lose precision on round-trip.
+
+
+```ts
+type EnvironmentValue = string | number | boolean | {
+  fallbackLanguage?: string
+  options: Array<{
+    value: string
+    label: string
+  } | {
+    value: string
+    labels: Record<string, string>
+  }>
+}
 ```
 
 ### `EnvironmentVariable`
@@ -288,10 +352,20 @@ type EnvironmentValueType = "String" | "SecretString"
 ```ts
 type EnvironmentVariable = {
   key: string
-  type: "String" | "SecretString"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
   description?: string
   group?: string
-  value?: string
+  value?: string | number | boolean | {
+    fallbackLanguage?: string
+    options: Array<{
+      value: { ... }
+      label: { ... }
+    } | {
+      value: { ... }
+      labels: { ... }
+    }>
+  }
+  protected?: boolean
   created_at: string // date-time
   updated_at: string // date-time
 }
@@ -302,10 +376,20 @@ type EnvironmentVariable = {
 ```ts
 type EnvironmentVariableListItem = {
   key: string
-  type: "String" | "SecretString"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
   description?: string
   group?: string
-  value?: string
+  value?: string | number | boolean | {
+    fallbackLanguage?: string
+    options: Array<{
+      value: { ... }
+      label: { ... }
+    } | {
+      value: { ... }
+      labels: { ... }
+    }>
+  }
+  protected?: boolean
   created_at: string // date-time
   updated_at: string // date-time
 }
@@ -317,10 +401,14 @@ type EnvironmentVariableListItem = {
 type EnvironmentVariableList = {
   items: Array<{
     key: string
-    type: "String" | "SecretString"
+    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
     description?: string
     group?: string
-    value?: string
+    value?: string | number | boolean | {
+      fallbackLanguage?: { ... }
+      options: { ... }
+    }
+    protected?: boolean
     created_at: string // date-time
     updated_at: string // date-time
   }>
@@ -332,10 +420,20 @@ type EnvironmentVariableList = {
 ```ts
 type EnvironmentVariableCreateRequest = {
   key: string
-  type: "String" | "SecretString"
+  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
   description?: string
   group?: string
-  value?: string
+  value?: string | number | boolean | {
+    fallbackLanguage?: string
+    options: Array<{
+      value: { ... }
+      label: { ... }
+    } | {
+      value: { ... }
+      labels: { ... }
+    }>
+  }
+  protected?: boolean
 }
 ```
 
@@ -343,10 +441,20 @@ type EnvironmentVariableCreateRequest = {
 
 ```ts
 type EnvironmentVariableUpdateRequest = {
-  type?: "String" | "SecretString"
-  value?: string
+  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options"
+  value?: string | number | boolean | {
+    fallbackLanguage?: string
+    options: Array<{
+      value: { ... }
+      label: { ... }
+    } | {
+      value: { ... }
+      labels: { ... }
+    }>
+  }
   description?: string
   group?: string
+  protected?: boolean
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.19.4",
+  "version": "2.19.6-alpha.0",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -322,6 +322,16 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix",
+    "prepublishOnly": "npm run build"
+  },
   "keywords": [
     "epilot",
     "sdk",
@@ -515,14 +525,5 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
-  },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix"
   }
-}
+}