@testcollab/sdk 3.10.0 → 3.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +46 -0
- package/dist/apis/ProjectsApi.d.ts +5 -5
- package/dist/apis/ProjectsApi.js +1 -1
- package/dist/apis/ReleasesApi.d.ts +280 -0
- package/dist/apis/ReleasesApi.js +379 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ProjectsApi.d.ts +5 -5
- package/dist/esm/apis/ProjectsApi.js +2 -2
- package/dist/esm/apis/ReleasesApi.d.ts +280 -0
- package/dist/esm/apis/ReleasesApi.js +375 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Activity.d.ts +9 -0
- package/dist/esm/models/Activity.js +6 -1
- package/dist/esm/models/ActivityAuditInfo.d.ts +44 -0
- package/dist/esm/models/ActivityAuditInfo.js +45 -0
- package/dist/esm/models/ProjectListItem.d.ts +93 -0
- package/dist/esm/models/ProjectListItem.js +72 -0
- package/dist/esm/models/Release.d.ts +131 -0
- package/dist/esm/models/Release.js +95 -0
- package/dist/esm/models/ReleaseGoNoGoThreshold.d.ts +45 -0
- package/dist/esm/models/ReleaseGoNoGoThreshold.js +45 -0
- package/dist/esm/models/ReleaseMinified.d.ts +67 -0
- package/dist/esm/models/ReleaseMinified.js +65 -0
- package/dist/esm/models/ReleasePayload.d.ts +98 -0
- package/dist/esm/models/ReleasePayload.js +75 -0
- package/dist/esm/models/ReleaseReadiness.d.ts +106 -0
- package/dist/esm/models/ReleaseReadiness.js +79 -0
- package/dist/esm/models/ReleaseReadinessComparison.d.ts +52 -0
- package/dist/esm/models/ReleaseReadinessComparison.js +47 -0
- package/dist/esm/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
- package/dist/esm/models/ReleaseReadinessConfigurationCoverage.js +71 -0
- package/dist/esm/models/ReleaseReadinessCoverageItem.d.ts +75 -0
- package/dist/esm/models/ReleaseReadinessCoverageItem.js +65 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.js +75 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
- package/dist/esm/models/ReleaseReadinessCustomFieldGroup.js +69 -0
- package/dist/esm/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
- package/dist/esm/models/ReleaseReadinessDefectSeverity.js +47 -0
- package/dist/esm/models/ReleaseReadinessDefects.d.ts +46 -0
- package/dist/esm/models/ReleaseReadinessDefects.js +52 -0
- package/dist/esm/models/ReleaseReadinessEvidence.d.ts +45 -0
- package/dist/esm/models/ReleaseReadinessEvidence.js +51 -0
- package/dist/esm/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
- package/dist/esm/models/ReleaseReadinessRequirementCoverage.js +48 -0
- package/dist/esm/models/ReleaseReadinessRequirementItem.d.ts +92 -0
- package/dist/esm/models/ReleaseReadinessRequirementItem.js +84 -0
- package/dist/esm/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
- package/dist/esm/models/ReleaseReadinessRequirementSummary.js +59 -0
- package/dist/esm/models/ReleaseReadinessSummary.d.ts +70 -0
- package/dist/esm/models/ReleaseReadinessSummary.js +51 -0
- package/dist/esm/models/ReleaseReadinessTestPlan.d.ts +69 -0
- package/dist/esm/models/ReleaseReadinessTestPlan.js +68 -0
- package/dist/esm/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
- package/dist/esm/models/ReleaseReadinessTestPlanRun.js +51 -0
- package/dist/esm/models/ReleaseReadinessVerdict.d.ts +50 -0
- package/dist/esm/models/ReleaseReadinessVerdict.js +56 -0
- package/dist/esm/models/StepWiseResult.d.ts +6 -0
- package/dist/esm/models/StepWiseResult.js +2 -0
- package/dist/esm/models/TestDatasetWiseResult.d.ts +6 -0
- package/dist/esm/models/TestDatasetWiseResult.js +2 -0
- package/dist/esm/models/TestPlan.d.ts +7 -0
- package/dist/esm/models/TestPlan.js +2 -0
- package/dist/esm/models/TestPlanBulkActionPayload.d.ts +6 -0
- package/dist/esm/models/TestPlanBulkActionPayload.js +2 -0
- package/dist/esm/models/TestPlanPayload.d.ts +6 -0
- package/dist/esm/models/TestPlanPayload.js +2 -0
- package/dist/esm/models/TraceabilityMatrixPayload.d.ts +7 -0
- package/dist/esm/models/TraceabilityMatrixPayload.js +2 -0
- package/dist/esm/models/index.d.ts +22 -0
- package/dist/esm/models/index.js +22 -0
- package/dist/models/Activity.d.ts +9 -0
- package/dist/models/Activity.js +6 -1
- package/dist/models/ActivityAuditInfo.d.ts +44 -0
- package/dist/models/ActivityAuditInfo.js +52 -0
- package/dist/models/ProjectListItem.d.ts +93 -0
- package/dist/models/ProjectListItem.js +79 -0
- package/dist/models/Release.d.ts +131 -0
- package/dist/models/Release.js +103 -0
- package/dist/models/ReleaseGoNoGoThreshold.d.ts +45 -0
- package/dist/models/ReleaseGoNoGoThreshold.js +52 -0
- package/dist/models/ReleaseMinified.d.ts +67 -0
- package/dist/models/ReleaseMinified.js +73 -0
- package/dist/models/ReleasePayload.d.ts +98 -0
- package/dist/models/ReleasePayload.js +83 -0
- package/dist/models/ReleaseReadiness.d.ts +106 -0
- package/dist/models/ReleaseReadiness.js +86 -0
- package/dist/models/ReleaseReadinessComparison.d.ts +52 -0
- package/dist/models/ReleaseReadinessComparison.js +54 -0
- package/dist/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
- package/dist/models/ReleaseReadinessConfigurationCoverage.js +78 -0
- package/dist/models/ReleaseReadinessCoverageItem.d.ts +75 -0
- package/dist/models/ReleaseReadinessCoverageItem.js +72 -0
- package/dist/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
- package/dist/models/ReleaseReadinessCustomFieldCoverage.js +83 -0
- package/dist/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
- package/dist/models/ReleaseReadinessCustomFieldGroup.js +76 -0
- package/dist/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
- package/dist/models/ReleaseReadinessDefectSeverity.js +54 -0
- package/dist/models/ReleaseReadinessDefects.d.ts +46 -0
- package/dist/models/ReleaseReadinessDefects.js +59 -0
- package/dist/models/ReleaseReadinessEvidence.d.ts +45 -0
- package/dist/models/ReleaseReadinessEvidence.js +58 -0
- package/dist/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
- package/dist/models/ReleaseReadinessRequirementCoverage.js +55 -0
- package/dist/models/ReleaseReadinessRequirementItem.d.ts +92 -0
- package/dist/models/ReleaseReadinessRequirementItem.js +92 -0
- package/dist/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
- package/dist/models/ReleaseReadinessRequirementSummary.js +66 -0
- package/dist/models/ReleaseReadinessSummary.d.ts +70 -0
- package/dist/models/ReleaseReadinessSummary.js +58 -0
- package/dist/models/ReleaseReadinessTestPlan.d.ts +69 -0
- package/dist/models/ReleaseReadinessTestPlan.js +76 -0
- package/dist/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
- package/dist/models/ReleaseReadinessTestPlanRun.js +58 -0
- package/dist/models/ReleaseReadinessVerdict.d.ts +50 -0
- package/dist/models/ReleaseReadinessVerdict.js +64 -0
- package/dist/models/StepWiseResult.d.ts +6 -0
- package/dist/models/StepWiseResult.js +2 -0
- package/dist/models/TestDatasetWiseResult.d.ts +6 -0
- package/dist/models/TestDatasetWiseResult.js +2 -0
- package/dist/models/TestPlan.d.ts +7 -0
- package/dist/models/TestPlan.js +2 -0
- package/dist/models/TestPlanBulkActionPayload.d.ts +6 -0
- package/dist/models/TestPlanBulkActionPayload.js +2 -0
- package/dist/models/TestPlanPayload.d.ts +6 -0
- package/dist/models/TestPlanPayload.js +2 -0
- package/dist/models/TraceabilityMatrixPayload.d.ts +7 -0
- package/dist/models/TraceabilityMatrixPayload.js +2 -0
- package/dist/models/index.d.ts +22 -0
- package/dist/models/index.js +22 -0
- package/docs/Activity.md +2 -0
- package/docs/ActivityAuditInfo.md +39 -0
- package/docs/ProjectListItem.md +54 -0
- package/docs/ProjectsApi.md +2 -2
- package/docs/Release.md +62 -0
- package/docs/ReleaseGoNoGoThreshold.md +39 -0
- package/docs/ReleaseMinified.md +42 -0
- package/docs/ReleasePayload.md +52 -0
- package/docs/ReleaseReadiness.md +55 -0
- package/docs/ReleaseReadinessComparison.md +41 -0
- package/docs/ReleaseReadinessConfigurationCoverage.md +51 -0
- package/docs/ReleaseReadinessCoverageItem.md +49 -0
- package/docs/ReleaseReadinessCustomFieldCoverage.md +43 -0
- package/docs/ReleaseReadinessCustomFieldGroup.md +49 -0
- package/docs/ReleaseReadinessDefectSeverity.md +36 -0
- package/docs/ReleaseReadinessDefects.md +39 -0
- package/docs/ReleaseReadinessEvidence.md +39 -0
- package/docs/ReleaseReadinessRequirementCoverage.md +37 -0
- package/docs/ReleaseReadinessRequirementItem.md +51 -0
- package/docs/ReleaseReadinessRequirementSummary.md +43 -0
- package/docs/ReleaseReadinessSummary.md +47 -0
- package/docs/ReleaseReadinessTestPlan.md +43 -0
- package/docs/ReleaseReadinessTestPlanRun.md +41 -0
- package/docs/ReleaseReadinessVerdict.md +37 -0
- package/docs/ReleasesApi.md +655 -0
- package/docs/StepWiseResult.md +2 -0
- package/docs/TestDatasetWiseResult.md +2 -0
- package/docs/TestPlan.md +2 -0
- package/docs/TestPlanBulkActionPayload.md +2 -0
- package/docs/TestPlanPayload.md +2 -0
- package/docs/TraceabilityMatrixPayload.md +2 -0
- package/package.json +1 -1
- package/src/apis/ProjectsApi.ts +8 -5
- package/src/apis/ReleasesApi.ts +663 -0
- package/src/apis/index.ts +1 -0
- package/src/models/Activity.ts +18 -1
- package/src/models/ActivityAuditInfo.ts +81 -0
- package/src/models/ProjectListItem.ts +158 -0
- package/src/models/Release.ts +227 -0
- package/src/models/ReleaseGoNoGoThreshold.ts +82 -0
- package/src/models/ReleaseMinified.ts +114 -0
- package/src/models/ReleasePayload.ts +162 -0
- package/src/models/ReleaseReadiness.ts +233 -0
- package/src/models/ReleaseReadinessComparison.ts +98 -0
- package/src/models/ReleaseReadinessConfigurationCoverage.ts +138 -0
- package/src/models/ReleaseReadinessCoverageItem.ts +127 -0
- package/src/models/ReleaseReadinessCustomFieldCoverage.ts +133 -0
- package/src/models/ReleaseReadinessCustomFieldGroup.ts +129 -0
- package/src/models/ReleaseReadinessDefectSeverity.ts +75 -0
- package/src/models/ReleaseReadinessDefects.ts +93 -0
- package/src/models/ReleaseReadinessEvidence.ts +85 -0
- package/src/models/ReleaseReadinessRequirementCoverage.ts +91 -0
- package/src/models/ReleaseReadinessRequirementItem.ts +153 -0
- package/src/models/ReleaseReadinessRequirementSummary.ts +103 -0
- package/src/models/ReleaseReadinessSummary.ts +124 -0
- package/src/models/ReleaseReadinessTestPlan.ts +131 -0
- package/src/models/ReleaseReadinessTestPlanRun.ts +92 -0
- package/src/models/ReleaseReadinessVerdict.ts +90 -0
- package/src/models/StepWiseResult.ts +8 -0
- package/src/models/TestDatasetWiseResult.ts +8 -0
- package/src/models/TestPlan.ts +15 -0
- package/src/models/TestPlanBulkActionPayload.ts +8 -0
- package/src/models/TestPlanPayload.ts +8 -0
- package/src/models/TraceabilityMatrixPayload.ts +9 -0
- package/src/models/index.ts +22 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Minimal info about the latest run (regression) of a test plan within the release.
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ReleaseReadinessTestPlanRun
|
|
17
|
+
*/
|
|
18
|
+
export interface ReleaseReadinessTestPlanRun {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof ReleaseReadinessTestPlanRun
|
|
23
|
+
*/
|
|
24
|
+
id: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof ReleaseReadinessTestPlanRun
|
|
29
|
+
*/
|
|
30
|
+
iteration: number;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ReleaseReadinessTestPlanRun
|
|
35
|
+
*/
|
|
36
|
+
status?: string;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof ReleaseReadinessTestPlanRun
|
|
41
|
+
*/
|
|
42
|
+
createdAt?: string;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the ReleaseReadinessTestPlanRun interface.
|
|
46
|
+
*/
|
|
47
|
+
export declare function instanceOfReleaseReadinessTestPlanRun(value: object): value is ReleaseReadinessTestPlanRun;
|
|
48
|
+
export declare function ReleaseReadinessTestPlanRunFromJSON(json: any): ReleaseReadinessTestPlanRun;
|
|
49
|
+
export declare function ReleaseReadinessTestPlanRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessTestPlanRun;
|
|
50
|
+
export declare function ReleaseReadinessTestPlanRunToJSON(json: any): ReleaseReadinessTestPlanRun;
|
|
51
|
+
export declare function ReleaseReadinessTestPlanRunToJSONTyped(value?: ReleaseReadinessTestPlanRun | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* TC API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.3.1
|
|
9
|
+
* Contact: support@testcollab.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfReleaseReadinessTestPlanRun = instanceOfReleaseReadinessTestPlanRun;
|
|
17
|
+
exports.ReleaseReadinessTestPlanRunFromJSON = ReleaseReadinessTestPlanRunFromJSON;
|
|
18
|
+
exports.ReleaseReadinessTestPlanRunFromJSONTyped = ReleaseReadinessTestPlanRunFromJSONTyped;
|
|
19
|
+
exports.ReleaseReadinessTestPlanRunToJSON = ReleaseReadinessTestPlanRunToJSON;
|
|
20
|
+
exports.ReleaseReadinessTestPlanRunToJSONTyped = ReleaseReadinessTestPlanRunToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ReleaseReadinessTestPlanRun interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfReleaseReadinessTestPlanRun(value) {
|
|
25
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('iteration' in value) || value['iteration'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
function ReleaseReadinessTestPlanRunFromJSON(json) {
|
|
32
|
+
return ReleaseReadinessTestPlanRunFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
function ReleaseReadinessTestPlanRunFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'id': json['id'],
|
|
40
|
+
'iteration': json['iteration'],
|
|
41
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
42
|
+
'createdAt': json['created_at'] == null ? undefined : json['created_at'],
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
function ReleaseReadinessTestPlanRunToJSON(json) {
|
|
46
|
+
return ReleaseReadinessTestPlanRunToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function ReleaseReadinessTestPlanRunToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'id': value['id'],
|
|
54
|
+
'iteration': value['iteration'],
|
|
55
|
+
'status': value['status'],
|
|
56
|
+
'created_at': value['createdAt'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Computed Go/No-Go verdict based on the release's go_no_go_threshold settings compared against actual metrics.
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ReleaseReadinessVerdict
|
|
17
|
+
*/
|
|
18
|
+
export interface ReleaseReadinessVerdict {
|
|
19
|
+
/**
|
|
20
|
+
* go = all thresholds met; no_go = one or more thresholds violated; at_risk = within 5% of a threshold; not_configured = no thresholds set on the release
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof ReleaseReadinessVerdict
|
|
24
|
+
*/
|
|
25
|
+
result: ReleaseReadinessVerdictResultEnum;
|
|
26
|
+
/**
|
|
27
|
+
* List of human-readable reasons for the verdict
|
|
28
|
+
* @type {Array<string>}
|
|
29
|
+
* @memberof ReleaseReadinessVerdict
|
|
30
|
+
*/
|
|
31
|
+
reasons: Array<string>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @export
|
|
35
|
+
*/
|
|
36
|
+
export declare const ReleaseReadinessVerdictResultEnum: {
|
|
37
|
+
readonly Go: "go";
|
|
38
|
+
readonly NoGo: "no_go";
|
|
39
|
+
readonly AtRisk: "at_risk";
|
|
40
|
+
readonly NotConfigured: "not_configured";
|
|
41
|
+
};
|
|
42
|
+
export type ReleaseReadinessVerdictResultEnum = typeof ReleaseReadinessVerdictResultEnum[keyof typeof ReleaseReadinessVerdictResultEnum];
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the ReleaseReadinessVerdict interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfReleaseReadinessVerdict(value: object): value is ReleaseReadinessVerdict;
|
|
47
|
+
export declare function ReleaseReadinessVerdictFromJSON(json: any): ReleaseReadinessVerdict;
|
|
48
|
+
export declare function ReleaseReadinessVerdictFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessVerdict;
|
|
49
|
+
export declare function ReleaseReadinessVerdictToJSON(json: any): ReleaseReadinessVerdict;
|
|
50
|
+
export declare function ReleaseReadinessVerdictToJSONTyped(value?: ReleaseReadinessVerdict | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* TC API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.3.1
|
|
9
|
+
* Contact: support@testcollab.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ReleaseReadinessVerdictResultEnum = void 0;
|
|
17
|
+
exports.instanceOfReleaseReadinessVerdict = instanceOfReleaseReadinessVerdict;
|
|
18
|
+
exports.ReleaseReadinessVerdictFromJSON = ReleaseReadinessVerdictFromJSON;
|
|
19
|
+
exports.ReleaseReadinessVerdictFromJSONTyped = ReleaseReadinessVerdictFromJSONTyped;
|
|
20
|
+
exports.ReleaseReadinessVerdictToJSON = ReleaseReadinessVerdictToJSON;
|
|
21
|
+
exports.ReleaseReadinessVerdictToJSONTyped = ReleaseReadinessVerdictToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.ReleaseReadinessVerdictResultEnum = {
|
|
26
|
+
Go: 'go',
|
|
27
|
+
NoGo: 'no_go',
|
|
28
|
+
AtRisk: 'at_risk',
|
|
29
|
+
NotConfigured: 'not_configured'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the ReleaseReadinessVerdict interface.
|
|
33
|
+
*/
|
|
34
|
+
function instanceOfReleaseReadinessVerdict(value) {
|
|
35
|
+
if (!('result' in value) || value['result'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('reasons' in value) || value['reasons'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
function ReleaseReadinessVerdictFromJSON(json) {
|
|
42
|
+
return ReleaseReadinessVerdictFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
function ReleaseReadinessVerdictFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
if (json == null) {
|
|
46
|
+
return json;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'result': json['result'],
|
|
50
|
+
'reasons': json['reasons'],
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
function ReleaseReadinessVerdictToJSON(json) {
|
|
54
|
+
return ReleaseReadinessVerdictToJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
function ReleaseReadinessVerdictToJSONTyped(value, ignoreDiscriminator = false) {
|
|
57
|
+
if (value == null) {
|
|
58
|
+
return value;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
'result': value['result'],
|
|
62
|
+
'reasons': value['reasons'],
|
|
63
|
+
};
|
|
64
|
+
}
|
|
@@ -45,6 +45,12 @@ export interface StepWiseResult {
|
|
|
45
45
|
* @memberof StepWiseResult
|
|
46
46
|
*/
|
|
47
47
|
comment: string;
|
|
48
|
+
/**
|
|
49
|
+
* ID of the user who wrote the comment
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof StepWiseResult
|
|
52
|
+
*/
|
|
53
|
+
commentBy?: number;
|
|
48
54
|
/**
|
|
49
55
|
* Array of user IDs
|
|
50
56
|
* @type {Array<string>}
|
|
@@ -43,6 +43,7 @@ function StepWiseResultFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
43
|
'expectedResult': json['expected_result'] == null ? undefined : json['expected_result'],
|
|
44
44
|
'status': json['status'],
|
|
45
45
|
'comment': json['comment'],
|
|
46
|
+
'commentBy': json['comment_by'] == null ? undefined : json['comment_by'],
|
|
46
47
|
'mentions': json['mentions'] == null ? undefined : json['mentions'],
|
|
47
48
|
'attachments': json['attachments'] == null ? undefined : json['attachments'],
|
|
48
49
|
};
|
|
@@ -60,6 +61,7 @@ function StepWiseResultToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
60
61
|
'expected_result': value['expectedResult'],
|
|
61
62
|
'status': value['status'],
|
|
62
63
|
'comment': value['comment'],
|
|
64
|
+
'comment_by': value['commentBy'],
|
|
63
65
|
'mentions': value['mentions'],
|
|
64
66
|
'attachments': value['attachments'],
|
|
65
67
|
};
|
|
@@ -57,6 +57,12 @@ export interface TestDatasetWiseResult {
|
|
|
57
57
|
* @memberof TestDatasetWiseResult
|
|
58
58
|
*/
|
|
59
59
|
comment: string;
|
|
60
|
+
/**
|
|
61
|
+
* ID of the user who wrote the comment
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof TestDatasetWiseResult
|
|
64
|
+
*/
|
|
65
|
+
commentBy?: number;
|
|
60
66
|
/**
|
|
61
67
|
* Array of user IDs
|
|
62
68
|
* @type {Array<string>}
|
|
@@ -47,6 +47,7 @@ function TestDatasetWiseResultFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
47
|
'expectedResult': json['expected_result'] == null ? undefined : json['expected_result'],
|
|
48
48
|
'status': json['status'],
|
|
49
49
|
'comment': json['comment'],
|
|
50
|
+
'commentBy': json['comment_by'] == null ? undefined : json['comment_by'],
|
|
50
51
|
'mentions': json['mentions'] == null ? undefined : json['mentions'],
|
|
51
52
|
'attachments': json['attachments'] == null ? undefined : json['attachments'],
|
|
52
53
|
};
|
|
@@ -66,6 +67,7 @@ function TestDatasetWiseResultToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
66
67
|
'expected_result': value['expectedResult'],
|
|
67
68
|
'status': value['status'],
|
|
68
69
|
'comment': value['comment'],
|
|
70
|
+
'comment_by': value['commentBy'],
|
|
69
71
|
'mentions': value['mentions'],
|
|
70
72
|
'attachments': value['attachments'],
|
|
71
73
|
};
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ReleaseMinified } from './ReleaseMinified';
|
|
12
13
|
import type { TestPlanFolder } from './TestPlanFolder';
|
|
13
14
|
import type { UserMinified } from './UserMinified';
|
|
14
15
|
import type { TestPlanResults } from './TestPlanResults';
|
|
@@ -139,6 +140,12 @@ export interface TestPlan {
|
|
|
139
140
|
* @memberof TestPlan
|
|
140
141
|
*/
|
|
141
142
|
isPublic?: number;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {ReleaseMinified}
|
|
146
|
+
* @memberof TestPlan
|
|
147
|
+
*/
|
|
148
|
+
release?: ReleaseMinified;
|
|
142
149
|
}
|
|
143
150
|
/**
|
|
144
151
|
* @export
|
package/dist/models/TestPlan.js
CHANGED
|
@@ -92,6 +92,7 @@ function TestPlanFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
92
92
|
'description': json['description'] == null ? undefined : json['description'],
|
|
93
93
|
'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputFromJSON)),
|
|
94
94
|
'isPublic': json['is_public'] == null ? undefined : json['is_public'],
|
|
95
|
+
'release': json['release'] == null ? undefined : json['release'],
|
|
95
96
|
};
|
|
96
97
|
}
|
|
97
98
|
function TestPlanToJSON(json) {
|
|
@@ -122,5 +123,6 @@ function TestPlanToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
122
123
|
'description': value['description'],
|
|
123
124
|
'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputToJSON)),
|
|
124
125
|
'is_public': value['isPublic'],
|
|
126
|
+
'release': value['release'],
|
|
125
127
|
};
|
|
126
128
|
}
|
|
@@ -58,6 +58,12 @@ export interface TestPlanBulkActionPayload {
|
|
|
58
58
|
* @memberof TestPlanBulkActionPayload
|
|
59
59
|
*/
|
|
60
60
|
endDate?: string;
|
|
61
|
+
/**
|
|
62
|
+
* Release ID to associate test plans with (optional)
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof TestPlanBulkActionPayload
|
|
65
|
+
*/
|
|
66
|
+
release?: number;
|
|
61
67
|
/**
|
|
62
68
|
* Array of custom fields
|
|
63
69
|
* @type {Array<CustomFieldInputPayload>}
|
|
@@ -57,6 +57,7 @@ function TestPlanBulkActionPayloadFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
57
|
'testPlanFolder': json['test_plan_folder'] == null ? undefined : json['test_plan_folder'],
|
|
58
58
|
'startDate': json['start_date'] == null ? undefined : json['start_date'],
|
|
59
59
|
'endDate': json['end_date'] == null ? undefined : json['end_date'],
|
|
60
|
+
'release': json['release'] == null ? undefined : json['release'],
|
|
60
61
|
'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadFromJSON)),
|
|
61
62
|
};
|
|
62
63
|
}
|
|
@@ -75,6 +76,7 @@ function TestPlanBulkActionPayloadToJSONTyped(value, ignoreDiscriminator = false
|
|
|
75
76
|
'test_plan_folder': value['testPlanFolder'],
|
|
76
77
|
'start_date': value['startDate'],
|
|
77
78
|
'end_date': value['endDate'],
|
|
79
|
+
'release': value['release'],
|
|
78
80
|
'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadToJSON)),
|
|
79
81
|
};
|
|
80
82
|
}
|
|
@@ -76,6 +76,12 @@ export interface TestPlanPayload {
|
|
|
76
76
|
* @memberof TestPlanPayload
|
|
77
77
|
*/
|
|
78
78
|
project: number;
|
|
79
|
+
/**
|
|
80
|
+
* Release ID to associate this test plan with (optional)
|
|
81
|
+
* @type {number}
|
|
82
|
+
* @memberof TestPlanPayload
|
|
83
|
+
*/
|
|
84
|
+
release?: number;
|
|
79
85
|
/**
|
|
80
86
|
* Array of custom fields
|
|
81
87
|
* @type {Array<CustomFieldInputPayload>}
|
|
@@ -71,6 +71,7 @@ function TestPlanPayloadFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
71
71
|
'startDate': json['start_date'] == null ? undefined : json['start_date'],
|
|
72
72
|
'endDate': json['end_date'] == null ? undefined : json['end_date'],
|
|
73
73
|
'project': json['project'],
|
|
74
|
+
'release': json['release'] == null ? undefined : json['release'],
|
|
74
75
|
'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadFromJSON)),
|
|
75
76
|
};
|
|
76
77
|
}
|
|
@@ -92,6 +93,7 @@ function TestPlanPayloadToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
92
93
|
'start_date': value['startDate'],
|
|
93
94
|
'end_date': value['endDate'],
|
|
94
95
|
'project': value['project'],
|
|
96
|
+
'release': value['release'],
|
|
95
97
|
'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadToJSON)),
|
|
96
98
|
};
|
|
97
99
|
}
|
|
@@ -33,6 +33,13 @@ export interface TraceabilityMatrixPayload {
|
|
|
33
33
|
* @memberof TraceabilityMatrixPayload
|
|
34
34
|
*/
|
|
35
35
|
forceRefresh?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Optional release ID. When provided, the traceability matrix is filtered to only include test cases that belong to test plans in this release, and only requirements linked to this release.
|
|
38
|
+
*
|
|
39
|
+
* @type {number}
|
|
40
|
+
* @memberof TraceabilityMatrixPayload
|
|
41
|
+
*/
|
|
42
|
+
release?: number;
|
|
36
43
|
}
|
|
37
44
|
/**
|
|
38
45
|
* Check if a given object implements the TraceabilityMatrixPayload interface.
|
|
@@ -37,6 +37,7 @@ function TraceabilityMatrixPayloadFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
37
|
'filterModel': json['filterModel'] == null ? undefined : json['filterModel'],
|
|
38
38
|
'project': json['project'],
|
|
39
39
|
'forceRefresh': json['force_refresh'] == null ? undefined : json['force_refresh'],
|
|
40
|
+
'release': json['release'] == null ? undefined : json['release'],
|
|
40
41
|
};
|
|
41
42
|
}
|
|
42
43
|
function TraceabilityMatrixPayloadToJSON(json) {
|
|
@@ -50,5 +51,6 @@ function TraceabilityMatrixPayloadToJSONTyped(value, ignoreDiscriminator = false
|
|
|
50
51
|
'filterModel': value['filterModel'],
|
|
51
52
|
'project': value['project'],
|
|
52
53
|
'force_refresh': value['forceRefresh'],
|
|
54
|
+
'release': value['release'],
|
|
53
55
|
};
|
|
54
56
|
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from './Activity';
|
|
2
|
+
export * from './ActivityAuditInfo';
|
|
2
3
|
export * from './AddNewFolderPayload';
|
|
3
4
|
export * from './AddRequirementPayload';
|
|
4
5
|
export * from './AddRequirementPayloadFolder';
|
|
@@ -145,6 +146,7 @@ export * from './PreferencePayload';
|
|
|
145
146
|
export * from './Project';
|
|
146
147
|
export * from './ProjectActivity';
|
|
147
148
|
export * from './ProjectCreatePayload';
|
|
149
|
+
export * from './ProjectListItem';
|
|
148
150
|
export * from './ProjectMetrics';
|
|
149
151
|
export * from './ProjectMini';
|
|
150
152
|
export * from './ProjectMinified';
|
|
@@ -171,6 +173,26 @@ export * from './QueueStatus';
|
|
|
171
173
|
export * from './QueueUpdatePayload';
|
|
172
174
|
export * from './RegisteredUser';
|
|
173
175
|
export * from './RegisteredUserUser';
|
|
176
|
+
export * from './Release';
|
|
177
|
+
export * from './ReleaseGoNoGoThreshold';
|
|
178
|
+
export * from './ReleaseMinified';
|
|
179
|
+
export * from './ReleasePayload';
|
|
180
|
+
export * from './ReleaseReadiness';
|
|
181
|
+
export * from './ReleaseReadinessComparison';
|
|
182
|
+
export * from './ReleaseReadinessConfigurationCoverage';
|
|
183
|
+
export * from './ReleaseReadinessCoverageItem';
|
|
184
|
+
export * from './ReleaseReadinessCustomFieldCoverage';
|
|
185
|
+
export * from './ReleaseReadinessCustomFieldGroup';
|
|
186
|
+
export * from './ReleaseReadinessDefectSeverity';
|
|
187
|
+
export * from './ReleaseReadinessDefects';
|
|
188
|
+
export * from './ReleaseReadinessEvidence';
|
|
189
|
+
export * from './ReleaseReadinessRequirementCoverage';
|
|
190
|
+
export * from './ReleaseReadinessRequirementItem';
|
|
191
|
+
export * from './ReleaseReadinessRequirementSummary';
|
|
192
|
+
export * from './ReleaseReadinessSummary';
|
|
193
|
+
export * from './ReleaseReadinessTestPlan';
|
|
194
|
+
export * from './ReleaseReadinessTestPlanRun';
|
|
195
|
+
export * from './ReleaseReadinessVerdict';
|
|
174
196
|
export * from './ReportPayload';
|
|
175
197
|
export * from './ReportResult';
|
|
176
198
|
export * from './Requirement';
|
package/dist/models/index.js
CHANGED
|
@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
19
|
__exportStar(require("./Activity"), exports);
|
|
20
|
+
__exportStar(require("./ActivityAuditInfo"), exports);
|
|
20
21
|
__exportStar(require("./AddNewFolderPayload"), exports);
|
|
21
22
|
__exportStar(require("./AddRequirementPayload"), exports);
|
|
22
23
|
__exportStar(require("./AddRequirementPayloadFolder"), exports);
|
|
@@ -163,6 +164,7 @@ __exportStar(require("./PreferencePayload"), exports);
|
|
|
163
164
|
__exportStar(require("./Project"), exports);
|
|
164
165
|
__exportStar(require("./ProjectActivity"), exports);
|
|
165
166
|
__exportStar(require("./ProjectCreatePayload"), exports);
|
|
167
|
+
__exportStar(require("./ProjectListItem"), exports);
|
|
166
168
|
__exportStar(require("./ProjectMetrics"), exports);
|
|
167
169
|
__exportStar(require("./ProjectMini"), exports);
|
|
168
170
|
__exportStar(require("./ProjectMinified"), exports);
|
|
@@ -189,6 +191,26 @@ __exportStar(require("./QueueStatus"), exports);
|
|
|
189
191
|
__exportStar(require("./QueueUpdatePayload"), exports);
|
|
190
192
|
__exportStar(require("./RegisteredUser"), exports);
|
|
191
193
|
__exportStar(require("./RegisteredUserUser"), exports);
|
|
194
|
+
__exportStar(require("./Release"), exports);
|
|
195
|
+
__exportStar(require("./ReleaseGoNoGoThreshold"), exports);
|
|
196
|
+
__exportStar(require("./ReleaseMinified"), exports);
|
|
197
|
+
__exportStar(require("./ReleasePayload"), exports);
|
|
198
|
+
__exportStar(require("./ReleaseReadiness"), exports);
|
|
199
|
+
__exportStar(require("./ReleaseReadinessComparison"), exports);
|
|
200
|
+
__exportStar(require("./ReleaseReadinessConfigurationCoverage"), exports);
|
|
201
|
+
__exportStar(require("./ReleaseReadinessCoverageItem"), exports);
|
|
202
|
+
__exportStar(require("./ReleaseReadinessCustomFieldCoverage"), exports);
|
|
203
|
+
__exportStar(require("./ReleaseReadinessCustomFieldGroup"), exports);
|
|
204
|
+
__exportStar(require("./ReleaseReadinessDefectSeverity"), exports);
|
|
205
|
+
__exportStar(require("./ReleaseReadinessDefects"), exports);
|
|
206
|
+
__exportStar(require("./ReleaseReadinessEvidence"), exports);
|
|
207
|
+
__exportStar(require("./ReleaseReadinessRequirementCoverage"), exports);
|
|
208
|
+
__exportStar(require("./ReleaseReadinessRequirementItem"), exports);
|
|
209
|
+
__exportStar(require("./ReleaseReadinessRequirementSummary"), exports);
|
|
210
|
+
__exportStar(require("./ReleaseReadinessSummary"), exports);
|
|
211
|
+
__exportStar(require("./ReleaseReadinessTestPlan"), exports);
|
|
212
|
+
__exportStar(require("./ReleaseReadinessTestPlanRun"), exports);
|
|
213
|
+
__exportStar(require("./ReleaseReadinessVerdict"), exports);
|
|
192
214
|
__exportStar(require("./ReportPayload"), exports);
|
|
193
215
|
__exportStar(require("./ReportResult"), exports);
|
|
194
216
|
__exportStar(require("./Requirement"), exports);
|
package/docs/Activity.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`project` | [ProjectMini](ProjectMini.md)
|
|
15
15
|
`activityType` | string
|
|
16
16
|
`user` | [User](User.md)
|
|
17
|
+
`auditInfo` | [ActivityAuditInfo](ActivityAuditInfo.md)
|
|
17
18
|
`createdAt` | string
|
|
18
19
|
`updatedAt` | string
|
|
19
20
|
|
|
@@ -32,6 +33,7 @@ const example = {
|
|
|
32
33
|
"project": null,
|
|
33
34
|
"activityType": add,
|
|
34
35
|
"user": null,
|
|
36
|
+
"auditInfo": null,
|
|
35
37
|
"createdAt": 2019-04-30T17:11:24.000Z,
|
|
36
38
|
"updatedAt": 2019-04-30T17:11:24.000Z,
|
|
37
39
|
} satisfies Activity
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# ActivityAuditInfo
|
|
3
|
+
|
|
4
|
+
Additional metadata for the activity (e.g. release name, old/new verdict)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`releaseName` | string
|
|
11
|
+
`oldVerdict` | string
|
|
12
|
+
`newVerdict` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ActivityAuditInfo } from '@testcollab/sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"releaseName": v1,
|
|
22
|
+
"oldVerdict": No-Go,
|
|
23
|
+
"newVerdict": Go,
|
|
24
|
+
} satisfies ActivityAuditInfo
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as ActivityAuditInfo
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
|
|
2
|
+
# ProjectListItem
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`description` | string
|
|
12
|
+
`archived` | boolean
|
|
13
|
+
`team` | [Array<ProjectUserMinified>](ProjectUserMinified.md)
|
|
14
|
+
`activity` | string
|
|
15
|
+
`createdAt` | string
|
|
16
|
+
`updatedAt` | string
|
|
17
|
+
`isSample` | boolean
|
|
18
|
+
`testCaseCount` | number
|
|
19
|
+
`testPlanCount` | number
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import type { ProjectListItem } from '@testcollab/sdk'
|
|
25
|
+
|
|
26
|
+
// TODO: Update the object below with actual values
|
|
27
|
+
const example = {
|
|
28
|
+
"id": 1,
|
|
29
|
+
"name": Crowd Vox,
|
|
30
|
+
"description": QA workspace for the customer web app,
|
|
31
|
+
"archived": false,
|
|
32
|
+
"team": null,
|
|
33
|
+
"activity": 2017-06-05,
|
|
34
|
+
"createdAt": 2019-04-30T17:11:24.000Z,
|
|
35
|
+
"updatedAt": 2019-04-30T17:11:24.000Z,
|
|
36
|
+
"isSample": false,
|
|
37
|
+
"testCaseCount": 128,
|
|
38
|
+
"testPlanCount": 7,
|
|
39
|
+
} satisfies ProjectListItem
|
|
40
|
+
|
|
41
|
+
console.log(example)
|
|
42
|
+
|
|
43
|
+
// Convert the instance to a JSON string
|
|
44
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
45
|
+
console.log(exampleJSON)
|
|
46
|
+
|
|
47
|
+
// Parse the JSON string back to an object
|
|
48
|
+
const exampleParsed = JSON.parse(exampleJSON) as ProjectListItem
|
|
49
|
+
console.log(exampleParsed)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
53
|
+
|
|
54
|
+
|
package/docs/ProjectsApi.md
CHANGED
|
@@ -407,7 +407,7 @@ example().catch(console.error);
|
|
|
407
407
|
|
|
408
408
|
## getProjects
|
|
409
409
|
|
|
410
|
-
> Array<
|
|
410
|
+
> Array<ProjectListItem> getProjects(company, limit, start, sort, filter)
|
|
411
411
|
|
|
412
412
|
Get list of projects
|
|
413
413
|
|
|
@@ -470,7 +470,7 @@ example().catch(console.error);
|
|
|
470
470
|
|
|
471
471
|
### Return type
|
|
472
472
|
|
|
473
|
-
[**Array<
|
|
473
|
+
[**Array<ProjectListItem>**](ProjectListItem.md)
|
|
474
474
|
|
|
475
475
|
### Authorization
|
|
476
476
|
|