@testcollab/sdk 3.11.0 → 3.12.0

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 .openapi-generator-ignore
 README.md
 docs/Activity.md
+docs/ActivityAuditInfo.md
 docs/AddNewFolderPayload.md
 docs/AddRequirementPayload.md
 docs/AddRequirementPayloadFolder.md
@@ -192,6 +193,27 @@ docs/QueueStatus.md
 docs/QueueUpdatePayload.md
 docs/RegisteredUser.md
 docs/RegisteredUserUser.md
+docs/Release.md
+docs/ReleaseGoNoGoThreshold.md
+docs/ReleaseMinified.md
+docs/ReleasePayload.md
+docs/ReleaseReadiness.md
+docs/ReleaseReadinessComparison.md
+docs/ReleaseReadinessConfigurationCoverage.md
+docs/ReleaseReadinessCoverageItem.md
+docs/ReleaseReadinessCustomFieldCoverage.md
+docs/ReleaseReadinessCustomFieldGroup.md
+docs/ReleaseReadinessDefectSeverity.md
+docs/ReleaseReadinessDefects.md
+docs/ReleaseReadinessEvidence.md
+docs/ReleaseReadinessRequirementCoverage.md
+docs/ReleaseReadinessRequirementItem.md
+docs/ReleaseReadinessRequirementSummary.md
+docs/ReleaseReadinessSummary.md
+docs/ReleaseReadinessTestPlan.md
+docs/ReleaseReadinessTestPlanRun.md
+docs/ReleaseReadinessVerdict.md
+docs/ReleasesApi.md
 docs/ReportPayload.md
 docs/ReportResult.md
 docs/ReportsApi.md
@@ -412,6 +434,7 @@ src/apis/NotificationsApi.ts
 src/apis/ProjectUsersApi.ts
 src/apis/ProjectsApi.ts
 src/apis/ProjectsettingsApi.ts
+src/apis/ReleasesApi.ts
 src/apis/ReportsApi.ts
 src/apis/RequirementFoldersApi.ts
 src/apis/RequirementsApi.ts
@@ -443,6 +466,7 @@ src/apis/UsersApi.ts
 src/apis/index.ts
 src/index.ts
 src/models/Activity.ts
+src/models/ActivityAuditInfo.ts
 src/models/AddNewFolderPayload.ts
 src/models/AddRequirementPayload.ts
 src/models/AddRequirementPayloadFolder.ts
@@ -616,6 +640,26 @@ src/models/QueueStatus.ts
 src/models/QueueUpdatePayload.ts
 src/models/RegisteredUser.ts
 src/models/RegisteredUserUser.ts
+src/models/Release.ts
+src/models/ReleaseGoNoGoThreshold.ts
+src/models/ReleaseMinified.ts
+src/models/ReleasePayload.ts
+src/models/ReleaseReadiness.ts
+src/models/ReleaseReadinessComparison.ts
+src/models/ReleaseReadinessConfigurationCoverage.ts
+src/models/ReleaseReadinessCoverageItem.ts
+src/models/ReleaseReadinessCustomFieldCoverage.ts
+src/models/ReleaseReadinessCustomFieldGroup.ts
+src/models/ReleaseReadinessDefectSeverity.ts
+src/models/ReleaseReadinessDefects.ts
+src/models/ReleaseReadinessEvidence.ts
+src/models/ReleaseReadinessRequirementCoverage.ts
+src/models/ReleaseReadinessRequirementItem.ts
+src/models/ReleaseReadinessRequirementSummary.ts
+src/models/ReleaseReadinessSummary.ts
+src/models/ReleaseReadinessTestPlan.ts
+src/models/ReleaseReadinessTestPlanRun.ts
+src/models/ReleaseReadinessVerdict.ts
 src/models/ReportPayload.ts
 src/models/ReportResult.ts
 src/models/Requirement.ts

package/dist/apis/ReleasesApi.d.ts

