@testcollab/sdk 3.10.0 → 3.12.0

package/src/models/ReleaseReadinessTestPlan.ts

@@ -0,0 +1,131 @@
+/* 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 { mapValues } from '../runtime';
+import type { ResultSummary } from './ResultSummary';
+import {
+    ResultSummaryFromJSON,
+    ResultSummaryFromJSONTyped,
+    ResultSummaryToJSON,
+    ResultSummaryToJSONTyped,
+} from './ResultSummary';
+import type { ReleaseReadinessTestPlanRun } from './ReleaseReadinessTestPlanRun';
+import {
+    ReleaseReadinessTestPlanRunFromJSON,
+    ReleaseReadinessTestPlanRunFromJSONTyped,
+    ReleaseReadinessTestPlanRunToJSON,
+    ReleaseReadinessTestPlanRunToJSONTyped,
+} 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 const ReleaseReadinessTestPlanStatusEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2,
+    NUMBER_3: 3
+} as const;
+export type ReleaseReadinessTestPlanStatusEnum = typeof ReleaseReadinessTestPlanStatusEnum[keyof typeof ReleaseReadinessTestPlanStatusEnum];
+
+
+/**
+ * Check if a given object implements the ReleaseReadinessTestPlan interface.
+ */
+export function instanceOfReleaseReadinessTestPlan(value: object): value is ReleaseReadinessTestPlan {
+    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;
+}
+
+export function ReleaseReadinessTestPlanFromJSON(json: any): ReleaseReadinessTestPlan {
+    return ReleaseReadinessTestPlanFromJSONTyped(json, false);
+}
+
+export function ReleaseReadinessTestPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessTestPlan {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'title': json['title'],
+        'status': json['status'],
+        'latestRun': json['latest_run'],
+        'results': json['results'],
+    };
+}
+
+export function ReleaseReadinessTestPlanToJSON(json: any): ReleaseReadinessTestPlan {
+    return ReleaseReadinessTestPlanToJSONTyped(json, false);
+}
+
+export function ReleaseReadinessTestPlanToJSONTyped(value?: ReleaseReadinessTestPlan | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'title': value['title'],
+        'status': value['status'],
+        'latest_run': value['latestRun'],
+        'results': value['results'],
+    };
+}
+

package/src/models/ReleaseReadinessTestPlanRun.ts

@@ -0,0 +1,92 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Minimal info about the latest run (regression) of a test plan within the release.
+ * 
+ * @export
+ * @interface ReleaseReadinessTestPlanRun
+ */
+export interface ReleaseReadinessTestPlanRun {
+    /**
+     * 
+     * @type {number}
+     * @memberof ReleaseReadinessTestPlanRun
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ReleaseReadinessTestPlanRun
+     */
+    iteration: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReleaseReadinessTestPlanRun
+     */
+    status?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReleaseReadinessTestPlanRun
+     */
+    createdAt?: string;
+}
+
+/**
+ * Check if a given object implements the ReleaseReadinessTestPlanRun interface.
+ */
+export function instanceOfReleaseReadinessTestPlanRun(value: object): value is ReleaseReadinessTestPlanRun {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('iteration' in value) || value['iteration'] === undefined) return false;
+    return true;
+}
+
+export function ReleaseReadinessTestPlanRunFromJSON(json: any): ReleaseReadinessTestPlanRun {
+    return ReleaseReadinessTestPlanRunFromJSONTyped(json, false);
+}
+
+export function ReleaseReadinessTestPlanRunFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessTestPlanRun {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'iteration': json['iteration'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+    };
+}
+
+export function ReleaseReadinessTestPlanRunToJSON(json: any): ReleaseReadinessTestPlanRun {
+    return ReleaseReadinessTestPlanRunToJSONTyped(json, false);
+}
+
+export function ReleaseReadinessTestPlanRunToJSONTyped(value?: ReleaseReadinessTestPlanRun | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'iteration': value['iteration'],
+        'status': value['status'],
+        'created_at': value['createdAt'],
+    };
+}
+

package/src/models/ReleaseReadinessVerdict.ts

