Add ability to get ee project status

Author: stevencl840

examples/src/environments/get-ephemeral-environment-project-status.ts

@@ -0,0 +1,30 @@
+import { ClientConfiguration, EnvironmentRepository } from "../../../src/index";
+import { CreateClient, GetProject } from "../utility";
+
+const main = async () => {
+    const projectNameOrId: string = "project-name-or-ID";
+    const environmentName: string = "an-ephemeral-environment-name";
+
+    const configuration: ClientConfiguration = {
+        userAgentApp: "examples",
+        instanceURL: "instance-url", // required
+        apiKey: "api-key", // required
+    };
+
+    const client = await CreateClient(configuration);
+
+    console.log(`Getting project: ${projectNameOrId}`);
+    const project = await GetProject(client, projectNameOrId);  
+
+    const environmentsRepo = new EnvironmentRepository(client, "Default");
+
+    console.log(`Creating ephemeral environment: ${environmentName}`);
+    const environment = await environmentsRepo.createEphemeralEnvironment(environmentName, project.Id);
+    
+    console.log(`Getting ephemeral environment status: ${environment.Id}`);
+    const response = await environmentsRepo.getEphemeralEnvironmentProjectStatus(environment.Id, project.Id);
+
+    console.log(`Ephemeral Environment Status: ${response.Status}`);
+};
+
+main();

src/features/deploymentEnvironments/environmentRepository.ts

@@ -56,6 +56,18 @@ export class EnvironmentRepository extends SpaceScopedBasicRepository<Deployment
         return response;
     }
 
+    async getEphemeralEnvironmentProjectStatus(environmentId: string, projectId: string): Promise<GetEphemeralEnvironmentProjectStatusResponse> {
+        const response = await this.client.request<GetEphemeralEnvironmentProjectStatusResponse>(
+            `${spaceScopedRoutePrefix}/projects/{projectId}/environments/ephemeral/{id}/status`,
+            {
+                spaceName: this.spaceName,
+                projectId: projectId,
+                id: environmentId,
+            }
+        );
+        return response;
+    }
+
     async deprovisionEphemeralEnvironmentForProject(environmentId: string, projectId: string): Promise<DeprovisionEphemeralEnvironmentProjectResponse> {
         const response = await this.client.doCreate<DeprovisionEphemeralEnvironmentProjectResponse>(
             `${spaceScopedRoutePrefix}/projects/{projectId}/environments/ephemeral/{environmentId}/deprovision`,
@@ -151,3 +163,7 @@ export interface DeprovisionEphemeralEnvironmentProjectResponse {
 export interface DeprovisionEphemeralEnvironmentResponse {
     DeprovisioningRuns?: DeprovisioningRunbookRun[];
 }
+
+export interface GetEphemeralEnvironmentProjectStatusResponse {
+    Status: string;
+}