@epilot/sdk 2.20.13-alpha.0 → 2.20.14

package/dist/environments-S3O6ASTY.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// 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- [`StringTranslations`](#stringtranslations)\n- [`MapEntry`](#mapentry)\n- [`MapValue`](#mapvalue)\n- [`JsonValue`](#jsonvalue)\n- [`LinkValue`](#linkvalue)\n- [`LinkFields`](#linkfields)\n- [`ListItemType`](#listitemtype)\n- [`ListOfText`](#listoftext)\n- [`ListOfString`](#listofstring)\n- [`ListOfSecretString`](#listofsecretstring)\n- [`ListOfNumber`](#listofnumber)\n- [`ListOfBoolean`](#listofboolean)\n- [`ListOfJson`](#listofjson)\n- [`ListOfLink`](#listoflink)\n- [`ListValue`](#listvalue)\n- [`EnvironmentValue`](#environmentvalue)\n- [`EnvironmentVariable`](#environmentvariable)\n- [`EnvironmentVariableListItem`](#environmentvariablelistitem)\n- [`EnvironmentVariableList`](#environmentvariablelist)\n- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)\n- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)\n- [`EnvironmentGroup`](#environmentgroup)\n- [`EnvironmentGroupList`](#environmentgrouplist)\n- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)\n\n### `listEnvironmentVariables`\n\nList all environment variables for the organization. Returns metadata only, no secret values.\n\n`GET /v1/environments`\n\n```ts\nconst { data } = await client.listEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "key": "string",\n      "type": "String",\n      "item_type": "String",\n      "description": "string",\n      "group": "string",\n      "value": "string",\n      "protected": true,\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createEnvironmentVariable`\n\nCreate a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`POST /v1/environments`\n\n```ts\nconst { data } = await client.createEnvironmentVariable(\n  null,\n  {\n    key: \'string\',\n    type: \'String\',\n    description: \'string\',\n    group: \'string\',\n    value: \'string\',\n    protected: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "key": "string",\n  "type": "String",\n  "item_type": "String",\n  "description": "string",\n  "group": "string",\n  "value": "string",\n  "protected": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `listEnvironmentGroups`\n\nList all environment groups for the organization.\n\n`GET /v1/environments/groups`\n\n```ts\nconst { data } = await client.listEnvironmentGroups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "items": [\n    {\n      "name": "string",\n      "description": "string",\n      "created_at": "1970-01-01T00:00:00.000Z",\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `putEnvironmentGroup`\n\nCreate or update an environment group by name. Acts as an upsert \u2014 creates the group if it does not exist.\n\n`PUT /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.putEnvironmentGroup(\n  {\n    name: \'example\',\n  },\n  {\n    description: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "name": "string",\n  "description": "string",\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentGroup`\n\nDeletes a group. Variables assigned to this group become ungrouped.\n\n`DELETE /v1/environments/groups/{name}`\n\n```ts\nconst { data } = await client.deleteEnvironmentGroup({\n  name: \'example\',\n})\n```\n\n---\n\n### `getEnvironmentVariable`\n\nGet an environment variable by key. Returns value for non-secret types, omitted for SecretString.\n\n`GET /v1/environments/{key}`\n\n```ts\nconst { data } = await client.getEnvironmentVariable({\n  key: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "key": "string",\n  "type": "String",\n  "item_type": "String",\n  "description": "string",\n  "group": "string",\n  "value": "string",\n  "protected": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateEnvironmentVariable`\n\nCreate or update an environment variable. Acts as an upsert \u2014 creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.\n\n`PUT /v1/environments/{key}`\n\n```ts\nconst { data } = await client.updateEnvironmentVariable(\n  {\n    key: \'example\',\n  },\n  {\n    type: \'String\',\n    value: \'string\',\n    description: \'string\',\n    group: \'string\',\n    protected: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "key": "string",\n  "type": "String",\n  "item_type": "String",\n  "description": "string",\n  "group": "string",\n  "value": "string",\n  "protected": true,\n  "created_at": "1970-01-01T00:00:00.000Z",\n  "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `deleteEnvironmentVariable`\n\nDelete an environment variable by key.\n\n`DELETE /v1/environments/{key}`\n\n```ts\nconst { data } = await client.deleteEnvironmentVariable({\n  key: \'example\',\n})\n```\n\n---\n\n## Schemas\n\n### `EnvironmentValueType`\n\nThe structure a variable\'s value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`\nmay be served to browser-facing consumers; `String` and `SecretString` may not. A\n`List` inherits this from its element type: a `List` is\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n```\n\n### `StringTranslations`\n\nA string translated per language. Keys are language codes (e.g. `de`,\n`en-US`), matching the hyphen-only BCP-47 form epilot\'s i18n stack uses\neverywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces\nthat with LANGUAGE_KEY_PATTERN in src/core/value-types.ts \u2014 the two are\nnot otherwise lin\n\n```ts\ntype StringTranslations = Record<string, string>\n```\n\n### `MapEntry`\n\nOne entry of a Map. `key` is the token a journey submits; `value` is\nwhat the customer reads \u2014 either one string, or one string per\nlanguage. Every entry of a Map must agree on which of the two it uses.\n\n\n```ts\ntype MapEntry = {\n  key: string\n  value: string | Record<string, string>\n}\n```\n\n### `MapValue`\n\n```ts\ntype MapValue = {\n  fallbackLanguage?: string\n  options: Array<{\n    key: string\n    value: string | Record<string, string>\n  }>\n}\n```\n\n### `JsonValue`\n\nArbitrary JSON object, e.g. a flat key/value map used by integrations for\nenum translation: {"Mr.": 1, "Ms. / Mrs.": 2}. Max 32 KB serialised.\n\n\n```ts\ntype JsonValue = Record<string, unknown>\n```\n\n### `LinkValue`\n\nOne URL with a label and description a customer reads. `label` and\n`description` are each either a plain string or one string per language;\nthe two fields decide that independently \u2014 a plain string means "the\nsame in every language". A translated field must carry the fallback\nlanguage.\n\nThe URL must\n\n```ts\ntype LinkValue = {\n  url: string\n  label: string | Record<string, string>\n  description?: string | Record<string, string>\n  fallbackLanguage?: string\n}\n```\n\n### `LinkFields`\n\nThe fields of a link, without a fallback language \u2014 the shape a `List`\nitem carries. Inside a list the fallback belongs to the wrapper, which\nowns the language tabs for every row.\n\nRestated rather than composed with `LinkValue`: `allOf` plus\n`additionalProperties: false` is rejected by most validato\n\n```ts\ntype LinkFields = {\n  url: string\n  label: string | Record<string, string>\n  description?: string | Record<string, string>\n}\n```\n\n### `ListItemType`\n\nThe element type a `List` holds \u2014 every value type except the\ncontainers. `Map` is already a keyed collection and a list of lists has\nno consumer. A list is exactly as client-safe and exactly as secret as\nits element type: a list of `SecretString` is encrypted per item and its\nvalue is never returne\n\n```ts\ntype ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"\n```\n\n### `ListOfText`\n\n```ts\ntype ListOfText = {\n  itemType: "Text"\n  items: string[]\n}\n```\n\n### `ListOfString`\n\n```ts\ntype ListOfString = {\n  itemType: "String"\n  items: string[]\n}\n```\n\n### `ListOfSecretString`\n\nWrite-only in effect: the items are encrypted per item at rest and the\nwhole value is omitted from every read response, exactly as a\n`SecretString` variable\'s value is. Read `item_type` to learn what a\nlist holds when its value is withheld.\n\n\n```ts\ntype ListOfSecretString = {\n  itemType: "SecretString"\n  items: string[]\n}\n```\n\n### `ListOfNumber`\n\n```ts\ntype ListOfNumber = {\n  itemType: "Number"\n  items: number[]\n}\n```\n\n### `ListOfBoolean`\n\n```ts\ntype ListOfBoolean = {\n  itemType: "Boolean"\n  items: boolean[]\n}\n```\n\n### `ListOfJson`\n\n```ts\ntype ListOfJson = {\n  itemType: "JSON"\n  items: Record<string, unknown>[]\n}\n```\n\n### `ListOfLink`\n\nA list of links. `fallbackLanguage` applies to every item\'s translated\n`label` and `description`; items may mix plain and translated fields\nfreely, since a plain string is a complete answer for any language.\n\n\n```ts\ntype ListOfLink = {\n  itemType: "Link"\n  fallbackLanguage?: string\n  items: Array<{\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n  }>\n}\n```\n\n### `ListValue`\n\nAn ordered collection of one declared element type. Items round-trip in\nthe order written; nothing sorts them. Holds at most 100 items.\n\nThe whole value is limited to 32768 characters when serialised \u2014 the\nserver enforces this, and it is not expressible per-property here.\n\n\n```ts\ntype ListValue = {\n  itemType: "Text"\n  items: string[]\n} | {\n  itemType: "Number"\n  items: number[]\n} | {\n  itemType: "Boolean"\n  items: boolean[]\n} | {\n  itemType: "JSON"\n  items: Record<string, unknown>[]\n} | {\n  itemType: "Link"\n  fallbackLanguage?: string\n  items: Array<{\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n  }>\n} | {\n  itemType: "String"\n  items: string[]\n} | {\n  itemType: "SecretString"\n  items: string[]\n}\n```\n\n### `EnvironmentValue`\n\nA variable\'s value. The JSON type corresponds to the variable\'s `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.\nNumbers are IEEE 754 doubles; integers above 2^53 may lose precision on\nround-trip.\n\n```ts\ntype EnvironmentValue = string | number | boolean | {\n  fallbackLanguage?: string\n  options: Array<{\n    key: string\n    value: string | Record<string, string>\n  }>\n} | Record<string, unknown> | {\n  url: string\n  label: string | Record<string, string>\n  description?: string | Record<string, string>\n  fallbackLanguage?: string\n} | {\n  itemType: "Text"\n  items: string[]\n} | {\n  itemType: "Number"\n  items: number[]\n} | {\n  itemType: "Boolean"\n  items: boolean[]\n} | {\n  itemType: "JSON"\n  items: Record<string, unknown>[]\n} | {\n  itemType: "Link"\n  fallbackLanguage?: string\n  items: Array<{\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n  }>\n} | {\n  itemType: "String"\n  items: string[]\n} | {\n  itemType: "SecretString"\n  items: string[]\n}\n```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n  key: string\n  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n  item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"\n  description?: string\n  group?: string\n  value?: string | number | boolean | {\n    fallbackLanguage?: string\n    options: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  } | Record<string, unknown> | {\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n    fallbackLanguage?: string\n  } | {\n    itemType: "Text"\n    items: string[]\n  } | {\n    itemType: "Number"\n    items: number[]\n  } | {\n    itemType: "Boolean"\n    items: boolean[]\n  } | {\n    itemType: "JSON"\n    items: Record<string, unknown>[]\n  } | {\n    itemType: "Link"\n    fallbackLanguage?: string\n    items: Array<{\n      url: { ... }\n      label: { ... }\n      description?: { ... }\n    }>\n  } | {\n    itemType: "String"\n    items: string[]\n  } | {\n    itemType: "SecretString"\n    items: string[]\n  }\n  protected?: boolean\n  created_at: string // date-time\n  updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableListItem`\n\n```ts\ntype EnvironmentVariableListItem = {\n  key: string\n  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n  item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"\n  description?: string\n  group?: string\n  value?: string | number | boolean | {\n    fallbackLanguage?: string\n    options: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  } | Record<string, unknown> | {\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n    fallbackLanguage?: string\n  } | {\n    itemType: "Text"\n    items: string[]\n  } | {\n    itemType: "Number"\n    items: number[]\n  } | {\n    itemType: "Boolean"\n    items: boolean[]\n  } | {\n    itemType: "JSON"\n    items: Record<string, unknown>[]\n  } | {\n    itemType: "Link"\n    fallbackLanguage?: string\n    items: Array<{\n      url: { ... }\n      label: { ... }\n      description?: { ... }\n    }>\n  } | {\n    itemType: "String"\n    items: string[]\n  } | {\n    itemType: "SecretString"\n    items: string[]\n  }\n  protected?: boolean\n  created_at: string // date-time\n  updated_at: string // date-time\n}\n```\n\n### `EnvironmentVariableList`\n\n```ts\ntype EnvironmentVariableList = {\n  items: Array<{\n    key: string\n    type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n    item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"\n    description?: string\n    group?: string\n    value?: string | number | boolean | {\n      fallbackLanguage?: { ... }\n      options: { ... }\n    } | Record<string, unknown> | {\n      url: { ... }\n      label: { ... }\n      description?: { ... }\n      fallbackLanguage?: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      fallbackLanguage?: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    } | {\n      itemType: { ... }\n      items: { ... }\n    }\n    protected?: boolean\n    created_at: string // date-time\n    updated_at: string // date-time\n  }>\n}\n```\n\n### `EnvironmentVariableCreateRequest`\n\n```ts\ntype EnvironmentVariableCreateRequest = {\n  key: string\n  type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n  description?: string\n  group?: string\n  value?: string | number | boolean | {\n    fallbackLanguage?: string\n    options: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  } | Record<string, unknown> | {\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n    fallbackLanguage?: string\n  } | {\n    itemType: "Text"\n    items: string[]\n  } | {\n    itemType: "Number"\n    items: number[]\n  } | {\n    itemType: "Boolean"\n    items: boolean[]\n  } | {\n    itemType: "JSON"\n    items: Record<string, unknown>[]\n  } | {\n    itemType: "Link"\n    fallbackLanguage?: string\n    items: Array<{\n      url: { ... }\n      label: { ... }\n      description?: { ... }\n    }>\n  } | {\n    itemType: "String"\n    items: string[]\n  } | {\n    itemType: "SecretString"\n    items: string[]\n  }\n  protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n  type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"\n  value?: string | number | boolean | {\n    fallbackLanguage?: string\n    options: Array<{\n      key: { ... }\n      value: { ... }\n    }>\n  } | Record<string, unknown> | {\n    url: string\n    label: string | Record<string, string>\n    description?: string | Record<string, string>\n    fallbackLanguage?: string\n  } | {\n    itemType: "Text"\n    items: string[]\n  } | {\n    itemType: "Number"\n    items: number[]\n  } | {\n    itemType: "Boolean"\n    items: boolean[]\n  } | {\n    itemType: "JSON"\n    items: Record<string, unknown>[]\n  } | {\n    itemType: "Link"\n    fallbackLanguage?: string\n    items: Array<{\n      url: { ... }\n      label: { ... }\n      description?: { ... }\n    }>\n  } | {\n    itemType: "String"\n    items: string[]\n  } | {\n    itemType: "SecretString"\n    items: string[]\n  }\n  description?: string\n  group?: string\n  protected?: boolean\n}\n```\n\n### `EnvironmentGroup`\n\n```ts\ntype EnvironmentGroup = {\n  name: string\n  description?: string\n  created_at: string // date-time\n  updated_at: string // date-time\n}\n```\n\n### `EnvironmentGroupList`\n\n```ts\ntype EnvironmentGroupList = {\n  items: Array<{\n    name: string\n    description?: string\n    created_at: string // date-time\n    updated_at: string // date-time\n  }>\n}\n```\n\n### `EnvironmentGroupUpsertRequest`\n\n```ts\ntype EnvironmentGroupUpsertRequest = {\n  description?: string\n}\n```\n';
-
-
-exports.default = environments_default;