@epilot/sdk 2.18.16 → 2.18.18
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/app.json +34 -17
- package/definitions/configuration-hub-runtime.json +1 -1
- package/definitions/configuration-hub.json +1064 -48
- 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.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- 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 +8 -8
- package/dist/apis/configuration-hub.d.cts +2 -2
- package/dist/apis/configuration-hub.d.ts +2 -2
- package/dist/apis/configuration-hub.js +2 -2
- 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.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.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/app-IXCUVIHD.js +7 -0
- package/dist/app-RKHOTF7Z.cjs +7 -0
- package/dist/{app.d-vPrbhe5h.d.cts → app.d-CZDjyxee.d.cts} +22 -15
- package/dist/{app.d-vPrbhe5h.d.ts → app.d-CZDjyxee.d.ts} +22 -15
- package/dist/chunk-2674L26S.cjs +14 -0
- package/dist/{chunk-WCFT56OJ.cjs → chunk-GZMYWGJR.cjs} +3 -3
- package/dist/chunk-TH4IM6Q6.js +14 -0
- package/dist/{chunk-S7LXTIGZ.js → chunk-WCF2QVZE.js} +3 -3
- package/dist/configuration-hub-6TSL5AGX.cjs +7 -0
- package/dist/configuration-hub-ZYOLN7ZX.js +7 -0
- package/dist/{configuration-hub-runtime-QVLJKEZD.cjs → configuration-hub-runtime-3RFJBODE.cjs} +2 -2
- package/dist/{configuration-hub-runtime-CXME7TCX.js → configuration-hub-runtime-EG2OIBXX.js} +1 -1
- package/dist/{configuration-hub.d-CbSJDa7k.d.cts → configuration-hub.d-Dv41yC3b.d.cts} +929 -84
- package/dist/{configuration-hub.d-CbSJDa7k.d.ts → configuration-hub.d-Dv41yC3b.d.ts} +929 -84
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/app.md +43 -88
- package/docs/configuration-hub.md +967 -40
- package/package.json +1 -1
- package/dist/app-A7P5LKNL.cjs +0 -7
- package/dist/app-EEEBOCVZ.js +0 -7
- package/dist/chunk-MOLFG5L4.cjs +0 -14
- package/dist/chunk-WW6DVKJR.js +0 -14
- package/dist/configuration-hub-E7S4JB2T.js +0 -7
- package/dist/configuration-hub-Q5JBYB52.cjs +0 -7
|
@@ -13,6 +13,7 @@ declare namespace Components {
|
|
|
13
13
|
*/
|
|
14
14
|
Schemas.ResourceType;
|
|
15
15
|
export type CursorParam = string;
|
|
16
|
+
export type DeleteJobId = string;
|
|
16
17
|
export type SizeParam = number;
|
|
17
18
|
export type SyncJobId = string;
|
|
18
19
|
}
|
|
@@ -20,12 +21,100 @@ declare namespace Components {
|
|
|
20
21
|
ConfigType?: Parameters.ConfigType;
|
|
21
22
|
ConfigId?: Parameters.ConfigId;
|
|
22
23
|
SyncJobId?: Parameters.SyncJobId;
|
|
24
|
+
DeleteJobId?: Parameters.DeleteJobId;
|
|
23
25
|
}
|
|
24
26
|
export interface QueryParameters {
|
|
25
27
|
CursorParam?: Parameters.CursorParam;
|
|
26
28
|
SizeParam?: Parameters.SizeParam;
|
|
27
29
|
}
|
|
28
30
|
namespace Schemas {
|
|
31
|
+
export interface BreakLineageResponse {
|
|
32
|
+
deleted: boolean;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Row counts per match status
|
|
36
|
+
*/
|
|
37
|
+
export interface CompareCounts {
|
|
38
|
+
matched: number;
|
|
39
|
+
only_current: number;
|
|
40
|
+
only_source: number;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Provenance of a lineage-backed match
|
|
44
|
+
*/
|
|
45
|
+
export interface CompareLineage {
|
|
46
|
+
/**
|
|
47
|
+
* `pull` — the caller org imported this config from the source org
|
|
48
|
+
* (entry lives in the caller's lineage partition). `push` — the
|
|
49
|
+
* source org imported it from the caller (entry lives in the source
|
|
50
|
+
* org's partition).
|
|
51
|
+
*
|
|
52
|
+
*/
|
|
53
|
+
direction: "pull" | "push";
|
|
54
|
+
last_synced_at?: string; // date-time
|
|
55
|
+
last_sync_job_id?: string;
|
|
56
|
+
/**
|
|
57
|
+
* `manual_confirm` when the entry was created by confirming a
|
|
58
|
+
* heuristic suggestion in the Compare view; absent for sync-written
|
|
59
|
+
* entries.
|
|
60
|
+
*
|
|
61
|
+
*/
|
|
62
|
+
origin?: string;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Request body for a per-type cross-org comparison
|
|
66
|
+
*/
|
|
67
|
+
export interface CompareRequest {
|
|
68
|
+
/**
|
|
69
|
+
* Organization to compare the caller's org against
|
|
70
|
+
*/
|
|
71
|
+
source_org_id: string;
|
|
72
|
+
/**
|
|
73
|
+
* Auth token belonging to `source_org_id` (e.g. a pipeline token).
|
|
74
|
+
* Verified before any source-org data is read. Never logged.
|
|
75
|
+
*
|
|
76
|
+
*/
|
|
77
|
+
source_auth_token: string;
|
|
78
|
+
type: /**
|
|
79
|
+
* Configuration resource type identifier.
|
|
80
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
81
|
+
*
|
|
82
|
+
*/
|
|
83
|
+
ResourceType;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Side-by-side comparison of one config type across two orgs
|
|
87
|
+
*/
|
|
88
|
+
export interface CompareResponse {
|
|
89
|
+
type: /**
|
|
90
|
+
* Configuration resource type identifier.
|
|
91
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
92
|
+
*
|
|
93
|
+
*/
|
|
94
|
+
ResourceType;
|
|
95
|
+
label: string;
|
|
96
|
+
icon: string;
|
|
97
|
+
rows: /**
|
|
98
|
+
* One row of the side-by-side comparison. `matched` rows carry both
|
|
99
|
+
* configs plus lineage provenance; one-sided rows carry only the side
|
|
100
|
+
* the config exists on.
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
CompareRow[];
|
|
104
|
+
counts: /* Row counts per match status */ CompareCounts;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* One row of the side-by-side comparison. `matched` rows carry both
|
|
108
|
+
* configs plus lineage provenance; one-sided rows carry only the side
|
|
109
|
+
* the config exists on.
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
export interface CompareRow {
|
|
113
|
+
match_status: "matched" | "only_current" | "only_source";
|
|
114
|
+
current?: /* Summary metadata for a single configuration item in the tree */ ConfigNode;
|
|
115
|
+
source?: /* Summary metadata for a single configuration item in the tree */ ConfigNode;
|
|
116
|
+
lineage?: /* Provenance of a lineage-backed match */ CompareLineage;
|
|
117
|
+
}
|
|
29
118
|
/**
|
|
30
119
|
* Cursor-paginated list of configs referenced by a given config
|
|
31
120
|
*/
|
|
@@ -40,6 +129,35 @@ declare namespace Components {
|
|
|
40
129
|
next_cursor?: string;
|
|
41
130
|
results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
|
|
42
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* Fresh inventory of all configuration resources for an org.
|
|
134
|
+
*/
|
|
135
|
+
export interface ConfigInventoryResponse {
|
|
136
|
+
/**
|
|
137
|
+
* Unique identifier for this inventory run (UUID).
|
|
138
|
+
*/
|
|
139
|
+
inventory_id: string;
|
|
140
|
+
/**
|
|
141
|
+
* Organization ID the inventory was collected for.
|
|
142
|
+
*/
|
|
143
|
+
org_id: string;
|
|
144
|
+
/**
|
|
145
|
+
* ISO timestamp of when the inventory was collected.
|
|
146
|
+
*/
|
|
147
|
+
indexed_at: string; // date-time
|
|
148
|
+
/**
|
|
149
|
+
* Total number of resources found across all types.
|
|
150
|
+
*/
|
|
151
|
+
resources_count: number;
|
|
152
|
+
/**
|
|
153
|
+
* List of all found resources as `{ type, id }` pairs.
|
|
154
|
+
*/
|
|
155
|
+
resources: /* Minimal identity of a single configuration resource. */ SnapshotInventoryItem[];
|
|
156
|
+
/**
|
|
157
|
+
* Types that failed to list or had no adapter; never fail the whole inventory.
|
|
158
|
+
*/
|
|
159
|
+
skipped_types: /* A type that could not be listed during inventory collection. */ SnapshotInventorySkippedType[];
|
|
160
|
+
}
|
|
43
161
|
/**
|
|
44
162
|
* Cursor-paginated list of configs for a specific type
|
|
45
163
|
*/
|
|
@@ -158,7 +276,143 @@ declare namespace Components {
|
|
|
158
276
|
* @epilot/sdk/journey
|
|
159
277
|
*/
|
|
160
278
|
sdk_client: string;
|
|
279
|
+
/**
|
|
280
|
+
* Whether resources of this type can be deleted via the bulk-delete API
|
|
281
|
+
* example:
|
|
282
|
+
* true
|
|
283
|
+
*/
|
|
284
|
+
deletable: boolean;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* Persist a source→target lineage pairing (caller org as target)
|
|
288
|
+
*/
|
|
289
|
+
export interface ConfirmLineageRequest {
|
|
290
|
+
type: /**
|
|
291
|
+
* Configuration resource type identifier.
|
|
292
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
293
|
+
*
|
|
294
|
+
*/
|
|
295
|
+
ResourceType;
|
|
296
|
+
source_org_id: string;
|
|
297
|
+
/**
|
|
298
|
+
* Config id in the source org
|
|
299
|
+
*/
|
|
300
|
+
source_id: string;
|
|
301
|
+
/**
|
|
302
|
+
* Config id in the caller's org to pair it with
|
|
303
|
+
*/
|
|
304
|
+
target_id: string;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Bulk-delete job header surfaced by `createDeleteJob`/`getDeleteJob`.
|
|
308
|
+
*/
|
|
309
|
+
export interface DeleteJob {
|
|
310
|
+
id: string;
|
|
311
|
+
name?: string;
|
|
312
|
+
status: /* Lifecycle status of a bulk-delete job. */ DeleteJobStatus;
|
|
313
|
+
org_id: string;
|
|
314
|
+
counts: /* Aggregate counters by resource delete status. */ DeleteJobCounts;
|
|
315
|
+
started_at: string; // date-time
|
|
316
|
+
finished_at?: string; // date-time
|
|
317
|
+
/**
|
|
318
|
+
* True once the worker has kicked the index rebuild on completion.
|
|
319
|
+
*/
|
|
320
|
+
rebuild_triggered?: boolean;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Aggregate counters by resource delete status.
|
|
324
|
+
*/
|
|
325
|
+
export interface DeleteJobCounts {
|
|
326
|
+
total: number;
|
|
327
|
+
pending: number;
|
|
328
|
+
in_progress: number;
|
|
329
|
+
deleted: number;
|
|
330
|
+
skipped: number;
|
|
331
|
+
failed: number;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Cursor-paginated list of delete jobs.
|
|
335
|
+
*/
|
|
336
|
+
export interface DeleteJobListResponse {
|
|
337
|
+
next_cursor?: string;
|
|
338
|
+
results: /* Bulk-delete job header surfaced by `createDeleteJob`/`getDeleteJob`. */ DeleteJob[];
|
|
161
339
|
}
|
|
340
|
+
/**
|
|
341
|
+
* Request body for `createDeleteJob`.
|
|
342
|
+
*/
|
|
343
|
+
export interface DeleteJobRequest {
|
|
344
|
+
/**
|
|
345
|
+
* Optional human-friendly job name shown in the history list.
|
|
346
|
+
*/
|
|
347
|
+
name?: string;
|
|
348
|
+
/**
|
|
349
|
+
* The resources to delete, by type + id.
|
|
350
|
+
*/
|
|
351
|
+
resources: [
|
|
352
|
+
{
|
|
353
|
+
/**
|
|
354
|
+
* Resource type identifier
|
|
355
|
+
*/
|
|
356
|
+
type: string;
|
|
357
|
+
/**
|
|
358
|
+
* Resource ID
|
|
359
|
+
*/
|
|
360
|
+
id: string;
|
|
361
|
+
/**
|
|
362
|
+
* Optional human-readable title captured for the failures view.
|
|
363
|
+
*/
|
|
364
|
+
title?: string;
|
|
365
|
+
},
|
|
366
|
+
...{
|
|
367
|
+
/**
|
|
368
|
+
* Resource type identifier
|
|
369
|
+
*/
|
|
370
|
+
type: string;
|
|
371
|
+
/**
|
|
372
|
+
* Resource ID
|
|
373
|
+
*/
|
|
374
|
+
id: string;
|
|
375
|
+
/**
|
|
376
|
+
* Optional human-readable title captured for the failures view.
|
|
377
|
+
*/
|
|
378
|
+
title?: string;
|
|
379
|
+
}[]
|
|
380
|
+
];
|
|
381
|
+
}
|
|
382
|
+
/**
|
|
383
|
+
* Per-resource row for a delete job.
|
|
384
|
+
*/
|
|
385
|
+
export interface DeleteJobResource {
|
|
386
|
+
type: string;
|
|
387
|
+
id: string;
|
|
388
|
+
title?: string;
|
|
389
|
+
status: /**
|
|
390
|
+
* Per-resource delete status. `skipped` is used for protected resources
|
|
391
|
+
* that are intentionally not deleted (e.g. built-in schemas).
|
|
392
|
+
*
|
|
393
|
+
*/
|
|
394
|
+
DeleteJobResourceStatus;
|
|
395
|
+
attempt: number;
|
|
396
|
+
error?: string;
|
|
397
|
+
updated_at: string; // date-time
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* Cursor-paginated list of delete job resources.
|
|
401
|
+
*/
|
|
402
|
+
export interface DeleteJobResourceListResponse {
|
|
403
|
+
next_cursor?: string;
|
|
404
|
+
results: /* Per-resource row for a delete job. */ DeleteJobResource[];
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* Per-resource delete status. `skipped` is used for protected resources
|
|
408
|
+
* that are intentionally not deleted (e.g. built-in schemas).
|
|
409
|
+
*
|
|
410
|
+
*/
|
|
411
|
+
export type DeleteJobResourceStatus = "pending" | "in_progress" | "deleted" | "skipped" | "failed";
|
|
412
|
+
/**
|
|
413
|
+
* Lifecycle status of a bulk-delete job.
|
|
414
|
+
*/
|
|
415
|
+
export type DeleteJobStatus = "pending" | "in_progress" | "succeeded" | "partial" | "failed" | "cancelled";
|
|
162
416
|
export interface ErrorResponse {
|
|
163
417
|
status: number;
|
|
164
418
|
error: string;
|
|
@@ -178,16 +432,127 @@ declare namespace Components {
|
|
|
178
432
|
*/
|
|
179
433
|
export interface IndexStatusResponse {
|
|
180
434
|
status: "missing" | "building" | "ready" | "failed";
|
|
435
|
+
/**
|
|
436
|
+
* Organization the index (and the authenticated token) belongs to.
|
|
437
|
+
* Echoed so callers holding a token for another org can resolve and
|
|
438
|
+
* verify its identity.
|
|
439
|
+
*
|
|
440
|
+
*/
|
|
441
|
+
org_id?: string;
|
|
181
442
|
last_built_at?: string; // date-time
|
|
182
443
|
total_items?: number;
|
|
183
444
|
build_duration_ms?: number;
|
|
184
445
|
}
|
|
446
|
+
/**
|
|
447
|
+
* A persisted lineage entry
|
|
448
|
+
*/
|
|
449
|
+
export interface LineageEntryResponse {
|
|
450
|
+
type: /**
|
|
451
|
+
* Configuration resource type identifier.
|
|
452
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
453
|
+
*
|
|
454
|
+
*/
|
|
455
|
+
ResourceType;
|
|
456
|
+
target_org_id: string;
|
|
457
|
+
source_org_id: string;
|
|
458
|
+
source_id: string;
|
|
459
|
+
target_id: string;
|
|
460
|
+
last_synced_at?: string; // date-time
|
|
461
|
+
origin?: string;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* Heuristic candidate for one source config (null candidate = no match)
|
|
465
|
+
*/
|
|
466
|
+
export interface MatchSuggestion {
|
|
467
|
+
source_id: string;
|
|
468
|
+
candidate?: {
|
|
469
|
+
id: string;
|
|
470
|
+
title?: string;
|
|
471
|
+
} | null;
|
|
472
|
+
}
|
|
185
473
|
/**
|
|
186
474
|
* Configuration resource type identifier.
|
|
187
475
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
188
476
|
*
|
|
189
477
|
*/
|
|
190
478
|
export type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "document_template" | "webhook" | "saved_view" | "dashboard" | "kanban" | "role" | "usergroup" | "validation_rule" | "integration" | "app" | "designbuilder" | "notification_template" | "custom_variable" | "environment_variable" | "taxonomy" | "taxonomy_classification" | "entity_mapping" | "portal_config" | "target" | "product_recommendation" | "access_token";
|
|
479
|
+
/**
|
|
480
|
+
* Minimal identity of a single configuration resource.
|
|
481
|
+
*/
|
|
482
|
+
export interface SnapshotInventoryItem {
|
|
483
|
+
type: /**
|
|
484
|
+
* Configuration resource type identifier.
|
|
485
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
486
|
+
*
|
|
487
|
+
*/
|
|
488
|
+
ResourceType;
|
|
489
|
+
/**
|
|
490
|
+
* Unique identifier of the resource
|
|
491
|
+
*/
|
|
492
|
+
id: string;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* A type that could not be listed during inventory collection.
|
|
496
|
+
*/
|
|
497
|
+
export interface SnapshotInventorySkippedType {
|
|
498
|
+
type: string;
|
|
499
|
+
reason: string;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Request body for batched heuristic match suggestions
|
|
503
|
+
*/
|
|
504
|
+
export interface SuggestMatchesRequest {
|
|
505
|
+
source_org_id: string;
|
|
506
|
+
/**
|
|
507
|
+
* Auth token belonging to `source_org_id`. Never logged.
|
|
508
|
+
*/
|
|
509
|
+
source_auth_token: string;
|
|
510
|
+
type: /**
|
|
511
|
+
* Configuration resource type identifier.
|
|
512
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
513
|
+
*
|
|
514
|
+
*/
|
|
515
|
+
ResourceType;
|
|
516
|
+
/**
|
|
517
|
+
* Source-org config ids to find caller-org candidates for
|
|
518
|
+
*/
|
|
519
|
+
source_ids: [
|
|
520
|
+
string,
|
|
521
|
+
string?,
|
|
522
|
+
string?,
|
|
523
|
+
string?,
|
|
524
|
+
string?,
|
|
525
|
+
string?,
|
|
526
|
+
string?,
|
|
527
|
+
string?,
|
|
528
|
+
string?,
|
|
529
|
+
string?,
|
|
530
|
+
string?,
|
|
531
|
+
string?,
|
|
532
|
+
string?,
|
|
533
|
+
string?,
|
|
534
|
+
string?,
|
|
535
|
+
string?,
|
|
536
|
+
string?,
|
|
537
|
+
string?,
|
|
538
|
+
string?,
|
|
539
|
+
string?,
|
|
540
|
+
string?,
|
|
541
|
+
string?,
|
|
542
|
+
string?,
|
|
543
|
+
string?,
|
|
544
|
+
string?
|
|
545
|
+
];
|
|
546
|
+
}
|
|
547
|
+
export interface SuggestMatchesResponse {
|
|
548
|
+
type: /**
|
|
549
|
+
* Configuration resource type identifier.
|
|
550
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
551
|
+
*
|
|
552
|
+
*/
|
|
553
|
+
ResourceType;
|
|
554
|
+
suggestions: /* Heuristic candidate for one source config (null candidate = no match) */ MatchSuggestion[];
|
|
555
|
+
}
|
|
191
556
|
/**
|
|
192
557
|
* Direction of the sync, derived from the source/target pane selection in the
|
|
193
558
|
* configuration hub UI.
|
|
@@ -476,6 +841,13 @@ declare namespace Components {
|
|
|
476
841
|
type: string;
|
|
477
842
|
source_id: string;
|
|
478
843
|
target_id?: string;
|
|
844
|
+
/**
|
|
845
|
+
* Human-readable resource title captured from the source payload
|
|
846
|
+
* during Phase 0. Lets clients identify rows without resolving
|
|
847
|
+
* raw UUIDs. Absent on rows written before this field existed.
|
|
848
|
+
*
|
|
849
|
+
*/
|
|
850
|
+
title?: string;
|
|
479
851
|
status: /**
|
|
480
852
|
* Per-resource status. `would_*` values are produced by dry-run jobs.
|
|
481
853
|
*
|
|
@@ -511,8 +883,8 @@ declare namespace Components {
|
|
|
511
883
|
*/
|
|
512
884
|
export type SyncJobResourceStatus = "pending" | "in_progress" | "created" | "patched" | "skipped" | "would_create" | "would_patch" | "would_skip_unchanged" | "would_match_heuristic" | "failed";
|
|
513
885
|
/**
|
|
514
|
-
* Optional body for `retrySyncJob`. Defaults to retrying every
|
|
515
|
-
* resource of the original job.
|
|
886
|
+
* Optional body for `retrySyncJob`. Defaults to retrying every unresolved
|
|
887
|
+
* resource of the original job (failed, pending or in_progress).
|
|
516
888
|
*
|
|
517
889
|
*/
|
|
518
890
|
export interface SyncJobRetryRequest {
|
|
@@ -542,6 +914,66 @@ declare namespace Components {
|
|
|
542
914
|
}
|
|
543
915
|
}
|
|
544
916
|
declare namespace Paths {
|
|
917
|
+
namespace BreakLineage {
|
|
918
|
+
namespace Parameters {
|
|
919
|
+
export type SourceId = string;
|
|
920
|
+
export type Type = /**
|
|
921
|
+
* Configuration resource type identifier.
|
|
922
|
+
* Matches blueprint-manifest-api V3 naming conventions.
|
|
923
|
+
*
|
|
924
|
+
*/
|
|
925
|
+
Components.Schemas.ResourceType;
|
|
926
|
+
}
|
|
927
|
+
export interface QueryParameters {
|
|
928
|
+
type: Parameters.Type;
|
|
929
|
+
source_id: Parameters.SourceId;
|
|
930
|
+
}
|
|
931
|
+
namespace Responses {
|
|
932
|
+
export type $200 = Components.Schemas.BreakLineageResponse;
|
|
933
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
934
|
+
}
|
|
935
|
+
}
|
|
936
|
+
namespace CancelSyncJob {
|
|
937
|
+
namespace Parameters {
|
|
938
|
+
export type Id = string;
|
|
939
|
+
}
|
|
940
|
+
export interface PathParameters {
|
|
941
|
+
id: Parameters.Id;
|
|
942
|
+
}
|
|
943
|
+
namespace Responses {
|
|
944
|
+
export type $200 = /**
|
|
945
|
+
* Sync job header as surfaced by `getSyncJob` and the create response. The
|
|
946
|
+
* canonical persistence shape is described in `docs/sync/INTERFACES.md`.
|
|
947
|
+
*
|
|
948
|
+
*/
|
|
949
|
+
Components.Schemas.SyncJob;
|
|
950
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
951
|
+
export type $409 = Components.Schemas.ErrorResponse;
|
|
952
|
+
}
|
|
953
|
+
}
|
|
954
|
+
namespace CompareConfigs {
|
|
955
|
+
export type RequestBody = /* Request body for a per-type cross-org comparison */ Components.Schemas.CompareRequest;
|
|
956
|
+
namespace Responses {
|
|
957
|
+
export type $200 = /* Side-by-side comparison of one config type across two orgs */ Components.Schemas.CompareResponse;
|
|
958
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
959
|
+
export type $403 = Components.Schemas.ErrorResponse;
|
|
960
|
+
}
|
|
961
|
+
}
|
|
962
|
+
namespace ConfirmLineage {
|
|
963
|
+
export type RequestBody = /* Persist a source→target lineage pairing (caller org as target) */ Components.Schemas.ConfirmLineageRequest;
|
|
964
|
+
namespace Responses {
|
|
965
|
+
export type $201 = /* A persisted lineage entry */ Components.Schemas.LineageEntryResponse;
|
|
966
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
967
|
+
export type $409 = Components.Schemas.ErrorResponse;
|
|
968
|
+
}
|
|
969
|
+
}
|
|
970
|
+
namespace CreateDeleteJob {
|
|
971
|
+
export type RequestBody = /* Request body for `createDeleteJob`. */ Components.Schemas.DeleteJobRequest;
|
|
972
|
+
namespace Responses {
|
|
973
|
+
export type $201 = /* Bulk-delete job header surfaced by `createDeleteJob`/`getDeleteJob`. */ Components.Schemas.DeleteJob;
|
|
974
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
975
|
+
}
|
|
976
|
+
}
|
|
545
977
|
namespace CreateSyncJob {
|
|
546
978
|
export type RequestBody = /**
|
|
547
979
|
* Request body for `createSyncJob`. `target_auth_token` is the destination
|
|
@@ -584,6 +1016,17 @@ declare namespace Paths {
|
|
|
584
1016
|
export type $404 = Components.Schemas.ErrorResponse;
|
|
585
1017
|
}
|
|
586
1018
|
}
|
|
1019
|
+
namespace GetConfigInventory {
|
|
1020
|
+
namespace Parameters {
|
|
1021
|
+
export type IncludeDependencyOnly = boolean;
|
|
1022
|
+
}
|
|
1023
|
+
export interface QueryParameters {
|
|
1024
|
+
include_dependency_only?: Parameters.IncludeDependencyOnly;
|
|
1025
|
+
}
|
|
1026
|
+
namespace Responses {
|
|
1027
|
+
export type $200 = /* Fresh inventory of all configuration resources for an org. */ Components.Schemas.ConfigInventoryResponse;
|
|
1028
|
+
}
|
|
1029
|
+
}
|
|
587
1030
|
namespace GetConfigUsedBy {
|
|
588
1031
|
namespace Parameters {
|
|
589
1032
|
export type Id = string;
|
|
@@ -602,6 +1045,18 @@ declare namespace Paths {
|
|
|
602
1045
|
export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
|
|
603
1046
|
}
|
|
604
1047
|
}
|
|
1048
|
+
namespace GetDeleteJob {
|
|
1049
|
+
namespace Parameters {
|
|
1050
|
+
export type Id = string;
|
|
1051
|
+
}
|
|
1052
|
+
export interface PathParameters {
|
|
1053
|
+
id: Parameters.Id;
|
|
1054
|
+
}
|
|
1055
|
+
namespace Responses {
|
|
1056
|
+
export type $200 = /* Bulk-delete job header surfaced by `createDeleteJob`/`getDeleteJob`. */ Components.Schemas.DeleteJob;
|
|
1057
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
1058
|
+
}
|
|
1059
|
+
}
|
|
605
1060
|
namespace GetIndex {
|
|
606
1061
|
namespace Responses {
|
|
607
1062
|
export type $200 = /* Current index build state */ Components.Schemas.IndexStatusResponse;
|
|
@@ -644,7 +1099,7 @@ declare namespace Paths {
|
|
|
644
1099
|
export type Purposes = string;
|
|
645
1100
|
export type Q = string;
|
|
646
1101
|
export type Size = number;
|
|
647
|
-
export type Sort = "updated_at" | "usage";
|
|
1102
|
+
export type Sort = "updated_at" | "usage" | "name";
|
|
648
1103
|
export type Type = /**
|
|
649
1104
|
* Configuration resource type identifier.
|
|
650
1105
|
* Matches blueprint-manifest-api V3 naming conventions.
|
|
@@ -673,6 +1128,37 @@ declare namespace Paths {
|
|
|
673
1128
|
export type $400 = Components.Schemas.ErrorResponse;
|
|
674
1129
|
}
|
|
675
1130
|
}
|
|
1131
|
+
namespace ListDeleteJobResources {
|
|
1132
|
+
namespace Parameters {
|
|
1133
|
+
export type Cursor = string;
|
|
1134
|
+
export type Id = string;
|
|
1135
|
+
export type Size = number;
|
|
1136
|
+
}
|
|
1137
|
+
export interface PathParameters {
|
|
1138
|
+
id: Parameters.Id;
|
|
1139
|
+
}
|
|
1140
|
+
export interface QueryParameters {
|
|
1141
|
+
cursor?: Parameters.Cursor;
|
|
1142
|
+
size?: Parameters.Size;
|
|
1143
|
+
}
|
|
1144
|
+
namespace Responses {
|
|
1145
|
+
export type $200 = /* Cursor-paginated list of delete job resources. */ Components.Schemas.DeleteJobResourceListResponse;
|
|
1146
|
+
export type $404 = Components.Schemas.ErrorResponse;
|
|
1147
|
+
}
|
|
1148
|
+
}
|
|
1149
|
+
namespace ListDeleteJobs {
|
|
1150
|
+
namespace Parameters {
|
|
1151
|
+
export type Cursor = string;
|
|
1152
|
+
export type Size = number;
|
|
1153
|
+
}
|
|
1154
|
+
export interface QueryParameters {
|
|
1155
|
+
cursor?: Parameters.Cursor;
|
|
1156
|
+
size?: Parameters.Size;
|
|
1157
|
+
}
|
|
1158
|
+
namespace Responses {
|
|
1159
|
+
export type $200 = /* Cursor-paginated list of delete jobs. */ Components.Schemas.DeleteJobListResponse;
|
|
1160
|
+
}
|
|
1161
|
+
}
|
|
676
1162
|
namespace ListSyncJobResources {
|
|
677
1163
|
namespace Parameters {
|
|
678
1164
|
export type Cursor = string;
|
|
@@ -730,8 +1216,8 @@ declare namespace Paths {
|
|
|
730
1216
|
id: Parameters.Id;
|
|
731
1217
|
}
|
|
732
1218
|
export type RequestBody = /**
|
|
733
|
-
* Optional body for `retrySyncJob`. Defaults to retrying every
|
|
734
|
-
* resource of the original job.
|
|
1219
|
+
* Optional body for `retrySyncJob`. Defaults to retrying every unresolved
|
|
1220
|
+
* resource of the original job (failed, pending or in_progress).
|
|
735
1221
|
*
|
|
736
1222
|
*/
|
|
737
1223
|
Components.Schemas.SyncJobRetryRequest;
|
|
@@ -745,340 +1231,699 @@ declare namespace Paths {
|
|
|
745
1231
|
export type $404 = Components.Schemas.ErrorResponse;
|
|
746
1232
|
}
|
|
747
1233
|
}
|
|
1234
|
+
namespace SuggestMatches {
|
|
1235
|
+
export type RequestBody = /* Request body for batched heuristic match suggestions */ Components.Schemas.SuggestMatchesRequest;
|
|
1236
|
+
namespace Responses {
|
|
1237
|
+
export type $200 = Components.Schemas.SuggestMatchesResponse;
|
|
1238
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
1239
|
+
}
|
|
1240
|
+
}
|
|
748
1241
|
}
|
|
749
1242
|
|
|
750
1243
|
|
|
751
1244
|
interface OperationMethods {
|
|
752
1245
|
/**
|
|
753
1246
|
* listConfigTypes - listConfigTypes
|
|
754
|
-
*
|
|
1247
|
+
*
|
|
755
1248
|
* Returns the static list of available configuration types with display metadata.
|
|
756
1249
|
* This is a cheap call — no fan-out to downstream APIs. Returns all known types
|
|
757
1250
|
* with labels and icons. The frontend should then call `listConfigs` separately
|
|
758
1251
|
* for each type it wants to load.
|
|
759
|
-
*
|
|
1252
|
+
*
|
|
760
1253
|
*/
|
|
761
1254
|
'listConfigTypes'(
|
|
762
1255
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
763
1256
|
data?: any,
|
|
764
|
-
config?: AxiosRequestConfig
|
|
1257
|
+
config?: AxiosRequestConfig
|
|
765
1258
|
): OperationResponse<Paths.ListConfigTypes.Responses.$200>
|
|
766
1259
|
/**
|
|
767
1260
|
* listConfigs - listConfigs
|
|
768
|
-
*
|
|
1261
|
+
*
|
|
769
1262
|
* List configs of a given type with pagination. Returns summary metadata only
|
|
770
1263
|
* (not full payloads). The frontend calls this per type folder when expanding.
|
|
771
|
-
*
|
|
1264
|
+
*
|
|
772
1265
|
* Supports offset-based pagination via `from` and `size` parameters.
|
|
773
|
-
*
|
|
1266
|
+
*
|
|
774
1267
|
*/
|
|
775
1268
|
'listConfigs'(
|
|
776
1269
|
parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
|
|
777
1270
|
data?: any,
|
|
778
|
-
config?: AxiosRequestConfig
|
|
1271
|
+
config?: AxiosRequestConfig
|
|
779
1272
|
): OperationResponse<Paths.ListConfigs.Responses.$200>
|
|
780
1273
|
/**
|
|
781
1274
|
* getConfigDependencies - getConfigDependencies
|
|
782
|
-
*
|
|
1275
|
+
*
|
|
783
1276
|
* Get configs that are referenced by the given config.
|
|
784
1277
|
* Used to render children when expanding a config node in the tree.
|
|
785
|
-
*
|
|
1278
|
+
*
|
|
786
1279
|
* Resolves dependencies by fetching the config payload server-side and scanning
|
|
787
1280
|
* for references (UUIDs, source IDs, slug-based references).
|
|
788
|
-
*
|
|
1281
|
+
*
|
|
789
1282
|
*/
|
|
790
1283
|
'getConfigDependencies'(
|
|
791
1284
|
parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
|
|
792
1285
|
data?: any,
|
|
793
|
-
config?: AxiosRequestConfig
|
|
1286
|
+
config?: AxiosRequestConfig
|
|
794
1287
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
795
1288
|
/**
|
|
796
1289
|
* getConfigUsedBy - getConfigUsedBy
|
|
797
|
-
*
|
|
1290
|
+
*
|
|
798
1291
|
* Get configs that reference the given config (reverse dependencies).
|
|
799
1292
|
* Scans the indexed config items for references to this config's ID or aliases.
|
|
800
|
-
*
|
|
1293
|
+
*
|
|
801
1294
|
*/
|
|
802
1295
|
'getConfigUsedBy'(
|
|
803
1296
|
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
804
1297
|
data?: any,
|
|
805
|
-
config?: AxiosRequestConfig
|
|
1298
|
+
config?: AxiosRequestConfig
|
|
806
1299
|
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
807
1300
|
/**
|
|
808
1301
|
* getIndex - getIndex
|
|
809
|
-
*
|
|
1302
|
+
*
|
|
810
1303
|
* Return the current index build state for the caller's organization.
|
|
811
1304
|
* Clients poll this to decide whether to show a "building" indicator
|
|
812
1305
|
* and when to refetch data.
|
|
813
|
-
*
|
|
1306
|
+
*
|
|
814
1307
|
*/
|
|
815
1308
|
'getIndex'(
|
|
816
1309
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
817
1310
|
data?: any,
|
|
818
|
-
config?: AxiosRequestConfig
|
|
1311
|
+
config?: AxiosRequestConfig
|
|
819
1312
|
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
1313
|
+
/**
|
|
1314
|
+
* compareConfigs - compareConfigs
|
|
1315
|
+
*
|
|
1316
|
+
* Compare the caller org's configs of a single type against another
|
|
1317
|
+
* (source) org, side by side. Rows are paired via the lineage registry in
|
|
1318
|
+
* both sync directions (caller imported from source, or source imported
|
|
1319
|
+
* from caller); configs without a counterpart come back as `only_current`
|
|
1320
|
+
* or `only_source`.
|
|
1321
|
+
*
|
|
1322
|
+
* `source_auth_token` must be a valid token for `source_org_id` — the
|
|
1323
|
+
* frontend mints one via the pipeline pairing, mirroring `createSyncJob`'s
|
|
1324
|
+
* `target_auth_token`. The token is verified against `source_org_id`
|
|
1325
|
+
* before any source-org data is read.
|
|
1326
|
+
*
|
|
1327
|
+
* POST because the request carries a token; the operation reads only.
|
|
1328
|
+
*
|
|
1329
|
+
*/
|
|
1330
|
+
'compareConfigs'(
|
|
1331
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1332
|
+
data?: Paths.CompareConfigs.RequestBody,
|
|
1333
|
+
config?: AxiosRequestConfig
|
|
1334
|
+
): OperationResponse<Paths.CompareConfigs.Responses.$200>
|
|
1335
|
+
/**
|
|
1336
|
+
* suggestMatches - suggestMatches
|
|
1337
|
+
*
|
|
1338
|
+
* Run the sync-grade heuristic match (`lookupByHeuristic` — name / slug /
|
|
1339
|
+
* unique key) for a batch of source-org configs that have no lineage
|
|
1340
|
+
* entry, and return candidate counterparts in the caller's org.
|
|
1341
|
+
*
|
|
1342
|
+
* Suggestions are ephemeral — nothing is persisted. The client offers
|
|
1343
|
+
* each candidate to the user, and a confirmed pair is written via
|
|
1344
|
+
* `confirmLineage`. Batches are capped at 25 ids; the client pages
|
|
1345
|
+
* through unmatched rows across successive calls.
|
|
1346
|
+
*
|
|
1347
|
+
*/
|
|
1348
|
+
'suggestMatches'(
|
|
1349
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1350
|
+
data?: Paths.SuggestMatches.RequestBody,
|
|
1351
|
+
config?: AxiosRequestConfig
|
|
1352
|
+
): OperationResponse<Paths.SuggestMatches.Responses.$200>
|
|
1353
|
+
/**
|
|
1354
|
+
* confirmLineage - confirmLineage
|
|
1355
|
+
*
|
|
1356
|
+
* Persist a lineage entry pairing a source-org config with a config in
|
|
1357
|
+
* the caller's org — used to confirm a heuristic suggestion from the
|
|
1358
|
+
* Compare view. Writes to the caller org's lineage partition (caller as
|
|
1359
|
+
* sync target), so subsequent syncs PATCH the confirmed target instead of
|
|
1360
|
+
* creating a duplicate. Conflicts (an existing entry pointing at a
|
|
1361
|
+
* different target) return 409 so the client can refresh.
|
|
1362
|
+
*
|
|
1363
|
+
*/
|
|
1364
|
+
'confirmLineage'(
|
|
1365
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1366
|
+
data?: Paths.ConfirmLineage.RequestBody,
|
|
1367
|
+
config?: AxiosRequestConfig
|
|
1368
|
+
): OperationResponse<Paths.ConfirmLineage.Responses.$201>
|
|
1369
|
+
/**
|
|
1370
|
+
* breakLineage - breakLineage
|
|
1371
|
+
*
|
|
1372
|
+
* Delete a lineage entry from the caller org's partition (caller as sync
|
|
1373
|
+
* target), identified by `type` + `source_id`. Used to break a wrong or
|
|
1374
|
+
* stale match from the Compare view. Note: a future sync can re-match the
|
|
1375
|
+
* same pair heuristically — the entry is deleted, not blocklisted. To
|
|
1376
|
+
* break a match recorded in the OTHER direction, call this operation
|
|
1377
|
+
* authenticated as the other org (pipeline token).
|
|
1378
|
+
*
|
|
1379
|
+
*/
|
|
1380
|
+
'breakLineage'(
|
|
1381
|
+
parameters?: Parameters<Paths.BreakLineage.QueryParameters> | null,
|
|
1382
|
+
data?: any,
|
|
1383
|
+
config?: AxiosRequestConfig
|
|
1384
|
+
): OperationResponse<Paths.BreakLineage.Responses.$200>
|
|
820
1385
|
/**
|
|
821
1386
|
* listSyncJobs - listSyncJobs
|
|
822
|
-
*
|
|
1387
|
+
*
|
|
823
1388
|
* List sync jobs scoped to the caller's organization, paginated with an opaque
|
|
824
1389
|
* cursor. Defaults to most-recent first.
|
|
825
|
-
*
|
|
1390
|
+
*
|
|
826
1391
|
*/
|
|
827
1392
|
'listSyncJobs'(
|
|
828
1393
|
parameters?: Parameters<Paths.ListSyncJobs.QueryParameters> | null,
|
|
829
1394
|
data?: any,
|
|
830
|
-
config?: AxiosRequestConfig
|
|
1395
|
+
config?: AxiosRequestConfig
|
|
831
1396
|
): OperationResponse<Paths.ListSyncJobs.Responses.$200>
|
|
832
1397
|
/**
|
|
833
1398
|
* createSyncJob - createSyncJob
|
|
834
|
-
*
|
|
1399
|
+
*
|
|
835
1400
|
* Create a new cross-org sync job. The job is enqueued for asynchronous execution
|
|
836
1401
|
* by the worker Lambda; the response returns the persisted job header with status
|
|
837
1402
|
* `pending`.
|
|
838
|
-
*
|
|
1403
|
+
*
|
|
839
1404
|
* See `docs/sync/INTERFACES.md` for the locked request/response contract.
|
|
840
|
-
*
|
|
1405
|
+
*
|
|
841
1406
|
*/
|
|
842
1407
|
'createSyncJob'(
|
|
843
1408
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
844
1409
|
data?: Paths.CreateSyncJob.RequestBody,
|
|
845
|
-
config?: AxiosRequestConfig
|
|
1410
|
+
config?: AxiosRequestConfig
|
|
846
1411
|
): OperationResponse<Paths.CreateSyncJob.Responses.$201>
|
|
847
1412
|
/**
|
|
848
1413
|
* getSyncJob - getSyncJob
|
|
849
|
-
*
|
|
1414
|
+
*
|
|
850
1415
|
* Fetch a single sync job by ID. Returns the job header, counts summary,
|
|
851
1416
|
* current phase pointer, and the latest activity events. Frontend polls this
|
|
852
1417
|
* endpoint with a ramping interval.
|
|
853
|
-
*
|
|
1418
|
+
*
|
|
854
1419
|
*/
|
|
855
1420
|
'getSyncJob'(
|
|
856
1421
|
parameters?: Parameters<Paths.GetSyncJob.PathParameters> | null,
|
|
857
1422
|
data?: any,
|
|
858
|
-
config?: AxiosRequestConfig
|
|
1423
|
+
config?: AxiosRequestConfig
|
|
859
1424
|
): OperationResponse<Paths.GetSyncJob.Responses.$200>
|
|
860
1425
|
/**
|
|
861
1426
|
* retrySyncJob - retrySyncJob
|
|
862
|
-
*
|
|
863
|
-
* Retry the
|
|
864
|
-
*
|
|
865
|
-
*
|
|
866
|
-
*
|
|
1427
|
+
*
|
|
1428
|
+
* Retry the unresolved resources from a prior sync job: `failed` rows, plus
|
|
1429
|
+
* rows the original run left at `pending`/`in_progress` because it stopped
|
|
1430
|
+
* early. Creates a new job whose scope is that `(type, source_id)` set and
|
|
1431
|
+
* enqueues it for execution. Optionally accepts inline payload overrides.
|
|
1432
|
+
*
|
|
867
1433
|
*/
|
|
868
1434
|
'retrySyncJob'(
|
|
869
1435
|
parameters?: Parameters<Paths.RetrySyncJob.PathParameters> | null,
|
|
870
1436
|
data?: Paths.RetrySyncJob.RequestBody,
|
|
871
|
-
config?: AxiosRequestConfig
|
|
1437
|
+
config?: AxiosRequestConfig
|
|
872
1438
|
): OperationResponse<Paths.RetrySyncJob.Responses.$201>
|
|
1439
|
+
/**
|
|
1440
|
+
* cancelSyncJob - cancelSyncJob
|
|
1441
|
+
*
|
|
1442
|
+
* Cancel a running sync job. Marks the job `cancelled` with a `finished_at`
|
|
1443
|
+
* so it stops being reported as in-flight, and the worker stops at its next
|
|
1444
|
+
* batch boundary — phases re-read the job status and abort rather than
|
|
1445
|
+
* overwrite a cancellation with their own outcome.
|
|
1446
|
+
*
|
|
1447
|
+
* Resources already written to the target are NOT rolled back; cancelling
|
|
1448
|
+
* stops further work. Jobs already in a terminal state are rejected with
|
|
1449
|
+
* 409.
|
|
1450
|
+
*
|
|
1451
|
+
*/
|
|
1452
|
+
'cancelSyncJob'(
|
|
1453
|
+
parameters?: Parameters<Paths.CancelSyncJob.PathParameters> | null,
|
|
1454
|
+
data?: any,
|
|
1455
|
+
config?: AxiosRequestConfig
|
|
1456
|
+
): OperationResponse<Paths.CancelSyncJob.Responses.$200>
|
|
873
1457
|
/**
|
|
874
1458
|
* listSyncJobResources - listSyncJobResources
|
|
875
|
-
*
|
|
1459
|
+
*
|
|
876
1460
|
* List the per-resource rows for a sync job. Supports filtering by status
|
|
877
1461
|
* (e.g. `failed`) and cursor pagination. Used by the failures table and the
|
|
878
1462
|
* dry-run plan view in the frontend.
|
|
879
|
-
*
|
|
1463
|
+
*
|
|
880
1464
|
*/
|
|
881
1465
|
'listSyncJobResources'(
|
|
882
1466
|
parameters?: Parameters<Paths.ListSyncJobResources.QueryParameters & Paths.ListSyncJobResources.PathParameters> | null,
|
|
883
1467
|
data?: any,
|
|
884
|
-
config?: AxiosRequestConfig
|
|
1468
|
+
config?: AxiosRequestConfig
|
|
885
1469
|
): OperationResponse<Paths.ListSyncJobResources.Responses.$200>
|
|
1470
|
+
/**
|
|
1471
|
+
* listDeleteJobs - listDeleteJobs
|
|
1472
|
+
*
|
|
1473
|
+
* List bulk-delete jobs scoped to the caller's organization, paginated
|
|
1474
|
+
* with an opaque cursor. Most-recent first.
|
|
1475
|
+
*
|
|
1476
|
+
*/
|
|
1477
|
+
'listDeleteJobs'(
|
|
1478
|
+
parameters?: Parameters<Paths.ListDeleteJobs.QueryParameters> | null,
|
|
1479
|
+
data?: any,
|
|
1480
|
+
config?: AxiosRequestConfig
|
|
1481
|
+
): OperationResponse<Paths.ListDeleteJobs.Responses.$200>
|
|
1482
|
+
/**
|
|
1483
|
+
* createDeleteJob - createDeleteJob
|
|
1484
|
+
*
|
|
1485
|
+
* Create a bulk-delete job for the caller's organization. The selected
|
|
1486
|
+
* resources are deleted asynchronously by a worker Lambda; the response
|
|
1487
|
+
* returns the persisted job header with status `pending`.
|
|
1488
|
+
*
|
|
1489
|
+
* Raw delete — no dependency checks are performed. On completion the
|
|
1490
|
+
* worker auto-triggers an index rebuild so the config list reflects the
|
|
1491
|
+
* deletions.
|
|
1492
|
+
*
|
|
1493
|
+
*/
|
|
1494
|
+
'createDeleteJob'(
|
|
1495
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1496
|
+
data?: Paths.CreateDeleteJob.RequestBody,
|
|
1497
|
+
config?: AxiosRequestConfig
|
|
1498
|
+
): OperationResponse<Paths.CreateDeleteJob.Responses.$201>
|
|
1499
|
+
/**
|
|
1500
|
+
* getDeleteJob - getDeleteJob
|
|
1501
|
+
*
|
|
1502
|
+
* Fetch a single bulk-delete job by ID. Returns the job header and counts
|
|
1503
|
+
* summary. Frontend polls this endpoint while the job runs.
|
|
1504
|
+
*
|
|
1505
|
+
*/
|
|
1506
|
+
'getDeleteJob'(
|
|
1507
|
+
parameters?: Parameters<Paths.GetDeleteJob.PathParameters> | null,
|
|
1508
|
+
data?: any,
|
|
1509
|
+
config?: AxiosRequestConfig
|
|
1510
|
+
): OperationResponse<Paths.GetDeleteJob.Responses.$200>
|
|
1511
|
+
/**
|
|
1512
|
+
* listDeleteJobResources - listDeleteJobResources
|
|
1513
|
+
*
|
|
1514
|
+
* List the per-resource rows for a delete job, cursor-paginated. Used by
|
|
1515
|
+
* the failures view in the frontend.
|
|
1516
|
+
*
|
|
1517
|
+
*/
|
|
1518
|
+
'listDeleteJobResources'(
|
|
1519
|
+
parameters?: Parameters<Paths.ListDeleteJobResources.QueryParameters & Paths.ListDeleteJobResources.PathParameters> | null,
|
|
1520
|
+
data?: any,
|
|
1521
|
+
config?: AxiosRequestConfig
|
|
1522
|
+
): OperationResponse<Paths.ListDeleteJobResources.Responses.$200>
|
|
886
1523
|
/**
|
|
887
1524
|
* rebuildIndex - rebuildIndex
|
|
888
|
-
*
|
|
1525
|
+
*
|
|
889
1526
|
* Rebuild the configuration index for the caller's organization.
|
|
890
1527
|
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
891
1528
|
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
892
|
-
*
|
|
1529
|
+
*
|
|
893
1530
|
*/
|
|
894
1531
|
'rebuildIndex'(
|
|
895
1532
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
896
1533
|
data?: any,
|
|
897
|
-
config?: AxiosRequestConfig
|
|
1534
|
+
config?: AxiosRequestConfig
|
|
898
1535
|
): OperationResponse<Paths.RebuildIndex.Responses.$200>
|
|
1536
|
+
/**
|
|
1537
|
+
* getConfigInventory - getConfigInventory
|
|
1538
|
+
*
|
|
1539
|
+
* Returns a fresh inventory of an org's configuration resources — `{ type, id }` identities only,
|
|
1540
|
+
* no full payloads. Calls every adapter's `list()` live (bypasses the 7-day DynamoDB index).
|
|
1541
|
+
* Intended for snapshot-api to consume when taking a full-org snapshot.
|
|
1542
|
+
*
|
|
1543
|
+
*/
|
|
1544
|
+
'getConfigInventory'(
|
|
1545
|
+
parameters?: Parameters<Paths.GetConfigInventory.QueryParameters> | null,
|
|
1546
|
+
data?: any,
|
|
1547
|
+
config?: AxiosRequestConfig
|
|
1548
|
+
): OperationResponse<Paths.GetConfigInventory.Responses.$200>
|
|
899
1549
|
}
|
|
900
1550
|
|
|
901
1551
|
interface PathsDictionary {
|
|
902
1552
|
['/v1/configs/types']: {
|
|
903
1553
|
/**
|
|
904
1554
|
* listConfigTypes - listConfigTypes
|
|
905
|
-
*
|
|
1555
|
+
*
|
|
906
1556
|
* Returns the static list of available configuration types with display metadata.
|
|
907
1557
|
* This is a cheap call — no fan-out to downstream APIs. Returns all known types
|
|
908
1558
|
* with labels and icons. The frontend should then call `listConfigs` separately
|
|
909
1559
|
* for each type it wants to load.
|
|
910
|
-
*
|
|
1560
|
+
*
|
|
911
1561
|
*/
|
|
912
1562
|
'get'(
|
|
913
1563
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
914
1564
|
data?: any,
|
|
915
|
-
config?: AxiosRequestConfig
|
|
1565
|
+
config?: AxiosRequestConfig
|
|
916
1566
|
): OperationResponse<Paths.ListConfigTypes.Responses.$200>
|
|
917
1567
|
}
|
|
918
1568
|
['/v1/configs/{type}']: {
|
|
919
1569
|
/**
|
|
920
1570
|
* listConfigs - listConfigs
|
|
921
|
-
*
|
|
1571
|
+
*
|
|
922
1572
|
* List configs of a given type with pagination. Returns summary metadata only
|
|
923
1573
|
* (not full payloads). The frontend calls this per type folder when expanding.
|
|
924
|
-
*
|
|
1574
|
+
*
|
|
925
1575
|
* Supports offset-based pagination via `from` and `size` parameters.
|
|
926
|
-
*
|
|
1576
|
+
*
|
|
927
1577
|
*/
|
|
928
1578
|
'get'(
|
|
929
1579
|
parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
|
|
930
1580
|
data?: any,
|
|
931
|
-
config?: AxiosRequestConfig
|
|
1581
|
+
config?: AxiosRequestConfig
|
|
932
1582
|
): OperationResponse<Paths.ListConfigs.Responses.$200>
|
|
933
1583
|
}
|
|
934
1584
|
['/v1/configs/{type}/{id}/dependencies']: {
|
|
935
1585
|
/**
|
|
936
1586
|
* getConfigDependencies - getConfigDependencies
|
|
937
|
-
*
|
|
1587
|
+
*
|
|
938
1588
|
* Get configs that are referenced by the given config.
|
|
939
1589
|
* Used to render children when expanding a config node in the tree.
|
|
940
|
-
*
|
|
1590
|
+
*
|
|
941
1591
|
* Resolves dependencies by fetching the config payload server-side and scanning
|
|
942
1592
|
* for references (UUIDs, source IDs, slug-based references).
|
|
943
|
-
*
|
|
1593
|
+
*
|
|
944
1594
|
*/
|
|
945
1595
|
'get'(
|
|
946
1596
|
parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
|
|
947
1597
|
data?: any,
|
|
948
|
-
config?: AxiosRequestConfig
|
|
1598
|
+
config?: AxiosRequestConfig
|
|
949
1599
|
): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
|
|
950
1600
|
}
|
|
951
1601
|
['/v1/configs/{type}/{id}/used_by']: {
|
|
952
1602
|
/**
|
|
953
1603
|
* getConfigUsedBy - getConfigUsedBy
|
|
954
|
-
*
|
|
1604
|
+
*
|
|
955
1605
|
* Get configs that reference the given config (reverse dependencies).
|
|
956
1606
|
* Scans the indexed config items for references to this config's ID or aliases.
|
|
957
|
-
*
|
|
1607
|
+
*
|
|
958
1608
|
*/
|
|
959
1609
|
'get'(
|
|
960
1610
|
parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
|
|
961
1611
|
data?: any,
|
|
962
|
-
config?: AxiosRequestConfig
|
|
1612
|
+
config?: AxiosRequestConfig
|
|
963
1613
|
): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
|
|
964
1614
|
}
|
|
965
1615
|
['/v1/configs/index']: {
|
|
966
1616
|
/**
|
|
967
1617
|
* getIndex - getIndex
|
|
968
|
-
*
|
|
1618
|
+
*
|
|
969
1619
|
* Return the current index build state for the caller's organization.
|
|
970
1620
|
* Clients poll this to decide whether to show a "building" indicator
|
|
971
1621
|
* and when to refetch data.
|
|
972
|
-
*
|
|
1622
|
+
*
|
|
973
1623
|
*/
|
|
974
1624
|
'get'(
|
|
975
1625
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
976
1626
|
data?: any,
|
|
977
|
-
config?: AxiosRequestConfig
|
|
1627
|
+
config?: AxiosRequestConfig
|
|
978
1628
|
): OperationResponse<Paths.GetIndex.Responses.$200>
|
|
979
1629
|
}
|
|
1630
|
+
['/v1/configs/compare']: {
|
|
1631
|
+
/**
|
|
1632
|
+
* compareConfigs - compareConfigs
|
|
1633
|
+
*
|
|
1634
|
+
* Compare the caller org's configs of a single type against another
|
|
1635
|
+
* (source) org, side by side. Rows are paired via the lineage registry in
|
|
1636
|
+
* both sync directions (caller imported from source, or source imported
|
|
1637
|
+
* from caller); configs without a counterpart come back as `only_current`
|
|
1638
|
+
* or `only_source`.
|
|
1639
|
+
*
|
|
1640
|
+
* `source_auth_token` must be a valid token for `source_org_id` — the
|
|
1641
|
+
* frontend mints one via the pipeline pairing, mirroring `createSyncJob`'s
|
|
1642
|
+
* `target_auth_token`. The token is verified against `source_org_id`
|
|
1643
|
+
* before any source-org data is read.
|
|
1644
|
+
*
|
|
1645
|
+
* POST because the request carries a token; the operation reads only.
|
|
1646
|
+
*
|
|
1647
|
+
*/
|
|
1648
|
+
'post'(
|
|
1649
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1650
|
+
data?: Paths.CompareConfigs.RequestBody,
|
|
1651
|
+
config?: AxiosRequestConfig
|
|
1652
|
+
): OperationResponse<Paths.CompareConfigs.Responses.$200>
|
|
1653
|
+
}
|
|
1654
|
+
['/v1/configs/compare/suggestions']: {
|
|
1655
|
+
/**
|
|
1656
|
+
* suggestMatches - suggestMatches
|
|
1657
|
+
*
|
|
1658
|
+
* Run the sync-grade heuristic match (`lookupByHeuristic` — name / slug /
|
|
1659
|
+
* unique key) for a batch of source-org configs that have no lineage
|
|
1660
|
+
* entry, and return candidate counterparts in the caller's org.
|
|
1661
|
+
*
|
|
1662
|
+
* Suggestions are ephemeral — nothing is persisted. The client offers
|
|
1663
|
+
* each candidate to the user, and a confirmed pair is written via
|
|
1664
|
+
* `confirmLineage`. Batches are capped at 25 ids; the client pages
|
|
1665
|
+
* through unmatched rows across successive calls.
|
|
1666
|
+
*
|
|
1667
|
+
*/
|
|
1668
|
+
'post'(
|
|
1669
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1670
|
+
data?: Paths.SuggestMatches.RequestBody,
|
|
1671
|
+
config?: AxiosRequestConfig
|
|
1672
|
+
): OperationResponse<Paths.SuggestMatches.Responses.$200>
|
|
1673
|
+
}
|
|
1674
|
+
['/v1/configs/lineage']: {
|
|
1675
|
+
/**
|
|
1676
|
+
* confirmLineage - confirmLineage
|
|
1677
|
+
*
|
|
1678
|
+
* Persist a lineage entry pairing a source-org config with a config in
|
|
1679
|
+
* the caller's org — used to confirm a heuristic suggestion from the
|
|
1680
|
+
* Compare view. Writes to the caller org's lineage partition (caller as
|
|
1681
|
+
* sync target), so subsequent syncs PATCH the confirmed target instead of
|
|
1682
|
+
* creating a duplicate. Conflicts (an existing entry pointing at a
|
|
1683
|
+
* different target) return 409 so the client can refresh.
|
|
1684
|
+
*
|
|
1685
|
+
*/
|
|
1686
|
+
'post'(
|
|
1687
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1688
|
+
data?: Paths.ConfirmLineage.RequestBody,
|
|
1689
|
+
config?: AxiosRequestConfig
|
|
1690
|
+
): OperationResponse<Paths.ConfirmLineage.Responses.$201>
|
|
1691
|
+
/**
|
|
1692
|
+
* breakLineage - breakLineage
|
|
1693
|
+
*
|
|
1694
|
+
* Delete a lineage entry from the caller org's partition (caller as sync
|
|
1695
|
+
* target), identified by `type` + `source_id`. Used to break a wrong or
|
|
1696
|
+
* stale match from the Compare view. Note: a future sync can re-match the
|
|
1697
|
+
* same pair heuristically — the entry is deleted, not blocklisted. To
|
|
1698
|
+
* break a match recorded in the OTHER direction, call this operation
|
|
1699
|
+
* authenticated as the other org (pipeline token).
|
|
1700
|
+
*
|
|
1701
|
+
*/
|
|
1702
|
+
'delete'(
|
|
1703
|
+
parameters?: Parameters<Paths.BreakLineage.QueryParameters> | null,
|
|
1704
|
+
data?: any,
|
|
1705
|
+
config?: AxiosRequestConfig
|
|
1706
|
+
): OperationResponse<Paths.BreakLineage.Responses.$200>
|
|
1707
|
+
}
|
|
980
1708
|
['/v1/configs/sync-jobs']: {
|
|
981
1709
|
/**
|
|
982
1710
|
* createSyncJob - createSyncJob
|
|
983
|
-
*
|
|
1711
|
+
*
|
|
984
1712
|
* Create a new cross-org sync job. The job is enqueued for asynchronous execution
|
|
985
1713
|
* by the worker Lambda; the response returns the persisted job header with status
|
|
986
1714
|
* `pending`.
|
|
987
|
-
*
|
|
1715
|
+
*
|
|
988
1716
|
* See `docs/sync/INTERFACES.md` for the locked request/response contract.
|
|
989
|
-
*
|
|
1717
|
+
*
|
|
990
1718
|
*/
|
|
991
1719
|
'post'(
|
|
992
1720
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
993
1721
|
data?: Paths.CreateSyncJob.RequestBody,
|
|
994
|
-
config?: AxiosRequestConfig
|
|
1722
|
+
config?: AxiosRequestConfig
|
|
995
1723
|
): OperationResponse<Paths.CreateSyncJob.Responses.$201>
|
|
996
1724
|
/**
|
|
997
1725
|
* listSyncJobs - listSyncJobs
|
|
998
|
-
*
|
|
1726
|
+
*
|
|
999
1727
|
* List sync jobs scoped to the caller's organization, paginated with an opaque
|
|
1000
1728
|
* cursor. Defaults to most-recent first.
|
|
1001
|
-
*
|
|
1729
|
+
*
|
|
1002
1730
|
*/
|
|
1003
1731
|
'get'(
|
|
1004
1732
|
parameters?: Parameters<Paths.ListSyncJobs.QueryParameters> | null,
|
|
1005
1733
|
data?: any,
|
|
1006
|
-
config?: AxiosRequestConfig
|
|
1734
|
+
config?: AxiosRequestConfig
|
|
1007
1735
|
): OperationResponse<Paths.ListSyncJobs.Responses.$200>
|
|
1008
1736
|
}
|
|
1009
1737
|
['/v1/configs/sync-jobs/{id}']: {
|
|
1010
1738
|
/**
|
|
1011
1739
|
* getSyncJob - getSyncJob
|
|
1012
|
-
*
|
|
1740
|
+
*
|
|
1013
1741
|
* Fetch a single sync job by ID. Returns the job header, counts summary,
|
|
1014
1742
|
* current phase pointer, and the latest activity events. Frontend polls this
|
|
1015
1743
|
* endpoint with a ramping interval.
|
|
1016
|
-
*
|
|
1744
|
+
*
|
|
1017
1745
|
*/
|
|
1018
1746
|
'get'(
|
|
1019
1747
|
parameters?: Parameters<Paths.GetSyncJob.PathParameters> | null,
|
|
1020
1748
|
data?: any,
|
|
1021
|
-
config?: AxiosRequestConfig
|
|
1749
|
+
config?: AxiosRequestConfig
|
|
1022
1750
|
): OperationResponse<Paths.GetSyncJob.Responses.$200>
|
|
1023
1751
|
}
|
|
1024
1752
|
['/v1/configs/sync-jobs/{id}/retry']: {
|
|
1025
1753
|
/**
|
|
1026
1754
|
* retrySyncJob - retrySyncJob
|
|
1027
|
-
*
|
|
1028
|
-
* Retry the
|
|
1029
|
-
*
|
|
1030
|
-
*
|
|
1031
|
-
*
|
|
1755
|
+
*
|
|
1756
|
+
* Retry the unresolved resources from a prior sync job: `failed` rows, plus
|
|
1757
|
+
* rows the original run left at `pending`/`in_progress` because it stopped
|
|
1758
|
+
* early. Creates a new job whose scope is that `(type, source_id)` set and
|
|
1759
|
+
* enqueues it for execution. Optionally accepts inline payload overrides.
|
|
1760
|
+
*
|
|
1032
1761
|
*/
|
|
1033
1762
|
'post'(
|
|
1034
1763
|
parameters?: Parameters<Paths.RetrySyncJob.PathParameters> | null,
|
|
1035
1764
|
data?: Paths.RetrySyncJob.RequestBody,
|
|
1036
|
-
config?: AxiosRequestConfig
|
|
1765
|
+
config?: AxiosRequestConfig
|
|
1037
1766
|
): OperationResponse<Paths.RetrySyncJob.Responses.$201>
|
|
1038
1767
|
}
|
|
1768
|
+
['/v1/configs/sync-jobs/{id}/cancel']: {
|
|
1769
|
+
/**
|
|
1770
|
+
* cancelSyncJob - cancelSyncJob
|
|
1771
|
+
*
|
|
1772
|
+
* Cancel a running sync job. Marks the job `cancelled` with a `finished_at`
|
|
1773
|
+
* so it stops being reported as in-flight, and the worker stops at its next
|
|
1774
|
+
* batch boundary — phases re-read the job status and abort rather than
|
|
1775
|
+
* overwrite a cancellation with their own outcome.
|
|
1776
|
+
*
|
|
1777
|
+
* Resources already written to the target are NOT rolled back; cancelling
|
|
1778
|
+
* stops further work. Jobs already in a terminal state are rejected with
|
|
1779
|
+
* 409.
|
|
1780
|
+
*
|
|
1781
|
+
*/
|
|
1782
|
+
'post'(
|
|
1783
|
+
parameters?: Parameters<Paths.CancelSyncJob.PathParameters> | null,
|
|
1784
|
+
data?: any,
|
|
1785
|
+
config?: AxiosRequestConfig
|
|
1786
|
+
): OperationResponse<Paths.CancelSyncJob.Responses.$200>
|
|
1787
|
+
}
|
|
1039
1788
|
['/v1/configs/sync-jobs/{id}/resources']: {
|
|
1040
1789
|
/**
|
|
1041
1790
|
* listSyncJobResources - listSyncJobResources
|
|
1042
|
-
*
|
|
1791
|
+
*
|
|
1043
1792
|
* List the per-resource rows for a sync job. Supports filtering by status
|
|
1044
1793
|
* (e.g. `failed`) and cursor pagination. Used by the failures table and the
|
|
1045
1794
|
* dry-run plan view in the frontend.
|
|
1046
|
-
*
|
|
1795
|
+
*
|
|
1047
1796
|
*/
|
|
1048
1797
|
'get'(
|
|
1049
1798
|
parameters?: Parameters<Paths.ListSyncJobResources.QueryParameters & Paths.ListSyncJobResources.PathParameters> | null,
|
|
1050
1799
|
data?: any,
|
|
1051
|
-
config?: AxiosRequestConfig
|
|
1800
|
+
config?: AxiosRequestConfig
|
|
1052
1801
|
): OperationResponse<Paths.ListSyncJobResources.Responses.$200>
|
|
1053
1802
|
}
|
|
1803
|
+
['/v1/configs/delete-jobs']: {
|
|
1804
|
+
/**
|
|
1805
|
+
* createDeleteJob - createDeleteJob
|
|
1806
|
+
*
|
|
1807
|
+
* Create a bulk-delete job for the caller's organization. The selected
|
|
1808
|
+
* resources are deleted asynchronously by a worker Lambda; the response
|
|
1809
|
+
* returns the persisted job header with status `pending`.
|
|
1810
|
+
*
|
|
1811
|
+
* Raw delete — no dependency checks are performed. On completion the
|
|
1812
|
+
* worker auto-triggers an index rebuild so the config list reflects the
|
|
1813
|
+
* deletions.
|
|
1814
|
+
*
|
|
1815
|
+
*/
|
|
1816
|
+
'post'(
|
|
1817
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1818
|
+
data?: Paths.CreateDeleteJob.RequestBody,
|
|
1819
|
+
config?: AxiosRequestConfig
|
|
1820
|
+
): OperationResponse<Paths.CreateDeleteJob.Responses.$201>
|
|
1821
|
+
/**
|
|
1822
|
+
* listDeleteJobs - listDeleteJobs
|
|
1823
|
+
*
|
|
1824
|
+
* List bulk-delete jobs scoped to the caller's organization, paginated
|
|
1825
|
+
* with an opaque cursor. Most-recent first.
|
|
1826
|
+
*
|
|
1827
|
+
*/
|
|
1828
|
+
'get'(
|
|
1829
|
+
parameters?: Parameters<Paths.ListDeleteJobs.QueryParameters> | null,
|
|
1830
|
+
data?: any,
|
|
1831
|
+
config?: AxiosRequestConfig
|
|
1832
|
+
): OperationResponse<Paths.ListDeleteJobs.Responses.$200>
|
|
1833
|
+
}
|
|
1834
|
+
['/v1/configs/delete-jobs/{id}']: {
|
|
1835
|
+
/**
|
|
1836
|
+
* getDeleteJob - getDeleteJob
|
|
1837
|
+
*
|
|
1838
|
+
* Fetch a single bulk-delete job by ID. Returns the job header and counts
|
|
1839
|
+
* summary. Frontend polls this endpoint while the job runs.
|
|
1840
|
+
*
|
|
1841
|
+
*/
|
|
1842
|
+
'get'(
|
|
1843
|
+
parameters?: Parameters<Paths.GetDeleteJob.PathParameters> | null,
|
|
1844
|
+
data?: any,
|
|
1845
|
+
config?: AxiosRequestConfig
|
|
1846
|
+
): OperationResponse<Paths.GetDeleteJob.Responses.$200>
|
|
1847
|
+
}
|
|
1848
|
+
['/v1/configs/delete-jobs/{id}/resources']: {
|
|
1849
|
+
/**
|
|
1850
|
+
* listDeleteJobResources - listDeleteJobResources
|
|
1851
|
+
*
|
|
1852
|
+
* List the per-resource rows for a delete job, cursor-paginated. Used by
|
|
1853
|
+
* the failures view in the frontend.
|
|
1854
|
+
*
|
|
1855
|
+
*/
|
|
1856
|
+
'get'(
|
|
1857
|
+
parameters?: Parameters<Paths.ListDeleteJobResources.QueryParameters & Paths.ListDeleteJobResources.PathParameters> | null,
|
|
1858
|
+
data?: any,
|
|
1859
|
+
config?: AxiosRequestConfig
|
|
1860
|
+
): OperationResponse<Paths.ListDeleteJobResources.Responses.$200>
|
|
1861
|
+
}
|
|
1054
1862
|
['/v1/configs/index:rebuild']: {
|
|
1055
1863
|
/**
|
|
1056
1864
|
* rebuildIndex - rebuildIndex
|
|
1057
|
-
*
|
|
1865
|
+
*
|
|
1058
1866
|
* Rebuild the configuration index for the caller's organization.
|
|
1059
1867
|
* Fire-and-forget: invokes the async worker and returns immediately.
|
|
1060
1868
|
* A new rebuild will cancel any in-flight build (see `build_token`).
|
|
1061
|
-
*
|
|
1869
|
+
*
|
|
1062
1870
|
*/
|
|
1063
1871
|
'post'(
|
|
1064
1872
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1065
1873
|
data?: any,
|
|
1066
|
-
config?: AxiosRequestConfig
|
|
1874
|
+
config?: AxiosRequestConfig
|
|
1067
1875
|
): OperationResponse<Paths.RebuildIndex.Responses.$200>
|
|
1068
1876
|
}
|
|
1877
|
+
['/v1/configs/inventory']: {
|
|
1878
|
+
/**
|
|
1879
|
+
* getConfigInventory - getConfigInventory
|
|
1880
|
+
*
|
|
1881
|
+
* Returns a fresh inventory of an org's configuration resources — `{ type, id }` identities only,
|
|
1882
|
+
* no full payloads. Calls every adapter's `list()` live (bypasses the 7-day DynamoDB index).
|
|
1883
|
+
* Intended for snapshot-api to consume when taking a full-org snapshot.
|
|
1884
|
+
*
|
|
1885
|
+
*/
|
|
1886
|
+
'get'(
|
|
1887
|
+
parameters?: Parameters<Paths.GetConfigInventory.QueryParameters> | null,
|
|
1888
|
+
data?: any,
|
|
1889
|
+
config?: AxiosRequestConfig
|
|
1890
|
+
): OperationResponse<Paths.GetConfigInventory.Responses.$200>
|
|
1891
|
+
}
|
|
1069
1892
|
}
|
|
1070
1893
|
|
|
1071
1894
|
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1072
1895
|
|
|
1073
1896
|
|
|
1897
|
+
type BreakLineageResponse = Components.Schemas.BreakLineageResponse;
|
|
1898
|
+
type CompareCounts = Components.Schemas.CompareCounts;
|
|
1899
|
+
type CompareLineage = Components.Schemas.CompareLineage;
|
|
1900
|
+
type CompareRequest = Components.Schemas.CompareRequest;
|
|
1901
|
+
type CompareResponse = Components.Schemas.CompareResponse;
|
|
1902
|
+
type CompareRow = Components.Schemas.CompareRow;
|
|
1074
1903
|
type ConfigDependenciesResponse = Components.Schemas.ConfigDependenciesResponse;
|
|
1904
|
+
type ConfigInventoryResponse = Components.Schemas.ConfigInventoryResponse;
|
|
1075
1905
|
type ConfigListResponse = Components.Schemas.ConfigListResponse;
|
|
1076
1906
|
type ConfigNode = Components.Schemas.ConfigNode;
|
|
1077
1907
|
type ConfigTypeInfo = Components.Schemas.ConfigTypeInfo;
|
|
1908
|
+
type ConfirmLineageRequest = Components.Schemas.ConfirmLineageRequest;
|
|
1909
|
+
type DeleteJob = Components.Schemas.DeleteJob;
|
|
1910
|
+
type DeleteJobCounts = Components.Schemas.DeleteJobCounts;
|
|
1911
|
+
type DeleteJobListResponse = Components.Schemas.DeleteJobListResponse;
|
|
1912
|
+
type DeleteJobRequest = Components.Schemas.DeleteJobRequest;
|
|
1913
|
+
type DeleteJobResource = Components.Schemas.DeleteJobResource;
|
|
1914
|
+
type DeleteJobResourceListResponse = Components.Schemas.DeleteJobResourceListResponse;
|
|
1915
|
+
type DeleteJobResourceStatus = Components.Schemas.DeleteJobResourceStatus;
|
|
1916
|
+
type DeleteJobStatus = Components.Schemas.DeleteJobStatus;
|
|
1078
1917
|
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
1079
1918
|
type IndexRebuildResponse = Components.Schemas.IndexRebuildResponse;
|
|
1080
1919
|
type IndexStatusResponse = Components.Schemas.IndexStatusResponse;
|
|
1920
|
+
type LineageEntryResponse = Components.Schemas.LineageEntryResponse;
|
|
1921
|
+
type MatchSuggestion = Components.Schemas.MatchSuggestion;
|
|
1081
1922
|
type ResourceType = Components.Schemas.ResourceType;
|
|
1923
|
+
type SnapshotInventoryItem = Components.Schemas.SnapshotInventoryItem;
|
|
1924
|
+
type SnapshotInventorySkippedType = Components.Schemas.SnapshotInventorySkippedType;
|
|
1925
|
+
type SuggestMatchesRequest = Components.Schemas.SuggestMatchesRequest;
|
|
1926
|
+
type SuggestMatchesResponse = Components.Schemas.SuggestMatchesResponse;
|
|
1082
1927
|
type SyncDirection = Components.Schemas.SyncDirection;
|
|
1083
1928
|
type SyncJob = Components.Schemas.SyncJob;
|
|
1084
1929
|
type SyncJobBatch = Components.Schemas.SyncJobBatch;
|
|
@@ -1093,4 +1938,4 @@ type SyncJobRetryRequest = Components.Schemas.SyncJobRetryRequest;
|
|
|
1093
1938
|
type SyncJobStatus = Components.Schemas.SyncJobStatus;
|
|
1094
1939
|
type SyncPhase = Components.Schemas.SyncPhase;
|
|
1095
1940
|
|
|
1096
|
-
export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, type
|
|
1941
|
+
export { type SyncJobBatch as A, type BreakLineageResponse as B, type Client as C, type DeleteJob as D, type ErrorResponse as E, type SyncJobCounts as F, type SyncJobEvent as G, type SyncJobListResponse as H, type IndexRebuildResponse as I, type SyncJobRequest as J, type SyncJobResource as K, type LineageEntryResponse as L, type MatchSuggestion as M, type SyncJobResourceListResponse as N, type OperationMethods as O, Paths as P, type SyncJobResourceStatus as Q, type ResourceType as R, type SnapshotInventoryItem as S, type SyncJobRetryRequest as T, type SyncJobStatus as U, type SyncPhase as V, Components as a, type PathsDictionary as b, type CompareCounts as c, type CompareLineage as d, type CompareRequest as e, type CompareResponse as f, type CompareRow as g, type ConfigDependenciesResponse as h, type ConfigInventoryResponse as i, type ConfigListResponse as j, type ConfigNode as k, type ConfigTypeInfo as l, type ConfirmLineageRequest as m, type DeleteJobCounts as n, type DeleteJobListResponse as o, type DeleteJobRequest as p, type DeleteJobResource as q, type DeleteJobResourceListResponse as r, type DeleteJobResourceStatus as s, type DeleteJobStatus as t, type IndexStatusResponse as u, type SnapshotInventorySkippedType as v, type SuggestMatchesRequest as w, type SuggestMatchesResponse as x, type SyncDirection as y, type SyncJob as z };
|