@testcollab/sdk 3.8.0 → 3.9.0

package/dist/models/QacConversationMessage.js

@@ -0,0 +1,113 @@
+"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.QacConversationMessageStatusEnum = exports.QacConversationMessageRoleEnum = exports.QacConversationMessageAuthorTypeEnum = void 0;
+exports.instanceOfQacConversationMessage = instanceOfQacConversationMessage;
+exports.QacConversationMessageFromJSON = QacConversationMessageFromJSON;
+exports.QacConversationMessageFromJSONTyped = QacConversationMessageFromJSONTyped;
+exports.QacConversationMessageToJSON = QacConversationMessageToJSON;
+exports.QacConversationMessageToJSONTyped = QacConversationMessageToJSONTyped;
+const UserMinified_1 = require("./UserMinified");
+const QacConversationTokenUsage_1 = require("./QacConversationTokenUsage");
+const Upload_1 = require("./Upload");
+/**
+ * @export
+ */
+exports.QacConversationMessageAuthorTypeEnum = {
+    User: 'user',
+    Copilot: 'copilot',
+    System: 'system'
+};
+/**
+ * @export
+ */
+exports.QacConversationMessageRoleEnum = {
+    User: 'user',
+    Assistant: 'assistant',
+    System: 'system'
+};
+/**
+ * @export
+ */
+exports.QacConversationMessageStatusEnum = {
+    Queued: 'queued',
+    InProgress: 'in_progress',
+    Completed: 'completed',
+    Error: 'error'
+};
+/**
+ * Check if a given object implements the QacConversationMessage interface.
+ */
+function instanceOfQacConversationMessage(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('thread' in value) || value['thread'] === undefined)
+        return false;
+    if (!('authorType' in value) || value['authorType'] === undefined)
+        return false;
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function QacConversationMessageFromJSON(json) {
+    return QacConversationMessageFromJSONTyped(json, false);
+}
+function QacConversationMessageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'thread': json['thread'],
+        'authorType': json['author_type'],
+        'author': json['author'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['author']),
+        'role': json['role'] == null ? undefined : json['role'],
+        'content': json['content'],
+        'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
+        'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(Upload_1.UploadFromJSON)),
+        'status': json['status'],
+        'errorReason': json['error_reason'] == null ? undefined : json['error_reason'],
+        'tokenUsage': json['token_usage'] == null ? undefined : (0, QacConversationTokenUsage_1.QacConversationTokenUsageFromJSON)(json['token_usage']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+function QacConversationMessageToJSON(json) {
+    return QacConversationMessageToJSONTyped(json, false);
+}
+function QacConversationMessageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'thread': value['thread'],
+        'author_type': value['authorType'],
+        'author': (0, UserMinified_1.UserMinifiedToJSON)(value['author']),
+        'role': value['role'],
+        'content': value['content'],
+        'content_html': value['contentHtml'],
+        'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(Upload_1.UploadToJSON)),
+        'status': value['status'],
+        'error_reason': value['errorReason'],
+        'token_usage': (0, QacConversationTokenUsage_1.QacConversationTokenUsageToJSON)(value['tokenUsage']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}

package/dist/models/QacConversationMessagePayload.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 QacConversationMessagePayload
+ */
+export interface QacConversationMessagePayload {
+    /**
+     *
+     * @type {number}
+     * @memberof QacConversationMessagePayload
+     */
+    thread?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationMessagePayload
+     */
+    authorType?: QacConversationMessagePayloadAuthorTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationMessagePayload
+     */
+    role?: QacConversationMessagePayloadRoleEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationMessagePayload
+     */
+    content: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationMessagePayload
+     */
+    contentHtml?: string;
+    /**
+     * Upload IDs returned by upload path
+     * @type {Array<number>}
+     * @memberof QacConversationMessagePayload
+     */
+    attachments?: Array<number>;
+    /**
+     * Optional metadata such as browser, environment or locale
+     * @type {{ [key: string]: any; }}
+     * @memberof QacConversationMessagePayload
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const QacConversationMessagePayloadAuthorTypeEnum: {
+    readonly User: "user";
+    readonly Copilot: "copilot";
+    readonly System: "system";
+};
+export type QacConversationMessagePayloadAuthorTypeEnum = typeof QacConversationMessagePayloadAuthorTypeEnum[keyof typeof QacConversationMessagePayloadAuthorTypeEnum];
+/**
+ * @export
+ */
+export declare const QacConversationMessagePayloadRoleEnum: {
+    readonly User: "user";
+    readonly Assistant: "assistant";
+    readonly System: "system";
+};
+export type QacConversationMessagePayloadRoleEnum = typeof QacConversationMessagePayloadRoleEnum[keyof typeof QacConversationMessagePayloadRoleEnum];
+/**
+ * Check if a given object implements the QacConversationMessagePayload interface.
+ */
+export declare function instanceOfQacConversationMessagePayload(value: object): value is QacConversationMessagePayload;
+export declare function QacConversationMessagePayloadFromJSON(json: any): QacConversationMessagePayload;
+export declare function QacConversationMessagePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationMessagePayload;
+export declare function QacConversationMessagePayloadToJSON(json: any): QacConversationMessagePayload;
+export declare function QacConversationMessagePayloadToJSONTyped(value?: QacConversationMessagePayload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QacConversationMessagePayload.js

@@ -0,0 +1,79 @@
+"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.QacConversationMessagePayloadRoleEnum = exports.QacConversationMessagePayloadAuthorTypeEnum = void 0;
+exports.instanceOfQacConversationMessagePayload = instanceOfQacConversationMessagePayload;
+exports.QacConversationMessagePayloadFromJSON = QacConversationMessagePayloadFromJSON;
+exports.QacConversationMessagePayloadFromJSONTyped = QacConversationMessagePayloadFromJSONTyped;
+exports.QacConversationMessagePayloadToJSON = QacConversationMessagePayloadToJSON;
+exports.QacConversationMessagePayloadToJSONTyped = QacConversationMessagePayloadToJSONTyped;
+/**
+ * @export
+ */
+exports.QacConversationMessagePayloadAuthorTypeEnum = {
+    User: 'user',
+    Copilot: 'copilot',
+    System: 'system'
+};
+/**
+ * @export
+ */
+exports.QacConversationMessagePayloadRoleEnum = {
+    User: 'user',
+    Assistant: 'assistant',
+    System: 'system'
+};
+/**
+ * Check if a given object implements the QacConversationMessagePayload interface.
+ */
+function instanceOfQacConversationMessagePayload(value) {
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    return true;
+}
+function QacConversationMessagePayloadFromJSON(json) {
+    return QacConversationMessagePayloadFromJSONTyped(json, false);
+}
+function QacConversationMessagePayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'thread': json['thread'] == null ? undefined : json['thread'],
+        'authorType': json['author_type'] == null ? undefined : json['author_type'],
+        'role': json['role'] == null ? undefined : json['role'],
+        'content': json['content'],
+        'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+function QacConversationMessagePayloadToJSON(json) {
+    return QacConversationMessagePayloadToJSONTyped(json, false);
+}
+function QacConversationMessagePayloadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'thread': value['thread'],
+        'author_type': value['authorType'],
+        'role': value['role'],
+        'content': value['content'],
+        'content_html': value['contentHtml'],
+        'attachments': value['attachments'],
+        'metadata': value['metadata'],
+    };
+}

