@testcollab/sdk 3.11.0 → 3.12.0

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

package/docs/ReleaseReadinessRequirementSummary.md

@@ -0,0 +1,43 @@
+
+# ReleaseReadinessRequirementSummary
+
+Summary statistics for requirement coverage within the release. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`fullyCovered` | number
+`partiallyCovered` | number
+`notCovered` | number
+`coverageRate` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessRequirementSummary } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 20,
+  "fullyCovered": 12,
+  "partiallyCovered": 5,
+  "notCovered": 3,
+  "coverageRate": 60,
+} satisfies ReleaseReadinessRequirementSummary
+
+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 ReleaseReadinessRequirementSummary
+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/ReleaseReadinessSummary.md

@@ -0,0 +1,47 @@
+
+# ReleaseReadinessSummary
+
+Aggregated execution results across all test plans in the release, using the latest run (regression) of each test plan. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`passed` | number
+`failed` | number
+`blocked` | number
+`skipped` | number
+`unexecuted` | number
+`passRate` | number
+
+## Example
+
+```typescript
+import type { ReleaseReadinessSummary } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 412,
+  "passed": 360,
+  "failed": 32,
+  "blocked": 8,
+  "skipped": 4,
+  "unexecuted": 8,
+  "passRate": 89.1,
+} satisfies ReleaseReadinessSummary
+
+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 ReleaseReadinessSummary
+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/ReleaseReadinessTestPlan.md

@@ -0,0 +1,43 @@
+
+# ReleaseReadinessTestPlan
+
+Per-test-plan readiness summary within a release, showing the latest run\'s results. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`title` | string
+`status` | number
+`latestRun` | [ReleaseReadinessTestPlanRun](.md)
+`results` | [ResultSummary](.md)
+
+## Example
+
+```typescript
+import type { ReleaseReadinessTestPlan } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 5,
+  "title": Regression - Payment Module,
+  "status": 3,
+  "latestRun": null,
+  "results": null,
+} satisfies ReleaseReadinessTestPlan
+
+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 ReleaseReadinessTestPlan
+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/ReleaseReadinessTestPlanRun.md

@@ -0,0 +1,41 @@
+
+# ReleaseReadinessTestPlanRun
+
+Minimal info about the latest run (regression) of a test plan within the release. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`iteration` | number
+`status` | string
+`createdAt` | string
+
+## Example
+
+```typescript
+import type { ReleaseReadinessTestPlanRun } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 23,
+  "iteration": 3,
+  "status": 2,
+  "createdAt": 2025-02-10T14:30:00.000Z,
+} satisfies ReleaseReadinessTestPlanRun
+
+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 ReleaseReadinessTestPlanRun
+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/ReleaseReadinessVerdict.md

@@ -0,0 +1,37 @@
+
+# ReleaseReadinessVerdict
+
+Computed Go/No-Go verdict based on the release\'s go_no_go_threshold settings compared against actual metrics. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`result` | string
+`reasons` | Array<string>
+
+## Example
+
+```typescript
+import type { ReleaseReadinessVerdict } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "result": no_go,
+  "reasons": ["Pass rate 89.1% is below threshold of 95%","3 open blockers exceeds maximum of 0"],
+} satisfies ReleaseReadinessVerdict
+
+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 ReleaseReadinessVerdict
+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)
+
+