@testcollab/sdk 3.1.1

package/dist/models/TestCase.js

@@ -0,0 +1,123 @@
+"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.TestCasePriorityEnum = void 0;
+exports.instanceOfTestCase = instanceOfTestCase;
+exports.TestCaseFromJSON = TestCaseFromJSON;
+exports.TestCaseFromJSONTyped = TestCaseFromJSONTyped;
+exports.TestCaseToJSON = TestCaseToJSON;
+exports.TestCaseToJSONTyped = TestCaseToJSONTyped;
+const Suite_1 = require("./Suite");
+const Requirement_1 = require("./Requirement");
+const UserMinified_1 = require("./UserMinified");
+const Upload_1 = require("./Upload");
+const Step_1 = require("./Step");
+const Tag_1 = require("./Tag");
+const CustomFieldCollectionOutput_1 = require("./CustomFieldCollectionOutput");
+const StepParsed_1 = require("./StepParsed");
+/**
+ * @export
+ */
+exports.TestCasePriorityEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the TestCase interface.
+ */
+function instanceOfTestCase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('priority' in value) || value['priority'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseFromJSON(json) {
+    return TestCaseFromJSONTyped(json, false);
+}
+function TestCaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'suite': json['suite'] == null ? undefined : (0, Suite_1.SuiteFromJSON)(json['suite']),
+        'description': json['description'],
+        'steps': json['steps'] == null ? undefined : (json['steps'].map(Step_1.StepFromJSON)),
+        'stepsParsed': json['steps_parsed'] == null ? undefined : (json['steps_parsed'].map(StepParsed_1.StepParsedFromJSON)),
+        'priority': json['priority'],
+        'tags': json['tags'] == null ? undefined : (json['tags'].map(Tag_1.TagFromJSON)),
+        'requirements': json['requirements'] == null ? undefined : (json['requirements'].map(Requirement_1.RequirementFromJSON)),
+        'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(Upload_1.UploadFromJSON)),
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputFromJSON)),
+        'sortOrder': json['sort_order'] == null ? undefined : json['sort_order'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+        'createdBy': json['created_by'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['created_by']),
+        'lastRunStatus': json['last_run_status'] == null ? undefined : json['last_run_status'],
+        'runCount': json['run_count'] == null ? undefined : json['run_count'],
+        'avgExecutionTime': json['avg_execution_time'] == null ? undefined : json['avg_execution_time'],
+        'lastRunOn': json['last_run_on'] == null ? undefined : json['last_run_on'],
+        'failureRate': json['failure_rate'] == null ? undefined : json['failure_rate'],
+        'isReference': json['is_reference'] == null ? undefined : json['is_reference'],
+        'sourceId': json['source_id'] == null ? undefined : json['source_id'],
+        'sourceProject': json['source_project'] == null ? undefined : json['source_project'],
+        'underReview': json['under_review'] == null ? undefined : json['under_review'],
+        'isAutomated': json['is_automated'] == null ? undefined : json['is_automated'],
+        'qacTimeout': json['qac_timeout'] == null ? undefined : json['qac_timeout'],
+    };
+}
+function TestCaseToJSON(json) {
+    return TestCaseToJSONTyped(json, false);
+}
+function TestCaseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'suite': (0, Suite_1.SuiteToJSON)(value['suite']),
+        'description': value['description'],
+        'steps': value['steps'] == null ? undefined : (value['steps'].map(Step_1.StepToJSON)),
+        'steps_parsed': value['stepsParsed'] == null ? undefined : (value['stepsParsed'].map(StepParsed_1.StepParsedToJSON)),
+        'priority': value['priority'],
+        'tags': value['tags'] == null ? undefined : (value['tags'].map(Tag_1.TagToJSON)),
+        'requirements': value['requirements'] == null ? undefined : (value['requirements'].map(Requirement_1.RequirementToJSON)),
+        'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(Upload_1.UploadToJSON)),
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldCollectionOutput_1.CustomFieldCollectionOutputToJSON)),
+        'sort_order': value['sortOrder'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'created_by': (0, UserMinified_1.UserMinifiedToJSON)(value['createdBy']),
+        'last_run_status': value['lastRunStatus'],
+        'run_count': value['runCount'],
+        'avg_execution_time': value['avgExecutionTime'],
+        'last_run_on': value['lastRunOn'],
+        'failure_rate': value['failureRate'],
+        'is_reference': value['isReference'],
+        'source_id': value['sourceId'],
+        'source_project': value['sourceProject'],
+        'under_review': value['underReview'],
+        'is_automated': value['isAutomated'],
+        'qac_timeout': value['qacTimeout'],
+    };
+}

