@testcollab/sdk 3.1.1

package/dist/esm/models/ExecutionComment.js

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { UserFromJSON, UserToJSON, } from './User';
+/**
+ * Check if a given object implements the ExecutionComment interface.
+ */
+export function instanceOfExecutionComment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('executedTestCase' in value) || value['executedTestCase'] === undefined)
+        return false;
+    if (!('comment' in value) || value['comment'] === undefined)
+        return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined)
+        return false;
+    return true;
+}
+export function ExecutionCommentFromJSON(json) {
+    return ExecutionCommentFromJSONTyped(json, false);
+}
+export function ExecutionCommentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'executedTestCase': json['executed_test_case'],
+        'mentions': json['mentions'] == null ? undefined : (json['mentions'].map(UserFromJSON)),
+        'comment': json['comment'],
+        'createdBy': json['created_by'],
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+    };
+}
+export function ExecutionCommentToJSON(json) {
+    return ExecutionCommentToJSONTyped(json, false);
+}
+export function ExecutionCommentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'project': value['project'],
+        'executed_test_case': value['executedTestCase'],
+        'mentions': value['mentions'] == null ? undefined : (value['mentions'].map(UserToJSON)),
+        'comment': value['comment'],
+        'created_by': value['createdBy'],
+        'created_at': value['createdAt'],
+    };
+}

package/dist/esm/models/ExecutionCommentPayload.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 ExecutionCommentPayload
+ */
+export interface ExecutionCommentPayload {
+    /**
+     *
+     * @type {string}
+     * @memberof ExecutionCommentPayload
+     */
+    comment: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ExecutionCommentPayload
+     */
+    executedTestCase: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ExecutionCommentPayload
+     */
+    project: number;
+    /**
+     * Array of user IDs
+     * @type {Array<string>}
+     * @memberof ExecutionCommentPayload
+     */
+    mentions?: Array<string>;
+}
+/**
+ * Check if a given object implements the ExecutionCommentPayload interface.
+ */
+export declare function instanceOfExecutionCommentPayload(value: object): value is ExecutionCommentPayload;
+export declare function ExecutionCommentPayloadFromJSON(json: any): ExecutionCommentPayload;
+export declare function ExecutionCommentPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecutionCommentPayload;
+export declare function ExecutionCommentPayloadToJSON(json: any): ExecutionCommentPayload;
+export declare function ExecutionCommentPayloadToJSONTyped(value?: ExecutionCommentPayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExecutionCommentPayload.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ExecutionCommentPayload interface.
+ */
+export function instanceOfExecutionCommentPayload(value) {
+    if (!('comment' in value) || value['comment'] === undefined)
+        return false;
+    if (!('executedTestCase' in value) || value['executedTestCase'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+export function ExecutionCommentPayloadFromJSON(json) {
+    return ExecutionCommentPayloadFromJSONTyped(json, false);
+}
+export function ExecutionCommentPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'comment': json['comment'],
+        'executedTestCase': json['executed_test_case'],
+        'project': json['project'],
+        'mentions': json['mentions'] == null ? undefined : json['mentions'],
+    };
+}
+export function ExecutionCommentPayloadToJSON(json) {
+    return ExecutionCommentPayloadToJSONTyped(json, false);
+}
+export function ExecutionCommentPayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'comment': value['comment'],
+        'executed_test_case': value['executedTestCase'],
+        'project': value['project'],
+        'mentions': value['mentions'],
+    };
+}

