@devopness/sdk-js 1.101.1 → 1.102.0

package/README.md

@@ -1,19 +1,11 @@
 # Devopness SDK - JavaScript
 
-[![MIT License](https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square)](https://github.com/devopness/devopness-sdk-js/blob/master/LICENSE)
-![CI](https://github.com/devopness/sdk-js/workflows/CI/badge.svg)
-
 [![NPM](https://nodei.co/npm/@devopness/sdk-js.png?downloads=true&stars=true)](https://nodei.co/npm/@devopness/sdk-js/)
 
 The official Devopness SDK for JavaScript, available for browsers, mobile devices and `Node.js` backends.
 
 Devopness SDK includes a pre-defined set of classes that provide convenient access to Devopness platform data. This SDK aims to make it easy and fun to consume Devopness API resources from web, Node.js or mobile apps written in the JavaScript programming language.
 
-## About Devopness
-`Devopness` aims to drastically change the way software developers deploy applications and manage on-premise and cloud servers in a secure and performant fashion.
-
-By streamlining essential DevOps practices we're making first class software deployment and server management tools accessible and affordable to every developer in the world.
-
 ## Usage
 
 ### Install/Upgrade
@@ -57,7 +49,7 @@ async function authenticate(email, pass) {
 authenticate('user@email.com', 'secret-password');
 ```
 
-In the example above, `userTokens` is a instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness-sdk-js/blob/master/src/common/ApiResponse.ts) for reference.
+In the example above, `userTokens` is a instance of `ApiResponse` and the `data` property has the data requested from the API. See [ApiResponse.ts](https://github.com/devopness/devopness/blob/master/src/common/ApiResponse.ts) for reference.
 
 ### Invoking authentication protected endpoints
 Once an authentication token is set, any protected endpoint can be invoked.
@@ -88,7 +80,7 @@ Some methods in `Devopness SDK JavaScript` accept and return objects from the De
 To build and test the SDK locally, follow these steps:
 1. Clone de repository
 ```
-git clone https://github.com/devopness/devopness-sdk-js.git
+git clone https://github.com/devopness/devopness.git
 ```
 2. Install missing dependencies
 

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

@@ -13,6 +13,7 @@ import { ApiBaseService } from "../../../services/ApiBaseService";
 import { ApiResponse } from "../../../common/ApiResponse";
 import { Action } from '../../generated/models';
 import { ActionListItem } from '../../generated/models';
+import { ActionType } from '../../generated/models';
 /**
  * ActionsApiService - Auto-generated
  */
@@ -30,4 +31,29 @@ export declare class ActionsApiService extends ApiBaseService {
      * @param {number} [perPage] Number of items returned per page
      */
     listActions(page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+    /**
+     *
+     * @summary List resource actions
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} resourceId Unique ID of the resource that is being searched
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listResourceActions(resourceType: string, resourceId: number, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+    /**
+     *
+     * @summary List resource actions of an action type
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} resourceId Unique ID of the resource that is being searched
+     * @param {ActionType} actionType The action type
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listResourceActionsOfResourceTypeActionType(resourceType: string, resourceId: number, actionType: ActionType, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+    /**
+     *
+     * @summary Retry an action
+     * @param {number} actionId Numeric ID of the action to be retried
+     */
+    retryAction(actionId: number): Promise<ApiResponse<Action>>;
 }

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

@@ -66,5 +66,83 @@ class ActionsApiService extends ApiBaseService_1.ApiBaseService {
             return new ApiResponse_1.ApiResponse(response);
         });
     }
+    /**
+     *
+     * @summary List resource actions
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} resourceId Unique ID of the resource that is being searched
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listResourceActions(resourceType, resourceId, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listResourceActions');
+            }
+            if (resourceId === null || resourceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceId', 'listResourceActions');
+            }
+            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 = '/actions/{resource_type}/{resource_id}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))).replace(`{${"resource_id"}}`, encodeURIComponent(String(resourceId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary List resource actions of an action type
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} resourceId Unique ID of the resource that is being searched
+     * @param {ActionType} actionType The action type
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listResourceActionsOfResourceTypeActionType(resourceType, resourceId, actionType, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listResourceActionsOfResourceTypeActionType');
+            }
+            if (resourceId === null || resourceId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceId', 'listResourceActionsOfResourceTypeActionType');
+            }
+            if (actionType === null || actionType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('actionType', 'listResourceActionsOfResourceTypeActionType');
+            }
+            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 = '/actions/{resource_type}/{resource_id}/{action_type}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))).replace(`{${"resource_id"}}`, encodeURIComponent(String(resourceId))).replace(`{${"action_type"}}`, encodeURIComponent(String(actionType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary Retry an action
+     * @param {number} actionId Numeric ID of the action to be retried
+     */
+    retryAction(actionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (actionId === null || actionId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('actionId', 'retryAction');
+            }
+            let queryString = '';
+            const requestUrl = '/actions/{action_id}/retry' + (queryString ? `?${queryString}` : '');
+            const response = yield this.post(requestUrl.replace(`{${"action_id"}}`, encodeURIComponent(String(actionId))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
 }
 exports.ActionsApiService = ActionsApiService;

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

@@ -0,0 +1,28 @@
+/**
+ * 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 { ActionListItem } from '../../generated/models';
+/**
+ * EnvironmentsActionsApiService - Auto-generated
+ */
+export declare class EnvironmentsActionsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary List environment actions of a resource type
+     * @param {number} environmentId Unique ID of the environment to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listEnvironmentActionsOfResourceType(environmentId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+}

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

@@ -0,0 +1,62 @@
+"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.EnvironmentsActionsApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * EnvironmentsActionsApiService - Auto-generated
+ */
+class EnvironmentsActionsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary List environment actions of a resource type
+     * @param {number} environmentId Unique ID of the environment to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listEnvironmentActionsOfResourceType(environmentId, resourceType, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (environmentId === null || environmentId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('environmentId', 'listEnvironmentActionsOfResourceType');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listEnvironmentActionsOfResourceType');
+            }
+            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 = '/environments/{environment_id}/actions/{resource_type}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"environment_id"}}`, encodeURIComponent(String(environmentId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.EnvironmentsActionsApiService = EnvironmentsActionsApiService;

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { ActionListItem } from '../../generated/models';
+import { ActionType } from '../../generated/models';
+/**
+ * ProjectsActionsApiService - Auto-generated
+ */
+export declare class ProjectsActionsApiService extends ApiBaseService {
+    /**
+     *
+     * @summary List resource actions of a resource type
+     * @param {number} projectId Unique ID of the project to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectActionsOfResourceType(projectId: number, resourceType: string, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+    /**
+     *
+     * @summary List project actions of a resource type and action type
+     * @param {number} projectId Unique ID of the project to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {ActionType} actionType The action type
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectActionsOfResourceTypeActionType(projectId: number, resourceType: string, actionType: ActionType, page?: number, perPage?: number): Promise<ApiResponse<Array<ActionListItem>>>;
+}

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

@@ -0,0 +1,95 @@
+"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.ProjectsActionsApiService = void 0;
+const ApiBaseService_1 = require("../../../services/ApiBaseService");
+const ApiResponse_1 = require("../../../common/ApiResponse");
+const Exceptions_1 = require("../../../common/Exceptions");
+/**
+ * ProjectsActionsApiService - Auto-generated
+ */
+class ProjectsActionsApiService extends ApiBaseService_1.ApiBaseService {
+    /**
+     *
+     * @summary List resource actions of a resource type
+     * @param {number} projectId Unique ID of the project to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectActionsOfResourceType(projectId, resourceType, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (projectId === null || projectId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('projectId', 'listProjectActionsOfResourceType');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listProjectActionsOfResourceType');
+            }
+            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}/actions/{resource_type}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+    /**
+     *
+     * @summary List project actions of a resource type and action type
+     * @param {number} projectId Unique ID of the project to get
+     * @param {string} resourceType The resource type to get related actions
+     * @param {ActionType} actionType The action type
+     * @param {number} [page] Number of the page to be retrieved
+     * @param {number} [perPage] Number of items returned per page
+     */
+    listProjectActionsOfResourceTypeActionType(projectId, resourceType, actionType, page, perPage) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (projectId === null || projectId === undefined) {
+                throw new Exceptions_1.ArgumentNullException('projectId', 'listProjectActionsOfResourceTypeActionType');
+            }
+            if (resourceType === null || resourceType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('resourceType', 'listProjectActionsOfResourceTypeActionType');
+            }
+            if (actionType === null || actionType === undefined) {
+                throw new Exceptions_1.ArgumentNullException('actionType', 'listProjectActionsOfResourceTypeActionType');
+            }
+            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}/actions/{resource_type}/{action_type}' + (queryString ? `?${queryString}` : '');
+            const response = yield this.get(requestUrl.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId))).replace(`{${"resource_type"}}`, encodeURIComponent(String(resourceType))).replace(`{${"action_type"}}`, encodeURIComponent(String(actionType))));
+            return new ApiResponse_1.ApiResponse(response);
+        });
+    }
+}
+exports.ProjectsActionsApiService = ProjectsActionsApiService;

package/dist/api/generated/apis/resource-events-api.d.ts

@@ -20,7 +20,7 @@ export declare class ResourceEventsApiService extends ApiBaseService {
      *
      * @summary Return a list of all events belonging to a resource
      * @param {string} resourceType The resource type to get related events
-     * @param {number} resourceId Unique ID of the resource that\'s being searched
+     * @param {number} resourceId Unique ID of the resource that is being searched
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

package/dist/api/generated/apis/resource-events-api.js

@@ -33,7 +33,7 @@ class ResourceEventsApiService extends ApiBaseService_1.ApiBaseService {
      *
      * @summary Return a list of all events belonging to a resource
      * @param {string} resourceType The resource type to get related events
-     * @param {number} resourceId Unique ID of the resource that\'s being searched
+     * @param {number} resourceId Unique ID of the resource that is being searched
      * @param {number} [page] Number of the page to be retrieved
      * @param {number} [perPage] Number of items returned per page
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopness/sdk-js",
-  "version": "1.101.1",
+  "version": "1.102.0",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
   "license": "MIT",
   "release": {
     "branches": [
-      "master"
+      "main"
     ]
   },
   "bugs": {
@@ -59,7 +59,7 @@
     "husky": "^8.0.1",
     "jest": "^27.0.6",
     "ts-jest": "^27.0.3",
-    "typedoc": "^0.22.3",
+    "typedoc": "^0.23.1",
     "typescript": "^4.4.0"
   },
   "dependencies": {

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Devopness
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.