@epilot/blueprint-manifest-client 2.3.1 → 2.3.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 +98 -23
  2. package/dist/openapi.json +137 -102
  3. package/package.json +1 -1
package/dist/openapi.d.ts CHANGED
@@ -86,6 +86,28 @@ declare namespace Components {
86
86
  postinstall?: string;
87
87
  };
88
88
  }
89
+ export interface CommonResourceNode {
90
+ /**
91
+ * ID of the resource
92
+ */
93
+ id: string;
94
+ /**
95
+ * Type of the resource
96
+ */
97
+ type: ResourceNodeType;
98
+ /**
99
+ * Name of the resource
100
+ */
101
+ name?: string;
102
+ /**
103
+ * Source ID of the resource
104
+ */
105
+ source_id?: string;
106
+ /**
107
+ * Whether the resource is virtual
108
+ */
109
+ is_virtual?: boolean;
110
+ }
89
111
  export interface Job {
90
112
  job_id?: /**
91
113
  * ID of an import or export job (state machine)
@@ -301,59 +323,106 @@ declare namespace Components {
301
323
  */
302
324
  updated_at?: string; // date-time
303
325
  }
326
+ export type PlanChanges = ("create" | "update" | "no-op" | "delete")[];
304
327
  export interface ResourceNode {
328
+ /**
329
+ * ID of the resource
330
+ */
305
331
  id: string;
306
332
  type: ResourceNodeType;
333
+ /**
334
+ * Name of the resource
335
+ */
307
336
  name?: string;
337
+ /**
338
+ * Original ID of the exported resource
339
+ */
308
340
  source_id?: string;
341
+ /**
342
+ * Whether the resource is virtual
343
+ */
344
+ is_virtual?: boolean;
345
+ /**
346
+ * Terraform address of the resource
347
+ */
309
348
  address?: string;
310
- changes?: ("create" | "update" | "no-op" | "delete")[];
349
+ /**
350
+ * Dependencies of the resource
351
+ */
352
+ dependencies?: ResourceNode[] | null;
311
353
  parents?: {
312
354
  id?: string;
313
355
  type?: ResourceNodeType;
314
356
  }[];
357
+ changes?: PlanChanges;
315
358
  }
316
- export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook";
359
+ export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "custom_variable";
317
360
  export interface RootResourceNode {
361
+ /**
362
+ * ID of the resource
363
+ */
318
364
  id: string;
319
365
  type: ResourceNodeType;
366
+ /**
367
+ * Name of the resource
368
+ */
320
369
  name?: string;
370
+ /**
371
+ * Source ID of the resource
372
+ */
321
373
  source_id?: string;
374
+ /**
375
+ * Whether the resource is virtual
376
+ */
377
+ is_virtual?: boolean;
378
+ /**
379
+ * Terraform address of the resource
380
+ */
322
381
  address?: string;
323
- dependencies?: VirtualResourceNodeGroup[];
324
- changes?: ("create" | "update" | "no-op" | "delete")[];
382
+ /**
383
+ * Dependencies of the resource
384
+ */
385
+ dependencies?: VirtualResourceNodeGroup[] | null;
386
+ changes?: PlanChanges;
325
387
  }
326
388
  export interface S3Reference {
327
389
  /**
328
390
  * example:
329
391
  * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
330
392
  */
331
- bucket?: string;
393
+ bucket: string;
332
394
  /**
333
395
  * example:
334
396
  * templates/main.tf
335
397
  */
336
- key?: string;
398
+ key: string;
337
399
  }
338
400
  export interface UploadFilePayload {
339
401
  /**
340
402
  * example:
341
- * main.tf
403
+ * example.manifest.zip
342
404
  */
343
405
  filename: string;
344
- /**
345
- * MIME type of file
346
- * example:
347
- * application/pdf
348
- */
349
- mime_type?: string;
350
406
  }
