@devopness/sdk-js 2.61.0 → 2.63.0

package/README.md

@@ -89,22 +89,27 @@ To build and test the SDK locally, [**fork this repository**](https://github.com
   xcode-select --install
   ```
 ### Setup and run in local environment
-#### 1. Build Docker Image
+#### 1. Navigate to the project directory
+```shell
+cd packages/sdks/javascript/
+```
+
+#### 2. Build Docker Image
 ```
 make build-image
 ```
 
-#### 2. Install Dependencies
+#### 3. Install Dependencies
 ```
 make npm-ci
 ```
 
-#### 3. Build SDK
+#### 4. Build SDK
 ```
 make build-sdk-js
 ```
 
-#### 4. Run Tests
+#### 5. Run Tests
 ```
 make test
 ```
@@ -112,7 +117,7 @@ make test
 ### Without Docker
 Installing on ``Linux`` or ``macOS`` systems.
 
-#### 1. Navigate to the project directory!
+#### 1. Navigate to the project directory
 ```shell
 cd packages/sdks/javascript/
 ```

package/dist/api/generated/apis/environments-api.d.ts

@@ -17,6 +17,12 @@ import { EnvironmentUpdate } from '../../generated/models';
  * EnvironmentsApiService - Auto-generated
  */
 export declare class EnvironmentsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Archive an environment
+     * @param {number} environmentId The ID of the environment.
+     */
+    archiveEnvironment(environmentId: number): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Delete a given environment
@@ -29,6 +35,12 @@ export declare class EnvironmentsApiService extends ApiBaseService {
      * @param {number} environmentId The ID of the environment.
      */
     getEnvironment(environmentId: number): Promise<ApiResponse<Environment>>;
+    /**
+     *
+     * @summary Unarchive an environment
+     * @param {number} environmentId The ID of the environment.
+     */
+    unarchiveEnvironment(environmentId: number): Promise<ApiResponse<void>>;
     /**
      *
      * @summary Update a given environment

package/dist/api/generated/apis/environments-api.js

@@ -29,6 +29,22 @@ const Exceptions_1 = require("../../../common/Exceptions");
  * EnvironmentsApiService - Auto-generated
  */
 class EnvironmentsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Archive an environment
+     * @param {number} environmentId The ID of the environment.
+     */
+    archiveEnvironment(environmentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'archiveEnvironment');
+            }
+            let queryString = '';
+            const requestUrl = '/environments/{environment_id}/archive' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Delete a given environment
@@ -61,6 +77,22 @@ class EnvironmentsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary Unarchive an environment
+     * @param {number} environmentId The ID of the environment.
+     */
+    unarchiveEnvironment(environmentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'unarchiveEnvironment');
+            }
+            let queryString = '';
+            const requestUrl = '/environments/{environment_id}/unarchive' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
     /**
      *
      * @summary Update a given environment

package/dist/api/generated/apis/pipelines-actions-api.d.ts

@@ -0,0 +1,27 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApiBaseService } from "../../../services/ApiBaseService";
+import { ApiResponse } from "../../../common/ApiResponse";
+import { Action } from '../../generated/models';
+import { ActionPipelineCreate } from '../../generated/models';
+/**
+ * PipelinesActionsApiService - Auto-generated
+ */
+export declare class PipelinesActionsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Create an action to run a Pipeline
+     * @param {number} pipelineId The ID of the pipeline that will be executed by the created action
+     * @param {ActionPipelineCreate} actionPipelineCreate A JSON object containing the resource data
+     */
+    addPipelineAction(pipelineId: number, actionPipelineCreate: ActionPipelineCreate): Promise<ApiResponse<Action>>;
+}

package/dist/api/generated/apis/pipelines-actions-api.js

@@ -0,0 +1,53 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PipelinesActionsApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * PipelinesActionsApiService - Auto-generated
+ */
+class PipelinesActionsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Create an action to run a Pipeline
+     * @param {number} pipelineId The ID of the pipeline that will be executed by the created action
+     * @param {ActionPipelineCreate} actionPipelineCreate A JSON object containing the resource data
+     */
+    addPipelineAction(pipelineId, actionPipelineCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (pipelineId === null || pipelineId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('pipelineId', 'addPipelineAction');
+            }
+            if (actionPipelineCreate === null || actionPipelineCreate === undefined) {
+                throw new Exceptions_1.ArgumentNullException('actionPipelineCreate', 'addPipelineAction');
+            }
+            let queryString = '';
+            const requestUrl = '/pipelines/{pipeline_id}/actions' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"pipeline_id"}}`, encodeURIComponent(String(pipelineId))), actionPipelineCreate);
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.PipelinesActionsApiService = PipelinesActionsApiService;

