@epilot/sdk 2.8.10 → 2.9.1
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/integration-toolkit.json +30 -5
- package/definitions/snapshot.json +3 -34
- 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.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.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- 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 +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.d.cts +2 -2
- package/dist/apis/snapshot.d.ts +2 -2
- 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.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/{chunk-OMZ2LWNR.cjs → chunk-6V3NYADA.cjs} +2 -2
- package/dist/{chunk-H5BH4GQQ.js → chunk-QGP5WMHK.js} +2 -2
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/integration-toolkit-334NGEOE.cjs +7 -0
- package/dist/integration-toolkit-5VCY6CUN.js +7 -0
- package/dist/{integration-toolkit.d-BW9RK5G-.d.cts → integration-toolkit.d-BSA9RRdq.d.cts} +22 -4
- package/dist/{integration-toolkit.d-BW9RK5G-.d.ts → integration-toolkit.d-BSA9RRdq.d.ts} +22 -4
- package/dist/snapshot-2HFERXRQ.js +7 -0
- package/dist/snapshot-UHCQAT4R.cjs +7 -0
- package/dist/{snapshot.d-CPTXg4xN.d.cts → snapshot.d-CqefmvuB.d.cts} +16 -43
- package/dist/{snapshot.d-CPTXg4xN.d.ts → snapshot.d-CqefmvuB.d.ts} +16 -43
- package/docs/integration-toolkit.md +13 -0
- package/docs/snapshot.md +9 -56
- package/package.json +1 -1
- package/dist/integration-toolkit-27Z3VZBZ.cjs +0 -7
- package/dist/integration-toolkit-NRLZZFVS.js +0 -7
- package/dist/snapshot-HFVQTHYF.cjs +0 -7
- package/dist/snapshot-Y6A7QUYS.js +0 -7
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/snapshot.json
|
|
4
|
+
var snapshot_default = '# Snapshot API\n\n- **Base URL:** `https://snapshot.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/snapshot](https://docs.epilot.io/api/snapshot)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.snapshot.createSnapshot(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/snapshot\'\n\nconst snapshotClient = getClient()\nauthorize(snapshotClient, () => \'<token>\')\nconst { data } = await snapshotClient.createSnapshot(...)\n```\n\n## Operations\n\n**Snapshots**\n- [`createSnapshot`](#createsnapshot)\n- [`listSnapshots`](#listsnapshots)\n- [`captureOrgSnapshot`](#captureorgsnapshot)\n- [`getSnapshot`](#getsnapshot)\n- [`deleteSnapshot`](#deletesnapshot)\n- [`restoreSnapshot`](#restoresnapshot)\n- [`listSnapshotResources`](#listsnapshotresources)\n- [`getSnapshotResource`](#getsnapshotresource)\n- [`listDependencies`](#listdependencies)\n\n**Schemas**\n- [`Error`](#error)\n- [`EmptyInventoryError`](#emptyinventoryerror)\n- [`ResourceRef`](#resourceref)\n- [`SnapshotResourceSummary`](#snapshotresourcesummary)\n- [`SnapshotResourceList`](#snapshotresourcelist)\n- [`SnapshotResourceDetail`](#snapshotresourcedetail)\n- [`CreateSnapshotRequest`](#createsnapshotrequest)\n- [`CreateOrgSnapshotRequest`](#createorgsnapshotrequest)\n- [`CreateSnapshotResponse`](#createsnapshotresponse)\n- [`RestoreSnapshotRequest`](#restoresnapshotrequest)\n- [`RestoreSnapshotResponse`](#restoresnapshotresponse)\n- [`Snapshot`](#snapshot)\n- [`Operation`](#operation)\n- [`CallerIdentity`](#calleridentity)\n\n### `createSnapshot`\n\nCreate a new snapshot of the given resources. Async \u2014 returns immediately\nwith a snapshot ID; client polls `getSnapshot` until `create.status`\nmoves from `in_progress` to `completed` or `failed`.\n\n`POST /v1/snapshots`\n\n```ts\nconst { data } = await client.createSnapshot(\n null,\n {\n name: \'string\',\n description: \'string\',\n trigger: \'manual\',\n blueprint_instance_id: \'string\',\n resources: [\n {\n type: \'string\',\n id: \'string\'\n }\n ]\n },\n)\n```\n\n---\n\n### `listSnapshots`\n\nList snapshots for the caller\'s organization, newest first.\n\n`GET /v1/snapshots`\n\n```ts\nconst { data } = await client.listSnapshots({\n cursor: \'example\',\n size: 1,\n resource: [\'...\'],\n trigger: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "page_size": 0,\n "cursor": "string",\n "results": [\n {\n "id": "string",\n "org_id": "string",\n "name": "string",\n "description": "string",\n "trigger": "manual",\n "blueprint_instance_id": "string",\n "resource_counts": {},\n "create": {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n },\n "restores": [\n {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n }\n ],\n "matched_count": 0,\n "scope": "selection",\n "expires_at": "1970-01-01T00:00:00.000Z",\n "capture_summary": {\n "total": 0,\n "captured": 0,\n "skipped": 0,\n "failed": 0\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `captureOrgSnapshot`\n\nSnapshot the caller\'s whole organization now. Fetches a fresh inventory\nof the org\'s configuration resources from configuration-hub-api, persists\nit as an inventory artifact, and starts a `scope: "org\n\n`POST /v1/snapshots:capture-org`\n\n```ts\nconst { data } = await client.captureOrgSnapshot(\n null,\n {\n name: \'string\',\n retention: {\n value: 1,\n unit: \'days\'\n },\n excluded_types: [\'string\']\n },\n)\n```\n\n---\n\n### `getSnapshot`\n\nFetch a snapshot\'s metadata. Poll this endpoint to track create/restore progress.\n\n`GET /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.getSnapshot({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "string",\n "description": "string",\n "trigger": "manual",\n "blueprint_instance_id": "string",\n "resource_counts": {},\n "create": {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n },\n "restores": [\n {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n }\n ],\n "matched_count": 0,\n "scope": "selection",\n "expires_at": "1970-01-01T00:00:00.000Z",\n "capture_summary": {\n "total": 0,\n "captured": 0,\n "skipped": 0,\n "failed": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteSnapshot`\n\nDelete a snapshot\'s metadata and S3 manifest.\n\n`DELETE /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.deleteSnapshot({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `restoreSnapshot`\n\nRestore a snapshot to the org. Async \u2014 returns immediately; client polls\n`getSnapshot` until the latest entry in `restores` moves from\n`in_progress` to one of `completed | partial | failed`.\n\n`POST /v1/snapshots/{id}:restore`\n\n```ts\nconst { data } = await client.restoreSnapshot(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n exclude_target_ids: [\'string\']\n },\n)\n```\n\n---\n\n### `listSnapshotResources`\n\nList the resources captured in this snapshot. Returns lightweight\nidentity fields per resource \u2014 payloads are fetched via the\nsingle-resource endpoint when needed.\n\n`GET /v1/snapshots/{id}/resources`\n\n```ts\nconst { data } = await client.listSnapshotResources({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "resources": [\n {\n "lineage_id": "string",\n "target_id": "string",\n "type": "string",\n "name": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getSnapshotResource`\n\nFetch one captured resource with its full payload. For UI views\nthat diff the captured state against the current destination.\n\n`GET /v1/snapshots/{id}/resources/{lineage_id}`\n\n```ts\nconst { data } = await client.getSnapshotResource({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n lineage_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lineage_id": "string",\n "target_id": "string",\n "type": "string",\n "name": "string",\n "captured": {}\n}\n```\n\n</details>\n\n---\n\n### `listDependencies`\n\nWalk the dependency tree for a set of resources and return the full\ntransitive closure, topologically sorted.\n\n`POST /v1/snapshots:list-dependencies`\n\n```ts\nconst { data } = await client.listDependencies(\n null,\n {\n resources: [\n {\n type: \'string\',\n id: \'string\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "dependencies": [\n {\n "type": "string",\n "id": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n status: number\n error: string\n}\n```\n\n### `EmptyInventoryError`\n\nReturned (422) when the org inventory contains no capturable resources\nafter filtering out sensitive, unsupported, and excluded types. The\n`skipped_types` array explains why every type was dropped.\n\n\n```ts\ntype EmptyInventoryError = {\n message: string\n skipped_types: Array<{\n type: string\n reason: string\n }>\n}\n```\n\n### `ResourceRef`\n\n```ts\ntype ResourceRef = {\n type: string\n id: string\n}\n```\n\n### `SnapshotResourceSummary`\n\nLightweight identity for a captured resource. Returned by\n`listSnapshotResources`; the full payload is fetched separately via\n`getSnapshotResource` when needed.\n\n\n```ts\ntype SnapshotResourceSummary = {\n lineage_id: string\n target_id: string\n type: string\n name?: string\n}\n```\n\n### `SnapshotResourceList`\n\n```ts\ntype SnapshotResourceList = {\n resources: Array<{\n lineage_id: string\n target_id: string\n type: string\n name?: string\n }>\n}\n```\n\n### `SnapshotResourceDetail`\n\nA single captured resource with its full payload. The identity fields\nmatch `SnapshotResourceSummary`; the `captured` payload is the\npre-install state at snapshot time.\n\n\n```ts\ntype SnapshotResourceDetail = {\n lineage_id: string\n target_id: string\n type: string\n name?: string\n captured: Record<string, unknown>\n}\n```\n\n### `CreateSnapshotRequest`\n\n```ts\ntype CreateSnapshotRequest = {\n name: string\n description?: string\n trigger?: "manual" | "sync" | "blueprint_install" | "scheduled"\n blueprint_instance_id?: string\n resources: Array<{\n type: string\n id: string\n }>\n}\n```\n\n### `CreateOrgSnapshotRequest`\n\nRequest body for `captureOrgSnapshot`. All fields optional \u2014 an empty body\nsnapshots the whole org with a default name and the 90-day default TTL.\n\n\n```ts\ntype CreateOrgSnapshotRequest = {\n name?: string\n retention?: {\n value: number\n unit: "days" | "weeks" | "months"\n }\n excluded_types?: string[]\n}\n```\n\n### `CreateSnapshotResponse`\n\n```ts\ntype CreateSnapshotResponse = {\n id: string\n name: string\n status: "creating"\n created_at: string // date-time\n}\n```\n\n### `RestoreSnapshotRequest`\n\nApply a captured snapshot to its source org. snapshot-api applies the\nmanifest verbatim minus any target ids the caller pre-decided to skip.\nDrift detection (skip modified-since-install) is the caller\'s\nresponsibility \u2014 blueprint-manifest-api owns that logic for blueprint\nrestores; Config Hub\'s manu\n\n```ts\ntype RestoreSnapshotRequest = {\n exclude_target_ids?: string[]\n}\n```\n\n### `RestoreSnapshotResponse`\n\n```ts\ntype RestoreSnapshotResponse = {\n id: string\n status: "restoring"\n}\n```\n\n### `Snapshot`\n\n```ts\ntype Snapshot = {\n id: string\n org_id: string\n name: string\n description?: string\n trigger: "manual" | "sync" | "blueprint_install" | "scheduled"\n blueprint_instance_id?: string\n resource_counts: Record<string, number>\n create: {\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: { ... }\n user_id?: { ... }\n token_id?: { ... }\n }\n }\n restores: Array<{\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: { ... }\n user_id?: { ... }\n token_id?: { ... }\n }\n }>\n matched_count?: number\n scope?: "selection" | "org"\n expires_at?: string // date-time\n capture_summary?: {\n total: number\n captured: number\n skipped: number\n failed: number\n }\n}\n```\n\n### `Operation`\n\n```ts\ntype Operation = {\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: string\n user_id?: string\n token_id?: string\n }\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n name: string\n user_id?: string\n token_id?: string\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
snapshot_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/snapshot.json
|
|
4
|
+
var snapshot_default = '# Snapshot API\n\n- **Base URL:** `https://snapshot.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/snapshot](https://docs.epilot.io/api/snapshot)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.snapshot.createSnapshot(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/snapshot\'\n\nconst snapshotClient = getClient()\nauthorize(snapshotClient, () => \'<token>\')\nconst { data } = await snapshotClient.createSnapshot(...)\n```\n\n## Operations\n\n**Snapshots**\n- [`createSnapshot`](#createsnapshot)\n- [`listSnapshots`](#listsnapshots)\n- [`captureOrgSnapshot`](#captureorgsnapshot)\n- [`getSnapshot`](#getsnapshot)\n- [`deleteSnapshot`](#deletesnapshot)\n- [`restoreSnapshot`](#restoresnapshot)\n- [`listSnapshotResources`](#listsnapshotresources)\n- [`getSnapshotResource`](#getsnapshotresource)\n- [`listDependencies`](#listdependencies)\n\n**Schemas**\n- [`Error`](#error)\n- [`EmptyInventoryError`](#emptyinventoryerror)\n- [`ResourceRef`](#resourceref)\n- [`SnapshotResourceSummary`](#snapshotresourcesummary)\n- [`SnapshotResourceList`](#snapshotresourcelist)\n- [`SnapshotResourceDetail`](#snapshotresourcedetail)\n- [`CreateSnapshotRequest`](#createsnapshotrequest)\n- [`CreateOrgSnapshotRequest`](#createorgsnapshotrequest)\n- [`CreateSnapshotResponse`](#createsnapshotresponse)\n- [`RestoreSnapshotRequest`](#restoresnapshotrequest)\n- [`RestoreSnapshotResponse`](#restoresnapshotresponse)\n- [`Snapshot`](#snapshot)\n- [`Operation`](#operation)\n- [`CallerIdentity`](#calleridentity)\n\n### `createSnapshot`\n\nCreate a new snapshot of the given resources. Async \u2014 returns immediately\nwith a snapshot ID; client polls `getSnapshot` until `create.status`\nmoves from `in_progress` to `completed` or `failed`.\n\n`POST /v1/snapshots`\n\n```ts\nconst { data } = await client.createSnapshot(\n null,\n {\n name: \'string\',\n description: \'string\',\n trigger: \'manual\',\n blueprint_instance_id: \'string\',\n resources: [\n {\n type: \'string\',\n id: \'string\'\n }\n ]\n },\n)\n```\n\n---\n\n### `listSnapshots`\n\nList snapshots for the caller\'s organization, newest first.\n\n`GET /v1/snapshots`\n\n```ts\nconst { data } = await client.listSnapshots({\n cursor: \'example\',\n size: 1,\n resource: [\'...\'],\n trigger: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "page_size": 0,\n "cursor": "string",\n "results": [\n {\n "id": "string",\n "org_id": "string",\n "name": "string",\n "description": "string",\n "trigger": "manual",\n "blueprint_instance_id": "string",\n "resource_counts": {},\n "create": {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n },\n "restores": [\n {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n }\n ],\n "matched_count": 0,\n "scope": "selection",\n "expires_at": "1970-01-01T00:00:00.000Z",\n "capture_summary": {\n "total": 0,\n "captured": 0,\n "skipped": 0,\n "failed": 0\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `captureOrgSnapshot`\n\nSnapshot the caller\'s whole organization now. Fetches a fresh inventory\nof the org\'s configuration resources from configuration-hub-api, persists\nit as an inventory artifact, and starts a `scope: "org\n\n`POST /v1/snapshots:capture-org`\n\n```ts\nconst { data } = await client.captureOrgSnapshot(\n null,\n {\n name: \'string\',\n retention: {\n value: 1,\n unit: \'days\'\n },\n excluded_types: [\'string\']\n },\n)\n```\n\n---\n\n### `getSnapshot`\n\nFetch a snapshot\'s metadata. Poll this endpoint to track create/restore progress.\n\n`GET /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.getSnapshot({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "org_id": "string",\n "name": "string",\n "description": "string",\n "trigger": "manual",\n "blueprint_instance_id": "string",\n "resource_counts": {},\n "create": {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n },\n "restores": [\n {\n "type": "create",\n "started_at": "1970-01-01T00:00:00.000Z",\n "completed_at": "1970-01-01T00:00:00.000Z",\n "status": "in_progress",\n "error": "string",\n "triggered_by": {\n "name": "string",\n "user_id": "string",\n "token_id": "string"\n }\n }\n ],\n "matched_count": 0,\n "scope": "selection",\n "expires_at": "1970-01-01T00:00:00.000Z",\n "capture_summary": {\n "total": 0,\n "captured": 0,\n "skipped": 0,\n "failed": 0\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteSnapshot`\n\nDelete a snapshot\'s metadata and S3 manifest.\n\n`DELETE /v1/snapshots/{id}`\n\n```ts\nconst { data } = await client.deleteSnapshot({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `restoreSnapshot`\n\nRestore a snapshot to the org. Async \u2014 returns immediately; client polls\n`getSnapshot` until the latest entry in `restores` moves from\n`in_progress` to one of `completed | partial | failed`.\n\n`POST /v1/snapshots/{id}:restore`\n\n```ts\nconst { data } = await client.restoreSnapshot(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n exclude_target_ids: [\'string\']\n },\n)\n```\n\n---\n\n### `listSnapshotResources`\n\nList the resources captured in this snapshot. Returns lightweight\nidentity fields per resource \u2014 payloads are fetched via the\nsingle-resource endpoint when needed.\n\n`GET /v1/snapshots/{id}/resources`\n\n```ts\nconst { data } = await client.listSnapshotResources({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "resources": [\n {\n "lineage_id": "string",\n "target_id": "string",\n "type": "string",\n "name": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getSnapshotResource`\n\nFetch one captured resource with its full payload. For UI views\nthat diff the captured state against the current destination.\n\n`GET /v1/snapshots/{id}/resources/{lineage_id}`\n\n```ts\nconst { data } = await client.getSnapshotResource({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n lineage_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lineage_id": "string",\n "target_id": "string",\n "type": "string",\n "name": "string",\n "captured": {}\n}\n```\n\n</details>\n\n---\n\n### `listDependencies`\n\nWalk the dependency tree for a set of resources and return the full\ntransitive closure, topologically sorted.\n\n`POST /v1/snapshots:list-dependencies`\n\n```ts\nconst { data } = await client.listDependencies(\n null,\n {\n resources: [\n {\n type: \'string\',\n id: \'string\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "dependencies": [\n {\n "type": "string",\n "id": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\n```ts\ntype Error = {\n status: number\n error: string\n}\n```\n\n### `EmptyInventoryError`\n\nReturned (422) when the org inventory contains no capturable resources\nafter filtering out sensitive, unsupported, and excluded types. The\n`skipped_types` array explains why every type was dropped.\n\n\n```ts\ntype EmptyInventoryError = {\n message: string\n skipped_types: Array<{\n type: string\n reason: string\n }>\n}\n```\n\n### `ResourceRef`\n\n```ts\ntype ResourceRef = {\n type: string\n id: string\n}\n```\n\n### `SnapshotResourceSummary`\n\nLightweight identity for a captured resource. Returned by\n`listSnapshotResources`; the full payload is fetched separately via\n`getSnapshotResource` when needed.\n\n\n```ts\ntype SnapshotResourceSummary = {\n lineage_id: string\n target_id: string\n type: string\n name?: string\n}\n```\n\n### `SnapshotResourceList`\n\n```ts\ntype SnapshotResourceList = {\n resources: Array<{\n lineage_id: string\n target_id: string\n type: string\n name?: string\n }>\n}\n```\n\n### `SnapshotResourceDetail`\n\nA single captured resource with its full payload. The identity fields\nmatch `SnapshotResourceSummary`; the `captured` payload is the\npre-install state at snapshot time.\n\n\n```ts\ntype SnapshotResourceDetail = {\n lineage_id: string\n target_id: string\n type: string\n name?: string\n captured: Record<string, unknown>\n}\n```\n\n### `CreateSnapshotRequest`\n\n```ts\ntype CreateSnapshotRequest = {\n name: string\n description?: string\n trigger?: "manual" | "sync" | "blueprint_install" | "scheduled"\n blueprint_instance_id?: string\n resources: Array<{\n type: string\n id: string\n }>\n}\n```\n\n### `CreateOrgSnapshotRequest`\n\nRequest body for `captureOrgSnapshot`. All fields optional \u2014 an empty body\nsnapshots the whole org with a default name and the 90-day default TTL.\n\n\n```ts\ntype CreateOrgSnapshotRequest = {\n name?: string\n retention?: {\n value: number\n unit: "days" | "weeks" | "months"\n }\n excluded_types?: string[]\n}\n```\n\n### `CreateSnapshotResponse`\n\n```ts\ntype CreateSnapshotResponse = {\n id: string\n name: string\n status: "creating"\n created_at: string // date-time\n}\n```\n\n### `RestoreSnapshotRequest`\n\nApply a captured snapshot to its source org. snapshot-api applies the\nmanifest verbatim minus any target ids the caller pre-decided to skip.\nDrift detection (skip modified-since-install) is the caller\'s\nresponsibility \u2014 blueprint-manifest-api owns that logic for blueprint\nrestores; Config Hub\'s manu\n\n```ts\ntype RestoreSnapshotRequest = {\n exclude_target_ids?: string[]\n}\n```\n\n### `RestoreSnapshotResponse`\n\n```ts\ntype RestoreSnapshotResponse = {\n id: string\n status: "restoring"\n}\n```\n\n### `Snapshot`\n\n```ts\ntype Snapshot = {\n id: string\n org_id: string\n name: string\n description?: string\n trigger: "manual" | "sync" | "blueprint_install" | "scheduled"\n blueprint_instance_id?: string\n resource_counts: Record<string, number>\n create: {\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: { ... }\n user_id?: { ... }\n token_id?: { ... }\n }\n }\n restores: Array<{\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: { ... }\n user_id?: { ... }\n token_id?: { ... }\n }\n }>\n matched_count?: number\n scope?: "selection" | "org"\n expires_at?: string // date-time\n capture_summary?: {\n total: number\n captured: number\n skipped: number\n failed: number\n }\n}\n```\n\n### `Operation`\n\n```ts\ntype Operation = {\n type: "create" | "restore"\n started_at: string // date-time\n completed_at?: string // date-time\n status: "in_progress" | "completed" | "partial" | "failed"\n error?: string\n triggered_by: {\n name: string\n user_id?: string\n token_id?: string\n }\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n name: string\n user_id?: string\n token_id?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = snapshot_default;
|
|
@@ -109,22 +109,14 @@ declare namespace Components {
|
|
|
109
109
|
started_at: string; // date-time
|
|
110
110
|
completed_at?: string; // date-time
|
|
111
111
|
/**
|
|
112
|
-
* `partial` indicates
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* `partial` indicates `engine.apply` reported a partial success
|
|
113
|
+
* (one or more resources failed individually) but the operation
|
|
114
|
+
* as a whole did not fail.
|
|
115
115
|
*
|
|
116
116
|
*/
|
|
117
117
|
status: "in_progress" | "completed" | "partial" | "failed";
|
|
118
118
|
error?: string;
|
|
119
119
|
triggered_by: CallerIdentity;
|
|
120
|
-
/**
|
|
121
|
-
* Captured resources snapshot-api elected to skip — currently
|
|
122
|
-
* only drift detections (`preserve_modified: true`). Caller-
|
|
123
|
-
* supplied `exclude_target_ids` skips are NOT echoed here; the
|
|
124
|
-
* caller built the list, the caller knows.
|
|
125
|
-
*
|
|
126
|
-
*/
|
|
127
|
-
skipped?: SkippedResource[];
|
|
128
120
|
}
|
|
129
121
|
export interface ResourceRef {
|
|
130
122
|
/**
|
|
@@ -134,27 +126,18 @@ declare namespace Components {
|
|
|
134
126
|
id: string;
|
|
135
127
|
}
|
|
136
128
|
/**
|
|
137
|
-
* Apply a captured snapshot to its source org.
|
|
138
|
-
*
|
|
139
|
-
*
|
|
129
|
+
* Apply a captured snapshot to its source org. snapshot-api applies the
|
|
130
|
+
* manifest verbatim minus any target ids the caller pre-decided to skip.
|
|
131
|
+
* Drift detection (skip modified-since-install) is the caller's
|
|
132
|
+
* responsibility — blueprint-manifest-api owns that logic for blueprint
|
|
133
|
+
* restores; Config Hub's manual restore just omits the field.
|
|
140
134
|
*
|
|
141
135
|
*/
|
|
142
136
|
export interface RestoreSnapshotRequest {
|
|
143
|
-
/**
|
|
144
|
-
* When `true`, skip captured resources whose live payload's content
|
|
145
|
-
* fingerprint diverges from the capture-time fingerprint stored on
|
|
146
|
-
* the manifest entry. snapshot-api fetches the live payload and
|
|
147
|
-
* hashes it itself; no cross-service lookup. Surfaces under
|
|
148
|
-
* `Operation.skipped` with `reason: 'modified'`. Legacy snapshots
|
|
149
|
-
* captured before fingerprints were stored fail open (applied).
|
|
150
|
-
*
|
|
151
|
-
*/
|
|
152
|
-
preserve_modified?: boolean;
|
|
153
137
|
/**
|
|
154
138
|
* Target ids the caller has decided not to restore. snapshot-api
|
|
155
|
-
* applies the manifest minus these ids. Drops are silent —
|
|
156
|
-
*
|
|
157
|
-
* list and already knows.
|
|
139
|
+
* applies the manifest minus these ids. Drops are silent — the
|
|
140
|
+
* caller supplied the list and already knows.
|
|
158
141
|
*
|
|
159
142
|
*/
|
|
160
143
|
exclude_target_ids?: string[];
|
|
@@ -163,17 +146,6 @@ declare namespace Components {
|
|
|
163
146
|
id: string;
|
|
164
147
|
status: "restoring";
|
|
165
148
|
}
|
|
166
|
-
export interface SkippedResource {
|
|
167
|
-
target_id: string;
|
|
168
|
-
/**
|
|
169
|
-
* - `modified` — live destination payload's content fingerprint
|
|
170
|
-
* differs from the capture-time fingerprint stored on the
|
|
171
|
-
* manifest entry. Only set when the restore was requested with
|
|
172
|
-
* `preserve_modified: true`.
|
|
173
|
-
*
|
|
174
|
-
*/
|
|
175
|
-
reason: "modified";
|
|
176
|
-
}
|
|
177
149
|
export interface Snapshot {
|
|
178
150
|
id: string;
|
|
179
151
|
org_id: string;
|
|
@@ -400,9 +372,11 @@ declare namespace Paths {
|
|
|
400
372
|
}
|
|
401
373
|
namespace RestoreSnapshot {
|
|
402
374
|
export type RequestBody = /**
|
|
403
|
-
* Apply a captured snapshot to its source org.
|
|
404
|
-
*
|
|
405
|
-
*
|
|
375
|
+
* Apply a captured snapshot to its source org. snapshot-api applies the
|
|
376
|
+
* manifest verbatim minus any target ids the caller pre-decided to skip.
|
|
377
|
+
* Drift detection (skip modified-since-install) is the caller's
|
|
378
|
+
* responsibility — blueprint-manifest-api owns that logic for blueprint
|
|
379
|
+
* restores; Config Hub's manual restore just omits the field.
|
|
406
380
|
*
|
|
407
381
|
*/
|
|
408
382
|
Components.Schemas.RestoreSnapshotRequest;
|
|
@@ -742,10 +716,9 @@ type Operation = Components.Schemas.Operation;
|
|
|
742
716
|
type ResourceRef = Components.Schemas.ResourceRef;
|
|
743
717
|
type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
|
|
744
718
|
type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
|
|
745
|
-
type SkippedResource = Components.Schemas.SkippedResource;
|
|
746
719
|
type Snapshot = Components.Schemas.Snapshot;
|
|
747
720
|
type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
|
|
748
721
|
type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
|
|
749
722
|
type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
|
|
750
723
|
|
|
751
|
-
export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type
|
|
724
|
+
export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type Snapshot as S, Components as a, type PathsDictionary as b, type CallerIdentity as c, type CreateOrgSnapshotRequest as d, type CreateSnapshotRequest as e, type CreateSnapshotResponse as f, type Error as g, type Operation as h, type RestoreSnapshotRequest as i, type RestoreSnapshotResponse as j, type SnapshotResourceDetail as k, type SnapshotResourceList as l, type SnapshotResourceSummary as m };
|
|
@@ -109,22 +109,14 @@ declare namespace Components {
|
|
|
109
109
|
started_at: string; // date-time
|
|
110
110
|
completed_at?: string; // date-time
|
|
111
111
|
/**
|
|
112
|
-
* `partial` indicates
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* `partial` indicates `engine.apply` reported a partial success
|
|
113
|
+
* (one or more resources failed individually) but the operation
|
|
114
|
+
* as a whole did not fail.
|
|
115
115
|
*
|
|
116
116
|
*/
|
|
117
117
|
status: "in_progress" | "completed" | "partial" | "failed";
|
|
118
118
|
error?: string;
|
|
119
119
|
triggered_by: CallerIdentity;
|
|
120
|
-
/**
|
|
121
|
-
* Captured resources snapshot-api elected to skip — currently
|
|
122
|
-
* only drift detections (`preserve_modified: true`). Caller-
|
|
123
|
-
* supplied `exclude_target_ids` skips are NOT echoed here; the
|
|
124
|
-
* caller built the list, the caller knows.
|
|
125
|
-
*
|
|
126
|
-
*/
|
|
127
|
-
skipped?: SkippedResource[];
|
|
128
120
|
}
|
|
129
121
|
export interface ResourceRef {
|
|
130
122
|
/**
|
|
@@ -134,27 +126,18 @@ declare namespace Components {
|
|
|
134
126
|
id: string;
|
|
135
127
|
}
|
|
136
128
|
/**
|
|
137
|
-
* Apply a captured snapshot to its source org.
|
|
138
|
-
*
|
|
139
|
-
*
|
|
129
|
+
* Apply a captured snapshot to its source org. snapshot-api applies the
|
|
130
|
+
* manifest verbatim minus any target ids the caller pre-decided to skip.
|
|
131
|
+
* Drift detection (skip modified-since-install) is the caller's
|
|
132
|
+
* responsibility — blueprint-manifest-api owns that logic for blueprint
|
|
133
|
+
* restores; Config Hub's manual restore just omits the field.
|
|
140
134
|
*
|
|
141
135
|
*/
|
|
142
136
|
export interface RestoreSnapshotRequest {
|
|
143
|
-
/**
|
|
144
|
-
* When `true`, skip captured resources whose live payload's content
|
|
145
|
-
* fingerprint diverges from the capture-time fingerprint stored on
|
|
146
|
-
* the manifest entry. snapshot-api fetches the live payload and
|
|
147
|
-
* hashes it itself; no cross-service lookup. Surfaces under
|
|
148
|
-
* `Operation.skipped` with `reason: 'modified'`. Legacy snapshots
|
|
149
|
-
* captured before fingerprints were stored fail open (applied).
|
|
150
|
-
*
|
|
151
|
-
*/
|
|
152
|
-
preserve_modified?: boolean;
|
|
153
137
|
/**
|
|
154
138
|
* Target ids the caller has decided not to restore. snapshot-api
|
|
155
|
-
* applies the manifest minus these ids. Drops are silent —
|
|
156
|
-
*
|
|
157
|
-
* list and already knows.
|
|
139
|
+
* applies the manifest minus these ids. Drops are silent — the
|
|
140
|
+
* caller supplied the list and already knows.
|
|
158
141
|
*
|
|
159
142
|
*/
|
|
160
143
|
exclude_target_ids?: string[];
|
|
@@ -163,17 +146,6 @@ declare namespace Components {
|
|
|
163
146
|
id: string;
|
|
164
147
|
status: "restoring";
|
|
165
148
|
}
|
|
166
|
-
export interface SkippedResource {
|
|
167
|
-
target_id: string;
|
|
168
|
-
/**
|
|
169
|
-
* - `modified` — live destination payload's content fingerprint
|
|
170
|
-
* differs from the capture-time fingerprint stored on the
|
|
171
|
-
* manifest entry. Only set when the restore was requested with
|
|
172
|
-
* `preserve_modified: true`.
|
|
173
|
-
*
|
|
174
|
-
*/
|
|
175
|
-
reason: "modified";
|
|
176
|
-
}
|
|
177
149
|
export interface Snapshot {
|
|
178
150
|
id: string;
|
|
179
151
|
org_id: string;
|
|
@@ -400,9 +372,11 @@ declare namespace Paths {
|
|
|
400
372
|
}
|
|
401
373
|
namespace RestoreSnapshot {
|
|
402
374
|
export type RequestBody = /**
|
|
403
|
-
* Apply a captured snapshot to its source org.
|
|
404
|
-
*
|
|
405
|
-
*
|
|
375
|
+
* Apply a captured snapshot to its source org. snapshot-api applies the
|
|
376
|
+
* manifest verbatim minus any target ids the caller pre-decided to skip.
|
|
377
|
+
* Drift detection (skip modified-since-install) is the caller's
|
|
378
|
+
* responsibility — blueprint-manifest-api owns that logic for blueprint
|
|
379
|
+
* restores; Config Hub's manual restore just omits the field.
|
|
406
380
|
*
|
|
407
381
|
*/
|
|
408
382
|
Components.Schemas.RestoreSnapshotRequest;
|
|
@@ -742,10 +716,9 @@ type Operation = Components.Schemas.Operation;
|
|
|
742
716
|
type ResourceRef = Components.Schemas.ResourceRef;
|
|
743
717
|
type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
|
|
744
718
|
type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
|
|
745
|
-
type SkippedResource = Components.Schemas.SkippedResource;
|
|
746
719
|
type Snapshot = Components.Schemas.Snapshot;
|
|
747
720
|
type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
|
|
748
721
|
type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
|
|
749
722
|
type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
|
|
750
723
|
|
|
751
|
-
export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type
|
|
724
|
+
export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type Snapshot as S, Components as a, type PathsDictionary as b, type CallerIdentity as c, type CreateOrgSnapshotRequest as d, type CreateSnapshotRequest as e, type CreateSnapshotResponse as f, type Error as g, type Operation as h, type RestoreSnapshotRequest as i, type RestoreSnapshotResponse as j, type SnapshotResourceDetail as k, type SnapshotResourceList as l, type SnapshotResourceSummary as m };
|
|
@@ -161,6 +161,7 @@ const { data } = await integrationToolkitClient.acknowledgeTracking(...)
|
|
|
161
161
|
- [`SecureProxySummary`](#secureproxysummary)
|
|
162
162
|
- [`SecureProxyRequest`](#secureproxyrequest)
|
|
163
163
|
- [`SecureProxyResponse`](#secureproxyresponse)
|
|
164
|
+
- [`SecureProxyUpstreamError`](#secureproxyupstreamerror)
|
|
164
165
|
- [`ManagedCallOperationConfig`](#managedcalloperationconfig)
|
|
165
166
|
- [`ManagedCallOperation`](#managedcalloperation)
|
|
166
167
|
- [`ManagedCallExecuteRequest`](#managedcallexecuterequest)
|
|
@@ -5453,6 +5454,18 @@ type SecureProxyResponse = {
|
|
|
5453
5454
|
}
|
|
5454
5455
|
```
|
|
5455
5456
|
|
|
5457
|
+
### `SecureProxyUpstreamError`
|
|
5458
|
+
|
|
5459
|
+
Error payload returned when epilot could not obtain an HTTP response from the proxied target. The failure is epilot-generated (HTTP 502) but the cause is usually remote-side; `code`/`reason` make that attributable.
|
|
5460
|
+
|
|
5461
|
+
```ts
|
|
5462
|
+
type SecureProxyUpstreamError = {
|
|
5463
|
+
message: "Upstream network error" | "Upstream error"
|
|
5464
|
+
code?: string
|
|
5465
|
+
reason?: string
|
|
5466
|
+
}
|
|
5467
|
+
```
|
|
5468
|
+
|
|
5456
5469
|
### `ManagedCallOperationConfig`
|
|
5457
5470
|
|
|
5458
5471
|
Configuration for managed_call use cases. Defines a single API operation with JSONata mapping.
|
package/docs/snapshot.md
CHANGED
|
@@ -49,7 +49,6 @@ const { data } = await snapshotClient.createSnapshot(...)
|
|
|
49
49
|
- [`RestoreSnapshotResponse`](#restoresnapshotresponse)
|
|
50
50
|
- [`Snapshot`](#snapshot)
|
|
51
51
|
- [`Operation`](#operation)
|
|
52
|
-
- [`SkippedResource`](#skippedresource)
|
|
53
52
|
- [`CallerIdentity`](#calleridentity)
|
|
54
53
|
|
|
55
54
|
### `createSnapshot`
|
|
@@ -121,13 +120,7 @@ const { data } = await client.listSnapshots({
|
|
|
121
120
|
"name": "string",
|
|
122
121
|
"user_id": "string",
|
|
123
122
|
"token_id": "string"
|
|
124
|
-
}
|
|
125
|
-
"skipped": [
|
|
126
|
-
{
|
|
127
|
-
"target_id": "string",
|
|
128
|
-
"reason": "modified"
|
|
129
|
-
}
|
|
130
|
-
]
|
|
123
|
+
}
|
|
131
124
|
},
|
|
132
125
|
"restores": [
|
|
133
126
|
{
|
|
@@ -140,13 +133,7 @@ const { data } = await client.listSnapshots({
|
|
|
140
133
|
"name": "string",
|
|
141
134
|
"user_id": "string",
|
|
142
135
|
"token_id": "string"
|
|
143
|
-
}
|
|
144
|
-
"skipped": [
|
|
145
|
-
{
|
|
146
|
-
"target_id": "string",
|
|
147
|
-
"reason": "modified"
|
|
148
|
-
}
|
|
149
|
-
]
|
|
136
|
+
}
|
|
150
137
|
}
|
|
151
138
|
],
|
|
152
139
|
"matched_count": 0,
|
|
@@ -225,13 +212,7 @@ const { data } = await client.getSnapshot({
|
|
|
225
212
|
"name": "string",
|
|
226
213
|
"user_id": "string",
|
|
227
214
|
"token_id": "string"
|
|
228
|
-
}
|
|
229
|
-
"skipped": [
|
|
230
|
-
{
|
|
231
|
-
"target_id": "string",
|
|
232
|
-
"reason": "modified"
|
|
233
|
-
}
|
|
234
|
-
]
|
|
215
|
+
}
|
|
235
216
|
},
|
|
236
217
|
"restores": [
|
|
237
218
|
{
|
|
@@ -244,13 +225,7 @@ const { data } = await client.getSnapshot({
|
|
|
244
225
|
"name": "string",
|
|
245
226
|
"user_id": "string",
|
|
246
227
|
"token_id": "string"
|
|
247
|
-
}
|
|
248
|
-
"skipped": [
|
|
249
|
-
{
|
|
250
|
-
"target_id": "string",
|
|
251
|
-
"reason": "modified"
|
|
252
|
-
}
|
|
253
|
-
]
|
|
228
|
+
}
|
|
254
229
|
}
|
|
255
230
|
],
|
|
256
231
|
"matched_count": 0,
|
|
@@ -297,7 +272,6 @@ const { data } = await client.restoreSnapshot(
|
|
|
297
272
|
id: '123e4567-e89b-12d3-a456-426614174000',
|
|
298
273
|
},
|
|
299
274
|
{
|
|
300
|
-
preserve_modified: false,
|
|
301
275
|
exclude_target_ids: ['string']
|
|
302
276
|
},
|
|
303
277
|
)
|
|
@@ -537,14 +511,14 @@ type CreateSnapshotResponse = {
|
|
|
537
511
|
|
|
538
512
|
### `RestoreSnapshotRequest`
|
|
539
513
|
|
|
540
|
-
Apply a captured snapshot to its source org.
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
514
|
+
Apply a captured snapshot to its source org. snapshot-api applies the
|
|
515
|
+
manifest verbatim minus any target ids the caller pre-decided to skip.
|
|
516
|
+
Drift detection (skip modified-since-install) is the caller's
|
|
517
|
+
responsibility — blueprint-manifest-api owns that logic for blueprint
|
|
518
|
+
restores; Config Hub's manu
|
|
544
519
|
|
|
545
520
|
```ts
|
|
546
521
|
type RestoreSnapshotRequest = {
|
|
547
|
-
preserve_modified?: boolean
|
|
548
522
|
exclude_target_ids?: string[]
|
|
549
523
|
}
|
|
550
524
|
```
|
|
@@ -580,10 +554,6 @@ type Snapshot = {
|
|
|
580
554
|
user_id?: { ... }
|
|
581
555
|
token_id?: { ... }
|
|
582
556
|
}
|
|
583
|
-
skipped?: Array<{
|
|
584
|
-
target_id: { ... }
|
|
585
|
-
reason: { ... }
|
|
586
|
-
}>
|
|
587
557
|
}
|
|
588
558
|
restores: Array<{
|
|
589
559
|
type: "create" | "restore"
|
|
@@ -596,10 +566,6 @@ type Snapshot = {
|
|
|
596
566
|
user_id?: { ... }
|
|
597
567
|
token_id?: { ... }
|
|
598
568
|
}
|
|
599
|
-
skipped?: Array<{
|
|
600
|
-
target_id: { ... }
|
|
601
|
-
reason: { ... }
|
|
602
|
-
}>
|
|
603
569
|
}>
|
|
604
570
|
matched_count?: number
|
|
605
571
|
scope?: "selection" | "org"
|
|
@@ -627,19 +593,6 @@ type Operation = {
|
|
|
627
593
|
user_id?: string
|
|
628
594
|
token_id?: string
|
|
629
595
|
}
|
|
630
|
-
skipped?: Array<{
|
|
631
|
-
target_id: string
|
|
632
|
-
reason: "modified"
|
|
633
|
-
}>
|
|
634
|
-
}
|
|
635
|
-
```
|
|
636
|
-
|
|
637
|
-
### `SkippedResource`
|
|
638
|
-
|
|
639
|
-
```ts
|
|
640
|
-
type SkippedResource = {
|
|
641
|
-
target_id: string
|
|
642
|
-
reason: "modified"
|
|
643
596
|
}
|
|
644
597
|
```
|
|
645
598
|
|