@testcollab/sdk 3.11.0 → 3.12.0

package/dist/models/ReleaseReadinessDefects.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReleaseReadinessDefects = instanceOfReleaseReadinessDefects;
+exports.ReleaseReadinessDefectsFromJSON = ReleaseReadinessDefectsFromJSON;
+exports.ReleaseReadinessDefectsFromJSONTyped = ReleaseReadinessDefectsFromJSONTyped;
+exports.ReleaseReadinessDefectsToJSON = ReleaseReadinessDefectsToJSON;
+exports.ReleaseReadinessDefectsToJSONTyped = ReleaseReadinessDefectsToJSONTyped;
+const ReleaseReadinessDefectSeverity_1 = require("./ReleaseReadinessDefectSeverity");
+/**
+ * Check if a given object implements the ReleaseReadinessDefects interface.
+ */
+function instanceOfReleaseReadinessDefects(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('totalOpen' in value) || value['totalOpen'] === undefined)
+        return false;
+    if (!('bySeverity' in value) || value['bySeverity'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessDefectsFromJSON(json) {
+    return ReleaseReadinessDefectsFromJSONTyped(json, false);
+}
+function ReleaseReadinessDefectsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'total': json['total'],
+        'totalOpen': json['total_open'],
+        'bySeverity': (json['by_severity'].map(ReleaseReadinessDefectSeverity_1.ReleaseReadinessDefectSeverityFromJSON)),
+    };
+}
+function ReleaseReadinessDefectsToJSON(json) {
+    return ReleaseReadinessDefectsToJSONTyped(json, false);
+}
+function ReleaseReadinessDefectsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total': value['total'],
+        'total_open': value['totalOpen'],
+        'by_severity': (value['bySeverity'].map(ReleaseReadinessDefectSeverity_1.ReleaseReadinessDefectSeverityToJSON)),
+    };
+}

package/dist/models/ReleaseReadinessEvidence.d.ts

