@epilot/sdk 2.15.6 → 2.15.8
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/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +699 -3
- package/definitions/entity-runtime.json +1 -1
- package/definitions/entity.json +373 -3
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +2 -2
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +2 -2
- 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/blueprint-manifest-GU75577F.js +7 -0
- package/dist/blueprint-manifest-KTUWFTDX.cjs +7 -0
- package/dist/{blueprint-manifest-runtime-2PQBKBIN.cjs → blueprint-manifest-runtime-6MEPQQC5.cjs} +2 -2
- package/dist/{blueprint-manifest-runtime-JYDKG5WQ.js → blueprint-manifest-runtime-SAWWJW2G.js} +1 -1
- package/dist/{blueprint-manifest.d-D2I9nhZa.d.cts → blueprint-manifest.d-BiaeSTI3.d.cts} +548 -46
- package/dist/{blueprint-manifest.d-D2I9nhZa.d.ts → blueprint-manifest.d-BiaeSTI3.d.ts} +548 -46
- package/dist/chunk-EZU3MFGV.cjs +14 -0
- package/dist/chunk-FUHSA3BV.js +14 -0
- package/dist/{chunk-6DBGRVEF.js → chunk-H5DNNZU5.js} +4 -4
- package/dist/{chunk-VBTUFDXY.cjs → chunk-USC6N3WG.cjs} +4 -4
- package/dist/chunk-XHTYJNOZ.cjs +14 -0
- package/dist/chunk-ZQU37FR3.js +14 -0
- package/dist/entity-K5HYURU7.js +7 -0
- package/dist/entity-V5375UNT.cjs +7 -0
- package/dist/entity-runtime-7INAS2AX.cjs +5 -0
- package/dist/{entity-runtime-LNAZILIN.js → entity-runtime-EBFSSNOM.js} +1 -1
- package/dist/{entity.d-fospShiN.d.cts → entity.d-CmQvgvyi.d.cts} +1038 -6
- package/dist/{entity.d-fospShiN.d.ts → entity.d-CmQvgvyi.d.ts} +1038 -6
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/docs/blueprint-manifest.md +571 -27
- package/docs/entity.md +396 -56
- package/package.json +1 -1
- package/dist/blueprint-manifest-IWQ2TGMV.js +0 -7
- package/dist/blueprint-manifest-YNNRSATN.cjs +0 -7
- package/dist/chunk-ACOAPYGP.cjs +0 -14
- package/dist/chunk-LIWGP5QQ.js +0 -14
- package/dist/chunk-M6Z6ES3I.js +0 -14
- package/dist/chunk-UBQCDPW6.cjs +0 -14
- package/dist/entity-SS36LQO6.cjs +0 -7
- package/dist/entity-Z4YWKDVG.js +0 -7
- package/dist/entity-runtime-3J5EDLXP.cjs +0 -5
|
@@ -41,6 +41,21 @@ declare namespace Components {
|
|
|
41
41
|
*/
|
|
42
42
|
postinstall?: string;
|
|
43
43
|
};
|
|
44
|
+
/**
|
|
45
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
46
|
+
* stamped with its author and creation time server-side and is never
|
|
47
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
48
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
49
|
+
*
|
|
50
|
+
* Available on every blueprint including marketplace ones (whose
|
|
51
|
+
* `description` is read-only), and never included in the published
|
|
52
|
+
* marketplace package — see `buildMetadata` in
|
|
53
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
54
|
+
* destination org only when an install/sync passes
|
|
55
|
+
* `options.sync_notes: true`.
|
|
56
|
+
*
|
|
57
|
+
*/
|
|
58
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
44
59
|
version?: string;
|
|
45
60
|
deployments?: {
|
|
46
61
|
source_org_id?: string;
|
|
@@ -296,6 +311,13 @@ declare namespace Components {
|
|
|
296
311
|
* List of resource addresses to ignore changes for. When a resource is marked as create, it will be ignored and not created.
|
|
297
312
|
*/
|
|
298
313
|
resources_to_ignore?: string[];
|
|
314
|
+
/**
|
|
315
|
+
* When `true`, the source blueprint's `notes` overwrite the destination
|
|
316
|
+
* blueprint's `notes`. Defaults to `false`, which leaves the
|
|
317
|
+
* destination's notes untouched.
|
|
318
|
+
*
|
|
319
|
+
*/
|
|
320
|
+
sync_notes?: boolean;
|
|
299
321
|
}
|
|
300
322
|
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintRestoreJob | BlueprintDependenciesSyncJob | BlueprintValidateJob | BlueprintVerificationJob;
|
|
301
323
|
export interface BlueprintJobEvent {
|
|
@@ -325,6 +347,25 @@ declare namespace Components {
|
|
|
325
347
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
326
348
|
*/
|
|
327
349
|
export type BlueprintJobID = string;
|
|
350
|
+
/**
|
|
351
|
+
* A single internal note on a blueprint.
|
|
352
|
+
*/
|
|
353
|
+
export interface BlueprintNote {
|
|
354
|
+
/**
|
|
355
|
+
* Server-generated note id.
|
|
356
|
+
* example:
|
|
357
|
+
* 3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40
|
|
358
|
+
*/
|
|
359
|
+
id: string;
|
|
360
|
+
/**
|
|
361
|
+
* Plain-text note body.
|
|
362
|
+
* example:
|
|
363
|
+
* Adjusted the meter-reading journey for the §14a rollout.
|
|
364
|
+
*/
|
|
365
|
+
text: string;
|
|
366
|
+
created_at: string; // date-time
|
|
367
|
+
created_by?: CallerIdentity;
|
|
368
|
+
}
|
|
328
369
|
export interface BlueprintPatch {
|
|
329
370
|
patch_id?: string;
|
|
330
371
|
version?: number;
|
|
@@ -563,12 +604,12 @@ declare namespace Components {
|
|
|
563
604
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
564
605
|
*/
|
|
565
606
|
BlueprintID;
|
|
566
|
-
|
|
567
|
-
*
|
|
607
|
+
/**
|
|
608
|
+
* Install job this verification is checking, when known.
|
|
568
609
|
* example:
|
|
569
610
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
570
611
|
*/
|
|
571
|
-
|
|
612
|
+
installation_job_id?: string;
|
|
572
613
|
/**
|
|
573
614
|
* Install engine used by the linked installation job, when known.
|
|
574
615
|
*/
|
|
@@ -907,6 +948,21 @@ declare namespace Components {
|
|
|
907
948
|
*/
|
|
908
949
|
postinstall?: string;
|
|
909
950
|
};
|
|
951
|
+
/**
|
|
952
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
953
|
+
* stamped with its author and creation time server-side and is never
|
|
954
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
955
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
956
|
+
*
|
|
957
|
+
* Available on every blueprint including marketplace ones (whose
|
|
958
|
+
* `description` is read-only), and never included in the published
|
|
959
|
+
* marketplace package — see `buildMetadata` in
|
|
960
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
961
|
+
* destination org only when an install/sync passes
|
|
962
|
+
* `options.sync_notes: true`.
|
|
963
|
+
*
|
|
964
|
+
*/
|
|
965
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
910
966
|
version?: string;
|
|
911
967
|
deployments?: {
|
|
912
968
|
source_org_id?: string;
|
|
@@ -1278,6 +1334,21 @@ declare namespace Components {
|
|
|
1278
1334
|
*/
|
|
1279
1335
|
postinstall?: string;
|
|
1280
1336
|
};
|
|
1337
|
+
/**
|
|
1338
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
1339
|
+
* stamped with its author and creation time server-side and is never
|
|
1340
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
1341
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1342
|
+
*
|
|
1343
|
+
* Available on every blueprint including marketplace ones (whose
|
|
1344
|
+
* `description` is read-only), and never included in the published
|
|
1345
|
+
* marketplace package — see `buildMetadata` in
|
|
1346
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
1347
|
+
* destination org only when an install/sync passes
|
|
1348
|
+
* `options.sync_notes: true`.
|
|
1349
|
+
*
|
|
1350
|
+
*/
|
|
1351
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
1281
1352
|
version?: string;
|
|
1282
1353
|
deployments?: {
|
|
1283
1354
|
source_org_id?: string;
|
|
@@ -1465,6 +1536,21 @@ declare namespace Components {
|
|
|
1465
1536
|
*/
|
|
1466
1537
|
postinstall?: string;
|
|
1467
1538
|
};
|
|
1539
|
+
/**
|
|
1540
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
1541
|
+
* stamped with its author and creation time server-side and is never
|
|
1542
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
1543
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1544
|
+
*
|
|
1545
|
+
* Available on every blueprint including marketplace ones (whose
|
|
1546
|
+
* `description` is read-only), and never included in the published
|
|
1547
|
+
* marketplace package — see `buildMetadata` in
|
|
1548
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
1549
|
+
* destination org only when an install/sync passes
|
|
1550
|
+
* `options.sync_notes: true`.
|
|
1551
|
+
*
|
|
1552
|
+
*/
|
|
1553
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
1468
1554
|
version?: string;
|
|
1469
1555
|
deployments?: {
|
|
1470
1556
|
source_org_id?: string;
|
|
@@ -1627,6 +1713,40 @@ declare namespace Components {
|
|
|
1627
1713
|
source_type: "deploy";
|
|
1628
1714
|
resources?: BlueprintResource[];
|
|
1629
1715
|
}
|
|
1716
|
+
export interface DeploymentHealthReport {
|
|
1717
|
+
status: "running" | "completed" | "failed";
|
|
1718
|
+
job_id: /**
|
|
1719
|
+
* ID of a job
|
|
1720
|
+
* example:
|
|
1721
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1722
|
+
*/
|
|
1723
|
+
BlueprintJobID;
|
|
1724
|
+
blueprint_instance_id: /**
|
|
1725
|
+
* ID of a blueprint
|
|
1726
|
+
* example:
|
|
1727
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1728
|
+
*/
|
|
1729
|
+
BlueprintID;
|
|
1730
|
+
destination_org_id: string;
|
|
1731
|
+
generated_at: string; // date-time
|
|
1732
|
+
/**
|
|
1733
|
+
* Presigned link to the rendered HTML report (present once the check completed)
|
|
1734
|
+
*/
|
|
1735
|
+
html_url?: string;
|
|
1736
|
+
summary?: {
|
|
1737
|
+
resources_scanned?: number;
|
|
1738
|
+
unchecked?: number;
|
|
1739
|
+
errors?: number;
|
|
1740
|
+
warnings?: number;
|
|
1741
|
+
infos?: number;
|
|
1742
|
+
};
|
|
1743
|
+
findings?: HealthFinding[];
|
|
1744
|
+
coverage?: HealthScanCoverage;
|
|
1745
|
+
/**
|
|
1746
|
+
* Failure reason when status is `failed`.
|
|
1747
|
+
*/
|
|
1748
|
+
error?: string;
|
|
1749
|
+
}
|
|
1630
1750
|
export interface DetectChangesResult {
|
|
1631
1751
|
resources?: PatchResourceDiff[];
|
|
1632
1752
|
}
|
|
@@ -1664,6 +1784,21 @@ declare namespace Components {
|
|
|
1664
1784
|
*/
|
|
1665
1785
|
postinstall?: string;
|
|
1666
1786
|
};
|
|
1787
|
+
/**
|
|
1788
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
1789
|
+
* stamped with its author and creation time server-side and is never
|
|
1790
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
1791
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1792
|
+
*
|
|
1793
|
+
* Available on every blueprint including marketplace ones (whose
|
|
1794
|
+
* `description` is read-only), and never included in the published
|
|
1795
|
+
* marketplace package — see `buildMetadata` in
|
|
1796
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
1797
|
+
* destination org only when an install/sync passes
|
|
1798
|
+
* `options.sync_notes: true`.
|
|
1799
|
+
*
|
|
1800
|
+
*/
|
|
1801
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
1667
1802
|
version?: string;
|
|
1668
1803
|
deployments?: {
|
|
1669
1804
|
source_org_id?: string;
|
|
@@ -1846,6 +1981,75 @@ declare namespace Components {
|
|
|
1846
1981
|
name?: string;
|
|
1847
1982
|
type?: string;
|
|
1848
1983
|
}
|
|
1984
|
+
export interface HealthCheckCoverage {
|
|
1985
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance";
|
|
1986
|
+
status: "completed" | "partial" | "skipped" | "not_applicable";
|
|
1987
|
+
scope: "tracked_resources" | "org_wide" | "source_comparison";
|
|
1988
|
+
resources_considered: number;
|
|
1989
|
+
details: string[];
|
|
1990
|
+
}
|
|
1991
|
+
export interface HealthFinding {
|
|
1992
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "catalog_hygiene" | "spec_conformance";
|
|
1993
|
+
code: "missing_in_destination" | "fetch_error" | "no_readback" | "unreplaced_source_reference" | "broken_internal_reference" | "dropped_at_install" | "orphaned_group_reference" | "uuid_group_label" | "unreachable_attribute_purpose" | "duplicate_attribute_name" | "duplicate_headline" | "broken_mapping_reference" | "stale_mapping_version" | "mapping_slot_mismatch" | "mapping_parity_mismatch" | "stale_lineage" | "broken_trigger_reference" | "broken_action_reference" | "broken_workflow_step" | "invalid_mapping_target" | "invalid_mapping_source" | "invalid_mapping_version" | "unknown_mapping_attribute" | "workflow_edge_limit" | "dead_purpose_reference" | "broken_portal_reference" | "orphaned_portal_block" | "broken_closing_reason" | "broken_journey_settings" | "unresolved_assignee" | "current_write_invalid" | "duplicate_live_resource" | "missing_file_content" | "file_etag_mismatch" | "incomplete_webhook" | "broken_template_reference" | "orphaned_price" | "duplicate_price" | "inactive_price_in_use" | "cross_org_reference";
|
|
1994
|
+
severity: "error" | "warning" | "info";
|
|
1995
|
+
resource_type: string;
|
|
1996
|
+
lineage_id: string;
|
|
1997
|
+
target_id?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* Human-readable name of the affected resource
|
|
2000
|
+
*/
|
|
2001
|
+
resource_name?: string;
|
|
2002
|
+
message: string;
|
|
2003
|
+
/**
|
|
2004
|
+
* Mechanical root-cause classification and suggested fix, when determinable
|
|
2005
|
+
*/
|
|
2006
|
+
verdict?: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* Check-specific evidence, e.g. the JSON path and referenced id of a broken reference.
|
|
2009
|
+
*/
|
|
2010
|
+
evidence?: {
|
|
2011
|
+
path?: string;
|
|
2012
|
+
referenced_id?: string;
|
|
2013
|
+
referenced_type?: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* Human-readable name or logical slug of the referenced source resource
|
|
2016
|
+
*/
|
|
2017
|
+
referenced_name?: string;
|
|
2018
|
+
/**
|
|
2019
|
+
* Logical source lineage identity of the referenced resource
|
|
2020
|
+
*/
|
|
2021
|
+
referenced_lineage_id?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* Destination id that should have replaced the source reference
|
|
2024
|
+
*/
|
|
2025
|
+
expected_target_id?: string;
|
|
2026
|
+
/**
|
|
2027
|
+
* Human-readable description of the exact field carrying the reference
|
|
2028
|
+
*/
|
|
2029
|
+
reference_kind?: string;
|
|
2030
|
+
operation?: string;
|
|
2031
|
+
rejection_reason?: string;
|
|
2032
|
+
error_message?: string;
|
|
2033
|
+
response_status?: number;
|
|
2034
|
+
};
|
|
2035
|
+
}
|
|
2036
|
+
export interface HealthResourceTypeCoverage {
|
|
2037
|
+
resource_type: string;
|
|
2038
|
+
tracked: number;
|
|
2039
|
+
readable_by_lineage: number;
|
|
2040
|
+
missing_by_lineage: number;
|
|
2041
|
+
read_errors: number;
|
|
2042
|
+
unchecked: number;
|
|
2043
|
+
specialized_checks: ("live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance")[];
|
|
2044
|
+
/**
|
|
2045
|
+
* Type-specific contracts the current scanner explicitly does not claim to validate.
|
|
2046
|
+
*/
|
|
2047
|
+
known_blind_spots: string[];
|
|
2048
|
+
}
|
|
2049
|
+
export interface HealthScanCoverage {
|
|
2050
|
+
checks: HealthCheckCoverage[];
|
|
2051
|
+
resource_types: HealthResourceTypeCoverage[];
|
|
2052
|
+
}
|
|
1849
2053
|
/**
|
|
1850
2054
|
* Summary of an installed marketplace blueprint for version tracking
|
|
1851
2055
|
*/
|
|
@@ -2466,6 +2670,21 @@ declare namespace Components {
|
|
|
2466
2670
|
*/
|
|
2467
2671
|
postinstall?: string;
|
|
2468
2672
|
};
|
|
2673
|
+
/**
|
|
2674
|
+
* Internal collaboration notes, oldest first. Append-only: each entry is
|
|
2675
|
+
* stamped with its author and creation time server-side and is never
|
|
2676
|
+
* rewritten, so the history of who noted what stays intact. Written via
|
|
2677
|
+
* `addBlueprintNote` / `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
2678
|
+
*
|
|
2679
|
+
* Available on every blueprint including marketplace ones (whose
|
|
2680
|
+
* `description` is read-only), and never included in the published
|
|
2681
|
+
* marketplace package — see `buildMetadata` in
|
|
2682
|
+
* `services/blueprint-v3/published-blueprint.ts`. Carried to a
|
|
2683
|
+
* destination org only when an install/sync passes
|
|
2684
|
+
* `options.sync_notes: true`.
|
|
2685
|
+
*
|
|
2686
|
+
*/
|
|
2687
|
+
notes?: /* A single internal note on a blueprint. */ BlueprintNote[];
|
|
2469
2688
|
version?: string;
|
|
2470
2689
|
deployments?: {
|
|
2471
2690
|
source_org_id?: string;
|
|
@@ -3096,6 +3315,31 @@ declare namespace Components {
|
|
|
3096
3315
|
}
|
|
3097
3316
|
}
|
|
3098
3317
|
declare namespace Paths {
|
|
3318
|
+
namespace AddBlueprintNote {
|
|
3319
|
+
namespace Parameters {
|
|
3320
|
+
export type BlueprintId = /**
|
|
3321
|
+
* ID of a blueprint
|
|
3322
|
+
* example:
|
|
3323
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3324
|
+
*/
|
|
3325
|
+
Components.Schemas.BlueprintID;
|
|
3326
|
+
}
|
|
3327
|
+
export interface PathParameters {
|
|
3328
|
+
blueprint_id: Parameters.BlueprintId;
|
|
3329
|
+
}
|
|
3330
|
+
export interface RequestBody {
|
|
3331
|
+
/**
|
|
3332
|
+
* Plain-text note body. Must not be blank.
|
|
3333
|
+
*/
|
|
3334
|
+
text: string;
|
|
3335
|
+
}
|
|
3336
|
+
namespace Responses {
|
|
3337
|
+
export type $201 = /* A single internal note on a blueprint. */ Components.Schemas.BlueprintNote;
|
|
3338
|
+
export interface $400 {
|
|
3339
|
+
message?: string;
|
|
3340
|
+
}
|
|
3341
|
+
}
|
|
3342
|
+
}
|
|
3099
3343
|
namespace AddBlueprintResource {
|
|
3100
3344
|
namespace Parameters {
|
|
3101
3345
|
/**
|
|
@@ -3509,6 +3753,29 @@ declare namespace Paths {
|
|
|
3509
3753
|
export type $200 = Components.Schemas.Blueprint;
|
|
3510
3754
|
}
|
|
3511
3755
|
}
|
|
3756
|
+
namespace DeleteBlueprintNote {
|
|
3757
|
+
namespace Parameters {
|
|
3758
|
+
export type BlueprintId = /**
|
|
3759
|
+
* ID of a blueprint
|
|
3760
|
+
* example:
|
|
3761
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3762
|
+
*/
|
|
3763
|
+
Components.Schemas.BlueprintID;
|
|
3764
|
+
export type NoteId = string;
|
|
3765
|
+
}
|
|
3766
|
+
export interface PathParameters {
|
|
3767
|
+
blueprint_id: Parameters.BlueprintId;
|
|
3768
|
+
note_id: Parameters.NoteId;
|
|
3769
|
+
}
|
|
3770
|
+
namespace Responses {
|
|
3771
|
+
export interface $200 {
|
|
3772
|
+
notes?: /* A single internal note on a blueprint. */ Components.Schemas.BlueprintNote[];
|
|
3773
|
+
}
|
|
3774
|
+
export interface $404 {
|
|
3775
|
+
message?: string;
|
|
3776
|
+
}
|
|
3777
|
+
}
|
|
3778
|
+
}
|
|
3512
3779
|
namespace DeleteBlueprintResource {
|
|
3513
3780
|
namespace Parameters {
|
|
3514
3781
|
export type BlueprintId = /**
|
|
@@ -3790,6 +4057,31 @@ declare namespace Paths {
|
|
|
3790
4057
|
}
|
|
3791
4058
|
}
|
|
3792
4059
|
}
|
|
4060
|
+
namespace GetDeploymentHealthReportV3 {
|
|
4061
|
+
namespace Parameters {
|
|
4062
|
+
export type BlueprintId = /**
|
|
4063
|
+
* ID of a blueprint
|
|
4064
|
+
* example:
|
|
4065
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4066
|
+
*/
|
|
4067
|
+
Components.Schemas.BlueprintID;
|
|
4068
|
+
export type JobId = /**
|
|
4069
|
+
* ID of a job
|
|
4070
|
+
* example:
|
|
4071
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4072
|
+
*/
|
|
4073
|
+
Components.Schemas.BlueprintJobID;
|
|
4074
|
+
}
|
|
4075
|
+
export interface PathParameters {
|
|
4076
|
+
blueprint_id: Parameters.BlueprintId;
|
|
4077
|
+
job_id: Parameters.JobId;
|
|
4078
|
+
}
|
|
4079
|
+
namespace Responses {
|
|
4080
|
+
export type $200 = Components.Schemas.DeploymentHealthReport;
|
|
4081
|
+
export interface $404 {
|
|
4082
|
+
}
|
|
4083
|
+
}
|
|
4084
|
+
}
|
|
3793
4085
|
namespace GetJob {
|
|
3794
4086
|
namespace Parameters {
|
|
3795
4087
|
export type JobId = /**
|
|
@@ -4068,6 +4360,7 @@ declare namespace Paths {
|
|
|
4068
4360
|
* Auth token for the destination org. Required for cross-org installs where the caller's token belongs to the source org. Defaults to the caller's bearer token.
|
|
4069
4361
|
*/
|
|
4070
4362
|
destination_auth_token?: string;
|
|
4363
|
+
source_blueprint_type?: "marketplace";
|
|
4071
4364
|
options?: Components.Schemas.BlueprintInstallationJobOptions;
|
|
4072
4365
|
/**
|
|
4073
4366
|
* Slug for marketplace blueprint consistency
|
|
@@ -4103,6 +4396,7 @@ declare namespace Paths {
|
|
|
4103
4396
|
* Auth token for the destination org. Required for cross-org installs where the caller's token belongs to the source org. Defaults to the caller's bearer token.
|
|
4104
4397
|
*/
|
|
4105
4398
|
destination_auth_token?: string;
|
|
4399
|
+
source_blueprint_type?: "marketplace";
|
|
4106
4400
|
options?: Components.Schemas.BlueprintInstallationJobOptions;
|
|
4107
4401
|
/**
|
|
4108
4402
|
* Slug for marketplace blueprint consistency
|
|
@@ -4320,6 +4614,26 @@ declare namespace Paths {
|
|
|
4320
4614
|
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
4321
4615
|
}
|
|
4322
4616
|
}
|
|
4617
|
+
namespace PreInstallBlueprintV3 {
|
|
4618
|
+
export interface RequestBody {
|
|
4619
|
+
/**
|
|
4620
|
+
* S3 key of a V3 blueprint package previously uploaded through uploadManifest
|
|
4621
|
+
*/
|
|
4622
|
+
blueprint_file: string;
|
|
4623
|
+
source_blueprint_type?: "marketplace";
|
|
4624
|
+
/**
|
|
4625
|
+
* Marketplace slug to preserve across updates
|
|
4626
|
+
*/
|
|
4627
|
+
slug?: string;
|
|
4628
|
+
}
|
|
4629
|
+
namespace Responses {
|
|
4630
|
+
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
4631
|
+
export interface $400 {
|
|
4632
|
+
}
|
|
4633
|
+
export interface $404 {
|
|
4634
|
+
}
|
|
4635
|
+
}
|
|
4636
|
+
}
|
|
4323
4637
|
namespace PublishBlueprint {
|
|
4324
4638
|
export interface RequestBody {
|
|
4325
4639
|
blueprint_id: /**
|
|
@@ -4547,6 +4861,41 @@ declare namespace Paths {
|
|
|
4547
4861
|
}
|
|
4548
4862
|
}
|
|
4549
4863
|
}
|
|
4864
|
+
namespace TriggerDeploymentHealthCheckV3 {
|
|
4865
|
+
namespace Parameters {
|
|
4866
|
+
export type BlueprintId = /**
|
|
4867
|
+
* ID of a blueprint
|
|
4868
|
+
* example:
|
|
4869
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4870
|
+
*/
|
|
4871
|
+
Components.Schemas.BlueprintID;
|
|
4872
|
+
export type JobId = /**
|
|
4873
|
+
* ID of a job
|
|
4874
|
+
* example:
|
|
4875
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4876
|
+
*/
|
|
4877
|
+
Components.Schemas.BlueprintJobID;
|
|
4878
|
+
}
|
|
4879
|
+
export interface PathParameters {
|
|
4880
|
+
blueprint_id: Parameters.BlueprintId;
|
|
4881
|
+
job_id: Parameters.JobId;
|
|
4882
|
+
}
|
|
4883
|
+
export interface RequestBody {
|
|
4884
|
+
/**
|
|
4885
|
+
* Source/sandbox org to deep-compare entity mappings against.
|
|
4886
|
+
*/
|
|
4887
|
+
source_org_id?: string;
|
|
4888
|
+
/**
|
|
4889
|
+
* Read token for the source org. Never persisted; used only for this scan.
|
|
4890
|
+
*/
|
|
4891
|
+
source_auth_token?: string;
|
|
4892
|
+
}
|
|
4893
|
+
namespace Responses {
|
|
4894
|
+
export type $202 = Components.Schemas.DeploymentHealthReport;
|
|
4895
|
+
export interface $404 {
|
|
4896
|
+
}
|
|
4897
|
+
}
|
|
4898
|
+
}
|
|
4550
4899
|
namespace UpdateBlueprint {
|
|
4551
4900
|
namespace Parameters {
|
|
4552
4901
|
export type BlueprintId = /**
|
|
@@ -4732,13 +5081,10 @@ declare namespace Paths {
|
|
|
4732
5081
|
destination_auth_token?: string;
|
|
4733
5082
|
/**
|
|
4734
5083
|
* Optional install job this verification is checking. If omitted, the latest destination blueprint installation job is used when available.
|
|
4735
|
-
*/
|
|
4736
|
-
installation_job_id?: /**
|
|
4737
|
-
* ID of a job
|
|
4738
5084
|
* example:
|
|
4739
5085
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4740
5086
|
*/
|
|
4741
|
-
|
|
5087
|
+
installation_job_id?: string;
|
|
4742
5088
|
/**
|
|
4743
5089
|
* Optional install engine hint. Usually inferred from installation_job_id.
|
|
4744
5090
|
*/
|
|
@@ -4965,6 +5311,29 @@ interface OperationMethods {
|
|
|
4965
5311
|
data?: any,
|
|
4966
5312
|
config?: AxiosRequestConfig
|
|
4967
5313
|
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
5314
|
+
/**
|
|
5315
|
+
* addBlueprintNote - addBlueprintNote
|
|
5316
|
+
*
|
|
5317
|
+
* Append an internal note to a blueprint. `id`, `created_at` and `created_by`
|
|
5318
|
+
* are stamped server-side from the caller, so notes cannot be backdated or
|
|
5319
|
+
* attributed to someone else. Existing notes are never modified.
|
|
5320
|
+
*
|
|
5321
|
+
*/
|
|
5322
|
+
'addBlueprintNote'(
|
|
5323
|
+
parameters?: Parameters<Paths.AddBlueprintNote.PathParameters> | null,
|
|
5324
|
+
data?: Paths.AddBlueprintNote.RequestBody,
|
|
5325
|
+
config?: AxiosRequestConfig
|
|
5326
|
+
): OperationResponse<Paths.AddBlueprintNote.Responses.$201>
|
|
5327
|
+
/**
|
|
5328
|
+
* deleteBlueprintNote - deleteBlueprintNote
|
|
5329
|
+
*
|
|
5330
|
+
* Remove a single internal note from a blueprint.
|
|
5331
|
+
*/
|
|
5332
|
+
'deleteBlueprintNote'(
|
|
5333
|
+
parameters?: Parameters<Paths.DeleteBlueprintNote.PathParameters> | null,
|
|
5334
|
+
data?: any,
|
|
5335
|
+
config?: AxiosRequestConfig
|
|
5336
|
+
): OperationResponse<Paths.DeleteBlueprintNote.Responses.$200>
|
|
4968
5337
|
/**
|
|
4969
5338
|
* validateBlueprint - validateBlueprint
|
|
4970
5339
|
*
|
|
@@ -5206,7 +5575,7 @@ interface OperationMethods {
|
|
|
5206
5575
|
* check `sync_engine` (`terraform` | `v3`) to tell them apart. V3 jobs additionally
|
|
5207
5576
|
* expose live `resource_progress[]`. V3 single-install and bulk-install child jobs
|
|
5208
5577
|
* are polled here.
|
|
5209
|
-
*
|
|
5578
|
+
*
|
|
5210
5579
|
*/
|
|
5211
5580
|
'getBlueprintJob'(
|
|
5212
5581
|
parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
|
|
@@ -5220,7 +5589,7 @@ interface OperationMethods {
|
|
|
5220
5589
|
* planning. Works for both Terraform and V3 jobs. Not needed for V3 installs created
|
|
5221
5590
|
* with `auto_apply: true` (including all bulk-install child jobs), which apply
|
|
5222
5591
|
* without pausing.
|
|
5223
|
-
*
|
|
5592
|
+
*
|
|
5224
5593
|
*/
|
|
5225
5594
|
'continueInstallationJob'(
|
|
5226
5595
|
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
@@ -5339,21 +5708,31 @@ interface OperationMethods {
|
|
|
5339
5708
|
): OperationResponse<Paths.PublishMarketplaceListingVersion.Responses.$200>
|
|
5340
5709
|
/**
|
|
5341
5710
|
* publishBlueprintV3 - Publish Blueprint V3
|
|
5342
|
-
*
|
|
5711
|
+
*
|
|
5343
5712
|
* Starts an asynchronous V3 publication. The result is a signed, portable package; poll the existing blueprint job endpoint for completion.
|
|
5344
5713
|
*/
|
|
5345
5714
|
'publishBlueprintV3'(
|
|
5346
5715
|
parameters?: Parameters<Paths.PublishBlueprintV3.PathParameters> | null,
|
|
5347
5716
|
data?: any,
|
|
5348
|
-
config?: AxiosRequestConfig
|
|
5717
|
+
config?: AxiosRequestConfig
|
|
5349
5718
|
): OperationResponse<Paths.PublishBlueprintV3.Responses.$202>
|
|
5719
|
+
/**
|
|
5720
|
+
* preInstallBlueprintV3 - Preview a V3 blueprint package before installation
|
|
5721
|
+
*
|
|
5722
|
+
* Validates a signed V3 package and returns the destination-specific resource plan used by the install UI.
|
|
5723
|
+
*/
|
|
5724
|
+
'preInstallBlueprintV3'(
|
|
5725
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
5726
|
+
data?: Paths.PreInstallBlueprintV3.RequestBody,
|
|
5727
|
+
config?: AxiosRequestConfig
|
|
5728
|
+
): OperationResponse<Paths.PreInstallBlueprintV3.Responses.$200>
|
|
5350
5729
|
/**
|
|
5351
5730
|
* installBlueprintV3 - Install Blueprint V3
|
|
5352
5731
|
*
|
|
5353
5732
|
* Install a blueprint into a single destination org using the V3 engine (direct API
|
|
5354
5733
|
* calls, no Terraform). Creates resources in topological order with global ID
|
|
5355
5734
|
* replacement and supports checkpoint-based resume on failure.
|
|
5356
|
-
*
|
|
5735
|
+
*
|
|
5357
5736
|
* **Lifecycle (how to drive an install to completion):**
|
|
5358
5737
|
* 1. `POST /v3/blueprint-manifest/blueprint:install` returns `{ job_id }` (202).
|
|
5359
5738
|
* 2. Poll the job with `GET /v2/blueprint-manifest/jobs/{job_id}` — V3 jobs are
|
|
@@ -5365,7 +5744,7 @@ interface OperationMethods {
|
|
|
5365
5744
|
* 4. If `auto_apply` is `true`, the engine applies automatically after plan +
|
|
5366
5745
|
* snapshot — no `:continue` call is needed. This is what the bulk-install worker
|
|
5367
5746
|
* uses; to install into many orgs at once prefer `POST .../bulk-installs`.
|
|
5368
|
-
*
|
|
5747
|
+
*
|
|
5369
5748
|
* For cross-org installs, pass `destination_auth_token` (the destination org's
|
|
5370
5749
|
* token); reads use the caller's bearer token, writes use that token.
|
|
5371
5750
|
*
|
|
@@ -5424,6 +5803,43 @@ interface OperationMethods {
|
|
|
5424
5803
|
data?: any,
|
|
5425
5804
|
config?: AxiosRequestConfig
|
|
5426
5805
|
): OperationResponse<Paths.GetRestorePreview.Responses.$200>
|
|
5806
|
+
/**
|
|
5807
|
+
* triggerDeploymentHealthCheckV3 - Run a health check on a deployment
|
|
5808
|
+
*
|
|
5809
|
+
* Starts a read-only health scan of the resources this deployment's
|
|
5810
|
+
* blueprint instance tracks in the destination org (see
|
|
5811
|
+
* docs/rfcs/RFC-org-health-check.md, Phase 0). Checks:
|
|
5812
|
+
*
|
|
5813
|
+
* - live readability — every lineage-tracked resource is read back
|
|
5814
|
+
* via its adapter; tracked-but-unreadable resources are flagged.
|
|
5815
|
+
* - referential integrity — destination payloads containing
|
|
5816
|
+
* unreplaced source-org ids, or references to tracked resources
|
|
5817
|
+
* that are not readable.
|
|
5818
|
+
* - install completeness — install operations whose final attempt
|
|
5819
|
+
* ended `failed` or `skipped`, with their rejection reasons.
|
|
5820
|
+
*
|
|
5821
|
+
* Async — returns 202 immediately with a `running` report stub. Poll
|
|
5822
|
+
* the health-report endpoint until `status` is `completed` or
|
|
5823
|
+
* `failed`. Never mutates any resource.
|
|
5824
|
+
*
|
|
5825
|
+
*/
|
|
5826
|
+
'triggerDeploymentHealthCheckV3'(
|
|
5827
|
+
parameters?: Parameters<Paths.TriggerDeploymentHealthCheckV3.PathParameters> | null,
|
|
5828
|
+
data?: Paths.TriggerDeploymentHealthCheckV3.RequestBody,
|
|
5829
|
+
config?: AxiosRequestConfig
|
|
5830
|
+
): OperationResponse<Paths.TriggerDeploymentHealthCheckV3.Responses.$202>
|
|
5831
|
+
/**
|
|
5832
|
+
* getDeploymentHealthReportV3 - Get the latest health report of a deployment
|
|
5833
|
+
*
|
|
5834
|
+
* Returns the most recent health report produced for this deployment
|
|
5835
|
+
* by the `:health-check` endpoint. Idempotent and side-effect free.
|
|
5836
|
+
*
|
|
5837
|
+
*/
|
|
5838
|
+
'getDeploymentHealthReportV3'(
|
|
5839
|
+
parameters?: Parameters<Paths.GetDeploymentHealthReportV3.PathParameters> | null,
|
|
5840
|
+
data?: any,
|
|
5841
|
+
config?: AxiosRequestConfig
|
|
5842
|
+
): OperationResponse<Paths.GetDeploymentHealthReportV3.Responses.$200>
|
|
5427
5843
|
/**
|
|
5428
5844
|
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
5429
5845
|
*
|
|
@@ -5438,61 +5854,61 @@ interface OperationMethods {
|
|
|
5438
5854
|
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
5439
5855
|
/**
|
|
5440
5856
|
* createBulkInstallV3 - Create Bulk Install V3
|
|
5441
|
-
*
|
|
5857
|
+
*
|
|
5442
5858
|
* Install one source blueprint into many destination organizations in a single
|
|
5443
5859
|
* request. The server schedules child V3 installs with `auto_apply=true` and caps
|
|
5444
5860
|
* active installs at `max_concurrency`. Per-target failures are isolated and
|
|
5445
5861
|
* retryable; they do not stop the remaining targets.
|
|
5446
|
-
*
|
|
5862
|
+
*
|
|
5447
5863
|
* Each target carries its own write-only `destination_auth_token` (org-scoped).
|
|
5448
5864
|
* Tokens are passed to the worker via Step Functions input only — they are never
|
|
5449
5865
|
* persisted in DynamoDB nor returned by any endpoint.
|
|
5450
|
-
*
|
|
5866
|
+
*
|
|
5451
5867
|
*/
|
|
5452
5868
|
'createBulkInstallV3'(
|
|
5453
5869
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
5454
5870
|
data?: Paths.CreateBulkInstallV3.RequestBody,
|
|
5455
|
-
config?: AxiosRequestConfig
|
|
5871
|
+
config?: AxiosRequestConfig
|
|
5456
5872
|
): OperationResponse<Paths.CreateBulkInstallV3.Responses.$202>
|
|
5457
5873
|
/**
|
|
5458
5874
|
* getBulkInstallV3 - Get Bulk Install V3
|
|
5459
|
-
*
|
|
5875
|
+
*
|
|
5460
5876
|
* Returns the bulk install parent with aggregate status and counts. Scoped by the
|
|
5461
5877
|
* caller org as `source_org_id`. Target rows are not included — use the targets
|
|
5462
5878
|
* endpoint to page through them.
|
|
5463
|
-
*
|
|
5879
|
+
*
|
|
5464
5880
|
*/
|
|
5465
5881
|
'getBulkInstallV3'(
|
|
5466
5882
|
parameters?: Parameters<Paths.GetBulkInstallV3.PathParameters> | null,
|
|
5467
5883
|
data?: any,
|
|
5468
|
-
config?: AxiosRequestConfig
|
|
5884
|
+
config?: AxiosRequestConfig
|
|
5469
5885
|
): OperationResponse<Paths.GetBulkInstallV3.Responses.$200>
|
|
5470
5886
|
/**
|
|
5471
5887
|
* listBulkInstallTargetsV3 - List Bulk Install Targets V3
|
|
5472
|
-
*
|
|
5888
|
+
*
|
|
5473
5889
|
* Pages through the bulk install's target rows. Each row hydrates its latest child
|
|
5474
5890
|
* install job (`job_ids.at(-1)`) with the standard V3 job shape (`events[]`,
|
|
5475
5891
|
* `resource_progress[]`) so callers can inspect per-resource progress and errors.
|
|
5476
|
-
*
|
|
5892
|
+
*
|
|
5477
5893
|
*/
|
|
5478
5894
|
'listBulkInstallTargetsV3'(
|
|
5479
5895
|
parameters?: Parameters<Paths.ListBulkInstallTargetsV3.QueryParameters & Paths.ListBulkInstallTargetsV3.PathParameters> | null,
|
|
5480
5896
|
data?: any,
|
|
5481
|
-
config?: AxiosRequestConfig
|
|
5897
|
+
config?: AxiosRequestConfig
|
|
5482
5898
|
): OperationResponse<Paths.ListBulkInstallTargetsV3.Responses.$200>
|
|
5483
5899
|
/**
|
|
5484
5900
|
* retryBulkInstallTargetV3 - Retry Bulk Install Target V3
|
|
5485
|
-
*
|
|
5901
|
+
*
|
|
5486
5902
|
* Retries a single failed target. Allowed only for `FAILED` and `PARTIAL_SUCCESS`
|
|
5487
5903
|
* targets. Starts a new child install with `auto_apply=true`, appends its job id to
|
|
5488
5904
|
* `job_ids`, and reuses the same target row. Only the destination auth token may be
|
|
5489
5905
|
* supplied for the new attempt; source/destination identifiers are immutable.
|
|
5490
|
-
*
|
|
5906
|
+
*
|
|
5491
5907
|
*/
|
|
5492
5908
|
'retryBulkInstallTargetV3'(
|
|
5493
5909
|
parameters?: Parameters<Paths.RetryBulkInstallTargetV3.PathParameters> | null,
|
|
5494
5910
|
data?: Paths.RetryBulkInstallTargetV3.RequestBody,
|
|
5495
|
-
config?: AxiosRequestConfig
|
|
5911
|
+
config?: AxiosRequestConfig
|
|
5496
5912
|
): OperationResponse<Paths.RetryBulkInstallTargetV3.Responses.$200>
|
|
5497
5913
|
/**
|
|
5498
5914
|
* listUniquenessCriteria - listUniquenessCriteria
|
|
@@ -5776,6 +6192,33 @@ interface PathsDictionary {
|
|
|
5776
6192
|
config?: AxiosRequestConfig
|
|
5777
6193
|
): OperationResponse<Paths.DeleteBlueprint.Responses.$200>
|
|
5778
6194
|
}
|
|
6195
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/notes']: {
|
|
6196
|
+
/**
|
|
6197
|
+
* addBlueprintNote - addBlueprintNote
|
|
6198
|
+
*
|
|
6199
|
+
* Append an internal note to a blueprint. `id`, `created_at` and `created_by`
|
|
6200
|
+
* are stamped server-side from the caller, so notes cannot be backdated or
|
|
6201
|
+
* attributed to someone else. Existing notes are never modified.
|
|
6202
|
+
*
|
|
6203
|
+
*/
|
|
6204
|
+
'post'(
|
|
6205
|
+
parameters?: Parameters<Paths.AddBlueprintNote.PathParameters> | null,
|
|
6206
|
+
data?: Paths.AddBlueprintNote.RequestBody,
|
|
6207
|
+
config?: AxiosRequestConfig
|
|
6208
|
+
): OperationResponse<Paths.AddBlueprintNote.Responses.$201>
|
|
6209
|
+
}
|
|
6210
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id}']: {
|
|
6211
|
+
/**
|
|
6212
|
+
* deleteBlueprintNote - deleteBlueprintNote
|
|
6213
|
+
*
|
|
6214
|
+
* Remove a single internal note from a blueprint.
|
|
6215
|
+
*/
|
|
6216
|
+
'delete'(
|
|
6217
|
+
parameters?: Parameters<Paths.DeleteBlueprintNote.PathParameters> | null,
|
|
6218
|
+
data?: any,
|
|
6219
|
+
config?: AxiosRequestConfig
|
|
6220
|
+
): OperationResponse<Paths.DeleteBlueprintNote.Responses.$200>
|
|
6221
|
+
}
|
|
5779
6222
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/validate']: {
|
|
5780
6223
|
/**
|
|
5781
6224
|
* validateBlueprint - validateBlueprint
|
|
@@ -6052,7 +6495,7 @@ interface PathsDictionary {
|
|
|
6052
6495
|
* check `sync_engine` (`terraform` | `v3`) to tell them apart. V3 jobs additionally
|
|
6053
6496
|
* expose live `resource_progress[]`. V3 single-install and bulk-install child jobs
|
|
6054
6497
|
* are polled here.
|
|
6055
|
-
*
|
|
6498
|
+
*
|
|
6056
6499
|
*/
|
|
6057
6500
|
'get'(
|
|
6058
6501
|
parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
|
|
@@ -6068,7 +6511,7 @@ interface PathsDictionary {
|
|
|
6068
6511
|
* planning. Works for both Terraform and V3 jobs. Not needed for V3 installs created
|
|
6069
6512
|
* with `auto_apply: true` (including all bulk-install child jobs), which apply
|
|
6070
6513
|
* without pausing.
|
|
6071
|
-
*
|
|
6514
|
+
*
|
|
6072
6515
|
*/
|
|
6073
6516
|
'post'(
|
|
6074
6517
|
parameters?: Parameters<Paths.ContinueInstallationJob.PathParameters> | null,
|
|
@@ -6203,15 +6646,27 @@ interface PathsDictionary {
|
|
|
6203
6646
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}:publish']: {
|
|
6204
6647
|
/**
|
|
6205
6648
|
* publishBlueprintV3 - Publish Blueprint V3
|
|
6206
|
-
*
|
|
6649
|
+
*
|
|
6207
6650
|
* Starts an asynchronous V3 publication. The result is a signed, portable package; poll the existing blueprint job endpoint for completion.
|
|
6208
6651
|
*/
|
|
6209
6652
|
'post'(
|
|
6210
6653
|
parameters?: Parameters<Paths.PublishBlueprintV3.PathParameters> | null,
|
|
6211
6654
|
data?: any,
|
|
6212
|
-
config?: AxiosRequestConfig
|
|
6655
|
+
config?: AxiosRequestConfig
|
|
6213
6656
|
): OperationResponse<Paths.PublishBlueprintV3.Responses.$202>
|
|
6214
6657
|
}
|
|
6658
|
+
['/v3/blueprint-manifest/blueprints:pre-install']: {
|
|
6659
|
+
/**
|
|
6660
|
+
* preInstallBlueprintV3 - Preview a V3 blueprint package before installation
|
|
6661
|
+
*
|
|
6662
|
+
* Validates a signed V3 package and returns the destination-specific resource plan used by the install UI.
|
|
6663
|
+
*/
|
|
6664
|
+
'post'(
|
|
6665
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
6666
|
+
data?: Paths.PreInstallBlueprintV3.RequestBody,
|
|
6667
|
+
config?: AxiosRequestConfig
|
|
6668
|
+
): OperationResponse<Paths.PreInstallBlueprintV3.Responses.$200>
|
|
6669
|
+
}
|
|
6215
6670
|
['/v3/blueprint-manifest/blueprint:install']: {
|
|
6216
6671
|
/**
|
|
6217
6672
|
* installBlueprintV3 - Install Blueprint V3
|
|
@@ -6219,7 +6674,7 @@ interface PathsDictionary {
|
|
|
6219
6674
|
* Install a blueprint into a single destination org using the V3 engine (direct API
|
|
6220
6675
|
* calls, no Terraform). Creates resources in topological order with global ID
|
|
6221
6676
|
* replacement and supports checkpoint-based resume on failure.
|
|
6222
|
-
*
|
|
6677
|
+
*
|
|
6223
6678
|
* **Lifecycle (how to drive an install to completion):**
|
|
6224
6679
|
* 1. `POST /v3/blueprint-manifest/blueprint:install` returns `{ job_id }` (202).
|
|
6225
6680
|
* 2. Poll the job with `GET /v2/blueprint-manifest/jobs/{job_id}` — V3 jobs are
|
|
@@ -6231,7 +6686,7 @@ interface PathsDictionary {
|
|
|
6231
6686
|
* 4. If `auto_apply` is `true`, the engine applies automatically after plan +
|
|
6232
6687
|
* snapshot — no `:continue` call is needed. This is what the bulk-install worker
|
|
6233
6688
|
* uses; to install into many orgs at once prefer `POST .../bulk-installs`.
|
|
6234
|
-
*
|
|
6689
|
+
*
|
|
6235
6690
|
* For cross-org installs, pass `destination_auth_token` (the destination org's
|
|
6236
6691
|
* token); reads use the caller's bearer token, writes use that token.
|
|
6237
6692
|
*
|
|
@@ -6295,6 +6750,47 @@ interface PathsDictionary {
|
|
|
6295
6750
|
config?: AxiosRequestConfig
|
|
6296
6751
|
): OperationResponse<Paths.GetRestorePreview.Responses.$200>
|
|
6297
6752
|
}
|
|
6753
|
+
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:health-check']: {
|
|
6754
|
+
/**
|
|
6755
|
+
* triggerDeploymentHealthCheckV3 - Run a health check on a deployment
|
|
6756
|
+
*
|
|
6757
|
+
* Starts a read-only health scan of the resources this deployment's
|
|
6758
|
+
* blueprint instance tracks in the destination org (see
|
|
6759
|
+
* docs/rfcs/RFC-org-health-check.md, Phase 0). Checks:
|
|
6760
|
+
*
|
|
6761
|
+
* - live readability — every lineage-tracked resource is read back
|
|
6762
|
+
* via its adapter; tracked-but-unreadable resources are flagged.
|
|
6763
|
+
* - referential integrity — destination payloads containing
|
|
6764
|
+
* unreplaced source-org ids, or references to tracked resources
|
|
6765
|
+
* that are not readable.
|
|
6766
|
+
* - install completeness — install operations whose final attempt
|
|
6767
|
+
* ended `failed` or `skipped`, with their rejection reasons.
|
|
6768
|
+
*
|
|
6769
|
+
* Async — returns 202 immediately with a `running` report stub. Poll
|
|
6770
|
+
* the health-report endpoint until `status` is `completed` or
|
|
6771
|
+
* `failed`. Never mutates any resource.
|
|
6772
|
+
*
|
|
6773
|
+
*/
|
|
6774
|
+
'post'(
|
|
6775
|
+
parameters?: Parameters<Paths.TriggerDeploymentHealthCheckV3.PathParameters> | null,
|
|
6776
|
+
data?: Paths.TriggerDeploymentHealthCheckV3.RequestBody,
|
|
6777
|
+
config?: AxiosRequestConfig
|
|
6778
|
+
): OperationResponse<Paths.TriggerDeploymentHealthCheckV3.Responses.$202>
|
|
6779
|
+
}
|
|
6780
|
+
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/health-report']: {
|
|
6781
|
+
/**
|
|
6782
|
+
* getDeploymentHealthReportV3 - Get the latest health report of a deployment
|
|
6783
|
+
*
|
|
6784
|
+
* Returns the most recent health report produced for this deployment
|
|
6785
|
+
* by the `:health-check` endpoint. Idempotent and side-effect free.
|
|
6786
|
+
*
|
|
6787
|
+
*/
|
|
6788
|
+
'get'(
|
|
6789
|
+
parameters?: Parameters<Paths.GetDeploymentHealthReportV3.PathParameters> | null,
|
|
6790
|
+
data?: any,
|
|
6791
|
+
config?: AxiosRequestConfig
|
|
6792
|
+
): OperationResponse<Paths.GetDeploymentHealthReportV3.Responses.$200>
|
|
6793
|
+
}
|
|
6298
6794
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/lineage']: {
|
|
6299
6795
|
/**
|
|
6300
6796
|
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
@@ -6312,67 +6808,67 @@ interface PathsDictionary {
|
|
|
6312
6808
|
['/v3/blueprint-manifest/bulk-installs']: {
|
|
6313
6809
|
/**
|
|
6314
6810
|
* createBulkInstallV3 - Create Bulk Install V3
|
|
6315
|
-
*
|
|
6811
|
+
*
|
|
6316
6812
|
* Install one source blueprint into many destination organizations in a single
|
|
6317
6813
|
* request. The server schedules child V3 installs with `auto_apply=true` and caps
|
|
6318
6814
|
* active installs at `max_concurrency`. Per-target failures are isolated and
|
|
6319
6815
|
* retryable; they do not stop the remaining targets.
|
|
6320
|
-
*
|
|
6816
|
+
*
|
|
6321
6817
|
* Each target carries its own write-only `destination_auth_token` (org-scoped).
|
|
6322
6818
|
* Tokens are passed to the worker via Step Functions input only — they are never
|
|
6323
6819
|
* persisted in DynamoDB nor returned by any endpoint.
|
|
6324
|
-
*
|
|
6820
|
+
*
|
|
6325
6821
|
*/
|
|
6326
6822
|
'post'(
|
|
6327
6823
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
6328
6824
|
data?: Paths.CreateBulkInstallV3.RequestBody,
|
|
6329
|
-
config?: AxiosRequestConfig
|
|
6825
|
+
config?: AxiosRequestConfig
|
|
6330
6826
|
): OperationResponse<Paths.CreateBulkInstallV3.Responses.$202>
|
|
6331
6827
|
}
|
|
6332
6828
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}']: {
|
|
6333
6829
|
/**
|
|
6334
6830
|
* getBulkInstallV3 - Get Bulk Install V3
|
|
6335
|
-
*
|
|
6831
|
+
*
|
|
6336
6832
|
* Returns the bulk install parent with aggregate status and counts. Scoped by the
|
|
6337
6833
|
* caller org as `source_org_id`. Target rows are not included — use the targets
|
|
6338
6834
|
* endpoint to page through them.
|
|
6339
|
-
*
|
|
6835
|
+
*
|
|
6340
6836
|
*/
|
|
6341
6837
|
'get'(
|
|
6342
6838
|
parameters?: Parameters<Paths.GetBulkInstallV3.PathParameters> | null,
|
|
6343
6839
|
data?: any,
|
|
6344
|
-
config?: AxiosRequestConfig
|
|
6840
|
+
config?: AxiosRequestConfig
|
|
6345
6841
|
): OperationResponse<Paths.GetBulkInstallV3.Responses.$200>
|
|
6346
6842
|
}
|
|
6347
6843
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets']: {
|
|
6348
6844
|
/**
|
|
6349
6845
|
* listBulkInstallTargetsV3 - List Bulk Install Targets V3
|
|
6350
|
-
*
|
|
6846
|
+
*
|
|
6351
6847
|
* Pages through the bulk install's target rows. Each row hydrates its latest child
|
|
6352
6848
|
* install job (`job_ids.at(-1)`) with the standard V3 job shape (`events[]`,
|
|
6353
6849
|
* `resource_progress[]`) so callers can inspect per-resource progress and errors.
|
|
6354
|
-
*
|
|
6850
|
+
*
|
|
6355
6851
|
*/
|
|
6356
6852
|
'get'(
|
|
6357
6853
|
parameters?: Parameters<Paths.ListBulkInstallTargetsV3.QueryParameters & Paths.ListBulkInstallTargetsV3.PathParameters> | null,
|
|
6358
6854
|
data?: any,
|
|
6359
|
-
config?: AxiosRequestConfig
|
|
6855
|
+
config?: AxiosRequestConfig
|
|
6360
6856
|
): OperationResponse<Paths.ListBulkInstallTargetsV3.Responses.$200>
|
|
6361
6857
|
}
|
|
6362
6858
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets/{destination_org_id}:retry']: {
|
|
6363
6859
|
/**
|
|
6364
6860
|
* retryBulkInstallTargetV3 - Retry Bulk Install Target V3
|
|
6365
|
-
*
|
|
6861
|
+
*
|
|
6366
6862
|
* Retries a single failed target. Allowed only for `FAILED` and `PARTIAL_SUCCESS`
|
|
6367
6863
|
* targets. Starts a new child install with `auto_apply=true`, appends its job id to
|
|
6368
6864
|
* `job_ids`, and reuses the same target row. Only the destination auth token may be
|
|
6369
6865
|
* supplied for the new attempt; source/destination identifiers are immutable.
|
|
6370
|
-
*
|
|
6866
|
+
*
|
|
6371
6867
|
*/
|
|
6372
6868
|
'post'(
|
|
6373
6869
|
parameters?: Parameters<Paths.RetryBulkInstallTargetV3.PathParameters> | null,
|
|
6374
6870
|
data?: Paths.RetryBulkInstallTargetV3.RequestBody,
|
|
6375
|
-
config?: AxiosRequestConfig
|
|
6871
|
+
config?: AxiosRequestConfig
|
|
6376
6872
|
): OperationResponse<Paths.RetryBulkInstallTargetV3.Responses.$200>
|
|
6377
6873
|
}
|
|
6378
6874
|
['/v1/blueprint-manifest/uniqueness-criteria']: {
|
|
@@ -6442,6 +6938,7 @@ type BlueprintInstallationJobOptions = Components.Schemas.BlueprintInstallationJ
|
|
|
6442
6938
|
type BlueprintJob = Components.Schemas.BlueprintJob;
|
|
6443
6939
|
type BlueprintJobEvent = Components.Schemas.BlueprintJobEvent;
|
|
6444
6940
|
type BlueprintJobID = Components.Schemas.BlueprintJobID;
|
|
6941
|
+
type BlueprintNote = Components.Schemas.BlueprintNote;
|
|
6445
6942
|
type BlueprintPatch = Components.Schemas.BlueprintPatch;
|
|
6446
6943
|
type BlueprintPatchWithResults = Components.Schemas.BlueprintPatchWithResults;
|
|
6447
6944
|
type BlueprintPreview = Components.Schemas.BlueprintPreview;
|
|
@@ -6466,12 +6963,17 @@ type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
|
|
|
6466
6963
|
type CommonResourceNode = Components.Schemas.CommonResourceNode;
|
|
6467
6964
|
type CustomBlueprint = Components.Schemas.CustomBlueprint;
|
|
6468
6965
|
type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
|
|
6966
|
+
type DeploymentHealthReport = Components.Schemas.DeploymentHealthReport;
|
|
6469
6967
|
type DetectChangesResult = Components.Schemas.DetectChangesResult;
|
|
6470
6968
|
type FieldDiff = Components.Schemas.FieldDiff;
|
|
6471
6969
|
type FileBlueprint = Components.Schemas.FileBlueprint;
|
|
6472
6970
|
type FormattedError = Components.Schemas.FormattedError;
|
|
6473
6971
|
type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
|
|
6474
6972
|
type FormattedErrorData = Components.Schemas.FormattedErrorData;
|
|
6973
|
+
type HealthCheckCoverage = Components.Schemas.HealthCheckCoverage;
|
|
6974
|
+
type HealthFinding = Components.Schemas.HealthFinding;
|
|
6975
|
+
type HealthResourceTypeCoverage = Components.Schemas.HealthResourceTypeCoverage;
|
|
6976
|
+
type HealthScanCoverage = Components.Schemas.HealthScanCoverage;
|
|
6475
6977
|
type InstalledMarketplaceBlueprintItem = Components.Schemas.InstalledMarketplaceBlueprintItem;
|
|
6476
6978
|
type Job = Components.Schemas.Job;
|
|
6477
6979
|
type JobID = Components.Schemas.JobID;
|
|
@@ -6511,4 +7013,4 @@ type V3ResourceProgressEntry = Components.Schemas.V3ResourceProgressEntry;
|
|
|
6511
7013
|
type VerificationSummary = Components.Schemas.VerificationSummary;
|
|
6512
7014
|
type VirtualResourceNodeGroup = Components.Schemas.VirtualResourceNodeGroup;
|
|
6513
7015
|
|
|
6514
|
-
export { type
|
|
7016
|
+
export { type Job as $, type AppBlueprint as A, type Blueprint as B, type Client as C, type BulkInstallTargetList as D, type CallerIdentity as E, type CommonBlueprintFields as F, type CommonBlueprintJobFields as G, type CommonImportFields as H, type CommonManifestFields as I, type CommonMarkdownFields as J, type CommonResourceNode as K, type CustomBlueprint as L, type DeployedBlueprint as M, type DeploymentHealthReport as N, type OperationMethods as O, Paths as P, type DetectChangesResult as Q, type FieldDiff as R, type FileBlueprint as S, type FormattedError as T, type FormattedErrorCodes as U, type FormattedErrorData as V, type HealthCheckCoverage as W, type HealthFinding as X, type HealthResourceTypeCoverage as Y, type HealthScanCoverage as Z, type InstalledMarketplaceBlueprintItem as _, Components as a, type JobID as a0, type JobStatus as a1, type LatestBlueprintVerification as a2, type LineageEntry as a3, type Manifest as a4, type ManifestID as a5, type ManifestItem as a6, type ManifestSource as a7, type ManifestTimestampFields as a8, type MarketplaceBlueprint as a9, type MarketplaceListing as aa, type MarketplaceListingUpdate as ab, type MarketplaceListingVersion as ac, type OrgPatchExecution as ad, type PatchFieldDiff as ae, type PatchResourceDiff as af, type PlanChanges as ag, type PreInstallRequirements as ah, type PutManifestPayload as ai, type ResourceNode as aj, type ResourceNodeType as ak, type ResourceReplacement as al, type ResourceVerificationResult as am, type RestoreOutcome as an, type RestoreOutcomeItem as ao, type RootResourceNode as ap, type S3Reference as aq, type SelectedResources as ar, type SuggestBlueprintResourcesRequest as as, type SuggestBlueprintResourcesResponse as at, type UniquenessCriteria as au, type UniquenessCriteriaResourceType as av, type UploadFilePayload as aw, type V3ResourceProgressEntry as ax, type VerificationSummary as ay, type VirtualResourceNodeGroup as az, type PathsDictionary as b, type BlueprintDependenciesSyncJob as c, type BlueprintExportJob as d, type BlueprintID as e, type BlueprintInstallStatus as f, type BlueprintInstallationJob as g, type BlueprintInstallationJobOptions as h, type BlueprintJob as i, type BlueprintJobEvent as j, type BlueprintJobID as k, type BlueprintNote as l, type BlueprintPatch as m, type BlueprintPatchWithResults as n, type BlueprintPreview as o, type BlueprintResource as p, type BlueprintResourceID as q, type BlueprintRestoreJob as r, type BlueprintValidateJob as s, type BlueprintVerificationJob as t, type BulkInstall as u, type BulkInstallCounts as v, type BulkInstallCreateRequest as w, type BulkInstallStatus as x, type BulkInstallTarget as y, type BulkInstallTargetInput as z };
|