package/dist/esm/models/ExecutionTestCase.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { TestCase } from './TestCase';
+/**
+ *
+ * @export
+ * @interface ExecutionTestCase
+ */
+export interface ExecutionTestCase {
+    /**
+     *
+     * @type {number}
+     * @memberof ExecutionTestCase
+     */
+    id: number;
+    /**
+     *
+     * @type {TestCase}
+     * @memberof ExecutionTestCase
+     */
+    testCase: TestCase;
+    /**
+     * Executed test case status (0 = unexecuted; 1 = passed; 2 = failed; 3 = skipped; 4+ = user-defined statuses)
+     * @type {number}
+     * @memberof ExecutionTestCase
+     */
+    status: number;
+    /**
+     * Time taken (in seconds)
+     * @type {number}
+     * @memberof ExecutionTestCase
+     */
+    timeTaken: number;
+}
+/**
+ * Check if a given object implements the ExecutionTestCase interface.
+ */
+export declare function instanceOfExecutionTestCase(value: object): value is ExecutionTestCase;
+export declare function ExecutionTestCaseFromJSON(json: any): ExecutionTestCase;
+export declare function ExecutionTestCaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecutionTestCase;
+export declare function ExecutionTestCaseToJSON(json: any): ExecutionTestCase;
+export declare function ExecutionTestCaseToJSONTyped(value?: ExecutionTestCase | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExecutionTestCase.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * TC API
+ * TestCollab is a test management tool that helps development teams carry out testing effectively and avoid failures. # Introduction This is an API documentation for TestCollab 2.   # Authentication TestCollab supports two forms of authentication:   - An <b>API token</b> is required to make API calls. The token can be generated from user\'s profile; to obtain it login to your TestCollab account and go to [\'My Profile Settings\'](https://testcollab.io/my_profile) and switch to API Token tab. Click on \"Generate new API token\", Once the token is generated it can be sent as a query parameter for the API calls made - https://api.testcollab.io/projects?token=<generated-API-token>    - <b>Bearer authentication</b> (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. You can generate bearer auth token using [Login](#operation/login) API.     Send this token as the Authorization header while making requests to protected resources:     `Authorization: Bearer <token>`    For making API calls, we recommend using the <b>API token</b> generated from user profile page as it won\'t affect the on-going user session and will be available until it is revoked by the user who generated it.      # Error Handling Error responses   - `Not Found` - Error is sent when requested resource is not available.   - `Unauthorized - invalid token` - Error is sent when API token sent with the request is invalid or revoked. Error contains status code 401        - `Forbidden` - Error is sent when logged in user is not part of the company, project or his role does not allow to complete given action. Response consist of 403 status code and more information is given in error message.
+ *
+ * The version of the OpenAPI document: 2.3.1
+ * Contact: support@testcollab.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TestCaseFromJSON, TestCaseToJSON, } from './TestCase';
+/**
+ * Check if a given object implements the ExecutionTestCase interface.
+ */
+export function instanceOfExecutionTestCase(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('testCase' in value) || value['testCase'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('timeTaken' in value) || value['timeTaken'] === undefined)
+        return false;
+    return true;
+}
+export function ExecutionTestCaseFromJSON(json) {
+    return ExecutionTestCaseFromJSONTyped(json, false);
+}
+export function ExecutionTestCaseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'testCase': TestCaseFromJSON(json['test_case']),
+        'status': json['status'],
+        'timeTaken': json['time_taken'],
+    };
+}
+export function ExecutionTestCaseToJSON(json) {
+    return ExecutionTestCaseToJSONTyped(json, false);
+}
+export function ExecutionTestCaseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'test_case': TestCaseToJSON(value['testCase']),
+        'status': value['status'],
+        'time_taken': value['timeTaken'],
+    };
+}

package/dist/esm/models/ExecutionTestCaseStatusInner.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 ExecutionTestCaseStatusInner
+ */
+export interface ExecutionTestCaseStatusInner {
+    /**
+     *
+     * @type {string}
+     * @memberof ExecutionTestCaseStatusInner
+     */
+    status?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof ExecutionTestCaseStatusInner
+     */
+    count?: number;
+    /**
+     * Color hex
+     * @type {string}
+     * @memberof ExecutionTestCaseStatusInner
+     */
+    color?: string;
+}
+/**
+ * Check if a given object implements the ExecutionTestCaseStatusInner interface.
+ */
+export declare function instanceOfExecutionTestCaseStatusInner(value: object): value is ExecutionTestCaseStatusInner;
+export declare function ExecutionTestCaseStatusInnerFromJSON(json: any): ExecutionTestCaseStatusInner;
+export declare function ExecutionTestCaseStatusInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExecutionTestCaseStatusInner;
+export declare function ExecutionTestCaseStatusInnerToJSON(json: any): ExecutionTestCaseStatusInner;
+export declare function ExecutionTestCaseStatusInnerToJSONTyped(value?: ExecutionTestCaseStatusInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExecutionTestCaseStatusInner.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ExecutionTestCaseStatusInner interface.
+ */
+export function instanceOfExecutionTestCaseStatusInner(value) {
+    return true;
+}
+export function ExecutionTestCaseStatusInnerFromJSON(json) {
+    return ExecutionTestCaseStatusInnerFromJSONTyped(json, false);
+}
+export function ExecutionTestCaseStatusInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'] == null ? undefined : json['status'],
+        'count': json['count'] == null ? undefined : json['count'],
+        'color': json['color'] == null ? undefined : json['color'],
+    };
+}
+export function ExecutionTestCaseStatusInnerToJSON(json) {
+    return ExecutionTestCaseStatusInnerToJSONTyped(json, false);
+}
+export function ExecutionTestCaseStatusInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'count': value['count'],
+        'color': value['color'],
+    };
+}