@@ -0,0 +1,45 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Metrics about test evidence (attachments) on executed test cases, particularly for failed executions.
+ *
+ * @export
+ * @interface ReleaseReadinessEvidence
+ */
+export interface ReleaseReadinessEvidence {
+    /**
+     * Total failed executions across the release
+     * @type {number}
+     * @memberof ReleaseReadinessEvidence
+     */
+    totalFailed: number;
+    /**
+     * Failed executions that have at least one attachment
+     * @type {number}
+     * @memberof ReleaseReadinessEvidence
+     */
+    failedWithAttachments: number;
+    /**
+     * Percentage of failed executions with attachments
+     * @type {number}
+     * @memberof ReleaseReadinessEvidence
+     */
+    evidenceCoverage: number;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessEvidence interface.
+ */
+export declare function instanceOfReleaseReadinessEvidence(value: object): value is ReleaseReadinessEvidence;
+export declare function ReleaseReadinessEvidenceFromJSON(json: any): ReleaseReadinessEvidence;
+export declare function ReleaseReadinessEvidenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessEvidence;
+export declare function ReleaseReadinessEvidenceToJSON(json: any): ReleaseReadinessEvidence;
+export declare function ReleaseReadinessEvidenceToJSONTyped(value?: ReleaseReadinessEvidence | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessEvidence.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReleaseReadinessEvidence = instanceOfReleaseReadinessEvidence;
+exports.ReleaseReadinessEvidenceFromJSON = ReleaseReadinessEvidenceFromJSON;
+exports.ReleaseReadinessEvidenceFromJSONTyped = ReleaseReadinessEvidenceFromJSONTyped;
+exports.ReleaseReadinessEvidenceToJSON = ReleaseReadinessEvidenceToJSON;
+exports.ReleaseReadinessEvidenceToJSONTyped = ReleaseReadinessEvidenceToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessEvidence interface.
+ */
+function instanceOfReleaseReadinessEvidence(value) {
+    if (!('totalFailed' in value) || value['totalFailed'] === undefined)
+        return false;
+    if (!('failedWithAttachments' in value) || value['failedWithAttachments'] === undefined)
+        return false;
+    if (!('evidenceCoverage' in value) || value['evidenceCoverage'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessEvidenceFromJSON(json) {
+    return ReleaseReadinessEvidenceFromJSONTyped(json, false);
+}
+function ReleaseReadinessEvidenceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'totalFailed': json['total_failed'],
+        'failedWithAttachments': json['failed_with_attachments'],
+        'evidenceCoverage': json['evidence_coverage'],
+    };
+}
+function ReleaseReadinessEvidenceToJSON(json) {
+    return ReleaseReadinessEvidenceToJSONTyped(json, false);
+}
+function ReleaseReadinessEvidenceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total_failed': value['totalFailed'],
+        'failed_with_attachments': value['failedWithAttachments'],
+        'evidence_coverage': value['evidenceCoverage'],
+    };
+}

package/dist/models/ReleaseReadinessRequirementCoverage.d.ts

@@ -0,0 +1,41 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ReleaseReadinessRequirementSummary } from './ReleaseReadinessRequirementSummary';
+import type { ReleaseReadinessRequirementItem } from './ReleaseReadinessRequirementItem';
+/**
+ * Requirement coverage analysis for the release. Shows how well the requirements linked to this release are covered by test execution.
+ *
+ * @export
+ * @interface ReleaseReadinessRequirementCoverage
+ */
+export interface ReleaseReadinessRequirementCoverage {
+    /**
+     *
+     * @type {ReleaseReadinessRequirementSummary}
+     * @memberof ReleaseReadinessRequirementCoverage
+     */
+    summary: ReleaseReadinessRequirementSummary;
+    /**
+     *
+     * @type {Array<ReleaseReadinessRequirementItem>}
+     * @memberof ReleaseReadinessRequirementCoverage
+     */
+    items: Array<ReleaseReadinessRequirementItem>;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementCoverage interface.
+ */
+export declare function instanceOfReleaseReadinessRequirementCoverage(value: object): value is ReleaseReadinessRequirementCoverage;
+export declare function ReleaseReadinessRequirementCoverageFromJSON(json: any): ReleaseReadinessRequirementCoverage;
+export declare function ReleaseReadinessRequirementCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementCoverage;
+export declare function ReleaseReadinessRequirementCoverageToJSON(json: any): ReleaseReadinessRequirementCoverage;
+export declare function ReleaseReadinessRequirementCoverageToJSONTyped(value?: ReleaseReadinessRequirementCoverage | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessRequirementCoverage.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReleaseReadinessRequirementCoverage = instanceOfReleaseReadinessRequirementCoverage;
+exports.ReleaseReadinessRequirementCoverageFromJSON = ReleaseReadinessRequirementCoverageFromJSON;
+exports.ReleaseReadinessRequirementCoverageFromJSONTyped = ReleaseReadinessRequirementCoverageFromJSONTyped;
+exports.ReleaseReadinessRequirementCoverageToJSON = ReleaseReadinessRequirementCoverageToJSON;
+exports.ReleaseReadinessRequirementCoverageToJSONTyped = ReleaseReadinessRequirementCoverageToJSONTyped;
+const ReleaseReadinessRequirementItem_1 = require("./ReleaseReadinessRequirementItem");
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementCoverage interface.
+ */
+function instanceOfReleaseReadinessRequirementCoverage(value) {
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessRequirementCoverageFromJSON(json) {
+    return ReleaseReadinessRequirementCoverageFromJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementCoverageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'summary': json['summary'],
+        'items': (json['items'].map(ReleaseReadinessRequirementItem_1.ReleaseReadinessRequirementItemFromJSON)),
+    };
+}
+function ReleaseReadinessRequirementCoverageToJSON(json) {
+    return ReleaseReadinessRequirementCoverageToJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementCoverageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'summary': value['summary'],
+        'items': (value['items'].map(ReleaseReadinessRequirementItem_1.ReleaseReadinessRequirementItemToJSON)),
+    };
+}

package/dist/models/ReleaseReadinessRequirementItem.d.ts

@@ -0,0 +1,92 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Coverage data for a single requirement associated with the release.
+ *
+ * @export
+ * @interface ReleaseReadinessRequirementItem
+ */
+export interface ReleaseReadinessRequirementItem {
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    requirementId: number;
+    /**
+     * Human-readable requirement identifier
+     * @type {string}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    requirementKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    title: string;
+    /**
+     * Total test cases linked to this requirement (across all projects)
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    totalLinkedCases: number;
+    /**
+     * Number of linked test cases that appear in this release's test plans
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    casesInRelease: number;
+    /**
+     * Number of cases_in_release that have been executed
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    executed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    passed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    failed: number;
+    /**
+     * fully_covered = all cases_in_release passed, partially_covered = some executed but not all passed, not_covered = none executed, no_cases = no linked test cases in the release
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessRequirementItem
+     */
+    coverageStatus: ReleaseReadinessRequirementItemCoverageStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const ReleaseReadinessRequirementItemCoverageStatusEnum: {
+    readonly FullyCovered: "fully_covered";
+    readonly PartiallyCovered: "partially_covered";
+    readonly NotCovered: "not_covered";
+    readonly NoCases: "no_cases";
+};
+export type ReleaseReadinessRequirementItemCoverageStatusEnum = typeof ReleaseReadinessRequirementItemCoverageStatusEnum[keyof typeof ReleaseReadinessRequirementItemCoverageStatusEnum];
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementItem interface.
+ */
+export declare function instanceOfReleaseReadinessRequirementItem(value: object): value is ReleaseReadinessRequirementItem;
+export declare function ReleaseReadinessRequirementItemFromJSON(json: any): ReleaseReadinessRequirementItem;
+export declare function ReleaseReadinessRequirementItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementItem;
+export declare function ReleaseReadinessRequirementItemToJSON(json: any): ReleaseReadinessRequirementItem;
+export declare function ReleaseReadinessRequirementItemToJSONTyped(value?: ReleaseReadinessRequirementItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessRequirementItem.js

@@ -0,0 +1,92 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleaseReadinessRequirementItemCoverageStatusEnum = void 0;
+exports.instanceOfReleaseReadinessRequirementItem = instanceOfReleaseReadinessRequirementItem;
+exports.ReleaseReadinessRequirementItemFromJSON = ReleaseReadinessRequirementItemFromJSON;
+exports.ReleaseReadinessRequirementItemFromJSONTyped = ReleaseReadinessRequirementItemFromJSONTyped;
+exports.ReleaseReadinessRequirementItemToJSON = ReleaseReadinessRequirementItemToJSON;
+exports.ReleaseReadinessRequirementItemToJSONTyped = ReleaseReadinessRequirementItemToJSONTyped;
+/**
+ * @export
+ */
+exports.ReleaseReadinessRequirementItemCoverageStatusEnum = {
+    FullyCovered: 'fully_covered',
+    PartiallyCovered: 'partially_covered',
+    NotCovered: 'not_covered',
+    NoCases: 'no_cases'
+};
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementItem interface.
+ */
+function instanceOfReleaseReadinessRequirementItem(value) {
+    if (!('requirementId' in value) || value['requirementId'] === undefined)
+        return false;
+    if (!('requirementKey' in value) || value['requirementKey'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('totalLinkedCases' in value) || value['totalLinkedCases'] === undefined)
+        return false;
+    if (!('casesInRelease' in value) || value['casesInRelease'] === undefined)
+        return false;
+    if (!('executed' in value) || value['executed'] === undefined)
+        return false;
+    if (!('passed' in value) || value['passed'] === undefined)
+        return false;
+    if (!('failed' in value) || value['failed'] === undefined)
+        return false;
+    if (!('coverageStatus' in value) || value['coverageStatus'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessRequirementItemFromJSON(json) {
+    return ReleaseReadinessRequirementItemFromJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'requirementId': json['requirement_id'],
+        'requirementKey': json['requirement_key'],
+        'title': json['title'],
+        'totalLinkedCases': json['total_linked_cases'],
+        'casesInRelease': json['cases_in_release'],
+        'executed': json['executed'],
+        'passed': json['passed'],
+        'failed': json['failed'],
+        'coverageStatus': json['coverage_status'],
+    };
+}
+function ReleaseReadinessRequirementItemToJSON(json) {
+    return ReleaseReadinessRequirementItemToJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'requirement_id': value['requirementId'],
+        'requirement_key': value['requirementKey'],
+        'title': value['title'],
+        'total_linked_cases': value['totalLinkedCases'],
+        'cases_in_release': value['casesInRelease'],
+        'executed': value['executed'],
+        'passed': value['passed'],
+        'failed': value['failed'],
+        'coverage_status': value['coverageStatus'],
+    };
+}

package/dist/models/ReleaseReadinessRequirementSummary.d.ts

@@ -0,0 +1,57 @@
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Summary statistics for requirement coverage within the release.
+ *
+ * @export
+ * @interface ReleaseReadinessRequirementSummary
+ */
+export interface ReleaseReadinessRequirementSummary {
+    /**
+     * Total number of requirements linked to this release
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementSummary
+     */
+    total: number;
+    /**
+     * Requirements where all linked test cases in the release passed
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementSummary
+     */
+    fullyCovered: number;
+    /**
+     * Requirements where some test cases were executed but not all passed
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementSummary
+     */
+    partiallyCovered: number;
+    /**
+     * Requirements where no linked test cases were executed
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementSummary
+     */
+    notCovered: number;
+    /**
+     * Percentage of fully covered requirements out of total
+     * @type {number}
+     * @memberof ReleaseReadinessRequirementSummary
+     */
+    coverageRate: number;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementSummary interface.
+ */
+export declare function instanceOfReleaseReadinessRequirementSummary(value: object): value is ReleaseReadinessRequirementSummary;
+export declare function ReleaseReadinessRequirementSummaryFromJSON(json: any): ReleaseReadinessRequirementSummary;
+export declare function ReleaseReadinessRequirementSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementSummary;
+export declare function ReleaseReadinessRequirementSummaryToJSON(json: any): ReleaseReadinessRequirementSummary;
+export declare function ReleaseReadinessRequirementSummaryToJSONTyped(value?: ReleaseReadinessRequirementSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessRequirementSummary.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfReleaseReadinessRequirementSummary = instanceOfReleaseReadinessRequirementSummary;
+exports.ReleaseReadinessRequirementSummaryFromJSON = ReleaseReadinessRequirementSummaryFromJSON;
+exports.ReleaseReadinessRequirementSummaryFromJSONTyped = ReleaseReadinessRequirementSummaryFromJSONTyped;
+exports.ReleaseReadinessRequirementSummaryToJSON = ReleaseReadinessRequirementSummaryToJSON;
+exports.ReleaseReadinessRequirementSummaryToJSONTyped = ReleaseReadinessRequirementSummaryToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessRequirementSummary interface.
+ */
+function instanceOfReleaseReadinessRequirementSummary(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('fullyCovered' in value) || value['fullyCovered'] === undefined)
+        return false;
+    if (!('partiallyCovered' in value) || value['partiallyCovered'] === undefined)
+        return false;
+    if (!('notCovered' in value) || value['notCovered'] === undefined)
+        return false;
+    if (!('coverageRate' in value) || value['coverageRate'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessRequirementSummaryFromJSON(json) {
+    return ReleaseReadinessRequirementSummaryFromJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'total': json['total'],
+        'fullyCovered': json['fully_covered'],
+        'partiallyCovered': json['partially_covered'],
+        'notCovered': json['not_covered'],
+        'coverageRate': json['coverage_rate'],
+    };
+}
+function ReleaseReadinessRequirementSummaryToJSON(json) {
+    return ReleaseReadinessRequirementSummaryToJSONTyped(json, false);
+}
+function ReleaseReadinessRequirementSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total': value['total'],
+        'fully_covered': value['fullyCovered'],
+        'partially_covered': value['partiallyCovered'],
+        'not_covered': value['notCovered'],
+        'coverage_rate': value['coverageRate'],
+    };
+}