@epilot/sdk 2.20.8-alpha.0 → 2.20.9
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.
- package/definitions/environments.json +3 -211
- package/definitions/pricing-runtime.json +1 -1
- package/definitions/pricing.json +3489 -757
- package/definitions/validation-rules.json +184 -6
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +8 -8
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +2 -2
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.d.cts +2 -2
- package/dist/apis/validation-rules.d.ts +2 -2
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-OHYTCUUB.js → chunk-7Q3JW72Y.js} +1 -1
- package/dist/{chunk-PFO4HNPR.js → chunk-JBFTKLP2.js} +4 -4
- package/dist/{chunk-UKHR33EL.cjs → chunk-QLWDOKGE.cjs} +1 -1
- package/dist/{chunk-4FP7EKQT.cjs → chunk-VCD3C4UW.cjs} +4 -4
- package/dist/environments-EAVUY4FC.cjs +7 -0
- package/dist/environments-RNOROUFZ.js +7 -0
- package/dist/{environments.d-Cr-oj1fN.d.cts → environments.d-C_BTxz4W.d.cts} +22 -193
- package/dist/{environments.d-Cr-oj1fN.d.ts → environments.d-C_BTxz4W.d.ts} +22 -193
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/pricing-PFTFDGZ3.cjs +7 -0
- package/dist/pricing-YZHONV3M.js +7 -0
- package/dist/{pricing-runtime-AT27C3BP.js → pricing-runtime-MJAIO4AY.js} +1 -1
- package/dist/{pricing-runtime-PFVTRERK.cjs → pricing-runtime-NMRZO6J4.cjs} +2 -2
- package/dist/{pricing.d-CSVO1WCD.d.cts → pricing.d-CvcYBm8A.d.cts} +9979 -1422
- package/dist/{pricing.d-CSVO1WCD.d.ts → pricing.d-CvcYBm8A.d.ts} +9979 -1422
- package/dist/validation-rules-2JQLB6PH.cjs +7 -0
- package/dist/validation-rules-VQXUQSMC.js +7 -0
- package/dist/{validation-rules.d-D8X9MYTc.d.ts → validation-rules.d-Bbo90IYn.d.cts} +178 -7
- package/dist/{validation-rules.d-D8X9MYTc.d.cts → validation-rules.d-Bbo90IYn.d.ts} +178 -7
- package/docs/environments.md +11 -252
- package/docs/pricing.md +1372 -204
- package/docs/validation-rules.md +286 -0
- package/package.json +1 -1
- package/dist/environments-DBHM4GKI.cjs +0 -7
- package/dist/environments-JVPK6LSD.js +0 -7
- package/dist/pricing-5EKKEZSL.js +0 -7
- package/dist/pricing-N4Z2CHGZ.cjs +0 -7
- package/dist/validation-rules-ETOO45CW.js +0 -7
- package/dist/validation-rules-MZZ7YMJM.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- [`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`, `Map`, `JSON` and `Link`\nmay be served to browser-facing consumers; `String` and `SecretString` may not.\n\n\n```ts\ntype EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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### `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` and `Link` are objects. Numbers are\nIEEE 754 doubles; 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 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```\n\n### `EnvironmentVariable`\n\n```ts\ntype EnvironmentVariable = {\n key: string\n type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "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 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"\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 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"\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 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"\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 protected?: boolean\n}\n```\n\n### `EnvironmentVariableUpdateRequest`\n\n```ts\ntype EnvironmentVariableUpdateRequest = {\n type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"\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 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
|
+
};
|
|
@@ -20,17 +20,15 @@ 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
|
|
24
|
-
*
|
|
25
|
-
* round-trip.
|
|
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.
|
|
26
25
|
*
|
|
27
26
|
*/
|
|
28
27
|
export type EnvironmentValue = /**
|
|
29
28
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
30
29
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
31
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
32
|
-
*
|
|
33
|
-
* round-trip.
|
|
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.
|
|
34
32
|
*
|
|
35
33
|
*/
|
|
36
34
|
string | number | boolean | MapValue | /**
|
|
@@ -61,28 +59,20 @@ declare namespace Components {
|
|
|
61
59
|
* does not itself declare it.
|
|
62
60
|
*
|
|
63
61
|
*/
|
|
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;
|
|
62
|
+
LinkValue;
|
|
73
63
|
/**
|
|
74
64
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
75
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
76
|
-
*
|
|
65
|
+
* 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.
|
|
77
67
|
*
|
|
78
68
|
*/
|
|
79
|
-
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
69
|
+
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
80
70
|
export interface EnvironmentVariable {
|
|
81
71
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
82
72
|
type: /**
|
|
83
73
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
84
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
85
|
-
*
|
|
74
|
+
* 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.
|
|
86
76
|
*
|
|
87
77
|
*/
|
|
88
78
|
EnvironmentValueType;
|
|
@@ -131,15 +121,7 @@ declare namespace Components {
|
|
|
131
121
|
* does not itself declare it.
|
|
132
122
|
*
|
|
133
123
|
*/
|
|
134
|
-
LinkValue
|
|
135
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
136
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
137
|
-
*
|
|
138
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
139
|
-
* server enforces this, and it is not expressible per-property here.
|
|
140
|
-
*
|
|
141
|
-
*/
|
|
142
|
-
ListValue;
|
|
124
|
+
LinkValue;
|
|
143
125
|
/**
|
|
144
126
|
* Whether the variable is protected from editing
|
|
145
127
|
*/
|
|
@@ -151,8 +133,8 @@ declare namespace Components {
|
|
|
151
133
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
152
134
|
type: /**
|
|
153
135
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
154
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
155
|
-
*
|
|
136
|
+
* 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.
|
|
156
138
|
*
|
|
157
139
|
*/
|
|
158
140
|
EnvironmentValueType;
|
|
@@ -161,9 +143,8 @@ declare namespace Components {
|
|
|
161
143
|
value?: /**
|
|
162
144
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
163
145
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
164
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
165
|
-
*
|
|
166
|
-
* round-trip.
|
|
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.
|
|
167
148
|
*
|
|
168
149
|
*/
|
|
169
150
|
EnvironmentValue;
|
|
@@ -179,8 +160,8 @@ declare namespace Components {
|
|
|
179
160
|
key: string;
|
|
180
161
|
type: /**
|
|
181
162
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
182
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
183
|
-
*
|
|
163
|
+
* 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.
|
|
184
165
|
*
|
|
185
166
|
*/
|
|
186
167
|
EnvironmentValueType;
|
|
@@ -229,15 +210,7 @@ declare namespace Components {
|
|
|
229
210
|
* does not itself declare it.
|
|
230
211
|
*
|
|
231
212
|
*/
|
|
232
|
-
LinkValue
|
|
233
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
234
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
235
|
-
*
|
|
236
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
237
|
-
* server enforces this, and it is not expressible per-property here.
|
|
238
|
-
*
|
|
239
|
-
*/
|
|
240
|
-
ListValue;
|
|
213
|
+
LinkValue;
|
|
241
214
|
/**
|
|
242
215
|
* Whether the variable is protected from editing
|
|
243
216
|
*/
|
|
@@ -249,13 +222,12 @@ declare namespace Components {
|
|
|
249
222
|
/**
|
|
250
223
|
* Type of variable. Used when creating a new variable. Defaults to String.
|
|
251
224
|
*/
|
|
252
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
225
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
253
226
|
value?: /**
|
|
254
227
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
255
228
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
256
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
257
|
-
*
|
|
258
|
-
* round-trip.
|
|
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.
|
|
259
231
|
*
|
|
260
232
|
*/
|
|
261
233
|
EnvironmentValue;
|
|
@@ -274,42 +246,6 @@ declare namespace Components {
|
|
|
274
246
|
export interface JsonValue {
|
|
275
247
|
[name: string]: any;
|
|
276
248
|
}
|
|
277
|
-
/**
|
|
278
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
279
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
280
|
-
* owns the language tabs for every row.
|
|
281
|
-
*
|
|
282
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
283
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
284
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
285
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
286
|
-
*
|
|
287
|
-
*/
|
|
288
|
-
export interface LinkFields {
|
|
289
|
-
url: string;
|
|
290
|
-
label: string | /**
|
|
291
|
-
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
292
|
-
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
293
|
-
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
294
|
-
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
295
|
-
* not otherwise linked. The pattern is documented rather than declared
|
|
296
|
-
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
297
|
-
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
298
|
-
*
|
|
299
|
-
*/
|
|
300
|
-
StringTranslations;
|
|
301
|
-
description?: string | /**
|
|
302
|
-
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
303
|
-
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
304
|
-
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
305
|
-
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
306
|
-
* not otherwise linked. The pattern is documented rather than declared
|
|
307
|
-
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
308
|
-
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
309
|
-
*
|
|
310
|
-
*/
|
|
311
|
-
StringTranslations;
|
|
312
|
-
}
|
|
313
249
|
/**
|
|
314
250
|
* One URL with a label and description a customer reads. `label` and
|
|
315
251
|
* `description` are each either a plain string or one string per language;
|
|
@@ -359,105 +295,6 @@ declare namespace Components {
|
|
|
359
295
|
StringTranslations;
|
|
360
296
|
fallbackLanguage?: string;
|
|
361
297
|
}
|
|
362
|
-
/**
|
|
363
|
-
* The element type a `List` holds. `String` and `SecretString` are absent
|
|
364
|
-
* deliberately: they are the two types never served to browser-facing
|
|
365
|
-
* consumers, and a `List` is. `Map` is already a keyed collection, and a
|
|
366
|
-
* list of lists has no consumer.
|
|
367
|
-
*
|
|
368
|
-
*/
|
|
369
|
-
export type ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link";
|
|
370
|
-
export interface ListOfBoolean {
|
|
371
|
-
itemType: "Boolean";
|
|
372
|
-
items: [
|
|
373
|
-
boolean,
|
|
374
|
-
...boolean[]
|
|
375
|
-
];
|
|
376
|
-
}
|
|
377
|
-
export interface ListOfJson {
|
|
378
|
-
itemType: "JSON";
|
|
379
|
-
items: [
|
|
380
|
-
{
|
|
381
|
-
[name: string]: any;
|
|
382
|
-
},
|
|
383
|
-
...{
|
|
384
|
-
[name: string]: any;
|
|
385
|
-
}[]
|
|
386
|
-
];
|
|
387
|
-
}
|
|
388
|
-
/**
|
|
389
|
-
* A list of links. `fallbackLanguage` applies to every item's translated
|
|
390
|
-
* `label` and `description`; items may mix plain and translated fields
|
|
391
|
-
* freely, since a plain string is a complete answer for any language.
|
|
392
|
-
*
|
|
393
|
-
*/
|
|
394
|
-
export interface ListOfLink {
|
|
395
|
-
itemType: "Link";
|
|
396
|
-
fallbackLanguage?: string;
|
|
397
|
-
items: [
|
|
398
|
-
/**
|
|
399
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
400
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
401
|
-
* owns the language tabs for every row.
|
|
402
|
-
*
|
|
403
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
404
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
405
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
406
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
407
|
-
*
|
|
408
|
-
*/
|
|
409
|
-
LinkFields,
|
|
410
|
-
.../**
|
|
411
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
412
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
413
|
-
* owns the language tabs for every row.
|
|
414
|
-
*
|
|
415
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
416
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
417
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
418
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
419
|
-
*
|
|
420
|
-
*/
|
|
421
|
-
LinkFields[]
|
|
422
|
-
];
|
|
423
|
-
}
|
|
424
|
-
export interface ListOfNumber {
|
|
425
|
-
itemType: "Number";
|
|
426
|
-
items: [
|
|
427
|
-
number,
|
|
428
|
-
...number[]
|
|
429
|
-
];
|
|
430
|
-
}
|
|
431
|
-
export interface ListOfText {
|
|
432
|
-
itemType: "Text";
|
|
433
|
-
items: [
|
|
434
|
-
string,
|
|
435
|
-
...string[]
|
|
436
|
-
];
|
|
437
|
-
}
|
|
438
|
-
/**
|
|
439
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
440
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
441
|
-
*
|
|
442
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
443
|
-
* server enforces this, and it is not expressible per-property here.
|
|
444
|
-
*
|
|
445
|
-
*/
|
|
446
|
-
export type ListValue = /**
|
|
447
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
448
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
449
|
-
*
|
|
450
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
451
|
-
* server enforces this, and it is not expressible per-property here.
|
|
452
|
-
*
|
|
453
|
-
*/
|
|
454
|
-
ListOfText | ListOfNumber | ListOfBoolean | ListOfJson | /**
|
|
455
|
-
* A list of links. `fallbackLanguage` applies to every item's translated
|
|
456
|
-
* `label` and `description`; items may mix plain and translated fields
|
|
457
|
-
* freely, since a plain string is a complete answer for any language.
|
|
458
|
-
*
|
|
459
|
-
*/
|
|
460
|
-
ListOfLink;
|
|
461
298
|
/**
|
|
462
299
|
* One entry of a Map. `key` is the token a journey submits; `value` is
|
|
463
300
|
* what the customer reads — either one string, or one string per
|
|
@@ -829,17 +666,9 @@ type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
|
|
|
829
666
|
type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
|
|
830
667
|
type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
|
|
831
668
|
type JsonValue = Components.Schemas.JsonValue;
|
|
832
|
-
type LinkFields = Components.Schemas.LinkFields;
|
|
833
669
|
type LinkValue = Components.Schemas.LinkValue;
|
|
834
|
-
type ListItemType = Components.Schemas.ListItemType;
|
|
835
|
-
type ListOfBoolean = Components.Schemas.ListOfBoolean;
|
|
836
|
-
type ListOfJson = Components.Schemas.ListOfJson;
|
|
837
|
-
type ListOfLink = Components.Schemas.ListOfLink;
|
|
838
|
-
type ListOfNumber = Components.Schemas.ListOfNumber;
|
|
839
|
-
type ListOfText = Components.Schemas.ListOfText;
|
|
840
|
-
type ListValue = Components.Schemas.ListValue;
|
|
841
670
|
type MapEntry = Components.Schemas.MapEntry;
|
|
842
671
|
type MapValue = Components.Schemas.MapValue;
|
|
843
672
|
type StringTranslations = Components.Schemas.StringTranslations;
|
|
844
673
|
|
|
845
|
-
export { type Client as C, type EnvironmentGroup as E, type JsonValue as J, type
|
|
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 };
|
|
@@ -20,17 +20,15 @@ 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
|
|
24
|
-
*
|
|
25
|
-
* round-trip.
|
|
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.
|
|
26
25
|
*
|
|
27
26
|
*/
|
|
28
27
|
export type EnvironmentValue = /**
|
|
29
28
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
30
29
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
31
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
32
|
-
*
|
|
33
|
-
* round-trip.
|
|
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.
|
|
34
32
|
*
|
|
35
33
|
*/
|
|
36
34
|
string | number | boolean | MapValue | /**
|
|
@@ -61,28 +59,20 @@ declare namespace Components {
|
|
|
61
59
|
* does not itself declare it.
|
|
62
60
|
*
|
|
63
61
|
*/
|
|
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;
|
|
62
|
+
LinkValue;
|
|
73
63
|
/**
|
|
74
64
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
75
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
76
|
-
*
|
|
65
|
+
* 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.
|
|
77
67
|
*
|
|
78
68
|
*/
|
|
79
|
-
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
69
|
+
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
80
70
|
export interface EnvironmentVariable {
|
|
81
71
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
82
72
|
type: /**
|
|
83
73
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
84
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
85
|
-
*
|
|
74
|
+
* 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.
|
|
86
76
|
*
|
|
87
77
|
*/
|
|
88
78
|
EnvironmentValueType;
|
|
@@ -131,15 +121,7 @@ declare namespace Components {
|
|
|
131
121
|
* does not itself declare it.
|
|
132
122
|
*
|
|
133
123
|
*/
|
|
134
|
-
LinkValue
|
|
135
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
136
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
137
|
-
*
|
|
138
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
139
|
-
* server enforces this, and it is not expressible per-property here.
|
|
140
|
-
*
|
|
141
|
-
*/
|
|
142
|
-
ListValue;
|
|
124
|
+
LinkValue;
|
|
143
125
|
/**
|
|
144
126
|
* Whether the variable is protected from editing
|
|
145
127
|
*/
|
|
@@ -151,8 +133,8 @@ declare namespace Components {
|
|
|
151
133
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
152
134
|
type: /**
|
|
153
135
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
154
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
155
|
-
*
|
|
136
|
+
* 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.
|
|
156
138
|
*
|
|
157
139
|
*/
|
|
158
140
|
EnvironmentValueType;
|
|
@@ -161,9 +143,8 @@ declare namespace Components {
|
|
|
161
143
|
value?: /**
|
|
162
144
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
163
145
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
164
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
165
|
-
*
|
|
166
|
-
* round-trip.
|
|
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.
|
|
167
148
|
*
|
|
168
149
|
*/
|
|
169
150
|
EnvironmentValue;
|
|
@@ -179,8 +160,8 @@ declare namespace Components {
|
|
|
179
160
|
key: string;
|
|
180
161
|
type: /**
|
|
181
162
|
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
182
|
-
* its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON
|
|
183
|
-
*
|
|
163
|
+
* 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.
|
|
184
165
|
*
|
|
185
166
|
*/
|
|
186
167
|
EnvironmentValueType;
|
|
@@ -229,15 +210,7 @@ declare namespace Components {
|
|
|
229
210
|
* does not itself declare it.
|
|
230
211
|
*
|
|
231
212
|
*/
|
|
232
|
-
LinkValue
|
|
233
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
234
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
235
|
-
*
|
|
236
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
237
|
-
* server enforces this, and it is not expressible per-property here.
|
|
238
|
-
*
|
|
239
|
-
*/
|
|
240
|
-
ListValue;
|
|
213
|
+
LinkValue;
|
|
241
214
|
/**
|
|
242
215
|
* Whether the variable is protected from editing
|
|
243
216
|
*/
|
|
@@ -249,13 +222,12 @@ declare namespace Components {
|
|
|
249
222
|
/**
|
|
250
223
|
* Type of variable. Used when creating a new variable. Defaults to String.
|
|
251
224
|
*/
|
|
252
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
225
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link";
|
|
253
226
|
value?: /**
|
|
254
227
|
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
255
228
|
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
256
|
-
* `Boolean` is a boolean, and `Map`, `JSON
|
|
257
|
-
*
|
|
258
|
-
* round-trip.
|
|
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.
|
|
259
231
|
*
|
|
260
232
|
*/
|
|
261
233
|
EnvironmentValue;
|
|
@@ -274,42 +246,6 @@ declare namespace Components {
|
|
|
274
246
|
export interface JsonValue {
|
|
275
247
|
[name: string]: any;
|
|
276
248
|
}
|
|
277
|
-
/**
|
|
278
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
279
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
280
|
-
* owns the language tabs for every row.
|
|
281
|
-
*
|
|
282
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
283
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
284
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
285
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
286
|
-
*
|
|
287
|
-
*/
|
|
288
|
-
export interface LinkFields {
|
|
289
|
-
url: string;
|
|
290
|
-
label: string | /**
|
|
291
|
-
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
292
|
-
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
293
|
-
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
294
|
-
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
295
|
-
* not otherwise linked. The pattern is documented rather than declared
|
|
296
|
-
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
297
|
-
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
298
|
-
*
|
|
299
|
-
*/
|
|
300
|
-
StringTranslations;
|
|
301
|
-
description?: string | /**
|
|
302
|
-
* A string translated per language. Keys are language codes (e.g. `de`,
|
|
303
|
-
* `en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses
|
|
304
|
-
* everywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces
|
|
305
|
-
* that with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are
|
|
306
|
-
* not otherwise linked. The pattern is documented rather than declared
|
|
307
|
-
* because `propertyNames` is JSON Schema / OAS 3.1 and this document is
|
|
308
|
-
* 3.0.3, where it fails `spectral lint` (oas3-schema).
|
|
309
|
-
*
|
|
310
|
-
*/
|
|
311
|
-
StringTranslations;
|
|
312
|
-
}
|
|
313
249
|
/**
|
|
314
250
|
* One URL with a label and description a customer reads. `label` and
|
|
315
251
|
* `description` are each either a plain string or one string per language;
|
|
@@ -359,105 +295,6 @@ declare namespace Components {
|
|
|
359
295
|
StringTranslations;
|
|
360
296
|
fallbackLanguage?: string;
|
|
361
297
|
}
|
|
362
|
-
/**
|
|
363
|
-
* The element type a `List` holds. `String` and `SecretString` are absent
|
|
364
|
-
* deliberately: they are the two types never served to browser-facing
|
|
365
|
-
* consumers, and a `List` is. `Map` is already a keyed collection, and a
|
|
366
|
-
* list of lists has no consumer.
|
|
367
|
-
*
|
|
368
|
-
*/
|
|
369
|
-
export type ListItemType = "Text" | "Number" | "Boolean" | "JSON" | "Link";
|
|
370
|
-
export interface ListOfBoolean {
|
|
371
|
-
itemType: "Boolean";
|
|
372
|
-
items: [
|
|
373
|
-
boolean,
|
|
374
|
-
...boolean[]
|
|
375
|
-
];
|
|
376
|
-
}
|
|
377
|
-
export interface ListOfJson {
|
|
378
|
-
itemType: "JSON";
|
|
379
|
-
items: [
|
|
380
|
-
{
|
|
381
|
-
[name: string]: any;
|
|
382
|
-
},
|
|
383
|
-
...{
|
|
384
|
-
[name: string]: any;
|
|
385
|
-
}[]
|
|
386
|
-
];
|
|
387
|
-
}
|
|
388
|
-
/**
|
|
389
|
-
* A list of links. `fallbackLanguage` applies to every item's translated
|
|
390
|
-
* `label` and `description`; items may mix plain and translated fields
|
|
391
|
-
* freely, since a plain string is a complete answer for any language.
|
|
392
|
-
*
|
|
393
|
-
*/
|
|
394
|
-
export interface ListOfLink {
|
|
395
|
-
itemType: "Link";
|
|
396
|
-
fallbackLanguage?: string;
|
|
397
|
-
items: [
|
|
398
|
-
/**
|
|
399
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
400
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
401
|
-
* owns the language tabs for every row.
|
|
402
|
-
*
|
|
403
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
404
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
405
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
406
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
407
|
-
*
|
|
408
|
-
*/
|
|
409
|
-
LinkFields,
|
|
410
|
-
.../**
|
|
411
|
-
* The fields of a link, without a fallback language — the shape a `List`
|
|
412
|
-
* item carries. Inside a list the fallback belongs to the wrapper, which
|
|
413
|
-
* owns the language tabs for every row.
|
|
414
|
-
*
|
|
415
|
-
* Restated rather than composed with `LinkValue`: `allOf` plus
|
|
416
|
-
* `additionalProperties: false` is rejected by most validators, because
|
|
417
|
-
* each branch sees the sibling's properties as unknown. zod composes
|
|
418
|
-
* properly — see LinkFieldsSchema in src/core/value-types.ts.
|
|
419
|
-
*
|
|
420
|
-
*/
|
|
421
|
-
LinkFields[]
|
|
422
|
-
];
|
|
423
|
-
}
|
|
424
|
-
export interface ListOfNumber {
|
|
425
|
-
itemType: "Number";
|
|
426
|
-
items: [
|
|
427
|
-
number,
|
|
428
|
-
...number[]
|
|
429
|
-
];
|
|
430
|
-
}
|
|
431
|
-
export interface ListOfText {
|
|
432
|
-
itemType: "Text";
|
|
433
|
-
items: [
|
|
434
|
-
string,
|
|
435
|
-
...string[]
|
|
436
|
-
];
|
|
437
|
-
}
|
|
438
|
-
/**
|
|
439
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
440
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
441
|
-
*
|
|
442
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
443
|
-
* server enforces this, and it is not expressible per-property here.
|
|
444
|
-
*
|
|
445
|
-
*/
|
|
446
|
-
export type ListValue = /**
|
|
447
|
-
* An ordered collection of one declared element type. Items round-trip in
|
|
448
|
-
* the order written; nothing sorts them. Holds at most 100 items.
|
|
449
|
-
*
|
|
450
|
-
* The whole value is limited to 32768 characters when serialised — the
|
|
451
|
-
* server enforces this, and it is not expressible per-property here.
|
|
452
|
-
*
|
|
453
|
-
*/
|
|
454
|
-
ListOfText | ListOfNumber | ListOfBoolean | ListOfJson | /**
|
|
455
|
-
* A list of links. `fallbackLanguage` applies to every item's translated
|
|
456
|
-
* `label` and `description`; items may mix plain and translated fields
|
|
457
|
-
* freely, since a plain string is a complete answer for any language.
|
|
458
|
-
*
|
|
459
|
-
*/
|
|
460
|
-
ListOfLink;
|
|
461
298
|
/**
|
|
462
299
|
* One entry of a Map. `key` is the token a journey submits; `value` is
|
|
463
300
|
* what the customer reads — either one string, or one string per
|
|
@@ -829,17 +666,9 @@ type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
|
|
|
829
666
|
type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
|
|
830
667
|
type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
|
|
831
668
|
type JsonValue = Components.Schemas.JsonValue;
|
|
832
|
-
type LinkFields = Components.Schemas.LinkFields;
|
|
833
669
|
type LinkValue = Components.Schemas.LinkValue;
|
|
834
|
-
type ListItemType = Components.Schemas.ListItemType;
|
|
835
|
-
type ListOfBoolean = Components.Schemas.ListOfBoolean;
|
|
836
|
-
type ListOfJson = Components.Schemas.ListOfJson;
|
|
837
|
-
type ListOfLink = Components.Schemas.ListOfLink;
|
|
838
|
-
type ListOfNumber = Components.Schemas.ListOfNumber;
|
|
839
|
-
type ListOfText = Components.Schemas.ListOfText;
|
|
840
|
-
type ListValue = Components.Schemas.ListValue;
|
|
841
670
|
type MapEntry = Components.Schemas.MapEntry;
|
|
842
671
|
type MapValue = Components.Schemas.MapValue;
|
|
843
672
|
type StringTranslations = Components.Schemas.StringTranslations;
|
|
844
673
|
|
|
845
|
-
export { type Client as C, type EnvironmentGroup as E, type JsonValue as J, type
|
|
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 };
|