@epilot/blueprint-manifest-client 2.9.0 → 2.9.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.
Files changed (3) hide show
  1. package/dist/openapi.d.ts +97 -71
  2. package/dist/openapi.json +115 -68
  3. package/package.json +3 -3
package/dist/openapi.d.ts CHANGED
@@ -141,11 +141,30 @@ declare namespace Components {
141
141
  * ID of the manifest that was deployed
142
142
  */
143
143
  source_manifest_id?: string;
144
+ source_organization_type?: "sandbox" | "production";
144
145
  /**
145
146
  * When the deployment was last triggered
146
147
  */
147
148
  last_triggered_at?: string; // date-time
148
149
  };
150
+ /**
151
+ * Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
152
+ */
153
+ deployed_to?: {
154
+ /**
155
+ * ID of the organization that the manifest was deployed to
156
+ */
157
+ destination_organization_id?: string;
158
+ /**
159
+ * ID of the manifest that was deployed to
160
+ */
161
+ destination_manifest_id?: string;
162
+ destination_organization_type?: "sandbox" | "production";
163
+ /**
164
+ * When the deployment was last triggered
165
+ */
166
+ last_triggered_at?: string; // date-time
167
+ }[];
149
168
  }
150
169
  export interface CommonMarkdownFields {
151
170
  /**
@@ -360,11 +379,30 @@ declare namespace Components {
360
379
  * ID of the manifest that was deployed
361
380
  */
362
381
  source_manifest_id?: string;
382
+ source_organization_type?: "sandbox" | "production";
363
383
  /**
364
384
  * When the deployment was last triggered
365
385
  */
366
386
  last_triggered_at?: string; // date-time
367
387
  };
388
+ /**
389
+ * Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
390
+ */
391
+ deployed_to?: {
392
+ /**
393
+ * ID of the organization that the manifest was deployed to
394
+ */
395
+ destination_organization_id?: string;
396
+ /**
397
+ * ID of the manifest that was deployed to
398
+ */
399
+ destination_manifest_id?: string;
400
+ destination_organization_type?: "sandbox" | "production";
401
+ /**
402
+ * When the deployment was last triggered
403
+ */
404
+ last_triggered_at?: string; // date-time
405
+ }[];
368
406
  }
369
407
  /**
370
408
  * ID of an import or export job (state machine)
@@ -467,11 +505,30 @@ declare namespace Components {
467
505
  * ID of the manifest that was deployed
468
506
  */
469
507
  source_manifest_id?: string;
508
+ source_organization_type?: "sandbox" | "production";
470
509
  /**
471
510
  * When the deployment was last triggered
472
511
  */
473
512
  last_triggered_at?: string; // date-time
474
513
  };
514
+ /**
515
+ * Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
516
+ */
517
+ deployed_to?: {
518
+ /**
519
+ * ID of the organization that the manifest was deployed to
520
+ */
521
+ destination_organization_id?: string;
522
+ /**
523
+ * ID of the manifest that was deployed to
524
+ */
525
+ destination_manifest_id?: string;
526
+ destination_organization_type?: "sandbox" | "production";
527
+ /**
528
+ * When the deployment was last triggered
529
+ */
530
+ last_triggered_at?: string; // date-time
531
+ }[];
475
532
  /**
476
533
  * Markdown content part of a manifest file
477
534
  */
@@ -603,11 +660,30 @@ declare namespace Components {
603
660
  * ID of the manifest that was deployed
604
661
  */
605
662
  source_manifest_id?: string;
663
+ source_organization_type?: "sandbox" | "production";
606
664
  /**
607
665
  * When the deployment was last triggered
608
666
  */
609
667
  last_triggered_at?: string; // date-time
610
668
  };
