@testcollab/sdk 3.10.0 → 3.12.0

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)
+
+

package/docs/ReleaseReadinessDefectSeverity.md

@@ -0,0 +1,36 @@
+
+# ReleaseReadinessDefectSeverity
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`severity` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessDefectSeverity } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "severity": Blocker,
+  "count": 3,
+} satisfies ReleaseReadinessDefectSeverity
+
+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 ReleaseReadinessDefectSeverity
+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/ReleaseReadinessDefects.md

@@ -0,0 +1,39 @@
+
+# ReleaseReadinessDefects
+
+Defects linked to test plans in this release, with open count and severity breakdown. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`totalOpen` | number
+`bySeverity` | [Array<ReleaseReadinessDefectSeverity>](ReleaseReadinessDefectSeverity.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadinessDefects } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 35,
+  "totalOpen": 20,
+  "bySeverity": null,
+} satisfies ReleaseReadinessDefects
+
+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 ReleaseReadinessDefects
+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/ReleaseReadinessEvidence.md

@@ -0,0 +1,39 @@
+
+# ReleaseReadinessEvidence
+
+Metrics about test evidence (attachments) on executed test cases, particularly for failed executions. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalFailed` | number
+`failedWithAttachments` | number
+`evidenceCoverage` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessEvidence } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalFailed": 32,
+  "failedWithAttachments": 28,
+  "evidenceCoverage": 87.5,
+} satisfies ReleaseReadinessEvidence
+
+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 ReleaseReadinessEvidence
+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/ReleaseReadinessRequirementCoverage.md

@@ -0,0 +1,37 @@
+
+# ReleaseReadinessRequirementCoverage
+
+Requirement coverage analysis for the release. Shows how well the requirements linked to this release are covered by test execution. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`summary` | [ReleaseReadinessRequirementSummary](.md)
+`items` | [Array<ReleaseReadinessRequirementItem>](ReleaseReadinessRequirementItem.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadinessRequirementCoverage } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "summary": null,
+  "items": null,
+} satisfies ReleaseReadinessRequirementCoverage
+
+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 ReleaseReadinessRequirementCoverage
+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/ReleaseReadinessRequirementItem.md

@@ -0,0 +1,51 @@
+
+# ReleaseReadinessRequirementItem
+
+Coverage data for a single requirement associated with the release. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`requirementId` | number
+`requirementKey` | string
+`title` | string
+`totalLinkedCases` | number
+`casesInRelease` | number
+`executed` | number
+`passed` | number
+`failed` | number
+`coverageStatus` | string
+
+## Example
+
+```typescript
+import type { ReleaseReadinessRequirementItem } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "requirementId": 101,
+  "requirementKey": REQ-42,
+  "title": User can reset password via email,
+  "totalLinkedCases": 8,
+  "casesInRelease": 5,
+  "executed": 4,
+  "passed": 3,
+  "failed": 1,
+  "coverageStatus": partially_covered,
+} satisfies ReleaseReadinessRequirementItem
+
+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 ReleaseReadinessRequirementItem
+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)
+
+