351
407
  export interface VirtualResourceNodeGroup {
408
+ /**
409
+ * ID of the resource
410
+ */
352
411
  id: string;
353
412
  type: ResourceNodeType;
413
+ /**
414
+ * Name of the resource
415
+ */
354
416
  name?: string;
417
+ /**
418
+ * Source ID of the resource
419
+ */
420
+ source_id?: string;
421
+ /**
422
+ * Whether the resource is virtual
423
+ */
424
+ is_virtual?: true;
355
425
  dependencies?: ResourceNode[];
356
- is_virtual?: boolean;
357
426
  }
358
427
  }
359
428
  }
@@ -390,8 +459,8 @@ declare namespace Paths {
390
459
  }
391
460
  namespace CreateExport {
392
461
  export interface RequestBody {
393
- resourceType?: Components.Schemas.ResourceNodeType;
394
- resourceIds?: [
462
+ resourceType: Components.Schemas.ResourceNodeType;
463
+ resourceIds: [
395
464
  string,
396
465
  string?,
397
466
  string?,
@@ -450,12 +519,12 @@ declare namespace Paths {
450
519
  * example:
451
520
  * blueprint-manifest-prod-blueprintsv2bucket-sybpsryropzw
452
521
  */
453
- bucket?: string;
522
+ bucket: string;
454
523
  /**
455
524
  * example:
456
525
  * templates/main.tf
457
526
  */
458
- key?: string;
527
+ key: string;
459
528
  };
460
529
  /**
461
530
  * ID of an imported / installed manifest
@@ -465,11 +534,15 @@ declare namespace Paths {
465
534
  manifest_id?: string;
466
535
  } | {
467
536
  /**
468
- * Manifest file key uploaded via `uploadManifest`
469
- * example:
470
- * example.tf
537
+ * Manifest s3 key uploaded via `uploadManifest`
471
538
  */
472
539
  manifestFilePath: string;
540
+ /**
541
+ * ID of an imported / installed manifest
542
+ * example:
543
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
544
+ */
545
+ manifest_id?: string;
473
546
  };
474
547
  namespace Responses {
475
548
  export interface $200 {
@@ -513,12 +586,12 @@ declare namespace Paths {
513
586
  /**
514
587
  * An array of resource IDs to export
515
588
  */
516
- selectedResourceIds?: string[];
589
+ selectedResourceIds: string[];
517
590
  /**
518
591
  * example:
519
592
  * journey_HouseConnectionJourney
520
593
  */
521
- resourceName?: string;
594
+ resourceName: string;
522
595
  /**
523
596
  * Temporary flag to indicate if multiple resources are being exported
524
597
  */
@@ -821,6 +894,7 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
821
894
  export type CommonImportFields = Components.Schemas.CommonImportFields;
822
895
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
823
896
  export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
897
+ export type CommonResourceNode = Components.Schemas.CommonResourceNode;
824
898
  export type Job = Components.Schemas.Job;
825
899
  export type JobID = Components.Schemas.JobID;
826
900
  export type JobStatus = Components.Schemas.JobStatus;
@@ -828,6 +902,7 @@ export type Manifest = Components.Schemas.Manifest;
828
902
  export type ManifestID = Components.Schemas.ManifestID;
829
903
  export type ManifestItem = Components.Schemas.ManifestItem;
830
904
  export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
905
+ export type PlanChanges = Components.Schemas.PlanChanges;
831
906
  export type ResourceNode = Components.Schemas.ResourceNode;
832
907
  export type ResourceNodeType = Components.Schemas.ResourceNodeType;
833
908
  export type RootResourceNode = Components.Schemas.RootResourceNode;
package/dist/openapi.json CHANGED
@@ -96,7 +96,11 @@
96
96
  "type": "boolean",
97
97
  "description": "Temporary flag to indicate if multiple resources are being exported"
98
98
  }
99
- }
99
+ },
100
+ "required": [
101
+ "resourceType",
102
+ "resourceIds"
103
+ ]
100
104
  }
101
105
  }
102
106
  }
@@ -154,7 +158,11 @@
154
158
  "type": "boolean",
155
159
  "description": "Temporary flag to indicate if multiple resources are being exported"
156
160
  }
157
- }
161
+ },
162
+ "required": [
163
+ "resourceName",
164
+ "selectedResourceIds"
165
+ ]
158
166
  }
159
167
  }
160
168
  }
@@ -262,12 +270,22 @@
262
270
  },
