@testcollab/sdk 3.10.0 → 3.12.0

package/dist/models/ReleaseReadiness.js

@@ -0,0 +1,86 @@
+"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.instanceOfReleaseReadiness = instanceOfReleaseReadiness;
+exports.ReleaseReadinessFromJSON = ReleaseReadinessFromJSON;
+exports.ReleaseReadinessFromJSONTyped = ReleaseReadinessFromJSONTyped;
+exports.ReleaseReadinessToJSON = ReleaseReadinessToJSON;
+exports.ReleaseReadinessToJSONTyped = ReleaseReadinessToJSONTyped;
+const ReleaseReadinessConfigurationCoverage_1 = require("./ReleaseReadinessConfigurationCoverage");
+const ReleaseReadinessCustomFieldCoverage_1 = require("./ReleaseReadinessCustomFieldCoverage");
+const ReleaseReadinessCoverageItem_1 = require("./ReleaseReadinessCoverageItem");
+const ReleaseReadinessTestPlan_1 = require("./ReleaseReadinessTestPlan");
+/**
+ * Check if a given object implements the ReleaseReadiness interface.
+ */
+function instanceOfReleaseReadiness(value) {
+    if (!('release' in value) || value['release'] === undefined)
+        return false;
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('defects' in value) || value['defects'] === undefined)
+        return false;
+    if (!('coverage' in value) || value['coverage'] === undefined)
+        return false;
+    if (!('evidence' in value) || value['evidence'] === undefined)
+        return false;
+    if (!('verdict' in value) || value['verdict'] === undefined)
+        return false;
+    if (!('testPlans' in value) || value['testPlans'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessFromJSON(json) {
+    return ReleaseReadinessFromJSONTyped(json, false);
+}
+function ReleaseReadinessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'release': json['release'],
+        'summary': json['summary'],
+        'defects': json['defects'],
+        'coverage': (json['coverage'].map(ReleaseReadinessCoverageItem_1.ReleaseReadinessCoverageItemFromJSON)),
+        'evidence': json['evidence'],
+        'comparison': json['comparison'] == null ? undefined : json['comparison'],
+        'verdict': json['verdict'],
+        'testPlans': (json['test_plans'].map(ReleaseReadinessTestPlan_1.ReleaseReadinessTestPlanFromJSON)),
+        'requirementCoverage': json['requirement_coverage'] == null ? undefined : json['requirement_coverage'],
+        'customFieldCoverage': json['custom_field_coverage'] == null ? undefined : (json['custom_field_coverage'].map(ReleaseReadinessCustomFieldCoverage_1.ReleaseReadinessCustomFieldCoverageFromJSON)),
+        'configurationCoverage': json['configuration_coverage'] == null ? undefined : (json['configuration_coverage'].map(ReleaseReadinessConfigurationCoverage_1.ReleaseReadinessConfigurationCoverageFromJSON)),
+    };
+}
+function ReleaseReadinessToJSON(json) {
+    return ReleaseReadinessToJSONTyped(json, false);
+}
+function ReleaseReadinessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'release': value['release'],
+        'summary': value['summary'],
+        'defects': value['defects'],
+        'coverage': (value['coverage'].map(ReleaseReadinessCoverageItem_1.ReleaseReadinessCoverageItemToJSON)),
+        'evidence': value['evidence'],
+        'comparison': value['comparison'],
+        'verdict': value['verdict'],
+        'test_plans': (value['testPlans'].map(ReleaseReadinessTestPlan_1.ReleaseReadinessTestPlanToJSON)),
+        'requirement_coverage': value['requirementCoverage'],
+        'custom_field_coverage': value['customFieldCoverage'] == null ? undefined : (value['customFieldCoverage'].map(ReleaseReadinessCustomFieldCoverage_1.ReleaseReadinessCustomFieldCoverageToJSON)),
+        'configuration_coverage': value['configurationCoverage'] == null ? undefined : (value['configurationCoverage'].map(ReleaseReadinessConfigurationCoverage_1.ReleaseReadinessConfigurationCoverageToJSON)),
+    };
+}

