@epilot/sdk 2.20.17 → 2.20.19

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 (138) hide show
  1. package/definitions/environments.json +290 -5
  2. package/definitions/journey-runtime.json +1 -1
  3. package/definitions/journey.json +29 -4
  4. package/dist/apis/access-token.cjs +6 -6
  5. package/dist/apis/access-token.js +1 -1
  6. package/dist/apis/address-suggestions.cjs +6 -6
  7. package/dist/apis/address-suggestions.js +1 -1
  8. package/dist/apis/address.cjs +6 -6
  9. package/dist/apis/address.js +1 -1
  10. package/dist/apis/ai-agents.cjs +6 -6
  11. package/dist/apis/ai-agents.js +1 -1
  12. package/dist/apis/app.cjs +6 -6
  13. package/dist/apis/app.js +1 -1
  14. package/dist/apis/audit-logs.cjs +6 -6
  15. package/dist/apis/audit-logs.js +1 -1
  16. package/dist/apis/automation.cjs +6 -6
  17. package/dist/apis/automation.js +1 -1
  18. package/dist/apis/billing.cjs +6 -6
  19. package/dist/apis/billing.js +1 -1
  20. package/dist/apis/blueprint-manifest.cjs +6 -6
  21. package/dist/apis/blueprint-manifest.js +1 -1
  22. package/dist/apis/calendar.cjs +6 -6
  23. package/dist/apis/calendar.js +1 -1
  24. package/dist/apis/configuration-hub.cjs +6 -6
  25. package/dist/apis/configuration-hub.js +1 -1
  26. package/dist/apis/consent.cjs +6 -6
  27. package/dist/apis/consent.js +1 -1
  28. package/dist/apis/customer-portal.cjs +6 -6
  29. package/dist/apis/customer-portal.js +1 -1
  30. package/dist/apis/dashboard.cjs +6 -6
  31. package/dist/apis/dashboard.js +1 -1
  32. package/dist/apis/data-governance.cjs +6 -6
  33. package/dist/apis/data-governance.js +1 -1
  34. package/dist/apis/deduplication.cjs +6 -6
  35. package/dist/apis/deduplication.js +1 -1
  36. package/dist/apis/design.cjs +6 -6
  37. package/dist/apis/design.js +1 -1
  38. package/dist/apis/document.cjs +6 -6
  39. package/dist/apis/document.js +1 -1
  40. package/dist/apis/email-settings.cjs +6 -6
  41. package/dist/apis/email-settings.js +1 -1
  42. package/dist/apis/email-template.cjs +6 -6
  43. package/dist/apis/email-template.js +1 -1
  44. package/dist/apis/entity-mapping.cjs +6 -6
  45. package/dist/apis/entity-mapping.js +1 -1
  46. package/dist/apis/entity.cjs +6 -6
  47. package/dist/apis/entity.js +1 -1
  48. package/dist/apis/environments.cjs +6 -6
  49. package/dist/apis/environments.d.cts +2 -2
  50. package/dist/apis/environments.d.ts +2 -2
  51. package/dist/apis/environments.js +1 -1
  52. package/dist/apis/event-catalog.cjs +6 -6
  53. package/dist/apis/event-catalog.js +1 -1
  54. package/dist/apis/file.cjs +6 -6
  55. package/dist/apis/file.js +1 -1
  56. package/dist/apis/iban.cjs +6 -6
  57. package/dist/apis/iban.js +1 -1
  58. package/dist/apis/integration-toolkit.cjs +6 -6
  59. package/dist/apis/integration-toolkit.js +1 -1
  60. package/dist/apis/journey.cjs +8 -8
  61. package/dist/apis/journey.d.cts +2 -2
  62. package/dist/apis/journey.d.ts +2 -2
  63. package/dist/apis/journey.js +2 -2
  64. package/dist/apis/kanban.cjs +6 -6
  65. package/dist/apis/kanban.js +1 -1
  66. package/dist/apis/message.cjs +6 -6
  67. package/dist/apis/message.js +1 -1
  68. package/dist/apis/metering.cjs +6 -6
  69. package/dist/apis/metering.js +1 -1
  70. package/dist/apis/notes.cjs +6 -6
  71. package/dist/apis/notes.js +1 -1
  72. package/dist/apis/notification.cjs +6 -6
  73. package/dist/apis/notification.js +1 -1
  74. package/dist/apis/organization.cjs +6 -6
  75. package/dist/apis/organization.js +1 -1
  76. package/dist/apis/partner-directory.cjs +6 -6
  77. package/dist/apis/partner-directory.js +1 -1
  78. package/dist/apis/permissions.cjs +6 -6
  79. package/dist/apis/permissions.js +1 -1
  80. package/dist/apis/pricing-tier.cjs +6 -6
  81. package/dist/apis/pricing-tier.js +1 -1
  82. package/dist/apis/pricing.cjs +6 -6
  83. package/dist/apis/pricing.js +1 -1
  84. package/dist/apis/purpose.cjs +6 -6
  85. package/dist/apis/purpose.js +1 -1
  86. package/dist/apis/query.cjs +6 -6
  87. package/dist/apis/query.js +1 -1
  88. package/dist/apis/sandbox.cjs +6 -6
  89. package/dist/apis/sandbox.js +1 -1
  90. package/dist/apis/sharing.cjs +6 -6
  91. package/dist/apis/sharing.js +1 -1
  92. package/dist/apis/snapshot.cjs +6 -6
  93. package/dist/apis/snapshot.js +1 -1
  94. package/dist/apis/submission.cjs +6 -6
  95. package/dist/apis/submission.js +1 -1
  96. package/dist/apis/target.cjs +6 -6
  97. package/dist/apis/target.js +1 -1
  98. package/dist/apis/targeting.cjs +6 -6
  99. package/dist/apis/targeting.js +1 -1
  100. package/dist/apis/template-variables.cjs +6 -6
  101. package/dist/apis/template-variables.js +1 -1
  102. package/dist/apis/user.cjs +6 -6
  103. package/dist/apis/user.js +1 -1
  104. package/dist/apis/validation-rules.cjs +6 -6
  105. package/dist/apis/validation-rules.js +1 -1
  106. package/dist/apis/webhooks.cjs +6 -6
  107. package/dist/apis/webhooks.js +1 -1
  108. package/dist/apis/workflow-definition.cjs +6 -6
  109. package/dist/apis/workflow-definition.js +1 -1
  110. package/dist/apis/workflow.cjs +6 -6
  111. package/dist/apis/workflow.js +1 -1
  112. package/dist/{chunk-OZHARSW5.cjs → chunk-5EIG7AKU.cjs} +3 -3
  113. package/dist/{chunk-HQJ5AG4I.js → chunk-ACIBIJN5.js} +3 -3
  114. package/dist/chunk-SJS5S6Z5.js +14 -0
  115. package/dist/chunk-X7UJYAG5.cjs +14 -0
  116. package/dist/environments-OYCH6VUD.js +7 -0
  117. package/dist/environments-S3O6ASTY.cjs +7 -0
  118. package/dist/{environments.d-C_BTxz4W.d.cts → environments.d-qL1urwAq.d.cts} +252 -22
  119. package/dist/{environments.d-C_BTxz4W.d.ts → environments.d-qL1urwAq.d.ts} +252 -22
  120. package/dist/index.cjs +10 -10
  121. package/dist/index.d.cts +2 -2
  122. package/dist/index.d.ts +2 -2
  123. package/dist/index.js +2 -2
  124. package/dist/journey-LIJDXSEC.js +7 -0
  125. package/dist/journey-LNA7JFP3.cjs +7 -0
  126. package/dist/{journey-runtime-EFWGEDUE.cjs → journey-runtime-BVSPJTYH.cjs} +2 -2
  127. package/dist/{journey-runtime-VCADGDRV.js → journey-runtime-S5I3K4NH.js} +1 -1
  128. package/dist/{journey.d-6Bs1uNLT.d.cts → journey.d-DvwLALwc.d.cts} +36 -2
  129. package/dist/{journey.d-6Bs1uNLT.d.ts → journey.d-DvwLALwc.d.ts} +36 -2
  130. package/docs/environments.md +327 -11
  131. package/docs/journey.md +17 -2
  132. package/package.json +1 -1
  133. package/dist/chunk-HL4MZXEK.js +0 -14
  134. package/dist/chunk-W6R2J6KQ.cjs +0 -14
  135. package/dist/environments-EAVUY4FC.cjs +0 -7
  136. package/dist/environments-RNOROUFZ.js +0 -7
  137. package/dist/journey-FNWHSZW3.js +0 -7
  138. package/dist/journey-FUJDOH5O.cjs +0 -7