@@ -0,0 +1,90 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * Computed Go/No-Go verdict based on the release's go_no_go_threshold settings compared against actual metrics.
+ * 
+ * @export
+ * @interface ReleaseReadinessVerdict
+ */
+export interface ReleaseReadinessVerdict {
+    /**
+     * go = all thresholds met; no_go = one or more thresholds violated; at_risk = within 5% of a threshold; not_configured = no thresholds set on the release
+     * 
+     * @type {string}
+     * @memberof ReleaseReadinessVerdict
+     */
+    result: ReleaseReadinessVerdictResultEnum;
+    /**
+     * List of human-readable reasons for the verdict
+     * @type {Array<string>}
+     * @memberof ReleaseReadinessVerdict
+     */
+    reasons: Array<string>;
+}
+
+
+/**
+ * @export
+ */
+export const ReleaseReadinessVerdictResultEnum = {
+    Go: 'go',
+    NoGo: 'no_go',
+    AtRisk: 'at_risk',
+    NotConfigured: 'not_configured'
+} as const;
+export type ReleaseReadinessVerdictResultEnum = typeof ReleaseReadinessVerdictResultEnum[keyof typeof ReleaseReadinessVerdictResultEnum];
+
+
+/**
+ * Check if a given object implements the ReleaseReadinessVerdict interface.
+ */
+export function instanceOfReleaseReadinessVerdict(value: object): value is ReleaseReadinessVerdict {
+    if (!('result' in value) || value['result'] === undefined) return false;
+    if (!('reasons' in value) || value['reasons'] === undefined) return false;
+    return true;
+}
+
+export function ReleaseReadinessVerdictFromJSON(json: any): ReleaseReadinessVerdict {
+    return ReleaseReadinessVerdictFromJSONTyped(json, false);
+}
+
+export function ReleaseReadinessVerdictFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessVerdict {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'result': json['result'],
+        'reasons': json['reasons'],
+    };
+}
+
+export function ReleaseReadinessVerdictToJSON(json: any): ReleaseReadinessVerdict {
+    return ReleaseReadinessVerdictToJSONTyped(json, false);
+}
+
+export function ReleaseReadinessVerdictToJSONTyped(value?: ReleaseReadinessVerdict | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'result': value['result'],
+        'reasons': value['reasons'],
+    };
+}
+

package/src/models/StepWiseResult.ts

@@ -49,6 +49,12 @@ export interface StepWiseResult {
      * @memberof StepWiseResult
      */
     comment: string;
+    /**
+     * ID of the user who wrote the comment
+     * @type {number}
+     * @memberof StepWiseResult
+     */
+    commentBy?: number;
     /**
      * Array of user IDs
      * @type {Array<string>}
@@ -88,6 +94,7 @@ export function StepWiseResultFromJSONTyped(json: any, ignoreDiscriminator: bool
         'expectedResult': json['expected_result'] == null ? undefined : json['expected_result'],
         'status': json['status'],
         'comment': json['comment'],
+        'commentBy': json['comment_by'] == null ? undefined : json['comment_by'],
         'mentions': json['mentions'] == null ? undefined : json['mentions'],
         'attachments': json['attachments'] == null ? undefined : json['attachments'],
     };
@@ -109,6 +116,7 @@ export function StepWiseResultToJSONTyped(value?: StepWiseResult | null, ignoreD
         'expected_result': value['expectedResult'],
         'status': value['status'],
         'comment': value['comment'],
+        'comment_by': value['commentBy'],
         'mentions': value['mentions'],
         'attachments': value['attachments'],
     };

package/src/models/TestDatasetWiseResult.ts

@@ -61,6 +61,12 @@ export interface TestDatasetWiseResult {
      * @memberof TestDatasetWiseResult
      */
     comment: string;
+    /**
+     * ID of the user who wrote the comment
+     * @type {number}
+     * @memberof TestDatasetWiseResult
+     */
+    commentBy?: number;
     /**
      * Array of user IDs
      * @type {Array<string>}
@@ -103,6 +109,7 @@ export function TestDatasetWiseResultFromJSONTyped(json: any, ignoreDiscriminato
         'expectedResult': json['expected_result'] == null ? undefined : json['expected_result'],
         'status': json['status'],
         'comment': json['comment'],
+        'commentBy': json['comment_by'] == null ? undefined : json['comment_by'],
         'mentions': json['mentions'] == null ? undefined : json['mentions'],
         'attachments': json['attachments'] == null ? undefined : json['attachments'],
     };
@@ -126,6 +133,7 @@ export function TestDatasetWiseResultToJSONTyped(value?: TestDatasetWiseResult |
         'expected_result': value['expectedResult'],
         'status': value['status'],
         'comment': value['comment'],
+        'comment_by': value['commentBy'],
         'mentions': value['mentions'],
         'attachments': value['attachments'],
     };

package/src/models/TestPlan.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ReleaseMinified } from './ReleaseMinified';
+import {
+    ReleaseMinifiedFromJSON,
+    ReleaseMinifiedFromJSONTyped,
+    ReleaseMinifiedToJSON,
+    ReleaseMinifiedToJSONTyped,
+} from './ReleaseMinified';
 import type { TestPlanFolder } from './TestPlanFolder';
 import {
     TestPlanFolderFromJSON,
@@ -168,6 +175,12 @@ export interface TestPlan {
      * @memberof TestPlan
      */
     isPublic?: number;
+    /**
+     * 
+     * @type {ReleaseMinified}
+     * @memberof TestPlan
+     */
+    release?: ReleaseMinified;
 }
 
 
