@testcollab/sdk 3.8.0 → 3.10.0

package/docs/QacConversationMessage.md

@@ -0,0 +1,58 @@
+
+# QacConversationMessage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`thread` | number
+`authorType` | string
+`author` | [UserMinified](UserMinified.md)
+`role` | string
+`content` | string
+`contentHtml` | string
+`attachments` | [Array<Upload>](Upload.md)
+`status` | string
+`errorReason` | string
+`tokenUsage` | [QacConversationTokenUsage](QacConversationTokenUsage.md)
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { QacConversationMessage } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 120,
+  "thread": 45,
+  "authorType": user,
+  "author": null,
+  "role": assistant,
+  "content": Here are the steps to reproduce the issue.,
+  "contentHtml": <p>Here are the steps to reproduce the issue.</p>,
+  "attachments": null,
+  "status": completed,
+  "errorReason": LLM request failed,
+  "tokenUsage": null,
+  "createdAt": 2019-04-30T17:11:24.000Z,
+  "updatedAt": 2019-04-30T17:11:24.000Z,
+} satisfies QacConversationMessage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationMessage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QacConversationMessagePayload.md

@@ -0,0 +1,46 @@
+
+# QacConversationMessagePayload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`thread` | number
+`authorType` | string
+`role` | string
+`content` | string
+`contentHtml` | string
+`attachments` | Array<number>
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { QacConversationMessagePayload } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "thread": 45,
+  "authorType": user,
+  "role": assistant,
+  "content": Draft a regression test outline for checkout.,
+  "contentHtml": <p>Draft a regression test outline for checkout.</p>,
+  "attachments": null,
+  "metadata": null,
+} satisfies QacConversationMessagePayload
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationMessagePayload
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QacConversationThread.md

@@ -0,0 +1,62 @@
+
+# QacConversationThread
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`project` | number
+`company` | number
+`createdBy` | [UserMinified](UserMinified.md)
+`title` | string
+`status` | string
+`sourceUrl` | string
+`contextRefs` | { [key: string]: any; }
+`messagesCount` | number
+`lastMessageAt` | string
+`lastMessagePreview` | string
+`pinned` | boolean
+`metadata` | { [key: string]: any; }
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { QacConversationThread } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 45,
+  "project": 12,
+  "company": 3,
+  "createdBy": null,
+  "title": Checkout regression draft,
+  "status": open,
+  "sourceUrl": https://app.testcollab.io/project/12/test_cases/101,
+  "contextRefs": null,
+  "messagesCount": 14,
+  "lastMessageAt": 2019-04-30T17:11:24.000Z,
+  "lastMessagePreview": Drafted 5 test cases for checkout happy path.,
+  "pinned": false,
+  "metadata": null,
+  "createdAt": 2019-04-30T17:11:24.000Z,
+  "updatedAt": 2019-04-30T17:11:24.000Z,
+} satisfies QacConversationThread
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationThread
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QacConversationThreadPayload.md

@@ -0,0 +1,46 @@
+
+# QacConversationThreadPayload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`project` | number
+`company` | number
+`title` | string
+`status` | string
+`sourceUrl` | string
+`contextRefs` | { [key: string]: any; }
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { QacConversationThreadPayload } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "project": 12,
+  "company": 3,
+  "title": Checkout regression draft,
+  "status": open,
+  "sourceUrl": https://app.testcollab.io/project/12/test_cases/101,
+  "contextRefs": null,
+  "metadata": null,
+} satisfies QacConversationThreadPayload
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationThreadPayload
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QacConversationThreadWithMessages.md

@@ -0,0 +1,36 @@
+
+# QacConversationThreadWithMessages
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`thread` | [QacConversationThread](QacConversationThread.md)
+`messages` | [Array<QacConversationMessage>](QacConversationMessage.md)
+
+## Example
+
+```typescript
+import type { QacConversationThreadWithMessages } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "thread": null,
+  "messages": null,
+} satisfies QacConversationThreadWithMessages
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationThreadWithMessages
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/QacConversationTokenUsage.md

@@ -0,0 +1,38 @@
+
+# QacConversationTokenUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`promptTokens` | number
+`completionTokens` | number
+`totalTokens` | number
+
+## Example
+
+```typescript
+import type { QacConversationTokenUsage } from '@testcollab/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "promptTokens": 512,
+  "completionTokens": 1024,
+  "totalTokens": 1536,
+} satisfies QacConversationTokenUsage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as QacConversationTokenUsage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SuiteTree.md

