@epilot/sdk 2.3.2 → 2.3.5
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 +2 -0
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +239 -12
- package/definitions/configuration-hub-runtime.json +1 -0
- package/definitions/configuration-hub.json +399 -0
- package/definitions/environments-runtime.json +1 -1
- package/definitions/environments.json +2 -2
- package/definitions/query-runtime.json +1 -0
- package/definitions/query.json +3178 -0
- package/dist/README-6MG272KM.cjs +7 -0
- package/dist/README-7N542PBL.js +7 -0
- package/dist/{_index-O7JDGRSE.cjs → _index-55HAH24D.cjs} +7 -1
- package/dist/{_index-CLT2KTVS.js → _index-HE4B6FOA.js} +6 -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 +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/configuration-hub.cjs +38 -0
- package/dist/apis/configuration-hub.d.cts +18 -0
- package/dist/apis/configuration-hub.d.ts +18 -0
- package/dist/apis/configuration-hub.js +38 -0
- 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/query.js +38 -0
- 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/blueprint-manifest-DBEY5PPI.js +7 -0
- package/dist/blueprint-manifest-IEQ6YBY7.cjs +7 -0
- package/dist/{blueprint-manifest-runtime-E2FN43TB.js → blueprint-manifest-runtime-5UN52LW5.js} +1 -1
- package/dist/{blueprint-manifest-runtime-G4UK5VEX.cjs → blueprint-manifest-runtime-QN2IECSA.cjs} +2 -2
- package/dist/{blueprint-manifest.d-BGrGU787.d.cts → blueprint-manifest.d-BPyzoR0X.d.cts} +228 -9
- package/dist/{blueprint-manifest.d-BGrGU787.d.ts → blueprint-manifest.d-BPyzoR0X.d.ts} +228 -9
- package/dist/{chunk-6IMAKHA4.js → chunk-2LEEXRJX.js} +1 -1
- package/dist/chunk-4JAOFRYX.js +14 -0
- package/dist/{chunk-5JN243WJ.js → chunk-7C4FQXMS.js} +12 -6
- package/dist/chunk-EYKEVZME.cjs +14 -0
- package/dist/{chunk-VTJQTEQX.cjs → chunk-GGMGJYHO.cjs} +12 -6
- package/dist/{chunk-BDKLBHIN.cjs → chunk-I6DG26UJ.cjs} +1 -1
- package/dist/{chunk-5APJZUIH.cjs → chunk-L544VG3B.cjs} +1 -1
- package/dist/chunk-MM5JDJFO.js +14 -0
- package/dist/{chunk-VPDA5SAH.js → chunk-O2YVXGPZ.js} +1 -1
- package/dist/chunk-Q7OKRNUG.cjs +14 -0
- package/dist/chunk-RMP2HHCR.js +14 -0
- package/dist/chunk-XDZ2JKJ4.cjs +14 -0
- package/dist/configuration-hub-LKSRCGYT.cjs +7 -0
- package/dist/configuration-hub-TZ2ULWV4.js +7 -0
- package/dist/configuration-hub-runtime-B7KKIHHY.cjs +5 -0
- package/dist/configuration-hub-runtime-TEDEKI7E.js +5 -0
- package/dist/configuration-hub.d-CqvhcMOn.d.cts +166 -0
- package/dist/configuration-hub.d-CqvhcMOn.d.ts +166 -0
- package/dist/environments-PXJOTQVM.js +7 -0
- package/dist/environments-QJ4UMJ5C.cjs +7 -0
- package/dist/{environments-runtime-FMSNJF5S.js → environments-runtime-NKHLZJB3.js} +1 -1
- package/dist/{environments-runtime-5DVTRV2Z.cjs → environments-runtime-QC2BUHBW.cjs} +2 -2
- package/dist/{environments.d-H3LK_KuH.d.ts → environments.d-BvqvN-PD.d.cts} +134 -5
- package/dist/{environments.d-H3LK_KuH.d.cts → environments.d-BvqvN-PD.d.ts} +134 -5
- package/dist/index.cjs +43 -27
- package/dist/index.d.cts +81 -77
- package/dist/index.d.ts +81 -77
- package/dist/index.js +39 -23
- 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/blueprint-manifest.md +418 -40
- package/docs/configuration-hub.md +256 -0
- package/docs/environments.md +3 -5
- package/docs/query.md +1609 -0
- package/docs/target.md +741 -0
- package/package.json +19 -1
- package/dist/README-KX4XC2HB.js +0 -7
- package/dist/README-PTYV6PQI.cjs +0 -7
- package/dist/blueprint-manifest-ELK4SGN7.js +0 -7
- package/dist/blueprint-manifest-VBOWPK52.cjs +0 -7
- package/dist/environments-I6RWPVHA.js +0 -7
- package/dist/environments-TZYXLYXA.cjs +0 -7
|
@@ -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
|
+
};
|