@@ -240,6 +253,7 @@ export function TestPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'description': json['description'] == null ? undefined : json['description'],
         'customFields': json['custom_fields'] == null ? undefined : ((json['custom_fields'] as Array<any>).map(CustomFieldCollectionOutputFromJSON)),
         'isPublic': json['is_public'] == null ? undefined : json['is_public'],
+        'release': json['release'] == null ? undefined : json['release'],
     };
 }
 
@@ -274,6 +288,7 @@ export function TestPlanToJSONTyped(value?: TestPlan | null, ignoreDiscriminator
         'description': value['description'],
         'custom_fields': value['customFields'] == null ? undefined : ((value['customFields'] as Array<any>).map(CustomFieldCollectionOutputToJSON)),
         'is_public': value['isPublic'],
+        'release': value['release'],
     };
 }
 

package/src/models/TestPlanBulkActionPayload.ts

@@ -69,6 +69,12 @@ export interface TestPlanBulkActionPayload {
      * @memberof TestPlanBulkActionPayload
      */
     endDate?: string;
+    /**
+     * Release ID to associate test plans with (optional)
+     * @type {number}
+     * @memberof TestPlanBulkActionPayload
+     */
+    release?: number;
     /**
      * Array of custom fields
      * @type {Array<CustomFieldInputPayload>}
@@ -118,6 +124,7 @@ export function TestPlanBulkActionPayloadFromJSONTyped(json: any, ignoreDiscrimi
         'testPlanFolder': json['test_plan_folder'] == null ? undefined : json['test_plan_folder'],
         'startDate': json['start_date'] == null ? undefined : json['start_date'],
         'endDate': json['end_date'] == null ? undefined : json['end_date'],
+        'release': json['release'] == null ? undefined : json['release'],
         'customFields': json['custom_fields'] == null ? undefined : ((json['custom_fields'] as Array<any>).map(CustomFieldInputPayloadFromJSON)),
     };
 }
@@ -140,6 +147,7 @@ export function TestPlanBulkActionPayloadToJSONTyped(value?: TestPlanBulkActionP
         'test_plan_folder': value['testPlanFolder'],
         'start_date': value['startDate'],
         'end_date': value['endDate'],
+        'release': value['release'],
         'custom_fields': value['customFields'] == null ? undefined : ((value['customFields'] as Array<any>).map(CustomFieldInputPayloadToJSON)),
     };
 }

package/src/models/TestPlanPayload.ts

@@ -87,6 +87,12 @@ export interface TestPlanPayload {
      * @memberof TestPlanPayload
      */
     project: number;
+    /**
+     * Release ID to associate this test plan with (optional)
+     * @type {number}
+     * @memberof TestPlanPayload
+     */
+    release?: number;
     /**
      * Array of custom fields
      * @type {Array<CustomFieldInputPayload>}
@@ -150,6 +156,7 @@ export function TestPlanPayloadFromJSONTyped(json: any, ignoreDiscriminator: boo
         'startDate': json['start_date'] == null ? undefined : json['start_date'],
         'endDate': json['end_date'] == null ? undefined : json['end_date'],
         'project': json['project'],
+        'release': json['release'] == null ? undefined : json['release'],
         'customFields': json['custom_fields'] == null ? undefined : ((json['custom_fields'] as Array<any>).map(CustomFieldInputPayloadFromJSON)),
     };
 }
@@ -175,6 +182,7 @@ export function TestPlanPayloadToJSONTyped(value?: TestPlanPayload | null, ignor
         'start_date': value['startDate'],
         'end_date': value['endDate'],
         'project': value['project'],
+        'release': value['release'],
         'custom_fields': value['customFields'] == null ? undefined : ((value['customFields'] as Array<any>).map(CustomFieldInputPayloadToJSON)),
     };
 }

package/src/models/TraceabilityMatrixPayload.ts

@@ -37,6 +37,13 @@ export interface TraceabilityMatrixPayload {
      * @memberof TraceabilityMatrixPayload
      */
     forceRefresh?: boolean;
+    /**
+     * Optional release ID. When provided, the traceability matrix is filtered to only include test cases that belong to test plans in this release, and only requirements linked to this release.
+     * 
+     * @type {number}
+     * @memberof TraceabilityMatrixPayload
+     */
+    release?: number;
 }
 
 /**
@@ -60,6 +67,7 @@ export function TraceabilityMatrixPayloadFromJSONTyped(json: any, ignoreDiscrimi
         'filterModel': json['filterModel'] == null ? undefined : json['filterModel'],
         'project': json['project'],
         'forceRefresh': json['force_refresh'] == null ? undefined : json['force_refresh'],
+        'release': json['release'] == null ? undefined : json['release'],
     };
 }
 
@@ -77,6 +85,7 @@ export function TraceabilityMatrixPayloadToJSONTyped(value?: TraceabilityMatrixP
         'filterModel': value['filterModel'],
         'project': value['project'],
         'force_refresh': value['forceRefresh'],
+        'release': value['release'],
     };
 }
 

package/src/models/index.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './Activity';
+export * from './ActivityAuditInfo';
 export * from './AddNewFolderPayload';
 export * from './AddRequirementPayload';
 export * from './AddRequirementPayloadFolder';
@@ -147,6 +148,7 @@ export * from './PreferencePayload';
 export * from './Project';
 export * from './ProjectActivity';
 export * from './ProjectCreatePayload';
+export * from './ProjectListItem';
 export * from './ProjectMetrics';
 export * from './ProjectMini';
 export * from './ProjectMinified';
@@ -173,6 +175,26 @@ export * from './QueueStatus';
 export * from './QueueUpdatePayload';
 export * from './RegisteredUser';
 export * from './RegisteredUserUser';
+export * from './Release';
+export * from './ReleaseGoNoGoThreshold';
+export * from './ReleaseMinified';
+export * from './ReleasePayload';
+export * from './ReleaseReadiness';
+export * from './ReleaseReadinessComparison';
+export * from './ReleaseReadinessConfigurationCoverage';
+export * from './ReleaseReadinessCoverageItem';
+export * from './ReleaseReadinessCustomFieldCoverage';
+export * from './ReleaseReadinessCustomFieldGroup';
+export * from './ReleaseReadinessDefectSeverity';
+export * from './ReleaseReadinessDefects';
+export * from './ReleaseReadinessEvidence';
+export * from './ReleaseReadinessRequirementCoverage';
+export * from './ReleaseReadinessRequirementItem';
+export * from './ReleaseReadinessRequirementSummary';
+export * from './ReleaseReadinessSummary';
+export * from './ReleaseReadinessTestPlan';
+export * from './ReleaseReadinessTestPlanRun';
+export * from './ReleaseReadinessVerdict';
 export * from './ReportPayload';
 export * from './ReportResult';
 export * from './Requirement';