package/dist/api/generated/apis/projects-archived-environments-api.d.ts

@@ -0,0 +1,27 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApiBaseService } from "../../../services/ApiBaseService";
+import { ApiResponse } from "../../../common/ApiResponse";
+import { ArchivedEnvironmentRelation } from '../../generated/models';
+/**
+ * ProjectsArchivedEnvironmentsApiService - Auto-generated
+ */
+export declare class ProjectsArchivedEnvironmentsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary Return a list of all archived environments belonging to a project
+     * @param {number} projectId The ID of the project.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectArchivedEnvironments(projectId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<ArchivedEnvironmentRelation>>>;
+}

package/dist/api/generated/apis/projects-archived-environments-api.js

@@ -0,0 +1,58 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectsArchivedEnvironmentsApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * ProjectsArchivedEnvironmentsApiService - Auto-generated
+ */
+class ProjectsArchivedEnvironmentsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary Return a list of all archived environments belonging to a project
+     * @param {number} projectId The ID of the project.
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectArchivedEnvironments(projectId, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (projectId === null || projectId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('projectId', 'listProjectArchivedEnvironments');
+            }
+            let queryString = '';
+            const queryParams = { page: page, per_page: perPage, };
+            for (const key in queryParams) {
+                if (queryParams[key] === undefined || queryParams[key] === null) {
+                    continue;
+                }
+                queryString += (queryString ? '&' : '') + `${key}=${encodeURI(queryParams[key])}`;
+            }
+            const requestUrl = '/projects/{project_id}/environments/archived' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.ProjectsArchivedEnvironmentsApiService = ProjectsArchivedEnvironmentsApiService;

package/dist/api/generated/models/action-pipeline-create.d.ts

@@ -0,0 +1,24 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ActionPipelineCreate
+ */
+export interface ActionPipelineCreate {
+    /**
+     * List of valid resource IDs
+     * @type {Array<number>}
+     * @memberof ActionPipelineCreate
+     */
+    servers: Array<number>;
+}

package/dist/api/generated/models/action-pipeline-create.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/action-retry-response.d.ts

@@ -33,6 +33,12 @@ export interface ActionRetryResponse {
      * @memberof ActionRetryResponse
      */
     id: number;
+    /**
+     * The ID of the pipeline executed by this action
+     * @type {number}
+     * @memberof ActionRetryResponse
+     */
+    pipeline_id: number | null;
     /**
      * The Id of the parent action that this action is a retry of
      * @type {number}

package/dist/api/generated/models/action.d.ts

@@ -33,6 +33,12 @@ export interface Action {
      * @memberof Action
      */
     id: number;
+    /**
+     * The ID of the pipeline executed by this action
+     * @type {number}
+     * @memberof Action
+     */
+    pipeline_id: number | null;
     /**
      * The Id of the parent action that this action is a retry of
      * @type {number}

package/dist/api/generated/models/archived-environment-relation.d.ts

@@ -0,0 +1,61 @@
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { EnvironmentType } from './environment-type';
+/**
+ *
+ * @export
+ * @interface ArchivedEnvironmentRelation
+ */
+export interface ArchivedEnvironmentRelation {
+    /**
+     * Unique id of the given record
+     * @type {number}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    id: number;
+    /**
+     * Environment\'s name
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    name: string;
+    /**
+     *
+     * @type {EnvironmentType}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    type: EnvironmentType;
+    /**
+     * The human readable version of the type
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    type_human_readable: string;
+    /**
+     * The date and time when the record was created
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    created_at: string;
+    /**
+     * The date and time when the record was last updated
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    updated_at: string;
+    /**
+     * The date and time when the record was archived
+     * @type {string}
+     * @memberof ArchivedEnvironmentRelation
+     */
+    archived_at: string | null;
+}

package/dist/api/generated/models/archived-environment-relation.js

@@ -0,0 +1,14 @@
+"use strict";
+/* eslint-disable */
+/**
+ * devopness API
+ * Devopness API - Painless essential DevOps to everyone
+ *
+ * The version of the OpenAPI document: latest
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/generated/models/environment-relation.d.ts

@@ -52,4 +52,10 @@ export interface EnvironmentRelation {
      * @memberof EnvironmentRelation
      */
     updated_at: string;
+    /**
+     * The date and time when the record was archived
+     * @type {string}
+     * @memberof EnvironmentRelation
+     */
+    archived_at: string | null;
 }

package/dist/api/generated/models/environment.d.ts

@@ -49,6 +49,12 @@ export interface Environment {
      * @memberof Environment
      */
     type_human_readable: string;
+    /**
+     * Indicates whether the record was archived
+     * @type {boolean}
+     * @memberof Environment
+     */
+    is_archived: boolean;
     /**
      *
      * @type {Array<ServerRelation>}

package/dist/api/generated/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './action-deployment-commit';
 export * from './action-deployment-content';
 export * from './action-deployment-data';
 export * from './action-hook-request';
+export * from './action-pipeline-create';
 export * from './action-relation';
 export * from './action-resource';
 export * from './action-retry-response';
@@ -25,6 +26,7 @@ export * from './application-pipeline';
 export * from './application-relation';
 export * from './application-type';
 export * from './application-update';
+export * from './archived-environment-relation';
 export * from './blueprint-service';
 export * from './cloud-aws-ec2-settings';
 export * from './cloud-digital-ocean-droplet-settings';

package/dist/api/generated/models/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./action-deployment-commit"), exports);
 __exportStar(require("./action-deployment-content"), exports);
 __exportStar(require("./action-deployment-data"), exports);
 __exportStar(require("./action-hook-request"), exports);
+__exportStar(require("./action-pipeline-create"), exports);
 __exportStar(require("./action-relation"), exports);
 __exportStar(require("./action-resource"), exports);
 __exportStar(require("./action-retry-response"), exports);
@@ -41,6 +42,7 @@ __exportStar(require("./application-pipeline"), exports);
 __exportStar(require("./application-relation"), exports);
 __exportStar(require("./application-type"), exports);
 __exportStar(require("./application-update"), exports);
+__exportStar(require("./archived-environment-relation"), exports);
 __exportStar(require("./blueprint-service"), exports);
 __exportStar(require("./cloud-aws-ec2-settings"), exports);
 __exportStar(require("./cloud-digital-ocean-droplet-settings"), exports);

package/dist/services/ProjectService.d.ts

@@ -3,8 +3,10 @@ import { ProjectsActionsApiService } from '../api/generated/apis/projects-action
 import { ProjectsEnvironmentsApiService } from '../api/generated/apis/projects-environments-api';
 import { ProjectsRolesApiService } from '../api/generated/apis/projects-roles-api';
 import { ProjectsTeamsApiService } from '../api/generated/apis/projects-teams-api';
+import { ProjectsArchivedEnvironmentsApiService } from '../api/generated/apis/projects-archived-environments-api';
 export declare class ProjectService extends ProjectsApiService {
     actions: ProjectsActionsApiService;
+    archivedEnvironments: ProjectsArchivedEnvironmentsApiService;
     environments: ProjectsEnvironmentsApiService;
     roles: ProjectsRolesApiService;
     teams: ProjectsTeamsApiService;

package/dist/services/ProjectService.js

@@ -6,10 +6,12 @@ const projects_actions_api_1 = require("../api/generated/apis/projects-actions-a
 const projects_environments_api_1 = require("../api/generated/apis/projects-environments-api");
 const projects_roles_api_1 = require("../api/generated/apis/projects-roles-api");
 const projects_teams_api_1 = require("../api/generated/apis/projects-teams-api");
+const projects_archived_environments_api_1 = require("../api/generated/apis/projects-archived-environments-api");
 class ProjectService extends projects_api_1.ProjectsApiService {
     constructor() {
         super(...arguments);
         this.actions = new projects_actions_api_1.ProjectsActionsApiService();
+        this.archivedEnvironments = new projects_archived_environments_api_1.ProjectsArchivedEnvironmentsApiService();
         this.environments = new projects_environments_api_1.ProjectsEnvironmentsApiService();
         this.roles = new projects_roles_api_1.ProjectsRolesApiService();
         this.teams = new projects_teams_api_1.ProjectsTeamsApiService();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "2.61.0",
+  "version": "2.63.0",
   "publishConfig": {
     "access": "public"
   },