@testcollab/sdk 3.1.1

package/dist/esm/models/TestCaseLastRunStatus.js

@@ -0,0 +1,55 @@
+/* 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 TestCaseLastRunStatus interface.
+ */
+export function instanceOfTestCaseLastRunStatus(value) {
+    if (!('skipped' in value) || value['skipped'] === undefined)
+        return false;
+    if (!('failed' in value) || value['failed'] === undefined)
+        return false;
+    if (!('passed' in value) || value['passed'] === undefined)
+        return false;
+    if (!('unexecuted' in value) || value['unexecuted'] === undefined)
+        return false;
+    return true;
+}
+export function TestCaseLastRunStatusFromJSON(json) {
+    return TestCaseLastRunStatusFromJSONTyped(json, false);
+}
+export function TestCaseLastRunStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'skipped': json['Skipped'],
+        'failed': json['Failed'],
+        'passed': json['Passed'],
+        'unexecuted': json['Unexecuted'],
+    };
+}
+export function TestCaseLastRunStatusToJSON(json) {
+    return TestCaseLastRunStatusToJSONTyped(json, false);
+}
+export function TestCaseLastRunStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'Skipped': value['skipped'],
+        'Failed': value['failed'],
+        'Passed': value['passed'],
+        'Unexecuted': value['unexecuted'],
+    };
+}

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

