@testcollab/sdk 3.7.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.
Files changed (72) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/dist/esm/models/QacConversationFeedback.d.ts +93 -0
  3. package/dist/esm/models/QacConversationFeedback.js +80 -0
  4. package/dist/esm/models/QacConversationFeedbackPayload.d.ts +62 -0
  5. package/dist/esm/models/QacConversationFeedbackPayload.js +63 -0
  6. package/dist/esm/models/QacConversationMessage.d.ts +135 -0
  7. package/dist/esm/models/QacConversationMessage.js +105 -0
  8. package/dist/esm/models/QacConversationMessagePayload.d.ts +88 -0
  9. package/dist/esm/models/QacConversationMessagePayload.js +71 -0
  10. package/dist/esm/models/QacConversationThread.d.ts +130 -0
  11. package/dist/esm/models/QacConversationThread.js +90 -0
  12. package/dist/esm/models/QacConversationThreadPayload.d.ts +81 -0
  13. package/dist/esm/models/QacConversationThreadPayload.js +65 -0
  14. package/dist/esm/models/QacConversationThreadWithMessages.d.ts +40 -0
  15. package/dist/esm/models/QacConversationThreadWithMessages.js +45 -0
  16. package/dist/esm/models/QacConversationTokenUsage.d.ts +44 -0
  17. package/dist/esm/models/QacConversationTokenUsage.js +45 -0
  18. package/dist/esm/models/SuiteTree.d.ts +0 -6
  19. package/dist/esm/models/SuiteTree.js +0 -4
  20. package/dist/esm/models/TrainingArtifactPayload.d.ts +4 -4
  21. package/dist/esm/models/TrainingArtifactPayload.js +4 -4
  22. package/dist/esm/models/TrainingSession.d.ts +1 -0
  23. package/dist/esm/models/TrainingSession.js +2 -1
  24. package/dist/esm/models/index.d.ts +8 -0
  25. package/dist/esm/models/index.js +8 -0
  26. package/dist/models/QacConversationFeedback.d.ts +93 -0
  27. package/dist/models/QacConversationFeedback.js +88 -0
  28. package/dist/models/QacConversationFeedbackPayload.d.ts +62 -0
  29. package/dist/models/QacConversationFeedbackPayload.js +71 -0
  30. package/dist/models/QacConversationMessage.d.ts +135 -0
  31. package/dist/models/QacConversationMessage.js +113 -0
  32. package/dist/models/QacConversationMessagePayload.d.ts +88 -0
  33. package/dist/models/QacConversationMessagePayload.js +79 -0
  34. package/dist/models/QacConversationThread.d.ts +130 -0
  35. package/dist/models/QacConversationThread.js +98 -0
  36. package/dist/models/QacConversationThreadPayload.d.ts +81 -0
  37. package/dist/models/QacConversationThreadPayload.js +73 -0
  38. package/dist/models/QacConversationThreadWithMessages.d.ts +40 -0
  39. package/dist/models/QacConversationThreadWithMessages.js +52 -0
  40. package/dist/models/QacConversationTokenUsage.d.ts +44 -0
  41. package/dist/models/QacConversationTokenUsage.js +52 -0
  42. package/dist/models/SuiteTree.d.ts +0 -6
  43. package/dist/models/SuiteTree.js +0 -4
  44. package/dist/models/TrainingArtifactPayload.d.ts +4 -4
  45. package/dist/models/TrainingArtifactPayload.js +4 -4
  46. package/dist/models/TrainingSession.d.ts +1 -0
  47. package/dist/models/TrainingSession.js +2 -1
  48. package/dist/models/index.d.ts +8 -0
  49. package/dist/models/index.js +8 -0
  50. package/docs/QacConversationFeedback.md +48 -0
  51. package/docs/QacConversationFeedbackPayload.md +38 -0
  52. package/docs/QacConversationMessage.md +58 -0
  53. package/docs/QacConversationMessagePayload.md +46 -0
  54. package/docs/QacConversationThread.md +62 -0
  55. package/docs/QacConversationThreadPayload.md +46 -0
  56. package/docs/QacConversationThreadWithMessages.md +36 -0
  57. package/docs/QacConversationTokenUsage.md +38 -0
  58. package/docs/SuiteTree.md +0 -2
  59. package/docs/TrainingArtifactPayload.md +2 -2
  60. package/package.json +1 -1
  61. package/src/models/QacConversationFeedback.ts +155 -0
  62. package/src/models/QacConversationFeedbackPayload.ts +104 -0
  63. package/src/models/QacConversationMessage.ts +222 -0
  64. package/src/models/QacConversationMessagePayload.ts +136 -0
  65. package/src/models/QacConversationThread.ts +203 -0
  66. package/src/models/QacConversationThreadPayload.ts +127 -0
  67. package/src/models/QacConversationThreadWithMessages.ts +88 -0
  68. package/src/models/QacConversationTokenUsage.ts +81 -0
  69. package/src/models/SuiteTree.ts +0 -9
  70. package/src/models/TrainingArtifactPayload.ts +8 -8
  71. package/src/models/TrainingSession.ts +2 -1
  72. package/src/models/index.ts +8 -0