package/dist/models/QacConversationThread.d.ts

@@ -0,0 +1,130 @@
+/**
+ * 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 { UserMinified } from './UserMinified';
+/**
+ *
+ * @export
+ * @interface QacConversationThread
+ */
+export interface QacConversationThread {
+    /**
+     *
+     * @type {number}
+     * @memberof QacConversationThread
+     */
+    id: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QacConversationThread
+     */
+    project?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof QacConversationThread
+     */
+    company: number;
+    /**
+     *
+     * @type {UserMinified}
+     * @memberof QacConversationThread
+     */
+    createdBy?: UserMinified;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    status: QacConversationThreadStatusEnum;
+    /**
+     * Origin URL where the conversation was started
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    sourceUrl: string;
+    /**
+     * Flexible JSON for linking related entities (e.g., test_case, run, requirement, suite)
+     * @type {{ [key: string]: any; }}
+     * @memberof QacConversationThread
+     */
+    contextRefs?: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof QacConversationThread
+     */
+    messagesCount: number;
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    lastMessageAt?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    lastMessagePreview?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof QacConversationThread
+     */
+    pinned?: boolean;
+    /**
+     * Optional metadata such as browser, environment or locale
+     * @type {{ [key: string]: any; }}
+     * @memberof QacConversationThread
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    createdAt: string;
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof QacConversationThread
+     */
+    updatedAt?: string;
+}
+/**
+ * @export
+ */
+export declare const QacConversationThreadStatusEnum: {
+    readonly Open: "open";
+    readonly Closed: "closed";
+    readonly Archived: "archived";
+};
+export type QacConversationThreadStatusEnum = typeof QacConversationThreadStatusEnum[keyof typeof QacConversationThreadStatusEnum];
+/**
+ * Check if a given object implements the QacConversationThread interface.
+ */
+export declare function instanceOfQacConversationThread(value: object): value is QacConversationThread;
+export declare function QacConversationThreadFromJSON(json: any): QacConversationThread;
+export declare function QacConversationThreadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationThread;
+export declare function QacConversationThreadToJSON(json: any): QacConversationThread;
+export declare function QacConversationThreadToJSONTyped(value?: QacConversationThread | null, ignoreDiscriminator?: boolean): any;

