@epilot/sdk 2.3.1 → 2.3.4
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/README.md +1 -0
- package/definitions/data-management-runtime.json +1 -0
- package/definitions/data-management.json +972 -0
- package/definitions/environments-runtime.json +1 -1
- package/definitions/environments.json +183 -7
- package/definitions/erp-integration-runtime.json +1 -0
- package/definitions/erp-integration.json +6780 -0
- package/definitions/query-runtime.json +1 -0
- package/definitions/query.json +3178 -0
- package/definitions/target-runtime.json +1 -0
- package/definitions/target.json +609 -0
- package/dist/README-6UYTPMQO.cjs +7 -0
- package/dist/README-GS3DFP4W.js +7 -0
- package/dist/{_index-O7JDGRSE.cjs → _index-LZFTZV7Z.cjs} +4 -1
- package/dist/{_index-CLT2KTVS.js → _index-X3IADTN2.js} +3 -0
- 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/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 +8 -8
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- package/dist/apis/environments.js +2 -2
- 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 +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +38 -0
- package/dist/apis/query.d.cts +18 -0
- package/dist/apis/query.d.ts +18 -0
- package/dist/apis/{erp-integration.js → query.js} +11 -11
- 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/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +38 -0
- package/dist/apis/target.d.cts +597 -0
- package/dist/apis/target.d.ts +597 -0
- package/dist/apis/target.js +38 -0
- 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.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-2LEEXRJX.js +14 -0
- package/dist/chunk-EYKEVZME.cjs +14 -0
- package/dist/{chunk-TXDVGTQD.cjs → chunk-I6DG26UJ.cjs} +1 -1
- package/dist/{chunk-TKTSGA7G.cjs → chunk-LS3ISLMD.cjs} +9 -5
- package/dist/chunk-MM5JDJFO.js +14 -0
- package/dist/chunk-RMP2HHCR.js +14 -0
- package/dist/chunk-XDZ2JKJ4.cjs +14 -0
- package/dist/{chunk-QSEIJWJW.js → chunk-YVN2SRSQ.js} +9 -5
- package/dist/environments-PXJOTQVM.js +7 -0
- package/dist/environments-QJ4UMJ5C.cjs +7 -0
- package/dist/{environments-runtime-BPR47PW7.js → environments-runtime-NKHLZJB3.js} +1 -1
- package/dist/{environments-runtime-L6TJCVW6.cjs → environments-runtime-QC2BUHBW.cjs} +2 -2
- package/dist/{environments.d-H3LK_KuH.d.cts → environments.d-BvqvN-PD.d.cts} +134 -5
- package/dist/{environments.d-H3LK_KuH.d.ts → environments.d-BvqvN-PD.d.ts} +134 -5
- package/dist/erp-integration-runtime-JGVGQ22V.js +13 -0
- package/dist/erp-integration-runtime-OZ4YSTQX.cjs +13 -0
- package/dist/index.cjs +26 -18
- package/dist/index.d.cts +23 -21
- package/dist/index.d.ts +23 -21
- package/dist/index.js +19 -11
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/dist/query-JSDB2F2U.cjs +7 -0
- package/dist/query-RJ4M25PA.js +7 -0
- package/dist/query-runtime-NLOSMDAJ.cjs +5 -0
- package/dist/query-runtime-SYJTDUNG.js +5 -0
- package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
- package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
- package/dist/target-3RS5BN2B.cjs +7 -0
- package/dist/target-5MKRXCHX.js +7 -0
- package/dist/target-runtime-BMJ7EARM.cjs +5 -0
- package/dist/target-runtime-PBF3WYL7.js +5 -0
- package/docs/environments.md +127 -3
- package/docs/query.md +1609 -0
- package/docs/target.md +741 -0
- package/package.json +10 -1
- package/dist/README-KX4XC2HB.js +0 -7
- package/dist/README-PTYV6PQI.cjs +0 -7
- package/dist/apis/erp-integration.cjs +0 -38
- package/dist/apis/erp-integration.d.cts +0 -5770
- package/dist/apis/erp-integration.d.ts +0 -5770
- package/dist/chunk-6OYECNL2.js +0 -14
- package/dist/chunk-MUNMUGB5.js +0 -14
- package/dist/chunk-TLH6XOTL.cjs +0 -14
- package/dist/environments-E3X6NYGX.js +0 -7
- package/dist/environments-P2JS4F5N.cjs +0 -7
- package/dist/erp-integration-runtime-BHHWMG4O.js +0 -5
- package/dist/erp-integration-runtime-Y6VWGQ3L.cjs +0 -5
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/target.json
|
|
4
|
+
var target_default = '# Target API\n\n- **Base URL:** `https://target.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/target](https://docs.epilot.io/api/target)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.target.createTarget(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/target\'\n\nconst targetClient = getClient()\nauthorize(targetClient, () => \'<token>\')\nconst { data } = await targetClient.createTarget(...)\n```\n\n## Operations\n\n**Target**\n- [`createTarget`](#createtarget)\n- [`getTarget`](#gettarget)\n- [`deleteTarget`](#deletetarget)\n- [`patchTarget`](#patchtarget)\n- [`updateTarget`](#updatetarget)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseTags`](#basetags)\n- [`BasePurpose`](#basepurpose)\n- [`BaseRelation`](#baserelation)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemReadonlyFields`](#basesystemreadonlyfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`BaseTarget`](#basetarget)\n- [`BaseTargetRequired`](#basetargetrequired)\n- [`Target`](#target)\n- [`TargetCreate`](#targetcreate)\n- [`TargetPatch`](#targetpatch)\n\n### `createTarget`\n\nCreate a new target entity\n\n`POST /v1/target`\n\n```ts\nconst { data } = await client.createTarget(\n null,\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `getTarget`\n\nRead a specific target entity by a given id\n\n`GET /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.getTarget({\n targetId: \'example\',\n hydrate: true,\n strict: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `deleteTarget`\n\nDelete a specific target entity by a given id\n\n`DELETE /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.deleteTarget({\n targetId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `patchTarget`\n\nPartially update a specific target entity\'s properties by a given id and a given payload\n\n`PATCH /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.patchTarget(\n {\n targetId: \'example\',\n },\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `updateTarget`\n\nCompletly replace a specific target entity\'s properties by a given id and a given payload\n\n`PUT /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.updateTarget(\n {\n targetId: \'example\',\n },\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n status: number\n message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n status: number\n message: string\n}\n```\n\n### `ClientError`\n\n```ts\ntype ClientError = {\n status: number\n message: string\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BasePurpose`\n\n```ts\ntype BasePurpose = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n $relation?: Array<{\n entity_id?: string // uuid\n _tags?: string[]\n }>\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `BaseSystemReadonlyFields`\n\n```ts\ntype BaseSystemReadonlyFields = {\n _id?: string // uuid\n _schema?: string\n _org?: string\n _tags?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _title?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `BaseTarget`\n\n```ts\ntype BaseTarget = {\n _schema?: "target"\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n}\n```\n\n### `BaseTargetRequired`\n\n```ts\ntype BaseTargetRequired = object\n```\n\n### `Target`\n\n```ts\ntype Target = {\n _id?: string // uuid\n _schema: "target"\n _org: string\n _tags?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _title?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _purpose?: string[]\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `TargetCreate`\n\n```ts\ntype TargetCreate = {\n _schema?: "target"\n name: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `TargetPatch`\n\n```ts\ntype TargetPatch = {\n _schema?: "target"\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = target_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/target.json
|
|
4
|
+
var target_default = '# Target API\n\n- **Base URL:** `https://target.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/target](https://docs.epilot.io/api/target)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.target.createTarget(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/target\'\n\nconst targetClient = getClient()\nauthorize(targetClient, () => \'<token>\')\nconst { data } = await targetClient.createTarget(...)\n```\n\n## Operations\n\n**Target**\n- [`createTarget`](#createtarget)\n- [`getTarget`](#gettarget)\n- [`deleteTarget`](#deletetarget)\n- [`patchTarget`](#patchtarget)\n- [`updateTarget`](#updatetarget)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseTags`](#basetags)\n- [`BasePurpose`](#basepurpose)\n- [`BaseRelation`](#baserelation)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemReadonlyFields`](#basesystemreadonlyfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`BaseTarget`](#basetarget)\n- [`BaseTargetRequired`](#basetargetrequired)\n- [`Target`](#target)\n- [`TargetCreate`](#targetcreate)\n- [`TargetPatch`](#targetpatch)\n\n### `createTarget`\n\nCreate a new target entity\n\n`POST /v1/target`\n\n```ts\nconst { data } = await client.createTarget(\n null,\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `getTarget`\n\nRead a specific target entity by a given id\n\n`GET /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.getTarget({\n targetId: \'example\',\n hydrate: true,\n strict: true,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `deleteTarget`\n\nDelete a specific target entity by a given id\n\n`DELETE /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.deleteTarget({\n targetId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `patchTarget`\n\nPartially update a specific target entity\'s properties by a given id and a given payload\n\n`PATCH /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.patchTarget(\n {\n targetId: \'example\',\n },\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n### `updateTarget`\n\nCompletly replace a specific target entity\'s properties by a given id and a given payload\n\n`PUT /v1/target/{targetId}`\n\n```ts\nconst { data } = await client.updateTarget(\n {\n targetId: \'example\',\n },\n {\n _schema: \'target\',\n name: \'string\',\n description: \'string\',\n entity_schema: \'string\',\n entity_filters: {\n filter: {\n items: [\n {\n key: \'string\',\n operator: \'string\',\n value: \'string\'\n }\n ],\n combination: \'string\'\n }\n },\n _tags: [\'string\'],\n _purpose: [\'string\'],\n _files: {\n $relation: [\n {\n entity_id: \'123e4567-e89b-12d3-a456-426614174000\',\n _tags: [\'string\']\n }\n ]\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n __additional: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_id": "123e4567-e89b-12d3-a456-426614174000",\n "_schema": "target",\n "_org": "string",\n "_tags": ["string"],\n "_files": {\n "$relation": [\n {\n "entity_id": "123e4567-e89b-12d3-a456-426614174000",\n "_tags": ["string"]\n }\n ]\n },\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_title": "string",\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {\n "filter": {\n "items": [\n {\n "key": "string",\n "operator": "string",\n "value": "string"\n }\n ],\n "combination": "string"\n }\n },\n "_purpose": ["string"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "__additional": {}\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n status: number\n message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n status: number\n message: string\n}\n```\n\n### `ClientError`\n\n```ts\ntype ClientError = {\n status: number\n message: string\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BasePurpose`\n\n```ts\ntype BasePurpose = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n $relation?: Array<{\n entity_id?: string // uuid\n _tags?: string[]\n }>\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `BaseSystemReadonlyFields`\n\n```ts\ntype BaseSystemReadonlyFields = {\n _id?: string // uuid\n _schema?: string\n _org?: string\n _tags?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _title?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `BaseTarget`\n\n```ts\ntype BaseTarget = {\n _schema?: "target"\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n}\n```\n\n### `BaseTargetRequired`\n\n```ts\ntype BaseTargetRequired = object\n```\n\n### `Target`\n\n```ts\ntype Target = {\n _id?: string // uuid\n _schema: "target"\n _org: string\n _tags?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _title?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _purpose?: string[]\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `TargetCreate`\n\n```ts\ntype TargetCreate = {\n _schema?: "target"\n name: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n\n### `TargetPatch`\n\n```ts\ntype TargetPatch = {\n _schema?: "target"\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: {\n filter?: {\n items?: { ... }\n combination?: { ... }\n }\n }\n _tags?: string[]\n _purpose?: string[]\n _files?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n _manifest?: string // uuid[]\n __additional?: Record<string, unknown>\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
target_default as default
|
|
7
|
+
};
|
package/docs/environments.md
CHANGED
|
@@ -27,6 +27,9 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
27
27
|
**environments**
|
|
28
28
|
- [`listEnvironmentVariables`](#listenvironmentvariables)
|
|
29
29
|
- [`createEnvironmentVariable`](#createenvironmentvariable)
|
|
30
|
+
- [`listEnvironmentGroups`](#listenvironmentgroups)
|
|
31
|
+
- [`putEnvironmentGroup`](#putenvironmentgroup)
|
|
32
|
+
- [`deleteEnvironmentGroup`](#deleteenvironmentgroup)
|
|
30
33
|
- [`getEnvironmentVariable`](#getenvironmentvariable)
|
|
31
34
|
- [`updateEnvironmentVariable`](#updateenvironmentvariable)
|
|
32
35
|
- [`deleteEnvironmentVariable`](#deleteenvironmentvariable)
|
|
@@ -38,6 +41,9 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
38
41
|
- [`EnvironmentVariableList`](#environmentvariablelist)
|
|
39
42
|
- [`EnvironmentVariableCreateRequest`](#environmentvariablecreaterequest)
|
|
40
43
|
- [`EnvironmentVariableUpdateRequest`](#environmentvariableupdaterequest)
|
|
44
|
+
- [`EnvironmentGroup`](#environmentgroup)
|
|
45
|
+
- [`EnvironmentGroupList`](#environmentgrouplist)
|
|
46
|
+
- [`EnvironmentGroupUpsertRequest`](#environmentgroupupsertrequest)
|
|
41
47
|
|
|
42
48
|
### `listEnvironmentVariables`
|
|
43
49
|
|
|
@@ -59,6 +65,7 @@ const { data } = await client.listEnvironmentVariables()
|
|
|
59
65
|
"key": "string",
|
|
60
66
|
"type": "String",
|
|
61
67
|
"description": "string",
|
|
68
|
+
"group": "string",
|
|
62
69
|
"value": "string",
|
|
63
70
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
64
71
|
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
@@ -84,6 +91,7 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
84
91
|
key: 'string',
|
|
85
92
|
type: 'String',
|
|
86
93
|
description: 'string',
|
|
94
|
+
group: 'string',
|
|
87
95
|
value: 'string'
|
|
88
96
|
},
|
|
89
97
|
)
|
|
@@ -97,6 +105,7 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
97
105
|
"key": "string",
|
|
98
106
|
"type": "String",
|
|
99
107
|
"description": "string",
|
|
108
|
+
"group": "string",
|
|
100
109
|
"value": "string",
|
|
101
110
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
102
111
|
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
@@ -107,6 +116,81 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
107
116
|
|
|
108
117
|
---
|
|
109
118
|
|
|
119
|
+
### `listEnvironmentGroups`
|
|
120
|
+
|
|
121
|
+
List environment groups
|
|
122
|
+
|
|
123
|
+
`GET /v1/environments/groups`
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
const { data } = await client.listEnvironmentGroups()
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
<details>
|
|
130
|
+
<summary>Response</summary>
|
|
131
|
+
|
|
132
|
+
```json
|
|
133
|
+
{
|
|
134
|
+
"items": [
|
|
135
|
+
{
|
|
136
|
+
"name": "string",
|
|
137
|
+
"description": "string",
|
|
138
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
139
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
140
|
+
}
|
|
141
|
+
]
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
</details>
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
### `putEnvironmentGroup`
|
|
150
|
+
|
|
151
|
+
`PUT /v1/environments/groups/{name}`
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
const { data } = await client.putEnvironmentGroup(
|
|
155
|
+
{
|
|
156
|
+
name: 'example',
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
description: 'string'
|
|
160
|
+
},
|
|
161
|
+
)
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
<details>
|
|
165
|
+
<summary>Response</summary>
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
{
|
|
169
|
+
"name": "string",
|
|
170
|
+
"description": "string",
|
|
171
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
172
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
</details>
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
### `deleteEnvironmentGroup`
|
|
181
|
+
|
|
182
|
+
Delete an environment group
|
|
183
|
+
|
|
184
|
+
`DELETE /v1/environments/groups/{name}`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
const { data } = await client.deleteEnvironmentGroup({
|
|
188
|
+
name: 'example',
|
|
189
|
+
})
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
110
194
|
### `getEnvironmentVariable`
|
|
111
195
|
|
|
112
196
|
Get environment variable
|
|
@@ -127,6 +211,7 @@ const { data } = await client.getEnvironmentVariable({
|
|
|
127
211
|
"key": "string",
|
|
128
212
|
"type": "String",
|
|
129
213
|
"description": "string",
|
|
214
|
+
"group": "string",
|
|
130
215
|
"value": "string",
|
|
131
216
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
132
217
|
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
@@ -151,7 +236,8 @@ const { data } = await client.updateEnvironmentVariable(
|
|
|
151
236
|
{
|
|
152
237
|
type: 'String',
|
|
153
238
|
value: 'string',
|
|
154
|
-
description: 'string'
|
|
239
|
+
description: 'string',
|
|
240
|
+
group: 'string'
|
|
155
241
|
},
|
|
156
242
|
)
|
|
157
243
|
```
|
|
@@ -164,6 +250,7 @@ const { data } = await client.updateEnvironmentVariable(
|
|
|
164
250
|
"key": "string",
|
|
165
251
|
"type": "String",
|
|
166
252
|
"description": "string",
|
|
253
|
+
"group": "string",
|
|
167
254
|
"value": "string",
|
|
168
255
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
169
256
|
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
@@ -203,6 +290,7 @@ type EnvironmentVariable = {
|
|
|
203
290
|
key: string
|
|
204
291
|
type: "String" | "SecretString"
|
|
205
292
|
description?: string
|
|
293
|
+
group?: string
|
|
206
294
|
value?: string
|
|
207
295
|
created_at: string // date-time
|
|
208
296
|
updated_at: string // date-time
|
|
@@ -216,6 +304,7 @@ type EnvironmentVariableListItem = {
|
|
|
216
304
|
key: string
|
|
217
305
|
type: "String" | "SecretString"
|
|
218
306
|
description?: string
|
|
307
|
+
group?: string
|
|
219
308
|
value?: string
|
|
220
309
|
created_at: string // date-time
|
|
221
310
|
updated_at: string // date-time
|
|
@@ -230,6 +319,7 @@ type EnvironmentVariableList = {
|
|
|
230
319
|
key: string
|
|
231
320
|
type: "String" | "SecretString"
|
|
232
321
|
description?: string
|
|
322
|
+
group?: string
|
|
233
323
|
value?: string
|
|
234
324
|
created_at: string // date-time
|
|
235
325
|
updated_at: string // date-time
|
|
@@ -244,7 +334,8 @@ type EnvironmentVariableCreateRequest = {
|
|
|
244
334
|
key: string
|
|
245
335
|
type: "String" | "SecretString"
|
|
246
336
|
description?: string
|
|
247
|
-
|
|
337
|
+
group?: string
|
|
338
|
+
value?: string
|
|
248
339
|
}
|
|
249
340
|
```
|
|
250
341
|
|
|
@@ -253,7 +344,40 @@ type EnvironmentVariableCreateRequest = {
|
|
|
253
344
|
```ts
|
|
254
345
|
type EnvironmentVariableUpdateRequest = {
|
|
255
346
|
type?: "String" | "SecretString"
|
|
256
|
-
value
|
|
347
|
+
value?: string
|
|
348
|
+
description?: string
|
|
349
|
+
group?: string
|
|
350
|
+
}
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### `EnvironmentGroup`
|
|
354
|
+
|
|
355
|
+
```ts
|
|
356
|
+
type EnvironmentGroup = {
|
|
357
|
+
name: string
|
|
358
|
+
description?: string
|
|
359
|
+
created_at: string // date-time
|
|
360
|
+
updated_at: string // date-time
|
|
361
|
+
}
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### `EnvironmentGroupList`
|
|
365
|
+
|
|
366
|
+
```ts
|
|
367
|
+
type EnvironmentGroupList = {
|
|
368
|
+
items: Array<{
|
|
369
|
+
name: string
|
|
370
|
+
description?: string
|
|
371
|
+
created_at: string // date-time
|
|
372
|
+
updated_at: string // date-time
|
|
373
|
+
}>
|
|
374
|
+
}
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### `EnvironmentGroupUpsertRequest`
|
|
378
|
+
|
|
379
|
+
```ts
|
|
380
|
+
type EnvironmentGroupUpsertRequest = {
|
|
257
381
|
description?: string
|
|
258
382
|
}
|
|
259
383
|
```
|