package/dist/models/TestCaseAddActionResult.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 TestCaseAddActionResult
+ */
+export interface TestCaseAddActionResult {
+    /**
+     *
+     * @type {boolean}
+     * @memberof TestCaseAddActionResult
+     */
+    status: boolean;
+    /**
+     * ID of created test case
+     * @type {number}
+     * @memberof TestCaseAddActionResult
+     */
+    id: number;
+}
+/**
+ * Check if a given object implements the TestCaseAddActionResult interface.
+ */
+export declare function instanceOfTestCaseAddActionResult(value: object): value is TestCaseAddActionResult;
+export declare function TestCaseAddActionResultFromJSON(json: any): TestCaseAddActionResult;
+export declare function TestCaseAddActionResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseAddActionResult;
+export declare function TestCaseAddActionResultToJSON(json: any): TestCaseAddActionResult;
+export declare function TestCaseAddActionResultToJSONTyped(value?: TestCaseAddActionResult | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseAddActionResult.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.instanceOfTestCaseAddActionResult = instanceOfTestCaseAddActionResult;
+exports.TestCaseAddActionResultFromJSON = TestCaseAddActionResultFromJSON;
+exports.TestCaseAddActionResultFromJSONTyped = TestCaseAddActionResultFromJSONTyped;
+exports.TestCaseAddActionResultToJSON = TestCaseAddActionResultToJSON;
+exports.TestCaseAddActionResultToJSONTyped = TestCaseAddActionResultToJSONTyped;
+/**
+ * Check if a given object implements the TestCaseAddActionResult interface.
+ */
+function instanceOfTestCaseAddActionResult(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseAddActionResultFromJSON(json) {
+    return TestCaseAddActionResultFromJSONTyped(json, false);
+}
+function TestCaseAddActionResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'id': json['id'],
+    };
+}
+function TestCaseAddActionResultToJSON(json) {
+    return TestCaseAddActionResultToJSONTyped(json, false);
+}
+function TestCaseAddActionResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'id': value['id'],
+    };
+}

