@testcollab/sdk 3.1.1

package/dist/models/TestCaseAutomationStepFailurePayload.js

@@ -0,0 +1,70 @@
+"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.instanceOfTestCaseAutomationStepFailurePayload = instanceOfTestCaseAutomationStepFailurePayload;
+exports.TestCaseAutomationStepFailurePayloadFromJSON = TestCaseAutomationStepFailurePayloadFromJSON;
+exports.TestCaseAutomationStepFailurePayloadFromJSONTyped = TestCaseAutomationStepFailurePayloadFromJSONTyped;
+exports.TestCaseAutomationStepFailurePayloadToJSON = TestCaseAutomationStepFailurePayloadToJSON;
+exports.TestCaseAutomationStepFailurePayloadToJSONTyped = TestCaseAutomationStepFailurePayloadToJSONTyped;
+/**
+ * Check if a given object implements the TestCaseAutomationStepFailurePayload interface.
+ */
+function instanceOfTestCaseAutomationStepFailurePayload(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 (!('step' in value) || value['step'] === undefined)
+        return false;
+    if (!('errorDescription' in value) || value['errorDescription'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseAutomationStepFailurePayloadFromJSON(json) {
+    return TestCaseAutomationStepFailurePayloadFromJSONTyped(json, false);
+}
+function TestCaseAutomationStepFailurePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'testcase': json['testcase'],
+        'testcaserevision': json['testcaserevision'],
+        'project': json['project'],
+        'step': json['step'],
+        'stepCounter': json['step_counter'] == null ? undefined : json['step_counter'],
+        'tcStepCounter': json['tc_step_counter'] == null ? undefined : json['tc_step_counter'],
+        'errorDescription': json['error_description'],
+    };
+}
+function TestCaseAutomationStepFailurePayloadToJSON(json) {
+    return TestCaseAutomationStepFailurePayloadToJSONTyped(json, false);
+}
+function TestCaseAutomationStepFailurePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'testcase': value['testcase'],
+        'testcaserevision': value['testcaserevision'],
+        'project': value['project'],
+        'step': value['step'],
+        'step_counter': value['stepCounter'],
+        'tc_step_counter': value['tcStepCounter'],
+        'error_description': value['errorDescription'],
+    };
+}

