@testcollab/sdk 3.10.0 → 3.12.0

package/src/models/Activity.ts

@@ -27,6 +27,13 @@ import {
     UserToJSON,
     UserToJSONTyped,
 } from './User';
+import type { ActivityAuditInfo } from './ActivityAuditInfo';
+import {
+    ActivityAuditInfoFromJSON,
+    ActivityAuditInfoFromJSONTyped,
+    ActivityAuditInfoToJSON,
+    ActivityAuditInfoToJSONTyped,
+} from './ActivityAuditInfo';
 
 /**
  * 
@@ -82,6 +89,12 @@ export interface Activity {
      * @memberof Activity
      */
     user: User;
+    /**
+     * 
+     * @type {ActivityAuditInfo}
+     * @memberof Activity
+     */
+    auditInfo?: ActivityAuditInfo;
     /**
      * Time when the activity was performed
      * @type {string}
@@ -112,7 +125,9 @@ export const ActivityActivityTypeEnum = {
     Reopen: 'reopen',
     FinishedRun: 'finished_run',
     AssigneeChange: 'assignee_change',
-    Comment: 'comment'
+    Comment: 'comment',
+    ReleaseVerdictChange: 'release_verdict_change',
+    Link: 'link'
 } as const;
 export type ActivityActivityTypeEnum = typeof ActivityActivityTypeEnum[keyof typeof ActivityActivityTypeEnum];
 
@@ -147,6 +162,7 @@ export function ActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'project': json['project'] == null ? undefined : ProjectMiniFromJSON(json['project']),
         'activityType': json['activity_type'],
         'user': UserFromJSON(json['user']),
+        'auditInfo': json['audit_info'] == null ? undefined : ActivityAuditInfoFromJSON(json['audit_info']),
         'createdAt': json['created_at'] == null ? undefined : json['created_at'],
         'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
     };
@@ -171,6 +187,7 @@ export function ActivityToJSONTyped(value?: Activity | null, ignoreDiscriminator
         'project': ProjectMiniToJSON(value['project']),
         'activity_type': value['activityType'],
         'user': UserToJSON(value['user']),
+        'audit_info': ActivityAuditInfoToJSON(value['auditInfo']),
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
     };

package/src/models/ActivityAuditInfo.ts

@@ -0,0 +1,81 @@
+/* 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';
+/**
+ * Additional metadata for the activity (e.g. release name, old/new verdict)
+ * @export
+ * @interface ActivityAuditInfo
+ */
+export interface ActivityAuditInfo {
+    /**
+     * Name of the release
+     * @type {string}
+     * @memberof ActivityAuditInfo
+     */
+    releaseName?: string;
+    /**
+     * Previous verdict value
+     * @type {string}
+     * @memberof ActivityAuditInfo
+     */
+    oldVerdict?: string;
+    /**
+     * New verdict value
+     * @type {string}
+     * @memberof ActivityAuditInfo
+     */
+    newVerdict?: string;
+}
+
+/**
+ * Check if a given object implements the ActivityAuditInfo interface.
+ */
+export function instanceOfActivityAuditInfo(value: object): value is ActivityAuditInfo {
+    return true;
+}
+
+export function ActivityAuditInfoFromJSON(json: any): ActivityAuditInfo {
+    return ActivityAuditInfoFromJSONTyped(json, false);
+}
+
+export function ActivityAuditInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActivityAuditInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'releaseName': json['release_name'] == null ? undefined : json['release_name'],
+        'oldVerdict': json['old_verdict'] == null ? undefined : json['old_verdict'],
+        'newVerdict': json['new_verdict'] == null ? undefined : json['new_verdict'],
+    };
+}
+
+export function ActivityAuditInfoToJSON(json: any): ActivityAuditInfo {
+    return ActivityAuditInfoToJSONTyped(json, false);
+}
+
+export function ActivityAuditInfoToJSONTyped(value?: ActivityAuditInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'release_name': value['releaseName'],
+        'old_verdict': value['oldVerdict'],
+        'new_verdict': value['newVerdict'],
+    };
+}
+

package/src/models/ProjectListItem.ts

