@testcollab/sdk 3.11.0 → 3.12.0

package/dist/apis/ReleasesApi.js

@@ -0,0 +1,379 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * 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.GetReleasesStatusEnum = exports.CountReleasesStatusEnum = exports.ReleasesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ReleasesApi extends runtime.BaseAPI {
+    /**
+     * Creates a new release
+     * Create a release
+     */
+    addReleaseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ReleasePayloadToJSON)(requestParameters['releasePayload']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseMinifiedFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a new release
+     * Create a release
+     */
+    addRelease() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.addReleaseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get count of releases for a specific project
+     * Count releases
+     */
+    countReleasesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['project'] == null) {
+                throw new runtime.RequiredError('project', 'Required parameter "project" was null or undefined when calling countReleases().');
+            }
+            const queryParameters = {};
+            if (requestParameters['project'] != null) {
+                queryParameters['project'] = requestParameters['project'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases/count`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CountFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get count of releases for a specific project
+     * Count releases
+     */
+    countReleases(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.countReleasesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * Delete a release
+     */
+    deleteReleaseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteRelease().');
+            }
+            if (requestParameters['project'] == null) {
+                throw new runtime.RequiredError('project', 'Required parameter "project" was null or undefined when calling deleteRelease().');
+            }
+            const queryParameters = {};
+            if (requestParameters['project'] != null) {
+                queryParameters['project'] = requestParameters['project'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * Delete a release
+     */
+    deleteRelease(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteReleaseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Edits a specific release
+     * Edit a release
+     */
+    editReleaseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling editRelease().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ReleasePayloadToJSON)(requestParameters['releasePayload']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseMinifiedFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Edits a specific release
+     * Edit a release
+     */
+    editRelease(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.editReleaseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get details of a specific release
+     * Get release
+     */
+    getReleaseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getRelease().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get details of a specific release
+     * Get release
+     */
+    getRelease(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReleaseRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
+     * Get release readiness dashboard data
+     */
+    getReleaseReadinessRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getReleaseReadiness().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases/{id}/readiness`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseReadinessFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
+     * Get release readiness dashboard data
+     */
+    getReleaseReadiness(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReleaseReadinessRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
+     * Get release readiness by public token
+     */
+    getReleaseReadinessByTokenRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['token'] == null) {
+                throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling getReleaseReadinessByToken().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/releases/readiness/{token}`;
+            urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseReadinessFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
+     * Get release readiness by public token
+     */
+    getReleaseReadinessByToken(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReleaseReadinessByTokenRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get releases for a specific project
+     * Get releases
+     */
+    getReleasesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['project'] == null) {
+                throw new runtime.RequiredError('project', 'Required parameter "project" was null or undefined when calling getReleases().');
+            }
+            const queryParameters = {};
+            if (requestParameters['project'] != null) {
+                queryParameters['project'] = requestParameters['project'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['_limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['start'] != null) {
+                queryParameters['_start'] = requestParameters['start'];
+            }
+            if (requestParameters['sort'] != null) {
+                queryParameters['_sort'] = requestParameters['sort'];
+            }
+            if (requestParameters['filter'] != null) {
+                queryParameters['_filter'] = requestParameters['filter'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                queryParameters["token"] = yield this.configuration.apiKey("token"); // ApiKeyAuth authentication
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // bearerAuth authentication
+            }
+            let urlPath = `/releases`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ReleaseFromJSON));
+        });
+    }
+    /**
+     * Get releases for a specific project
+     * Get releases
+     */
+    getReleases(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getReleasesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.ReleasesApi = ReleasesApi;
+/**
+ * @export
+ */
+exports.CountReleasesStatusEnum = {
+    Planned: 'planned',
+    InProgress: 'in_progress',
+    Ready: 'ready',
+    Shipped: 'shipped',
+    Blocked: 'blocked'
+};
+/**
+ * @export
+ */
+exports.GetReleasesStatusEnum = {
+    Planned: 'planned',
+    InProgress: 'in_progress',
+    Ready: 'ready',
+    Shipped: 'shipped',
+    Blocked: 'blocked'
+};

package/dist/apis/index.d.ts

@@ -14,6 +14,7 @@ export * from './NotificationsApi';
 export * from './ProjectUsersApi';
 export * from './ProjectsApi';
 export * from './ProjectsettingsApi';
+export * from './ReleasesApi';
 export * from './ReportsApi';
 export * from './RequirementFoldersApi';
 export * from './RequirementsApi';

package/dist/apis/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./NotificationsApi"), exports);
 __exportStar(require("./ProjectUsersApi"), exports);
 __exportStar(require("./ProjectsApi"), exports);
 __exportStar(require("./ProjectsettingsApi"), exports);
+__exportStar(require("./ReleasesApi"), exports);
 __exportStar(require("./ReportsApi"), exports);
 __exportStar(require("./RequirementFoldersApi"), exports);
 __exportStar(require("./RequirementsApi"), exports);