@epilot/sdk 2.18.1 → 2.18.3
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 +219 -20
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +89 -6
- 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 +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 +8 -8
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +2 -2
- 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-4DD7CUPX.cjs +7 -0
- package/dist/blueprint-manifest-IP2AU3F3.js +7 -0
- package/dist/{blueprint-manifest-runtime-6MEPQQC5.cjs → blueprint-manifest-runtime-N5EXZB2K.cjs} +2 -2
- package/dist/{blueprint-manifest-runtime-SAWWJW2G.js → blueprint-manifest-runtime-W526ROPG.js} +1 -1
- package/dist/{blueprint-manifest.d-BiaeSTI3.d.cts → blueprint-manifest.d-CjsI-JqR.d.cts} +400 -62
- package/dist/{blueprint-manifest.d-BiaeSTI3.d.ts → blueprint-manifest.d-CjsI-JqR.d.ts} +400 -62
- package/dist/chunk-4Z6GRBDK.js +14 -0
- package/dist/{chunk-RJHXXGJ3.js → chunk-5OOGTDF2.js} +1 -1
- package/dist/{chunk-NCGUD7SQ.cjs → chunk-5RAQKW2K.cjs} +4 -4
- package/dist/{chunk-FDNLFLZ5.js → chunk-6XCKLP3T.js} +4 -4
- package/dist/{chunk-QXKCYTF3.cjs → chunk-RXFXAZK3.cjs} +1 -1
- package/dist/chunk-Z54CI2VS.cjs +14 -0
- 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/dist/integration-toolkit-63NIMAHB.js +7 -0
- package/dist/integration-toolkit-7NCK7Z5G.cjs +7 -0
- package/dist/{integration-toolkit-runtime-VUOXZ6HU.js → integration-toolkit-runtime-2MBB4EOE.js} +1 -1
- package/dist/{integration-toolkit-runtime-PI5G3OXL.cjs → integration-toolkit-runtime-VUI4NCRJ.cjs} +2 -2
- package/dist/{integration-toolkit.d-D5HZSNUf.d.cts → integration-toolkit.d-E2nrIdIM.d.cts} +43 -6
- package/dist/{integration-toolkit.d-D5HZSNUf.d.ts → integration-toolkit.d-E2nrIdIM.d.ts} +43 -6
- package/docs/blueprint-manifest.md +258 -95
- package/docs/integration-toolkit.md +79 -12
- package/package.json +1 -1
- package/dist/blueprint-manifest-GU75577F.js +0 -7
- package/dist/blueprint-manifest-KTUWFTDX.cjs +0 -7
- package/dist/chunk-EZU3MFGV.cjs +0 -14
- package/dist/chunk-FUHSA3BV.js +0 -14
- package/dist/integration-toolkit-XGP4BIWX.js +0 -7
- package/dist/integration-toolkit-ZVBMKUWM.cjs +0 -7
|
@@ -42,10 +42,11 @@ declare namespace Components {
|
|
|
42
42
|
postinstall?: string;
|
|
43
43
|
};
|
|
44
44
|
/**
|
|
45
|
-
* Internal collaboration notes, oldest first.
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* `addBlueprintNote` / `
|
|
45
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
46
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
47
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
48
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
49
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
49
50
|
*
|
|
50
51
|
* Available on every blueprint including marketplace ones (whose
|
|
51
52
|
* `description` is read-only), and never included in the published
|
|
@@ -67,6 +68,38 @@ declare namespace Components {
|
|
|
67
68
|
*/
|
|
68
69
|
job_id?: string;
|
|
69
70
|
triggered_at?: string; // date-time
|
|
71
|
+
/**
|
|
72
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
73
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
74
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
75
|
+
*
|
|
76
|
+
*/
|
|
77
|
+
performed_by?: {
|
|
78
|
+
/**
|
|
79
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
80
|
+
* example:
|
|
81
|
+
* manifest@epilot.cloud
|
|
82
|
+
*/
|
|
83
|
+
name?: any;
|
|
84
|
+
/**
|
|
85
|
+
* epilot organization id
|
|
86
|
+
* example:
|
|
87
|
+
* 911690
|
|
88
|
+
*/
|
|
89
|
+
org_id: string;
|
|
90
|
+
/**
|
|
91
|
+
* epilot user id, when called by a user
|
|
92
|
+
* example:
|
|
93
|
+
* 11001045
|
|
94
|
+
*/
|
|
95
|
+
user_id?: string;
|
|
96
|
+
/**
|
|
97
|
+
* token id, when called by API token
|
|
98
|
+
* example:
|
|
99
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
100
|
+
*/
|
|
101
|
+
token_id?: string;
|
|
102
|
+
};
|
|
70
103
|
/**
|
|
71
104
|
* User-provided note about this synchronization
|
|
72
105
|
*/
|
|
@@ -364,6 +397,10 @@ declare namespace Components {
|
|
|
364
397
|
*/
|
|
365
398
|
text: string;
|
|
366
399
|
created_at: string; // date-time
|
|
400
|
+
/**
|
|
401
|
+
* Set the first time the note text is edited.
|
|
402
|
+
*/
|
|
403
|
+
updated_at?: string; // date-time
|
|
367
404
|
created_by?: CallerIdentity;
|
|
368
405
|
}
|
|
369
406
|
export interface BlueprintPatch {
|
|
@@ -426,6 +463,10 @@ declare namespace Components {
|
|
|
426
463
|
version?: string;
|
|
427
464
|
slug?: string;
|
|
428
465
|
source_type: "marketplace" | "file";
|
|
466
|
+
/**
|
|
467
|
+
* Engine that must install this preview, detected from the uploaded archive's own format (never from a feature flag or request parameter). `v3` is only reported for a correctly shaped and validly signed V3 package. Clients must install a `v3` preview through `POST /v3/blueprint-manifest/blueprint:install` and a `terraform` preview through `POST /v2/blueprint-manifest/blueprints:install`. Absent only on previews created before format detection shipped; treat an absent value as `terraform`.
|
|
468
|
+
*/
|
|
469
|
+
sync_engine?: "terraform" | "v3";
|
|
429
470
|
/**
|
|
430
471
|
* S3 key of the blueprint zip file
|
|
431
472
|
*/
|
|
@@ -949,10 +990,11 @@ declare namespace Components {
|
|
|
949
990
|
postinstall?: string;
|
|
950
991
|
};
|
|
951
992
|
/**
|
|
952
|
-
* Internal collaboration notes, oldest first.
|
|
953
|
-
*
|
|
954
|
-
*
|
|
955
|
-
* `addBlueprintNote` / `
|
|
993
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
994
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
995
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
996
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
997
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
956
998
|
*
|
|
957
999
|
* Available on every blueprint including marketplace ones (whose
|
|
958
1000
|
* `description` is read-only), and never included in the published
|
|
@@ -974,6 +1016,38 @@ declare namespace Components {
|
|
|
974
1016
|
*/
|
|
975
1017
|
job_id?: string;
|
|
976
1018
|
triggered_at?: string; // date-time
|
|
1019
|
+
/**
|
|
1020
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
1021
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
1022
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
1023
|
+
*
|
|
1024
|
+
*/
|
|
1025
|
+
performed_by?: {
|
|
1026
|
+
/**
|
|
1027
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
1028
|
+
* example:
|
|
1029
|
+
* manifest@epilot.cloud
|
|
1030
|
+
*/
|
|
1031
|
+
name?: any;
|
|
1032
|
+
/**
|
|
1033
|
+
* epilot organization id
|
|
1034
|
+
* example:
|
|
1035
|
+
* 911690
|
|
1036
|
+
*/
|
|
1037
|
+
org_id: string;
|
|
1038
|
+
/**
|
|
1039
|
+
* epilot user id, when called by a user
|
|
1040
|
+
* example:
|
|
1041
|
+
* 11001045
|
|
1042
|
+
*/
|
|
1043
|
+
user_id?: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* token id, when called by API token
|
|
1046
|
+
* example:
|
|
1047
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
1048
|
+
*/
|
|
1049
|
+
token_id?: string;
|
|
1050
|
+
};
|
|
977
1051
|
/**
|
|
978
1052
|
* User-provided note about this synchronization
|
|
979
1053
|
*/
|
|
@@ -1335,10 +1409,11 @@ declare namespace Components {
|
|
|
1335
1409
|
postinstall?: string;
|
|
1336
1410
|
};
|
|
1337
1411
|
/**
|
|
1338
|
-
* Internal collaboration notes, oldest first.
|
|
1339
|
-
*
|
|
1340
|
-
*
|
|
1341
|
-
* `addBlueprintNote` / `
|
|
1412
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
1413
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
1414
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
1415
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
1416
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1342
1417
|
*
|
|
1343
1418
|
* Available on every blueprint including marketplace ones (whose
|
|
1344
1419
|
* `description` is read-only), and never included in the published
|
|
@@ -1360,6 +1435,38 @@ declare namespace Components {
|
|
|
1360
1435
|
*/
|
|
1361
1436
|
job_id?: string;
|
|
1362
1437
|
triggered_at?: string; // date-time
|
|
1438
|
+
/**
|
|
1439
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
1440
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
1441
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
1442
|
+
*
|
|
1443
|
+
*/
|
|
1444
|
+
performed_by?: {
|
|
1445
|
+
/**
|
|
1446
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
1447
|
+
* example:
|
|
1448
|
+
* manifest@epilot.cloud
|
|
1449
|
+
*/
|
|
1450
|
+
name?: any;
|
|
1451
|
+
/**
|
|
1452
|
+
* epilot organization id
|
|
1453
|
+
* example:
|
|
1454
|
+
* 911690
|
|
1455
|
+
*/
|
|
1456
|
+
org_id: string;
|
|
1457
|
+
/**
|
|
1458
|
+
* epilot user id, when called by a user
|
|
1459
|
+
* example:
|
|
1460
|
+
* 11001045
|
|
1461
|
+
*/
|
|
1462
|
+
user_id?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* token id, when called by API token
|
|
1465
|
+
* example:
|
|
1466
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
1467
|
+
*/
|
|
1468
|
+
token_id?: string;
|
|
1469
|
+
};
|
|
1363
1470
|
/**
|
|
1364
1471
|
* User-provided note about this synchronization
|
|
1365
1472
|
*/
|
|
@@ -1537,10 +1644,11 @@ declare namespace Components {
|
|
|
1537
1644
|
postinstall?: string;
|
|
1538
1645
|
};
|
|
1539
1646
|
/**
|
|
1540
|
-
* Internal collaboration notes, oldest first.
|
|
1541
|
-
*
|
|
1542
|
-
*
|
|
1543
|
-
* `addBlueprintNote` / `
|
|
1647
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
1648
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
1649
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
1650
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
1651
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1544
1652
|
*
|
|
1545
1653
|
* Available on every blueprint including marketplace ones (whose
|
|
1546
1654
|
* `description` is read-only), and never included in the published
|
|
@@ -1562,6 +1670,38 @@ declare namespace Components {
|
|
|
1562
1670
|
*/
|
|
1563
1671
|
job_id?: string;
|
|
1564
1672
|
triggered_at?: string; // date-time
|
|
1673
|
+
/**
|
|
1674
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
1675
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
1676
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
1677
|
+
*
|
|
1678
|
+
*/
|
|
1679
|
+
performed_by?: {
|
|
1680
|
+
/**
|
|
1681
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
1682
|
+
* example:
|
|
1683
|
+
* manifest@epilot.cloud
|
|
1684
|
+
*/
|
|
1685
|
+
name?: any;
|
|
1686
|
+
/**
|
|
1687
|
+
* epilot organization id
|
|
1688
|
+
* example:
|
|
1689
|
+
* 911690
|
|
1690
|
+
*/
|
|
1691
|
+
org_id: string;
|
|
1692
|
+
/**
|
|
1693
|
+
* epilot user id, when called by a user
|
|
1694
|
+
* example:
|
|
1695
|
+
* 11001045
|
|
1696
|
+
*/
|
|
1697
|
+
user_id?: string;
|
|
1698
|
+
/**
|
|
1699
|
+
* token id, when called by API token
|
|
1700
|
+
* example:
|
|
1701
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
1702
|
+
*/
|
|
1703
|
+
token_id?: string;
|
|
1704
|
+
};
|
|
1565
1705
|
/**
|
|
1566
1706
|
* User-provided note about this synchronization
|
|
1567
1707
|
*/
|
|
@@ -1785,10 +1925,11 @@ declare namespace Components {
|
|
|
1785
1925
|
postinstall?: string;
|
|
1786
1926
|
};
|
|
1787
1927
|
/**
|
|
1788
|
-
* Internal collaboration notes, oldest first.
|
|
1789
|
-
*
|
|
1790
|
-
*
|
|
1791
|
-
* `addBlueprintNote` / `
|
|
1928
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
1929
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
1930
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
1931
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
1932
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
1792
1933
|
*
|
|
1793
1934
|
* Available on every blueprint including marketplace ones (whose
|
|
1794
1935
|
* `description` is read-only), and never included in the published
|
|
@@ -1810,6 +1951,38 @@ declare namespace Components {
|
|
|
1810
1951
|
*/
|
|
1811
1952
|
job_id?: string;
|
|
1812
1953
|
triggered_at?: string; // date-time
|
|
1954
|
+
/**
|
|
1955
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
1956
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
1957
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
1958
|
+
*
|
|
1959
|
+
*/
|
|
1960
|
+
performed_by?: {
|
|
1961
|
+
/**
|
|
1962
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
1963
|
+
* example:
|
|
1964
|
+
* manifest@epilot.cloud
|
|
1965
|
+
*/
|
|
1966
|
+
name?: any;
|
|
1967
|
+
/**
|
|
1968
|
+
* epilot organization id
|
|
1969
|
+
* example:
|
|
1970
|
+
* 911690
|
|
1971
|
+
*/
|
|
1972
|
+
org_id: string;
|
|
1973
|
+
/**
|
|
1974
|
+
* epilot user id, when called by a user
|
|
1975
|
+
* example:
|
|
1976
|
+
* 11001045
|
|
1977
|
+
*/
|
|
1978
|
+
user_id?: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* token id, when called by API token
|
|
1981
|
+
* example:
|
|
1982
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
1983
|
+
*/
|
|
1984
|
+
token_id?: string;
|
|
1985
|
+
};
|
|
1813
1986
|
/**
|
|
1814
1987
|
* User-provided note about this synchronization
|
|
1815
1988
|
*/
|
|
@@ -2671,10 +2844,11 @@ declare namespace Components {
|
|
|
2671
2844
|
postinstall?: string;
|
|
2672
2845
|
};
|
|
2673
2846
|
/**
|
|
2674
|
-
* Internal collaboration notes, oldest first.
|
|
2675
|
-
*
|
|
2676
|
-
*
|
|
2677
|
-
* `addBlueprintNote` / `
|
|
2847
|
+
* Internal collaboration notes, oldest first. Each entry is stamped with
|
|
2848
|
+
* its author and creation time server-side; an edit rewrites only `text`
|
|
2849
|
+
* and stamps `updated_at`, so the history of who noted what stays intact.
|
|
2850
|
+
* Written via `addBlueprintNote` / `updateBlueprintNote` /
|
|
2851
|
+
* `deleteBlueprintNote`, not by `updateBlueprint`.
|
|
2678
2852
|
*
|
|
2679
2853
|
* Available on every blueprint including marketplace ones (whose
|
|
2680
2854
|
* `description` is read-only), and never included in the published
|
|
@@ -2696,6 +2870,38 @@ declare namespace Components {
|
|
|
2696
2870
|
*/
|
|
2697
2871
|
job_id?: string;
|
|
2698
2872
|
triggered_at?: string; // date-time
|
|
2873
|
+
/**
|
|
2874
|
+
* Who actually ran this synchronization — the caller of the install job.
|
|
2875
|
+
* Absent on deployments recorded before this field existed; consumers
|
|
2876
|
+
* should fall back to the blueprint's `updated_by` for those.
|
|
2877
|
+
*
|
|
2878
|
+
*/
|
|
2879
|
+
performed_by?: {
|
|
2880
|
+
/**
|
|
2881
|
+
* a human readable name of the caller (e.g. user name, token name or email address)
|
|
2882
|
+
* example:
|
|
2883
|
+
* manifest@epilot.cloud
|
|
2884
|
+
*/
|
|
2885
|
+
name?: any;
|
|
2886
|
+
/**
|
|
2887
|
+
* epilot organization id
|
|
2888
|
+
* example:
|
|
2889
|
+
* 911690
|
|
2890
|
+
*/
|
|
2891
|
+
org_id: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* epilot user id, when called by a user
|
|
2894
|
+
* example:
|
|
2895
|
+
* 11001045
|
|
2896
|
+
*/
|
|
2897
|
+
user_id?: string;
|
|
2898
|
+
/**
|
|
2899
|
+
* token id, when called by API token
|
|
2900
|
+
* example:
|
|
2901
|
+
* api_5ZugdRXasLfWBypHi93Fk
|
|
2902
|
+
*/
|
|
2903
|
+
token_id?: string;
|
|
2904
|
+
};
|
|
2699
2905
|
/**
|
|
2700
2906
|
* User-provided note about this synchronization
|
|
2701
2907
|
*/
|
|
@@ -3054,7 +3260,7 @@ declare namespace Components {
|
|
|
3054
3260
|
/**
|
|
3055
3261
|
* Type of the resource
|
|
3056
3262
|
*/
|
|
3057
|
-
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission";
|
|
3263
|
+
export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "product_recommendation" | "coupon" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "integration" | "dashboard" | "insight" | "custom_variable" | "usergroup" | "saved_view" | "app" | "role" | "portal_config" | "target" | "kanban" | "validation_rule" | "flow_template" | "taxonomy" | "notification_template" | "environment_variable" | "datasource" | "family" | "permission";
|
|
3058
3264
|
export interface ResourceReplacement {
|
|
3059
3265
|
/**
|
|
3060
3266
|
* Original resource ID to be replaced
|
|
@@ -3212,6 +3418,21 @@ declare namespace Components {
|
|
|
3212
3418
|
*/
|
|
3213
3419
|
pipeline_id?: string;
|
|
3214
3420
|
}
|
|
3421
|
+
/**
|
|
3422
|
+
* A resource that was requested (or discovered as a dependency) but was not
|
|
3423
|
+
* added to the Blueprint. Reasons are stable machine-readable codes.
|
|
3424
|
+
*
|
|
3425
|
+
*/
|
|
3426
|
+
export interface SkippedBlueprintResource {
|
|
3427
|
+
id: /**
|
|
3428
|
+
* ID of a blueprint resource
|
|
3429
|
+
* example:
|
|
3430
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3431
|
+
*/
|
|
3432
|
+
BlueprintResourceID;
|
|
3433
|
+
type: /* Type of the resource */ ResourceNodeType;
|
|
3434
|
+
reason: "not_found" | "source_validation_failed" | "enrichment_failed";
|
|
3435
|
+
}
|
|
3215
3436
|
export interface SuggestBlueprintResourcesRequest {
|
|
3216
3437
|
/**
|
|
3217
3438
|
* Natural-language description of what to include.
|
|
@@ -3363,6 +3584,27 @@ declare namespace Paths {
|
|
|
3363
3584
|
namespace Responses {
|
|
3364
3585
|
export interface $200 {
|
|
3365
3586
|
resources?: Components.Schemas.BlueprintResource[];
|
|
3587
|
+
/**
|
|
3588
|
+
* Resources that were dropped during enrichment instead of being added
|
|
3589
|
+
*/
|
|
3590
|
+
skipped?: /**
|
|
3591
|
+
* A resource that was requested (or discovered as a dependency) but was not
|
|
3592
|
+
* added to the Blueprint. Reasons are stable machine-readable codes.
|
|
3593
|
+
*
|
|
3594
|
+
*/
|
|
3595
|
+
Components.Schemas.SkippedBlueprintResource[];
|
|
3596
|
+
/**
|
|
3597
|
+
* Non-fatal dependency extraction failures encountered while enriching, deduplicated and capped. The listed resources were still added; some of their dependencies may be missing.
|
|
3598
|
+
*/
|
|
3599
|
+
errors?: Components.Schemas.FormattedError[];
|
|
3600
|
+
/**
|
|
3601
|
+
* Total distinct dependency errors, before the cap applied to `errors`
|
|
3602
|
+
*/
|
|
3603
|
+
total_errors?: number;
|
|
3604
|
+
/**
|
|
3605
|
+
* Whether `errors` omits some of the distinct errors counted by `total_errors`
|
|
3606
|
+
*/
|
|
3607
|
+
errors_truncated?: boolean;
|
|
3366
3608
|
}
|
|
3367
3609
|
}
|
|
3368
3610
|
}
|
|
@@ -3450,6 +3692,27 @@ declare namespace Paths {
|
|
|
3450
3692
|
namespace Responses {
|
|
3451
3693
|
export interface $200 {
|
|
3452
3694
|
resources?: Components.Schemas.BlueprintResource[];
|
|
3695
|
+
/**
|
|
3696
|
+
* Resources that were dropped during enrichment instead of being added
|
|
3697
|
+
*/
|
|
3698
|
+
skipped?: /**
|
|
3699
|
+
* A resource that was requested (or discovered as a dependency) but was not
|
|
3700
|
+
* added to the Blueprint. Reasons are stable machine-readable codes.
|
|
3701
|
+
*
|
|
3702
|
+
*/
|
|
3703
|
+
Components.Schemas.SkippedBlueprintResource[];
|
|
3704
|
+
/**
|
|
3705
|
+
* Non-fatal dependency extraction failures encountered while enriching, deduplicated and capped. The listed resources were still added; some of their dependencies may be missing.
|
|
3706
|
+
*/
|
|
3707
|
+
errors?: Components.Schemas.FormattedError[];
|
|
3708
|
+
/**
|
|
3709
|
+
* Total distinct dependency errors, before the cap applied to `errors`
|
|
3710
|
+
*/
|
|
3711
|
+
total_errors?: number;
|
|
3712
|
+
/**
|
|
3713
|
+
* Whether `errors` omits some of the distinct errors counted by `total_errors`
|
|
3714
|
+
*/
|
|
3715
|
+
errors_truncated?: boolean;
|
|
3453
3716
|
}
|
|
3454
3717
|
}
|
|
3455
3718
|
}
|
|
@@ -4612,6 +4875,8 @@ declare namespace Paths {
|
|
|
4612
4875
|
}
|
|
4613
4876
|
namespace Responses {
|
|
4614
4877
|
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
4878
|
+
export interface $400 {
|
|
4879
|
+
}
|
|
4615
4880
|
}
|
|
4616
4881
|
}
|
|
4617
4882
|
namespace PreInstallBlueprintV3 {
|
|
@@ -4678,6 +4943,14 @@ declare namespace Paths {
|
|
|
4678
4943
|
export interface PathParameters {
|
|
4679
4944
|
blueprint_id: Parameters.BlueprintId;
|
|
4680
4945
|
}
|
|
4946
|
+
export interface RequestBody {
|
|
4947
|
+
/**
|
|
4948
|
+
* When true, upload the package with public access and create or overwrite the
|
|
4949
|
+
* blueprint's Webflow CMS listing. Leave unset for a download-only package build.
|
|
4950
|
+
*
|
|
4951
|
+
*/
|
|
4952
|
+
publish_to_marketplace?: boolean;
|
|
4953
|
+
}
|
|
4681
4954
|
namespace Responses {
|
|
4682
4955
|
export interface $202 {
|
|
4683
4956
|
job_id: /**
|
|
@@ -4913,6 +5186,36 @@ declare namespace Paths {
|
|
|
4913
5186
|
export type $200 = Components.Schemas.Blueprint;
|
|
4914
5187
|
}
|
|
4915
5188
|
}
|
|
5189
|
+
namespace UpdateBlueprintNote {
|
|
5190
|
+
namespace Parameters {
|
|
5191
|
+
export type BlueprintId = /**
|
|
5192
|
+
* ID of a blueprint
|
|
5193
|
+
* example:
|
|
5194
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
5195
|
+
*/
|
|
5196
|
+
Components.Schemas.BlueprintID;
|
|
5197
|
+
export type NoteId = string;
|
|
5198
|
+
}
|
|
5199
|
+
export interface PathParameters {
|
|
5200
|
+
blueprint_id: Parameters.BlueprintId;
|
|
5201
|
+
note_id: Parameters.NoteId;
|
|
5202
|
+
}
|
|
5203
|
+
export interface RequestBody {
|
|
5204
|
+
/**
|
|
5205
|
+
* Plain-text note body. Must not be blank.
|
|
5206
|
+
*/
|
|
5207
|
+
text: string;
|
|
5208
|
+
}
|
|
5209
|
+
namespace Responses {
|
|
5210
|
+
export type $200 = /* A single internal note on a blueprint. */ Components.Schemas.BlueprintNote;
|
|
5211
|
+
export interface $400 {
|
|
5212
|
+
message?: string;
|
|
5213
|
+
}
|
|
5214
|
+
export interface $404 {
|
|
5215
|
+
message?: string;
|
|
5216
|
+
}
|
|
5217
|
+
}
|
|
5218
|
+
}
|
|
4916
5219
|
namespace UpdateBlueprintResource {
|
|
4917
5220
|
namespace Parameters {
|
|
4918
5221
|
export type BlueprintId = /**
|
|
@@ -5253,7 +5556,7 @@ interface OperationMethods {
|
|
|
5253
5556
|
/**
|
|
5254
5557
|
* preInstallBlueprint - preInstallBlueprint
|
|
5255
5558
|
*
|
|
5256
|
-
* Pre-install a Blueprint based on a blueprint file
|
|
5559
|
+
* Pre-install a Blueprint based on a blueprint file. Format-agnostic: the engine is detected from the uploaded archive, so this endpoint accepts both Terraform exports and signed V3 packages. The returned preview's `sync_engine` says which install endpoint to call next. An archive that is neither a Terraform export nor a validly signed V3 package is rejected with 400.
|
|
5257
5560
|
*/
|
|
5258
5561
|
'preInstallBlueprint'(
|
|
5259
5562
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -5324,6 +5627,19 @@ interface OperationMethods {
|
|
|
5324
5627
|
data?: Paths.AddBlueprintNote.RequestBody,
|
|
5325
5628
|
config?: AxiosRequestConfig
|
|
5326
5629
|
): OperationResponse<Paths.AddBlueprintNote.Responses.$201>
|
|
5630
|
+
/**
|
|
5631
|
+
* updateBlueprintNote - updateBlueprintNote
|
|
5632
|
+
*
|
|
5633
|
+
* Rewrite the text of an existing internal note. The note keeps its position in
|
|
5634
|
+
* the list along with `created_at` and `created_by`, so an edit cannot reassign
|
|
5635
|
+
* authorship; `updated_at` is stamped server-side.
|
|
5636
|
+
*
|
|
5637
|
+
*/
|
|
5638
|
+
'updateBlueprintNote'(
|
|
5639
|
+
parameters?: Parameters<Paths.UpdateBlueprintNote.PathParameters> | null,
|
|
5640
|
+
data?: Paths.UpdateBlueprintNote.RequestBody,
|
|
5641
|
+
config?: AxiosRequestConfig
|
|
5642
|
+
): OperationResponse<Paths.UpdateBlueprintNote.Responses.$200>
|
|
5327
5643
|
/**
|
|
5328
5644
|
* deleteBlueprintNote - deleteBlueprintNote
|
|
5329
5645
|
*
|
|
@@ -5559,7 +5875,7 @@ interface OperationMethods {
|
|
|
5559
5875
|
config?: AxiosRequestConfig
|
|
5560
5876
|
): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
|
|
5561
5877
|
/**
|
|
5562
|
-
* listBlueprintJobs -
|
|
5878
|
+
* listBlueprintJobs - listBlueprintJobs
|
|
5563
5879
|
*
|
|
5564
5880
|
* List all blueprint jobs
|
|
5565
5881
|
*/
|
|
@@ -5569,7 +5885,7 @@ interface OperationMethods {
|
|
|
5569
5885
|
config?: AxiosRequestConfig
|
|
5570
5886
|
): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
|
|
5571
5887
|
/**
|
|
5572
|
-
* getBlueprintJob -
|
|
5888
|
+
* getBlueprintJob - getBlueprintJob
|
|
5573
5889
|
*
|
|
5574
5890
|
* Poll the current state of a job. Serves both Terraform (v2) and V3-engine jobs —
|
|
5575
5891
|
* check `sync_engine` (`terraform` | `v3`) to tell them apart. V3 jobs additionally
|
|
@@ -5583,7 +5899,7 @@ interface OperationMethods {
|
|
|
5583
5899
|
config?: AxiosRequestConfig
|
|
5584
5900
|
): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
|
|
5585
5901
|
/**
|
|
5586
|
-
* continueInstallationJob -
|
|
5902
|
+
* continueInstallationJob - continueInstallationJob
|
|
5587
5903
|
*
|
|
5588
5904
|
* Resume an installation job that is paused at `status: "WAITING_USER_ACTION"` after
|
|
5589
5905
|
* planning. Works for both Terraform and V3 jobs. Not needed for V3 installs created
|
|
@@ -5597,7 +5913,7 @@ interface OperationMethods {
|
|
|
5597
5913
|
config?: AxiosRequestConfig
|
|
5598
5914
|
): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
|
|
5599
5915
|
/**
|
|
5600
|
-
* cancelBlueprintJob -
|
|
5916
|
+
* cancelBlueprintJob - cancelBlueprintJob
|
|
5601
5917
|
*
|
|
5602
5918
|
* Cancel a blueprint job if it is still running.
|
|
5603
5919
|
*/
|
|
@@ -5707,17 +6023,21 @@ interface OperationMethods {
|
|
|
5707
6023
|
config?: AxiosRequestConfig
|
|
5708
6024
|
): OperationResponse<Paths.PublishMarketplaceListingVersion.Responses.$200>
|
|
5709
6025
|
/**
|
|
5710
|
-
* publishBlueprintV3 -
|
|
6026
|
+
* publishBlueprintV3 - publishBlueprintV3
|
|
5711
6027
|
*
|
|
5712
6028
|
* Starts an asynchronous V3 publication. The result is a signed, portable package; poll the existing blueprint job endpoint for completion.
|
|
6029
|
+
*
|
|
6030
|
+
* By default this only builds the package and stores it privately for download. Creating or
|
|
6031
|
+
* overwriting the public marketplace listing is opt-in via `publish_to_marketplace`.
|
|
6032
|
+
*
|
|
5713
6033
|
*/
|
|
5714
6034
|
'publishBlueprintV3'(
|
|
5715
6035
|
parameters?: Parameters<Paths.PublishBlueprintV3.PathParameters> | null,
|
|
5716
|
-
data?:
|
|
6036
|
+
data?: Paths.PublishBlueprintV3.RequestBody,
|
|
5717
6037
|
config?: AxiosRequestConfig
|
|
5718
6038
|
): OperationResponse<Paths.PublishBlueprintV3.Responses.$202>
|
|
5719
6039
|
/**
|
|
5720
|
-
* preInstallBlueprintV3 -
|
|
6040
|
+
* preInstallBlueprintV3 - preInstallBlueprintV3
|
|
5721
6041
|
*
|
|
5722
6042
|
* Validates a signed V3 package and returns the destination-specific resource plan used by the install UI.
|
|
5723
6043
|
*/
|
|
@@ -5727,7 +6047,7 @@ interface OperationMethods {
|
|
|
5727
6047
|
config?: AxiosRequestConfig
|
|
5728
6048
|
): OperationResponse<Paths.PreInstallBlueprintV3.Responses.$200>
|
|
5729
6049
|
/**
|
|
5730
|
-
* installBlueprintV3 -
|
|
6050
|
+
* installBlueprintV3 - installBlueprintV3
|
|
5731
6051
|
*
|
|
5732
6052
|
* Install a blueprint into a single destination org using the V3 engine (direct API
|
|
5733
6053
|
* calls, no Terraform). Creates resources in topological order with global ID
|
|
@@ -5755,7 +6075,7 @@ interface OperationMethods {
|
|
|
5755
6075
|
config?: AxiosRequestConfig
|
|
5756
6076
|
): OperationResponse<Paths.InstallBlueprintV3.Responses.$202>
|
|
5757
6077
|
/**
|
|
5758
|
-
* restoreBlueprintDeploymentV3 -
|
|
6078
|
+
* restoreBlueprintDeploymentV3 - restoreBlueprintDeploymentV3
|
|
5759
6079
|
*
|
|
5760
6080
|
* Roll a deployment back to its pre-install state. Two phases:
|
|
5761
6081
|
*
|
|
@@ -5785,7 +6105,7 @@ interface OperationMethods {
|
|
|
5785
6105
|
config?: AxiosRequestConfig
|
|
5786
6106
|
): OperationResponse<Paths.RestoreBlueprintDeploymentV3.Responses.$202>
|
|
5787
6107
|
/**
|
|
5788
|
-
* getRestorePreview -
|
|
6108
|
+
* getRestorePreview - getRestorePreview
|
|
5789
6109
|
*
|
|
5790
6110
|
* Computes what would happen if the user triggered a restore on this
|
|
5791
6111
|
* deployment, without performing any writes. The forecast uses the
|
|
@@ -5804,7 +6124,7 @@ interface OperationMethods {
|
|
|
5804
6124
|
config?: AxiosRequestConfig
|
|
5805
6125
|
): OperationResponse<Paths.GetRestorePreview.Responses.$200>
|
|
5806
6126
|
/**
|
|
5807
|
-
* triggerDeploymentHealthCheckV3 -
|
|
6127
|
+
* triggerDeploymentHealthCheckV3 - triggerDeploymentHealthCheckV3
|
|
5808
6128
|
*
|
|
5809
6129
|
* Starts a read-only health scan of the resources this deployment's
|
|
5810
6130
|
* blueprint instance tracks in the destination org (see
|
|
@@ -5829,7 +6149,7 @@ interface OperationMethods {
|
|
|
5829
6149
|
config?: AxiosRequestConfig
|
|
5830
6150
|
): OperationResponse<Paths.TriggerDeploymentHealthCheckV3.Responses.$202>
|
|
5831
6151
|
/**
|
|
5832
|
-
* getDeploymentHealthReportV3 -
|
|
6152
|
+
* getDeploymentHealthReportV3 - getDeploymentHealthReportV3
|
|
5833
6153
|
*
|
|
5834
6154
|
* Returns the most recent health report produced for this deployment
|
|
5835
6155
|
* by the `:health-check` endpoint. Idempotent and side-effect free.
|
|
@@ -5841,7 +6161,7 @@ interface OperationMethods {
|
|
|
5841
6161
|
config?: AxiosRequestConfig
|
|
5842
6162
|
): OperationResponse<Paths.GetDeploymentHealthReportV3.Responses.$200>
|
|
5843
6163
|
/**
|
|
5844
|
-
* getBlueprintLineageV3 -
|
|
6164
|
+
* getBlueprintLineageV3 - getBlueprintLineageV3
|
|
5845
6165
|
*
|
|
5846
6166
|
* Returns the lineage registry entries for a blueprint's resources in the current org.
|
|
5847
6167
|
* Shows the mapping between source lineage IDs and target resource IDs.
|
|
@@ -5853,7 +6173,7 @@ interface OperationMethods {
|
|
|
5853
6173
|
config?: AxiosRequestConfig
|
|
5854
6174
|
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
5855
6175
|
/**
|
|
5856
|
-
* createBulkInstallV3 -
|
|
6176
|
+
* createBulkInstallV3 - createBulkInstallV3
|
|
5857
6177
|
*
|
|
5858
6178
|
* Install one source blueprint into many destination organizations in a single
|
|
5859
6179
|
* request. The server schedules child V3 installs with `auto_apply=true` and caps
|
|
@@ -5871,7 +6191,7 @@ interface OperationMethods {
|
|
|
5871
6191
|
config?: AxiosRequestConfig
|
|
5872
6192
|
): OperationResponse<Paths.CreateBulkInstallV3.Responses.$202>
|
|
5873
6193
|
/**
|
|
5874
|
-
* getBulkInstallV3 -
|
|
6194
|
+
* getBulkInstallV3 - getBulkInstallV3
|
|
5875
6195
|
*
|
|
5876
6196
|
* Returns the bulk install parent with aggregate status and counts. Scoped by the
|
|
5877
6197
|
* caller org as `source_org_id`. Target rows are not included — use the targets
|
|
@@ -5884,7 +6204,7 @@ interface OperationMethods {
|
|
|
5884
6204
|
config?: AxiosRequestConfig
|
|
5885
6205
|
): OperationResponse<Paths.GetBulkInstallV3.Responses.$200>
|
|
5886
6206
|
/**
|
|
5887
|
-
* listBulkInstallTargetsV3 -
|
|
6207
|
+
* listBulkInstallTargetsV3 - listBulkInstallTargetsV3
|
|
5888
6208
|
*
|
|
5889
6209
|
* Pages through the bulk install's target rows. Each row hydrates its latest child
|
|
5890
6210
|
* install job (`job_ids.at(-1)`) with the standard V3 job shape (`events[]`,
|
|
@@ -5897,7 +6217,7 @@ interface OperationMethods {
|
|
|
5897
6217
|
config?: AxiosRequestConfig
|
|
5898
6218
|
): OperationResponse<Paths.ListBulkInstallTargetsV3.Responses.$200>
|
|
5899
6219
|
/**
|
|
5900
|
-
* retryBulkInstallTargetV3 -
|
|
6220
|
+
* retryBulkInstallTargetV3 - retryBulkInstallTargetV3
|
|
5901
6221
|
*
|
|
5902
6222
|
* Retries a single failed target. Allowed only for `FAILED` and `PARTIAL_SUCCESS`
|
|
5903
6223
|
* targets. Starts a new child install with `auto_apply=true`, appends its job id to
|
|
@@ -6127,7 +6447,7 @@ interface PathsDictionary {
|
|
|
6127
6447
|
/**
|
|
6128
6448
|
* preInstallBlueprint - preInstallBlueprint
|
|
6129
6449
|
*
|
|
6130
|
-
* Pre-install a Blueprint based on a blueprint file
|
|
6450
|
+
* Pre-install a Blueprint based on a blueprint file. Format-agnostic: the engine is detected from the uploaded archive, so this endpoint accepts both Terraform exports and signed V3 packages. The returned preview's `sync_engine` says which install endpoint to call next. An archive that is neither a Terraform export nor a validly signed V3 package is rejected with 400.
|
|
6131
6451
|
*/
|
|
6132
6452
|
'post'(
|
|
6133
6453
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -6208,6 +6528,19 @@ interface PathsDictionary {
|
|
|
6208
6528
|
): OperationResponse<Paths.AddBlueprintNote.Responses.$201>
|
|
6209
6529
|
}
|
|
6210
6530
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id}']: {
|
|
6531
|
+
/**
|
|
6532
|
+
* updateBlueprintNote - updateBlueprintNote
|
|
6533
|
+
*
|
|
6534
|
+
* Rewrite the text of an existing internal note. The note keeps its position in
|
|
6535
|
+
* the list along with `created_at` and `created_by`, so an edit cannot reassign
|
|
6536
|
+
* authorship; `updated_at` is stamped server-side.
|
|
6537
|
+
*
|
|
6538
|
+
*/
|
|
6539
|
+
'patch'(
|
|
6540
|
+
parameters?: Parameters<Paths.UpdateBlueprintNote.PathParameters> | null,
|
|
6541
|
+
data?: Paths.UpdateBlueprintNote.RequestBody,
|
|
6542
|
+
config?: AxiosRequestConfig
|
|
6543
|
+
): OperationResponse<Paths.UpdateBlueprintNote.Responses.$200>
|
|
6211
6544
|
/**
|
|
6212
6545
|
* deleteBlueprintNote - deleteBlueprintNote
|
|
6213
6546
|
*
|
|
@@ -6477,7 +6810,7 @@ interface PathsDictionary {
|
|
|
6477
6810
|
}
|
|
6478
6811
|
['/v2/blueprint-manifest/jobs']: {
|
|
6479
6812
|
/**
|
|
6480
|
-
* listBlueprintJobs -
|
|
6813
|
+
* listBlueprintJobs - listBlueprintJobs
|
|
6481
6814
|
*
|
|
6482
6815
|
* List all blueprint jobs
|
|
6483
6816
|
*/
|
|
@@ -6489,7 +6822,7 @@ interface PathsDictionary {
|
|
|
6489
6822
|
}
|
|
6490
6823
|
['/v2/blueprint-manifest/jobs/{job_id}']: {
|
|
6491
6824
|
/**
|
|
6492
|
-
* getBlueprintJob -
|
|
6825
|
+
* getBlueprintJob - getBlueprintJob
|
|
6493
6826
|
*
|
|
6494
6827
|
* Poll the current state of a job. Serves both Terraform (v2) and V3-engine jobs —
|
|
6495
6828
|
* check `sync_engine` (`terraform` | `v3`) to tell them apart. V3 jobs additionally
|
|
@@ -6505,7 +6838,7 @@ interface PathsDictionary {
|
|
|
6505
6838
|
}
|
|
6506
6839
|
['/v2/blueprint-manifest/jobs/{job_id}:continue']: {
|
|
6507
6840
|
/**
|
|
6508
|
-
* continueInstallationJob -
|
|
6841
|
+
* continueInstallationJob - continueInstallationJob
|
|
6509
6842
|
*
|
|
6510
6843
|
* Resume an installation job that is paused at `status: "WAITING_USER_ACTION"` after
|
|
6511
6844
|
* planning. Works for both Terraform and V3 jobs. Not needed for V3 installs created
|
|
@@ -6521,7 +6854,7 @@ interface PathsDictionary {
|
|
|
6521
6854
|
}
|
|
6522
6855
|
['/v2/blueprint-manifest/jobs/{job_id}:cancel']: {
|
|
6523
6856
|
/**
|
|
6524
|
-
* cancelBlueprintJob -
|
|
6857
|
+
* cancelBlueprintJob - cancelBlueprintJob
|
|
6525
6858
|
*
|
|
6526
6859
|
* Cancel a blueprint job if it is still running.
|
|
6527
6860
|
*/
|
|
@@ -6645,19 +6978,23 @@ interface PathsDictionary {
|
|
|
6645
6978
|
}
|
|
6646
6979
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}:publish']: {
|
|
6647
6980
|
/**
|
|
6648
|
-
* publishBlueprintV3 -
|
|
6981
|
+
* publishBlueprintV3 - publishBlueprintV3
|
|
6649
6982
|
*
|
|
6650
6983
|
* Starts an asynchronous V3 publication. The result is a signed, portable package; poll the existing blueprint job endpoint for completion.
|
|
6984
|
+
*
|
|
6985
|
+
* By default this only builds the package and stores it privately for download. Creating or
|
|
6986
|
+
* overwriting the public marketplace listing is opt-in via `publish_to_marketplace`.
|
|
6987
|
+
*
|
|
6651
6988
|
*/
|
|
6652
6989
|
'post'(
|
|
6653
6990
|
parameters?: Parameters<Paths.PublishBlueprintV3.PathParameters> | null,
|
|
6654
|
-
data?:
|
|
6991
|
+
data?: Paths.PublishBlueprintV3.RequestBody,
|
|
6655
6992
|
config?: AxiosRequestConfig
|
|
6656
6993
|
): OperationResponse<Paths.PublishBlueprintV3.Responses.$202>
|
|
6657
6994
|
}
|
|
6658
6995
|
['/v3/blueprint-manifest/blueprints:pre-install']: {
|
|
6659
6996
|
/**
|
|
6660
|
-
* preInstallBlueprintV3 -
|
|
6997
|
+
* preInstallBlueprintV3 - preInstallBlueprintV3
|
|
6661
6998
|
*
|
|
6662
6999
|
* Validates a signed V3 package and returns the destination-specific resource plan used by the install UI.
|
|
6663
7000
|
*/
|
|
@@ -6669,7 +7006,7 @@ interface PathsDictionary {
|
|
|
6669
7006
|
}
|
|
6670
7007
|
['/v3/blueprint-manifest/blueprint:install']: {
|
|
6671
7008
|
/**
|
|
6672
|
-
* installBlueprintV3 -
|
|
7009
|
+
* installBlueprintV3 - installBlueprintV3
|
|
6673
7010
|
*
|
|
6674
7011
|
* Install a blueprint into a single destination org using the V3 engine (direct API
|
|
6675
7012
|
* calls, no Terraform). Creates resources in topological order with global ID
|
|
@@ -6699,7 +7036,7 @@ interface PathsDictionary {
|
|
|
6699
7036
|
}
|
|
6700
7037
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore']: {
|
|
6701
7038
|
/**
|
|
6702
|
-
* restoreBlueprintDeploymentV3 -
|
|
7039
|
+
* restoreBlueprintDeploymentV3 - restoreBlueprintDeploymentV3
|
|
6703
7040
|
*
|
|
6704
7041
|
* Roll a deployment back to its pre-install state. Two phases:
|
|
6705
7042
|
*
|
|
@@ -6731,7 +7068,7 @@ interface PathsDictionary {
|
|
|
6731
7068
|
}
|
|
6732
7069
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview']: {
|
|
6733
7070
|
/**
|
|
6734
|
-
* getRestorePreview -
|
|
7071
|
+
* getRestorePreview - getRestorePreview
|
|
6735
7072
|
*
|
|
6736
7073
|
* Computes what would happen if the user triggered a restore on this
|
|
6737
7074
|
* deployment, without performing any writes. The forecast uses the
|
|
@@ -6752,7 +7089,7 @@ interface PathsDictionary {
|
|
|
6752
7089
|
}
|
|
6753
7090
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:health-check']: {
|
|
6754
7091
|
/**
|
|
6755
|
-
* triggerDeploymentHealthCheckV3 -
|
|
7092
|
+
* triggerDeploymentHealthCheckV3 - triggerDeploymentHealthCheckV3
|
|
6756
7093
|
*
|
|
6757
7094
|
* Starts a read-only health scan of the resources this deployment's
|
|
6758
7095
|
* blueprint instance tracks in the destination org (see
|
|
@@ -6779,7 +7116,7 @@ interface PathsDictionary {
|
|
|
6779
7116
|
}
|
|
6780
7117
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/health-report']: {
|
|
6781
7118
|
/**
|
|
6782
|
-
* getDeploymentHealthReportV3 -
|
|
7119
|
+
* getDeploymentHealthReportV3 - getDeploymentHealthReportV3
|
|
6783
7120
|
*
|
|
6784
7121
|
* Returns the most recent health report produced for this deployment
|
|
6785
7122
|
* by the `:health-check` endpoint. Idempotent and side-effect free.
|
|
@@ -6793,7 +7130,7 @@ interface PathsDictionary {
|
|
|
6793
7130
|
}
|
|
6794
7131
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/lineage']: {
|
|
6795
7132
|
/**
|
|
6796
|
-
* getBlueprintLineageV3 -
|
|
7133
|
+
* getBlueprintLineageV3 - getBlueprintLineageV3
|
|
6797
7134
|
*
|
|
6798
7135
|
* Returns the lineage registry entries for a blueprint's resources in the current org.
|
|
6799
7136
|
* Shows the mapping between source lineage IDs and target resource IDs.
|
|
@@ -6807,7 +7144,7 @@ interface PathsDictionary {
|
|
|
6807
7144
|
}
|
|
6808
7145
|
['/v3/blueprint-manifest/bulk-installs']: {
|
|
6809
7146
|
/**
|
|
6810
|
-
* createBulkInstallV3 -
|
|
7147
|
+
* createBulkInstallV3 - createBulkInstallV3
|
|
6811
7148
|
*
|
|
6812
7149
|
* Install one source blueprint into many destination organizations in a single
|
|
6813
7150
|
* request. The server schedules child V3 installs with `auto_apply=true` and caps
|
|
@@ -6827,7 +7164,7 @@ interface PathsDictionary {
|
|
|
6827
7164
|
}
|
|
6828
7165
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}']: {
|
|
6829
7166
|
/**
|
|
6830
|
-
* getBulkInstallV3 -
|
|
7167
|
+
* getBulkInstallV3 - getBulkInstallV3
|
|
6831
7168
|
*
|
|
6832
7169
|
* Returns the bulk install parent with aggregate status and counts. Scoped by the
|
|
6833
7170
|
* caller org as `source_org_id`. Target rows are not included — use the targets
|
|
@@ -6842,7 +7179,7 @@ interface PathsDictionary {
|
|
|
6842
7179
|
}
|
|
6843
7180
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets']: {
|
|
6844
7181
|
/**
|
|
6845
|
-
* listBulkInstallTargetsV3 -
|
|
7182
|
+
* listBulkInstallTargetsV3 - listBulkInstallTargetsV3
|
|
6846
7183
|
*
|
|
6847
7184
|
* Pages through the bulk install's target rows. Each row hydrates its latest child
|
|
6848
7185
|
* install job (`job_ids.at(-1)`) with the standard V3 job shape (`events[]`,
|
|
@@ -6857,7 +7194,7 @@ interface PathsDictionary {
|
|
|
6857
7194
|
}
|
|
6858
7195
|
['/v3/blueprint-manifest/bulk-installs/{bulk_job_id}/targets/{destination_org_id}:retry']: {
|
|
6859
7196
|
/**
|
|
6860
|
-
* retryBulkInstallTargetV3 -
|
|
7197
|
+
* retryBulkInstallTargetV3 - retryBulkInstallTargetV3
|
|
6861
7198
|
*
|
|
6862
7199
|
* Retries a single failed target. Allowed only for `FAILED` and `PARTIAL_SUCCESS`
|
|
6863
7200
|
* targets. Starts a new child install with `auto_apply=true`, appends its job id to
|
|
@@ -7004,6 +7341,7 @@ type RestoreOutcomeItem = Components.Schemas.RestoreOutcomeItem;
|
|
|
7004
7341
|
type RootResourceNode = Components.Schemas.RootResourceNode;
|
|
7005
7342
|
type S3Reference = Components.Schemas.S3Reference;
|
|
7006
7343
|
type SelectedResources = Components.Schemas.SelectedResources;
|
|
7344
|
+
type SkippedBlueprintResource = Components.Schemas.SkippedBlueprintResource;
|
|
7007
7345
|
type SuggestBlueprintResourcesRequest = Components.Schemas.SuggestBlueprintResourcesRequest;
|
|
7008
7346
|
type SuggestBlueprintResourcesResponse = Components.Schemas.SuggestBlueprintResourcesResponse;
|
|
7009
7347
|
type UniquenessCriteria = Components.Schemas.UniquenessCriteria;
|
|
@@ -7013,4 +7351,4 @@ type V3ResourceProgressEntry = Components.Schemas.V3ResourceProgressEntry;
|
|
|
7013
7351
|
type VerificationSummary = Components.Schemas.VerificationSummary;
|
|
7014
7352
|
type VirtualResourceNodeGroup = Components.Schemas.VirtualResourceNodeGroup;
|
|
7015
7353
|
|
|
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
|
|
7354
|
+
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 VirtualResourceNodeGroup as aA, 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 SkippedBlueprintResource as as, type SuggestBlueprintResourcesRequest as at, type SuggestBlueprintResourcesResponse as au, type UniquenessCriteria as av, type UniquenessCriteriaResourceType as aw, type UploadFilePayload as ax, type V3ResourceProgressEntry as ay, type VerificationSummary 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 };
|