@epilot/sdk 2.19.11-alpha.0 → 2.19.11

package/dist/environments-SBUZ6QSC.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/environments.json
-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- [`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### `MapEntry`\n\n```ts\ntype MapEntry = {\n  value: string\n  label: string\n} | {\n  value: string\n  labels: Record<string, string>\n}\n```\n\n### `MapValue`\n\n```ts\ntype MapValue = {\n  fallbackLanguage?: string\n  options: Array<{\n    value: string\n    label: string\n  } | {\n    value: string\n    labels: 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    value: string\n    label: string\n  } | {\n    value: string\n    labels: 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      value: { ... }\n      label: { ... }\n    } | {\n      value: { ... }\n      labels: { ... }\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      value: { ... }\n      label: { ... }\n    } | {\n      value: { ... }\n      labels: { ... }\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      value: { ... }\n      label: { ... }\n    } | {\n      value: { ... }\n      labels: { ... }\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      value: { ... }\n      label: { ... }\n    } | {\n      value: { ... }\n      labels: { ... }\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';
-export {
-  environments_default as default
-};