@epilot/blueprint-manifest-client 2.8.8 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/openapi.d.ts +93 -9
  2. package/dist/openapi.json +83 -35
  3. package/package.json +4 -3
package/dist/openapi.d.ts CHANGED
@@ -129,6 +129,23 @@ declare namespace Components {
129
129
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
130
130
  */
131
131
  ready_imported_resources_url?: string;
132
+ /**
133
+ * Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
134
+ */
135
+ deployed_from?: {
136
+ /**
137
+ * ID of the organization that deployed the manifest
138
+ */
139
+ source_organization_id?: string;
140
+ /**
141
+ * ID of the manifest that was deployed
142
+ */
143
+ source_manifest_id?: string;
144
+ /**
145
+ * When the deployment was last triggered
146
+ */
147
+ last_triggered_at?: string; // date-time
148
+ };
132
149
  }
133
150
  export interface CommonMarkdownFields {
134
151
  /**
@@ -200,6 +217,10 @@ declare namespace Components {
200
217
  */
201
218
  JobID;
202
219
  job_status?: JobStatus;
220
+ /**
221
+ * The S3 key of the manifest file
222
+ */
223
+ manifest_file_path?: string;
203
224
  message?: string;
204
225
  timestamp?: string; // date-time
205
226
  /**
@@ -327,6 +348,23 @@ declare namespace Components {
327
348
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
328
349
  */
329
350
  ready_imported_resources_url?: string;
351
+ /**
352
+ * Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
353
+ */
354
+ deployed_from?: {
355
+ /**
356
+ * ID of the organization that deployed the manifest
357
+ */
358
+ source_organization_id?: string;
359
+ /**
360
+ * ID of the manifest that was deployed
361
+ */
362
+ source_manifest_id?: string;
363
+ /**
364
+ * When the deployment was last triggered
365
+ */
366
+ last_triggered_at?: string; // date-time
367
+ };
330
368
  }
331
369
  /**
332
370
  * ID of an import or export job (state machine)
@@ -417,6 +455,23 @@ declare namespace Components {
417
455
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
418
456
  */
419
457
  ready_imported_resources_url?: string;
458
+ /**
459
+ * Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
460
+ */
461
+ deployed_from?: {
462
+ /**
463
+ * ID of the organization that deployed the manifest
464
+ */
465
+ source_organization_id?: string;
466
+ /**
467
+ * ID of the manifest that was deployed
468
+ */
469
+ source_manifest_id?: string;
470
+ /**
471
+ * When the deployment was last triggered
472
+ */
473
+ last_triggered_at?: string; // date-time
474
+ };
420
475
  /**
421
476
  * Markdown content part of a manifest file
422
477
  */