@@ -0,0 +1,7 @@
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- [`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';
5
+ export {
6
+ environments_default as default
7
+ };
@@ -0,0 +1,7 @@
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- [`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';
5
+
6
+
7
+ exports.default = environments_default;
@@ -20,15 +20,17 @@ 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`, `JSON` and `Link` are objects. Numbers are
24
- * IEEE 754 doubles; integers above 2^53 may lose precision on round-trip.
23
+ * `Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
24
+ * Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
25
+ * round-trip.
25
26
  *
26
27
  */
27
28
  export type EnvironmentValue = /**
28
29
  * A variable's value. The JSON type corresponds to the variable's `type`:
29
30
  * `String`, `SecretString` and `Text` are strings, `Number` is a number,
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.
31
+ * `Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
32
+ * Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
33
+ * round-trip.
32
34
  *
33
35
  */
34
36
  string | number | boolean | MapValue | /**
@@ -59,36 +61,58 @@ declare namespace Components {
59
61
  * does not itself declare it.
60
62
  *
61
63
  */
62
- LinkValue;
64
+ LinkValue | /**
65
+ * An ordered collection of one declared element type. Items round-trip in
66
+ * the order written; nothing sorts them. Holds at most 100 items.
67
+ *
68
+ * The whole value is limited to 32768 characters when serialised — the
69
+ * server enforces this, and it is not expressible per-property here.
70
+ *
71
+ */
72
+ ListValue;
63
73
  /**
64
74
  * The structure a variable's value holds. `SecretString` is encrypted at rest and
65
75
  * 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.
76
+ * may be served to browser-facing consumers; `String` and `SecretString` may not. A
77
+ * `List` inherits this from its element type: a `List` is served only when its
78
+ * `itemType` is itself client-safe, so a `List<String>` or `List<SecretString>` is not.
67
79
  *
68
80
  */
69
- export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
81
+ export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List";
70
82
  export interface EnvironmentVariable {
71
83
  key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
72
84
  type: /**
73
85
  * The structure a variable's value holds. `SecretString` is encrypted at rest and
74
86
  * 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.
87
+ * may be served to browser-facing consumers; `String` and `SecretString` may not. A
88
+ * `List` inherits this from its element type: a `List` is served only when its
89
+ * `itemType` is itself client-safe, so a `List<String>` or `List<SecretString>` is not.
76
90
  *
77
91
  */
78
92
  EnvironmentValueType;
93
+ /**
94
+ * Present only for a `List` variable that holds a value, derived from
95
+ * that value at read time and never stored. Returned even when `value`
96
+ * itself is withheld, which is the case for a list of `SecretString` —
97
+ * it is the only way a client learns what such a list holds.
98
+ *
99
+ */
100
+ item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link";
79
101
  description?: string;
80
102
  /**
81
103
  * Optional group name for organising variables in the UI
82
104
  */
83
105
  group?: string;
84
106
  /**
85
- * Returned for non-secret types, omitted for SecretString. Also omitted when
107
+ * Returned for non-secret types, omitted for SecretString and for a
108
+ * List of SecretString. Also omitted when
86
109
  * the variable has been created without a value — for example by a blueprint
87
110
  * install, which syncs a variable's key and type but never its value.
88
111
  *
89
112
  */
90
113
  value?: /**
91
- * Returned for non-secret types, omitted for SecretString. Also omitted when
114
+ * Returned for non-secret types, omitted for SecretString and for a
115
+ * List of SecretString. Also omitted when
92
116
  * the variable has been created without a value — for example by a blueprint
93
117
  * install, which syncs a variable's key and type but never its value.
94
118
  *
@@ -121,7 +145,15 @@ declare namespace Components {
121
145
  * does not itself declare it.
122
146
  *
123
147
  */
124
- LinkValue;
148
+ LinkValue | /**
149
+ * An ordered collection of one declared element type. Items round-trip in
150
+ * the order written; nothing sorts them. Holds at most 100 items.
151
+ *
152
+ * The whole value is limited to 32768 characters when serialised — the
153
+ * server enforces this, and it is not expressible per-property here.
154
+ *
155
+ */
156
+ ListValue;
125
157
  /**
126
158
  * Whether the variable is protected from editing
127
159
  */
@@ -134,7 +166,9 @@ declare namespace Components {
134
166
  type: /**
135
167
  * The structure a variable's value holds. `SecretString` is encrypted at rest and
136
168
  * 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.
169
+ * may be served to browser-facing consumers; `String` and `SecretString` may not. A
170
+ * `List` inherits this from its element type: a `List` is served only when its
171
+ * `itemType` is itself client-safe, so a `List<String>` or `List<SecretString>` is not.
138
172
  *
139
173
  */
140
174
  EnvironmentValueType;
@@ -143,8 +177,9 @@ declare namespace Components {
143
177
  value?: /**
144
178
  * A variable's value. The JSON type corresponds to the variable's `type`:
145
179
  * `String`, `SecretString` and `Text` are strings, `Number` is a number,
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.
180
+ * `Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
181
+ * Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
182
+ * round-trip.
148
183
  *
149
184
  */
150
185
  EnvironmentValue;
@@ -161,23 +196,35 @@ declare namespace Components {
161
196
  type: /**
162
197
  * The structure a variable's value holds. `SecretString` is encrypted at rest and
163
198
  * 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.
199
+ * may be served to browser-facing consumers; `String` and `SecretString` may not. A
200
+ * `List` inherits this from its element type: a `List` is served only when its
201
+ * `itemType` is itself client-safe, so a `List<String>` or `List<SecretString>` is not.
165
202
  *
166
203
  */
167
204
  EnvironmentValueType;
205
+ /**
206
+ * Present only for a `List` variable that holds a value, derived from
207
+ * that value at read time and never stored. Returned even when `value`
208
+ * itself is withheld, which is the case for a list of `SecretString` —
209
+ * it is the only way a client learns what such a list holds.
210
+ *
211
+ */
212
+ item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link";
168
213
  description?: string;
169
214
  /**
170
215
  * Optional group name for organising variables in the UI
171
216
  */
172
217
  group?: string;
173
218
  /**
174
- * Returned for non-secret types, omitted for SecretString. Also omitted when
219
+ * Returned for non-secret types, omitted for SecretString and for a
220
+ * List of SecretString. Also omitted when
175
221
  * the variable has been created without a value — for example by a blueprint
176
222
  * install, which syncs a variable's key and type but never its value.
177
223
  *
178
224
  */
179
225
  value?: /**
180
- * Returned for non-secret types, omitted for SecretString. Also omitted when
226
+ * Returned for non-secret types, omitted for SecretString and for a
227
+ * List of SecretString. Also omitted when
181
228
  * the variable has been created without a value — for example by a blueprint
182
229
  * install, which syncs a variable's key and type but never its value.
183
230
  *
@@ -210,7 +257,15 @@ declare namespace Components {
210
257
  * does not itself declare it.
211
258
  *
212
259
  */
213
- LinkValue;
260
+ LinkValue | /**
261
+ * An ordered collection of one declared element type. Items round-trip in
262
+ * the order written; nothing sorts them. Holds at most 100 items.
263
+ *
264
+ * The whole value is limited to 32768 characters when serialised — the
265
+ * server enforces this, and it is not expressible per-property here.
266
+ *
267
+ */
268
+ ListValue;
214
269
  /**
215
270
  * Whether the variable is protected from editing
216
271
  */
@@ -222,12 +277,13 @@ declare namespace Components {
222
277
  /**
223
278
  * Type of variable. Used when creating a new variable. Defaults to String.
224
279
  */
225
- type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
280
+ type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List";
226
281
  value?: /**
227
282
  * A variable's value. The JSON type corresponds to the variable's `type`:
228
283
  * `String`, `SecretString` and `Text` are strings, `Number` is a number,
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.
284
+ * `Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
285
+ * Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
286
+ * round-trip.
231
287
  *
232
288
  */
233
289
  EnvironmentValue;
@@ -246,6 +302,42 @@ declare namespace Components {
246
302
  export interface JsonValue {
247
303
  [name: string]: any;
248
304
  }
305
+ /**
306
+ * The fields of a link, without a fallback language — the shape a `List`
307
+ * item carries. Inside a list the fallback belongs to the wrapper, which
308
+ * owns the language tabs for every row.
309
+ *
310
+ * Restated rather than composed with `LinkValue`: `allOf` plus
311
+ * `additionalProperties: false` is rejected by most validators, because
312
+ * each branch sees the sibling's properties as unknown. zod composes
313
+ * properly — see LinkFieldsSchema in src/core/value-types.ts.
314
+ *
315
+ */
316
+ export interface LinkFields {
317
+ url: string;
318
+ label: string | /**
319
+ * A string translated per language. Keys are language codes (e.g. `de`,
320
+ * `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
321
+ * everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
322
+ * that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
323
+ * not otherwise linked. The pattern is documented rather than declared
324
+ * because `propertyNames` is JSON Schema / OAS 3.1 and this document is
325
+ * 3.0.3, where it fails `spectral lint` (oas3-schema).
326
+ *
327
+ */
328
+ StringTranslations;
329
+ description?: string | /**
330
+ * A string translated per language. Keys are language codes (e.g. `de`,
331
+ * `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
332
+ * everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
333
+ * that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
334
+ * not otherwise linked. The pattern is documented rather than declared
335
+ * because `propertyNames` is JSON Schema / OAS 3.1 and this document is
336
+ * 3.0.3, where it fails `spectral lint` (oas3-schema).
337
+ *
338
+ */
339
+ StringTranslations;
340
+ }
249
341
  /**
250
342
  * One URL with a label and description a customer reads. `label` and
251
343
  * `description` are each either a plain string or one string per language;
@@ -295,6 +387,134 @@ declare namespace Components {
295
387
  StringTranslations;
296
388
  fallbackLanguage?: string;
297
389
  }
390
+ /**
391
+ * The element type a `List` holds — every value type except the
392
+ * containers. `Map` is already a keyed collection and a list of lists has
393
+ * no consumer. A list is exactly as client-safe and exactly as secret as
394
+ * its element type: a list of `SecretString` is encrypted per item and its
395
+ * value is never returned.
396
+ *
397
+ */
398
+ export type ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link";
399
+ export interface ListOfBoolean {
400
+ itemType: "Boolean";
401
+ items: [
402
+ boolean,
403
+ ...boolean[]
404
+ ];
405
+ }
406
+ export interface ListOfJson {
407
+ itemType: "JSON";
408
+ items: [
409
+ {
410
+ [name: string]: any;
411
+ },
412
+ ...{
413
+ [name: string]: any;
414
+ }[]
415
+ ];
416
+ }
417
+ /**
418
+ * A list of links. `fallbackLanguage` applies to every item's translated
419
+ * `label` and `description`; items may mix plain and translated fields
420
+ * freely, since a plain string is a complete answer for any language.
421
+ *
422
+ */
423
+ export interface ListOfLink {
424
+ itemType: "Link";
425
+ fallbackLanguage?: string;
426
+ items: [
427
+ /**
428
+ * The fields of a link, without a fallback language — the shape a `List`
429
+ * item carries. Inside a list the fallback belongs to the wrapper, which
430
+ * owns the language tabs for every row.
431
+ *
432
+ * Restated rather than composed with `LinkValue`: `allOf` plus
433
+ * `additionalProperties: false` is rejected by most validators, because
434
+ * each branch sees the sibling's properties as unknown. zod composes
435
+ * properly — see LinkFieldsSchema in src/core/value-types.ts.
436
+ *
437
+ */
438
+ LinkFields,
439
+ .../**
440
+ * The fields of a link, without a fallback language — the shape a `List`
441
+ * item carries. Inside a list the fallback belongs to the wrapper, which
442
+ * owns the language tabs for every row.
443
+ *
444
+ * Restated rather than composed with `LinkValue`: `allOf` plus
445
+ * `additionalProperties: false` is rejected by most validators, because
446
+ * each branch sees the sibling's properties as unknown. zod composes
447
+ * properly — see LinkFieldsSchema in src/core/value-types.ts.
448
+ *
449
+ */
450
+ LinkFields[]
451
+ ];
452
+ }
453
+ export interface ListOfNumber {
454
+ itemType: "Number";
455
+ items: [
456
+ number,
457
+ ...number[]
458
+ ];
459
+ }
460
+ /**
461
+ * Write-only in effect: the items are encrypted per item at rest and the
462
+ * whole value is omitted from every read response, exactly as a
463
+ * `SecretString` variable's value is. Read `item_type` to learn what a
464
+ * list holds when its value is withheld.
465
+ *
466
+ */
467
+ export interface ListOfSecretString {
468
+ itemType: "SecretString";
469
+ items: [
470
+ string,
471
+ ...string[]
472
+ ];
473
+ }
474
+ export interface ListOfString {
475
+ itemType: "String";
476
+ items: [
477
+ string,
478
+ ...string[]
479
+ ];
480
+ }
481
+ export interface ListOfText {
482
+ itemType: "Text";
483
+ items: [
484
+ string,
485
+ ...string[]
486
+ ];
487
+ }
488
+ /**
489
+ * An ordered collection of one declared element type. Items round-trip in
490
+ * the order written; nothing sorts them. Holds at most 100 items.
491
+ *
492
+ * The whole value is limited to 32768 characters when serialised — the
493
+ * server enforces this, and it is not expressible per-property here.
494
+ *
495
+ */
496
+ export type ListValue = /**
497
+ * An ordered collection of one declared element type. Items round-trip in
498
+ * the order written; nothing sorts them. Holds at most 100 items.
499
+ *
500
+ * The whole value is limited to 32768 characters when serialised — the
501
+ * server enforces this, and it is not expressible per-property here.
502
+ *
503
+ */
504
+ ListOfText | ListOfNumber | ListOfBoolean | ListOfJson | /**
505
+ * A list of links. `fallbackLanguage` applies to every item's translated
506
+ * `label` and `description`; items may mix plain and translated fields
507
+ * freely, since a plain string is a complete answer for any language.
508
+ *
509
+ */
510
+ ListOfLink | ListOfString | /**
511
+ * Write-only in effect: the items are encrypted per item at rest and the
512
+ * whole value is omitted from every read response, exactly as a
513
+ * `SecretString` variable's value is. Read `item_type` to learn what a
514
+ * list holds when its value is withheld.
515
+ *
516
+ */
517
+ ListOfSecretString;
298
518
  /**
299
519
  * One entry of a Map. `key` is the token a journey submits; `value` is
300
520
  * what the customer reads — either one string, or one string per
@@ -666,9 +886,19 @@ type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
666
886
  type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
667
887
  type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
668
888
  type JsonValue = Components.Schemas.JsonValue;
889
+ type LinkFields = Components.Schemas.LinkFields;
669
890
  type LinkValue = Components.Schemas.LinkValue;
891
+ type ListItemType = Components.Schemas.ListItemType;
892
+ type ListOfBoolean = Components.Schemas.ListOfBoolean;
893
+ type ListOfJson = Components.Schemas.ListOfJson;
894
+ type ListOfLink = Components.Schemas.ListOfLink;
895
+ type ListOfNumber = Components.Schemas.ListOfNumber;
896
+ type ListOfSecretString = Components.Schemas.ListOfSecretString;
897
+ type ListOfString = Components.Schemas.ListOfString;
898
+ type ListOfText = Components.Schemas.ListOfText;
899
+ type ListValue = Components.Schemas.ListValue;
670
900
  type MapEntry = Components.Schemas.MapEntry;
671
901
  type MapValue = Components.Schemas.MapValue;
672
902
  type StringTranslations = Components.Schemas.StringTranslations;
673
903
 
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 };
904
+ export { type Client as C, type EnvironmentGroup as E, type JsonValue as J, type LinkFields 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 LinkValue as l, type ListItemType as m, type ListOfBoolean as n, type ListOfJson as o, type ListOfLink as p, type ListOfNumber as q, type ListOfSecretString as r, type ListOfString as s, type ListOfText as t, type ListValue as u, type MapValue as v };