package/dist/models/ReleaseReadinessComparison.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { ReleaseMinified } from './ReleaseMinified';
+/**
+ * Comparison of this release's readiness metrics against the previous release in the same project. Null if no previous release exists.
+ *
+ * @export
+ * @interface ReleaseReadinessComparison
+ */
+export interface ReleaseReadinessComparison {
+    /**
+     *
+     * @type {ReleaseMinified}
+     * @memberof ReleaseReadinessComparison
+     */
+    previousRelease?: ReleaseMinified;
+    /**
+     * Pass rate of the previous release
+     * @type {number}
+     * @memberof ReleaseReadinessComparison
+     */
+    previousPassRate?: number;
+    /**
+     * Difference in pass rate (current - previous). Negative means regression.
+     * @type {number}
+     * @memberof ReleaseReadinessComparison
+     */
+    passRateDelta?: number;
+    /**
+     * Number of open defects in the previous release at time of shipping
+     * @type {number}
+     * @memberof ReleaseReadinessComparison
+     */
+    previousOpenDefects?: number;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessComparison interface.
+ */
+export declare function instanceOfReleaseReadinessComparison(value: object): value is ReleaseReadinessComparison;
+export declare function ReleaseReadinessComparisonFromJSON(json: any): ReleaseReadinessComparison;
+export declare function ReleaseReadinessComparisonFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessComparison;
+export declare function ReleaseReadinessComparisonToJSON(json: any): ReleaseReadinessComparison;
+export declare function ReleaseReadinessComparisonToJSONTyped(value?: ReleaseReadinessComparison | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessComparison.js

@@ -0,0 +1,54 @@
+"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.instanceOfReleaseReadinessComparison = instanceOfReleaseReadinessComparison;
+exports.ReleaseReadinessComparisonFromJSON = ReleaseReadinessComparisonFromJSON;
+exports.ReleaseReadinessComparisonFromJSONTyped = ReleaseReadinessComparisonFromJSONTyped;
+exports.ReleaseReadinessComparisonToJSON = ReleaseReadinessComparisonToJSON;
+exports.ReleaseReadinessComparisonToJSONTyped = ReleaseReadinessComparisonToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessComparison interface.
+ */
+function instanceOfReleaseReadinessComparison(value) {
+    return true;
+}
+function ReleaseReadinessComparisonFromJSON(json) {
+    return ReleaseReadinessComparisonFromJSONTyped(json, false);
+}
+function ReleaseReadinessComparisonFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'previousRelease': json['previous_release'] == null ? undefined : json['previous_release'],
+        'previousPassRate': json['previous_pass_rate'] == null ? undefined : json['previous_pass_rate'],
+        'passRateDelta': json['pass_rate_delta'] == null ? undefined : json['pass_rate_delta'],
+        'previousOpenDefects': json['previous_open_defects'] == null ? undefined : json['previous_open_defects'],
+    };
+}
+function ReleaseReadinessComparisonToJSON(json) {
+    return ReleaseReadinessComparisonToJSONTyped(json, false);
+}
+function ReleaseReadinessComparisonToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'previous_release': value['previousRelease'],
+        'previous_pass_rate': value['previousPassRate'],
+        'pass_rate_delta': value['passRateDelta'],
+        'previous_open_defects': value['previousOpenDefects'],
+    };
+}