@@ -536,6 +591,23 @@ declare namespace Components {
536
591
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json
537
592
  */
538
593
  ready_imported_resources_url?: string;
594
+ /**
595
+ * Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones
596
+ */
597
+ deployed_from?: {
598
+ /**
599
+ * ID of the organization that deployed the manifest
600
+ */
601
+ source_organization_id?: string;
602
+ /**
603
+ * ID of the manifest that was deployed
604
+ */
605
+ source_manifest_id?: string;
606
+ /**
607
+ * When the deployment was last triggered
608
+ */
609
+ last_triggered_at?: string; // date-time
610
+ };
539
611
  /**
540
612
  * When the manifest was first installed (applied)
541
613
  */
@@ -561,7 +633,7 @@ declare namespace Components {
561
633
  /**
562
634
  * Name of the source blueprint
563
635
  */
564
- source_blueprint_name: string;
636
+ source_blueprint_name?: string;
565
637
  /**
566
638
  * Markdown content of the manifest
567
639
  */
@@ -606,7 +678,7 @@ declare namespace Components {
606
678
  /**
607
679
  * Type of the resource
608
680
  */
609
- export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "custom_variable" | "coupon" | "usergroup" | "saved_view";
681
+ export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "custom_variable" | "coupon" | "usergroup" | "saved_view" | "dashboard" | "app";
610
682
  export interface ResourceReplacement {
611
683
  /**
612
684
  * Original resource ID to be replaced
@@ -715,12 +787,6 @@ declare namespace Paths {
715
787
  job_id: Parameters.JobId;
716
788
  }
717
789
  export interface RequestBody {
718
- /**
719
- * This is no longer used
720
- * example:
721
- * example.tf
722
- */
723
- manifestFilePath?: string | null;
724
790
  /**
725
791
  * List of resources to ignore changes for
726
792
  */
@@ -882,6 +948,10 @@ declare namespace Paths {
882
948
  * List of resource replacements to apply during import
883
949
  */
884
950
  resourceReplacements?: Components.Schemas.ResourceReplacement[];
951
+ deployedFrom?: {
952
+ sourceOrganizationId: string;
953
+ sourceManifestId: string;
954
+ };
885
955
  } | {
886
956
  /**
887
957
  * Manifest s3 key uploaded via `uploadManifest`
@@ -905,6 +975,10 @@ declare namespace Paths {
905
975
  * List of resource replacements to apply during import
906
976
  */
907
977
  resourceReplacements?: Components.Schemas.ResourceReplacement[];
978
+ deployedFrom?: {
979
+ sourceOrganizationId: string;
980
+ sourceManifestId: string;
981
+ };
908
982
  };
909
983
  namespace Responses {
910
984
  export interface $200 {
@@ -954,7 +1028,17 @@ declare namespace Paths {
954
1028
  * journey_HouseConnectionJourney
955
1029
  */
956
1030
  resourceName: string;
957
- metadata?: any;
1031
+ metadata?: {
1032
+ markdown?: {
1033
+ manifest?: string;
1034
+ preinstall?: string;
1035
+ postinstall?: string;
1036
+ };
1037
+ docs_link?: string;
1038
+ source_blueprint_name?: string;
1039
+ source_blueprint_slug?: string;
1040
+ source_blueprint_version?: string;
1041
+ };
958
1042
  /**
959
1043
  * Temporary flag to indicate if multiple resources are being exported
960
1044
  */
package/dist/openapi.json CHANGED
@@ -201,31 +201,34 @@
201
201
  "example": "journey_HouseConnectionJourney"
202
202
  },
203
203
  "metadata": {
204
- "markdown": {
205
- "type": "object",
206
- "properties": {
207
- "manifest": {
208
- "type": "string"
209
- },
210
- "preinstall": {
211
- "type": "string"
212
- },
213
- "postinstall": {
214
- "type": "string"
204
+ "type": "object",
205
+ "properties": {
206
+ "markdown": {
207
+ "type": "object",
208
+ "properties": {
209
+ "manifest": {
210
+ "type": "string"
211
+ },
212
+ "preinstall": {
213
+ "type": "string"
214
+ },
215
+ "postinstall": {
216
+ "type": "string"
217
+ }
215
218
  }
219
+ },
220
+ "docs_link": {
221
+ "type": "string"
222
+ },
223
+ "source_blueprint_name": {
224
+ "type": "string"
225
+ },
226
+ "source_blueprint_slug": {
227
+ "type": "string"
228
+ },
229
+ "source_blueprint_version": {
230
+ "type": "string"
216
231
  }
217
- },
218
- "docs_link": {
219
- "type": "string"
220
- },
221
- "source_blueprint_name": {
222
- "type": "string"
223
- },
224
- "source_blueprint_slug": {
225
- "type": "string"
226
- },
227
- "source_blueprint_version": {
228
- "type": "string"
229
232
  }
230
233
  },
231
234
  "isExportingMultipleResources": {
@@ -371,6 +374,21 @@
371
374
  "$ref": "#/components/schemas/ResourceReplacement"
372
375
  },
373
376
  "description": "List of resource replacements to apply during import"
377
+ },
378
+ "deployedFrom": {
379
+ "type": "object",
380
+ "properties": {
381
+ "sourceOrganizationId": {
382
+ "type": "string"
383
+ },
384
+ "sourceManifestId": {
385
+ "type": "string"
386
+ }
387
+ },
388
+ "required": [
389
+ "sourceOrganizationId",
390
+ "sourceManifestId"
391
+ ]
374
392
  }
375
393
  },
376
394
  "required": [
@@ -419,6 +437,21 @@
419
437
  "$ref": "#/components/schemas/ResourceReplacement"
420
438
  },
421
439
  "description": "List of resource replacements to apply during import"
440
+ },
441
+ "deployedFrom": {
442
+ "type": "object",
443
+ "properties": {
444
+ "sourceOrganizationId": {
445
+ "type": "string"
446
+ },
447
+ "sourceManifestId": {
448
+ "type": "string"
449
+ }
450
+ },
451
+ "required": [
452
+ "sourceOrganizationId",
453
+ "sourceManifestId"
454
+ ]
422
455
  }
423
456
  },
424
457
  "required": [
@@ -469,13 +502,6 @@
469
502
  "schema": {
470
503
  "type": "object",
471
504
  "properties": {
472
- "manifestFilePath": {
473
- "description": "This is no longer used",
474
- "type": "string",
475
- "example": "example.tf",
476
- "deprecated": true,
477
- "nullable": true
478
- },
479
505
  "resourcesToIgnore": {
480
506
  "type": "array",
481
507
  "items": {
@@ -755,7 +781,9 @@
755
781
  "custom_variable",
756
782
  "coupon",
757
783
  "usergroup",
758
- "saved_view"
784
+ "saved_view",
785
+ "dashboard",
786
+ "app"
759
787
  ]
760
788
  },
761
789
  "PlanChanges": {
@@ -905,6 +933,10 @@
905
933
  "job_status": {
906
934
  "$ref": "#/components/schemas/JobStatus"
907
935
  },
936
+ "manifest_file_path": {
937
+ "type": "string",
938
+ "description": "The S3 key of the manifest file"
939
+ },
908
940
  "message": {
909
941
  "type": "string"
910
942
  },
@@ -1078,6 +1110,25 @@
1078
1110
  "type": "string",
1079
1111
  "description": "All the resources that were marked as ready by the user",
1080
1112
  "example": "https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/ready_imported_resources.json"
1113
+ },
1114
+ "deployed_from": {
1115
+ "type": "object",
1116
+ "properties": {
1117
+ "source_organization_id": {
1118
+ "type": "string",
1119
+ "description": "ID of the organization that deployed the manifest"
1120
+ },
1121
+ "source_manifest_id": {
1122
+ "type": "string",
1123
+ "description": "ID of the manifest that was deployed"
1124
+ },
1125
+ "last_triggered_at": {
1126
+ "type": "string",
1127
+ "format": "date-time",
1128
+ "description": "When the deployment was last triggered"
1129
+ }
1130
+ },
1131
+ "description": "Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones"
1081
1132
  }
1082
1133
  }
1083
1134
  },
@@ -1318,10 +1369,7 @@
1318
1369
  },
1319
1370
  "description": "Array of ids of resources selected to be ready by the user"
1320
1371
  }
1321
- },
1322
- "required": [
1323
- "source_blueprint_name"
1324
- ]
1372
+ }
1325
1373
  }
1326
1374
  },
1327
1375
  "parameters": {
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "2.8.8",
3
+ "version": "2.9.0",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "author": "epilot GmbH",
8
8
  "license": "MIT",
9
+ "private": false,
9
10
  "repository": {
10
11
  "type": "git",
11
12
  "url": "git+https://github.com/epilot-dev/sdk-js.git",
@@ -24,7 +25,7 @@
24
25
  "test": "jest",
25
26
  "bundle-definition": "webpack",
26
27
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
27
- "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprints-api/lambda/TerraformHandlerFunction/openapi.yml",
28
+ "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
28
29
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
29
30
  "build": "tsc && npm run build:patch && npm run bundle-definition",
30
31
  "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
@@ -72,4 +73,4 @@
72
73
  "webpack-cli": "^4.4.0"
73
74
  },
74
75
  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
75
- }
76
+ }