@epilot/sdk 2.8.9 → 2.9.0

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.
Files changed (225) hide show
  1. package/README.md +0 -1
  2. package/definitions/access-token-runtime.json +1 -1
  3. package/definitions/access-token.json +1 -155
  4. package/definitions/automation.json +0 -120
  5. package/definitions/blueprint-manifest-runtime.json +1 -1
  6. package/definitions/blueprint-manifest.json +1 -571
  7. package/definitions/focus-pocus-runtime.json +1 -0
  8. package/definitions/focus-pocus.json +757 -0
  9. package/definitions/integration-toolkit.json +30 -5
  10. package/definitions/journey.json +2 -19
  11. package/definitions/targeting.json +4 -5
  12. package/definitions/user-runtime.json +1 -1
  13. package/definitions/user.json +0 -441
  14. package/dist/README-46VYEGGW.js +7 -0
  15. package/dist/README-IVBISSWB.cjs +7 -0
  16. package/dist/{_index-UY46ZN47.js → _index-5FB6F5YY.js} +0 -3
  17. package/dist/{_index-D5TTZP5F.cjs → _index-DB2VV4PQ.cjs} +1 -4
  18. package/dist/access-token-6BJDZSFE.cjs +7 -0
  19. package/dist/access-token-GSQZLDXR.js +7 -0
  20. package/dist/{access-token-runtime-2PSLN2U3.js → access-token-runtime-KCKGT4O7.js} +1 -1
  21. package/dist/{access-token-runtime-B6Z7JLUS.cjs → access-token-runtime-NZWZJPWV.cjs} +2 -2
  22. package/dist/{access-token.d-CegaQmrK.d.cts → access-token.d-CnmUTOlq.d.cts} +5 -165
  23. package/dist/{access-token.d-CegaQmrK.d.ts → access-token.d-CnmUTOlq.d.ts} +5 -165
  24. package/dist/{ai-agents.d-CC5IjXrs.d.ts → ai-agents.d-OkXfr2bz.d.cts} +2 -0
  25. package/dist/{ai-agents.d-CC5IjXrs.d.cts → ai-agents.d-OkXfr2bz.d.ts} +2 -0
  26. package/dist/apis/access-token.cjs +8 -8
  27. package/dist/apis/access-token.d.cts +2 -2
  28. package/dist/apis/access-token.d.ts +2 -2
  29. package/dist/apis/access-token.js +2 -2
  30. package/dist/apis/address-suggestions.cjs +6 -6
  31. package/dist/apis/address-suggestions.js +1 -1
  32. package/dist/apis/address.cjs +6 -6
  33. package/dist/apis/address.js +1 -1
  34. package/dist/apis/ai-agents.cjs +6 -6
  35. package/dist/apis/ai-agents.d.cts +2 -2
  36. package/dist/apis/ai-agents.d.ts +2 -2
  37. package/dist/apis/ai-agents.js +1 -1
  38. package/dist/apis/app.cjs +6 -6
  39. package/dist/apis/app.js +1 -1
  40. package/dist/apis/audit-logs.cjs +6 -6
  41. package/dist/apis/audit-logs.js +1 -1
  42. package/dist/apis/automation.cjs +6 -6
  43. package/dist/apis/automation.d.cts +2 -2
  44. package/dist/apis/automation.d.ts +2 -2
  45. package/dist/apis/automation.js +1 -1
  46. package/dist/apis/billing.cjs +6 -6
  47. package/dist/apis/billing.js +1 -1
  48. package/dist/apis/blueprint-manifest.cjs +8 -8
  49. package/dist/apis/blueprint-manifest.d.cts +2 -2
  50. package/dist/apis/blueprint-manifest.d.ts +2 -2
  51. package/dist/apis/blueprint-manifest.js +2 -2
  52. package/dist/apis/calendar.cjs +6 -6
  53. package/dist/apis/calendar.js +1 -1
  54. package/dist/apis/configuration-hub.cjs +6 -6
  55. package/dist/apis/configuration-hub.js +1 -1
  56. package/dist/apis/consent.cjs +6 -6
  57. package/dist/apis/consent.js +1 -1
  58. package/dist/apis/customer-portal.cjs +6 -6
  59. package/dist/apis/customer-portal.js +1 -1
  60. package/dist/apis/dashboard.cjs +6 -6
  61. package/dist/apis/dashboard.js +1 -1
  62. package/dist/apis/data-governance.cjs +6 -6
  63. package/dist/apis/data-governance.js +1 -1
  64. package/dist/apis/deduplication.cjs +6 -6
  65. package/dist/apis/deduplication.js +1 -1
  66. package/dist/apis/design.cjs +6 -6
  67. package/dist/apis/design.js +1 -1
  68. package/dist/apis/document.cjs +6 -6
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.js +1 -1
  72. package/dist/apis/email-template.cjs +6 -6
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.js +1 -1
  76. package/dist/apis/entity.cjs +6 -6
  77. package/dist/apis/entity.js +1 -1
  78. package/dist/apis/environments.cjs +6 -6
  79. package/dist/apis/environments.js +1 -1
  80. package/dist/apis/event-catalog.cjs +6 -6
  81. package/dist/apis/event-catalog.js +1 -1
  82. package/dist/apis/file.cjs +6 -6
  83. package/dist/apis/file.js +1 -1
  84. package/dist/apis/iban.cjs +6 -6
  85. package/dist/apis/iban.js +1 -1
  86. package/dist/apis/integration-toolkit.cjs +6 -6
  87. package/dist/apis/integration-toolkit.d.cts +2 -2
  88. package/dist/apis/integration-toolkit.d.ts +2 -2
  89. package/dist/apis/integration-toolkit.js +1 -1
  90. package/dist/apis/journey.cjs +6 -6
  91. package/dist/apis/journey.d.cts +2 -2
  92. package/dist/apis/journey.d.ts +2 -2
  93. package/dist/apis/journey.js +1 -1
  94. package/dist/apis/kanban.cjs +6 -6
  95. package/dist/apis/kanban.js +1 -1
  96. package/dist/apis/message.cjs +6 -6
  97. package/dist/apis/message.js +1 -1
  98. package/dist/apis/metering.cjs +6 -6
  99. package/dist/apis/metering.js +1 -1
  100. package/dist/apis/notes.cjs +6 -6
  101. package/dist/apis/notes.js +1 -1
  102. package/dist/apis/notification.cjs +6 -6
  103. package/dist/apis/notification.js +1 -1
  104. package/dist/apis/organization.cjs +6 -6
  105. package/dist/apis/organization.js +1 -1
  106. package/dist/apis/partner-directory.cjs +6 -6
  107. package/dist/apis/partner-directory.js +1 -1
  108. package/dist/apis/permissions.cjs +6 -6
  109. package/dist/apis/permissions.js +1 -1
  110. package/dist/apis/pricing-tier.cjs +6 -6
  111. package/dist/apis/pricing-tier.js +1 -1
  112. package/dist/apis/pricing.cjs +6 -6
  113. package/dist/apis/pricing.js +1 -1
  114. package/dist/apis/purpose.cjs +6 -6
  115. package/dist/apis/purpose.js +1 -1
  116. package/dist/apis/query.cjs +6 -6
  117. package/dist/apis/query.js +1 -1
  118. package/dist/apis/sandbox.cjs +6 -6
  119. package/dist/apis/sandbox.js +1 -1
  120. package/dist/apis/sharing.cjs +6 -6
  121. package/dist/apis/sharing.js +1 -1
  122. package/dist/apis/submission.cjs +6 -6
  123. package/dist/apis/submission.js +1 -1
  124. package/dist/apis/target.cjs +6 -6
  125. package/dist/apis/target.js +1 -1
  126. package/dist/apis/targeting.cjs +6 -6
  127. package/dist/apis/targeting.d.cts +2 -2
  128. package/dist/apis/targeting.d.ts +2 -2
  129. package/dist/apis/targeting.js +1 -1
  130. package/dist/apis/template-variables.cjs +6 -6
  131. package/dist/apis/template-variables.js +1 -1
  132. package/dist/apis/user.cjs +8 -8
  133. package/dist/apis/user.d.cts +2 -2
  134. package/dist/apis/user.d.ts +2 -2
  135. package/dist/apis/user.js +2 -2
  136. package/dist/apis/validation-rules.cjs +6 -6
  137. package/dist/apis/validation-rules.js +1 -1
  138. package/dist/apis/webhooks.cjs +6 -6
  139. package/dist/apis/webhooks.js +1 -1
  140. package/dist/apis/workflow-definition.cjs +6 -6
  141. package/dist/apis/workflow-definition.js +1 -1
  142. package/dist/apis/workflow.cjs +6 -6
  143. package/dist/apis/workflow.js +1 -1
  144. package/dist/automation-BMO7ZFTN.cjs +7 -0
  145. package/dist/automation-MEZTSUR3.js +7 -0
  146. package/dist/{automation.d-DS_YXDE8.d.cts → automation.d-Du6-uiz5.d.cts} +1 -300
  147. package/dist/{automation.d-DS_YXDE8.d.ts → automation.d-Du6-uiz5.d.ts} +1 -300
  148. package/dist/blueprint-manifest-6DEYW5MW.js +7 -0
  149. package/dist/blueprint-manifest-GCV7H74X.cjs +7 -0
  150. package/dist/{blueprint-manifest-runtime-WU5MWPVT.cjs → blueprint-manifest-runtime-EIDOROIQ.cjs} +2 -2
  151. package/dist/{blueprint-manifest-runtime-2344IUIE.js → blueprint-manifest-runtime-FRLU3ZSF.js} +1 -1
  152. package/dist/{blueprint-manifest.d-2-TORV8o.d.ts → blueprint-manifest.d-B8yDxagC.d.cts} +4 -926
  153. package/dist/{blueprint-manifest.d-2-TORV8o.d.cts → blueprint-manifest.d-B8yDxagC.d.ts} +4 -926
  154. package/dist/chunk-3XKBB5AE.js +14 -0
  155. package/dist/{chunk-UWGWRGGB.js → chunk-4YBWMDFP.js} +1 -1
  156. package/dist/{chunk-4GI6KGKZ.cjs → chunk-CULH5PIN.cjs} +12 -14
  157. package/dist/{chunk-T57MT6J5.cjs → chunk-NGHCQ2FA.cjs} +1 -1
  158. package/dist/{chunk-S5HBBTKM.cjs → chunk-OXJOO2YF.cjs} +1 -1
  159. package/dist/{chunk-VMKT7UQS.js → chunk-RZ4ABDOF.js} +12 -14
  160. package/dist/{chunk-OHHHS4HH.js → chunk-XSE4CFSM.js} +1 -1
  161. package/dist/chunk-Z5TVWG3I.cjs +14 -0
  162. package/dist/index.cjs +16 -24
  163. package/dist/index.d.cts +22 -24
  164. package/dist/index.d.ts +22 -24
  165. package/dist/index.js +6 -14
  166. package/dist/integration-toolkit-334NGEOE.cjs +7 -0
  167. package/dist/integration-toolkit-5VCY6CUN.js +7 -0
  168. package/dist/{integration-toolkit.d-BW9RK5G-.d.cts → integration-toolkit.d-BSA9RRdq.d.cts} +22 -4
  169. package/dist/{integration-toolkit.d-BW9RK5G-.d.ts → integration-toolkit.d-BSA9RRdq.d.ts} +22 -4
  170. package/dist/journey-4DIIPRU4.js +7 -0
  171. package/dist/journey-ATC3Y5AW.cjs +7 -0
  172. package/dist/{journey.d-B1sOeMHw.d.cts → journey.d-BenIUWaO.d.cts} +3 -16
  173. package/dist/{journey.d-B1sOeMHw.d.ts → journey.d-BenIUWaO.d.ts} +3 -16
  174. package/dist/js-yaml-DLCVPJ7G.js +0 -0
  175. package/dist/{targeting-WC62BBZN.cjs → targeting-DAFJBPIZ.cjs} +1 -1
  176. package/dist/{targeting-X4Y2ODBT.js → targeting-TGPCRRI6.js} +1 -1
  177. package/dist/{targeting.d-0rNF7ErD.d.cts → targeting.d-DxHQbn7-.d.cts} +4 -11
  178. package/dist/{targeting.d-0rNF7ErD.d.ts → targeting.d-DxHQbn7-.d.ts} +4 -11
  179. package/dist/user-7ZN2XO7G.cjs +7 -0
  180. package/dist/user-ZK7BK6VY.js +7 -0
  181. package/dist/user-runtime-7O2HLFVQ.cjs +5 -0
  182. package/dist/{user-runtime-6ICV2Y73.js → user-runtime-U4HYUWJU.js} +1 -1
  183. package/dist/{user.d-L-C7_K84.d.cts → user.d-D18fe97W.d.cts} +1 -421
  184. package/dist/{user.d-L-C7_K84.d.ts → user.d-D18fe97W.d.ts} +1 -421
  185. package/docs/access-token.md +3 -111
  186. package/docs/automation.md +37 -180
  187. package/docs/blueprint-manifest.md +95 -421
  188. package/docs/integration-toolkit.md +13 -0
  189. package/docs/journey.md +8 -28
  190. package/docs/targeting.md +3 -6
  191. package/docs/user.md +8 -321
  192. package/package.json +12 -20
  193. package/LICENSE +0 -21
  194. package/definitions/snapshot-runtime.json +0 -1
  195. package/definitions/snapshot.json +0 -973
  196. package/dist/README-NBWAQWQS.js +0 -7
  197. package/dist/README-XCIDDEAE.cjs +0 -7
  198. package/dist/access-token-GD6REL4U.js +0 -7
  199. package/dist/access-token-NQ5BLMOW.cjs +0 -7
  200. package/dist/apis/snapshot.cjs +0 -38
  201. package/dist/apis/snapshot.d.cts +0 -18
  202. package/dist/apis/snapshot.d.ts +0 -18
  203. package/dist/apis/snapshot.js +0 -38
  204. package/dist/automation-S6NFS5KU.cjs +0 -7
  205. package/dist/automation-W75XZG7B.js +0 -7
  206. package/dist/blueprint-manifest-WHYSBU66.cjs +0 -7
  207. package/dist/blueprint-manifest-WZVBTKUL.js +0 -7
  208. package/dist/chunk-54QNWEPZ.js +0 -14
  209. package/dist/chunk-NFIYEMMM.js +0 -14
  210. package/dist/chunk-OWXEZ56F.cjs +0 -14
  211. package/dist/chunk-YXJ4PBFQ.cjs +0 -14
  212. package/dist/integration-toolkit-27Z3VZBZ.cjs +0 -7
  213. package/dist/integration-toolkit-NRLZZFVS.js +0 -7
  214. package/dist/journey-LHVSSVTG.cjs +0 -7
  215. package/dist/journey-NXL264XW.js +0 -7
  216. package/dist/snapshot-6CCO4NYL.js +0 -7
  217. package/dist/snapshot-GWB56VPP.cjs +0 -7
  218. package/dist/snapshot-runtime-6DV42FVY.cjs +0 -5
  219. package/dist/snapshot-runtime-IW57MINC.js +0 -5
  220. package/dist/snapshot.d-D5z6-hzE.d.cts +0 -761
  221. package/dist/snapshot.d-D5z6-hzE.d.ts +0 -761
  222. package/dist/user-3SLAEEVD.cjs +0 -7
  223. package/dist/user-PRUYBXQV.js +0 -7
  224. package/dist/user-runtime-Y3227ETX.cjs +0 -5
  225. package/docs/snapshot.md +0 -656
