@testcollab/sdk 3.1.1

package/dist/models/TraceabilityMatrixPayload.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.instanceOfTraceabilityMatrixPayload = instanceOfTraceabilityMatrixPayload;
+exports.TraceabilityMatrixPayloadFromJSON = TraceabilityMatrixPayloadFromJSON;
+exports.TraceabilityMatrixPayloadFromJSONTyped = TraceabilityMatrixPayloadFromJSONTyped;
+exports.TraceabilityMatrixPayloadToJSON = TraceabilityMatrixPayloadToJSON;
+exports.TraceabilityMatrixPayloadToJSONTyped = TraceabilityMatrixPayloadToJSONTyped;
+/**
+ * Check if a given object implements the TraceabilityMatrixPayload interface.
+ */
+function instanceOfTraceabilityMatrixPayload(value) {
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+function TraceabilityMatrixPayloadFromJSON(json) {
+    return TraceabilityMatrixPayloadFromJSONTyped(json, false);
+}
+function TraceabilityMatrixPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filterModel': json['filterModel'] == null ? undefined : json['filterModel'],
+        'project': json['project'],
+        'forceRefresh': json['force_refresh'] == null ? undefined : json['force_refresh'],
+    };
+}
+function TraceabilityMatrixPayloadToJSON(json) {
+    return TraceabilityMatrixPayloadToJSONTyped(json, false);
+}
+function TraceabilityMatrixPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filterModel': value['filterModel'],
+        'project': value['project'],
+        'force_refresh': value['forceRefresh'],
+    };
+}

package/dist/models/TraceabilityMatrixRelation.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 TraceabilityMatrixRelation
+ */
+export interface TraceabilityMatrixRelation {
+    /**
+     *
+     * @type {number}
+     * @memberof TraceabilityMatrixRelation
+     */
+    testcaseId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TraceabilityMatrixRelation
+     */
+    requirementId: number;
+}
+/**
+ * Check if a given object implements the TraceabilityMatrixRelation interface.
+ */
+export declare function instanceOfTraceabilityMatrixRelation(value: object): value is TraceabilityMatrixRelation;
+export declare function TraceabilityMatrixRelationFromJSON(json: any): TraceabilityMatrixRelation;
+export declare function TraceabilityMatrixRelationFromJSONTyped(json: any, ignoreDiscriminator: boolean): TraceabilityMatrixRelation;
+export declare function TraceabilityMatrixRelationToJSON(json: any): TraceabilityMatrixRelation;
+export declare function TraceabilityMatrixRelationToJSONTyped(value?: TraceabilityMatrixRelation | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TraceabilityMatrixRelation.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.instanceOfTraceabilityMatrixRelation = instanceOfTraceabilityMatrixRelation;
+exports.TraceabilityMatrixRelationFromJSON = TraceabilityMatrixRelationFromJSON;
+exports.TraceabilityMatrixRelationFromJSONTyped = TraceabilityMatrixRelationFromJSONTyped;
+exports.TraceabilityMatrixRelationToJSON = TraceabilityMatrixRelationToJSON;
+exports.TraceabilityMatrixRelationToJSONTyped = TraceabilityMatrixRelationToJSONTyped;
+/**
+ * Check if a given object implements the TraceabilityMatrixRelation interface.
+ */
+function instanceOfTraceabilityMatrixRelation(value) {
+    if (!('testcaseId' in value) || value['testcaseId'] === undefined)
+        return false;
+    if (!('requirementId' in value) || value['requirementId'] === undefined)
+        return false;
+    return true;
+}
+function TraceabilityMatrixRelationFromJSON(json) {
+    return TraceabilityMatrixRelationFromJSONTyped(json, false);
+}
+function TraceabilityMatrixRelationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'testcaseId': json['testcase_id'],
+        'requirementId': json['requirement_id'],
+    };
+}
+function TraceabilityMatrixRelationToJSON(json) {
+    return TraceabilityMatrixRelationToJSONTyped(json, false);
+}
+function TraceabilityMatrixRelationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'testcase_id': value['testcaseId'],
+        'requirement_id': value['requirementId'],
+    };
+}