package/dist/models/QacConversationThread.js

@@ -0,0 +1,98 @@
+"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.QacConversationThreadStatusEnum = void 0;
+exports.instanceOfQacConversationThread = instanceOfQacConversationThread;
+exports.QacConversationThreadFromJSON = QacConversationThreadFromJSON;
+exports.QacConversationThreadFromJSONTyped = QacConversationThreadFromJSONTyped;
+exports.QacConversationThreadToJSON = QacConversationThreadToJSON;
+exports.QacConversationThreadToJSONTyped = QacConversationThreadToJSONTyped;
+const UserMinified_1 = require("./UserMinified");
+/**
+ * @export
+ */
+exports.QacConversationThreadStatusEnum = {
+    Open: 'open',
+    Closed: 'closed',
+    Archived: 'archived'
+};
+/**
+ * Check if a given object implements the QacConversationThread interface.
+ */
+function instanceOfQacConversationThread(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('company' in value) || value['company'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('sourceUrl' in value) || value['sourceUrl'] === undefined)
+        return false;
+    if (!('messagesCount' in value) || value['messagesCount'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+function QacConversationThreadFromJSON(json) {
+    return QacConversationThreadFromJSONTyped(json, false);
+}
+function QacConversationThreadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'project': json['project'] == null ? undefined : json['project'],
+        'company': json['company'],
+        'createdBy': json['created_by'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['created_by']),
+        'title': json['title'] == null ? undefined : json['title'],
+        'status': json['status'],
+        'sourceUrl': json['source_url'],
+        'contextRefs': json['context_refs'] == null ? undefined : json['context_refs'],
+        'messagesCount': json['messages_count'],
+        'lastMessageAt': json['last_message_at'] == null ? undefined : json['last_message_at'],
+        'lastMessagePreview': json['last_message_preview'] == null ? undefined : json['last_message_preview'],
+        'pinned': json['pinned'] == null ? undefined : json['pinned'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+function QacConversationThreadToJSON(json) {
+    return QacConversationThreadToJSONTyped(json, false);
+}
+function QacConversationThreadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'project': value['project'],
+        'company': value['company'],
+        'created_by': (0, UserMinified_1.UserMinifiedToJSON)(value['createdBy']),
+        'title': value['title'],
+        'status': value['status'],
+        'source_url': value['sourceUrl'],
+        'context_refs': value['contextRefs'],
+        'messages_count': value['messagesCount'],
+        'last_message_at': value['lastMessageAt'],
+        'last_message_preview': value['lastMessagePreview'],
+        'pinned': value['pinned'],
+        'metadata': value['metadata'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}

package/dist/models/QacConversationThreadPayload.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 QacConversationThreadPayload
+ */
+export interface QacConversationThreadPayload {
+    /**
+     * Project ID for the thread
+     * @type {number}
+     * @memberof QacConversationThreadPayload
+     */
+    project?: number;
+    /**
+     * Company ID for the thread
+     * @type {number}
+     * @memberof QacConversationThreadPayload
+     */
+    company: number;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationThreadPayload
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof QacConversationThreadPayload
+     */
+    status?: QacConversationThreadPayloadStatusEnum;
+    /**
+     * Origin URL where the conversation was started
+     * @type {string}
+     * @memberof QacConversationThreadPayload
+     */
+    sourceUrl: string;
+    /**
+     * Flexible JSON for linking related entities (e.g., test_case, run, requirement, suite)
+     * @type {{ [key: string]: any; }}
+     * @memberof QacConversationThreadPayload
+     */
+    contextRefs?: {
+        [key: string]: any;
+    };
+    /**
+     * Optional metadata such as browser, environment or locale
+     * @type {{ [key: string]: any; }}
+     * @memberof QacConversationThreadPayload
+     */
+    metadata?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const QacConversationThreadPayloadStatusEnum: {
+    readonly Open: "open";
+    readonly Closed: "closed";
+    readonly Archived: "archived";
+};
+export type QacConversationThreadPayloadStatusEnum = typeof QacConversationThreadPayloadStatusEnum[keyof typeof QacConversationThreadPayloadStatusEnum];
+/**
+ * Check if a given object implements the QacConversationThreadPayload interface.
+ */
+export declare function instanceOfQacConversationThreadPayload(value: object): value is QacConversationThreadPayload;
+export declare function QacConversationThreadPayloadFromJSON(json: any): QacConversationThreadPayload;
+export declare function QacConversationThreadPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationThreadPayload;
+export declare function QacConversationThreadPayloadToJSON(json: any): QacConversationThreadPayload;
+export declare function QacConversationThreadPayloadToJSONTyped(value?: QacConversationThreadPayload | null, ignoreDiscriminator?: boolean): any;