package/dist/models/TestCaseBulkActionEditPayload.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 { CustomFieldInputPayload } from './CustomFieldInputPayload';
+/**
+ *
+ * @export
+ * @interface TestCaseBulkActionEditPayload
+ */
+export interface TestCaseBulkActionEditPayload {
+    /**
+     *
+     * @type {boolean}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    overwriteTags?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    suite?: number;
+    /**
+     * Priority, 0 - Low, 1- Normal, 2 - High
+     * @type {number}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    priority?: TestCaseBulkActionEditPayloadPriorityEnum;
+    /**
+     * Tag IDs array
+     * @type {Array<number>}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    tags?: Array<number>;
+    /**
+     * Array of custom fields
+     * @type {Array<CustomFieldInputPayload>}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    customFields?: Array<CustomFieldInputPayload>;
+    /**
+     * Requirement IDs array
+     * @type {Array<number>}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    requirements?: Array<number>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof TestCaseBulkActionEditPayload
+     */
+    overwriteRequirements?: boolean;
+}
+/**
+ * @export
+ */
+export declare const TestCaseBulkActionEditPayloadPriorityEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type TestCaseBulkActionEditPayloadPriorityEnum = typeof TestCaseBulkActionEditPayloadPriorityEnum[keyof typeof TestCaseBulkActionEditPayloadPriorityEnum];
+/**
+ * Check if a given object implements the TestCaseBulkActionEditPayload interface.
+ */
+export declare function instanceOfTestCaseBulkActionEditPayload(value: object): value is TestCaseBulkActionEditPayload;
+export declare function TestCaseBulkActionEditPayloadFromJSON(json: any): TestCaseBulkActionEditPayload;
+export declare function TestCaseBulkActionEditPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseBulkActionEditPayload;
+export declare function TestCaseBulkActionEditPayloadToJSON(json: any): TestCaseBulkActionEditPayload;
+export declare function TestCaseBulkActionEditPayloadToJSONTyped(value?: TestCaseBulkActionEditPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseBulkActionEditPayload.js

@@ -0,0 +1,70 @@
+"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.TestCaseBulkActionEditPayloadPriorityEnum = void 0;
+exports.instanceOfTestCaseBulkActionEditPayload = instanceOfTestCaseBulkActionEditPayload;
+exports.TestCaseBulkActionEditPayloadFromJSON = TestCaseBulkActionEditPayloadFromJSON;
+exports.TestCaseBulkActionEditPayloadFromJSONTyped = TestCaseBulkActionEditPayloadFromJSONTyped;
+exports.TestCaseBulkActionEditPayloadToJSON = TestCaseBulkActionEditPayloadToJSON;
+exports.TestCaseBulkActionEditPayloadToJSONTyped = TestCaseBulkActionEditPayloadToJSONTyped;
+const CustomFieldInputPayload_1 = require("./CustomFieldInputPayload");
+/**
+ * @export
+ */
+exports.TestCaseBulkActionEditPayloadPriorityEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the TestCaseBulkActionEditPayload interface.
+ */
+function instanceOfTestCaseBulkActionEditPayload(value) {
+    return true;
+}
+function TestCaseBulkActionEditPayloadFromJSON(json) {
+    return TestCaseBulkActionEditPayloadFromJSONTyped(json, false);
+}
+function TestCaseBulkActionEditPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'overwriteTags': json['overwrite_tags'] == null ? undefined : json['overwrite_tags'],
+        'suite': json['suite'] == null ? undefined : json['suite'],
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadFromJSON)),
+        'requirements': json['requirements'] == null ? undefined : json['requirements'],
+        'overwriteRequirements': json['overwrite_requirements'] == null ? undefined : json['overwrite_requirements'],
+    };
+}
+function TestCaseBulkActionEditPayloadToJSON(json) {
+    return TestCaseBulkActionEditPayloadToJSONTyped(json, false);
+}
+function TestCaseBulkActionEditPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'overwrite_tags': value['overwriteTags'],
+        'suite': value['suite'],
+        'priority': value['priority'],
+        'tags': value['tags'],
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayload_1.CustomFieldInputPayloadToJSON)),
+        'requirements': value['requirements'],
+        'overwrite_requirements': value['overwriteRequirements'],
+    };
+}