package/dist/models/TraceabilityMatrixResult.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 { RequirementMinified } from './RequirementMinified';
+import type { TestCaseMinified } from './TestCaseMinified';
+import type { Queue } from './Queue';
+import type { TraceabilityMatrixRelation } from './TraceabilityMatrixRelation';
+/**
+ *
+ * @export
+ * @interface TraceabilityMatrixResult
+ */
+export interface TraceabilityMatrixResult {
+    /**
+     *
+     * @type {Array<RequirementMinified>}
+     * @memberof TraceabilityMatrixResult
+     */
+    requirements: Array<RequirementMinified>;
+    /**
+     *
+     * @type {Array<TestCaseMinified>}
+     * @memberof TraceabilityMatrixResult
+     */
+    testcases?: Array<TestCaseMinified>;
+    /**
+     *
+     * @type {Array<TraceabilityMatrixRelation>}
+     * @memberof TraceabilityMatrixResult
+     */
+    relationData?: Array<TraceabilityMatrixRelation>;
+    /**
+     *
+     * @type {Queue}
+     * @memberof TraceabilityMatrixResult
+     */
+    queue?: Queue;
+    /**
+     *
+     * @type {number}
+     * @memberof TraceabilityMatrixResult
+     */
+    totalRequirement?: number;
+}
+/**
+ * Check if a given object implements the TraceabilityMatrixResult interface.
+ */
+export declare function instanceOfTraceabilityMatrixResult(value: object): value is TraceabilityMatrixResult;
+export declare function TraceabilityMatrixResultFromJSON(json: any): TraceabilityMatrixResult;
+export declare function TraceabilityMatrixResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): TraceabilityMatrixResult;
+export declare function TraceabilityMatrixResultToJSON(json: any): TraceabilityMatrixResult;
+export declare function TraceabilityMatrixResultToJSONTyped(value?: TraceabilityMatrixResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TraceabilityMatrixResult.js

@@ -0,0 +1,62 @@
+"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.instanceOfTraceabilityMatrixResult = instanceOfTraceabilityMatrixResult;
+exports.TraceabilityMatrixResultFromJSON = TraceabilityMatrixResultFromJSON;
+exports.TraceabilityMatrixResultFromJSONTyped = TraceabilityMatrixResultFromJSONTyped;
+exports.TraceabilityMatrixResultToJSON = TraceabilityMatrixResultToJSON;
+exports.TraceabilityMatrixResultToJSONTyped = TraceabilityMatrixResultToJSONTyped;
+const RequirementMinified_1 = require("./RequirementMinified");
+const TestCaseMinified_1 = require("./TestCaseMinified");
+const Queue_1 = require("./Queue");
+const TraceabilityMatrixRelation_1 = require("./TraceabilityMatrixRelation");
+/**
+ * Check if a given object implements the TraceabilityMatrixResult interface.
+ */
+function instanceOfTraceabilityMatrixResult(value) {
+    if (!('requirements' in value) || value['requirements'] === undefined)
+        return false;
+    return true;
+}
+function TraceabilityMatrixResultFromJSON(json) {
+    return TraceabilityMatrixResultFromJSONTyped(json, false);
+}
+function TraceabilityMatrixResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'requirements': (json['requirements'].map(RequirementMinified_1.RequirementMinifiedFromJSON)),
+        'testcases': json['testcases'] == null ? undefined : (json['testcases'].map(TestCaseMinified_1.TestCaseMinifiedFromJSON)),
+        'relationData': json['relationData'] == null ? undefined : (json['relationData'].map(TraceabilityMatrixRelation_1.TraceabilityMatrixRelationFromJSON)),
+        'queue': json['queue'] == null ? undefined : (0, Queue_1.QueueFromJSON)(json['queue']),
+        'totalRequirement': json['totalRequirement'] == null ? undefined : json['totalRequirement'],
+    };
+}
+function TraceabilityMatrixResultToJSON(json) {
+    return TraceabilityMatrixResultToJSONTyped(json, false);
+}
+function TraceabilityMatrixResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'requirements': (value['requirements'].map(RequirementMinified_1.RequirementMinifiedToJSON)),
+        'testcases': value['testcases'] == null ? undefined : (value['testcases'].map(TestCaseMinified_1.TestCaseMinifiedToJSON)),
+        'relationData': value['relationData'] == null ? undefined : (value['relationData'].map(TraceabilityMatrixRelation_1.TraceabilityMatrixRelationToJSON)),
+        'queue': (0, Queue_1.QueueToJSON)(value['queue']),
+        'totalRequirement': value['totalRequirement'],
+    };
+}