package/dist/esm/models/ExportActionResult.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 ExportActionResult
+ */
+export interface ExportActionResult {
+    /**
+     * Stringified header
+     * @type {string}
+     * @memberof ExportActionResult
+     */
+    headerRow?: string;
+    /**
+     * Array of stringified test case data for export
+     * @type {Array<string>}
+     * @memberof ExportActionResult
+     */
+    testCases?: Array<string>;
+}
+/**
+ * Check if a given object implements the ExportActionResult interface.
+ */
+export declare function instanceOfExportActionResult(value: object): value is ExportActionResult;
+export declare function ExportActionResultFromJSON(json: any): ExportActionResult;
+export declare function ExportActionResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportActionResult;
+export declare function ExportActionResultToJSON(json: any): ExportActionResult;
+export declare function ExportActionResultToJSONTyped(value?: ExportActionResult | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ExportActionResult.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ExportActionResult interface.
+ */
+export function instanceOfExportActionResult(value) {
+    return true;
+}
+export function ExportActionResultFromJSON(json) {
+    return ExportActionResultFromJSONTyped(json, false);
+}
+export function ExportActionResultFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'headerRow': json['header_row'] == null ? undefined : json['header_row'],
+        'testCases': json['testCases'] == null ? undefined : json['testCases'],
+    };
+}
+export function ExportActionResultToJSON(json) {
+    return ExportActionResultToJSONTyped(json, false);
+}
+export function ExportActionResultToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'header_row': value['headerRow'],
+        'testCases': value['testCases'],
+    };
+}

package/dist/esm/models/ExportTestCasesPayload.d.ts

@@ -0,0 +1,108 @@
+/**
+ * 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 ExportTestCasesPayload
+ */
+export interface ExportTestCasesPayload {
+    /**
+     * Project ID
+     * @type {number}
+     * @memberof ExportTestCasesPayload
+     */
+    project: number;
+    /**
+     * Export data as CSV/EXCEL
+     * @type {string}
+     * @memberof ExportTestCasesPayload
+     */
+    exportAs: ExportTestCasesPayloadExportAsEnum;
+    /**
+     * Stringified filter object (Ag-grid filters)
+     * @type {string}
+     * @memberof ExportTestCasesPayload
+     */
+    filterModel?: string;
+    /**
+     * Stringified array of sort model objects (Ag-grid sort models)
+     * @type {string}
+     * @memberof ExportTestCasesPayload
+     */
+    sortModel?: string;
+    /**
+     * Export selected or all test cases. If none is selected and filter is present then all filtered test cases will be considered.
+     * @type {string}
+     * @memberof ExportTestCasesPayload
+     */
+    criteria: ExportTestCasesPayloadCriteriaEnum;
+    /**
+     * Selected test case IDs - will be considered only if criteria is selected.
+     * @type {Array<number>}
+     * @memberof ExportTestCasesPayload
+     */
+    testCases?: Array<number>;
+    /**
+     * Fields provided here will be considered for export. If none then all default fields. <br /><br />You can specify the custom fields using the template "cf_<customFieldId>" so if you want data for custom field whose Id is 123, along with test case title, priority and suite then the fields parameter would be like - <br />{<br />&emsp; "title",<br />&emsp; "priority",<br />&emsp; "suite",<br />&emsp; "cf_123" <br />]
+     * @type {Array<string>}
+     * @memberof ExportTestCasesPayload
+     */
+    fields: Array<string>;
+    /**
+     * If test cases related to a particular test plan has to be exported.
+     * @type {number}
+     * @memberof ExportTestCasesPayload
+     */
+    testPlan?: number;
+    /**
+     * Will be considered only if test plan is provided. Selected test plan configurations IDs - If none then all.
+     * @type {Array<number>}
+     * @memberof ExportTestCasesPayload
+     */
+    configs?: Array<number>;
+    /**
+     * Will be considered only if test plan is provided. Selected run otherwise latest run.
+     * @type {number}
+     * @memberof ExportTestCasesPayload
+     */
+    run?: number;
+    /**
+     * Strip HTML tags from text fields
+     * @type {boolean}
+     * @memberof ExportTestCasesPayload
+     */
+    removeTags?: boolean;
+}
+/**
+ * @export
+ */
+export declare const ExportTestCasesPayloadExportAsEnum: {
+    readonly Csv: "csv";
+    readonly Excel: "excel";
+};
+export type ExportTestCasesPayloadExportAsEnum = typeof ExportTestCasesPayloadExportAsEnum[keyof typeof ExportTestCasesPayloadExportAsEnum];
+/**
+ * @export
+ */
+export declare const ExportTestCasesPayloadCriteriaEnum: {
+    readonly All: "all";
+    readonly Selected: "selected";
+};
+export type ExportTestCasesPayloadCriteriaEnum = typeof ExportTestCasesPayloadCriteriaEnum[keyof typeof ExportTestCasesPayloadCriteriaEnum];
+/**
+ * Check if a given object implements the ExportTestCasesPayload interface.
+ */
+export declare function instanceOfExportTestCasesPayload(value: object): value is ExportTestCasesPayload;
+export declare function ExportTestCasesPayloadFromJSON(json: any): ExportTestCasesPayload;
+export declare function ExportTestCasesPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportTestCasesPayload;
+export declare function ExportTestCasesPayloadToJSON(json: any): ExportTestCasesPayload;
+export declare function ExportTestCasesPayloadToJSONTyped(value?: ExportTestCasesPayload | null, ignoreDiscriminator?: boolean): any;