@stack-spot/portal-network 0.16.0 → 0.17.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.
@@ -53,11 +53,11 @@ export type WorkspaceWorkflowCreateRequest = {
53
53
  };
54
54
  export type WorkspaceVariableReadResponse = {
55
55
  /** Workspace variable name. */
56
- name?: string;
56
+ name: string;
57
57
  /** Workspace variable value. */
58
- value?: string;
58
+ value: string;
59
59
  /** Workspace variable description. */
60
- description?: string;
60
+ description: string;
61
61
  };
62
62
  export type UpdateWorkspaceVariableRequest = {
63
63
  /** Workspace variable value. */
@@ -75,7 +75,7 @@ export type AttributesByEnv = {
75
75
  attributes: PluginAttribute[];
76
76
  };
77
77
  export type AddTypedContextRequest = {
78
- attributesByEnv?: AttributesByEnv;
78
+ attributesByEnv: AttributesByEnv;
79
79
  };
80
80
  export type WorkflowActionResponse = {
81
81
  actionVersionId: string;
@@ -92,17 +92,17 @@ export type WorkflowReadResponse = {
92
92
  };
93
93
  export type WorkflowActionsRequest = {
94
94
  /** Workflow action version id. */
95
- actionVersionId?: string;
95
+ actionVersionId: string;
96
96
  /** Workspace order step. */
97
- orderStep?: number;
97
+ orderStep: number;
98
98
  /** This action will create repository. */
99
- createRepo?: boolean;
99
+ createRepo: boolean;
100
100
  };
101
101
  export type WorkflowConditionRequest = {
102
102
  /** Workflow condition. */
103
- condition?: "BEFORE" | "AFTER";
103
+ condition: "BEFORE" | "AFTER";
104
104
  /** Workflow actions. */
105
- actions?: WorkflowActionsRequest[];
105
+ actions: WorkflowActionsRequest[];
106
106
  };
107
107
  export type AddWorkspaceWorkflowStepRequest = {
108
108
  /** Workflow identifier. */
@@ -111,19 +111,19 @@ export type AddWorkspaceWorkflowStepRequest = {
111
111
  };
112
112
  export type ImportContextRequest = {
113
113
  /** Context type (PLUGIN, ACTION). */
114
- "type"?: "PLUGIN" | "ACTION";
114
+ "type": "PLUGIN" | "ACTION";
115
115
  /** PluginId. */
116
- externalId?: string;
116
+ externalId: string;
117
117
  /** Input attributes by environments. */
118
- attributesByEnv?: AttributesByEnv[];
118
+ attributesByEnv: AttributesByEnv[];
119
119
  };
120
120
  export type UpdateSharedInfraStatusRequest = {
121
121
  /** Shared Infrastructure Status. */
122
- status?: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED";
122
+ status: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED";
123
123
  };
124
124
  export type IdResponse = {
125
125
  /** Id response. */
126
- id?: string;
126
+ id: string;
127
127
  };
128
128
  export type SharedInfraVisibleLinksResponse = {
129
129
  id: string;
@@ -175,23 +175,23 @@ export type PluginsStatusInCloud = {
175
175
  };
176
176
  export type UpdateRunRequest = {
177
177
  /** Activity status to update. */
178
- status?: "RUNNING" | "SUCCEEDED" | "USER_ERROR" | "RUNTIME_ERROR" | "EXTERNAL_ERROR" | "ABORTED" | "ABORTING";
178
+ status: "RUNNING" | "SUCCEEDED" | "USER_ERROR" | "RUNTIME_ERROR" | "EXTERNAL_ERROR" | "ABORTED" | "ABORTING";
179
179
  /** Message. */
180
180
  message?: string;
181
181
  /** List of plugins that contain in deploy, rollback or destroy. */
182
- plugins?: Plugins[];
182
+ plugins: Plugins[];
183
183
  /** List of plugins in cloud. */
184
- pluginsStatusInCloud?: PluginsStatusInCloud[];
184
+ pluginsStatusInCloud: PluginsStatusInCloud[];
185
185
  };
186
186
  export type RunTaskRequest = {
187
187
  /** Plugin Id. */
188
- runTaskId?: string;
188
+ runTaskId: string;
189
189
  /** Plugin type. */
190
- "type"?: "IAC" | "DEPLOY" | "DESTROY" | "IAC_SELF_HOSTED" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED";
190
+ "type": "IAC" | "DEPLOY" | "DESTROY" | "IAC_SELF_HOSTED" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED";
191
191
  /** Plugin status to update. */
192
- status?: "EXTERNAL_ERROR" | "INTERNAL_ERROR" | "ABORTED" | "FAILED" | "SUCCEEDED" | "RUNNING" | "PENDING" | "READY_TO_RUN";
192
+ status: "EXTERNAL_ERROR" | "INTERNAL_ERROR" | "ABORTED" | "FAILED" | "SUCCEEDED" | "RUNNING" | "PENDING" | "READY_TO_RUN";
193
193
  /** Plugin Alias. */
194
- pluginAlias?: string;
194
+ pluginAlias: string;
195
195
  /** Add message when plugin deployment gives error. */
196
196
  message?: string;
197
197
  };
@@ -201,27 +201,27 @@ export type DeploymentTagRequest = {
201
201
  /** Shared Infra id. */
202
202
  sharedInfrastructureId?: string;
203
203
  /** Related tag. */
204
- relatedTag?: string;
204
+ relatedTag: string;
205
205
  };
206
206
  export type ConnectionInterfaceAttribute = {
207
207
  /** Attribute key. */
208
- key?: string;
208
+ key: string;
209
209
  /** Attribute value. */
210
- value?: object;
210
+ value: object;
211
211
  /** Indicates if this attribute value is sensitive or not. */
212
- sensitive?: boolean;
212
+ sensitive: boolean;
213
213
  };
214
214
  export type UpdateConnectionInterfaceAttributesRequest = {
215
215
  /** Environment id. */
216
- environmentId?: string;
216
+ environmentId: string;
217
217
  /** List of attributes */
218
- attributes?: ConnectionInterfaceAttribute[];
218
+ attributes: ConnectionInterfaceAttribute[];
219
219
  };
220
220
  export type ConnectionInterfaceAttributesByEnv = {
221
221
  /** Environment id. */
222
- environmentId?: string;
222
+ environmentId: string;
223
223
  /** List of attributes */
224
- attributes?: ConnectionInterfaceAttribute[];
224
+ attributes: ConnectionInterfaceAttribute[];
225
225
  };
226
226
  export type UpsertConnectionInterfaceRequest = {
227
227
  applicationId?: string;
@@ -233,7 +233,7 @@ export type UpsertConnectionInterfaceRequest = {
233
233
  };
234
234
  export type UpdateApplicationStatusRequest = {
235
235
  /** Application Status. */
236
- status?: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED" | "ARCHIVING" | "ARCHIVED" | "ARCHIVE_FAILED";
236
+ status: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED" | "ARCHIVING" | "ARCHIVED" | "ARCHIVE_FAILED";
237
237
  };
238
238
  export type ApplicationVisibleLinksResponse = {
239
239
  id: string;
@@ -296,29 +296,61 @@ export type StackWorkflowCreateRequest = {
296
296
  actionsBefore: WorkflowActionContextRequest[];
297
297
  actionsAfter: WorkflowActionContextRequest[];
298
298
  };
299
+ export type EnvironmentSimpleResponse = {
300
+ /** Environment id. */
301
+ id: string;
302
+ /** Environment name. */
303
+ name: string;
304
+ };
305
+ export type TargetByPluginUsageResponse = {
306
+ /** Plugin Version ID. */
307
+ pluginVersionId: string;
308
+ environment: EnvironmentSimpleResponse;
309
+ };
310
+ export type WorkspaceResponse = {
311
+ /** Workspace id. */
312
+ id: string;
313
+ /** Workspace name */
314
+ name: string;
315
+ /** Workspace description */
316
+ description?: string;
317
+ /** Workspace image */
318
+ imageUrl?: string;
319
+ };
320
+ export type PluginUsageByTargetResponse = {
321
+ /** Application id. */
322
+ id: string;
323
+ /** Application name. */
324
+ name: string;
325
+ /** Application description. */
326
+ description?: string;
327
+ /** Amount of linked versions. */
328
+ totalLinkedVersions: number;
329
+ workspace: WorkspaceResponse;
330
+ };
299
331
  export type WorkspaceReadResponse = {
300
332
  /** Workspace id. */
301
- id?: string;
333
+ id: string;
302
334
  /** Workspace name. */
303
- name?: string;
335
+ name: string;
304
336
  /** Workspace description. */
305
337
  description?: string;
306
338
  /** Workspace image URL. */
307
339
  imageUrl?: string;
308
340
  /** Workspace manage runtime. */
309
- manageRuntime?: boolean;
341
+ manageRuntime: boolean;
310
342
  /** Workspace accountId. */
311
- accountId?: string;
343
+ accountId: string;
312
344
  /** Workspace teams. - deprecated field */
313
345
  teams?: string[];
314
346
  /** Workspace creator. */
315
- createdBy?: string;
347
+ createdBy: string;
316
348
  /** Workspace creation date. */
317
- createdAt?: string;
349
+ createdAt: string;
318
350
  /** Workspace updater. */
319
- updatedBy?: string;
351
+ updatedBy: string;
320
352
  /** Workspace update date. */
321
- updatedAt?: string;
353
+ updatedAt: string;
322
354
  };
323
355
  export type NewWorkspaceRequest = {
324
356
  /** Workspace name. */
@@ -328,7 +360,7 @@ export type NewWorkspaceRequest = {
328
360
  /** Workspace image base64. */
329
361
  image?: string;
330
362
  /** Workspace manage runtime. */
331
- manageRuntime?: boolean;
363
+ manageRuntime: boolean;
332
364
  };
333
365
  export type NewWorkspaceVariableRequest = {
334
366
  /** Workspace variable name. */
@@ -340,11 +372,11 @@ export type NewWorkspaceVariableRequest = {
340
372
  };
341
373
  export type StackInWorkspaceReadResponse = {
342
374
  /** Stack version id. */
343
- stackVersionId?: string;
375
+ stackVersionId: string;
344
376
  /** Workspace id. */
345
- workspaceId?: string;
377
+ workspaceId: string;
346
378
  /** Account id. */
347
- accountId?: string;
379
+ accountId: string;
348
380
  };
349
381
  export type AddStackInWorkspaceRequest = {
350
382
  /** Stack version id. */
@@ -356,37 +388,37 @@ export type StackVersionResponse = {
356
388
  };
357
389
  export type StackWithWorkspaceContextResponse = {
358
390
  /** List of stack version with pluginVersionId list that has workspace context. */
359
- stackVersions?: StackVersionResponse[];
391
+ stackVersions: StackVersionResponse[];
360
392
  /** Workspace id. */
361
- workspaceId?: string;
393
+ workspaceId: string;
362
394
  /** Account id. */
363
- accountId?: string;
395
+ accountId: string;
364
396
  };
365
397
  export type SharedInfraDetailsResponse = {
366
398
  /** Shared infrastructure id. */
367
- id?: string;
399
+ id: string;
368
400
  /** Shared infrastructure name. */
369
- name?: string;
401
+ name: string;
370
402
  /** Shared infrastructure description. */
371
403
  description?: string;
372
404
  /** Shared infrastructure repository url. */
373
405
  repoUrl?: string;
374
406
  /** Shared infrastructure repository base branch. */
375
- repoBaseBranch?: string;
407
+ repoBaseBranch: string;
376
408
  /** Stack used to generate this shared infrastructure. */
377
- stackVersionId?: string;
409
+ stackVersionId: string;
378
410
  /** Starter used to generate this shared infrastructure. */
379
411
  starterId?: string;
380
412
  /** Shared Infrastructure status. */
381
- status?: string;
413
+ status: string;
382
414
  /** Shared Infrastructure creator. */
383
- createdBy?: string;
415
+ createdBy: string;
384
416
  /** Shared Infrastructure creation date. */
385
- createdAt?: string;
417
+ createdAt: string;
386
418
  /** Shared Infrastructure updater. */
387
- updatedBy?: string;
419
+ updatedBy: string;
388
420
  /** Shared Infrastructure update date. */
389
- updatedAt?: string;
421
+ updatedAt: string;
390
422
  };
391
423
  export type CreateSharedInfraRequest = {
392
424
  /** Shared infrastructure name. */
@@ -398,7 +430,7 @@ export type CreateSharedInfraRequest = {
398
430
  /** Shared infrastructure repository base branch. */
399
431
  repoBaseBranch: string;
400
432
  /** Stack used to generate this shared infrastructure. */
401
- stackVersionId?: string;
433
+ stackVersionId: string;
402
434
  /** Starter used to generate this shared infrastructure. */
403
435
  starterId?: string;
404
436
  };
@@ -412,7 +444,7 @@ export type RecreateSharedInfraRequest = {
412
444
  /** Shared infrastructure repository base branch. */
413
445
  repoBaseBranch: string;
414
446
  /** Stack used to generate this shared infrastructure. */
415
- stackVersionId?: string;
447
+ stackVersionId: string;
416
448
  /** Starter used to generate this shared infrastructure. */
417
449
  starterId?: string;
418
450
  };
@@ -428,11 +460,11 @@ export type UpdateSharedInfraRequest = {
428
460
  };
429
461
  export type SharedInfraLinkReadResponse = {
430
462
  /** Shared infra link id. */
431
- id?: string;
463
+ id: string;
432
464
  /** Shared infra link name. */
433
- name?: string;
465
+ name: string;
434
466
  /** Shared infra link url. */
435
- url?: string;
467
+ url: string;
436
468
  /** Shared infra link image URL. */
437
469
  imageUrl?: string;
438
470
  };
@@ -440,7 +472,7 @@ export type CreateSharedInfraLinkRequest = {
440
472
  /** Shared infra link name. */
441
473
  name: string;
442
474
  /** Shared infra URL. */
443
- url?: string;
475
+ url: string;
444
476
  /** Shared infra image base64. */
445
477
  image?: string;
446
478
  };
@@ -461,41 +493,41 @@ export type PluginElementSnapshot = {
461
493
  };
462
494
  export type SharedInfraDeploySnapshotRequest = {
463
495
  /** Deployment Id. */
464
- deploymentId?: string;
496
+ deploymentId: string;
465
497
  /** Deployment Id. */
466
- environmentId?: string;
498
+ environmentId: string;
467
499
  /** Input attributes for applied app plugin. */
468
- plugins?: PluginElementSnapshot[];
500
+ plugins: PluginElementSnapshot[];
469
501
  };
470
502
  export type StartRunRequest = {
471
503
  /** Requestor's email. */
472
- requestedBy?: string;
504
+ requestedBy: string;
473
505
  /** Action to perform. */
474
- action?: "CREATE" | "UPDATE" | "DELETE" | "RUN";
506
+ action: "CREATE" | "UPDATE" | "DELETE" | "RUN";
475
507
  /** Run ID. */
476
- runId?: string;
508
+ runId: string;
477
509
  /** Environment id. */
478
- environmentId?: string;
510
+ environmentId: string;
479
511
  /** Application id. */
480
512
  applicationId?: string;
481
513
  /** Shared Infra id. */
482
514
  sharedInfrastructureId?: string;
483
515
  /** Deploy type. */
484
- "type"?: "DEPLOY" | "ROLLBACK" | "DESTROY" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED" | "ROLLBACK_SELF_HOSTED";
516
+ "type": "DEPLOY" | "ROLLBACK" | "DESTROY" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED" | "ROLLBACK_SELF_HOSTED";
485
517
  /** Pipeline URL for self hosted deployment. */
486
518
  pipelineLink?: string;
487
519
  /** Application Manifest. */
488
520
  appManifesto?: string;
489
521
  /** List of plugins that contain in deploy, rollback or destroy. */
490
- plugins?: Plugins[];
522
+ plugins: Plugins[];
491
523
  };
492
524
  export type WorkspaceLinkReadResponse = {
493
525
  /** Shared infra link id. */
494
- id?: string;
526
+ id: string;
495
527
  /** Workspace link name. */
496
- name?: string;
528
+ name: string;
497
529
  /** Workspace link url. */
498
- url?: string;
530
+ url: string;
499
531
  /** Workspace link image URL. */
500
532
  imageUrl?: string;
501
533
  };
@@ -503,17 +535,17 @@ export type CreateWorkspaceLinkRequest = {
503
535
  /** Workspace link name. */
504
536
  name: string;
505
537
  /** Workspace link URL. */
506
- url?: string;
538
+ url: string;
507
539
  /** Workspace link image base64. */
508
540
  image?: string;
509
541
  };
510
542
  export type WorkspaceEmbeddedLinkReadResponse = {
511
543
  /** Workspace embedded link id. */
512
- id?: string;
544
+ id: string;
513
545
  /** Workspace embedded link name. */
514
- name?: string;
546
+ name: string;
515
547
  /** Workspace embedded link url. */
516
- url?: string;
548
+ url: string;
517
549
  /** Workspace embedded link image URL. */
518
550
  imageUrl?: string;
519
551
  /** Workspace embedded link layout. */
@@ -523,31 +555,31 @@ export type CreateWorkspaceEmbeddedLinkRequest = {
523
555
  /** Workspace embedded link name. */
524
556
  name: string;
525
557
  /** Workspace embedded link URL. */
526
- url?: string;
558
+ url: string;
527
559
  /** Workspace embedded link image base64. */
528
560
  image?: string;
529
561
  };
530
562
  export type ConnectionInterfaceSummaryResponse = {
531
563
  /** Connection interface id. */
532
- id?: string;
564
+ id: string;
533
565
  /** Connection interface id type generate by client. */
534
- typeId?: string;
566
+ typeId: string;
535
567
  /** Shared infra that was used to generated this Connection interface. */
536
568
  sharedInfraId?: string;
537
569
  /** Application that was used to generated this Connection interface. */
538
570
  applicationId?: string;
539
571
  /** Connection interface id generated by client. */
540
- connectionInterfaceId?: string;
572
+ connectionInterfaceId: string;
541
573
  /** Indicates if this connection interface was generated by a plugin or manually. */
542
- automaticallyGenerated?: boolean;
574
+ automaticallyGenerated: boolean;
543
575
  /** The version ID of the plugin that generated this. */
544
576
  sourcePluginVersionId?: string;
545
577
  };
546
578
  export type CreateConnectionInterfaceRequest = {
547
579
  /** Connection interface type id. */
548
- typeId?: string;
580
+ typeId: string;
549
581
  /** Connection interface id generated by client. */
550
- connectionInterfaceId?: string;
582
+ connectionInterfaceId: string;
551
583
  /** Connection interface owner applications. */
552
584
  applicationId?: string;
553
585
  /** Connection interface owner shared infra. */
@@ -555,41 +587,39 @@ export type CreateConnectionInterfaceRequest = {
555
587
  /** Version id from plugin that generated this connection interface. */
556
588
  sourcePluginVersionId?: string;
557
589
  /** Indicates if this connection interface was generated by a plugin or manually. */
558
- automaticallyGenerated?: boolean;
590
+ automaticallyGenerated: boolean;
559
591
  /** Connection interface attributes. */
560
- attributesByEnv?: ConnectionInterfaceAttributesByEnv[];
592
+ attributesByEnv: ConnectionInterfaceAttributesByEnv[];
561
593
  };
562
594
  export type UpdateConnectionInterfaceVisibilityRequest = {
563
- /** Ids */
564
- ids?: string[];
565
- /** Type */
566
- type?: "ACCOUNT" | "APPLICATION" | "WORKSPACE";
595
+ ids: string[];
596
+ "type": "ACCOUNT" | "APPLICATION" | "WORKSPACE";
567
597
  };
568
598
  export type ApplicationReadResponse = {
569
599
  /** Application id. */
570
- id?: string;
600
+ id: string;
571
601
  /** Application name. */
572
- name?: string;
602
+ name: string;
573
603
  /** Application description. */
574
604
  description?: string;
575
605
  /** Application repository url. */
576
606
  repoUrl?: string;
577
607
  /** Application repository base branch. */
578
- repoBaseBranch?: string;
608
+ repoBaseBranch: string;
579
609
  /** Stack used to generate this application. */
580
610
  stackVersionId?: string;
581
611
  /** Starter used to generate this application. */
582
612
  starterId?: string;
583
613
  /** Application status. */
584
- status?: string;
614
+ status: string;
585
615
  /** Application creator. */
586
- createdBy?: string;
616
+ createdBy: string;
587
617
  /** Application creation date. */
588
- createdAt?: string;
618
+ createdAt: string;
589
619
  /** Application updater. */
590
- updatedBy?: string;
620
+ updatedBy: string;
591
621
  /** Application update date. */
592
- updatedAt?: string;
622
+ updatedAt: string;
593
623
  };
594
624
  export type CreateApplicationRequest = {
595
625
  /** Application name. */
@@ -601,9 +631,9 @@ export type CreateApplicationRequest = {
601
631
  /** Application repository base branch. */
602
632
  repoBaseBranch: string;
603
633
  /** Stack used to generate this application. */
604
- stackVersionId: string;
634
+ stackVersionId?: string;
605
635
  /** Starter used to generate this application. */
606
- starterId: string;
636
+ starterId?: string;
607
637
  };
608
638
  export type RecreateApplicationRequest = {
609
639
  /** Application name. */
@@ -631,11 +661,11 @@ export type UpdateApplicationRequest = {
631
661
  };
632
662
  export type ApplicationLinkReadResponse = {
633
663
  /** Shared infra link id. */
634
- id?: string;
664
+ id: string;
635
665
  /** Application link name. */
636
- name?: string;
666
+ name: string;
637
667
  /** Application link url. */
638
- url?: string;
668
+ url: string;
639
669
  /** Application link image URL. */
640
670
  imageUrl?: string;
641
671
  };
@@ -643,13 +673,13 @@ export type CreateApplicationLinkRequest = {
643
673
  /** Application link name. */
644
674
  name: string;
645
675
  /** Application link URL. */
646
- url?: string;
676
+ url: string;
647
677
  /** Application link image base64. */
648
678
  image?: string;
649
679
  };
650
680
  export type ApplicationDestroyRequest = {
651
681
  /** Destroy status. */
652
- status?: "SUCCESS" | "FAILED";
682
+ status: "SUCCESS" | "FAILED";
653
683
  };
654
684
  export type MetaDataRequest = {
655
685
  name: string;
@@ -693,10 +723,10 @@ export type AppliedPluginsRequest = {
693
723
  /** Stack version id */
694
724
  stackVersionId: string;
695
725
  /** Plugin inputs */
696
- inputs?: {
726
+ inputs: {
697
727
  [key: string]: object;
698
728
  };
699
- connections?: ConnectionsRequest;
729
+ connections: ConnectionsRequest;
700
730
  links?: PluginLinkRequest;
701
731
  };
702
732
  export type SpecRequest = {
@@ -705,30 +735,30 @@ export type SpecRequest = {
705
735
  /** Deploy specification repository */
706
736
  repository: string;
707
737
  /** Plugins applied in deploy */
708
- appliedPlugins?: AppliedPluginsRequest[];
738
+ appliedPlugins: AppliedPluginsRequest[];
709
739
  };
710
740
  export type AppManifestoRequest = {
711
741
  /** Deployment schema version */
712
742
  schemaVersion: string;
713
743
  /** Deployment kind */
714
744
  kind: string;
715
- metadata?: MetaDataRequest;
716
- spec?: SpecRequest;
745
+ metadata: MetaDataRequest;
746
+ spec: SpecRequest;
717
747
  };
718
748
  export type ApplicationDeployRequest = {
719
749
  /** Deploy status. */
720
- status?: "SUCCESS" | "FAILED";
750
+ status: "SUCCESS" | "FAILED";
721
751
  /** Deploy version. */
722
752
  version: string;
723
- appManifesto?: AppManifestoRequest;
753
+ appManifesto: AppManifestoRequest;
724
754
  };
725
755
  export type ApplicationEmbeddedLinkReadResponse = {
726
756
  /** Application embedded link id. */
727
- id?: string;
757
+ id: string;
728
758
  /** Application embedded link name. */
729
- name?: string;
759
+ name: string;
730
760
  /** Application embedded link url. */
731
- url?: string;
761
+ url: string;
732
762
  /** Application embedded link image URL. */
733
763
  imageUrl?: string;
734
764
  /** Application embedded link layout. */
@@ -738,27 +768,61 @@ export type CreateApplicationEmbeddedLinkRequest = {
738
768
  /** Application embedded link name. */
739
769
  name: string;
740
770
  /** Application embedded link URL. */
741
- url?: string;
771
+ url: string;
742
772
  /** Application embedded link image base64. */
743
773
  image?: string;
744
774
  };
745
775
  export type ApplicationDeploySnapshotRequest = {
746
776
  /** Deployment Id. */
747
- deploymentId?: string;
777
+ deploymentId: string;
748
778
  /** Deployment Id. */
749
- environmentId?: string;
779
+ environmentId: string;
750
780
  /** Input attributes for applied app plugin. */
751
- plugins?: PluginElementSnapshot[];
781
+ plugins: PluginElementSnapshot[];
782
+ };
783
+ export type EnvironmentLinkedPluginResponse = {
784
+ id: string;
785
+ name: string;
786
+ totalLinkedApps: number;
787
+ totalLinkedInfra: number;
788
+ };
789
+ export type EnvironmentStackResponse = {
790
+ stackVersionId: string;
791
+ environments: EnvironmentLinkedPluginResponse[];
792
+ };
793
+ export type StackUsageByWorkspaceResponse = {
794
+ /** Workspace id. */
795
+ id: string;
796
+ /** Workspace name */
797
+ name: string;
798
+ /** Workspace description */
799
+ description?: string;
800
+ /** Workspace image */
801
+ imageUrl?: string;
802
+ /** Amount of linked versions. */
803
+ totalLinkedVersions: number;
804
+ /** Stack Versions linked. */
805
+ stackVersions: EnvironmentStackResponse[];
806
+ };
807
+ export type PluginUsageAmountResponse = {
808
+ pluginVersionId: string;
809
+ totalUsedInInfras: number;
810
+ totalUsedInApps: number;
811
+ };
812
+ export type PluginUsageAmountConsolidatedResponse = {
813
+ totalUsedInInfras: number;
814
+ totalUsedInApps: number;
815
+ details: PluginUsageAmountResponse[];
752
816
  };
753
817
  export type EnvironmentReadResponse = {
754
818
  /** Environment id. */
755
- id?: string;
819
+ id: string;
756
820
  /** Environment name. */
757
- name?: string;
821
+ name: string;
758
822
  /** Environment description. */
759
- description?: string;
823
+ description: string;
760
824
  /** Environment accountId. */
761
- accountId?: string;
825
+ accountId: string;
762
826
  };
763
827
  export type EnvironmentSaveRequest = {
764
828
  /** Environment name. */
@@ -768,9 +832,9 @@ export type EnvironmentSaveRequest = {
768
832
  };
769
833
  export type EnvironmentReadBatchResponse = {
770
834
  /** Environment id. */
771
- id?: string;
835
+ id: string;
772
836
  /** Environment name. */
773
- name?: string;
837
+ name: string;
774
838
  };
775
839
  export type WorkflowResponse = {
776
840
  id: string;
@@ -797,9 +861,9 @@ export type AccountWorkflowCreateRequest = {
797
861
  };
798
862
  export type AccountStackContextResponse = {
799
863
  /** List of stack version ids with pluginVersionId list with account context. */
800
- stackVersions?: StackVersionResponse[];
864
+ stackVersions: StackVersionResponse[];
801
865
  /** Account id. */
802
- accountId?: string;
866
+ accountId: string;
803
867
  };
804
868
  export type UpdateWorkspaceRequest = {
805
869
  /** Workspace name. */
@@ -835,9 +899,9 @@ export type UpdateWorkspaceEmbeddedLinkRequest = {
835
899
  };
836
900
  export type UpsertWorkspaceEmbeddedLinkRequest = {
837
901
  /** Workspace embedded link id. */
838
- id?: string;
902
+ id: string;
839
903
  /** Workspace embedded link layout. */
840
- layout?: object;
904
+ layout: object;
841
905
  };
842
906
  export type UpdateApplicationLinkRequest = {
843
907
  /** Shared infra link URL. */
@@ -856,9 +920,9 @@ export type UpdateApplicationEmbeddedLinkRequest = {
856
920
  };
857
921
  export type UpsertApplicationEmbeddedLinkRequest = {
858
922
  /** Application embedded link id. */
859
- id?: string;
923
+ id: string;
860
924
  /** Application embedded link layout. */
861
- layout?: object;
925
+ layout: object;
862
926
  };
863
927
  export type EnvironmentUpdateRequest = {
864
928
  /** Environment name. */
@@ -898,34 +962,34 @@ export type AppliedPluginV2Response = {
898
962
  };
899
963
  export type ConnectionInterfaceSummaryV2Response = {
900
964
  /** Connection interface api id. */
901
- apiId?: string;
965
+ apiId: string;
902
966
  /** Connection interface id type generate by client. */
903
- typeId?: string;
967
+ typeId: string;
904
968
  /** Connection interface id generated by client. */
905
- slug?: string;
969
+ slug: string;
906
970
  /** Indicates if this connection interface was generated by a plugin or manually. */
907
- automaticallyGenerated?: boolean;
971
+ automaticallyGenerated: boolean;
908
972
  /** The version ID of the plugin that generated this. */
909
973
  sourcePluginVersionId?: string;
910
974
  };
911
975
  export type Visibility = {
912
976
  /** Connection visibility type. */
913
- "type"?: "ACCOUNT" | "APPLICATION" | "WORKSPACE";
977
+ "type": "ACCOUNT" | "APPLICATION" | "WORKSPACE";
914
978
  /** IDs (based on type) for which connection interface is visible. */
915
- ids?: string[];
979
+ ids: string[];
916
980
  };
917
981
  export type ConnectionInterfaceDetailsV2Response = {
918
982
  /** Connection interface type. */
919
- typeId?: string;
983
+ typeId: string;
920
984
  /** Connection interface id generated by client. */
921
- slug?: string;
922
- visibility?: Visibility;
985
+ slug: string;
986
+ visibility: Visibility;
923
987
  /** Version id from plugin that generated this connection interface. */
924
988
  sourcePluginVersionId?: string;
925
989
  /** Indicates if this connection interface was generated by a plugin or manually. */
926
- automaticallyGenerated?: boolean;
990
+ automaticallyGenerated: boolean;
927
991
  /** Connection interface attributes. */
928
- attributesByEnv?: ConnectionInterfaceAttributesByEnv[];
992
+ attributesByEnv: ConnectionInterfaceAttributesByEnv[];
929
993
  };
930
994
  export type PluginInUseResponse = {
931
995
  name: string;
@@ -1013,18 +1077,18 @@ export type AppAndInfraDependencyResponse = {
1013
1077
  };
1014
1078
  export type ConnectionInterfaceDetailsResponse = {
1015
1079
  /** Connection interface id. */
1016
- id?: string;
1080
+ id: string;
1017
1081
  /** Connection interface type id. */
1018
- typeId?: string;
1082
+ typeId: string;
1019
1083
  /** Connection interface id generated by client. */
1020
- connectionInterfaceId?: string;
1021
- visibility?: Visibility;
1084
+ connectionInterfaceId: string;
1085
+ visibility: Visibility;
1022
1086
  /** Version id from plugin that generated this connection interface. */
1023
1087
  sourcePluginVersionId?: string;
1024
1088
  /** Indicates if this connection interface was generated by a plugin or manually. */
1025
- automaticallyGenerated?: boolean;
1089
+ automaticallyGenerated: boolean;
1026
1090
  /** Connection interface attributes. */
1027
- attributesByEnv?: ConnectionInterfaceAttributesByEnv[];
1091
+ attributesByEnv: ConnectionInterfaceAttributesByEnv[];
1028
1092
  };
1029
1093
  export type DeploymentTargetsResponse = {
1030
1094
  targetId: string;
@@ -1106,24 +1170,24 @@ export type ApplicationCanBeDeletedResponse = {
1106
1170
  };
1107
1171
  export type WorkspaceInfo = {
1108
1172
  /** Workspace id. */
1109
- id?: string;
1173
+ id: string;
1110
1174
  /** Workspace name */
1111
- name?: string;
1175
+ name: string;
1112
1176
  };
1113
1177
  export type GetSharedInfraResponse = {
1114
1178
  /** Shared infrastructure id. */
1115
- id?: string;
1179
+ id: string;
1116
1180
  /** Shared infrastructure name. */
1117
- name?: string;
1181
+ name: string;
1118
1182
  /** Shared infrastructure description. */
1119
1183
  description?: string;
1120
1184
  /** Shared infrastructure repository url. */
1121
1185
  repoUrl?: string;
1122
1186
  /** Shared infrastructure repository base branch. */
1123
- repoBaseBranch?: string;
1187
+ repoBaseBranch: string;
1124
1188
  /** Stack used to generate this shared infrastructure. */
1125
- stackVersionId?: string;
1126
- workspace?: WorkspaceInfo;
1189
+ stackVersionId: string;
1190
+ workspace: WorkspaceInfo;
1127
1191
  };
1128
1192
  export type PluginInUseDetailsResponse = {
1129
1193
  workspaceId: string;
@@ -1131,41 +1195,35 @@ export type PluginInUseDetailsResponse = {
1131
1195
  };
1132
1196
  export type CheckConnectionSlugAvailabilityResponse = {
1133
1197
  /** Whether connection slug is available or not. */
1134
- available?: boolean;
1135
- };
1136
- export type WorkspaceResponse = {
1137
- /** Workspace id. */
1138
- id?: string;
1139
- /** Workspace name. */
1140
- name?: string;
1198
+ available: boolean;
1141
1199
  };
1142
1200
  export type ApplicationRepoUrlReadResponse = {
1143
1201
  /** Application id. */
1144
- id?: string;
1202
+ id: string;
1145
1203
  /** Application name. */
1146
- name?: string;
1204
+ name: string;
1147
1205
  /** Application status. */
1148
- status?: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED" | "ARCHIVING" | "ARCHIVED" | "ARCHIVE_FAILED";
1206
+ status: "CREATED" | "CREATE_FAILED" | "DRAFT" | "DELETING" | "DELETE_FAILED" | "ARCHIVING" | "ARCHIVED" | "ARCHIVE_FAILED";
1149
1207
  /** Application description. */
1150
1208
  description?: string;
1151
1209
  workspace?: WorkspaceResponse;
1152
1210
  };
1153
1211
  export type GetApplicationResponse = {
1154
1212
  /** Application id. */
1155
- id?: string;
1213
+ id: string;
1156
1214
  /** Application name. */
1157
- name?: string;
1215
+ name: string;
1158
1216
  /** Application description. */
1159
1217
  description?: string;
1160
1218
  /** Application repository url. */
1161
1219
  repoUrl?: string;
1162
1220
  /** Application repository base branch. */
1163
- repoBaseBranch?: string;
1221
+ repoBaseBranch: string;
1164
1222
  /** Stack used to generate this application. */
1165
- stackVersionId?: string;
1223
+ stackVersionId: string;
1166
1224
  /** Starter used to generate this application. */
1167
- starterId?: string;
1168
- workspace?: WorkspaceInfo;
1225
+ starterId: string;
1226
+ workspace: WorkspaceInfo;
1169
1227
  };
1170
1228
  export type WorkflowActionUsageResponse = {
1171
1229
  versionRanges: string[];
@@ -1435,12 +1493,29 @@ export declare function saveStackWorkflowContext({ stackId, workflowId, stackWor
1435
1493
  workflowId: string;
1436
1494
  stackWorkflowCreateRequest: StackWorkflowCreateRequest;
1437
1495
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1496
+ /**
1497
+ * List specific shared infra or application usage by plugin list.
1498
+ */
1499
+ export declare function listPluginUsageByTargetId({ accountId, targetType, targetId, body }: {
1500
+ accountId: string;
1501
+ targetType: "applications" | "shared_infra";
1502
+ targetId: string;
1503
+ body: string[];
1504
+ }, opts?: Oazapfts.RequestOpts): Promise<TargetByPluginUsageResponse[]>;
1505
+ /**
1506
+ * List all shared infras or applications usage by plugin list.
1507
+ */
1508
+ export declare function listAllPluginUsage({ accountId, targetType, body }: {
1509
+ accountId: string;
1510
+ targetType: "applications" | "shared_infra";
1511
+ body: string[];
1512
+ }, opts?: Oazapfts.RequestOpts): Promise<PluginUsageByTargetResponse[]>;
1438
1513
  /**
1439
1514
  * Get all workspaces
1440
1515
  */
1441
1516
  export declare function getWorkspaces({ name, aclOnly, accountId }: {
1442
1517
  name?: string;
1443
- aclOnly: boolean;
1518
+ aclOnly?: boolean;
1444
1519
  accountId?: string;
1445
1520
  }, opts?: Oazapfts.RequestOpts): Promise<WorkspaceReadResponse[]>;
1446
1521
  /**
@@ -1742,6 +1817,20 @@ export declare function processDeploySnapshot1({ workspaceId, applicationId, app
1742
1817
  applicationId: string;
1743
1818
  applicationDeploySnapshotRequest: ApplicationDeploySnapshotRequest;
1744
1819
  }, opts?: Oazapfts.RequestOpts): Promise<unknown>;
1820
+ /**
1821
+ * List all workspaces usage by stack version list.
1822
+ */
1823
+ export declare function listAllStackUsage({ accountId, body }: {
1824
+ accountId: string;
1825
+ body: string[];
1826
+ }, opts?: Oazapfts.RequestOpts): Promise<StackUsageByWorkspaceResponse[]>;
1827
+ /**
1828
+ * Retrieve the amount of apps and shared infras that use the given plugin version id list
1829
+ */
1830
+ export declare function findPluginUsageAmount({ accountId, body }: {
1831
+ accountId: string;
1832
+ body: string[];
1833
+ }, opts?: Oazapfts.RequestOpts): Promise<PluginUsageAmountConsolidatedResponse>;
1745
1834
  /**
1746
1835
  * Get environments
1747
1836
  */