@epilot/sdk 2.8.9 → 2.8.10

package/dist/snapshot-GWB56VPP.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/snapshot.json
-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- [`SkippedResource`](#skippedresource)\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        "skipped": [\n          {\n            "lineage_id": "string",\n            "reason": "modified"\n          }\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          "skipped": [\n            {\n              "lineage_id": "string",\n              "reason": "modified"\n            }\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    "skipped": [\n      {\n        "lineage_id": "string",\n        "reason": "modified"\n      }\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      "skipped": [\n        {\n          "lineage_id": "string",\n          "reason": "modified"\n        }\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    preserve_modified: false,\n    preserve_co_owned: false,\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\nSkipped resources surface under `Operation.skipped`. All filters default\nto the open setting (apply everything), which keeps Config Hub\'s manual-\nrestore semantics unchanged.\n\n\n```ts\ntype RestoreSnapshotRequest = {\n  preserve_modified?: boolean\n  preserve_co_owned?: boolean\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    skipped?: Array<{\n      lineage_id: { ... }\n      reason: { ... }\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    skipped?: Array<{\n      lineage_id: { ... }\n      reason: { ... }\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  skipped?: Array<{\n    lineage_id: string\n    reason: "modified" | "co_owned"\n  }>\n}\n```\n\n### `SkippedResource`\n\n```ts\ntype SkippedResource = {\n  lineage_id: string\n  reason: "modified" | "co_owned"\n}\n```\n\n### `CallerIdentity`\n\n```ts\ntype CallerIdentity = {\n  name: string\n  user_id?: string\n  token_id?: string\n}\n```\n';
-
-
-exports.default = snapshot_default;