@@ -0,0 +1,170 @@
+/**
+ * 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 { Step } from './Step';
+import type { CustomFieldCollectionOutput } from './CustomFieldCollectionOutput';
+import type { StepParsed } from './StepParsed';
+/**
+ *
+ * @export
+ * @interface TestCaseMinified
+ */
+export interface TestCaseMinified {
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    title: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    suite?: number;
+    /**
+     * Test case description (generated by rich text editor)
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    description: string;
+    /**
+     *
+     * @type {Array<Step>}
+     * @memberof TestCaseMinified
+     */
+    steps?: Array<Step>;
+    /**
+     *
+     * @type {Array<StepParsed>}
+     * @memberof TestCaseMinified
+     */
+    stepsParsed?: Array<StepParsed>;
+    /**
+     * Priority, 0 - Low, 1- Normal, 2 - High
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    priority: TestCaseMinifiedPriorityEnum;
+    /**
+     * Array of custom fields
+     * @type {Array<CustomFieldCollectionOutput>}
+     * @memberof TestCaseMinified
+     */
+    customFields?: Array<CustomFieldCollectionOutput>;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    createdAt?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    updatedAt?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    createdBy?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    lastRunStatus?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    runCount?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    avgExecutionTime?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCaseMinified
+     */
+    lastRunOn?: string;
+    /**
+     * Test failure percentage
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    failureRate?: number;
+    /**
+     * Will be true only for links
+     * @type {boolean}
+     * @memberof TestCaseMinified
+     */
+    isReference?: boolean;
+    /**
+     * Only for links - source entity ID
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    sourceId?: number;
+    /**
+     * Only for links - source Project ID
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    sourceProject?: number;
+    /**
+     * 1 if test case is under review else 0  (applicable when test case review feature is enabled)
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    underReview?: number;
+    /**
+     * Can be considered for execution by copilot (applicable when test case automation feature is enabled)
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    isAutomated?: number;
+    /**
+     * Can be considered for execution by copilot (applicable when test case automation feature is enabled)
+     * @type {number}
+     * @memberof TestCaseMinified
+     */
+    qacTimeout?: number;
+}
+/**
+ * @export
+ */
+export declare const TestCaseMinifiedPriorityEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type TestCaseMinifiedPriorityEnum = typeof TestCaseMinifiedPriorityEnum[keyof typeof TestCaseMinifiedPriorityEnum];
+/**
+ * Check if a given object implements the TestCaseMinified interface.
+ */
+export declare function instanceOfTestCaseMinified(value: object): value is TestCaseMinified;
+export declare function TestCaseMinifiedFromJSON(json: any): TestCaseMinified;
+export declare function TestCaseMinifiedFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCaseMinified;
+export declare function TestCaseMinifiedToJSON(json: any): TestCaseMinified;
+export declare function TestCaseMinifiedToJSONTyped(value?: TestCaseMinified | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TestCaseMinified.js

@@ -0,0 +1,102 @@
+/* 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 { StepFromJSON, StepToJSON, } from './Step';
+import { CustomFieldCollectionOutputFromJSON, CustomFieldCollectionOutputToJSON, } from './CustomFieldCollectionOutput';
+import { StepParsedFromJSON, StepParsedToJSON, } from './StepParsed';
+/**
+ * @export
+ */
+export const TestCaseMinifiedPriorityEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the TestCaseMinified interface.
+ */
+export function instanceOfTestCaseMinified(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;
+}
+export function TestCaseMinifiedFromJSON(json) {
+    return TestCaseMinifiedFromJSONTyped(json, false);
+}
+export function TestCaseMinifiedFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'suite': json['suite'] == null ? undefined : json['suite'],
+        'description': json['description'],
+        'steps': json['steps'] == null ? undefined : (json['steps'].map(StepFromJSON)),
+        'stepsParsed': json['steps_parsed'] == null ? undefined : (json['steps_parsed'].map(StepParsedFromJSON)),
+        'priority': json['priority'],
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldCollectionOutputFromJSON)),
+        'createdAt': json['created_at'] == null ? undefined : json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+        'createdBy': json['created_by'] == null ? undefined : 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'],
+    };
+}
+export function TestCaseMinifiedToJSON(json) {
+    return TestCaseMinifiedToJSONTyped(json, false);
+}
+export function TestCaseMinifiedToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'suite': value['suite'],
+        'description': value['description'],
+        'steps': value['steps'] == null ? undefined : (value['steps'].map(StepToJSON)),
+        'steps_parsed': value['stepsParsed'] == null ? undefined : (value['stepsParsed'].map(StepParsedToJSON)),
+        'priority': value['priority'],
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldCollectionOutputToJSON)),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'created_by': 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/esm/models/TestCasePassedBySuite.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.
+ */
+/**
+ * Object with suite name, number of test cases passed and color code value for heatmap
+ * @export
+ * @interface TestCasePassedBySuite
+ */
+export interface TestCasePassedBySuite {
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePassedBySuite
+     */
+    name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCasePassedBySuite
+     */
+    value: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCasePassedBySuite
+     */
+    colorValue: number;
+}
+/**
+ * Check if a given object implements the TestCasePassedBySuite interface.
+ */
+export declare function instanceOfTestCasePassedBySuite(value: object): value is TestCasePassedBySuite;
+export declare function TestCasePassedBySuiteFromJSON(json: any): TestCasePassedBySuite;
+export declare function TestCasePassedBySuiteFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCasePassedBySuite;
+export declare function TestCasePassedBySuiteToJSON(json: any): TestCasePassedBySuite;
+export declare function TestCasePassedBySuiteToJSONTyped(value?: TestCasePassedBySuite | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TestCasePassedBySuite.js

@@ -0,0 +1,51 @@
+/* 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 TestCasePassedBySuite interface.
+ */
+export function instanceOfTestCasePassedBySuite(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    if (!('colorValue' in value) || value['colorValue'] === undefined)
+        return false;
+    return true;
+}
+export function TestCasePassedBySuiteFromJSON(json) {
+    return TestCasePassedBySuiteFromJSONTyped(json, false);
+}
+export function TestCasePassedBySuiteFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'value': json['value'],
+        'colorValue': json['colorValue'],
+    };
+}
+export function TestCasePassedBySuiteToJSON(json) {
+    return TestCasePassedBySuiteToJSONTyped(json, false);
+}
+export function TestCasePassedBySuiteToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'value': value['value'],
+        'colorValue': value['colorValue'],
+    };
+}

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