@@ -0,0 +1,280 @@
+/**
+ * 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.
+ */
+import * as runtime from '../runtime';
+import type { Count, Release, ReleaseMinified, ReleasePayload, ReleaseReadiness } from '../models/index';
+export interface AddReleaseRequest {
+    releasePayload?: ReleasePayload;
+}
+export interface CountReleasesRequest {
+    project: number;
+    status?: CountReleasesStatusEnum;
+}
+export interface DeleteReleaseRequest {
+    id: number;
+    project: number;
+}
+export interface EditReleaseRequest {
+    id: number;
+    releasePayload?: ReleasePayload;
+}
+export interface GetReleaseRequest {
+    id: number;
+}
+export interface GetReleaseReadinessRequest {
+    id: number;
+}
+export interface GetReleaseReadinessByTokenRequest {
+    token: string;
+}
+export interface GetReleasesRequest {
+    project: number;
+    limit?: number;
+    start?: number;
+    sort?: string;
+    filter?: string;
+    status?: GetReleasesStatusEnum;
+}
+/**
+ * ReleasesApi - interface
+ *
+ * @export
+ * @interface ReleasesApiInterface
+ */
+export interface ReleasesApiInterface {
+    /**
+     * Creates a new release
+     * @summary Create a release
+     * @param {ReleasePayload} [releasePayload] Release to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    addReleaseRaw(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
+    /**
+     * Creates a new release
+     * Create a release
+     */
+    addRelease(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
+    /**
+     * Get count of releases for a specific project
+     * @summary Count releases
+     * @param {number} project Project ID
+     * @param {'planned' | 'in_progress' | 'ready' | 'shipped' | 'blocked'} [status] Filter by release status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    countReleasesRaw(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Count>>;
+    /**
+     * Get count of releases for a specific project
+     * Count releases
+     */
+    countReleases(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Count>;
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * @summary Delete a release
+     * @param {number} id Release ID
+     * @param {number} project Project ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    deleteReleaseRaw(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * Delete a release
+     */
+    deleteRelease(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Edits a specific release
+     * @summary Edit a release
+     * @param {number} id Release ID
+     * @param {ReleasePayload} [releasePayload] Updated release data
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    editReleaseRaw(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
+    /**
+     * Edits a specific release
+     * Edit a release
+     */
+    editRelease(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
+    /**
+     * Get details of a specific release
+     * @summary Get release
+     * @param {number} id Release ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    getReleaseRaw(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Release>>;
+    /**
+     * Get details of a specific release
+     * Get release
+     */
+    getRelease(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Release>;
+    /**
+     * 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.
+     * @summary Get release readiness dashboard data
+     * @param {number} id Release ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    getReleaseReadinessRaw(requestParameters: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
+    /**
+     * 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: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
+    /**
+     * 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.
+     * @summary Get release readiness by public token
+     * @param {string} token Public sharing token for the release
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    getReleaseReadinessByTokenRaw(requestParameters: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
+    /**
+     * 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: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
+    /**
+     * Get releases for a specific project
+     * @summary Get releases
+     * @param {number} project Project ID
+     * @param {number} [limit] Limit the size of the returned results
+     * @param {number} [start] Skip a specific number of entries (for pagination)
+     * @param {string} [sort] Sort according to a specific field.
+     * @param {string} [filter] Stringified filter object
+     * @param {'planned' | 'in_progress' | 'ready' | 'shipped' | 'blocked'} [status] Filter by release status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReleasesApiInterface
+     */
+    getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Release>>>;
+    /**
+     * Get releases for a specific project
+     * Get releases
+     */
+    getReleases(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Release>>;
+}
+/**
+ *
+ */
+export declare class ReleasesApi extends runtime.BaseAPI implements ReleasesApiInterface {
+    /**
+     * Creates a new release
+     * Create a release
+     */
+    addReleaseRaw(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
+    /**
+     * Creates a new release
+     * Create a release
+     */
+    addRelease(requestParameters?: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
+    /**
+     * Get count of releases for a specific project
+     * Count releases
+     */
+    countReleasesRaw(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Count>>;
+    /**
+     * Get count of releases for a specific project
+     * Count releases
+     */
+    countReleases(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Count>;
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * Delete a release
+     */
+    deleteReleaseRaw(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Deletes a specific release. Does not delete associated test plans.
+     * Delete a release
+     */
+    deleteRelease(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Edits a specific release
+     * Edit a release
+     */
+    editReleaseRaw(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
+    /**
+     * Edits a specific release
+     * Edit a release
+     */
+    editRelease(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
+    /**
+     * Get details of a specific release
+     * Get release
+     */
+    getReleaseRaw(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Release>>;
+    /**
+     * Get details of a specific release
+     * Get release
+     */
+    getRelease(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Release>;
+    /**
+     * 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: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
+    /**
+     * 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: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
+    /**
+     * 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: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
+    /**
+     * 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: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
+    /**
+     * Get releases for a specific project
+     * Get releases
+     */
+    getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Release>>>;
+    /**
+     * Get releases for a specific project
+     * Get releases
+     */
+    getReleases(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Release>>;
+}
+/**
+ * @export
+ */
+export declare const CountReleasesStatusEnum: {
+    readonly Planned: "planned";
+    readonly InProgress: "in_progress";
+    readonly Ready: "ready";
+    readonly Shipped: "shipped";
+    readonly Blocked: "blocked";
+};
+export type CountReleasesStatusEnum = typeof CountReleasesStatusEnum[keyof typeof CountReleasesStatusEnum];
+/**
+ * @export
+ */
+export declare const GetReleasesStatusEnum: {
+    readonly Planned: "planned";
+    readonly InProgress: "in_progress";
+    readonly Ready: "ready";
+    readonly Shipped: "shipped";
+    readonly Blocked: "blocked";
+};
+export type GetReleasesStatusEnum = typeof GetReleasesStatusEnum[keyof typeof GetReleasesStatusEnum];