package/dist/models/TrainingArtifact.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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 TrainingArtifact
+ */
+export interface TrainingArtifact {
+    /**
+     * Training artifact identifier
+     * @type {number}
+     * @memberof TrainingArtifact
+     */
+    id: number;
+    /**
+     * Training session ID to which the artifact belongs
+     * @type {number}
+     * @memberof TrainingArtifact
+     */
+    trainingSession: number;
+    /**
+     * Result of the captured step
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    status: TrainingArtifactStatusEnum;
+    /**
+     * Failure context if the artifact status is fail
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    errorInfo?: string | null;
+    /**
+     * Zero-based main step index for the recorded action
+     * @type {number}
+     * @memberof TrainingArtifact
+     */
+    stepIndex: number;
+    /**
+     * Step type, where i = interaction and a = assertion
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    stepType: TrainingArtifactStepTypeEnum;
+    /**
+     * Zero-based counter for nested interactions inside the same step
+     * @type {number}
+     * @memberof TrainingArtifact
+     */
+    subStep?: number | null;
+    /**
+     * Human readable description for the sub-step
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    subStepTxt?: string | null;
+    /**
+     * Full-size screenshot captured for the step
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    imgFull?: string | null;
+    /**
+     * Thumbnail screenshot preview for the step
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    imgThumb?: string | null;
+    /**
+     * Exact time when the automation performed the action
+     * @type {Date}
+     * @memberof TrainingArtifact
+     */
+    timestamp?: Date | null;
+    /**
+     * Browser URL or location when the artifact was recorded
+     * @type {string}
+     * @memberof TrainingArtifact
+     */
+    browserLocation?: string | null;
+    /**
+     * Serialized AI reasoning or auxiliary metadata captured for the artifact
+     * @type {{ [key: string]: any; }}
+     * @memberof TrainingArtifact
+     */
+    otherInfoJson?: {
+        [key: string]: any;
+    } | null;
+    /**
+     * Timestamp when the artifact entry was created
+     * @type {Date}
+     * @memberof TrainingArtifact
+     */
+    createdAt?: Date;
+}
+/**
+ * @export
+ */
+export declare const TrainingArtifactStatusEnum: {
+    readonly Pass: "pass";
+    readonly Fail: "fail";
+};
+export type TrainingArtifactStatusEnum = typeof TrainingArtifactStatusEnum[keyof typeof TrainingArtifactStatusEnum];
+/**
+ * @export
+ */
+export declare const TrainingArtifactStepTypeEnum: {
+    readonly I: "i";
+    readonly A: "a";
+};
+export type TrainingArtifactStepTypeEnum = typeof TrainingArtifactStepTypeEnum[keyof typeof TrainingArtifactStepTypeEnum];
+/**
+ * Check if a given object implements the TrainingArtifact interface.
+ */
+export declare function instanceOfTrainingArtifact(value: object): value is TrainingArtifact;
+export declare function TrainingArtifactFromJSON(json: any): TrainingArtifact;
+export declare function TrainingArtifactFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrainingArtifact;
+export declare function TrainingArtifactToJSON(json: any): TrainingArtifact;
+export declare function TrainingArtifactToJSONTyped(value?: TrainingArtifact | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TrainingArtifact.js

@@ -0,0 +1,99 @@
+"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.TrainingArtifactStepTypeEnum = exports.TrainingArtifactStatusEnum = void 0;
+exports.instanceOfTrainingArtifact = instanceOfTrainingArtifact;
+exports.TrainingArtifactFromJSON = TrainingArtifactFromJSON;
+exports.TrainingArtifactFromJSONTyped = TrainingArtifactFromJSONTyped;
+exports.TrainingArtifactToJSON = TrainingArtifactToJSON;
+exports.TrainingArtifactToJSONTyped = TrainingArtifactToJSONTyped;
+/**
+ * @export
+ */
+exports.TrainingArtifactStatusEnum = {
+    Pass: 'pass',
+    Fail: 'fail'
+};
+/**
+ * @export
+ */
+exports.TrainingArtifactStepTypeEnum = {
+    I: 'i',
+    A: 'a'
+};
+/**
+ * Check if a given object implements the TrainingArtifact interface.
+ */
+function instanceOfTrainingArtifact(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('trainingSession' in value) || value['trainingSession'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('stepIndex' in value) || value['stepIndex'] === undefined)
+        return false;
+    if (!('stepType' in value) || value['stepType'] === undefined)
+        return false;
+    return true;
+}
+function TrainingArtifactFromJSON(json) {
+    return TrainingArtifactFromJSONTyped(json, false);
+}
+function TrainingArtifactFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'trainingSession': json['training_session'],
+        'status': json['status'],
+        'errorInfo': json['error_info'] == null ? undefined : json['error_info'],
+        'stepIndex': json['step_index'],
+        'stepType': json['step_type'],
+        'subStep': json['sub_step'] == null ? undefined : json['sub_step'],
+        'subStepTxt': json['sub_step_txt'] == null ? undefined : json['sub_step_txt'],
+        'imgFull': json['img_full'] == null ? undefined : json['img_full'],
+        'imgThumb': json['img_thumb'] == null ? undefined : json['img_thumb'],
+        'timestamp': json['timestamp'] == null ? undefined : (new Date(json['timestamp'])),
+        'browserLocation': json['browser_location'] == null ? undefined : json['browser_location'],
+        'otherInfoJson': json['other_info_json'] == null ? undefined : json['other_info_json'],
+        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
+    };
+}
+function TrainingArtifactToJSON(json) {
+    return TrainingArtifactToJSONTyped(json, false);
+}
+function TrainingArtifactToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'training_session': value['trainingSession'],
+        'status': value['status'],
+        'error_info': value['errorInfo'],
+        'step_index': value['stepIndex'],
+        'step_type': value['stepType'],
+        'sub_step': value['subStep'],
+        'sub_step_txt': value['subStepTxt'],
+        'img_full': value['imgFull'],
+        'img_thumb': value['imgThumb'],
+        'timestamp': value['timestamp'] == null ? value['timestamp'] : value['timestamp'].toISOString(),
+        'browser_location': value['browserLocation'],
+        'other_info_json': value['otherInfoJson'],
+        'created_at': value['createdAt'] == null ? value['createdAt'] : value['createdAt'].toISOString(),
+    };
+}