@@ -177,6 +177,14 @@ docs/ProjectsettingMini.md
177
177
  docs/ProjectsettingPayload.md
178
178
  docs/ProjectsettingsApi.md
179
179
  docs/QACCustomHeader.md
180
+ docs/QacConversationFeedback.md
181
+ docs/QacConversationFeedbackPayload.md
182
+ docs/QacConversationMessage.md
183
+ docs/QacConversationMessagePayload.md
184
+ docs/QacConversationThread.md
185
+ docs/QacConversationThreadPayload.md
186
+ docs/QacConversationThreadWithMessages.md
187
+ docs/QacConversationTokenUsage.md
180
188
  docs/Queue.md
181
189
  docs/QueuePayload.md
182
190
  docs/QueueStatus.md
@@ -592,6 +600,14 @@ src/models/Projectsetting.ts
592
600
  src/models/ProjectsettingMini.ts
593
601
  src/models/ProjectsettingPayload.ts
594
602
  src/models/QACCustomHeader.ts
603
+ src/models/QacConversationFeedback.ts
604
+ src/models/QacConversationFeedbackPayload.ts
605
+ src/models/QacConversationMessage.ts
606
+ src/models/QacConversationMessagePayload.ts
607
+ src/models/QacConversationThread.ts
608
+ src/models/QacConversationThreadPayload.ts
609
+ src/models/QacConversationThreadWithMessages.ts
610
+ src/models/QacConversationTokenUsage.ts
595
611
  src/models/Queue.ts
596
612
  src/models/QueuePayload.ts
597
613
  src/models/QueueStatus.ts