@@ -8,7 +8,6 @@ Name | Type
 ------------ | -------------
 `id` | number
 `title` | string
-`description` | string
 `suitecount` | number
 `createdBy` | number
 `testcasecount` | number
@@ -28,7 +27,6 @@ import type { SuiteTree } from '@testcollab/sdk'
 const example = {
   "id": 1,
   "title": Suite 1,
-  "description": Used for abc, def...,
   "suitecount": 23,
   "createdBy": 23,
   "testcasecount": 23,

package/docs/TrainingArtifactPayload.md

@@ -15,10 +15,10 @@ Name | Type
 `subStepTxt` | string
 `imgFull` | string
 `imgThumb` | string
-`timestamp` | Date
+`timestamp` | string
 `browserLocation` | string
 `otherInfoJson` | { [key: string]: any; }
-`created` | Date
+`created` | string
 
 ## Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testcollab/sdk",
-  "version": "3.8.0",
+  "version": "3.10.0",
   "description": "TestCollab SDK for public API",
   "author": "Test Collab Software LLC.",
   "repository": {

package/src/models/Project.ts

@@ -39,6 +39,12 @@ export interface Project {
      * @memberof Project
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Project
+     */
+    description?: string;
     /**
      * 
      * @type {boolean}
@@ -101,6 +107,7 @@ export function ProjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'],
         'team': json['team'] == null ? undefined : ((json['team'] as Array<any>).map(ProjectUserMinifiedFromJSON)),
         'activity': json['activity'] == null ? undefined : json['activity'],
@@ -123,6 +130,7 @@ export function ProjectToJSONTyped(value?: Project | null, ignoreDiscriminator:
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'team': value['team'] == null ? undefined : ((value['team'] as Array<any>).map(ProjectUserMinifiedToJSON)),
         'activity': value['activity'],

package/src/models/ProjectCreatePayload.ts

@@ -31,6 +31,12 @@ export interface ProjectCreatePayload {
      * @memberof ProjectCreatePayload
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectCreatePayload
+     */
+    description?: string;
     /**
      * Project ID to import users from (only allowed at the time of project create)
      * @type {number}
@@ -79,6 +85,7 @@ export function ProjectCreatePayloadFromJSONTyped(json: any, ignoreDiscriminator
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'importUsers': json['importUsers'] == null ? undefined : json['importUsers'],
         'issueManagerProfile': json['issueManagerProfile'] == null ? undefined : json['issueManagerProfile'],
         'importIssueManagerSettings': json['importIssueManagerSettings'] == null ? undefined : json['importIssueManagerSettings'],
@@ -99,6 +106,7 @@ export function ProjectCreatePayloadToJSONTyped(value?: ProjectCreatePayload | n
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'importUsers': value['importUsers'],
         'issueManagerProfile': value['issueManagerProfile'],
         'importIssueManagerSettings': value['importIssueManagerSettings'],

package/src/models/ProjectPayload.ts

@@ -31,6 +31,12 @@ export interface ProjectPayload {
      * @memberof ProjectPayload
      */
     name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProjectPayload
+     */
+    description?: string;
     /**
      * 
      * @type {boolean}
@@ -66,6 +72,7 @@ export function ProjectPayloadFromJSONTyped(json: any, ignoreDiscriminator: bool
         
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
         'archived': json['archived'] == null ? undefined : json['archived'],
         'company': json['company'],
     };
@@ -84,6 +91,7 @@ export function ProjectPayloadToJSONTyped(value?: ProjectPayload | null, ignoreD
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'archived': value['archived'],
         'company': value['company'],
     };

package/src/models/QacConversationFeedback.ts

@@ -0,0 +1,155 @@
+/* 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 { mapValues } from '../runtime';
+import type { UserMinified } from './UserMinified';
+import {
+    UserMinifiedFromJSON,
+    UserMinifiedFromJSONTyped,
+    UserMinifiedToJSON,
+    UserMinifiedToJSONTyped,
+} from './UserMinified';
+
+/**
+ * 
+ * @export
+ * @interface QacConversationFeedback
+ */
+export interface QacConversationFeedback {
+    /**
+     * 
+     * @type {number}
+     * @memberof QacConversationFeedback
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QacConversationFeedback
+     */
+    message: number;
+    /**
+     * 
+     * @type {UserMinified}
+     * @memberof QacConversationFeedback
+     */
+    givenBy?: UserMinified;
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedback
+     */
+    rating: QacConversationFeedbackRatingEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedback
+     */
+    reason?: QacConversationFeedbackReasonEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedback
+     */
+    comment?: string;
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof QacConversationFeedback
+     */
+    createdAt: string;
+    /**
+     * Time when the activity was performed
+     * @type {string}
+     * @memberof QacConversationFeedback
+     */
+    updatedAt?: string;
+}
+
+
+/**
+ * @export
+ */
+export const QacConversationFeedbackRatingEnum = {
+    Up: 'up',
+    Down: 'down'
+} as const;
+export type QacConversationFeedbackRatingEnum = typeof QacConversationFeedbackRatingEnum[keyof typeof QacConversationFeedbackRatingEnum];
+
+/**
+ * @export
+ */
+export const QacConversationFeedbackReasonEnum = {
+    Irrelevant: 'irrelevant',
+    Incorrect: 'incorrect',
+    Offensive: 'offensive',
+    Other: 'other'
+} as const;
+export type QacConversationFeedbackReasonEnum = typeof QacConversationFeedbackReasonEnum[keyof typeof QacConversationFeedbackReasonEnum];
+
+
+/**
+ * Check if a given object implements the QacConversationFeedback interface.
+ */
+export function instanceOfQacConversationFeedback(value: object): value is QacConversationFeedback {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('rating' in value) || value['rating'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function QacConversationFeedbackFromJSON(json: any): QacConversationFeedback {
+    return QacConversationFeedbackFromJSONTyped(json, false);
+}
+
+export function QacConversationFeedbackFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationFeedback {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'message': json['message'],
+        'givenBy': json['given_by'] == null ? undefined : UserMinifiedFromJSON(json['given_by']),
+        'rating': json['rating'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+
+export function QacConversationFeedbackToJSON(json: any): QacConversationFeedback {
+    return QacConversationFeedbackToJSONTyped(json, false);
+}
+
+export function QacConversationFeedbackToJSONTyped(value?: QacConversationFeedback | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'message': value['message'],
+        'given_by': UserMinifiedToJSON(value['givenBy']),
+        'rating': value['rating'],
+        'reason': value['reason'],
+        'comment': value['comment'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/QacConversationFeedbackPayload.ts

@@ -0,0 +1,104 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface QacConversationFeedbackPayload
+ */
+export interface QacConversationFeedbackPayload {
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedbackPayload
+     */
+    rating: QacConversationFeedbackPayloadRatingEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedbackPayload
+     */
+    reason?: QacConversationFeedbackPayloadReasonEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof QacConversationFeedbackPayload
+     */
+    comment?: string;
+}
+
+
+/**
+ * @export
+ */
+export const QacConversationFeedbackPayloadRatingEnum = {
+    Up: 'up',
+    Down: 'down'
+} as const;
+export type QacConversationFeedbackPayloadRatingEnum = typeof QacConversationFeedbackPayloadRatingEnum[keyof typeof QacConversationFeedbackPayloadRatingEnum];
+
+/**
+ * @export
+ */
+export const QacConversationFeedbackPayloadReasonEnum = {
+    Irrelevant: 'irrelevant',
+    Incorrect: 'incorrect',
+    Offensive: 'offensive',
+    Other: 'other'
+} as const;
+export type QacConversationFeedbackPayloadReasonEnum = typeof QacConversationFeedbackPayloadReasonEnum[keyof typeof QacConversationFeedbackPayloadReasonEnum];
+
+
+/**
+ * Check if a given object implements the QacConversationFeedbackPayload interface.
+ */
+export function instanceOfQacConversationFeedbackPayload(value: object): value is QacConversationFeedbackPayload {
+    if (!('rating' in value) || value['rating'] === undefined) return false;
+    return true;
+}
+
+export function QacConversationFeedbackPayloadFromJSON(json: any): QacConversationFeedbackPayload {
+    return QacConversationFeedbackPayloadFromJSONTyped(json, false);
+}
+
+export function QacConversationFeedbackPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationFeedbackPayload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'rating': json['rating'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+    };
+}
+
+export function QacConversationFeedbackPayloadToJSON(json: any): QacConversationFeedbackPayload {
+    return QacConversationFeedbackPayloadToJSONTyped(json, false);
+}
+
+export function QacConversationFeedbackPayloadToJSONTyped(value?: QacConversationFeedbackPayload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'rating': value['rating'],
+        'reason': value['reason'],
+        'comment': value['comment'],
+    };
+}
+