@@ -0,0 +1,158 @@
+/* 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 { ProjectUserMinified } from './ProjectUserMinified';
+import {
+    ProjectUserMinifiedFromJSON,
+    ProjectUserMinifiedFromJSONTyped,
+    ProjectUserMinifiedToJSON,
+    ProjectUserMinifiedToJSONTyped,
+} from './ProjectUserMinified';
+
+/**
+ * 
+ * @export
+ * @interface ProjectListItem
+ */
+export interface ProjectListItem {
+    /**
+     * 
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    archived: boolean;
+    /**
+     * 
+     * @type {Array<ProjectUserMinified>}
+     * @memberof ProjectListItem
+     */
+    team?: Array<ProjectUserMinified>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    activity?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    createdAt: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectListItem
+     */
+    updatedAt: string;
+    /**
+     * Indicates that the project is a sample project or not
+     * @type {boolean}
+     * @memberof ProjectListItem
+     */
+    isSample?: boolean;
+    /**
+     * Number of test cases in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testCaseCount?: number;
+    /**
+     * Number of active test plans in the project
+     * @type {number}
+     * @memberof ProjectListItem
+     */
+    testPlanCount?: number;
+}
+
+/**
+ * Check if a given object implements the ProjectListItem interface.
+ */
+export function instanceOfProjectListItem(value: object): value is ProjectListItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('archived' in value) || value['archived'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ProjectListItemFromJSON(json: any): ProjectListItem {
+    return ProjectListItemFromJSONTyped(json, false);
+}
+
+export function ProjectListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'archived': json['archived'],
+        'team': json['team'] == null ? undefined : ((json['team'] as Array<any>).map(ProjectUserMinifiedFromJSON)),
+        'activity': json['activity'] == null ? undefined : json['activity'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'isSample': json['is_sample'] == null ? undefined : json['is_sample'],
+        'testCaseCount': json['test_case_count'] == null ? undefined : json['test_case_count'],
+        'testPlanCount': json['test_plan_count'] == null ? undefined : json['test_plan_count'],
+    };
+}
+
+export function ProjectListItemToJSON(json: any): ProjectListItem {
+    return ProjectListItemToJSONTyped(json, false);
+}
+
+export function ProjectListItemToJSONTyped(value?: ProjectListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'archived': value['archived'],
+        'team': value['team'] == null ? undefined : ((value['team'] as Array<any>).map(ProjectUserMinifiedToJSON)),
+        'activity': value['activity'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'is_sample': value['isSample'],
+        'test_case_count': value['testCaseCount'],
+        'test_plan_count': value['testPlanCount'],
+    };
+}
+

package/src/models/Release.ts

