@testcollab/sdk 3.10.0 → 3.12.0

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'],
+    };
+}

package/dist/models/ReleaseReadinessSummary.d.ts

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+/**
+ * Aggregated execution results across all test plans in the release, using the latest run (regression) of each test plan.
+ *
+ * @export
+ * @interface ReleaseReadinessSummary
+ */
+export interface ReleaseReadinessSummary {
+    [key: string]: number | any;
+    /**
+     * Total number of test case executions across all plans
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    passed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    failed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    blocked: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    skipped: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    unexecuted: number;
+    /**
+     * Percentage of passed out of total (excluding unexecuted)
+     * @type {number}
+     * @memberof ReleaseReadinessSummary
+     */
+    passRate: number;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessSummary interface.
+ */
+export declare function instanceOfReleaseReadinessSummary(value: object): value is ReleaseReadinessSummary;
+export declare function ReleaseReadinessSummaryFromJSON(json: any): ReleaseReadinessSummary;
+export declare function ReleaseReadinessSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessSummary;
+export declare function ReleaseReadinessSummaryToJSON(json: any): ReleaseReadinessSummary;
+export declare function ReleaseReadinessSummaryToJSONTyped(value?: ReleaseReadinessSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessSummary.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.instanceOfReleaseReadinessSummary = instanceOfReleaseReadinessSummary;
+exports.ReleaseReadinessSummaryFromJSON = ReleaseReadinessSummaryFromJSON;
+exports.ReleaseReadinessSummaryFromJSONTyped = ReleaseReadinessSummaryFromJSONTyped;
+exports.ReleaseReadinessSummaryToJSON = ReleaseReadinessSummaryToJSON;
+exports.ReleaseReadinessSummaryToJSONTyped = ReleaseReadinessSummaryToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessSummary interface.
+ */
+function instanceOfReleaseReadinessSummary(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('passed' in value) || value['passed'] === undefined)
+        return false;
+    if (!('failed' in value) || value['failed'] === undefined)
+        return false;
+    if (!('blocked' in value) || value['blocked'] === undefined)
+        return false;
+    if (!('skipped' in value) || value['skipped'] === undefined)
+        return false;
+    if (!('unexecuted' in value) || value['unexecuted'] === undefined)
+        return false;
+    if (!('passRate' in value) || value['passRate'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessSummaryFromJSON(json) {
+    return ReleaseReadinessSummaryFromJSONTyped(json, false);
+}
+function ReleaseReadinessSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return Object.assign(Object.assign({}, json), { 'total': json['total'], 'passed': json['passed'], 'failed': json['failed'], 'blocked': json['blocked'], 'skipped': json['skipped'], 'unexecuted': json['unexecuted'], 'passRate': json['pass_rate'] });
+}
+function ReleaseReadinessSummaryToJSON(json) {
+    return ReleaseReadinessSummaryToJSONTyped(json, false);
+}
+function ReleaseReadinessSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return Object.assign(Object.assign({}, value), { 'total': value['total'], 'passed': value['passed'], 'failed': value['failed'], 'blocked': value['blocked'], 'skipped': value['skipped'], 'unexecuted': value['unexecuted'], 'pass_rate': value['passRate'] });
+}

package/dist/models/ReleaseReadinessTestPlan.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 { ResultSummary } from './ResultSummary';
+import type { ReleaseReadinessTestPlanRun } from './ReleaseReadinessTestPlanRun';
+/**
+ * Per-test-plan readiness summary within a release, showing the latest run's results.
+ *
+ * @export
+ * @interface ReleaseReadinessTestPlan
+ */
+export interface ReleaseReadinessTestPlan {
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessTestPlan
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessTestPlan
+     */
+    title: string;
+    /**
+     * 0 = Draft; 1 = Ready to execute; 2 = Finish; 3 = Finished (with failures)
+     * @type {number}
+     * @memberof ReleaseReadinessTestPlan
+     */
+    status: ReleaseReadinessTestPlanStatusEnum;
+    /**
+     *
+     * @type {ReleaseReadinessTestPlanRun}
+     * @memberof ReleaseReadinessTestPlan
+     */
+    latestRun: ReleaseReadinessTestPlanRun;
+    /**
+     *
+     * @type {ResultSummary}
+     * @memberof ReleaseReadinessTestPlan
+     */
+    results: ResultSummary;
+}
+/**
+ * @export
+ */
+export declare const ReleaseReadinessTestPlanStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+    readonly NUMBER_3: 3;
+};
+export type ReleaseReadinessTestPlanStatusEnum = typeof ReleaseReadinessTestPlanStatusEnum[keyof typeof ReleaseReadinessTestPlanStatusEnum];
+/**
+ * Check if a given object implements the ReleaseReadinessTestPlan interface.
+ */
+export declare function instanceOfReleaseReadinessTestPlan(value: object): value is ReleaseReadinessTestPlan;
+export declare function ReleaseReadinessTestPlanFromJSON(json: any): ReleaseReadinessTestPlan;
+export declare function ReleaseReadinessTestPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessTestPlan;
+export declare function ReleaseReadinessTestPlanToJSON(json: any): ReleaseReadinessTestPlan;
+export declare function ReleaseReadinessTestPlanToJSONTyped(value?: ReleaseReadinessTestPlan | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessTestPlan.js

@@ -0,0 +1,76 @@
+"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.ReleaseReadinessTestPlanStatusEnum = void 0;
+exports.instanceOfReleaseReadinessTestPlan = instanceOfReleaseReadinessTestPlan;
+exports.ReleaseReadinessTestPlanFromJSON = ReleaseReadinessTestPlanFromJSON;
+exports.ReleaseReadinessTestPlanFromJSONTyped = ReleaseReadinessTestPlanFromJSONTyped;
+exports.ReleaseReadinessTestPlanToJSON = ReleaseReadinessTestPlanToJSON;
+exports.ReleaseReadinessTestPlanToJSONTyped = ReleaseReadinessTestPlanToJSONTyped;
+/**
+ * @export
+ */
+exports.ReleaseReadinessTestPlanStatusEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3
+};
+/**
+ * Check if a given object implements the ReleaseReadinessTestPlan interface.
+ */
+function instanceOfReleaseReadinessTestPlan(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('latestRun' in value) || value['latestRun'] === undefined)
+        return false;
+    if (!('results' in value) || value['results'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessTestPlanFromJSON(json) {
+    return ReleaseReadinessTestPlanFromJSONTyped(json, false);
+}
+function ReleaseReadinessTestPlanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'status': json['status'],
+        'latestRun': json['latest_run'],
+        'results': json['results'],
+    };
+}
+function ReleaseReadinessTestPlanToJSON(json) {
+    return ReleaseReadinessTestPlanToJSONTyped(json, false);
+}
+function ReleaseReadinessTestPlanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'status': value['status'],
+        'latest_run': value['latestRun'],
+        'results': value['results'],
+    };
+}