package/dist/models/TestCaseBulkActionPayload.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 { TestCaseBulkActionEditPayload } from './TestCaseBulkActionEditPayload';
+/**
+ *
+ * @export
+ * @interface TestCaseBulkActionPayload
+ */
+export interface TestCaseBulkActionPayload {
+    /**
+     * Bulk actions like automation
+     * @type {string}
+     * @memberof TestCaseBulkActionPayload
+     */
+    actionType: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseBulkActionPayload
+     */
+    project: number;
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof TestCaseBulkActionPayload
+     */
+    testcaseIds: Array<number>;
+    /**
+     * Applicable for automation only - Resume if single test case is selected
+     * @type {boolean}
+     * @memberof TestCaseBulkActionPayload
+     */
+    resume?: boolean;
+    /**
+     * Applicable for automation only - Resume from step number if single test case is selected
+     * @type {number}
+     * @memberof TestCaseBulkActionPayload
+     */
+    resumeFrom?: number;
+    /**
+     *
+     * @type {TestCaseBulkActionEditPayload}
+     * @memberof TestCaseBulkActionPayload
+     */
+    editParams?: TestCaseBulkActionEditPayload;
+    /**
+     * List of user ids (as reviewers)
+     * @type {Array<number>}
+     * @memberof TestCaseBulkActionPayload
+     */
+    reviewers?: Array<number>;
+}
+/**
+ * Check if a given object implements the TestCaseBulkActionPayload interface.
+ */
+export declare function instanceOfTestCaseBulkActionPayload(value: object): value is TestCaseBulkActionPayload;
+export declare function TestCaseBulkActionPayloadFromJSON(json: any): TestCaseBulkActionPayload;
+export declare function TestCaseBulkActionPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseBulkActionPayload;
+export declare function TestCaseBulkActionPayloadToJSON(json: any): TestCaseBulkActionPayload;
+export declare function TestCaseBulkActionPayloadToJSONTyped(value?: TestCaseBulkActionPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseBulkActionPayload.js

@@ -0,0 +1,67 @@
+"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.instanceOfTestCaseBulkActionPayload = instanceOfTestCaseBulkActionPayload;
+exports.TestCaseBulkActionPayloadFromJSON = TestCaseBulkActionPayloadFromJSON;
+exports.TestCaseBulkActionPayloadFromJSONTyped = TestCaseBulkActionPayloadFromJSONTyped;
+exports.TestCaseBulkActionPayloadToJSON = TestCaseBulkActionPayloadToJSON;
+exports.TestCaseBulkActionPayloadToJSONTyped = TestCaseBulkActionPayloadToJSONTyped;
+const TestCaseBulkActionEditPayload_1 = require("./TestCaseBulkActionEditPayload");
+/**
+ * Check if a given object implements the TestCaseBulkActionPayload interface.
+ */
+function instanceOfTestCaseBulkActionPayload(value) {
+    if (!('actionType' in value) || value['actionType'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    if (!('testcaseIds' in value) || value['testcaseIds'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseBulkActionPayloadFromJSON(json) {
+    return TestCaseBulkActionPayloadFromJSONTyped(json, false);
+}
+function TestCaseBulkActionPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'actionType': json['actionType'],
+        'project': json['project'],
+        'testcaseIds': json['testcaseIds'],
+        'resume': json['resume'] == null ? undefined : json['resume'],
+        'resumeFrom': json['resumeFrom'] == null ? undefined : json['resumeFrom'],
+        'editParams': json['editParams'] == null ? undefined : (0, TestCaseBulkActionEditPayload_1.TestCaseBulkActionEditPayloadFromJSON)(json['editParams']),
+        'reviewers': json['reviewers'] == null ? undefined : json['reviewers'],
+    };
+}
+function TestCaseBulkActionPayloadToJSON(json) {
+    return TestCaseBulkActionPayloadToJSONTyped(json, false);
+}
+function TestCaseBulkActionPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'actionType': value['actionType'],
+        'project': value['project'],
+        'testcaseIds': value['testcaseIds'],
+        'resume': value['resume'],
+        'resumeFrom': value['resumeFrom'],
+        'editParams': (0, TestCaseBulkActionEditPayload_1.TestCaseBulkActionEditPayloadToJSON)(value['editParams']),
+        'reviewers': value['reviewers'],
+    };
+}

package/dist/models/TestCaseComment.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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 { User } from './User';
+import type { UserMinified } from './UserMinified';
+import type { Upload } from './Upload';
+/**
+ *
+ * @export
+ * @interface TestCaseComment
+ */
+export interface TestCaseComment {
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseComment
+     */
+    id: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseComment
+     */
+    testPlanId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseComment
+     */
+    parentId?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseComment
+     */
+    project?: number;
+    /**
+     *
+     * @type {Array<Upload>}
+     * @memberof TestCaseComment
+     */
+    attachments?: Array<Upload>;
+    /**
+     *
+     * @type {Array<User>}
+     * @memberof TestCaseComment
+     */
+    mentions?: Array<User>;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseComment
+     */
+    testCase?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseComment
+     */
+    comment: string;
+    /**
+     *
+     * @type {UserMinified}
+     * @memberof TestCaseComment
+     */
+    createdBy: UserMinified;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseComment
+     */
+    createdAt?: string;
+}
+/**
+ * Check if a given object implements the TestCaseComment interface.
+ */
+export declare function instanceOfTestCaseComment(value: object): value is TestCaseComment;
+export declare function TestCaseCommentFromJSON(json: any): TestCaseComment;
+export declare function TestCaseCommentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseComment;
+export declare function TestCaseCommentToJSON(json: any): TestCaseComment;
+export declare function TestCaseCommentToJSONTyped(value?: TestCaseComment | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseComment.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.instanceOfTestCaseComment = instanceOfTestCaseComment;
+exports.TestCaseCommentFromJSON = TestCaseCommentFromJSON;
+exports.TestCaseCommentFromJSONTyped = TestCaseCommentFromJSONTyped;
+exports.TestCaseCommentToJSON = TestCaseCommentToJSON;
+exports.TestCaseCommentToJSONTyped = TestCaseCommentToJSONTyped;
+const User_1 = require("./User");
+const Upload_1 = require("./Upload");
+/**
+ * Check if a given object implements the TestCaseComment interface.
+ */
+function instanceOfTestCaseComment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('comment' in value) || value['comment'] === undefined)
+        return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseCommentFromJSON(json) {
+    return TestCaseCommentFromJSONTyped(json, false);
+}
+function TestCaseCommentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'testPlanId': json['testPlanId'] == null ? undefined : json['testPlanId'],
+        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(Upload_1.UploadFromJSON)),
+        'mentions': json['mentions'] == null ? undefined : (json['mentions'].map(User_1.UserFromJSON)),
+        'testCase': json['test_case'] == null ? undefined : json['test_case'],
+        'comment': json['comment'],
+        'createdBy': json['created_by'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+    };
+}
+function TestCaseCommentToJSON(json) {
+    return TestCaseCommentToJSONTyped(json, false);
+}
+function TestCaseCommentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'testPlanId': value['testPlanId'],
+        'parent_id': value['parentId'],
+        'project': value['project'],
+        'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(Upload_1.UploadToJSON)),
+        'mentions': value['mentions'] == null ? undefined : (value['mentions'].map(User_1.UserToJSON)),
+        'test_case': value['testCase'],
+        'comment': value['comment'],
+        'created_by': value['createdBy'],
+        'created_at': value['createdAt'],
+    };
+}