package/dist/models/TrainingArtifactPayload.d.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 TrainingArtifactPayload
+ */
+export interface TrainingArtifactPayload {
+    /**
+     * Training session ID to which the artifact belongs
+     * @type {number}
+     * @memberof TrainingArtifactPayload
+     */
+    trainingSession: number;
+    /**
+     * Status of the captured step
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    status: TrainingArtifactPayloadStatusEnum;
+    /**
+     * Optional error context when status is fail
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    errorInfo?: string;
+    /**
+     * Zero-based index for the parent step
+     * @type {number}
+     * @memberof TrainingArtifactPayload
+     */
+    stepIndex: number;
+    /**
+     * Step type, `i` for interaction and `a` for assertion
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    stepType: TrainingArtifactPayloadStepTypeEnum;
+    /**
+     * Zero-based counter for nested steps
+     * @type {number}
+     * @memberof TrainingArtifactPayload
+     */
+    subStep?: number;
+    /**
+     * Human readable description of the sub-step
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    subStepTxt?: string;
+    /**
+     * URL of the full-size screenshot
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    imgFull?: string;
+    /**
+     * URL of the thumbnail screenshot
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    imgThumb?: string;
+    /**
+     * Timestamp when the action was executed
+     * @type {Date}
+     * @memberof TrainingArtifactPayload
+     */
+    timestamp?: Date;
+    /**
+     * Browser URL captured for the artifact
+     * @type {string}
+     * @memberof TrainingArtifactPayload
+     */
+    browserLocation?: string;
+    /**
+     * Free-form metadata such as AI thoughts
+     * @type {{ [key: string]: any; }}
+     * @memberof TrainingArtifactPayload
+     */
+    otherInfoJson?: {
+        [key: string]: any;
+    };
+    /**
+     * Optional override for the artifact creation timestamp
+     * @type {Date}
+     * @memberof TrainingArtifactPayload
+     */
+    created?: Date;
+}
+/**
+ * @export
+ */
+export declare const TrainingArtifactPayloadStatusEnum: {
+    readonly Pass: "pass";
+    readonly Fail: "fail";
+};
+export type TrainingArtifactPayloadStatusEnum = typeof TrainingArtifactPayloadStatusEnum[keyof typeof TrainingArtifactPayloadStatusEnum];
+/**
+ * @export
+ */
+export declare const TrainingArtifactPayloadStepTypeEnum: {
+    readonly I: "i";
+    readonly A: "a";
+};
+export type TrainingArtifactPayloadStepTypeEnum = typeof TrainingArtifactPayloadStepTypeEnum[keyof typeof TrainingArtifactPayloadStepTypeEnum];
+/**
+ * Check if a given object implements the TrainingArtifactPayload interface.
+ */
+export declare function instanceOfTrainingArtifactPayload(value: object): value is TrainingArtifactPayload;
+export declare function TrainingArtifactPayloadFromJSON(json: any): TrainingArtifactPayload;
+export declare function TrainingArtifactPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrainingArtifactPayload;
+export declare function TrainingArtifactPayloadToJSON(json: any): TrainingArtifactPayload;
+export declare function TrainingArtifactPayloadToJSONTyped(value?: TrainingArtifactPayload | null, ignoreDiscriminator?: boolean): any;