@testcollab/sdk 3.8.0 → 3.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +16 -0
- package/dist/esm/models/QacConversationFeedback.d.ts +93 -0
- package/dist/esm/models/QacConversationFeedback.js +80 -0
- package/dist/esm/models/QacConversationFeedbackPayload.d.ts +62 -0
- package/dist/esm/models/QacConversationFeedbackPayload.js +63 -0
- package/dist/esm/models/QacConversationMessage.d.ts +135 -0
- package/dist/esm/models/QacConversationMessage.js +105 -0
- package/dist/esm/models/QacConversationMessagePayload.d.ts +88 -0
- package/dist/esm/models/QacConversationMessagePayload.js +71 -0
- package/dist/esm/models/QacConversationThread.d.ts +130 -0
- package/dist/esm/models/QacConversationThread.js +90 -0
- package/dist/esm/models/QacConversationThreadPayload.d.ts +81 -0
- package/dist/esm/models/QacConversationThreadPayload.js +65 -0
- package/dist/esm/models/QacConversationThreadWithMessages.d.ts +40 -0
- package/dist/esm/models/QacConversationThreadWithMessages.js +45 -0
- package/dist/esm/models/QacConversationTokenUsage.d.ts +44 -0
- package/dist/esm/models/QacConversationTokenUsage.js +45 -0
- package/dist/esm/models/SuiteTree.d.ts +0 -6
- package/dist/esm/models/SuiteTree.js +0 -4
- package/dist/esm/models/TrainingArtifactPayload.d.ts +4 -4
- package/dist/esm/models/TrainingArtifactPayload.js +4 -4
- package/dist/esm/models/TrainingSession.d.ts +1 -0
- package/dist/esm/models/TrainingSession.js +2 -1
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/models/QacConversationFeedback.d.ts +93 -0
- package/dist/models/QacConversationFeedback.js +88 -0
- package/dist/models/QacConversationFeedbackPayload.d.ts +62 -0
- package/dist/models/QacConversationFeedbackPayload.js +71 -0
- package/dist/models/QacConversationMessage.d.ts +135 -0
- package/dist/models/QacConversationMessage.js +113 -0
- package/dist/models/QacConversationMessagePayload.d.ts +88 -0
- package/dist/models/QacConversationMessagePayload.js +79 -0
- package/dist/models/QacConversationThread.d.ts +130 -0
- package/dist/models/QacConversationThread.js +98 -0
- package/dist/models/QacConversationThreadPayload.d.ts +81 -0
- package/dist/models/QacConversationThreadPayload.js +73 -0
- package/dist/models/QacConversationThreadWithMessages.d.ts +40 -0
- package/dist/models/QacConversationThreadWithMessages.js +52 -0
- package/dist/models/QacConversationTokenUsage.d.ts +44 -0
- package/dist/models/QacConversationTokenUsage.js +52 -0
- package/dist/models/SuiteTree.d.ts +0 -6
- package/dist/models/SuiteTree.js +0 -4
- package/dist/models/TrainingArtifactPayload.d.ts +4 -4
- package/dist/models/TrainingArtifactPayload.js +4 -4
- package/dist/models/TrainingSession.d.ts +1 -0
- package/dist/models/TrainingSession.js +2 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/docs/QacConversationFeedback.md +48 -0
- package/docs/QacConversationFeedbackPayload.md +38 -0
- package/docs/QacConversationMessage.md +58 -0
- package/docs/QacConversationMessagePayload.md +46 -0
- package/docs/QacConversationThread.md +62 -0
- package/docs/QacConversationThreadPayload.md +46 -0
- package/docs/QacConversationThreadWithMessages.md +36 -0
- package/docs/QacConversationTokenUsage.md +38 -0
- package/docs/SuiteTree.md +0 -2
- package/docs/TrainingArtifactPayload.md +2 -2
- package/package.json +1 -1
- package/src/models/QacConversationFeedback.ts +155 -0
- package/src/models/QacConversationFeedbackPayload.ts +104 -0
- package/src/models/QacConversationMessage.ts +222 -0
- package/src/models/QacConversationMessagePayload.ts +136 -0
- package/src/models/QacConversationThread.ts +203 -0
- package/src/models/QacConversationThreadPayload.ts +127 -0
- package/src/models/QacConversationThreadWithMessages.ts +88 -0
- package/src/models/QacConversationTokenUsage.ts +81 -0
- package/src/models/SuiteTree.ts +0 -9
- package/src/models/TrainingArtifactPayload.ts +8 -8
- package/src/models/TrainingSession.ts +2 -1
- package/src/models/index.ts +8 -0
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const QacConversationMessagePayloadAuthorTypeEnum = {
|
|
18
|
+
User: 'user',
|
|
19
|
+
Copilot: 'copilot',
|
|
20
|
+
System: 'system'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export const QacConversationMessagePayloadRoleEnum = {
|
|
26
|
+
User: 'user',
|
|
27
|
+
Assistant: 'assistant',
|
|
28
|
+
System: 'system'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the QacConversationMessagePayload interface.
|
|
32
|
+
*/
|
|
33
|
+
export function instanceOfQacConversationMessagePayload(value) {
|
|
34
|
+
if (!('content' in value) || value['content'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
return true;
|
|
37
|
+
}
|
|
38
|
+
export function QacConversationMessagePayloadFromJSON(json) {
|
|
39
|
+
return QacConversationMessagePayloadFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
export function QacConversationMessagePayloadFromJSONTyped(json, ignoreDiscriminator) {
|
|
42
|
+
if (json == null) {
|
|
43
|
+
return json;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'thread': json['thread'] == null ? undefined : json['thread'],
|
|
47
|
+
'authorType': json['author_type'] == null ? undefined : json['author_type'],
|
|
48
|
+
'role': json['role'] == null ? undefined : json['role'],
|
|
49
|
+
'content': json['content'],
|
|
50
|
+
'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
|
|
51
|
+
'attachments': json['attachments'] == null ? undefined : json['attachments'],
|
|
52
|
+
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
export function QacConversationMessagePayloadToJSON(json) {
|
|
56
|
+
return QacConversationMessagePayloadToJSONTyped(json, false);
|
|
57
|
+
}
|
|
58
|
+
export function QacConversationMessagePayloadToJSONTyped(value, ignoreDiscriminator = false) {
|
|
59
|
+
if (value == null) {
|
|
60
|
+
return value;
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
'thread': value['thread'],
|
|
64
|
+
'author_type': value['authorType'],
|
|
65
|
+
'role': value['role'],
|
|
66
|
+
'content': value['content'],
|
|
67
|
+
'content_html': value['contentHtml'],
|
|
68
|
+
'attachments': value['attachments'],
|
|
69
|
+
'metadata': value['metadata'],
|
|
70
|
+
};
|
|
71
|
+
}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { UserMinified } from './UserMinified';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface QacConversationThread
|
|
17
|
+
*/
|
|
18
|
+
export interface QacConversationThread {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof QacConversationThread
|
|
23
|
+
*/
|
|
24
|
+
id: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof QacConversationThread
|
|
29
|
+
*/
|
|
30
|
+
project?: number;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof QacConversationThread
|
|
35
|
+
*/
|
|
36
|
+
company: number;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {UserMinified}
|
|
40
|
+
* @memberof QacConversationThread
|
|
41
|
+
*/
|
|
42
|
+
createdBy?: UserMinified;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof QacConversationThread
|
|
47
|
+
*/
|
|
48
|
+
title?: string;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof QacConversationThread
|
|
53
|
+
*/
|
|
54
|
+
status: QacConversationThreadStatusEnum;
|
|
55
|
+
/**
|
|
56
|
+
* Origin URL where the conversation was started
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof QacConversationThread
|
|
59
|
+
*/
|
|
60
|
+
sourceUrl: string;
|
|
61
|
+
/**
|
|
62
|
+
* Flexible JSON for linking related entities (e.g., test_case, run, requirement, suite)
|
|
63
|
+
* @type {{ [key: string]: any; }}
|
|
64
|
+
* @memberof QacConversationThread
|
|
65
|
+
*/
|
|
66
|
+
contextRefs?: {
|
|
67
|
+
[key: string]: any;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {number}
|
|
72
|
+
* @memberof QacConversationThread
|
|
73
|
+
*/
|
|
74
|
+
messagesCount: number;
|
|
75
|
+
/**
|
|
76
|
+
* Time when the activity was performed
|
|
77
|
+
* @type {string}
|
|
78
|
+
* @memberof QacConversationThread
|
|
79
|
+
*/
|
|
80
|
+
lastMessageAt?: string;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @type {string}
|
|
84
|
+
* @memberof QacConversationThread
|
|
85
|
+
*/
|
|
86
|
+
lastMessagePreview?: string;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {boolean}
|
|
90
|
+
* @memberof QacConversationThread
|
|
91
|
+
*/
|
|
92
|
+
pinned?: boolean;
|
|
93
|
+
/**
|
|
94
|
+
* Optional metadata such as browser, environment or locale
|
|
95
|
+
* @type {{ [key: string]: any; }}
|
|
96
|
+
* @memberof QacConversationThread
|
|
97
|
+
*/
|
|
98
|
+
metadata?: {
|
|
99
|
+
[key: string]: any;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Time when the activity was performed
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof QacConversationThread
|
|
105
|
+
*/
|
|
106
|
+
createdAt: string;
|
|
107
|
+
/**
|
|
108
|
+
* Time when the activity was performed
|
|
109
|
+
* @type {string}
|
|
110
|
+
* @memberof QacConversationThread
|
|
111
|
+
*/
|
|
112
|
+
updatedAt?: string;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* @export
|
|
116
|
+
*/
|
|
117
|
+
export declare const QacConversationThreadStatusEnum: {
|
|
118
|
+
readonly Open: "open";
|
|
119
|
+
readonly Closed: "closed";
|
|
120
|
+
readonly Archived: "archived";
|
|
121
|
+
};
|
|
122
|
+
export type QacConversationThreadStatusEnum = typeof QacConversationThreadStatusEnum[keyof typeof QacConversationThreadStatusEnum];
|
|
123
|
+
/**
|
|
124
|
+
* Check if a given object implements the QacConversationThread interface.
|
|
125
|
+
*/
|
|
126
|
+
export declare function instanceOfQacConversationThread(value: object): value is QacConversationThread;
|
|
127
|
+
export declare function QacConversationThreadFromJSON(json: any): QacConversationThread;
|
|
128
|
+
export declare function QacConversationThreadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationThread;
|
|
129
|
+
export declare function QacConversationThreadToJSON(json: any): QacConversationThread;
|
|
130
|
+
export declare function QacConversationThreadToJSONTyped(value?: QacConversationThread | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { UserMinifiedFromJSON, UserMinifiedToJSON, } from './UserMinified';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const QacConversationThreadStatusEnum = {
|
|
19
|
+
Open: 'open',
|
|
20
|
+
Closed: 'closed',
|
|
21
|
+
Archived: 'archived'
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Check if a given object implements the QacConversationThread interface.
|
|
25
|
+
*/
|
|
26
|
+
export function instanceOfQacConversationThread(value) {
|
|
27
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('company' in value) || value['company'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('sourceUrl' in value) || value['sourceUrl'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('messagesCount' in value) || value['messagesCount'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
export function QacConversationThreadFromJSON(json) {
|
|
42
|
+
return QacConversationThreadFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
export function QacConversationThreadFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
if (json == null) {
|
|
46
|
+
return json;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'id': json['id'],
|
|
50
|
+
'project': json['project'] == null ? undefined : json['project'],
|
|
51
|
+
'company': json['company'],
|
|
52
|
+
'createdBy': json['created_by'] == null ? undefined : UserMinifiedFromJSON(json['created_by']),
|
|
53
|
+
'title': json['title'] == null ? undefined : json['title'],
|
|
54
|
+
'status': json['status'],
|
|
55
|
+
'sourceUrl': json['source_url'],
|
|
56
|
+
'contextRefs': json['context_refs'] == null ? undefined : json['context_refs'],
|
|
57
|
+
'messagesCount': json['messages_count'],
|
|
58
|
+
'lastMessageAt': json['last_message_at'] == null ? undefined : json['last_message_at'],
|
|
59
|
+
'lastMessagePreview': json['last_message_preview'] == null ? undefined : json['last_message_preview'],
|
|
60
|
+
'pinned': json['pinned'] == null ? undefined : json['pinned'],
|
|
61
|
+
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
62
|
+
'createdAt': json['created_at'],
|
|
63
|
+
'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
export function QacConversationThreadToJSON(json) {
|
|
67
|
+
return QacConversationThreadToJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
export function QacConversationThreadToJSONTyped(value, ignoreDiscriminator = false) {
|
|
70
|
+
if (value == null) {
|
|
71
|
+
return value;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
'id': value['id'],
|
|
75
|
+
'project': value['project'],
|
|
76
|
+
'company': value['company'],
|
|
77
|
+
'created_by': UserMinifiedToJSON(value['createdBy']),
|
|
78
|
+
'title': value['title'],
|
|
79
|
+
'status': value['status'],
|
|
80
|
+
'source_url': value['sourceUrl'],
|
|
81
|
+
'context_refs': value['contextRefs'],
|
|
82
|
+
'messages_count': value['messagesCount'],
|
|
83
|
+
'last_message_at': value['lastMessageAt'],
|
|
84
|
+
'last_message_preview': value['lastMessagePreview'],
|
|
85
|
+
'pinned': value['pinned'],
|
|
86
|
+
'metadata': value['metadata'],
|
|
87
|
+
'created_at': value['createdAt'],
|
|
88
|
+
'updated_at': value['updatedAt'],
|
|
89
|
+
};
|
|
90
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface QacConversationThreadPayload
|
|
16
|
+
*/
|
|
17
|
+
export interface QacConversationThreadPayload {
|
|
18
|
+
/**
|
|
19
|
+
* Project ID for the thread
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof QacConversationThreadPayload
|
|
22
|
+
*/
|
|
23
|
+
project?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Company ID for the thread
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof QacConversationThreadPayload
|
|
28
|
+
*/
|
|
29
|
+
company: number;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof QacConversationThreadPayload
|
|
34
|
+
*/
|
|
35
|
+
title?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof QacConversationThreadPayload
|
|
40
|
+
*/
|
|
41
|
+
status?: QacConversationThreadPayloadStatusEnum;
|
|
42
|
+
/**
|
|
43
|
+
* Origin URL where the conversation was started
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof QacConversationThreadPayload
|
|
46
|
+
*/
|
|
47
|
+
sourceUrl: string;
|
|
48
|
+
/**
|
|
49
|
+
* Flexible JSON for linking related entities (e.g., test_case, run, requirement, suite)
|
|
50
|
+
* @type {{ [key: string]: any; }}
|
|
51
|
+
* @memberof QacConversationThreadPayload
|
|
52
|
+
*/
|
|
53
|
+
contextRefs?: {
|
|
54
|
+
[key: string]: any;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Optional metadata such as browser, environment or locale
|
|
58
|
+
* @type {{ [key: string]: any; }}
|
|
59
|
+
* @memberof QacConversationThreadPayload
|
|
60
|
+
*/
|
|
61
|
+
metadata?: {
|
|
62
|
+
[key: string]: any;
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* @export
|
|
67
|
+
*/
|
|
68
|
+
export declare const QacConversationThreadPayloadStatusEnum: {
|
|
69
|
+
readonly Open: "open";
|
|
70
|
+
readonly Closed: "closed";
|
|
71
|
+
readonly Archived: "archived";
|
|
72
|
+
};
|
|
73
|
+
export type QacConversationThreadPayloadStatusEnum = typeof QacConversationThreadPayloadStatusEnum[keyof typeof QacConversationThreadPayloadStatusEnum];
|
|
74
|
+
/**
|
|
75
|
+
* Check if a given object implements the QacConversationThreadPayload interface.
|
|
76
|
+
*/
|
|
77
|
+
export declare function instanceOfQacConversationThreadPayload(value: object): value is QacConversationThreadPayload;
|
|
78
|
+
export declare function QacConversationThreadPayloadFromJSON(json: any): QacConversationThreadPayload;
|
|
79
|
+
export declare function QacConversationThreadPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationThreadPayload;
|
|
80
|
+
export declare function QacConversationThreadPayloadToJSON(json: any): QacConversationThreadPayload;
|
|
81
|
+
export declare function QacConversationThreadPayloadToJSONTyped(value?: QacConversationThreadPayload | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const QacConversationThreadPayloadStatusEnum = {
|
|
18
|
+
Open: 'open',
|
|
19
|
+
Closed: 'closed',
|
|
20
|
+
Archived: 'archived'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the QacConversationThreadPayload interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfQacConversationThreadPayload(value) {
|
|
26
|
+
if (!('company' in value) || value['company'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('sourceUrl' in value) || value['sourceUrl'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
export function QacConversationThreadPayloadFromJSON(json) {
|
|
33
|
+
return QacConversationThreadPayloadFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
export function QacConversationThreadPayloadFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'project': json['project'] == null ? undefined : json['project'],
|
|
41
|
+
'company': json['company'],
|
|
42
|
+
'title': json['title'] == null ? undefined : json['title'],
|
|
43
|
+
'status': json['status'] == null ? undefined : json['status'],
|
|
44
|
+
'sourceUrl': json['source_url'],
|
|
45
|
+
'contextRefs': json['context_refs'] == null ? undefined : json['context_refs'],
|
|
46
|
+
'metadata': json['metadata'] == null ? undefined : json['metadata'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
export function QacConversationThreadPayloadToJSON(json) {
|
|
50
|
+
return QacConversationThreadPayloadToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
export function QacConversationThreadPayloadToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'project': value['project'],
|
|
58
|
+
'company': value['company'],
|
|
59
|
+
'title': value['title'],
|
|
60
|
+
'status': value['status'],
|
|
61
|
+
'source_url': value['sourceUrl'],
|
|
62
|
+
'context_refs': value['contextRefs'],
|
|
63
|
+
'metadata': value['metadata'],
|
|
64
|
+
};
|
|
65
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { QacConversationThread } from './QacConversationThread';
|
|
13
|
+
import type { QacConversationMessage } from './QacConversationMessage';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface QacConversationThreadWithMessages
|
|
18
|
+
*/
|
|
19
|
+
export interface QacConversationThreadWithMessages {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {QacConversationThread}
|
|
23
|
+
* @memberof QacConversationThreadWithMessages
|
|
24
|
+
*/
|
|
25
|
+
thread?: QacConversationThread;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {Array<QacConversationMessage>}
|
|
29
|
+
* @memberof QacConversationThreadWithMessages
|
|
30
|
+
*/
|
|
31
|
+
messages?: Array<QacConversationMessage>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the QacConversationThreadWithMessages interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfQacConversationThreadWithMessages(value: object): value is QacConversationThreadWithMessages;
|
|
37
|
+
export declare function QacConversationThreadWithMessagesFromJSON(json: any): QacConversationThreadWithMessages;
|
|
38
|
+
export declare function QacConversationThreadWithMessagesFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationThreadWithMessages;
|
|
39
|
+
export declare function QacConversationThreadWithMessagesToJSON(json: any): QacConversationThreadWithMessages;
|
|
40
|
+
export declare function QacConversationThreadWithMessagesToJSONTyped(value?: QacConversationThreadWithMessages | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { QacConversationThreadFromJSON, QacConversationThreadToJSON, } from './QacConversationThread';
|
|
15
|
+
import { QacConversationMessageFromJSON, QacConversationMessageToJSON, } from './QacConversationMessage';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the QacConversationThreadWithMessages interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfQacConversationThreadWithMessages(value) {
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
export function QacConversationThreadWithMessagesFromJSON(json) {
|
|
23
|
+
return QacConversationThreadWithMessagesFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
export function QacConversationThreadWithMessagesFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if (json == null) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'thread': json['thread'] == null ? undefined : QacConversationThreadFromJSON(json['thread']),
|
|
31
|
+
'messages': json['messages'] == null ? undefined : (json['messages'].map(QacConversationMessageFromJSON)),
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
export function QacConversationThreadWithMessagesToJSON(json) {
|
|
35
|
+
return QacConversationThreadWithMessagesToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function QacConversationThreadWithMessagesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'thread': QacConversationThreadToJSON(value['thread']),
|
|
43
|
+
'messages': value['messages'] == null ? undefined : (value['messages'].map(QacConversationMessageToJSON)),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TC API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.3.1
|
|
6
|
+
* Contact: support@testcollab.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface QacConversationTokenUsage
|
|
16
|
+
*/
|
|
17
|
+
export interface QacConversationTokenUsage {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof QacConversationTokenUsage
|
|
22
|
+
*/
|
|
23
|
+
promptTokens?: number;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof QacConversationTokenUsage
|
|
28
|
+
*/
|
|
29
|
+
completionTokens?: number;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof QacConversationTokenUsage
|
|
34
|
+
*/
|
|
35
|
+
totalTokens?: number;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the QacConversationTokenUsage interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfQacConversationTokenUsage(value: object): value is QacConversationTokenUsage;
|
|
41
|
+
export declare function QacConversationTokenUsageFromJSON(json: any): QacConversationTokenUsage;
|
|
42
|
+
export declare function QacConversationTokenUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationTokenUsage;
|
|
43
|
+
export declare function QacConversationTokenUsageToJSON(json: any): QacConversationTokenUsage;
|
|
44
|
+
export declare function QacConversationTokenUsageToJSONTyped(value?: QacConversationTokenUsage | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* TC API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.3.1
|
|
8
|
+
* Contact: support@testcollab.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Check if a given object implements the QacConversationTokenUsage interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfQacConversationTokenUsage(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function QacConversationTokenUsageFromJSON(json) {
|
|
21
|
+
return QacConversationTokenUsageFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function QacConversationTokenUsageFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'promptTokens': json['prompt_tokens'] == null ? undefined : json['prompt_tokens'],
|
|
29
|
+
'completionTokens': json['completion_tokens'] == null ? undefined : json['completion_tokens'],
|
|
30
|
+
'totalTokens': json['total_tokens'] == null ? undefined : json['total_tokens'],
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
export function QacConversationTokenUsageToJSON(json) {
|
|
34
|
+
return QacConversationTokenUsageToJSONTyped(json, false);
|
|
35
|
+
}
|
|
36
|
+
export function QacConversationTokenUsageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
37
|
+
if (value == null) {
|
|
38
|
+
return value;
|
|
39
|
+
}
|
|
40
|
+
return {
|
|
41
|
+
'prompt_tokens': value['promptTokens'],
|
|
42
|
+
'completion_tokens': value['completionTokens'],
|
|
43
|
+
'total_tokens': value['totalTokens'],
|
|
44
|
+
};
|
|
45
|
+
}
|