package/dist/models/TestCaseCommentPayload.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 TestCaseCommentPayload
+ */
+export interface TestCaseCommentPayload {
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseCommentPayload
+     */
+    comment: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseCommentPayload
+     */
+    testCase: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseCommentPayload
+     */
+    project?: number;
+    /**
+     * Array of file ids
+     * @type {Array<string>}
+     * @memberof TestCaseCommentPayload
+     */
+    attachments?: Array<string>;
+    /**
+     * Array of user IDs
+     * @type {Array<string>}
+     * @memberof TestCaseCommentPayload
+     */
+    mentions?: Array<string>;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseCommentPayload
+     */
+    parentId?: number;
+}
+/**
+ * Check if a given object implements the TestCaseCommentPayload interface.
+ */
+export declare function instanceOfTestCaseCommentPayload(value: object): value is TestCaseCommentPayload;
+export declare function TestCaseCommentPayloadFromJSON(json: any): TestCaseCommentPayload;
+export declare function TestCaseCommentPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseCommentPayload;
+export declare function TestCaseCommentPayloadToJSON(json: any): TestCaseCommentPayload;
+export declare function TestCaseCommentPayloadToJSONTyped(value?: TestCaseCommentPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TestCaseCommentPayload.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.instanceOfTestCaseCommentPayload = instanceOfTestCaseCommentPayload;
+exports.TestCaseCommentPayloadFromJSON = TestCaseCommentPayloadFromJSON;
+exports.TestCaseCommentPayloadFromJSONTyped = TestCaseCommentPayloadFromJSONTyped;
+exports.TestCaseCommentPayloadToJSON = TestCaseCommentPayloadToJSON;
+exports.TestCaseCommentPayloadToJSONTyped = TestCaseCommentPayloadToJSONTyped;
+/**
+ * Check if a given object implements the TestCaseCommentPayload interface.
+ */
+function instanceOfTestCaseCommentPayload(value) {
+    if (!('comment' in value) || value['comment'] === undefined)
+        return false;
+    if (!('testCase' in value) || value['testCase'] === undefined)
+        return false;
+    return true;
+}
+function TestCaseCommentPayloadFromJSON(json) {
+    return TestCaseCommentPayloadFromJSONTyped(json, false);
+}
+function TestCaseCommentPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'comment': json['comment'],
+        'testCase': json['test_case'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'mentions': json['mentions'] == null ? undefined : json['mentions'],
+        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
+    };
+}
+function TestCaseCommentPayloadToJSON(json) {
+    return TestCaseCommentPayloadToJSONTyped(json, false);
+}
+function TestCaseCommentPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'comment': value['comment'],
+        'test_case': value['testCase'],
+        'project': value['project'],
+        'attachments': value['attachments'],
+        'mentions': value['mentions'],
+        'parent_id': value['parentId'],
+    };
+}