@@ -0,0 +1,145 @@
+/**
+ * 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';
+import type { TestCaseStepsPayload } from './TestCaseStepsPayload';
+/**
+ *
+ * @export
+ * @interface TestCasePayload
+ */
+export interface TestCasePayload {
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    title: string;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCasePayload
+     */
+    suite?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof TestCasePayload
+     */
+    project: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    issueKey?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    im?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    issueId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    instanceId?: string;
+    /**
+     * HTML-formatted test case description (generated by rich text editor)
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    description?: string;
+    /**
+     *
+     * @type {Array<TestCaseStepsPayload>}
+     * @memberof TestCasePayload
+     */
+    steps?: Array<TestCaseStepsPayload>;
+    /**
+     * Priority, 0 - Low, 1- Normal, 2 - High
+     * @type {number}
+     * @memberof TestCasePayload
+     */
+    priority?: TestCasePayloadPriorityEnum;
+    /**
+     * Tag IDs array
+     * @type {Array<number>}
+     * @memberof TestCasePayload
+     */
+    tags?: Array<number>;
+    /**
+     * Array of file ids
+     * @type {Array<string>}
+     * @memberof TestCasePayload
+     */
+    attachments?: Array<string>;
+    /**
+     * Array of custom fields
+     * @type {Array<CustomFieldInputPayload>}
+     * @memberof TestCasePayload
+     */
+    customFields?: Array<CustomFieldInputPayload>;
+    /**
+     * Requirement IDs array
+     * @type {Array<number>}
+     * @memberof TestCasePayload
+     */
+    requirements?: Array<number>;
+    /**
+     * Comment by poster/editor (applicable when test case review feature is enabled)
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    posterComment?: string;
+    /**
+     * Reviewer Id (applicable when test case review feature is enabled)
+     * @type {number}
+     * @memberof TestCasePayload
+     */
+    reviewer?: number;
+    /**
+     * Review Status (applicable when test case review feature is enabled)
+     * @type {number}
+     * @memberof TestCasePayload
+     */
+    reviewStatus?: number;
+    /**
+     * JSON string containing auto info - only available when test automation is enabled
+     * @type {string}
+     * @memberof TestCasePayload
+     */
+    autoInfo?: string;
+}
+/**
+ * @export
+ */
+export declare const TestCasePayloadPriorityEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type TestCasePayloadPriorityEnum = typeof TestCasePayloadPriorityEnum[keyof typeof TestCasePayloadPriorityEnum];
+/**
+ * Check if a given object implements the TestCasePayload interface.
+ */
+export declare function instanceOfTestCasePayload(value: object): value is TestCasePayload;
+export declare function TestCasePayloadFromJSON(json: any): TestCasePayload;
+export declare function TestCasePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCasePayload;
+export declare function TestCasePayloadToJSON(json: any): TestCasePayload;
+export declare function TestCasePayloadToJSONTyped(value?: TestCasePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/TestCasePayload.js

@@ -0,0 +1,89 @@
+/* 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 { CustomFieldInputPayloadFromJSON, CustomFieldInputPayloadToJSON, } from './CustomFieldInputPayload';
+import { TestCaseStepsPayloadFromJSON, TestCaseStepsPayloadToJSON, } from './TestCaseStepsPayload';
+/**
+ * @export
+ */
+export const TestCasePayloadPriorityEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the TestCasePayload interface.
+ */
+export function instanceOfTestCasePayload(value) {
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('project' in value) || value['project'] === undefined)
+        return false;
+    return true;
+}
+export function TestCasePayloadFromJSON(json) {
+    return TestCasePayloadFromJSONTyped(json, false);
+}
+export function TestCasePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'title': json['title'],
+        'suite': json['suite'] == null ? undefined : json['suite'],
+        'project': json['project'],
+        'issueKey': json['issue_key'] == null ? undefined : json['issue_key'],
+        'im': json['im'] == null ? undefined : json['im'],
+        'issueId': json['issue_id'] == null ? undefined : json['issue_id'],
+        'instanceId': json['instance_id'] == null ? undefined : json['instance_id'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'steps': json['steps'] == null ? undefined : (json['steps'].map(TestCaseStepsPayloadFromJSON)),
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'customFields': json['custom_fields'] == null ? undefined : (json['custom_fields'].map(CustomFieldInputPayloadFromJSON)),
+        'requirements': json['requirements'] == null ? undefined : json['requirements'],
+        'posterComment': json['poster_comment'] == null ? undefined : json['poster_comment'],
+        'reviewer': json['reviewer'] == null ? undefined : json['reviewer'],
+        'reviewStatus': json['review_status'] == null ? undefined : json['review_status'],
+        'autoInfo': json['auto_info'] == null ? undefined : json['auto_info'],
+    };
+}
+export function TestCasePayloadToJSON(json) {
+    return TestCasePayloadToJSONTyped(json, false);
+}
+export function TestCasePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'title': value['title'],
+        'suite': value['suite'],
+        'project': value['project'],
+        'issue_key': value['issueKey'],
+        'im': value['im'],
+        'issue_id': value['issueId'],
+        'instance_id': value['instanceId'],
+        'description': value['description'],
+        'steps': value['steps'] == null ? undefined : (value['steps'].map(TestCaseStepsPayloadToJSON)),
+        'priority': value['priority'],
+        'tags': value['tags'],
+        'attachments': value['attachments'],
+        'custom_fields': value['customFields'] == null ? undefined : (value['customFields'].map(CustomFieldInputPayloadToJSON)),
+        'requirements': value['requirements'],
+        'poster_comment': value['posterComment'],
+        'reviewer': value['reviewer'],
+        'review_status': value['reviewStatus'],
+        'auto_info': value['autoInfo'],
+    };
+}