@epilot/blueprint-manifest-client 2.9.0 → 2.9.2
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/dist/openapi.d.ts +95 -26
- package/dist/openapi.json +110 -70
- 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" | "
|
|
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,7 +896,7 @@ declare namespace Paths {
|
|
|
808
896
|
}
|
|
809
897
|
}
|
|
810
898
|
namespace CreateExport {
|
|
811
|
-
export
|
|
899
|
+
export interface RequestBody {
|
|
812
900
|
resourceType: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
813
901
|
resourceIds: [
|
|
814
902
|
string,
|
|
@@ -876,32 +964,11 @@ declare namespace Paths {
|
|
|
876
964
|
* Pipeline ID selected when doing the sandbox sync
|
|
877
965
|
*/
|
|
878
966
|
pipelineId?: string;
|
|
879
|
-
} | {
|
|
880
|
-
resources: [
|
|
881
|
-
{
|
|
882
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
883
|
-
id: string;
|
|
884
|
-
},
|
|
885
|
-
...{
|
|
886
|
-
type: /* Type of the resource */ Components.Schemas.ResourceNodeType;
|
|
887
|
-
id: string;
|
|
888
|
-
}[]
|
|
889
|
-
];
|
|
890
|
-
jobId?: /**
|
|
891
|
-
* ID of an import or export job (state machine)
|
|
892
|
-
* example:
|
|
893
|
-
* 4854bb2a-94f9-424d-a968-3fb17fb0bf89
|
|
894
|
-
*/
|
|
895
|
-
Components.Schemas.JobID;
|
|
896
967
|
/**
|
|
897
|
-
*
|
|
898
|
-
*/
|
|
899
|
-
isExportingMultipleResources?: boolean;
|
|
900
|
-
/**
|
|
901
|
-
* Pipeline ID selected when doing the sandbox sync
|
|
968
|
+
* ID of the installed manifest to load the resource addresses from
|
|
902
969
|
*/
|
|
903
|
-
|
|
904
|
-
}
|
|
970
|
+
manifestId?: string;
|
|
971
|
+
}
|
|
905
972
|
namespace Responses {
|
|
906
973
|
export interface $200 {
|
|
907
974
|
jobId?: /**
|
|
@@ -951,6 +1018,7 @@ declare namespace Paths {
|
|
|
951
1018
|
deployedFrom?: {
|
|
952
1019
|
sourceOrganizationId: string;
|
|
953
1020
|
sourceManifestId: string;
|
|
1021
|
+
sourceOrganizationType: "sandbox" | "production";
|
|
954
1022
|
};
|
|
955
1023
|
} | {
|
|
956
1024
|
/**
|
|
@@ -978,6 +1046,7 @@ declare namespace Paths {
|
|
|
978
1046
|
deployedFrom?: {
|
|
979
1047
|
sourceOrganizationId: string;
|
|
980
1048
|
sourceManifestId: string;
|
|
1049
|
+
sourceOrganizationType: "sandbox" | "production";
|
|
981
1050
|
};
|
|
982
1051
|
};
|
|
983
1052
|
namespace Responses {
|
package/dist/openapi.json
CHANGED
|
@@ -76,76 +76,38 @@
|
|
|
76
76
|
"content": {
|
|
77
77
|
"application/json": {
|
|
78
78
|
"schema": {
|
|
79
|
-
"
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
"
|
|
83
|
-
"resourceType": {
|
|
84
|
-
"$ref": "#/components/schemas/ResourceNodeType"
|
|
85
|
-
},
|
|
86
|
-
"resourceIds": {
|
|
87
|
-
"type": "array",
|
|
88
|
-
"items": {
|
|
89
|
-
"type": "string"
|
|
90
|
-
},
|
|
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"
|
|
100
|
-
},
|
|
101
|
-
"pipelineId": {
|
|
102
|
-
"type": "string",
|
|
103
|
-
"description": "Pipeline ID selected when doing the sandbox sync"
|
|
104
|
-
}
|
|
105
|
-
},
|
|
106
|
-
"required": [
|
|
107
|
-
"resourceType",
|
|
108
|
-
"resourceIds"
|
|
109
|
-
]
|
|
79
|
+
"type": "object",
|
|
80
|
+
"properties": {
|
|
81
|
+
"resourceType": {
|
|
82
|
+
"$ref": "#/components/schemas/ResourceNodeType"
|
|
110
83
|
},
|
|
111
|
-
{
|
|
112
|
-
"type": "
|
|
113
|
-
"
|
|
114
|
-
"
|
|
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
|
-
}
|
|
84
|
+
"resourceIds": {
|
|
85
|
+
"type": "array",
|
|
86
|
+
"items": {
|
|
87
|
+
"type": "string"
|
|
144
88
|
},
|
|
145
|
-
"
|
|
146
|
-
|
|
147
|
-
|
|
89
|
+
"minItems": 1,
|
|
90
|
+
"maxItems": 50
|
|
91
|
+
},
|
|
92
|
+
"jobId": {
|
|
93
|
+
"$ref": "#/components/schemas/JobID"
|
|
94
|
+
},
|
|
95
|
+
"isExportingMultipleResources": {
|
|
96
|
+
"type": "boolean",
|
|
97
|
+
"description": "Temporary flag to indicate if multiple resources are being exported"
|
|
98
|
+
},
|
|
99
|
+
"pipelineId": {
|
|
100
|
+
"type": "string",
|
|
101
|
+
"description": "Pipeline ID selected when doing the sandbox sync"
|
|
102
|
+
},
|
|
103
|
+
"manifestId": {
|
|
104
|
+
"type": "string",
|
|
105
|
+
"description": "ID of the installed manifest to load the resource addresses from"
|
|
148
106
|
}
|
|
107
|
+
},
|
|
108
|
+
"required": [
|
|
109
|
+
"resourceType",
|
|
110
|
+
"resourceIds"
|
|
149
111
|
]
|
|
150
112
|
}
|
|
151
113
|
}
|
|
@@ -383,11 +345,19 @@
|
|
|
383
345
|
},
|
|
384
346
|
"sourceManifestId": {
|
|
385
347
|
"type": "string"
|
|
348
|
+
},
|
|
349
|
+
"sourceOrganizationType": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"enum": [
|
|
352
|
+
"sandbox",
|
|
353
|
+
"production"
|
|
354
|
+
]
|
|
386
355
|
}
|
|
387
356
|
},
|
|
388
357
|
"required": [
|
|
389
358
|
"sourceOrganizationId",
|
|
390
|
-
"sourceManifestId"
|
|
359
|
+
"sourceManifestId",
|
|
360
|
+
"sourceOrganizationType"
|
|
391
361
|
]
|
|
392
362
|
}
|
|
393
363
|
},
|
|
@@ -446,11 +416,19 @@
|
|
|
446
416
|
},
|
|
447
417
|
"sourceManifestId": {
|
|
448
418
|
"type": "string"
|
|
419
|
+
},
|
|
420
|
+
"sourceOrganizationType": {
|
|
421
|
+
"type": "string",
|
|
422
|
+
"enum": [
|
|
423
|
+
"sandbox",
|
|
424
|
+
"production"
|
|
425
|
+
]
|
|
449
426
|
}
|
|
450
427
|
},
|
|
451
428
|
"required": [
|
|
452
429
|
"sourceOrganizationId",
|
|
453
|
-
"sourceManifestId"
|
|
430
|
+
"sourceManifestId",
|
|
431
|
+
"sourceOrganizationType"
|
|
454
432
|
]
|
|
455
433
|
}
|
|
456
434
|
},
|
|
@@ -778,11 +756,11 @@
|
|
|
778
756
|
"closing_reason",
|
|
779
757
|
"taxonomy_classification",
|
|
780
758
|
"webhook",
|
|
759
|
+
"dashboard",
|
|
781
760
|
"custom_variable",
|
|
782
761
|
"coupon",
|
|
783
762
|
"usergroup",
|
|
784
763
|
"saved_view",
|
|
785
|
-
"dashboard",
|
|
786
764
|
"app"
|
|
787
765
|
]
|
|
788
766
|
},
|
|
@@ -1122,6 +1100,13 @@
|
|
|
1122
1100
|
"type": "string",
|
|
1123
1101
|
"description": "ID of the manifest that was deployed"
|
|
1124
1102
|
},
|
|
1103
|
+
"source_organization_type": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"enum": [
|
|
1106
|
+
"sandbox",
|
|
1107
|
+
"production"
|
|
1108
|
+
]
|
|
1109
|
+
},
|
|
1125
1110
|
"last_triggered_at": {
|
|
1126
1111
|
"type": "string",
|
|
1127
1112
|
"format": "date-time",
|
|
@@ -1129,6 +1114,35 @@
|
|
|
1129
1114
|
}
|
|
1130
1115
|
},
|
|
1131
1116
|
"description": "Information about the manifest that was deployed from, used to update existing deployments instead of always creating new ones"
|
|
1117
|
+
},
|
|
1118
|
+
"deployed_to": {
|
|
1119
|
+
"type": "array",
|
|
1120
|
+
"items": {
|
|
1121
|
+
"type": "object",
|
|
1122
|
+
"properties": {
|
|
1123
|
+
"destination_organization_id": {
|
|
1124
|
+
"type": "string",
|
|
1125
|
+
"description": "ID of the organization that the manifest was deployed to"
|
|
1126
|
+
},
|
|
1127
|
+
"destination_manifest_id": {
|
|
1128
|
+
"type": "string",
|
|
1129
|
+
"description": "ID of the manifest that was deployed to"
|
|
1130
|
+
},
|
|
1131
|
+
"destination_organization_type": {
|
|
1132
|
+
"type": "string",
|
|
1133
|
+
"enum": [
|
|
1134
|
+
"sandbox",
|
|
1135
|
+
"production"
|
|
1136
|
+
]
|
|
1137
|
+
},
|
|
1138
|
+
"last_triggered_at": {
|
|
1139
|
+
"type": "string",
|
|
1140
|
+
"format": "date-time",
|
|
1141
|
+
"description": "When the deployment was last triggered"
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
},
|
|
1145
|
+
"description": "Information about the manifest that was deployed to, used to update existing deployments instead of always creating new ones"
|
|
1132
1146
|
}
|
|
1133
1147
|
}
|
|
1134
1148
|
},
|
|
@@ -1368,6 +1382,32 @@
|
|
|
1368
1382
|
"type": "string"
|
|
1369
1383
|
},
|
|
1370
1384
|
"description": "Array of ids of resources selected to be ready by the user"
|
|
1385
|
+
},
|
|
1386
|
+
"deployed_to": {
|
|
1387
|
+
"type": "array",
|
|
1388
|
+
"items": {
|
|
1389
|
+
"type": "object",
|
|
1390
|
+
"properties": {
|
|
1391
|
+
"destination_organization_id": {
|
|
1392
|
+
"type": "string",
|
|
1393
|
+
"description": "ID of the organization that the manifest was deployed to"
|
|
1394
|
+
},
|
|
1395
|
+
"destination_manifest_id": {
|
|
1396
|
+
"type": "string",
|
|
1397
|
+
"description": "ID of the manifest that was deployed to"
|
|
1398
|
+
},
|
|
1399
|
+
"destination_organization_type": {
|
|
1400
|
+
"type": "string",
|
|
1401
|
+
"enum": [
|
|
1402
|
+
"sandbox",
|
|
1403
|
+
"production"
|
|
1404
|
+
]
|
|
1405
|
+
},
|
|
1406
|
+
"last_triggered_at": {
|
|
1407
|
+
"type": "string"
|
|
1408
|
+
}
|
|
1409
|
+
}
|
|
1410
|
+
}
|
|
1371
1411
|
}
|
|
1372
1412
|
}
|
|
1373
1413
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/blueprint-manifest-client",
|
|
3
|
-
"version": "2.9.
|
|
3
|
+
"version": "2.9.2",
|
|
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 ../../../
|
|
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
|
+
}
|