@epilot/sdk 2.15.7 → 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/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 +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-4QHWT67K.js → chunk-H5DNNZU5.js} +2 -2
- package/dist/{chunk-Q7WEQVWP.cjs → chunk-USC6N3WG.cjs} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/docs/blueprint-manifest.md +571 -27
- 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
|
@@ -36,6 +36,8 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
36
36
|
- [`getBlueprint`](#getblueprint)
|
|
37
37
|
- [`updateBlueprint`](#updateblueprint)
|
|
38
38
|
- [`deleteBlueprint`](#deleteblueprint)
|
|
39
|
+
- [`addBlueprintNote`](#addblueprintnote)
|
|
40
|
+
- [`deleteBlueprintNote`](#deleteblueprintnote)
|
|
39
41
|
- [`verifyBlueprint`](#verifyblueprint)
|
|
40
42
|
- [`listMarketplaceSlugs`](#listmarketplaceslugs)
|
|
41
43
|
- [`publishBlueprint`](#publishblueprint)
|
|
@@ -49,9 +51,12 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
49
51
|
- [`updateBlueprintResource`](#updateblueprintresource)
|
|
50
52
|
- [`deleteBlueprintResource`](#deleteblueprintresource)
|
|
51
53
|
- [`publishBlueprintV3`](#publishblueprintv3)
|
|
54
|
+
- [`preInstallBlueprintV3`](#preinstallblueprintv3)
|
|
52
55
|
- [`installBlueprintV3`](#installblueprintv3)
|
|
53
56
|
- [`restoreBlueprintDeploymentV3`](#restoreblueprintdeploymentv3)
|
|
54
57
|
- [`getRestorePreview`](#getrestorepreview)
|
|
58
|
+
- [`triggerDeploymentHealthCheckV3`](#triggerdeploymenthealthcheckv3)
|
|
59
|
+
- [`getDeploymentHealthReportV3`](#getdeploymenthealthreportv3)
|
|
55
60
|
- [`getBlueprintLineageV3`](#getblueprintlineagev3)
|
|
56
61
|
- [`createBulkInstallV3`](#createbulkinstallv3)
|
|
57
62
|
- [`getBulkInstallV3`](#getbulkinstallv3)
|
|
@@ -94,6 +99,7 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
94
99
|
- [`BlueprintPatch`](#blueprintpatch)
|
|
95
100
|
- [`OrgPatchExecution`](#orgpatchexecution)
|
|
96
101
|
- [`BlueprintPatchWithResults`](#blueprintpatchwithresults)
|
|
102
|
+
- [`BlueprintNote`](#blueprintnote)
|
|
97
103
|
- [`BlueprintID`](#blueprintid)
|
|
98
104
|
- [`BlueprintResourceID`](#blueprintresourceid)
|
|
99
105
|
- [`CommonBlueprintFields`](#commonblueprintfields)
|
|
@@ -122,6 +128,11 @@ const { data } = await blueprintManifestClient.getJob(...)
|
|
|
122
128
|
- [`BlueprintRestoreJob`](#blueprintrestorejob)
|
|
123
129
|
- [`V3ResourceProgressEntry`](#v3resourceprogressentry)
|
|
124
130
|
- [`RestoreOutcomeItem`](#restoreoutcomeitem)
|
|
131
|
+
- [`HealthFinding`](#healthfinding)
|
|
132
|
+
- [`HealthCheckCoverage`](#healthcheckcoverage)
|
|
133
|
+
- [`HealthResourceTypeCoverage`](#healthresourcetypecoverage)
|
|
134
|
+
- [`HealthScanCoverage`](#healthscancoverage)
|
|
135
|
+
- [`DeploymentHealthReport`](#deploymenthealthreport)
|
|
125
136
|
- [`RestoreOutcome`](#restoreoutcome)
|
|
126
137
|
- [`BlueprintJob`](#blueprintjob)
|
|
127
138
|
- [`BlueprintDependenciesSyncJob`](#blueprintdependenciessyncjob)
|
|
@@ -221,6 +232,7 @@ const { data } = await client.listBlueprints({
|
|
|
221
232
|
"title": "string",
|
|
222
233
|
"slug": "string",
|
|
223
234
|
"description": {},
|
|
235
|
+
"notes": [],
|
|
224
236
|
"version": "string",
|
|
225
237
|
"deployments": [],
|
|
226
238
|
"is_verified": true,
|
|
@@ -268,6 +280,14 @@ const { data } = await client.createBlueprint(
|
|
|
268
280
|
postinstall: 'This is the content of the postinstall.md file
|
|
269
281
|
'
|
|
270
282
|
},
|
|
283
|
+
notes: [
|
|
284
|
+
{
|
|
285
|
+
id: '3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40',
|
|
286
|
+
text: 'Adjusted the meter-reading journey for the §14a rollout.',
|
|
287
|
+
created_at: '1970-01-01T00:00:00.000Z',
|
|
288
|
+
created_by: { /* ... */ }
|
|
289
|
+
}
|
|
290
|
+
],
|
|
271
291
|
version: 'string',
|
|
272
292
|
deployments: [
|
|
273
293
|
{
|
|
@@ -364,6 +384,14 @@ const { data } = await client.createBlueprint(
|
|
|
364
384
|
"preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
|
|
365
385
|
"postinstall": "This is the content of the postinstall.md file\n"
|
|
366
386
|
},
|
|
387
|
+
"notes": [
|
|
388
|
+
{
|
|
389
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
390
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
391
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
392
|
+
"created_by": {}
|
|
393
|
+
}
|
|
394
|
+
],
|
|
367
395
|
"version": "string",
|
|
368
396
|
"deployments": [
|
|
369
397
|
{
|
|
@@ -660,6 +688,14 @@ const { data } = await client.getBlueprint({
|
|
|
660
688
|
"preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
|
|
661
689
|
"postinstall": "This is the content of the postinstall.md file\n"
|
|
662
690
|
},
|
|
691
|
+
"notes": [
|
|
692
|
+
{
|
|
693
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
694
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
695
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
696
|
+
"created_by": {}
|
|
697
|
+
}
|
|
698
|
+
],
|
|
663
699
|
"version": "string",
|
|
664
700
|
"deployments": [
|
|
665
701
|
{
|
|
@@ -768,6 +804,14 @@ const { data } = await client.updateBlueprint(
|
|
|
768
804
|
postinstall: 'This is the content of the postinstall.md file
|
|
769
805
|
'
|
|
770
806
|
},
|
|
807
|
+
notes: [
|
|
808
|
+
{
|
|
809
|
+
id: '3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40',
|
|
810
|
+
text: 'Adjusted the meter-reading journey for the §14a rollout.',
|
|
811
|
+
created_at: '1970-01-01T00:00:00.000Z',
|
|
812
|
+
created_by: { /* ... */ }
|
|
813
|
+
}
|
|
814
|
+
],
|
|
771
815
|
version: 'string',
|
|
772
816
|
deployments: [
|
|
773
817
|
{
|
|
@@ -864,6 +908,14 @@ const { data } = await client.updateBlueprint(
|
|
|
864
908
|
"preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
|
|
865
909
|
"postinstall": "This is the content of the postinstall.md file\n"
|
|
866
910
|
},
|
|
911
|
+
"notes": [
|
|
912
|
+
{
|
|
913
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
914
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
915
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
916
|
+
"created_by": {}
|
|
917
|
+
}
|
|
918
|
+
],
|
|
867
919
|
"version": "string",
|
|
868
920
|
"deployments": [
|
|
869
921
|
{
|
|
@@ -975,6 +1027,14 @@ const { data } = await client.deleteBlueprint({
|
|
|
975
1027
|
"preinstall": "This is the content of the preinstall.md file which contains the blueprint description.\n",
|
|
976
1028
|
"postinstall": "This is the content of the postinstall.md file\n"
|
|
977
1029
|
},
|
|
1030
|
+
"notes": [
|
|
1031
|
+
{
|
|
1032
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
1033
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
1034
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1035
|
+
"created_by": {}
|
|
1036
|
+
}
|
|
1037
|
+
],
|
|
978
1038
|
"version": "string",
|
|
979
1039
|
"deployments": [
|
|
980
1040
|
{
|
|
@@ -1062,6 +1122,84 @@ const { data } = await client.deleteBlueprint({
|
|
|
1062
1122
|
|
|
1063
1123
|
---
|
|
1064
1124
|
|
|
1125
|
+
### `addBlueprintNote`
|
|
1126
|
+
|
|
1127
|
+
Append an internal note to a blueprint. `id`, `created_at` and `created_by`
|
|
1128
|
+
are stamped server-side from the caller, so notes cannot be backdated or
|
|
1129
|
+
attributed to someone else. Existing notes are neve
|
|
1130
|
+
|
|
1131
|
+
`POST /v2/blueprint-manifest/blueprints/{blueprint_id}/notes`
|
|
1132
|
+
|
|
1133
|
+
```ts
|
|
1134
|
+
const { data } = await client.addBlueprintNote(
|
|
1135
|
+
{
|
|
1136
|
+
blueprint_id: 'example',
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
text: 'string'
|
|
1140
|
+
},
|
|
1141
|
+
)
|
|
1142
|
+
```
|
|
1143
|
+
|
|
1144
|
+
<details>
|
|
1145
|
+
<summary>Response</summary>
|
|
1146
|
+
|
|
1147
|
+
```json
|
|
1148
|
+
{
|
|
1149
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
1150
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
1151
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1152
|
+
"created_by": {
|
|
1153
|
+
"name": "manifest@epilot.cloud",
|
|
1154
|
+
"org_id": "911690",
|
|
1155
|
+
"user_id": "11001045",
|
|
1156
|
+
"token_id": "api_5ZugdRXasLfWBypHi93Fk"
|
|
1157
|
+
}
|
|
1158
|
+
}
|
|
1159
|
+
```
|
|
1160
|
+
|
|
1161
|
+
</details>
|
|
1162
|
+
|
|
1163
|
+
---
|
|
1164
|
+
|
|
1165
|
+
### `deleteBlueprintNote`
|
|
1166
|
+
|
|
1167
|
+
Remove a single internal note from a blueprint.
|
|
1168
|
+
|
|
1169
|
+
`DELETE /v2/blueprint-manifest/blueprints/{blueprint_id}/notes/{note_id}`
|
|
1170
|
+
|
|
1171
|
+
```ts
|
|
1172
|
+
const { data } = await client.deleteBlueprintNote({
|
|
1173
|
+
blueprint_id: 'example',
|
|
1174
|
+
note_id: 'example',
|
|
1175
|
+
})
|
|
1176
|
+
```
|
|
1177
|
+
|
|
1178
|
+
<details>
|
|
1179
|
+
<summary>Response</summary>
|
|
1180
|
+
|
|
1181
|
+
```json
|
|
1182
|
+
{
|
|
1183
|
+
"notes": [
|
|
1184
|
+
{
|
|
1185
|
+
"id": "3f1c9b0e-2f3a-4a1f-9a3e-6f2b8c7d1e40",
|
|
1186
|
+
"text": "Adjusted the meter-reading journey for the §14a rollout.",
|
|
1187
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1188
|
+
"created_by": {
|
|
1189
|
+
"name": "manifest@epilot.cloud",
|
|
1190
|
+
"org_id": "911690",
|
|
1191
|
+
"user_id": "11001045",
|
|
1192
|
+
"token_id": "api_5ZugdRXasLfWBypHi93Fk"
|
|
1193
|
+
}
|
|
1194
|
+
}
|
|
1195
|
+
]
|
|
1196
|
+
}
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
</details>
|
|
1200
|
+
|
|
1201
|
+
---
|
|
1202
|
+
|
|
1065
1203
|
### `verifyBlueprint`
|
|
1066
1204
|
|
|
1067
1205
|
Start a blueprint verification job. Compares resource configurations between a source org
|
|
@@ -1713,7 +1851,8 @@ const { data } = await client.continueInstallationJob(
|
|
|
1713
1851
|
job_id: 'example',
|
|
1714
1852
|
},
|
|
1715
1853
|
{
|
|
1716
|
-
resources_to_ignore: ['string']
|
|
1854
|
+
resources_to_ignore: ['string'],
|
|
1855
|
+
sync_notes: false
|
|
1717
1856
|
},
|
|
1718
1857
|
)
|
|
1719
1858
|
```
|
|
@@ -2450,6 +2589,77 @@ const { data } = await client.publishBlueprintV3({
|
|
|
2450
2589
|
|
|
2451
2590
|
---
|
|
2452
2591
|
|
|
2592
|
+
### `preInstallBlueprintV3`
|
|
2593
|
+
|
|
2594
|
+
Preview a V3 blueprint package before installation
|
|
2595
|
+
|
|
2596
|
+
`POST /v3/blueprint-manifest/blueprints:pre-install`
|
|
2597
|
+
|
|
2598
|
+
```ts
|
|
2599
|
+
const { data } = await client.preInstallBlueprintV3(
|
|
2600
|
+
null,
|
|
2601
|
+
{
|
|
2602
|
+
blueprint_file: 'string',
|
|
2603
|
+
source_blueprint_type: 'marketplace',
|
|
2604
|
+
slug: 'string'
|
|
2605
|
+
},
|
|
2606
|
+
)
|
|
2607
|
+
```
|
|
2608
|
+
|
|
2609
|
+
<details>
|
|
2610
|
+
<summary>Response</summary>
|
|
2611
|
+
|
|
2612
|
+
```json
|
|
2613
|
+
{
|
|
2614
|
+
"id": "string",
|
|
2615
|
+
"org_id": "string",
|
|
2616
|
+
"title": "string",
|
|
2617
|
+
"description": {
|
|
2618
|
+
"preinstall": "string"
|
|
2619
|
+
},
|
|
2620
|
+
"version": "string",
|
|
2621
|
+
"slug": "string",
|
|
2622
|
+
"source_type": "marketplace",
|
|
2623
|
+
"blueprint_file_s3_key": "string",
|
|
2624
|
+
"is_verified": true,
|
|
2625
|
+
"docs_url": "string",
|
|
2626
|
+
"recommended_apps": ["string"],
|
|
2627
|
+
"required_features": {
|
|
2628
|
+
"enabled": ["string"],
|
|
2629
|
+
"disabled": ["string"]
|
|
2630
|
+
},
|
|
2631
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
2632
|
+
"created_by": {
|
|
2633
|
+
"name": "manifest@epilot.cloud",
|
|
2634
|
+
"org_id": "911690",
|
|
2635
|
+
"user_id": "11001045",
|
|
2636
|
+
"token_id": "api_5ZugdRXasLfWBypHi93Fk"
|
|
2637
|
+
},
|
|
2638
|
+
"is_updating": true,
|
|
2639
|
+
"resources": [
|
|
2640
|
+
{
|
|
2641
|
+
"id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2642
|
+
"name": "string",
|
|
2643
|
+
"type": "designbuilder",
|
|
2644
|
+
"address": "string",
|
|
2645
|
+
"is_root": true,
|
|
2646
|
+
"is_ready": true,
|
|
2647
|
+
"is_hidden": true,
|
|
2648
|
+
"is_disabled": false,
|
|
2649
|
+
"hard_dependencies": ["designbuilder"],
|
|
2650
|
+
"parent_resource_ids": ["c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"],
|
|
2651
|
+
"depends_on_addresses": ["string"],
|
|
2652
|
+
"impact_on_install": ["create"],
|
|
2653
|
+
"impact_on_install_reason": ["string"]
|
|
2654
|
+
}
|
|
2655
|
+
]
|
|
2656
|
+
}
|
|
2657
|
+
```
|
|
2658
|
+
|
|
2659
|
+
</details>
|
|
2660
|
+
|
|
2661
|
+
---
|
|
2662
|
+
|
|
2453
2663
|
### `installBlueprintV3`
|
|
2454
2664
|
|
|
2455
2665
|
Install Blueprint V3
|
|
@@ -2527,6 +2737,115 @@ const { data } = await client.getRestorePreview({
|
|
|
2527
2737
|
|
|
2528
2738
|
---
|
|
2529
2739
|
|
|
2740
|
+
### `triggerDeploymentHealthCheckV3`
|
|
2741
|
+
|
|
2742
|
+
Run a health check on a deployment
|
|
2743
|
+
|
|
2744
|
+
`POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:health-check`
|
|
2745
|
+
|
|
2746
|
+
```ts
|
|
2747
|
+
const { data } = await client.triggerDeploymentHealthCheckV3(
|
|
2748
|
+
{
|
|
2749
|
+
blueprint_id: 'example',
|
|
2750
|
+
job_id: 'example',
|
|
2751
|
+
},
|
|
2752
|
+
{
|
|
2753
|
+
source_org_id: 'string',
|
|
2754
|
+
source_auth_token: 'string'
|
|
2755
|
+
},
|
|
2756
|
+
)
|
|
2757
|
+
```
|
|
2758
|
+
|
|
2759
|
+
---
|
|
2760
|
+
|
|
2761
|
+
### `getDeploymentHealthReportV3`
|
|
2762
|
+
|
|
2763
|
+
Get the latest health report of a deployment
|
|
2764
|
+
|
|
2765
|
+
`GET /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/health-report`
|
|
2766
|
+
|
|
2767
|
+
```ts
|
|
2768
|
+
const { data } = await client.getDeploymentHealthReportV3({
|
|
2769
|
+
blueprint_id: 'example',
|
|
2770
|
+
job_id: 'example',
|
|
2771
|
+
})
|
|
2772
|
+
```
|
|
2773
|
+
|
|
2774
|
+
<details>
|
|
2775
|
+
<summary>Response</summary>
|
|
2776
|
+
|
|
2777
|
+
```json
|
|
2778
|
+
{
|
|
2779
|
+
"status": "running",
|
|
2780
|
+
"job_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2781
|
+
"blueprint_instance_id": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341",
|
|
2782
|
+
"destination_org_id": "string",
|
|
2783
|
+
"generated_at": "1970-01-01T00:00:00.000Z",
|
|
2784
|
+
"html_url": "string",
|
|
2785
|
+
"summary": {
|
|
2786
|
+
"resources_scanned": 0,
|
|
2787
|
+
"unchecked": 0,
|
|
2788
|
+
"errors": 0,
|
|
2789
|
+
"warnings": 0,
|
|
2790
|
+
"infos": 0
|
|
2791
|
+
},
|
|
2792
|
+
"findings": [
|
|
2793
|
+
{
|
|
2794
|
+
"check_id": "live_readability",
|
|
2795
|
+
"code": "missing_in_destination",
|
|
2796
|
+
"severity": "error",
|
|
2797
|
+
"resource_type": "string",
|
|
2798
|
+
"lineage_id": "string",
|
|
2799
|
+
"target_id": "string",
|
|
2800
|
+
"resource_name": "string",
|
|
2801
|
+
"message": "string",
|
|
2802
|
+
"verdict": "string",
|
|
2803
|
+
"evidence": {
|
|
2804
|
+
"path": "string",
|
|
2805
|
+
"referenced_id": "string",
|
|
2806
|
+
"referenced_type": "string",
|
|
2807
|
+
"referenced_name": "string",
|
|
2808
|
+
"referenced_lineage_id": "string",
|
|
2809
|
+
"expected_target_id": "string",
|
|
2810
|
+
"reference_kind": "string",
|
|
2811
|
+
"operation": "string",
|
|
2812
|
+
"rejection_reason": "string",
|
|
2813
|
+
"error_message": "string",
|
|
2814
|
+
"response_status": 0
|
|
2815
|
+
}
|
|
2816
|
+
}
|
|
2817
|
+
],
|
|
2818
|
+
"coverage": {
|
|
2819
|
+
"checks": [
|
|
2820
|
+
{
|
|
2821
|
+
"check_id": "live_readability",
|
|
2822
|
+
"status": "completed",
|
|
2823
|
+
"scope": "tracked_resources",
|
|
2824
|
+
"resources_considered": 0,
|
|
2825
|
+
"details": ["string"]
|
|
2826
|
+
}
|
|
2827
|
+
],
|
|
2828
|
+
"resource_types": [
|
|
2829
|
+
{
|
|
2830
|
+
"resource_type": "string",
|
|
2831
|
+
"tracked": 0,
|
|
2832
|
+
"readable_by_lineage": 0,
|
|
2833
|
+
"missing_by_lineage": 0,
|
|
2834
|
+
"read_errors": 0,
|
|
2835
|
+
"unchecked": 0,
|
|
2836
|
+
"specialized_checks": ["live_readability"],
|
|
2837
|
+
"known_blind_spots": ["string"]
|
|
2838
|
+
}
|
|
2839
|
+
]
|
|
2840
|
+
},
|
|
2841
|
+
"error": "string"
|
|
2842
|
+
}
|
|
2843
|
+
```
|
|
2844
|
+
|
|
2845
|
+
</details>
|
|
2846
|
+
|
|
2847
|
+
---
|
|
2848
|
+
|
|
2530
2849
|
### `getBlueprintLineageV3`
|
|
2531
2850
|
|
|
2532
2851
|
Get Blueprint Lineage V3
|
|
@@ -2577,7 +2896,8 @@ const { data } = await client.createBulkInstallV3(
|
|
|
2577
2896
|
max_concurrency: 2,
|
|
2578
2897
|
slug: 'string',
|
|
2579
2898
|
options: {
|
|
2580
|
-
resources_to_ignore: ['string']
|
|
2899
|
+
resources_to_ignore: ['string'],
|
|
2900
|
+
sync_notes: false
|
|
2581
2901
|
},
|
|
2582
2902
|
targets: [
|
|
2583
2903
|
{
|
|
@@ -2624,7 +2944,8 @@ const { data } = await client.getBulkInstallV3({
|
|
|
2624
2944
|
},
|
|
2625
2945
|
"slug": "string",
|
|
2626
2946
|
"options": {
|
|
2627
|
-
"resources_to_ignore": ["string"]
|
|
2947
|
+
"resources_to_ignore": ["string"],
|
|
2948
|
+
"sync_notes": false
|
|
2628
2949
|
},
|
|
2629
2950
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
2630
2951
|
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
@@ -3134,6 +3455,24 @@ type BlueprintPatchWithResults = {
|
|
|
3134
3455
|
}
|
|
3135
3456
|
```
|
|
3136
3457
|
|
|
3458
|
+
### `BlueprintNote`
|
|
3459
|
+
|
|
3460
|
+
A single internal note on a blueprint.
|
|
3461
|
+
|
|
3462
|
+
```ts
|
|
3463
|
+
type BlueprintNote = {
|
|
3464
|
+
id: string
|
|
3465
|
+
text: string
|
|
3466
|
+
created_at: string // date-time
|
|
3467
|
+
created_by?: {
|
|
3468
|
+
name?: unknown
|
|
3469
|
+
org_id: string
|
|
3470
|
+
user_id?: string
|
|
3471
|
+
token_id?: string
|
|
3472
|
+
}
|
|
3473
|
+
}
|
|
3474
|
+
```
|
|
3475
|
+
|
|
3137
3476
|
### `BlueprintID`
|
|
3138
3477
|
|
|
3139
3478
|
ID of a blueprint
|
|
@@ -3161,6 +3500,17 @@ type CommonBlueprintFields = {
|
|
|
3161
3500
|
preinstall?: string
|
|
3162
3501
|
postinstall?: string
|
|
3163
3502
|
}
|
|
3503
|
+
notes?: Array<{
|
|
3504
|
+
id: string
|
|
3505
|
+
text: string
|
|
3506
|
+
created_at: string // date-time
|
|
3507
|
+
created_by?: {
|
|
3508
|
+
name?: { ... }
|
|
3509
|
+
org_id: { ... }
|
|
3510
|
+
user_id?: { ... }
|
|
3511
|
+
token_id?: { ... }
|
|
3512
|
+
}
|
|
3513
|
+
}>
|
|
3164
3514
|
version?: string
|
|
3165
3515
|
deployments?: Array<{
|
|
3166
3516
|
source_org_id?: string
|
|
@@ -3345,6 +3695,17 @@ type CustomBlueprint = {
|
|
|
3345
3695
|
preinstall?: string
|
|
3346
3696
|
postinstall?: string
|
|
3347
3697
|
}
|
|
3698
|
+
notes?: Array<{
|
|
3699
|
+
id: string
|
|
3700
|
+
text: string
|
|
3701
|
+
created_at: string // date-time
|
|
3702
|
+
created_by?: {
|
|
3703
|
+
name?: { ... }
|
|
3704
|
+
org_id: { ... }
|
|
3705
|
+
user_id?: { ... }
|
|
3706
|
+
token_id?: { ... }
|
|
3707
|
+
}
|
|
3708
|
+
}>
|
|
3348
3709
|
version?: string
|
|
3349
3710
|
deployments?: Array<{
|
|
3350
3711
|
source_org_id?: string
|
|
@@ -3426,8 +3787,7 @@ type CustomBlueprint = {
|
|
|
3426
3787
|
depends_on_addresses?: string[]
|
|
3427
3788
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3428
3789
|
impact_on_install_reason?: string[]
|
|
3429
|
-
|
|
3430
|
-
source_type?: "custom"
|
|
3790
|
+
// ...
|
|
3431
3791
|
}
|
|
3432
3792
|
```
|
|
3433
3793
|
|
|
@@ -3442,6 +3802,17 @@ type FileBlueprint = {
|
|
|
3442
3802
|
preinstall?: string
|
|
3443
3803
|
postinstall?: string
|
|
3444
3804
|
}
|
|
3805
|
+
notes?: Array<{
|
|
3806
|
+
id: string
|
|
3807
|
+
text: string
|
|
3808
|
+
created_at: string // date-time
|
|
3809
|
+
created_by?: {
|
|
3810
|
+
name?: { ... }
|
|
3811
|
+
org_id: { ... }
|
|
3812
|
+
user_id?: { ... }
|
|
3813
|
+
token_id?: { ... }
|
|
3814
|
+
}
|
|
3815
|
+
}>
|
|
3445
3816
|
version?: string
|
|
3446
3817
|
deployments?: Array<{
|
|
3447
3818
|
source_org_id?: string
|
|
@@ -3523,8 +3894,7 @@ type FileBlueprint = {
|
|
|
3523
3894
|
parent_resource_ids?: string[]
|
|
3524
3895
|
depends_on_addresses?: string[]
|
|
3525
3896
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3526
|
-
|
|
3527
|
-
}>
|
|
3897
|
+
// ...
|
|
3528
3898
|
}
|
|
3529
3899
|
```
|
|
3530
3900
|
|
|
@@ -3539,6 +3909,17 @@ type MarketplaceBlueprint = {
|
|
|
3539
3909
|
preinstall?: string
|
|
3540
3910
|
postinstall?: string
|
|
3541
3911
|
}
|
|
3912
|
+
notes?: Array<{
|
|
3913
|
+
id: string
|
|
3914
|
+
text: string
|
|
3915
|
+
created_at: string // date-time
|
|
3916
|
+
created_by?: {
|
|
3917
|
+
name?: { ... }
|
|
3918
|
+
org_id: { ... }
|
|
3919
|
+
user_id?: { ... }
|
|
3920
|
+
token_id?: { ... }
|
|
3921
|
+
}
|
|
3922
|
+
}>
|
|
3542
3923
|
version?: string
|
|
3543
3924
|
deployments?: Array<{
|
|
3544
3925
|
source_org_id?: string
|
|
@@ -3620,11 +4001,7 @@ type MarketplaceBlueprint = {
|
|
|
3620
4001
|
parent_resource_ids?: string[]
|
|
3621
4002
|
depends_on_addresses?: string[]
|
|
3622
4003
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3623
|
-
|
|
3624
|
-
}>
|
|
3625
|
-
has_update_available?: boolean
|
|
3626
|
-
latest_marketplace_version?: string
|
|
3627
|
-
installation_link?: string
|
|
4004
|
+
// ...
|
|
3628
4005
|
}
|
|
3629
4006
|
```
|
|
3630
4007
|
|
|
@@ -3668,6 +4045,17 @@ type DeployedBlueprint = {
|
|
|
3668
4045
|
preinstall?: string
|
|
3669
4046
|
postinstall?: string
|
|
3670
4047
|
}
|
|
4048
|
+
notes?: Array<{
|
|
4049
|
+
id: string
|
|
4050
|
+
text: string
|
|
4051
|
+
created_at: string // date-time
|
|
4052
|
+
created_by?: {
|
|
4053
|
+
name?: { ... }
|
|
4054
|
+
org_id: { ... }
|
|
4055
|
+
user_id?: { ... }
|
|
4056
|
+
token_id?: { ... }
|
|
4057
|
+
}
|
|
4058
|
+
}>
|
|
3671
4059
|
version?: string
|
|
3672
4060
|
deployments?: Array<{
|
|
3673
4061
|
source_org_id?: string
|
|
@@ -3749,8 +4137,7 @@ type DeployedBlueprint = {
|
|
|
3749
4137
|
parent_resource_ids?: string[]
|
|
3750
4138
|
depends_on_addresses?: string[]
|
|
3751
4139
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3752
|
-
|
|
3753
|
-
}>
|
|
4140
|
+
// ...
|
|
3754
4141
|
}
|
|
3755
4142
|
```
|
|
3756
4143
|
|
|
@@ -3765,6 +4152,17 @@ type AppBlueprint = {
|
|
|
3765
4152
|
preinstall?: string
|
|
3766
4153
|
postinstall?: string
|
|
3767
4154
|
}
|
|
4155
|
+
notes?: Array<{
|
|
4156
|
+
id: string
|
|
4157
|
+
text: string
|
|
4158
|
+
created_at: string // date-time
|
|
4159
|
+
created_by?: {
|
|
4160
|
+
name?: { ... }
|
|
4161
|
+
org_id: { ... }
|
|
4162
|
+
user_id?: { ... }
|
|
4163
|
+
token_id?: { ... }
|
|
4164
|
+
}
|
|
4165
|
+
}>
|
|
3768
4166
|
version?: string
|
|
3769
4167
|
deployments?: Array<{
|
|
3770
4168
|
source_org_id?: string
|
|
@@ -3846,8 +4244,7 @@ type AppBlueprint = {
|
|
|
3846
4244
|
parent_resource_ids?: string[]
|
|
3847
4245
|
depends_on_addresses?: string[]
|
|
3848
4246
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3849
|
-
|
|
3850
|
-
}>
|
|
4247
|
+
// ...
|
|
3851
4248
|
}
|
|
3852
4249
|
```
|
|
3853
4250
|
|
|
@@ -3862,6 +4259,17 @@ type Blueprint = {
|
|
|
3862
4259
|
preinstall?: string
|
|
3863
4260
|
postinstall?: string
|
|
3864
4261
|
}
|
|
4262
|
+
notes?: Array<{
|
|
4263
|
+
id: string
|
|
4264
|
+
text: string
|
|
4265
|
+
created_at: string // date-time
|
|
4266
|
+
created_by?: {
|
|
4267
|
+
name?: { ... }
|
|
4268
|
+
org_id: { ... }
|
|
4269
|
+
user_id?: { ... }
|
|
4270
|
+
token_id?: { ... }
|
|
4271
|
+
}
|
|
4272
|
+
}>
|
|
3865
4273
|
version?: string
|
|
3866
4274
|
deployments?: Array<{
|
|
3867
4275
|
source_org_id?: string
|
|
@@ -3943,17 +4351,6 @@ type Blueprint = {
|
|
|
3943
4351
|
depends_on_addresses?: string[]
|
|
3944
4352
|
impact_on_install?: "create" | "update" | "internal-update" | "no-op" | "delete" | "ignored" | "error"[]
|
|
3945
4353
|
impact_on_install_reason?: string[]
|
|
3946
|
-
}>
|
|
3947
|
-
source_type?: "custom"
|
|
3948
|
-
} | {
|
|
3949
|
-
id?: string
|
|
3950
|
-
title: string
|
|
3951
|
-
slug?: string
|
|
3952
|
-
description?: {
|
|
3953
|
-
preinstall?: string
|
|
3954
|
-
postinstall?: string
|
|
3955
|
-
}
|
|
3956
|
-
version?: string
|
|
3957
4354
|
// ...
|
|
3958
4355
|
}
|
|
3959
4356
|
```
|
|
@@ -4131,6 +4528,7 @@ type BulkInstall = {
|
|
|
4131
4528
|
slug?: string
|
|
4132
4529
|
options?: {
|
|
4133
4530
|
resources_to_ignore?: string[]
|
|
4531
|
+
sync_notes?: boolean
|
|
4134
4532
|
}
|
|
4135
4533
|
created_at?: string // date-time
|
|
4136
4534
|
updated_at?: string // date-time
|
|
@@ -4245,6 +4643,7 @@ type BulkInstallCreateRequest = {
|
|
|
4245
4643
|
slug?: string
|
|
4246
4644
|
options?: {
|
|
4247
4645
|
resources_to_ignore?: string[]
|
|
4646
|
+
sync_notes?: boolean
|
|
4248
4647
|
}
|
|
4249
4648
|
targets: Array<{
|
|
4250
4649
|
destination_org_id: string
|
|
@@ -4343,6 +4742,150 @@ type RestoreOutcomeItem = {
|
|
|
4343
4742
|
}
|
|
4344
4743
|
```
|
|
4345
4744
|
|
|
4745
|
+
### `HealthFinding`
|
|
4746
|
+
|
|
4747
|
+
```ts
|
|
4748
|
+
type HealthFinding = {
|
|
4749
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "catalog_hygiene" | "spec_conformance"
|
|
4750
|
+
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"
|
|
4751
|
+
severity: "error" | "warning" | "info"
|
|
4752
|
+
resource_type: string
|
|
4753
|
+
lineage_id: string
|
|
4754
|
+
target_id?: string
|
|
4755
|
+
resource_name?: string
|
|
4756
|
+
message: string
|
|
4757
|
+
verdict?: string
|
|
4758
|
+
evidence?: {
|
|
4759
|
+
path?: string
|
|
4760
|
+
referenced_id?: string
|
|
4761
|
+
referenced_type?: string
|
|
4762
|
+
referenced_name?: string
|
|
4763
|
+
referenced_lineage_id?: string
|
|
4764
|
+
expected_target_id?: string
|
|
4765
|
+
reference_kind?: string
|
|
4766
|
+
operation?: string
|
|
4767
|
+
rejection_reason?: string
|
|
4768
|
+
error_message?: string
|
|
4769
|
+
response_status?: number
|
|
4770
|
+
}
|
|
4771
|
+
}
|
|
4772
|
+
```
|
|
4773
|
+
|
|
4774
|
+
### `HealthCheckCoverage`
|
|
4775
|
+
|
|
4776
|
+
```ts
|
|
4777
|
+
type HealthCheckCoverage = {
|
|
4778
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance"
|
|
4779
|
+
status: "completed" | "partial" | "skipped" | "not_applicable"
|
|
4780
|
+
scope: "tracked_resources" | "org_wide" | "source_comparison"
|
|
4781
|
+
resources_considered: number
|
|
4782
|
+
details: string[]
|
|
4783
|
+
}
|
|
4784
|
+
```
|
|
4785
|
+
|
|
4786
|
+
### `HealthResourceTypeCoverage`
|
|
4787
|
+
|
|
4788
|
+
```ts
|
|
4789
|
+
type HealthResourceTypeCoverage = {
|
|
4790
|
+
resource_type: string
|
|
4791
|
+
tracked: number
|
|
4792
|
+
readable_by_lineage: number
|
|
4793
|
+
missing_by_lineage: number
|
|
4794
|
+
read_errors: number
|
|
4795
|
+
unchecked: number
|
|
4796
|
+
specialized_checks: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance"[]
|
|
4797
|
+
known_blind_spots: string[]
|
|
4798
|
+
}
|
|
4799
|
+
```
|
|
4800
|
+
|
|
4801
|
+
### `HealthScanCoverage`
|
|
4802
|
+
|
|
4803
|
+
```ts
|
|
4804
|
+
type HealthScanCoverage = {
|
|
4805
|
+
checks: Array<{
|
|
4806
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance"
|
|
4807
|
+
status: "completed" | "partial" | "skipped" | "not_applicable"
|
|
4808
|
+
scope: "tracked_resources" | "org_wide" | "source_comparison"
|
|
4809
|
+
resources_considered: number
|
|
4810
|
+
details: string[]
|
|
4811
|
+
}>
|
|
4812
|
+
resource_types: Array<{
|
|
4813
|
+
resource_type: string
|
|
4814
|
+
tracked: number
|
|
4815
|
+
readable_by_lineage: number
|
|
4816
|
+
missing_by_lineage: number
|
|
4817
|
+
read_errors: number
|
|
4818
|
+
unchecked: number
|
|
4819
|
+
specialized_checks: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "spec_conformance"[]
|
|
4820
|
+
known_blind_spots: string[]
|
|
4821
|
+
}>
|
|
4822
|
+
}
|
|
4823
|
+
```
|
|
4824
|
+
|
|
4825
|
+
### `DeploymentHealthReport`
|
|
4826
|
+
|
|
4827
|
+
```ts
|
|
4828
|
+
type DeploymentHealthReport = {
|
|
4829
|
+
status: "running" | "completed" | "failed"
|
|
4830
|
+
job_id: string
|
|
4831
|
+
blueprint_instance_id: string
|
|
4832
|
+
destination_org_id: string
|
|
4833
|
+
generated_at: string // date-time
|
|
4834
|
+
html_url?: string
|
|
4835
|
+
summary?: {
|
|
4836
|
+
resources_scanned?: number
|
|
4837
|
+
unchecked?: number
|
|
4838
|
+
errors?: number
|
|
4839
|
+
warnings?: number
|
|
4840
|
+
infos?: number
|
|
4841
|
+
}
|
|
4842
|
+
findings?: Array<{
|
|
4843
|
+
check_id: "live_readability" | "referential_integrity" | "install_completeness" | "schema_consistency" | "mapping_integrity" | "execution_readiness" | "catalog_hygiene" | "spec_conformance"
|
|
4844
|
+
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"
|
|
4845
|
+
severity: "error" | "warning" | "info"
|
|
4846
|
+
resource_type: string
|
|
4847
|
+
lineage_id: string
|
|
4848
|
+
target_id?: string
|
|
4849
|
+
resource_name?: string
|
|
4850
|
+
message: string
|
|
4851
|
+
verdict?: string
|
|
4852
|
+
evidence?: {
|
|
4853
|
+
path?: { ... }
|
|
4854
|
+
referenced_id?: { ... }
|
|
4855
|
+
referenced_type?: { ... }
|
|
4856
|
+
referenced_name?: { ... }
|
|
4857
|
+
referenced_lineage_id?: { ... }
|
|
4858
|
+
expected_target_id?: { ... }
|
|
4859
|
+
reference_kind?: { ... }
|
|
4860
|
+
operation?: { ... }
|
|
4861
|
+
rejection_reason?: { ... }
|
|
4862
|
+
error_message?: { ... }
|
|
4863
|
+
response_status?: { ... }
|
|
4864
|
+
}
|
|
4865
|
+
}>
|
|
4866
|
+
coverage?: {
|
|
4867
|
+
checks: Array<{
|
|
4868
|
+
check_id: { ... }
|
|
4869
|
+
status: { ... }
|
|
4870
|
+
scope: { ... }
|
|
4871
|
+
resources_considered: { ... }
|
|
4872
|
+
details: { ... }
|
|
4873
|
+
}>
|
|
4874
|
+
resource_types: Array<{
|
|
4875
|
+
resource_type: { ... }
|
|
4876
|
+
tracked: { ... }
|
|
4877
|
+
readable_by_lineage: { ... }
|
|
4878
|
+
missing_by_lineage: { ... }
|
|
4879
|
+
read_errors: { ... }
|
|
4880
|
+
unchecked: { ... }
|
|
4881
|
+
specialized_checks: { ... }
|
|
4882
|
+
known_blind_spots: { ... }
|
|
4883
|
+
}>
|
|
4884
|
+
}
|
|
4885
|
+
error?: string
|
|
4886
|
+
}
|
|
4887
|
+
```
|
|
4888
|
+
|
|
4346
4889
|
### `RestoreOutcome`
|
|
4347
4890
|
|
|
4348
4891
|
```ts
|
|
@@ -4723,6 +5266,7 @@ type BlueprintJobEvent = {
|
|
|
4723
5266
|
```ts
|
|
4724
5267
|
type BlueprintInstallationJobOptions = {
|
|
4725
5268
|
resources_to_ignore?: string[]
|
|
5269
|
+
sync_notes?: boolean
|
|
4726
5270
|
}
|
|
4727
5271
|
```
|
|
4728
5272
|
|