package/dist/models/TestCaseAutomationCodePayload.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 TestCaseAutomationCodePayload
+ */
+export interface TestCaseAutomationCodePayload {
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    testcase: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    testcaserevision: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    project: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    code: string;
+    /**
+     * automatic / manual
+     * @type {string}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    mode: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    automationStatus: number;
+    /**
+     * JSON stringified (applicable when test case automation feature is enabled)
+     * @type {string}
+     * @memberof TestCaseAutomationCodePayload
+     */
+    automationInfo: string;
+}
+/**
+ * Check if a given object implements the TestCaseAutomationCodePayload interface.
+ */
+export declare function instanceOfTestCaseAutomationCodePayload(value: object): value is TestCaseAutomationCodePayload;
+export declare function TestCaseAutomationCodePayloadFromJSON(json: any): TestCaseAutomationCodePayload;
+export declare function TestCaseAutomationCodePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseAutomationCodePayload;
+export declare function TestCaseAutomationCodePayloadToJSON(json: any): TestCaseAutomationCodePayload;
+export declare function TestCaseAutomationCodePayloadToJSONTyped(value?: TestCaseAutomationCodePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseAutomationCodePayload.js

@@ -0,0 +1,74 @@
+"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.instanceOfTestCaseAutomationCodePayload = instanceOfTestCaseAutomationCodePayload;
+exports.TestCaseAutomationCodePayloadFromJSON = TestCaseAutomationCodePayloadFromJSON;
+exports.TestCaseAutomationCodePayloadFromJSONTyped = TestCaseAutomationCodePayloadFromJSONTyped;
+exports.TestCaseAutomationCodePayloadToJSON = TestCaseAutomationCodePayloadToJSON;
+exports.TestCaseAutomationCodePayloadToJSONTyped = TestCaseAutomationCodePayloadToJSONTyped;
+/**
+ * Check if a given object implements the TestCaseAutomationCodePayload interface.
+ */
+function instanceOfTestCaseAutomationCodePayload(value) {
+    if (!('testcase' in value) || value['testcase'] === undefined)
+        return false;
+    if (!('testcaserevision' in value) || value['testcaserevision'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('automationStatus' in value) || value['automationStatus'] === undefined)
+        return false;
+    if (!('automationInfo' in value) || value['automationInfo'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseAutomationCodePayloadFromJSON(json) {
+    return TestCaseAutomationCodePayloadFromJSONTyped(json, false);
+}
+function TestCaseAutomationCodePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'testcase': json['testcase'],
+        'testcaserevision': json['testcaserevision'],
+        'project': json['project'],
+        'code': json['code'],
+        'mode': json['mode'],
+        'automationStatus': json['automation_status'],
+        'automationInfo': json['automation_info'],
+    };
+}
+function TestCaseAutomationCodePayloadToJSON(json) {
+    return TestCaseAutomationCodePayloadToJSONTyped(json, false);
+}
+function TestCaseAutomationCodePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'testcase': value['testcase'],
+        'testcaserevision': value['testcaserevision'],
+        'project': value['project'],
+        'code': value['code'],
+        'mode': value['mode'],
+        'automation_status': value['automationStatus'],
+        'automation_info': value['automationInfo'],
+    };
+}

package/dist/models/TestCaseAutomationProgressPayload.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.
+ */
+/**
+ *
+ * @export
+ * @interface TestCaseAutomationProgressPayload
+ */
+export interface TestCaseAutomationProgressPayload {
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    testcase: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    testcaserevision: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    project: number;
+    /**
+     * Code to validate the test case automation request/response
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    code: string;
+    /**
+     * Step content, e.g., 'Click on the button', 'Verify the text', etc.
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    step: string;
+    /**
+     * Test case automation training status
+     * @type {number}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    automationStatus: number;
+    /**
+     * Step number in the test case, e.g., 0, 1, 2, 3 - (0 is the first step)
+     * @type {number}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    stepNumber: number;
+    /**
+     * Type of the step, e.g., 'i'='interaction', 'a'='assertion'
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    stepType: string;
+    /**
+     * Status of the step, e.g., 'inprogress', 'error', 'finish'
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    stepStatus: string;
+    /**
+     * Error message if the step status is 'error'
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    stepError?: string;
+    /**
+     * List of image urls related to the step
+     * @type {Array<string>}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    stepImages?: Array<string>;
+    /**
+     * URL of the training video for the test case (optional and applicable only for the last step with status 'finish' or 'error')
+     * @type {string}
+     * @memberof TestCaseAutomationProgressPayload
+     */
+    trainingVideoUrl?: string;
+}
+/**
+ * Check if a given object implements the TestCaseAutomationProgressPayload interface.
+ */
+export declare function instanceOfTestCaseAutomationProgressPayload(value: object): value is TestCaseAutomationProgressPayload;
+export declare function TestCaseAutomationProgressPayloadFromJSON(json: any): TestCaseAutomationProgressPayload;
+export declare function TestCaseAutomationProgressPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseAutomationProgressPayload;
+export declare function TestCaseAutomationProgressPayloadToJSON(json: any): TestCaseAutomationProgressPayload;
+export declare function TestCaseAutomationProgressPayloadToJSONTyped(value?: TestCaseAutomationProgressPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseAutomationProgressPayload.js

@@ -0,0 +1,88 @@
+"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.instanceOfTestCaseAutomationProgressPayload = instanceOfTestCaseAutomationProgressPayload;
+exports.TestCaseAutomationProgressPayloadFromJSON = TestCaseAutomationProgressPayloadFromJSON;
+exports.TestCaseAutomationProgressPayloadFromJSONTyped = TestCaseAutomationProgressPayloadFromJSONTyped;
+exports.TestCaseAutomationProgressPayloadToJSON = TestCaseAutomationProgressPayloadToJSON;
+exports.TestCaseAutomationProgressPayloadToJSONTyped = TestCaseAutomationProgressPayloadToJSONTyped;
+/**
+ * Check if a given object implements the TestCaseAutomationProgressPayload interface.
+ */
+function instanceOfTestCaseAutomationProgressPayload(value) {
+    if (!('testcase' in value) || value['testcase'] === undefined)
+        return false;
+    if (!('testcaserevision' in value) || value['testcaserevision'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('step' in value) || value['step'] === undefined)
+        return false;
+    if (!('automationStatus' in value) || value['automationStatus'] === undefined)
+        return false;
+    if (!('stepNumber' in value) || value['stepNumber'] === undefined)
+        return false;
+    if (!('stepType' in value) || value['stepType'] === undefined)
+        return false;
+    if (!('stepStatus' in value) || value['stepStatus'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseAutomationProgressPayloadFromJSON(json) {
+    return TestCaseAutomationProgressPayloadFromJSONTyped(json, false);
+}
+function TestCaseAutomationProgressPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'testcase': json['testcase'],
+        'testcaserevision': json['testcaserevision'],
+        'project': json['project'],
+        'code': json['code'],
+        'step': json['step'],
+        'automationStatus': json['automation_status'],
+        'stepNumber': json['step_number'],
+        'stepType': json['step_type'],
+        'stepStatus': json['step_status'],
+        'stepError': json['step_error'] == null ? undefined : json['step_error'],
+        'stepImages': json['step_images'] == null ? undefined : json['step_images'],
+        'trainingVideoUrl': json['training_video_url'] == null ? undefined : json['training_video_url'],
+    };
+}
+function TestCaseAutomationProgressPayloadToJSON(json) {
+    return TestCaseAutomationProgressPayloadToJSONTyped(json, false);
+}
+function TestCaseAutomationProgressPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'testcase': value['testcase'],
+        'testcaserevision': value['testcaserevision'],
+        'project': value['project'],
+        'code': value['code'],
+        'step': value['step'],
+        'automation_status': value['automationStatus'],
+        'step_number': value['stepNumber'],
+        'step_type': value['stepType'],
+        'step_status': value['stepStatus'],
+        'step_error': value['stepError'],
+        'step_images': value['stepImages'],
+        'training_video_url': value['trainingVideoUrl'],
+    };
+}

package/dist/models/TestCaseAutomationStepFailurePayload.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 TestCaseAutomationStepFailurePayload
+ */
+export interface TestCaseAutomationStepFailurePayload {
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    testcase: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    testcaserevision: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    project: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    step: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    stepCounter?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    tcStepCounter?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseAutomationStepFailurePayload
+     */
+    errorDescription: string;
+}
+/**
+ * Check if a given object implements the TestCaseAutomationStepFailurePayload interface.
+ */
+export declare function instanceOfTestCaseAutomationStepFailurePayload(value: object): value is TestCaseAutomationStepFailurePayload;
+export declare function TestCaseAutomationStepFailurePayloadFromJSON(json: any): TestCaseAutomationStepFailurePayload;
+export declare function TestCaseAutomationStepFailurePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseAutomationStepFailurePayload;
+export declare function TestCaseAutomationStepFailurePayloadToJSON(json: any): TestCaseAutomationStepFailurePayload;
+export declare function TestCaseAutomationStepFailurePayloadToJSONTyped(value?: TestCaseAutomationStepFailurePayload | null, ignoreDiscriminator?: boolean): any;