669
+ /**
670
+ * Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones
671
+ */
672
+ deployed_to?: {
673
+ /**
674
+ * ID of the organization that the manifest was deployed to
675
+ */
676
+ destination_organization_id?: string;
677
+ /**
678
+ * ID of the manifest that was deployed to
679
+ */
680
+ destination_manifest_id?: string;
681
+ destination_organization_type?: "sandbox" | "production";
682
+ /**
683
+ * When the deployment was last triggered
684
+ */
685
+ last_triggered_at?: string; // date-time
686
+ }[];
611
687
  /**
612
688
  * When the manifest was first installed (applied)
613
689
  */
@@ -642,6 +718,18 @@ declare namespace Components {
642
718
  * Array of ids of resources selected to be ready by the user
643
719
  */
644
720
  ready_resources?: string[];
721
+ deployed_to?: {
722
+ /**
723
+ * ID of the organization that the manifest was deployed to
724
+ */
725
+ destination_organization_id?: string;
726
+ /**
727
+ * ID of the manifest that was deployed to
728
+ */
729
+ destination_manifest_id?: string;
730
+ destination_organization_type?: "sandbox" | "production";
731
+ last_triggered_at?: string;
732
+ }[];
645
733
  }
646
734
  export interface ResourceNode {
647
735
  /**
@@ -678,7 +766,7 @@ declare namespace Components {
678
766
  /**
679
767
  * Type of the resource
680
768
  */
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";
769
+ 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" | "dashboard" | "custom_variable" | "coupon" | "usergroup" | "saved_view" | "app";
682
770
  export interface ResourceReplacement {
683
771
  /**
684
772
  * Original resource ID to be replaced
@@ -808,75 +896,7 @@ declare namespace Paths {
808
896
  }
809
897
  }
810
898
  namespace CreateExport {
811
- export type RequestBody = {
812
- resourceType: /* Type of the resource */ Components.Schemas.ResourceNodeType;
813
- resourceIds: [
814
- string,
815
- string?,
816
- string?,
817
- string?,
818
- string?,
819
- string?,
820
- string?,
821
- string?,
822
- string?,
823
- string?,
824
- string?,
825
- string?,
826
- string?,
827
- string?,
828
- string?,
829
- string?,
830
- string?,
831
- string?,
832
- string?,
833
- string?,
834
- string?,
835
- string?,
836
- string?,
837
- string?,
838
- string?,
839
- string?,
840
- string?,
841
- string?,
842
- string?,
843
- string?,
844
- string?,
845
- string?,
846
- string?,
847
- string?,
848
- string?,
849
- string?,
850
- string?,
851
- string?,
852
- string?,
853
- string?,
854
- string?,
855
- string?,
856
- string?,
857
- string?,
858
- string?,
859
- string?,
860
- string?,
861
- string?,
862
- string?,
863
- string?
864
- ];
865
- jobId?: /**
866
- * ID of an import or export job (state machine)
867
- * example:
868
- * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
869
- */
870
- Components.Schemas.JobID;
871
- /**
872
- * Temporary flag to indicate if multiple resources are being exported
873
- */
874
- isExportingMultipleResources?: boolean;
875
- /**
876
- * Pipeline ID selected when doing the sandbox sync
877
- */
878
- pipelineId?: string;
879
- } | {
899
+ export interface RequestBody {
880
900
  resources: [
881
901
  {
882
902
  type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
@@ -901,7 +921,11 @@ declare namespace Paths {
901
921
  * Pipeline ID selected when doing the sandbox sync
902
922
  */
903
923
  pipelineId?: string;
904
- };
924
+ /**
925
+ * ID of the installed manifest to load the resource addresses from
926
+ */
927
+ manifestId?: string;
928
+ }
905
929
  namespace Responses {
906
930
  export interface $200 {
907
931
  jobId?: /**
@@ -951,6 +975,7 @@ declare namespace Paths {
951
975
  deployedFrom?: {
952
976
  sourceOrganizationId: string;
953
977
  sourceManifestId: string;
978
+ sourceOrganizationType: "sandbox" | "production";
954
979
  };
955
980
  } | {
956
981
  /**
@@ -978,6 +1003,7 @@ declare namespace Paths {
978
1003
  deployedFrom?: {
979
1004
  sourceOrganizationId: string;
980
1005
  sourceManifestId: string;
1006
+ sourceOrganizationType: "sandbox" | "production";
981
1007
  };
982
1008
  };
983
1009
  namespace Responses {
package/dist/openapi.json CHANGED
@@ -76,76 +76,45 @@
76
76
  "content": {
77
77
  "application/json": {
78
78
  "schema": {
79
- "oneOf": [
80
- {
81
- "type": "object",
82
- "properties": {
83
- "resourceType": {
84
- "$ref": "#/components/schemas/ResourceNodeType"
85
- },
86
- "resourceIds": {
87
- "type": "array",
88
- "items": {
89
- "type": "string"
79
+ "type": "object",
80
+ "properties": {
81
+ "resources": {
82
+ "type": "array",
83
+ "items": {
84
+ "type": "object",
85
+ "properties": {
86
+ "type": {
87
+ "$ref": "#/components/schemas/ResourceNodeType"
90
88
  },
91
- "minItems": 1,
92
- "maxItems": 50
93
- },
94
- "jobId": {
95
- "$ref": "#/components/schemas/JobID"
96
- },
97
- "isExportingMultipleResources": {
98
- "type": "boolean",
99
- "description": "Temporary flag to indicate if multiple resources are being exported"
89
+ "id": {
90
+ "type": "string"
91
+ }
100
92
  },
101
- "pipelineId": {
102
- "type": "string",
103
- "description": "Pipeline ID selected when doing the sandbox sync"
104
- }
93
+ "required": [
94
+ "type",
95
+ "id"
96
+ ]
105
97
  },
106
- "required": [
107
- "resourceType",
108
- "resourceIds"
109
- ]
98
+ "minItems": 1
110
99
  },
111
- {
112
- "type": "object",
113
- "properties": {
114
- "resources": {
115
- "type": "array",
116
- "items": {
117
- "type": "object",
118
- "properties": {
119
- "type": {
120
- "$ref": "#/components/schemas/ResourceNodeType"
121
- },
122
- "id": {
123
- "type": "string"
124
- }
125
- },
126
- "required": [
127
- "type",
128
- "id"
129
- ]
130
- },
131
- "minItems": 1
132
- },
133
- "jobId": {
134
- "$ref": "#/components/schemas/JobID"
135
- },
136
- "isExportingMultipleResources": {
137
- "type": "boolean",
138
- "description": "Temporary flag to indicate if multiple resources are being exported"
139
- },
140
- "pipelineId": {
141
- "type": "string",
142
- "description": "Pipeline ID selected when doing the sandbox sync"
143
- }
144
- },
145
- "required": [
146
- "resources"
147
- ]
100
+ "jobId": {
101
+ "$ref": "#/components/schemas/JobID"
102
+ },
103
+ "isExportingMultipleResources": {
104
+ "type": "boolean",
105
+ "description": "Temporary flag to indicate if multiple resources are being exported"
106
+ },
107
+ "pipelineId": {
108
+ "type": "string",
109
+ "description": "Pipeline ID selected when doing the sandbox sync"
110
+ },
111
+ "manifestId": {
112
+ "type": "string",
113
+ "description": "ID of the installed manifest to load the resource addresses from"
148
114
  }
115
+ },
116
+ "required": [
117
+ "resources"
149
118
  ]
150
119
  }
151
120
  }
@@ -383,11 +352,19 @@
383
352
  },
384
353
  "sourceManifestId": {
385
354
  "type": "string"
355
+ },
356
+ "sourceOrganizationType": {
357
+ "type": "string",
358
+ "enum": [
359
+ "sandbox",
360
+ "production"
361
+ ]
386
362
  }
387
363
  },
388
364
  "required": [
389
365
  "sourceOrganizationId",
390
- "sourceManifestId"
366
+ "sourceManifestId",
367
+ "sourceOrganizationType"
391
368
  ]
392
369
  }
393
370
  },
@@ -446,11 +423,19 @@
446
423
  },
447
424
  "sourceManifestId": {
448
425
  "type": "string"
426
+ },
427
+ "sourceOrganizationType": {
428
+ "type": "string",
429
+ "enum": [
430
+ "sandbox",
431
+ "production"
432
+ ]
449
433
  }
450
434
  },
451
435
  "required": [
452
436
  "sourceOrganizationId",
453
- "sourceManifestId"
437
+ "sourceManifestId",
438
+ "sourceOrganizationType"
454
439
  ]
455
440
  }
456
441
  },
@@ -778,11 +763,11 @@
778
763
  "closing_reason",
779
764
  "taxonomy_classification",
780
765
  "webhook",
766
+ "dashboard",
781
767
  "custom_variable",
782
768
  "coupon",
783
769
  "usergroup",
784
770
  "saved_view",
785
- "dashboard",
786
771
  "app"
787
772
  ]
788
773
  },
@@ -1122,6 +1107,13 @@
1122
1107
  "type": "string",
1123
1108
  "description": "ID of the manifest that was deployed"
1124
1109
  },
1110
+ "source_organization_type": {
1111
+ "type": "string",
1112
+ "enum": [
1113
+ "sandbox",
1114
+ "production"
1115
+ ]
1116
+ },
1125
1117
  "last_triggered_at": {
1126
1118
  "type": "string",
1127
1119
  "format": "date-time",
@@ -1129,6 +1121,35 @@
1129
1121
  }
1130
1122
  },
1131
1123
  "description": "Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones"
1124
+ },
1125
+ "deployed_to": {
1126
+ "type": "array",
1127
+ "items": {
1128
+ "type": "object",
1129
+ "properties": {
1130
+ "destination_organization_id": {
1131
+ "type": "string",
1132
+ "description": "ID of the organization that the manifest was deployed to"
1133
+ },
1134
+ "destination_manifest_id": {
1135
+ "type": "string",
1136
+ "description": "ID of the manifest that was deployed to"
1137
+ },
1138
+ "destination_organization_type": {
1139
+ "type": "string",
1140
+ "enum": [
1141
+ "sandbox",
1142
+ "production"
1143
+ ]
1144
+ },
1145
+ "last_triggered_at": {
1146
+ "type": "string",
1147
+ "format": "date-time",
1148
+ "description": "When the deployment was last triggered"
1149
+ }
1150
+ }
1151
+ },
1152
+ "description": "Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones"
1132
1153
  }
1133
1154
  }
1134
1155
  },
@@ -1368,6 +1389,32 @@
1368
1389
  "type": "string"
1369
1390
  },
1370
1391
  "description": "Array of ids of resources selected to be ready by the user"
1392
+ },
1393
+ "deployed_to": {
1394
+ "type": "array",
1395
+ "items": {
1396
+ "type": "object",
1397
+ "properties": {
1398
+ "destination_organization_id": {
1399
+ "type": "string",
1400
+ "description": "ID of the organization that the manifest was deployed to"
1401
+ },
1402
+ "destination_manifest_id": {
1403
+ "type": "string",
1404
+ "description": "ID of the manifest that was deployed to"
1405
+ },
1406
+ "destination_organization_type": {
1407
+ "type": "string",
1408
+ "enum": [
1409
+ "sandbox",
1410
+ "production"
1411
+ ]
1412
+ },
1413
+ "last_triggered_at": {
1414
+ "type": "string"
1415
+ }
1416
+ }
1417
+ }
1371
1418
  }
1372
1419
  }
1373
1420
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "2.9.0",
3
+ "version": "2.9.3",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "test": "jest",
26
26
  "bundle-definition": "webpack",
27
27
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
28
- "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
28
+ "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprints-api/lambda/TerraformHandlerFunction/openapi.yml",
29
29
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
30
30
  "build": "tsc && npm run build:patch && npm run bundle-definition",
31
31
  "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
@@ -73,4 +73,4 @@
73
73
  "webpack-cli": "^4.4.0"
74
74
  },
75
75
  "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
76
- }
76
+ }