@testcollab/sdk 3.10.0 → 3.12.0

package/dist/esm/models/ReleaseMinified.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ReleaseMinified
+ */
+export interface ReleaseMinified {
+    /**
+     *
+     * @type {number}
+     * @memberof ReleaseMinified
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseMinified
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseMinified
+     */
+    status: ReleaseMinifiedStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseMinified
+     */
+    targetDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleaseMinified
+     */
+    createdAt?: string;
+}
+/**
+ * @export
+ */
+export declare const ReleaseMinifiedStatusEnum: {
+    readonly Planned: "planned";
+    readonly InProgress: "in_progress";
+    readonly Ready: "ready";
+    readonly Shipped: "shipped";
+    readonly Blocked: "blocked";
+};
+export type ReleaseMinifiedStatusEnum = typeof ReleaseMinifiedStatusEnum[keyof typeof ReleaseMinifiedStatusEnum];
+/**
+ * Check if a given object implements the ReleaseMinified interface.
+ */
+export declare function instanceOfReleaseMinified(value: object): value is ReleaseMinified;
+export declare function ReleaseMinifiedFromJSON(json: any): ReleaseMinified;
+export declare function ReleaseMinifiedFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseMinified;
+export declare function ReleaseMinifiedToJSON(json: any): ReleaseMinified;
+export declare function ReleaseMinifiedToJSONTyped(value?: ReleaseMinified | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ReleaseMinified.js

@@ -0,0 +1,65 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ReleaseMinifiedStatusEnum = {
+    Planned: 'planned',
+    InProgress: 'in_progress',
+    Ready: 'ready',
+    Shipped: 'shipped',
+    Blocked: 'blocked'
+};
+/**
+ * Check if a given object implements the ReleaseMinified interface.
+ */
+export function instanceOfReleaseMinified(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function ReleaseMinifiedFromJSON(json) {
+    return ReleaseMinifiedFromJSONTyped(json, false);
+}
+export function ReleaseMinifiedFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'status': json['status'],
+        'targetDate': json['target_date'] == null ? undefined : json['target_date'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+    };
+}
+export function ReleaseMinifiedToJSON(json) {
+    return ReleaseMinifiedToJSONTyped(json, false);
+}
+export function ReleaseMinifiedToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'status': value['status'],
+        'target_date': value['targetDate'],
+        'created_at': value['createdAt'],
+    };
+}

package/dist/esm/models/ReleasePayload.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 { ReleaseGoNoGoThreshold } from './ReleaseGoNoGoThreshold';
+/**
+ *
+ * @export
+ * @interface ReleasePayload
+ */
+export interface ReleasePayload {
+    /**
+     *
+     * @type {string}
+     * @memberof ReleasePayload
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleasePayload
+     */
+    description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleasePayload
+     */
+    status: ReleasePayloadStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleasePayload
+     */
+    targetDate?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReleasePayload
+     */
+    releaseDate?: string;
+    /**
+     *
+     * @type {ReleaseGoNoGoThreshold}
+     * @memberof ReleasePayload
+     */
+    goNoGoThreshold?: ReleaseGoNoGoThreshold;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ReleasePayload
+     */
+    isPublic?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ReleasePayload
+     */
+    project: number;
+    /**
+     * Array of test plan IDs to associate with this release
+     * @type {Array<number>}
+     * @memberof ReleasePayload
+     */
+    testPlans?: Array<number>;
+    /**
+     * Array of requirement IDs to associate with this release
+     * @type {Array<number>}
+     * @memberof ReleasePayload
+     */
+    requirements?: Array<number>;
+}
+/**
+ * @export
+ */
+export declare const ReleasePayloadStatusEnum: {
+    readonly Planned: "planned";
+    readonly InProgress: "in_progress";
+    readonly Ready: "ready";
+    readonly Shipped: "shipped";
+    readonly Blocked: "blocked";
+};
+export type ReleasePayloadStatusEnum = typeof ReleasePayloadStatusEnum[keyof typeof ReleasePayloadStatusEnum];
+/**
+ * Check if a given object implements the ReleasePayload interface.
+ */
+export declare function instanceOfReleasePayload(value: object): value is ReleasePayload;
+export declare function ReleasePayloadFromJSON(json: any): ReleasePayload;
+export declare function ReleasePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleasePayload;
+export declare function ReleasePayloadToJSON(json: any): ReleasePayload;
+export declare function ReleasePayloadToJSONTyped(value?: ReleasePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ReleasePayload.js

@@ -0,0 +1,75 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ReleasePayloadStatusEnum = {
+    Planned: 'planned',
+    InProgress: 'in_progress',
+    Ready: 'ready',
+    Shipped: 'shipped',
+    Blocked: 'blocked'
+};
+/**
+ * Check if a given object implements the ReleasePayload interface.
+ */
+export function instanceOfReleasePayload(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+export function ReleasePayloadFromJSON(json) {
+    return ReleasePayloadFromJSONTyped(json, false);
+}
+export function ReleasePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'status': json['status'],
+        'targetDate': json['target_date'] == null ? undefined : json['target_date'],
+        'releaseDate': json['release_date'] == null ? undefined : json['release_date'],
+        'goNoGoThreshold': json['go_no_go_threshold'] == null ? undefined : json['go_no_go_threshold'],
+        'isPublic': json['is_public'] == null ? undefined : json['is_public'],
+        'project': json['project'],
+        'testPlans': json['test_plans'] == null ? undefined : json['test_plans'],
+        'requirements': json['requirements'] == null ? undefined : json['requirements'],
+    };
+}
+export function ReleasePayloadToJSON(json) {
+    return ReleasePayloadToJSONTyped(json, false);
+}
+export function ReleasePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'status': value['status'],
+        'target_date': value['targetDate'],
+        'release_date': value['releaseDate'],
+        'go_no_go_threshold': value['goNoGoThreshold'],
+        'is_public': value['isPublic'],
+        'project': value['project'],
+        'test_plans': value['testPlans'],
+        'requirements': value['requirements'],
+    };
+}