263
271
  {
264
272
  "type": "object",
273
+ "deprecated": true,
265
274
  "properties": {
266
275
  "manifestFilePath": {
267
276
  "deprecated": true,
268
- "description": "Manifest file key uploaded via `uploadManifest`",
269
- "type": "string",
270
- "example": "example.tf"
277
+ "description": "Manifest s3 key uploaded via `uploadManifest`",
278
+ "type": "string"
279
+ },
280
+ "manifest_id": {
281
+ "allOf": [
282
+ {
283
+ "description": "Update an existing manifest (optional)"
284
+ },
285
+ {
286
+ "$ref": "#/components/schemas/ManifestID"
287
+ }
288
+ ]
271
289
  }
272
290
  },
273
291
  "required": [
@@ -511,44 +529,44 @@
511
529
  "workflow_definition",
512
530
  "closing_reason",
513
531
  "taxonomy_classification",
514
- "webhook"
532
+ "webhook",
533
+ "custom_variable"
515
534
  ]
516
535
  },
517
- "RootResourceNode": {
536
+ "PlanChanges": {
537
+ "type": "array",
538
+ "items": {
539
+ "type": "string",
540
+ "enum": [
541
+ "create",
542
+ "update",
543
+ "no-op",
544
+ "delete"
545
+ ]
546
+ }
547
+ },
548
+ "CommonResourceNode": {
518
549
  "type": "object",
519
550
  "properties": {
520
551
  "id": {
521
- "type": "string"
552
+ "type": "string",
553
+ "description": "ID of the resource"
522
554
  },
523
555
  "type": {
524
- "$ref": "#/components/schemas/ResourceNodeType"
556
+ "$ref": "#/components/schemas/ResourceNodeType",
557
+ "description": "Type of the resource"
525
558
  },
526
559
  "name": {
527
- "type": "string"
560
+ "type": "string",
561
+ "description": "Name of the resource"
528
562
  },
529
563
  "source_id": {
530
- "type": "string"
531
- },
532
- "address": {
533
- "type": "string"
534
- },
535
- "dependencies": {
536
- "type": "array",
537
- "items": {
538
- "$ref": "#/components/schemas/VirtualResourceNodeGroup"
539
- }
564
+ "type": "string",
565
+ "description": "Source ID of the resource"
540
566
  },
541
- "changes": {
542
- "type": "array",
543
- "items": {
544
- "type": "string",
545
- "enum": [
546
- "create",
547
- "update",
548
- "no-op",
549
- "delete"
550
- ]
551
- }
567
+ "is_virtual": {
568
+ "type": "boolean",
569
+ "description": "Whether the resource is virtual"
552
570
  }
553
571
  },
554
572
  "required": [
@@ -556,81 +574,100 @@
556
574
  "type"
557
575
  ]
558
576
  },
559
- "VirtualResourceNodeGroup": {
560
- "type": "object",
561
- "properties": {
562
- "id": {
563
- "type": "string"
564
- },
565
- "type": {
566
- "$ref": "#/components/schemas/ResourceNodeType"
567
- },
568
- "name": {
569
- "type": "string"
577
+ "RootResourceNode": {
578
+ "allOf": [
579
+ {
580
+ "$ref": "#/components/schemas/CommonResourceNode"
570
581
  },
571
- "dependencies": {
572
- "type": "array",
573
- "items": {
574
- "$ref": "#/components/schemas/ResourceNode"
582
+ {
583
+ "type": "object",
584
+ "properties": {
585
+ "address": {
586
+ "type": "string",
587
+ "description": "Terraform address of the resource"
588
+ },
589
+ "dependencies": {
590
+ "type": "array",
591
+ "items": {
592
+ "$ref": "#/components/schemas/VirtualResourceNodeGroup"
593
+ },
594
+ "description": "Dependencies of the resource",
595
+ "nullable": true
596
+ },
597
+ "changes": {
598
+ "$ref": "#/components/schemas/PlanChanges"
599
+ }
575
600
  }
576
- },
577
- "is_virtual": {
578
- "type": "boolean"
579
601
  }
580
- },
581
- "required": [
582
- "id",
583
- "type"
584
602
  ]
585
603
  },
586
- "ResourceNode": {
587
- "type": "object",
588
- "properties": {
589
- "id": {
590
- "type": "string"
591
- },
592
- "type": {
593
- "$ref": "#/components/schemas/ResourceNodeType"
594
- },
595
- "name": {
596
- "type": "string"
597
- },
598
- "source_id": {
599
- "type": "string"
600
- },
601
- "address": {
602
- "type": "string"
604
+ "VirtualResourceNodeGroup": {
605
+ "allOf": [
606
+ {
607
+ "$ref": "#/components/schemas/CommonResourceNode"
603
608
  },
604
- "changes": {
605
- "type": "array",
606
- "items": {
607
- "type": "string",
608
- "enum": [
609
- "create",
610
- "update",
611
- "no-op",
612
- "delete"
613
- ]
609
+ {
610
+ "type": "object",
611
+ "properties": {
612
+ "dependencies": {
613
+ "type": "array",
614
+ "items": {
615
+ "$ref": "#/components/schemas/ResourceNode"
616
+ }
617
+ },
618
+ "is_virtual": {
619
+ "type": "boolean",
620
+ "enum": [
621
+ true
622
+ ]
623
+ }
614
624
  }
625
+ }
626
+ ]
627
+ },
628
+ "ResourceNode": {
629
+ "allOf": [
630
+ {
631
+ "$ref": "#/components/schemas/CommonResourceNode"
615
632
  },
616
- "parents": {
617
- "type": "array",
618
- "items": {
619
- "type": "object",
620
- "properties": {
621
- "id": {
622
- "type": "string"
633
+ {
634
+ "type": "object",
635
+ "properties": {
636
+ "address": {
637
+ "type": "string",
638
+ "description": "Terraform address of the resource"
639
+ },
640
+ "dependencies": {
641
+ "type": "array",
642
+ "items": {
643
+ "$ref": "#/components/schemas/ResourceNode"
623
644
  },
624
- "type": {
625
- "$ref": "#/components/schemas/ResourceNodeType"
645
+ "description": "Dependencies of the resource",
646
+ "nullable": true
647
+ },
648
+ "parents": {
649
+ "type": "array",
650
+ "items": {
651
+ "type": "object",
652
+ "properties": {
653
+ "id": {
654
+ "type": "string"
655
+ },
656
+ "type": {
657
+ "$ref": "#/components/schemas/ResourceNodeType"
658
+ }
659
+ }
626
660
  }
661
+ },
662
+ "source_id": {
663
+ "description": "Original ID of the exported resource",
664
+ "type": "string"
665
+ },
666
+ "changes": {
667
+ "$ref": "#/components/schemas/PlanChanges"
627
668
  }
628
669
  }
629
670
  }
630
- },
631
- "required": [
632
- "id",
633
- "type"
634
671
  ]
635
672
  },
636
673
  "Job": {
@@ -709,13 +746,7 @@
709
746
  "properties": {
710
747
  "filename": {
711
748
  "type": "string",
712
- "example": "main.tf"
713
- },
714
- "mime_type": {
715
- "description": "MIME type of file",
716
- "type": "string",
717
- "example": "application/pdf",
718
- "default": "application/octet-stream"
749
+ "example": "example.manifest.zip"
719
750
  }
720
751
  },
721
752
  "required": [
@@ -733,7 +764,11 @@
733
764
  "type": "string",
734
765
  "example": "templates/main.tf"
735
766
  }
736
- }
767
+ },
768
+ "required": [
769
+ "bucket",
770
+ "key"
771
+ ]
737
772
  },
738
773
  "CommonManifestFields": {
739
774
  "type": "object",
@@ -807,7 +842,7 @@
807
842
  "manifest": {
808
843
  "type": "string",
809
844
  "description": "Markdown content shown before installing the manifest",
810
- "example": "This is the content of the manifest.md file which contains the manifest descripton. \n"
845
+ "example": "This is the content of the manifest.md file which contains the manifest descripton.\n"
811
846
  },
812
847
  "preinstall": {
813
848
  "type": "string",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "2.3.1",
3
+ "version": "2.3.3",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",