@@ -0,0 +1,93 @@
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 QacConversationFeedback
17
+ */
18
+ export interface QacConversationFeedback {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof QacConversationFeedback
23
+ */
24
+ id: number;
25
+ /**
26
+ *
27
+ * @type {number}
28
+ * @memberof QacConversationFeedback
29
+ */
30
+ message: number;
31
+ /**
32
+ *
33
+ * @type {UserMinified}
34
+ * @memberof QacConversationFeedback
35
+ */
36
+ givenBy?: UserMinified;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof QacConversationFeedback
41
+ */
42
+ rating: QacConversationFeedbackRatingEnum;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof QacConversationFeedback
47
+ */
48
+ reason?: QacConversationFeedbackReasonEnum;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof QacConversationFeedback
53
+ */
54
+ comment?: string;
55
+ /**
56
+ * Time when the activity was performed
57
+ * @type {string}
58
+ * @memberof QacConversationFeedback
59
+ */
60
+ createdAt: string;
61
+ /**
62
+ * Time when the activity was performed
63
+ * @type {string}
64
+ * @memberof QacConversationFeedback
65
+ */
66
+ updatedAt?: string;
67
+ }
68
+ /**
69
+ * @export
70
+ */
71
+ export declare const QacConversationFeedbackRatingEnum: {
72
+ readonly Up: "up";
73
+ readonly Down: "down";
74
+ };
75
+ export type QacConversationFeedbackRatingEnum = typeof QacConversationFeedbackRatingEnum[keyof typeof QacConversationFeedbackRatingEnum];
76
+ /**
77
+ * @export
78
+ */
79
+ export declare const QacConversationFeedbackReasonEnum: {
80
+ readonly Irrelevant: "irrelevant";
81
+ readonly Incorrect: "incorrect";
82
+ readonly Offensive: "offensive";
83
+ readonly Other: "other";
84
+ };
85
+ export type QacConversationFeedbackReasonEnum = typeof QacConversationFeedbackReasonEnum[keyof typeof QacConversationFeedbackReasonEnum];
86
+ /**
87
+ * Check if a given object implements the QacConversationFeedback interface.
88
+ */
89
+ export declare function instanceOfQacConversationFeedback(value: object): value is QacConversationFeedback;
90
+ export declare function QacConversationFeedbackFromJSON(json: any): QacConversationFeedback;
91
+ export declare function QacConversationFeedbackFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationFeedback;
92
+ export declare function QacConversationFeedbackToJSON(json: any): QacConversationFeedback;
93
+ export declare function QacConversationFeedbackToJSONTyped(value?: QacConversationFeedback | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,80 @@
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 QacConversationFeedbackRatingEnum = {
19
+ Up: 'up',
20
+ Down: 'down'
21
+ };
22
+ /**
23
+ * @export
24
+ */
25
+ export const QacConversationFeedbackReasonEnum = {
26
+ Irrelevant: 'irrelevant',
27
+ Incorrect: 'incorrect',
28
+ Offensive: 'offensive',
29
+ Other: 'other'
30
+ };
31
+ /**
32
+ * Check if a given object implements the QacConversationFeedback interface.
33
+ */
34
+ export function instanceOfQacConversationFeedback(value) {
35
+ if (!('id' in value) || value['id'] === undefined)
36
+ return false;
37
+ if (!('message' in value) || value['message'] === undefined)
38
+ return false;
39
+ if (!('rating' in value) || value['rating'] === undefined)
40
+ return false;
41
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ export function QacConversationFeedbackFromJSON(json) {
46
+ return QacConversationFeedbackFromJSONTyped(json, false);
47
+ }
48
+ export function QacConversationFeedbackFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'id': json['id'],
54
+ 'message': json['message'],
55
+ 'givenBy': json['given_by'] == null ? undefined : UserMinifiedFromJSON(json['given_by']),
56
+ 'rating': json['rating'],
57
+ 'reason': json['reason'] == null ? undefined : json['reason'],
58
+ 'comment': json['comment'] == null ? undefined : json['comment'],
59
+ 'createdAt': json['created_at'],
60
+ 'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
61
+ };
62
+ }
63
+ export function QacConversationFeedbackToJSON(json) {
64
+ return QacConversationFeedbackToJSONTyped(json, false);
65
+ }
66
+ export function QacConversationFeedbackToJSONTyped(value, ignoreDiscriminator = false) {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+ 'id': value['id'],
72
+ 'message': value['message'],
73
+ 'given_by': UserMinifiedToJSON(value['givenBy']),
74
+ 'rating': value['rating'],
75
+ 'reason': value['reason'],
76
+ 'comment': value['comment'],
77
+ 'created_at': value['createdAt'],
78
+ 'updated_at': value['updatedAt'],
79
+ };
80
+ }
@@ -0,0 +1,62 @@
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 QacConversationFeedbackPayload
16
+ */
17
+ export interface QacConversationFeedbackPayload {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof QacConversationFeedbackPayload
22
+ */
23
+ rating: QacConversationFeedbackPayloadRatingEnum;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof QacConversationFeedbackPayload
28
+ */
29
+ reason?: QacConversationFeedbackPayloadReasonEnum;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof QacConversationFeedbackPayload
34
+ */
35
+ comment?: string;
36
+ }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const QacConversationFeedbackPayloadRatingEnum: {
41
+ readonly Up: "up";
42
+ readonly Down: "down";
43
+ };
44
+ export type QacConversationFeedbackPayloadRatingEnum = typeof QacConversationFeedbackPayloadRatingEnum[keyof typeof QacConversationFeedbackPayloadRatingEnum];
45
+ /**
46
+ * @export
47
+ */
48
+ export declare const QacConversationFeedbackPayloadReasonEnum: {
49
+ readonly Irrelevant: "irrelevant";
50
+ readonly Incorrect: "incorrect";
51
+ readonly Offensive: "offensive";
52
+ readonly Other: "other";
53
+ };
54
+ export type QacConversationFeedbackPayloadReasonEnum = typeof QacConversationFeedbackPayloadReasonEnum[keyof typeof QacConversationFeedbackPayloadReasonEnum];
55
+ /**
56
+ * Check if a given object implements the QacConversationFeedbackPayload interface.
57
+ */
58
+ export declare function instanceOfQacConversationFeedbackPayload(value: object): value is QacConversationFeedbackPayload;
59
+ export declare function QacConversationFeedbackPayloadFromJSON(json: any): QacConversationFeedbackPayload;
60
+ export declare function QacConversationFeedbackPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationFeedbackPayload;
61
+ export declare function QacConversationFeedbackPayloadToJSON(json: any): QacConversationFeedbackPayload;
62
+ export declare function QacConversationFeedbackPayloadToJSONTyped(value?: QacConversationFeedbackPayload | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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 QacConversationFeedbackPayloadRatingEnum = {
18
+ Up: 'up',
19
+ Down: 'down'
20
+ };
21
+ /**
22
+ * @export
23
+ */
24
+ export const QacConversationFeedbackPayloadReasonEnum = {
25
+ Irrelevant: 'irrelevant',
26
+ Incorrect: 'incorrect',
27
+ Offensive: 'offensive',
28
+ Other: 'other'
29
+ };
30
+ /**
31
+ * Check if a given object implements the QacConversationFeedbackPayload interface.
32
+ */
33
+ export function instanceOfQacConversationFeedbackPayload(value) {
34
+ if (!('rating' in value) || value['rating'] === undefined)
35
+ return false;
36
+ return true;
37
+ }
38
+ export function QacConversationFeedbackPayloadFromJSON(json) {
39
+ return QacConversationFeedbackPayloadFromJSONTyped(json, false);
40
+ }
41
+ export function QacConversationFeedbackPayloadFromJSONTyped(json, ignoreDiscriminator) {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'rating': json['rating'],
47
+ 'reason': json['reason'] == null ? undefined : json['reason'],
48
+ 'comment': json['comment'] == null ? undefined : json['comment'],
49
+ };
50
+ }
51
+ export function QacConversationFeedbackPayloadToJSON(json) {
52
+ return QacConversationFeedbackPayloadToJSONTyped(json, false);
53
+ }
54
+ export function QacConversationFeedbackPayloadToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'rating': value['rating'],
60
+ 'reason': value['reason'],
61
+ 'comment': value['comment'],
62
+ };
63
+ }
@@ -0,0 +1,135 @@
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
+ import type { QacConversationTokenUsage } from './QacConversationTokenUsage';
14
+ import type { Upload } from './Upload';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface QacConversationMessage
19
+ */
20
+ export interface QacConversationMessage {
21
+ /**
22
+ *
23
+ * @type {number}
24
+ * @memberof QacConversationMessage
25
+ */
26
+ id: number;
27
+ /**
28
+ *
29
+ * @type {number}
30
+ * @memberof QacConversationMessage
31
+ */
32
+ thread: number;
33
+ /**
34
+ *
35
+ * @type {string}
36
+ * @memberof QacConversationMessage
37
+ */
38
+ authorType: QacConversationMessageAuthorTypeEnum;
39
+ /**
40
+ *
41
+ * @type {UserMinified}
42
+ * @memberof QacConversationMessage
43
+ */
44
+ author?: UserMinified;
45
+ /**
46
+ *
47
+ * @type {string}
48
+ * @memberof QacConversationMessage
49
+ */
50
+ role?: QacConversationMessageRoleEnum;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof QacConversationMessage
55
+ */
56
+ content: string;
57
+ /**
58
+ *
59
+ * @type {string}
60
+ * @memberof QacConversationMessage
61
+ */
62
+ contentHtml?: string;
63
+ /**
64
+ *
65
+ * @type {Array<Upload>}
66
+ * @memberof QacConversationMessage
67
+ */
68
+ attachments?: Array<Upload>;
69
+ /**
70
+ *
71
+ * @type {string}
72
+ * @memberof QacConversationMessage
73
+ */
74
+ status: QacConversationMessageStatusEnum;
75
+ /**
76
+ *
77
+ * @type {string}
78
+ * @memberof QacConversationMessage
79
+ */
80
+ errorReason?: string;
81
+ /**
82
+ *
83
+ * @type {QacConversationTokenUsage}
84
+ * @memberof QacConversationMessage
85
+ */
86
+ tokenUsage?: QacConversationTokenUsage;
87
+ /**
88
+ * Time when the activity was performed
89
+ * @type {string}
90
+ * @memberof QacConversationMessage
91
+ */
92
+ createdAt: string;
93
+ /**
94
+ * Time when the activity was performed
95
+ * @type {string}
96
+ * @memberof QacConversationMessage
97
+ */
98
+ updatedAt?: string;
99
+ }
100
+ /**
101
+ * @export
102
+ */
103
+ export declare const QacConversationMessageAuthorTypeEnum: {
104
+ readonly User: "user";
105
+ readonly Copilot: "copilot";
106
+ readonly System: "system";
107
+ };
108
+ export type QacConversationMessageAuthorTypeEnum = typeof QacConversationMessageAuthorTypeEnum[keyof typeof QacConversationMessageAuthorTypeEnum];
109
+ /**
110
+ * @export
111
+ */
112
+ export declare const QacConversationMessageRoleEnum: {
113
+ readonly User: "user";
114
+ readonly Assistant: "assistant";
115
+ readonly System: "system";
116
+ };
117
+ export type QacConversationMessageRoleEnum = typeof QacConversationMessageRoleEnum[keyof typeof QacConversationMessageRoleEnum];
118
+ /**
119
+ * @export
120
+ */
121
+ export declare const QacConversationMessageStatusEnum: {
122
+ readonly Queued: "queued";
123
+ readonly InProgress: "in_progress";
124
+ readonly Completed: "completed";
125
+ readonly Error: "error";
126
+ };
127
+ export type QacConversationMessageStatusEnum = typeof QacConversationMessageStatusEnum[keyof typeof QacConversationMessageStatusEnum];
128
+ /**
129
+ * Check if a given object implements the QacConversationMessage interface.
130
+ */
131
+ export declare function instanceOfQacConversationMessage(value: object): value is QacConversationMessage;
132
+ export declare function QacConversationMessageFromJSON(json: any): QacConversationMessage;
133
+ export declare function QacConversationMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationMessage;
134
+ export declare function QacConversationMessageToJSON(json: any): QacConversationMessage;
135
+ export declare function QacConversationMessageToJSONTyped(value?: QacConversationMessage | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,105 @@
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
+ import { QacConversationTokenUsageFromJSON, QacConversationTokenUsageToJSON, } from './QacConversationTokenUsage';
16
+ import { UploadFromJSON, UploadToJSON, } from './Upload';
17
+ /**
18
+ * @export
19
+ */
20
+ export const QacConversationMessageAuthorTypeEnum = {
21
+ User: 'user',
22
+ Copilot: 'copilot',
23
+ System: 'system'
24
+ };
25
+ /**
26
+ * @export
27
+ */
28
+ export const QacConversationMessageRoleEnum = {
29
+ User: 'user',
30
+ Assistant: 'assistant',
31
+ System: 'system'
32
+ };
33
+ /**
34
+ * @export
35
+ */
36
+ export const QacConversationMessageStatusEnum = {
37
+ Queued: 'queued',
38
+ InProgress: 'in_progress',
39
+ Completed: 'completed',
40
+ Error: 'error'
41
+ };
42
+ /**
43
+ * Check if a given object implements the QacConversationMessage interface.
44
+ */
45
+ export function instanceOfQacConversationMessage(value) {
46
+ if (!('id' in value) || value['id'] === undefined)
47
+ return false;
48
+ if (!('thread' in value) || value['thread'] === undefined)
49
+ return false;
50
+ if (!('authorType' in value) || value['authorType'] === undefined)
51
+ return false;
52
+ if (!('content' in value) || value['content'] === undefined)
53
+ return false;
54
+ if (!('status' in value) || value['status'] === undefined)
55
+ return false;
56
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
57
+ return false;
58
+ return true;
59
+ }
60
+ export function QacConversationMessageFromJSON(json) {
61
+ return QacConversationMessageFromJSONTyped(json, false);
62
+ }
63
+ export function QacConversationMessageFromJSONTyped(json, ignoreDiscriminator) {
64
+ if (json == null) {
65
+ return json;
66
+ }
67
+ return {
68
+ 'id': json['id'],
69
+ 'thread': json['thread'],
70
+ 'authorType': json['author_type'],
71
+ 'author': json['author'] == null ? undefined : UserMinifiedFromJSON(json['author']),
72
+ 'role': json['role'] == null ? undefined : json['role'],
73
+ 'content': json['content'],
74
+ 'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
75
+ 'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(UploadFromJSON)),
76
+ 'status': json['status'],
77
+ 'errorReason': json['error_reason'] == null ? undefined : json['error_reason'],
78
+ 'tokenUsage': json['token_usage'] == null ? undefined : QacConversationTokenUsageFromJSON(json['token_usage']),
79
+ 'createdAt': json['created_at'],
80
+ 'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
81
+ };
82
+ }
83
+ export function QacConversationMessageToJSON(json) {
84
+ return QacConversationMessageToJSONTyped(json, false);
85
+ }
86
+ export function QacConversationMessageToJSONTyped(value, ignoreDiscriminator = false) {
87
+ if (value == null) {
88
+ return value;
89
+ }
90
+ return {
91
+ 'id': value['id'],
92
+ 'thread': value['thread'],
93
+ 'author_type': value['authorType'],
94
+ 'author': UserMinifiedToJSON(value['author']),
95
+ 'role': value['role'],
96
+ 'content': value['content'],
97
+ 'content_html': value['contentHtml'],
98
+ 'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(UploadToJSON)),
99
+ 'status': value['status'],
100
+ 'error_reason': value['errorReason'],
101
+ 'token_usage': QacConversationTokenUsageToJSON(value['tokenUsage']),
102
+ 'created_at': value['createdAt'],
103
+ 'updated_at': value['updatedAt'],
104
+ };
105
+ }
@@ -0,0 +1,88 @@
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 QacConversationMessagePayload
16
+ */
17
+ export interface QacConversationMessagePayload {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof QacConversationMessagePayload
22
+ */
23
+ thread?: number;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof QacConversationMessagePayload
28
+ */
29
+ authorType?: QacConversationMessagePayloadAuthorTypeEnum;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof QacConversationMessagePayload
34
+ */
35
+ role?: QacConversationMessagePayloadRoleEnum;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof QacConversationMessagePayload
40
+ */
41
+ content: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof QacConversationMessagePayload
46
+ */
47
+ contentHtml?: string;
48
+ /**
49
+ * Upload IDs returned by upload path
50
+ * @type {Array<number>}
51
+ * @memberof QacConversationMessagePayload
52
+ */
53
+ attachments?: Array<number>;
54
+ /**
55
+ * Optional metadata such as browser, environment or locale
56
+ * @type {{ [key: string]: any; }}
57
+ * @memberof QacConversationMessagePayload
58
+ */
59
+ metadata?: {
60
+ [key: string]: any;
61
+ };
62
+ }
63
+ /**
64
+ * @export
65
+ */
66
+ export declare const QacConversationMessagePayloadAuthorTypeEnum: {
67
+ readonly User: "user";
68
+ readonly Copilot: "copilot";
69
+ readonly System: "system";
70
+ };
71
+ export type QacConversationMessagePayloadAuthorTypeEnum = typeof QacConversationMessagePayloadAuthorTypeEnum[keyof typeof QacConversationMessagePayloadAuthorTypeEnum];
72
+ /**
73
+ * @export
74
+ */
75
+ export declare const QacConversationMessagePayloadRoleEnum: {
76
+ readonly User: "user";
77
+ readonly Assistant: "assistant";
78
+ readonly System: "system";
79
+ };
80
+ export type QacConversationMessagePayloadRoleEnum = typeof QacConversationMessagePayloadRoleEnum[keyof typeof QacConversationMessagePayloadRoleEnum];
81
+ /**
82
+ * Check if a given object implements the QacConversationMessagePayload interface.
83
+ */
84
+ export declare function instanceOfQacConversationMessagePayload(value: object): value is QacConversationMessagePayload;
85
+ export declare function QacConversationMessagePayloadFromJSON(json: any): QacConversationMessagePayload;
86
+ export declare function QacConversationMessagePayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): QacConversationMessagePayload;
87
+ export declare function QacConversationMessagePayloadToJSON(json: any): QacConversationMessagePayload;
88
+ export declare function QacConversationMessagePayloadToJSONTyped(value?: QacConversationMessagePayload | null, ignoreDiscriminator?: boolean): any;