@@ -1,761 +0,0 @@
1
- import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from snapshot-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Responses {
8
- export type BadRequest = Schemas.Error;
9
- export type NotFound = Schemas.Error;
10
- export type Unauthorized = Schemas.Error;
11
- export type UnprocessableEntity = /**
12
- * Returned (422) when the org inventory contains no capturable resources
13
- * after filtering out sensitive, unsupported, and excluded types. The
14
- * `skipped_types` array explains why every type was dropped.
15
- *
16
- */
17
- Schemas.EmptyInventoryError;
18
- }
19
- namespace Schemas {
20
- export interface CallerIdentity {
21
- name: string;
22
- user_id?: string;
23
- token_id?: string;
24
- }
25
- /**
26
- * Request body for `captureOrgSnapshot`. All fields optional — an empty body
27
- * snapshots the whole org with a default name and the 90-day default TTL.
28
- *
29
- */
30
- export interface CreateOrgSnapshotRequest {
31
- /**
32
- * Snapshot name. Defaults to "Org snapshot — <ISO timestamp>".
33
- */
34
- name?: string;
35
- /**
36
- * Retention window. Converted to an absolute `expires_at` at creation
37
- * time. Omit for the default 90-day TTL.
38
- *
39
- */
40
- retention?: {
41
- value: number;
42
- unit: "days" | "weeks" | "months";
43
- };
44
- /**
45
- * Resource types to exclude from the capture, in addition to the
46
- * always-excluded sensitive types (`access_token`,
47
- * `environment_variable`).
48
- *
49
- */
50
- excluded_types?: string[];
51
- }
52
- export interface CreateSnapshotRequest {
53
- name: string;
54
- description?: string;
55
- /**
56
- * What initiated this snapshot. `scheduled` is used for automatic
57
- * nightly backups triggered by an org's EventBridge schedule
58
- * (RFC — Scheduled org snapshots).
59
- *
60
- */
61
- trigger?: "manual" | "sync" | "blueprint_install" | "scheduled";
62
- /**
63
- * Required iff `trigger === 'blueprint_install'`; forbidden otherwise.
64
- * Identifies the destination blueprint instance whose install this
65
- * snapshot covers. Used at restore time as the join key for the
66
- * lineage-driven delete sweep.
67
- *
68
- */
69
- blueprint_instance_id?: string;
70
- /**
71
- * List of resources to capture. Required non-empty for
72
- * `trigger === 'manual'` or `'sync'`. May be empty when
73
- * `trigger === 'blueprint_install'` — an install with no
74
- * resources to overwrite still needs a snapshot row so the
75
- * blueprint-manifest-api restore endpoint can find it.
76
- *
77
- */
78
- resources: ResourceRef[];
79
- }
80
- export interface CreateSnapshotResponse {
81
- id: string;
82
- name: string;
83
- status: "creating";
84
- created_at: string; // date-time
85
- }
86
- /**
87
- * Returned (422) when the org inventory contains no capturable resources
88
- * after filtering out sensitive, unsupported, and excluded types. The
89
- * `skipped_types` array explains why every type was dropped.
90
- *
91
- */
92
- export interface EmptyInventoryError {
93
- /**
94
- * example:
95
- * No capturable resources in the org inventory
96
- */
97
- message: string;
98
- skipped_types: {
99
- type: string;
100
- reason: string;
101
- }[];
102
- }
103
- export interface Error {
104
- status: number;
105
- error: string;
106
- }
107
- export interface Operation {
108
- type: "create" | "restore";
109
- started_at: string; // date-time
110
- completed_at?: string; // date-time
111
- /**
112
- * `partial` indicates the operation completed but skipped at least
113
- * one resource — see `skipped`. Only populated by restores triggered
114
- * with `mode: 'preserve_edits'`.
115
- *
116
- */
117
- status: "in_progress" | "completed" | "partial" | "failed";
118
- error?: string;
119
- triggered_by: CallerIdentity;
120
- /**
121
- * Per-resource skips, populated only for restores triggered with
122
- * `mode: 'preserve_edits'`. Empty / absent for Config Hub's
123
- * default overwrite-mode restores.
124
- *
125
- */
126
- skipped?: SkippedResource[];
127
- }
128
- export interface ResourceRef {
129
- /**
130
- * Resource type (e.g., custom_variable, journey, automation_flow)
131
- */
132
- type: string;
133
- id: string;
134
- }
135
- /**
136
- * Skipped resources surface under `Operation.skipped`. All filters default
137
- * to the open setting (apply everything), which keeps Config Hub's manual-
138
- * restore semantics unchanged.
139
- *
140
- */
141
- export interface RestoreSnapshotRequest {
142
- /**
143
- * When `true`, skip captured resources whose live payload's content
144
- * fingerprint diverges from the capture-time fingerprint stored on
145
- * the manifest entry. Self-contained: snapshot-api fetches and hashes
146
- * the live payload itself; no cross-service lookup. Surfaces under
147
- * `Operation.skipped` with `reason: 'modified'`. Legacy snapshots
148
- * captured before fingerprints were stored fail open (applied).
149
- *
150
- */
151
- preserve_modified?: boolean;
152
- /**
153
- * Deprecated. Accepted for back-compat but treated as a no-op.
154
- * Co-ownership is now expressed via `exclude_target_ids` — the caller
155
- * (typically blueprint-manifest-api) computes which targets to skip
156
- * from its own data and passes the list. snapshot-api no longer
157
- * reaches into BMA's lineage table.
158
- *
159
- */
160
- preserve_co_owned?: boolean;
161
- /**
162
- * Target ids the caller has decided not to restore. snapshot-api
163
- * applies the manifest minus these ids and reports them under
164
- * `Operation.skipped` with `reason: 'co_owned'` (the only current
165
- * producer of exclude lists is BMA's revert flow, which uses this to
166
- * honor multi-blueprint ownership).
167
- *
168
- */
169
- exclude_target_ids?: string[];
170
- }
171
- export interface RestoreSnapshotResponse {
172
- id: string;
173
- status: "restoring";
174
- }
175
- export interface SkippedResource {
176
- lineage_id: string;
177
- /**
178
- * - `modified` — current destination payload's fingerprint differs
179
- * from the install-time fingerprint on the lineage row.
180
- * - `co_owned` — lineage row has ≥2 distinct
181
- * `blueprint_instance_ids`; restoring would unilaterally affect
182
- * another blueprint instance's contribution.
183
- *
184
- */
185
- reason: "modified" | "co_owned";
186
- }
187
- export interface Snapshot {
188
- id: string;
189
- org_id: string;
190
- name: string;
191
- description?: string;
192
- trigger: "manual" | "sync" | "blueprint_install" | "scheduled";
193
- /**
194
- * Set iff `trigger === 'blueprint_install'`. The destination blueprint
195
- * instance this snapshot covers.
196
- *
197
- */
198
- blueprint_instance_id?: string;
199
- /**
200
- * Resource type → count of resources of that type in the snapshot.
201
- */
202
- resource_counts: {
203
- [name: string]: number;
204
- };
205
- create: Operation;
206
- restores: Operation[];
207
- /**
208
- * Number of `resource` filter pairs from the request that are
209
- * contained in this snapshot. Present only on `listSnapshots`
210
- * responses where the caller passed at least one `resource`
211
- * filter — absent on `getSnapshot` and on unfiltered list calls.
212
- * Drives the coverage badge in Config Hub's snapshot picker.
213
- *
214
- */
215
- matched_count?: number;
216
- /**
217
- * Capture scope. `selection` (default for manual/sync/blueprint_install)
218
- * means only the explicitly listed resources were snapshotted.
219
- * `org` means a full org inventory was discovered and captured
220
- * (scheduled snapshots set this automatically).
221
- *
222
- */
223
- scope?: "selection" | "org";
224
- /**
225
- * ISO-8601 timestamp after which this snapshot will be deleted.
226
- * Derived from the org's retention setting at capture time for
227
- * scheduled snapshots; not set for manual snapshots (which use
228
- * a hardcoded 90-day TTL written directly as a DynamoDB `ttl` epoch).
229
- *
230
- */
231
- expires_at?: string; // date-time
232
- /**
233
- * Per-snapshot coverage report set by the capture worker on completion.
234
- * Records how many resources were attempted, captured, skipped
235
- * (unsupported type or explicitly excluded), and failed.
236
- *
237
- */
238
- capture_summary?: {
239
- /**
240
- * Total resources in the inventory that were attempted.
241
- */
242
- total: number;
243
- /**
244
- * Resources successfully fetched and written to the manifest.
245
- */
246
- captured: number;
247
- /**
248
- * Resources skipped — type not supported by config-engine or
249
- * excluded from capture (e.g. access_token, environment_variable).
250
- *
251
- */
252
- skipped: number;
253
- /**
254
- * Resources where the fetch call returned an error.
255
- */
256
- failed: number;
257
- };
258
- }
259
- /**
260
- * A single captured resource with its full payload. The identity fields
261
- * match `SnapshotResourceSummary`; the `captured` payload is the
262
- * pre-install state at snapshot time.
263
- *
264
- */
265
- export interface SnapshotResourceDetail {
266
- lineage_id: string;
267
- target_id: string;
268
- type: string;
269
- name?: string | null;
270
- /**
271
- * Full captured payload of the resource at snapshot time.
272
- */
273
- captured: {
274
- [name: string]: any;
275
- };
276
- }
277
- export interface SnapshotResourceList {
278
- resources: /**
279
- * Lightweight identity for a captured resource. Returned by
280
- * `listSnapshotResources`; the full payload is fetched separately via
281
- * `getSnapshotResource` when needed.
282
- *
283
- */
284
- SnapshotResourceSummary[];
285
- }
286
- /**
287
- * Lightweight identity for a captured resource. Returned by
288
- * `listSnapshotResources`; the full payload is fetched separately via
289
- * `getSnapshotResource` when needed.
290
- *
291
- */
292
- export interface SnapshotResourceSummary {
293
- /**
294
- * Deprecated alias of `target_id`. Always equals `target_id` (the
295
- * implementation never distinguished them). Use `target_id`.
296
- *
297
- */
298
- lineage_id: string;
299
- /**
300
- * Identifier the resource was captured by (passed in via `ResourceRef.id` on createSnapshot).
301
- */
302
- target_id: string;
303
- type: string;
304
- /**
305
- * Best-effort display name extracted from the captured payload
306
- * (`name` / `title` / `label` / `key` in that order). Null when
307
- * none of those fields are present.
308
- *
309
- */
310
- name?: string | null;
311
- }
312
- }
313
- }
314
- declare namespace Paths {
315
- namespace CaptureOrgSnapshot {
316
- export type RequestBody = /**
317
- * Request body for `captureOrgSnapshot`. All fields optional — an empty body
318
- * snapshots the whole org with a default name and the 90-day default TTL.
319
- *
320
- */
321
- Components.Schemas.CreateOrgSnapshotRequest;
322
- namespace Responses {
323
- export type $202 = Components.Schemas.CreateSnapshotResponse;
324
- export type $401 = Components.Responses.Unauthorized;
325
- export type $422 = Components.Responses.UnprocessableEntity;
326
- }
327
- }
328
- namespace CreateSnapshot {
329
- export type RequestBody = Components.Schemas.CreateSnapshotRequest;
330
- namespace Responses {
331
- export type $202 = Components.Schemas.CreateSnapshotResponse;
332
- export type $400 = Components.Responses.BadRequest;
333
- export type $401 = Components.Responses.Unauthorized;
334
- }
335
- }
336
- namespace DeleteSnapshot {
337
- namespace Responses {
338
- export interface $204 {
339
- }
340
- export type $401 = Components.Responses.Unauthorized;
341
- export type $404 = Components.Responses.NotFound;
342
- }
343
- }
344
- namespace GetSnapshot {
345
- namespace Responses {
346
- export type $200 = Components.Schemas.Snapshot;
347
- export type $401 = Components.Responses.Unauthorized;
348
- export type $404 = Components.Responses.NotFound;
349
- }
350
- }
351
- namespace GetSnapshotResource {
352
- namespace Responses {
353
- export type $200 = /**
354
- * A single captured resource with its full payload. The identity fields
355
- * match `SnapshotResourceSummary`; the `captured` payload is the
356
- * pre-install state at snapshot time.
357
- *
358
- */
359
- Components.Schemas.SnapshotResourceDetail;
360
- export type $401 = Components.Responses.Unauthorized;
361
- export type $404 = Components.Responses.NotFound;
362
- }
363
- }
364
- namespace ListDependencies {
365
- export interface RequestBody {
366
- resources: Components.Schemas.ResourceRef[];
367
- }
368
- namespace Responses {
369
- export interface $200 {
370
- dependencies: Components.Schemas.ResourceRef[];
371
- }
372
- export type $401 = Components.Responses.Unauthorized;
373
- export type $501 = Components.Schemas.Error;
374
- }
375
- }
376
- namespace ListSnapshotResources {
377
- namespace Responses {
378
- export type $200 = Components.Schemas.SnapshotResourceList;
379
- export type $401 = Components.Responses.Unauthorized;
380
- export type $404 = Components.Responses.NotFound;
381
- }
382
- }
383
- namespace ListSnapshots {
384
- namespace Parameters {
385
- export type Cursor = string;
386
- export type Resource = string /* ^[^:]+:.+$ */[];
387
- export type Size = number;
388
- export type Trigger = "manual" | "sync" | "blueprint_install" | "scheduled";
389
- }
390
- export interface QueryParameters {
391
- cursor?: Parameters.Cursor;
392
- size?: Parameters.Size;
393
- resource?: Parameters.Resource;
394
- trigger?: Parameters.Trigger;
395
- }
396
- namespace Responses {
397
- export interface $200 {
398
- /**
399
- * Number of items in this page (not the total across all pages).
400
- */
401
- page_size: number;
402
- /**
403
- * Pagination cursor; pass to the next request to get the next page.
404
- */
405
- cursor?: string;
406
- results: Components.Schemas.Snapshot[];
407
- }
408
- export type $401 = Components.Responses.Unauthorized;
409
- }
410
- }
411
- namespace RestoreSnapshot {
412
- export type RequestBody = /**
413
- * Skipped resources surface under `Operation.skipped`. All filters default
414
- * to the open setting (apply everything), which keeps Config Hub's manual-
415
- * restore semantics unchanged.
416
- *
417
- */
418
- Components.Schemas.RestoreSnapshotRequest;
419
- namespace Responses {
420
- export type $202 = Components.Schemas.RestoreSnapshotResponse;
421
- export type $401 = Components.Responses.Unauthorized;
422
- export type $404 = Components.Responses.NotFound;
423
- }
424
- }
425
- namespace V1Snapshots$Id {
426
- namespace Parameters {
427
- export type Id = string;
428
- }
429
- export interface PathParameters {
430
- id: Parameters.Id;
431
- }
432
- }
433
- namespace V1Snapshots$IdResources {
434
- namespace Parameters {
435
- export type Id = string;
436
- }
437
- export interface PathParameters {
438
- id: Parameters.Id;
439
- }
440
- }
441
- namespace V1Snapshots$IdResources$LineageId {
442
- namespace Parameters {
443
- export type Id = string;
444
- export type LineageId = string;
445
- }
446
- export interface PathParameters {
447
- id: Parameters.Id;
448
- lineage_id: Parameters.LineageId;
449
- }
450
- }
451
- namespace V1Snapshots$IdRestore {
452
- namespace Parameters {
453
- export type Id = string;
454
- }
455
- export interface PathParameters {
456
- id: Parameters.Id;
457
- }
458
- }
459
- }
460
-
461
-
462
- interface OperationMethods {
463
- /**
464
- * listSnapshots - listSnapshots
465
- *
466
- * List snapshots for the caller's organization, newest first.
467
- *
468
- * Pass `resource=<type>:<id>` one or more times to filter to snapshots
469
- * containing **any** of the listed resources (OR semantics). Each returned
470
- * snapshot includes a `matched_count` indicating how many of the filter
471
- * pairs are present in it. Hard cap of 50 filter pairs per request. When
472
- * filtered, pagination is not applied — the result set is bounded.
473
- *
474
- */
475
- 'listSnapshots'(
476
- parameters?: Parameters<Paths.ListSnapshots.QueryParameters> | null,
477
- data?: any,
478
- config?: AxiosRequestConfig
479
- ): OperationResponse<Paths.ListSnapshots.Responses.$200>
480
- /**
481
- * createSnapshot - createSnapshot
482
- *
483
- * Create a new snapshot of the given resources. Async — returns immediately
484
- * with a snapshot ID; client polls `getSnapshot` until `create.status`
485
- * moves from `in_progress` to `completed` or `failed`.
486
- *
487
- */
488
- 'createSnapshot'(
489
- parameters?: Parameters<UnknownParamsObject> | null,
490
- data?: Paths.CreateSnapshot.RequestBody,
491
- config?: AxiosRequestConfig
492
- ): OperationResponse<Paths.CreateSnapshot.Responses.$202>
493
- /**
494
- * captureOrgSnapshot - captureOrgSnapshot
495
- *
496
- * Snapshot the caller's whole organization now. Fetches a fresh inventory
497
- * of the org's configuration resources from configuration-hub-api, persists
498
- * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
499
- * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
500
- * and watches `capture_summary` fill in until `create.status` moves from
501
- * `in_progress` to `completed` or `failed`.
502
- *
503
- * Sensitive types (`access_token`, `environment_variable`), types with no
504
- * engine adapter, and any `excluded_types` are dropped from the capture and
505
- * recorded in the snapshot's coverage report.
506
- *
507
- */
508
- 'captureOrgSnapshot'(
509
- parameters?: Parameters<UnknownParamsObject> | null,
510
- data?: Paths.CaptureOrgSnapshot.RequestBody,
511
- config?: AxiosRequestConfig
512
- ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
513
- /**
514
- * getSnapshot - getSnapshot
515
- *
516
- * Fetch a snapshot's metadata. Poll this endpoint to track create/restore progress.
517
- */
518
- 'getSnapshot'(
519
- parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
520
- data?: any,
521
- config?: AxiosRequestConfig
522
- ): OperationResponse<Paths.GetSnapshot.Responses.$200>
523
- /**
524
- * deleteSnapshot - deleteSnapshot
525
- *
526
- * Delete a snapshot's metadata and S3 manifest.
527
- */
528
- 'deleteSnapshot'(
529
- parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
530
- data?: any,
531
- config?: AxiosRequestConfig
532
- ): OperationResponse<Paths.DeleteSnapshot.Responses.$204>
533
- /**
534
- * restoreSnapshot - restoreSnapshot
535
- *
536
- * Restore a snapshot to the org. Async — returns immediately; client polls
537
- * `getSnapshot` until the latest entry in `restores` moves from
538
- * `in_progress` to one of `completed | partial | failed`.
539
- *
540
- * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
541
- * question — see RFC OQ #1.
542
- *
543
- */
544
- 'restoreSnapshot'(
545
- parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
546
- data?: Paths.RestoreSnapshot.RequestBody,
547
- config?: AxiosRequestConfig
548
- ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
549
- /**
550
- * listSnapshotResources - listSnapshotResources
551
- *
552
- * List the resources captured in this snapshot. Returns lightweight
553
- * identity fields per resource — payloads are fetched via the
554
- * single-resource endpoint when needed.
555
- *
556
- * Used by Config Hub UI to render snapshot contents, and by
557
- * blueprint-manifest-api to partition lineage rows during a restore
558
- * sweep (resources in this list are touched; others are net-new).
559
- *
560
- */
561
- 'listSnapshotResources'(
562
- parameters?: Parameters<Paths.V1Snapshots$IdResources.PathParameters> | null,
563
- data?: any,
564
- config?: AxiosRequestConfig
565
- ): OperationResponse<Paths.ListSnapshotResources.Responses.$200>
566
- /**
567
- * getSnapshotResource - getSnapshotResource
568
- *
569
- * Fetch one captured resource with its full payload. For UI views
570
- * that diff the captured state against the current destination.
571
- *
572
- */
573
- 'getSnapshotResource'(
574
- parameters?: Parameters<Paths.V1Snapshots$IdResources$LineageId.PathParameters> | null,
575
- data?: any,
576
- config?: AxiosRequestConfig
577
- ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
578
- /**
579
- * listDependencies - listDependencies
580
- *
581
- * Walk the dependency tree for a set of resources and return the full
582
- * transitive closure, topologically sorted.
583
- *
584
- * **Not implemented in v1.** Returns 501. Callers should pass an explicit
585
- * resource list to `createSnapshot`. See RFC Phase 5.
586
- *
587
- */
588
- 'listDependencies'(
589
- parameters?: Parameters<UnknownParamsObject> | null,
590
- data?: Paths.ListDependencies.RequestBody,
591
- config?: AxiosRequestConfig
592
- ): OperationResponse<Paths.ListDependencies.Responses.$200>
593
- }
594
-
595
- interface PathsDictionary {
596
- ['/v1/snapshots']: {
597
- /**
598
- * createSnapshot - createSnapshot
599
- *
600
- * Create a new snapshot of the given resources. Async — returns immediately
601
- * with a snapshot ID; client polls `getSnapshot` until `create.status`
602
- * moves from `in_progress` to `completed` or `failed`.
603
- *
604
- */
605
- 'post'(
606
- parameters?: Parameters<UnknownParamsObject> | null,
607
- data?: Paths.CreateSnapshot.RequestBody,
608
- config?: AxiosRequestConfig
609
- ): OperationResponse<Paths.CreateSnapshot.Responses.$202>
610
- /**
611
- * listSnapshots - listSnapshots
612
- *
613
- * List snapshots for the caller's organization, newest first.
614
- *
615
- * Pass `resource=<type>:<id>` one or more times to filter to snapshots
616
- * containing **any** of the listed resources (OR semantics). Each returned
617
- * snapshot includes a `matched_count` indicating how many of the filter
618
- * pairs are present in it. Hard cap of 50 filter pairs per request. When
619
- * filtered, pagination is not applied — the result set is bounded.
620
- *
621
- */
622
- 'get'(
623
- parameters?: Parameters<Paths.ListSnapshots.QueryParameters> | null,
624
- data?: any,
625
- config?: AxiosRequestConfig
626
- ): OperationResponse<Paths.ListSnapshots.Responses.$200>
627
- }
628
- ['/v1/snapshots:capture-org']: {
629
- /**
630
- * captureOrgSnapshot - captureOrgSnapshot
631
- *
632
- * Snapshot the caller's whole organization now. Fetches a fresh inventory
633
- * of the org's configuration resources from configuration-hub-api, persists
634
- * it as an inventory artifact, and starts a `scope: "org"` chunked capture.
635
- * Async — returns immediately with a snapshot ID; client polls `getSnapshot`
636
- * and watches `capture_summary` fill in until `create.status` moves from
637
- * `in_progress` to `completed` or `failed`.
638
- *
639
- * Sensitive types (`access_token`, `environment_variable`), types with no
640
- * engine adapter, and any `excluded_types` are dropped from the capture and
641
- * recorded in the snapshot's coverage report.
642
- *
643
- */
644
- 'post'(
645
- parameters?: Parameters<UnknownParamsObject> | null,
646
- data?: Paths.CaptureOrgSnapshot.RequestBody,
647
- config?: AxiosRequestConfig
648
- ): OperationResponse<Paths.CaptureOrgSnapshot.Responses.$202>
649
- }
650
- ['/v1/snapshots/{id}']: {
651
- /**
652
- * getSnapshot - getSnapshot
653
- *
654
- * Fetch a snapshot's metadata. Poll this endpoint to track create/restore progress.
655
- */
656
- 'get'(
657
- parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
658
- data?: any,
659
- config?: AxiosRequestConfig
660
- ): OperationResponse<Paths.GetSnapshot.Responses.$200>
661
- /**
662
- * deleteSnapshot - deleteSnapshot
663
- *
664
- * Delete a snapshot's metadata and S3 manifest.
665
- */
666
- 'delete'(
667
- parameters?: Parameters<Paths.V1Snapshots$Id.PathParameters> | null,
668
- data?: any,
669
- config?: AxiosRequestConfig
670
- ): OperationResponse<Paths.DeleteSnapshot.Responses.$204>
671
- }
672
- ['/v1/snapshots/{id}:restore']: {
673
- /**
674
- * restoreSnapshot - restoreSnapshot
675
- *
676
- * Restore a snapshot to the org. Async — returns immediately; client polls
677
- * `getSnapshot` until the latest entry in `restores` moves from
678
- * `in_progress` to one of `completed | partial | failed`.
679
- *
680
- * v1: full restore only. Cherry-pick (`resources?` body filter) is an open
681
- * question — see RFC OQ #1.
682
- *
683
- */
684
- 'post'(
685
- parameters?: Parameters<Paths.V1Snapshots$IdRestore.PathParameters> | null,
686
- data?: Paths.RestoreSnapshot.RequestBody,
687
- config?: AxiosRequestConfig
688
- ): OperationResponse<Paths.RestoreSnapshot.Responses.$202>
689
- }
690
- ['/v1/snapshots/{id}/resources']: {
691
- /**
692
- * listSnapshotResources - listSnapshotResources
693
- *
694
- * List the resources captured in this snapshot. Returns lightweight
695
- * identity fields per resource — payloads are fetched via the
696
- * single-resource endpoint when needed.
697
- *
698
- * Used by Config Hub UI to render snapshot contents, and by
699
- * blueprint-manifest-api to partition lineage rows during a restore
700
- * sweep (resources in this list are touched; others are net-new).
701
- *
702
- */
703
- 'get'(
704
- parameters?: Parameters<Paths.V1Snapshots$IdResources.PathParameters> | null,
705
- data?: any,
706
- config?: AxiosRequestConfig
707
- ): OperationResponse<Paths.ListSnapshotResources.Responses.$200>
708
- }
709
- ['/v1/snapshots/{id}/resources/{lineage_id}']: {
710
- /**
711
- * getSnapshotResource - getSnapshotResource
712
- *
713
- * Fetch one captured resource with its full payload. For UI views
714
- * that diff the captured state against the current destination.
715
- *
716
- */
717
- 'get'(
718
- parameters?: Parameters<Paths.V1Snapshots$IdResources$LineageId.PathParameters> | null,
719
- data?: any,
720
- config?: AxiosRequestConfig
721
- ): OperationResponse<Paths.GetSnapshotResource.Responses.$200>
722
- }
723
- ['/v1/snapshots:list-dependencies']: {
724
- /**
725
- * listDependencies - listDependencies
726
- *
727
- * Walk the dependency tree for a set of resources and return the full
728
- * transitive closure, topologically sorted.
729
- *
730
- * **Not implemented in v1.** Returns 501. Callers should pass an explicit
731
- * resource list to `createSnapshot`. See RFC Phase 5.
732
- *
733
- */
734
- 'post'(
735
- parameters?: Parameters<UnknownParamsObject> | null,
736
- data?: Paths.ListDependencies.RequestBody,
737
- config?: AxiosRequestConfig
738
- ): OperationResponse<Paths.ListDependencies.Responses.$200>
739
- }
740
- }
741
-
742
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
743
-
744
-
745
- type CallerIdentity = Components.Schemas.CallerIdentity;
746
- type CreateOrgSnapshotRequest = Components.Schemas.CreateOrgSnapshotRequest;
747
- type CreateSnapshotRequest = Components.Schemas.CreateSnapshotRequest;
748
- type CreateSnapshotResponse = Components.Schemas.CreateSnapshotResponse;
749
- type EmptyInventoryError = Components.Schemas.EmptyInventoryError;
750
- type Error = Components.Schemas.Error;
751
- type Operation = Components.Schemas.Operation;
752
- type ResourceRef = Components.Schemas.ResourceRef;
753
- type RestoreSnapshotRequest = Components.Schemas.RestoreSnapshotRequest;
754
- type RestoreSnapshotResponse = Components.Schemas.RestoreSnapshotResponse;
755
- type SkippedResource = Components.Schemas.SkippedResource;
756
- type Snapshot = Components.Schemas.Snapshot;
757
- type SnapshotResourceDetail = Components.Schemas.SnapshotResourceDetail;
758
- type SnapshotResourceList = Components.Schemas.SnapshotResourceList;
759
- type SnapshotResourceSummary = Components.Schemas.SnapshotResourceSummary;
760
-
761
- export { type Client as C, type EmptyInventoryError as E, type OperationMethods as O, Paths as P, type ResourceRef as R, type SkippedResource 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 Snapshot as k, type SnapshotResourceDetail as l, type SnapshotResourceList as m, type SnapshotResourceSummary as n };