@testcollab/sdk 3.11.0 → 3.12.0

package/dist/models/TestPlanPayload.d.ts

@@ -76,6 +76,12 @@ export interface TestPlanPayload {
      * @memberof TestPlanPayload
      */
     project: number;
+    /**
+     * Release ID to associate this test plan with (optional)
+     * @type {number}
+     * @memberof TestPlanPayload
+     */
+    release?: number;
     /**
      * Array of custom fields
      * @type {Array<CustomFieldInputPayload>}

package/dist/models/TestPlanPayload.js

@@ -71,6 +71,7 @@ function TestPlanPayloadFromJSONTyped(json, ignoreDiscriminator) {
         'startDate': json['start_date'] == null ? undefined : json['start_date'],
         'endDate': json['end_date'] == null ? undefined : json['end_date'],
         'project': json['project'],
+        'release': json['release'] == null ? undefined : json['release'],
         'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadFromJSON)),
     };
 }
@@ -92,6 +93,7 @@ function TestPlanPayloadToJSONTyped(value, ignoreDiscriminator = false) {
         'start_date': value['startDate'],
         'end_date': value['endDate'],
         'project': value['project'],
+        'release': value['release'],
         'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadToJSON)),
     };
 }

package/dist/models/TraceabilityMatrixPayload.d.ts

@@ -33,6 +33,13 @@ export interface TraceabilityMatrixPayload {
      * @memberof TraceabilityMatrixPayload
      */
     forceRefresh?: boolean;
+    /**
+     * 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.
+     *
+     * @type {number}
+     * @memberof TraceabilityMatrixPayload
+     */
+    release?: number;
 }
 /**
  * Check if a given object implements the TraceabilityMatrixPayload interface.

package/dist/models/TraceabilityMatrixPayload.js

@@ -37,6 +37,7 @@ function TraceabilityMatrixPayloadFromJSONTyped(json, ignoreDiscriminator) {
         'filterModel': json['filterModel'] == null ? undefined : json['filterModel'],
         'project': json['project'],
         'forceRefresh': json['force_refresh'] == null ? undefined : json['force_refresh'],
+        'release': json['release'] == null ? undefined : json['release'],
     };
 }
 function TraceabilityMatrixPayloadToJSON(json) {
@@ -50,5 +51,6 @@ function TraceabilityMatrixPayloadToJSONTyped(value, ignoreDiscriminator = false
         'filterModel': value['filterModel'],
         'project': value['project'],
         'force_refresh': value['forceRefresh'],
+        'release': value['release'],
     };
 }

package/dist/models/index.d.ts

@@ -1,4 +1,5 @@
 export * from './Activity';
+export * from './ActivityAuditInfo';
 export * from './AddNewFolderPayload';
 export * from './AddRequirementPayload';
 export * from './AddRequirementPayloadFolder';
@@ -172,6 +173,26 @@ export * from './QueueStatus';
 export * from './QueueUpdatePayload';
 export * from './RegisteredUser';
 export * from './RegisteredUserUser';
+export * from './Release';
+export * from './ReleaseGoNoGoThreshold';
+export * from './ReleaseMinified';
+export * from './ReleasePayload';
+export * from './ReleaseReadiness';
+export * from './ReleaseReadinessComparison';
+export * from './ReleaseReadinessConfigurationCoverage';
+export * from './ReleaseReadinessCoverageItem';
+export * from './ReleaseReadinessCustomFieldCoverage';
+export * from './ReleaseReadinessCustomFieldGroup';
+export * from './ReleaseReadinessDefectSeverity';
+export * from './ReleaseReadinessDefects';
+export * from './ReleaseReadinessEvidence';
+export * from './ReleaseReadinessRequirementCoverage';
+export * from './ReleaseReadinessRequirementItem';
+export * from './ReleaseReadinessRequirementSummary';
+export * from './ReleaseReadinessSummary';
+export * from './ReleaseReadinessTestPlan';
+export * from './ReleaseReadinessTestPlanRun';
+export * from './ReleaseReadinessVerdict';
 export * from './ReportPayload';
 export * from './ReportResult';
 export * from './Requirement';

package/dist/models/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
 __exportStar(require("./Activity"), exports);
+__exportStar(require("./ActivityAuditInfo"), exports);
 __exportStar(require("./AddNewFolderPayload"), exports);
 __exportStar(require("./AddRequirementPayload"), exports);
 __exportStar(require("./AddRequirementPayloadFolder"), exports);
@@ -190,6 +191,26 @@ __exportStar(require("./QueueStatus"), exports);
 __exportStar(require("./QueueUpdatePayload"), exports);
 __exportStar(require("./RegisteredUser"), exports);
 __exportStar(require("./RegisteredUserUser"), exports);
+__exportStar(require("./Release"), exports);
+__exportStar(require("./ReleaseGoNoGoThreshold"), exports);
+__exportStar(require("./ReleaseMinified"), exports);
+__exportStar(require("./ReleasePayload"), exports);
+__exportStar(require("./ReleaseReadiness"), exports);
+__exportStar(require("./ReleaseReadinessComparison"), exports);
+__exportStar(require("./ReleaseReadinessConfigurationCoverage"), exports);
+__exportStar(require("./ReleaseReadinessCoverageItem"), exports);
+__exportStar(require("./ReleaseReadinessCustomFieldCoverage"), exports);
+__exportStar(require("./ReleaseReadinessCustomFieldGroup"), exports);
+__exportStar(require("./ReleaseReadinessDefectSeverity"), exports);
+__exportStar(require("./ReleaseReadinessDefects"), exports);
+__exportStar(require("./ReleaseReadinessEvidence"), exports);
+__exportStar(require("./ReleaseReadinessRequirementCoverage"), exports);
+__exportStar(require("./ReleaseReadinessRequirementItem"), exports);
+__exportStar(require("./ReleaseReadinessRequirementSummary"), exports);
+__exportStar(require("./ReleaseReadinessSummary"), exports);
+__exportStar(require("./ReleaseReadinessTestPlan"), exports);
+__exportStar(require("./ReleaseReadinessTestPlanRun"), exports);
+__exportStar(require("./ReleaseReadinessVerdict"), exports);
 __exportStar(require("./ReportPayload"), exports);
 __exportStar(require("./ReportResult"), exports);
 __exportStar(require("./Requirement"), exports);

package/docs/Activity.md

@@ -14,6 +14,7 @@ Name | Type
 `project` | [ProjectMini](ProjectMini.md)
 `activityType` | string
 `user` | [User](User.md)
+`auditInfo` | [ActivityAuditInfo](ActivityAuditInfo.md)
 `createdAt` | string
 `updatedAt` | string
 
@@ -32,6 +33,7 @@ const example = {
   "project": null,
   "activityType": add,
   "user": null,
+  "auditInfo": null,
   "createdAt": 2019-04-30T17:11:24.000Z,
   "updatedAt": 2019-04-30T17:11:24.000Z,
 } satisfies Activity

package/docs/ActivityAuditInfo.md

@@ -0,0 +1,39 @@
+
+# ActivityAuditInfo
+
+Additional metadata for the activity (e.g. release name, old/new verdict)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`releaseName` | string
+`oldVerdict` | string
+`newVerdict` | string
+
+## Example
+
+```typescript
+import type { ActivityAuditInfo } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "releaseName": v1,
+  "oldVerdict": No-Go,
+  "newVerdict": Go,
+} satisfies ActivityAuditInfo
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ActivityAuditInfo
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Release.md

@@ -0,0 +1,62 @@
+
+# Release
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`description` | string
+`status` | string
+`targetDate` | string
+`releaseDate` | string
+`goNoGoThreshold` | [ReleaseGoNoGoThreshold](.md)
+`isPublic` | boolean
+`publicToken` | string
+`testPlans` | [Array<TestPlanMinified>](TestPlanMinified.md)
+`requirements` | [Array<RequirementMinified>](RequirementMinified.md)
+`project` | number
+`createdBy` | [UserMinified](.md)
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { Release } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 1,
+  "name": v2.4.0,
+  "description": Sprint 23 release with payment module updates,
+  "status": in_progress,
+  "targetDate": 2025-03-15,
+  "releaseDate": 2025-03-14,
+  "goNoGoThreshold": null,
+  "isPublic": false,
+  "publicToken": a1b2c3d4-e5f6-7890-abcd-ef1234567890,
+  "testPlans": null,
+  "requirements": null,
+  "project": 1,
+  "createdBy": null,
+  "createdAt": 2025-02-11T10:00:00.000Z,
+  "updatedAt": 2025-02-11T10:00:00.000Z,
+} satisfies Release
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Release
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseGoNoGoThreshold.md

@@ -0,0 +1,39 @@
+
+# ReleaseGoNoGoThreshold
+
+Configurable thresholds that determine the auto-computed Go/No-Go verdict for a release. All fields are optional — only configured thresholds are evaluated. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`minPassRate` | number
+`maxOpenDefects` | number
+`minEvidenceCoverage` | number
+
+## Example
+
+```typescript
+import type { ReleaseGoNoGoThreshold } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "minPassRate": 95,
+  "maxOpenDefects": 0,
+  "minEvidenceCoverage": 80,
+} satisfies ReleaseGoNoGoThreshold
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseGoNoGoThreshold
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseMinified.md

@@ -0,0 +1,42 @@
+
+# ReleaseMinified
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`status` | string
+`targetDate` | string
+`createdAt` | string
+
+## Example
+
+```typescript
+import type { ReleaseMinified } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 1,
+  "name": v2.4.0,
+  "status": in_progress,
+  "targetDate": 2025-03-15,
+  "createdAt": 2025-02-11T10:00:00.000Z,
+} satisfies ReleaseMinified
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseMinified
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleasePayload.md

@@ -0,0 +1,52 @@
+
+# ReleasePayload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`status` | string
+`targetDate` | string
+`releaseDate` | string
+`goNoGoThreshold` | [ReleaseGoNoGoThreshold](.md)
+`isPublic` | boolean
+`project` | number
+`testPlans` | Array<number>
+`requirements` | Array<number>
+
+## Example
+
+```typescript
+import type { ReleasePayload } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": v2.4.0,
+  "description": Sprint 23 release with payment module updates,
+  "status": planned,
+  "targetDate": 2025-03-15,
+  "releaseDate": 2025-03-14,
+  "goNoGoThreshold": null,
+  "isPublic": false,
+  "project": 1,
+  "testPlans": [1,5,12],
+  "requirements": [10,20,35],
+} satisfies ReleasePayload
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleasePayload
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadiness.md

@@ -0,0 +1,55 @@
+
+# ReleaseReadiness
+
+Aggregated readiness data for a release. Combines execution results, defect counts, coverage analysis, evidence metrics, and a computed Go/No-Go verdict across all test plans in the release. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`release` | [ReleaseMinified](.md)
+`summary` | [ReleaseReadinessSummary](.md)
+`defects` | [ReleaseReadinessDefects](.md)
+`coverage` | [Array<ReleaseReadinessCoverageItem>](ReleaseReadinessCoverageItem.md)
+`evidence` | [ReleaseReadinessEvidence](.md)
+`comparison` | [ReleaseReadinessComparison](.md)
+`verdict` | [ReleaseReadinessVerdict](.md)
+`testPlans` | [Array<ReleaseReadinessTestPlan>](ReleaseReadinessTestPlan.md)
+`requirementCoverage` | [ReleaseReadinessRequirementCoverage](.md)
+`customFieldCoverage` | [Array<ReleaseReadinessCustomFieldCoverage>](ReleaseReadinessCustomFieldCoverage.md)
+`configurationCoverage` | [Array<ReleaseReadinessConfigurationCoverage>](ReleaseReadinessConfigurationCoverage.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadiness } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "release": null,
+  "summary": null,
+  "defects": null,
+  "coverage": null,
+  "evidence": null,
+  "comparison": null,
+  "verdict": null,
+  "testPlans": null,
+  "requirementCoverage": null,
+  "customFieldCoverage": null,
+  "configurationCoverage": null,
+} satisfies ReleaseReadiness
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadiness
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadinessComparison.md

@@ -0,0 +1,41 @@
+
+# ReleaseReadinessComparison
+
+Comparison of this release\'s readiness metrics against the previous release in the same project. Null if no previous release exists. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`previousRelease` | [ReleaseMinified](.md)
+`previousPassRate` | number
+`passRateDelta` | number
+`previousOpenDefects` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessComparison } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "previousRelease": null,
+  "previousPassRate": 94.1,
+  "passRateDelta": -5,
+  "previousOpenDefects": 5,
+} satisfies ReleaseReadinessComparison
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadinessComparison
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadinessConfigurationCoverage.md

@@ -0,0 +1,51 @@
+
+# ReleaseReadinessConfigurationCoverage
+
+Coverage breakdown for a single configuration. Shows execution statistics aggregated across all test plans in the release that use this configuration. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`configurationId` | number
+`parameters` | { [key: string]: string; }
+`testPlanId` | number
+`testPlanTitle` | string
+`total` | number
+`executed` | number
+`passed` | number
+`failed` | number
+`passRate` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessConfigurationCoverage } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "configurationId": 12,
+  "parameters": {"browser":"Chrome","os":"Windows"},
+  "testPlanId": 5,
+  "testPlanTitle": Smoke Test Plan,
+  "total": 100,
+  "executed": 85,
+  "passed": 75,
+  "failed": 5,
+  "passRate": 88.2,
+} satisfies ReleaseReadinessConfigurationCoverage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadinessConfigurationCoverage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadinessCoverageItem.md

@@ -0,0 +1,49 @@
+
+# ReleaseReadinessCoverageItem
+
+Test coverage for a single suite/module within the release. Supports tree structure — parent suites aggregate totals from children. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`suiteId` | number
+`suiteTitle` | string
+`total` | number
+`executed` | number
+`passed` | number
+`failed` | number
+`passRate` | number
+`children` | [Array<ReleaseReadinessCoverageItem>](ReleaseReadinessCoverageItem.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadinessCoverageItem } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "suiteId": 42,
+  "suiteTitle": Payment Module,
+  "total": 25,
+  "executed": 20,
+  "passed": 18,
+  "failed": 2,
+  "passRate": 90,
+  "children": null,
+} satisfies ReleaseReadinessCoverageItem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadinessCoverageItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadinessCustomFieldCoverage.md

@@ -0,0 +1,43 @@
+
+# ReleaseReadinessCustomFieldCoverage
+
+Coverage breakdown for a single custom field. Groups test cases by their custom field value and shows execution statistics per group. Supports both test case and test plan custom fields. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldId` | number
+`fieldLabel` | string
+`fieldType` | string
+`entity` | string
+`groups` | [Array<ReleaseReadinessCustomFieldGroup>](ReleaseReadinessCustomFieldGroup.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadinessCustomFieldCoverage } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fieldId": 5,
+  "fieldLabel": Priority Level,
+  "fieldType": dropdown,
+  "entity": TestCase,
+  "groups": null,
+} satisfies ReleaseReadinessCustomFieldCoverage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadinessCustomFieldCoverage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ReleaseReadinessCustomFieldGroup.md

@@ -0,0 +1,49 @@
+
+# ReleaseReadinessCustomFieldGroup
+
+Coverage data for a single value/group within a custom field. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`value` | string
+`label` | string
+`color` | string
+`total` | number
+`executed` | number
+`passed` | number
+`failed` | number
+`passRate` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessCustomFieldGroup } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "value": high_priority,
+  "label": High Priority,
+  "color": #f5222d,
+  "total": 15,
+  "executed": 12,
+  "passed": 10,
+  "failed": 2,
+  "passRate": 83.3,
+} satisfies ReleaseReadinessCustomFieldGroup
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ReleaseReadinessCustomFieldGroup
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+