@@ -0,0 +1,227 @@
+/* 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 { ReleaseGoNoGoThreshold } from './ReleaseGoNoGoThreshold';
+import {
+    ReleaseGoNoGoThresholdFromJSON,
+    ReleaseGoNoGoThresholdFromJSONTyped,
+    ReleaseGoNoGoThresholdToJSON,
+    ReleaseGoNoGoThresholdToJSONTyped,
+} from './ReleaseGoNoGoThreshold';
+import type { RequirementMinified } from './RequirementMinified';
+import {
+    RequirementMinifiedFromJSON,
+    RequirementMinifiedFromJSONTyped,
+    RequirementMinifiedToJSON,
+    RequirementMinifiedToJSONTyped,
+} from './RequirementMinified';
+import type { UserMinified } from './UserMinified';
+import {
+    UserMinifiedFromJSON,
+    UserMinifiedFromJSONTyped,
+    UserMinifiedToJSON,
+    UserMinifiedToJSONTyped,
+} from './UserMinified';
+import type { TestPlanMinified } from './TestPlanMinified';
+import {
+    TestPlanMinifiedFromJSON,
+    TestPlanMinifiedFromJSONTyped,
+    TestPlanMinifiedToJSON,
+    TestPlanMinifiedToJSONTyped,
+} from './TestPlanMinified';
+
+/**
+ * 
+ * @export
+ * @interface Release
+ */
+export interface Release {
+    /**
+     * 
+     * @type {number}
+     * @memberof Release
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    description?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    status: ReleaseStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    targetDate?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    releaseDate?: string;
+    /**
+     * 
+     * @type {ReleaseGoNoGoThreshold}
+     * @memberof Release
+     */
+    goNoGoThreshold?: ReleaseGoNoGoThreshold;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof Release
+     */
+    isPublic?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    publicToken?: string;
+    /**
+     * 
+     * @type {Array<TestPlanMinified>}
+     * @memberof Release
+     */
+    testPlans?: Array<TestPlanMinified>;
+    /**
+     * Requirements associated with this release
+     * @type {Array<RequirementMinified>}
+     * @memberof Release
+     */
+    requirements?: Array<RequirementMinified>;
+    /**
+     * 
+     * @type {number}
+     * @memberof Release
+     */
+    project: number;
+    /**
+     * 
+     * @type {UserMinified}
+     * @memberof Release
+     */
+    createdBy: UserMinified;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    createdAt: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Release
+     */
+    updatedAt: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReleaseStatusEnum = {
+    Planned: 'planned',
+    InProgress: 'in_progress',
+    Ready: 'ready',
+    Shipped: 'shipped',
+    Blocked: 'blocked'
+} as const;
+export type ReleaseStatusEnum = typeof ReleaseStatusEnum[keyof typeof ReleaseStatusEnum];
+
+
+/**
+ * Check if a given object implements the Release interface.
+ */
+export function instanceOfRelease(value: object): value is Release {
+    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;
+    if (!('project' in value) || value['project'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ReleaseFromJSON(json: any): Release {
+    return ReleaseFromJSONTyped(json, false);
+}
+
+export function ReleaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Release {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        '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'],
+        'publicToken': json['public_token'] == null ? undefined : json['public_token'],
+        'testPlans': json['test_plans'] == null ? undefined : ((json['test_plans'] as Array<any>).map(TestPlanMinifiedFromJSON)),
+        'requirements': json['requirements'] == null ? undefined : ((json['requirements'] as Array<any>).map(RequirementMinifiedFromJSON)),
+        'project': json['project'],
+        'createdBy': json['created_by'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function ReleaseToJSON(json: any): Release {
+    return ReleaseToJSONTyped(json, false);
+}
+
+export function ReleaseToJSONTyped(value?: Release | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        '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'],
+        'public_token': value['publicToken'],
+        'test_plans': value['testPlans'] == null ? undefined : ((value['testPlans'] as Array<any>).map(TestPlanMinifiedToJSON)),
+        'requirements': value['requirements'] == null ? undefined : ((value['requirements'] as Array<any>).map(RequirementMinifiedToJSON)),
+        'project': value['project'],
+        'created_by': value['createdBy'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/ReleaseGoNoGoThreshold.ts

@@ -0,0 +1,82 @@
+/* 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';
+/**
+ * Configurable thresholds that determine the auto-computed Go/No-Go verdict for a release. All fields are optional — only configured thresholds are evaluated.
+ * 
+ * @export
+ * @interface ReleaseGoNoGoThreshold
+ */
+export interface ReleaseGoNoGoThreshold {
+    /**
+     * Minimum overall pass rate percentage required for a Go verdict
+     * @type {number}
+     * @memberof ReleaseGoNoGoThreshold
+     */
+    minPassRate?: number;
+    /**
+     * Maximum number of total open defects allowed across all severities
+     * @type {number}
+     * @memberof ReleaseGoNoGoThreshold
+     */
+    maxOpenDefects?: number;
+    /**
+     * Minimum percentage of failed executions that must have attachments
+     * @type {number}
+     * @memberof ReleaseGoNoGoThreshold
+     */
+    minEvidenceCoverage?: number;
+}
+
+/**
+ * Check if a given object implements the ReleaseGoNoGoThreshold interface.
+ */
+export function instanceOfReleaseGoNoGoThreshold(value: object): value is ReleaseGoNoGoThreshold {
+    return true;
+}
+
+export function ReleaseGoNoGoThresholdFromJSON(json: any): ReleaseGoNoGoThreshold {
+    return ReleaseGoNoGoThresholdFromJSONTyped(json, false);
+}
+
+export function ReleaseGoNoGoThresholdFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseGoNoGoThreshold {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'minPassRate': json['min_pass_rate'] == null ? undefined : json['min_pass_rate'],
+        'maxOpenDefects': json['max_open_defects'] == null ? undefined : json['max_open_defects'],
+        'minEvidenceCoverage': json['min_evidence_coverage'] == null ? undefined : json['min_evidence_coverage'],
+    };
+}
+
+export function ReleaseGoNoGoThresholdToJSON(json: any): ReleaseGoNoGoThreshold {
+    return ReleaseGoNoGoThresholdToJSONTyped(json, false);
+}
+
+export function ReleaseGoNoGoThresholdToJSONTyped(value?: ReleaseGoNoGoThreshold | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'min_pass_rate': value['minPassRate'],
+        'max_open_defects': value['maxOpenDefects'],
+        'min_evidence_coverage': value['minEvidenceCoverage'],
+    };
+}
+