package/dist/models/ReleaseReadinessConfigurationCoverage.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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 breakdown for a single configuration. Shows execution statistics aggregated across all test plans in the release that use this configuration.
+ *
+ * @export
+ * @interface ReleaseReadinessConfigurationCoverage
+ */
+export interface ReleaseReadinessConfigurationCoverage {
+    /**
+     * The ID of the test plan configuration
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    configurationId: number;
+    /**
+     * Key-value pairs defining the configuration. E.g. {"browser": "Chrome", "os": "Windows"}.
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    parameters: {
+        [key: string]: string;
+    };
+    /**
+     * The test plan this configuration belongs to
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    testPlanId?: number;
+    /**
+     * Title of the test plan
+     * @type {string}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    testPlanTitle?: string;
+    /**
+     * Total test cases for this configuration
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    total: number;
+    /**
+     * Number of test cases executed
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    executed: number;
+    /**
+     * Number of test cases passed
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    passed: number;
+    /**
+     * Number of test cases failed
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    failed: number;
+    /**
+     * Pass rate as a percentage (passed / executed * 100)
+     * @type {number}
+     * @memberof ReleaseReadinessConfigurationCoverage
+     */
+    passRate: number;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessConfigurationCoverage interface.
+ */
+export declare function instanceOfReleaseReadinessConfigurationCoverage(value: object): value is ReleaseReadinessConfigurationCoverage;
+export declare function ReleaseReadinessConfigurationCoverageFromJSON(json: any): ReleaseReadinessConfigurationCoverage;
+export declare function ReleaseReadinessConfigurationCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessConfigurationCoverage;
+export declare function ReleaseReadinessConfigurationCoverageToJSON(json: any): ReleaseReadinessConfigurationCoverage;
+export declare function ReleaseReadinessConfigurationCoverageToJSONTyped(value?: ReleaseReadinessConfigurationCoverage | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessConfigurationCoverage.js

@@ -0,0 +1,78 @@
+"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.instanceOfReleaseReadinessConfigurationCoverage = instanceOfReleaseReadinessConfigurationCoverage;
+exports.ReleaseReadinessConfigurationCoverageFromJSON = ReleaseReadinessConfigurationCoverageFromJSON;
+exports.ReleaseReadinessConfigurationCoverageFromJSONTyped = ReleaseReadinessConfigurationCoverageFromJSONTyped;
+exports.ReleaseReadinessConfigurationCoverageToJSON = ReleaseReadinessConfigurationCoverageToJSON;
+exports.ReleaseReadinessConfigurationCoverageToJSONTyped = ReleaseReadinessConfigurationCoverageToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessConfigurationCoverage interface.
+ */
+function instanceOfReleaseReadinessConfigurationCoverage(value) {
+    if (!('configurationId' in value) || value['configurationId'] === undefined)
+        return false;
+    if (!('parameters' in value) || value['parameters'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === 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 (!('passRate' in value) || value['passRate'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessConfigurationCoverageFromJSON(json) {
+    return ReleaseReadinessConfigurationCoverageFromJSONTyped(json, false);
+}
+function ReleaseReadinessConfigurationCoverageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'configurationId': json['configuration_id'],
+        'parameters': json['parameters'],
+        'testPlanId': json['test_plan_id'] == null ? undefined : json['test_plan_id'],
+        'testPlanTitle': json['test_plan_title'] == null ? undefined : json['test_plan_title'],
+        'total': json['total'],
+        'executed': json['executed'],
+        'passed': json['passed'],
+        'failed': json['failed'],
+        'passRate': json['pass_rate'],
+    };
+}
+function ReleaseReadinessConfigurationCoverageToJSON(json) {
+    return ReleaseReadinessConfigurationCoverageToJSONTyped(json, false);
+}
+function ReleaseReadinessConfigurationCoverageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'configuration_id': value['configurationId'],
+        'parameters': value['parameters'],
+        'test_plan_id': value['testPlanId'],
+        'test_plan_title': value['testPlanTitle'],
+        'total': value['total'],
+        'executed': value['executed'],
+        'passed': value['passed'],
+        'failed': value['failed'],
+        'pass_rate': value['passRate'],
+    };
+}

package/dist/models/ReleaseReadinessCoverageItem.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+/**
+ * Test coverage for a single suite/module within the release. Supports tree structure — parent suites aggregate totals from children.
+ *
+ * @export
+ * @interface ReleaseReadinessCoverageItem
+ */
+export interface ReleaseReadinessCoverageItem {
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    suiteId: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    suiteTitle: string;
+    /**
+     * Total test cases from this suite (including children) in release test plans
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    total: number;
+    /**
+     * Number of test cases executed (including children, any status except unexecuted)
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    executed: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    passed?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    failed?: number;
+    /**
+     * Percentage of passed out of executed
+     * @type {number}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    passRate: number;
+    /**
+     * Child suite coverage nodes (tree structure)
+     * @type {Array<ReleaseReadinessCoverageItem>}
+     * @memberof ReleaseReadinessCoverageItem
+     */
+    children?: Array<ReleaseReadinessCoverageItem>;
+}
+/**
+ * Check if a given object implements the ReleaseReadinessCoverageItem interface.
+ */
+export declare function instanceOfReleaseReadinessCoverageItem(value: object): value is ReleaseReadinessCoverageItem;
+export declare function ReleaseReadinessCoverageItemFromJSON(json: any): ReleaseReadinessCoverageItem;
+export declare function ReleaseReadinessCoverageItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessCoverageItem;
+export declare function ReleaseReadinessCoverageItemToJSON(json: any): ReleaseReadinessCoverageItem;
+export declare function ReleaseReadinessCoverageItemToJSONTyped(value?: ReleaseReadinessCoverageItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ReleaseReadinessCoverageItem.js

@@ -0,0 +1,72 @@
+"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.instanceOfReleaseReadinessCoverageItem = instanceOfReleaseReadinessCoverageItem;
+exports.ReleaseReadinessCoverageItemFromJSON = ReleaseReadinessCoverageItemFromJSON;
+exports.ReleaseReadinessCoverageItemFromJSONTyped = ReleaseReadinessCoverageItemFromJSONTyped;
+exports.ReleaseReadinessCoverageItemToJSON = ReleaseReadinessCoverageItemToJSON;
+exports.ReleaseReadinessCoverageItemToJSONTyped = ReleaseReadinessCoverageItemToJSONTyped;
+/**
+ * Check if a given object implements the ReleaseReadinessCoverageItem interface.
+ */
+function instanceOfReleaseReadinessCoverageItem(value) {
+    if (!('suiteId' in value) || value['suiteId'] === undefined)
+        return false;
+    if (!('suiteTitle' in value) || value['suiteTitle'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('executed' in value) || value['executed'] === undefined)
+        return false;
+    if (!('passRate' in value) || value['passRate'] === undefined)
+        return false;
+    return true;
+}
+function ReleaseReadinessCoverageItemFromJSON(json) {
+    return ReleaseReadinessCoverageItemFromJSONTyped(json, false);
+}
+function ReleaseReadinessCoverageItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'suiteId': json['suite_id'],
+        'suiteTitle': json['suite_title'],
+        'total': json['total'],
+        'executed': json['executed'],
+        'passed': json['passed'] == null ? undefined : json['passed'],
+        'failed': json['failed'] == null ? undefined : json['failed'],
+        'passRate': json['pass_rate'],
+        'children': json['children'] == null ? undefined : (json['children'].map(ReleaseReadinessCoverageItemFromJSON)),
+    };
+}
+function ReleaseReadinessCoverageItemToJSON(json) {
+    return ReleaseReadinessCoverageItemToJSONTyped(json, false);
+}
+function ReleaseReadinessCoverageItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'suite_id': value['suiteId'],
+        'suite_title': value['suiteTitle'],
+        'total': value['total'],
+        'executed': value['executed'],
+        'passed': value['passed'],
+        'failed': value['failed'],
+        'pass_rate': value['passRate'],
+        'children': value['children'] == null ? undefined : (value['children'].map(ReleaseReadinessCoverageItemToJSON)),
+    };
+}

package/dist/models/ReleaseReadinessCustomFieldCoverage.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 { ReleaseReadinessCustomFieldGroup } from './ReleaseReadinessCustomFieldGroup';
+/**
+ * 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.
+ *
+ * @export
+ * @interface ReleaseReadinessCustomFieldCoverage
+ */
+export interface ReleaseReadinessCustomFieldCoverage {
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseReadinessCustomFieldCoverage
+     */
+    fieldId: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessCustomFieldCoverage
+     */
+    fieldLabel: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseReadinessCustomFieldCoverage
+     */
+    fieldType: ReleaseReadinessCustomFieldCoverageFieldTypeEnum;
+    /**
+     * Whether this is a test case or test plan custom field
+     * @type {string}
+     * @memberof ReleaseReadinessCustomFieldCoverage
+     */
+    entity?: ReleaseReadinessCustomFieldCoverageEntityEnum;
+    /**
+     *
+     * @type {Array<ReleaseReadinessCustomFieldGroup>}
+     * @memberof ReleaseReadinessCustomFieldCoverage
+     */
+    groups: Array<ReleaseReadinessCustomFieldGroup>;
+}
+/**
+ * @export
+ */
+export declare const ReleaseReadinessCustomFieldCoverageFieldTypeEnum: {
+    readonly Dropdown: "dropdown";
+    readonly MultipleSelect: "multipleSelect";
+    readonly Date: "date";
+    readonly Number: "number";
+    readonly User: "user";
+};
+export type ReleaseReadinessCustomFieldCoverageFieldTypeEnum = typeof ReleaseReadinessCustomFieldCoverageFieldTypeEnum[keyof typeof ReleaseReadinessCustomFieldCoverageFieldTypeEnum];
+/**
+ * @export
+ */
+export declare const ReleaseReadinessCustomFieldCoverageEntityEnum: {
+    readonly TestCase: "TestCase";
+    readonly TestPlan: "TestPlan";
+};
+export type ReleaseReadinessCustomFieldCoverageEntityEnum = typeof ReleaseReadinessCustomFieldCoverageEntityEnum[keyof typeof ReleaseReadinessCustomFieldCoverageEntityEnum];
+/**
+ * Check if a given object implements the ReleaseReadinessCustomFieldCoverage interface.
+ */
+export declare function instanceOfReleaseReadinessCustomFieldCoverage(value: object): value is ReleaseReadinessCustomFieldCoverage;
+export declare function ReleaseReadinessCustomFieldCoverageFromJSON(json: any): ReleaseReadinessCustomFieldCoverage;
+export declare function ReleaseReadinessCustomFieldCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessCustomFieldCoverage;
+export declare function ReleaseReadinessCustomFieldCoverageToJSON(json: any): ReleaseReadinessCustomFieldCoverage;
+export declare function ReleaseReadinessCustomFieldCoverageToJSONTyped(value?: ReleaseReadinessCustomFieldCoverage | null, ignoreDiscriminator?: boolean): any;