package/dist/esm/models/ReleaseReadiness.d.ts

@@ -0,0 +1,106 @@
+/**
+ * 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';
+import type { ReleaseReadinessComparison } from './ReleaseReadinessComparison';
+import type { ReleaseReadinessRequirementCoverage } from './ReleaseReadinessRequirementCoverage';
+import type { ReleaseReadinessSummary } from './ReleaseReadinessSummary';
+import type { ReleaseReadinessConfigurationCoverage } from './ReleaseReadinessConfigurationCoverage';
+import type { ReleaseReadinessCustomFieldCoverage } from './ReleaseReadinessCustomFieldCoverage';
+import type { ReleaseReadinessVerdict } from './ReleaseReadinessVerdict';
+import type { ReleaseReadinessEvidence } from './ReleaseReadinessEvidence';
+import type { ReleaseReadinessDefects } from './ReleaseReadinessDefects';
+import type { ReleaseReadinessCoverageItem } from './ReleaseReadinessCoverageItem';
+import type { ReleaseReadinessTestPlan } from './ReleaseReadinessTestPlan';
+/**
+ * Aggregated readiness data for a release. Combines execution results, defect counts, coverage analysis, evidence metrics, and a computed Go/No-Go verdict across all test plans in the release.
+ *
+ * @export
+ * @interface ReleaseReadiness
+ */
+export interface ReleaseReadiness {
+    /**
+     *
+     * @type {ReleaseMinified}
+     * @memberof ReleaseReadiness
+     */
+    release: ReleaseMinified;
+    /**
+     *
+     * @type {ReleaseReadinessSummary}
+     * @memberof ReleaseReadiness
+     */
+    summary: ReleaseReadinessSummary;
+    /**
+     *
+     * @type {ReleaseReadinessDefects}
+     * @memberof ReleaseReadiness
+     */
+    defects: ReleaseReadinessDefects;
+    /**
+     *
+     * @type {Array<ReleaseReadinessCoverageItem>}
+     * @memberof ReleaseReadiness
+     */
+    coverage: Array<ReleaseReadinessCoverageItem>;
+    /**
+     *
+     * @type {ReleaseReadinessEvidence}
+     * @memberof ReleaseReadiness
+     */
+    evidence: ReleaseReadinessEvidence;
+    /**
+     *
+     * @type {ReleaseReadinessComparison}
+     * @memberof ReleaseReadiness
+     */
+    comparison?: ReleaseReadinessComparison;
+    /**
+     *
+     * @type {ReleaseReadinessVerdict}
+     * @memberof ReleaseReadiness
+     */
+    verdict: ReleaseReadinessVerdict;
+    /**
+     *
+     * @type {Array<ReleaseReadinessTestPlan>}
+     * @memberof ReleaseReadiness
+     */
+    testPlans: Array<ReleaseReadinessTestPlan>;
+    /**
+     *
+     * @type {ReleaseReadinessRequirementCoverage}
+     * @memberof ReleaseReadiness
+     */
+    requirementCoverage?: ReleaseReadinessRequirementCoverage;
+    /**
+     * Coverage breakdown by non-text custom fields. Only present when eligible custom fields exist for the project.
+     *
+     * @type {Array<ReleaseReadinessCustomFieldCoverage>}
+     * @memberof ReleaseReadiness
+     */
+    customFieldCoverage?: Array<ReleaseReadinessCustomFieldCoverage>;
+    /**
+     * Coverage breakdown by test plan configuration. Only present when test plans in the release have configurations defined.
+     *
+     * @type {Array<ReleaseReadinessConfigurationCoverage>}
+     * @memberof ReleaseReadiness
+     */
+    configurationCoverage?: Array<ReleaseReadinessConfigurationCoverage>;
+}
+/**
+ * Check if a given object implements the ReleaseReadiness interface.
+ */
+export declare function instanceOfReleaseReadiness(value: object): value is ReleaseReadiness;
+export declare function ReleaseReadinessFromJSON(json: any): ReleaseReadiness;
+export declare function ReleaseReadinessFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadiness;
+export declare function ReleaseReadinessToJSON(json: any): ReleaseReadiness;
+export declare function ReleaseReadinessToJSONTyped(value?: ReleaseReadiness | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ReleaseReadiness.js

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

package/dist/esm/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/esm/models/ReleaseReadinessComparison.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ReleaseReadinessComparison interface.
+ */
+export function instanceOfReleaseReadinessComparison(value) {
+    return true;
+}
+export function ReleaseReadinessComparisonFromJSON(json) {
+    return ReleaseReadinessComparisonFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function ReleaseReadinessComparisonToJSON(json) {
+    return ReleaseReadinessComparisonToJSONTyped(json, false);
+}
+export 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'],
+    };
+}