@testcollab/sdk 3.8.0 → 3.10.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 (90) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/dist/esm/models/Project.d.ts +6 -0
  3. package/dist/esm/models/Project.js +2 -0
  4. package/dist/esm/models/ProjectCreatePayload.d.ts +6 -0
  5. package/dist/esm/models/ProjectCreatePayload.js +2 -0
  6. package/dist/esm/models/ProjectPayload.d.ts +6 -0
  7. package/dist/esm/models/ProjectPayload.js +2 -0
  8. package/dist/esm/models/QacConversationFeedback.d.ts +93 -0
  9. package/dist/esm/models/QacConversationFeedback.js +80 -0
  10. package/dist/esm/models/QacConversationFeedbackPayload.d.ts +62 -0
  11. package/dist/esm/models/QacConversationFeedbackPayload.js +63 -0
  12. package/dist/esm/models/QacConversationMessage.d.ts +135 -0
  13. package/dist/esm/models/QacConversationMessage.js +105 -0
  14. package/dist/esm/models/QacConversationMessagePayload.d.ts +88 -0
  15. package/dist/esm/models/QacConversationMessagePayload.js +71 -0
  16. package/dist/esm/models/QacConversationThread.d.ts +130 -0
  17. package/dist/esm/models/QacConversationThread.js +90 -0
  18. package/dist/esm/models/QacConversationThreadPayload.d.ts +81 -0
  19. package/dist/esm/models/QacConversationThreadPayload.js +65 -0
  20. package/dist/esm/models/QacConversationThreadWithMessages.d.ts +40 -0
  21. package/dist/esm/models/QacConversationThreadWithMessages.js +45 -0
  22. package/dist/esm/models/QacConversationTokenUsage.d.ts +44 -0
  23. package/dist/esm/models/QacConversationTokenUsage.js +45 -0
  24. package/dist/esm/models/SuiteTree.d.ts +0 -6
  25. package/dist/esm/models/SuiteTree.js +0 -4
  26. package/dist/esm/models/TrainingArtifactPayload.d.ts +4 -4
  27. package/dist/esm/models/TrainingArtifactPayload.js +4 -4
  28. package/dist/esm/models/TrainingSession.d.ts +1 -0
  29. package/dist/esm/models/TrainingSession.js +2 -1
  30. package/dist/esm/models/index.d.ts +8 -0
  31. package/dist/esm/models/index.js +8 -0
  32. package/dist/models/Project.d.ts +6 -0
  33. package/dist/models/Project.js +2 -0
  34. package/dist/models/ProjectCreatePayload.d.ts +6 -0
  35. package/dist/models/ProjectCreatePayload.js +2 -0
  36. package/dist/models/ProjectPayload.d.ts +6 -0
  37. package/dist/models/ProjectPayload.js +2 -0
  38. package/dist/models/QacConversationFeedback.d.ts +93 -0
  39. package/dist/models/QacConversationFeedback.js +88 -0
  40. package/dist/models/QacConversationFeedbackPayload.d.ts +62 -0
  41. package/dist/models/QacConversationFeedbackPayload.js +71 -0
  42. package/dist/models/QacConversationMessage.d.ts +135 -0
  43. package/dist/models/QacConversationMessage.js +113 -0
  44. package/dist/models/QacConversationMessagePayload.d.ts +88 -0
  45. package/dist/models/QacConversationMessagePayload.js +79 -0
  46. package/dist/models/QacConversationThread.d.ts +130 -0
  47. package/dist/models/QacConversationThread.js +98 -0
  48. package/dist/models/QacConversationThreadPayload.d.ts +81 -0
  49. package/dist/models/QacConversationThreadPayload.js +73 -0
  50. package/dist/models/QacConversationThreadWithMessages.d.ts +40 -0
  51. package/dist/models/QacConversationThreadWithMessages.js +52 -0
  52. package/dist/models/QacConversationTokenUsage.d.ts +44 -0
  53. package/dist/models/QacConversationTokenUsage.js +52 -0
  54. package/dist/models/SuiteTree.d.ts +0 -6
  55. package/dist/models/SuiteTree.js +0 -4
  56. package/dist/models/TrainingArtifactPayload.d.ts +4 -4
  57. package/dist/models/TrainingArtifactPayload.js +4 -4
  58. package/dist/models/TrainingSession.d.ts +1 -0
  59. package/dist/models/TrainingSession.js +2 -1
  60. package/dist/models/index.d.ts +8 -0
  61. package/dist/models/index.js +8 -0
  62. package/docs/Project.md +2 -0
  63. package/docs/ProjectCreatePayload.md +2 -0
  64. package/docs/ProjectPayload.md +2 -0
  65. package/docs/QacConversationFeedback.md +48 -0
  66. package/docs/QacConversationFeedbackPayload.md +38 -0
  67. package/docs/QacConversationMessage.md +58 -0
  68. package/docs/QacConversationMessagePayload.md +46 -0
  69. package/docs/QacConversationThread.md +62 -0
  70. package/docs/QacConversationThreadPayload.md +46 -0
  71. package/docs/QacConversationThreadWithMessages.md +36 -0
  72. package/docs/QacConversationTokenUsage.md +38 -0
  73. package/docs/SuiteTree.md +0 -2
  74. package/docs/TrainingArtifactPayload.md +2 -2
  75. package/package.json +1 -1
  76. package/src/models/Project.ts +8 -0
  77. package/src/models/ProjectCreatePayload.ts +8 -0
  78. package/src/models/ProjectPayload.ts +8 -0
  79. package/src/models/QacConversationFeedback.ts +155 -0
  80. package/src/models/QacConversationFeedbackPayload.ts +104 -0
  81. package/src/models/QacConversationMessage.ts +222 -0
  82. package/src/models/QacConversationMessagePayload.ts +136 -0
  83. package/src/models/QacConversationThread.ts +203 -0
  84. package/src/models/QacConversationThreadPayload.ts +127 -0
  85. package/src/models/QacConversationThreadWithMessages.ts +88 -0
  86. package/src/models/QacConversationTokenUsage.ts +81 -0
  87. package/src/models/SuiteTree.ts +0 -9
  88. package/src/models/TrainingArtifactPayload.ts +8 -8
  89. package/src/models/TrainingSession.ts +2 -1
  90. package/src/models/index.ts +8 -0
@@ -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,113 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * TC API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2.3.1
9
+ * Contact: support@testcollab.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.QacConversationMessageStatusEnum = exports.QacConversationMessageRoleEnum = exports.QacConversationMessageAuthorTypeEnum = void 0;
17
+ exports.instanceOfQacConversationMessage = instanceOfQacConversationMessage;
18
+ exports.QacConversationMessageFromJSON = QacConversationMessageFromJSON;
19
+ exports.QacConversationMessageFromJSONTyped = QacConversationMessageFromJSONTyped;
20
+ exports.QacConversationMessageToJSON = QacConversationMessageToJSON;
21
+ exports.QacConversationMessageToJSONTyped = QacConversationMessageToJSONTyped;
22
+ const UserMinified_1 = require("./UserMinified");
23
+ const QacConversationTokenUsage_1 = require("./QacConversationTokenUsage");
24
+ const Upload_1 = require("./Upload");
25
+ /**
26
+ * @export
27
+ */
28
+ exports.QacConversationMessageAuthorTypeEnum = {
29
+ User: 'user',
30
+ Copilot: 'copilot',
31
+ System: 'system'
32
+ };
33
+ /**
34
+ * @export
35
+ */
36
+ exports.QacConversationMessageRoleEnum = {
37
+ User: 'user',
38
+ Assistant: 'assistant',
39
+ System: 'system'
40
+ };
41
+ /**
42
+ * @export
43
+ */
44
+ exports.QacConversationMessageStatusEnum = {
45
+ Queued: 'queued',
46
+ InProgress: 'in_progress',
47
+ Completed: 'completed',
48
+ Error: 'error'
49
+ };
50
+ /**
51
+ * Check if a given object implements the QacConversationMessage interface.
52
+ */
53
+ function instanceOfQacConversationMessage(value) {
54
+ if (!('id' in value) || value['id'] === undefined)
55
+ return false;
56
+ if (!('thread' in value) || value['thread'] === undefined)
57
+ return false;
58
+ if (!('authorType' in value) || value['authorType'] === undefined)
59
+ return false;
60
+ if (!('content' in value) || value['content'] === undefined)
61
+ return false;
62
+ if (!('status' in value) || value['status'] === undefined)
63
+ return false;
64
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
65
+ return false;
66
+ return true;
67
+ }
68
+ function QacConversationMessageFromJSON(json) {
69
+ return QacConversationMessageFromJSONTyped(json, false);
70
+ }
71
+ function QacConversationMessageFromJSONTyped(json, ignoreDiscriminator) {
72
+ if (json == null) {
73
+ return json;
74
+ }
75
+ return {
76
+ 'id': json['id'],
77
+ 'thread': json['thread'],
78
+ 'authorType': json['author_type'],
79
+ 'author': json['author'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['author']),
80
+ 'role': json['role'] == null ? undefined : json['role'],
81
+ 'content': json['content'],
82
+ 'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
83
+ 'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(Upload_1.UploadFromJSON)),
84
+ 'status': json['status'],
85
+ 'errorReason': json['error_reason'] == null ? undefined : json['error_reason'],
86
+ 'tokenUsage': json['token_usage'] == null ? undefined : (0, QacConversationTokenUsage_1.QacConversationTokenUsageFromJSON)(json['token_usage']),
87
+ 'createdAt': json['created_at'],
88
+ 'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
89
+ };
90
+ }
91
+ function QacConversationMessageToJSON(json) {
92
+ return QacConversationMessageToJSONTyped(json, false);
93
+ }
94
+ function QacConversationMessageToJSONTyped(value, ignoreDiscriminator = false) {
95
+ if (value == null) {
96
+ return value;
97
+ }
98
+ return {
99
+ 'id': value['id'],
100
+ 'thread': value['thread'],
101
+ 'author_type': value['authorType'],
102
+ 'author': (0, UserMinified_1.UserMinifiedToJSON)(value['author']),
103
+ 'role': value['role'],
104
+ 'content': value['content'],
105
+ 'content_html': value['contentHtml'],
106
+ 'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(Upload_1.UploadToJSON)),
107
+ 'status': value['status'],
108
+ 'error_reason': value['errorReason'],
109
+ 'token_usage': (0, QacConversationTokenUsage_1.QacConversationTokenUsageToJSON)(value['tokenUsage']),
110
+ 'created_at': value['createdAt'],
111
+ 'updated_at': value['updatedAt'],
112
+ };
113
+ }
@@ -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;
@@ -0,0 +1,79 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * TC API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2.3.1
9
+ * Contact: support@testcollab.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.QacConversationMessagePayloadRoleEnum = exports.QacConversationMessagePayloadAuthorTypeEnum = void 0;
17
+ exports.instanceOfQacConversationMessagePayload = instanceOfQacConversationMessagePayload;
18
+ exports.QacConversationMessagePayloadFromJSON = QacConversationMessagePayloadFromJSON;
19
+ exports.QacConversationMessagePayloadFromJSONTyped = QacConversationMessagePayloadFromJSONTyped;
20
+ exports.QacConversationMessagePayloadToJSON = QacConversationMessagePayloadToJSON;
21
+ exports.QacConversationMessagePayloadToJSONTyped = QacConversationMessagePayloadToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.QacConversationMessagePayloadAuthorTypeEnum = {
26
+ User: 'user',
27
+ Copilot: 'copilot',
28
+ System: 'system'
29
+ };
30
+ /**
31
+ * @export
32
+ */
33
+ exports.QacConversationMessagePayloadRoleEnum = {
34
+ User: 'user',
35
+ Assistant: 'assistant',
36
+ System: 'system'
37
+ };
38
+ /**
39
+ * Check if a given object implements the QacConversationMessagePayload interface.
40
+ */
41
+ function instanceOfQacConversationMessagePayload(value) {
42
+ if (!('content' in value) || value['content'] === undefined)
43
+ return false;
44
+ return true;
45
+ }
46
+ function QacConversationMessagePayloadFromJSON(json) {
47
+ return QacConversationMessagePayloadFromJSONTyped(json, false);
48
+ }
49
+ function QacConversationMessagePayloadFromJSONTyped(json, ignoreDiscriminator) {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+ 'thread': json['thread'] == null ? undefined : json['thread'],
55
+ 'authorType': json['author_type'] == null ? undefined : json['author_type'],
56
+ 'role': json['role'] == null ? undefined : json['role'],
57
+ 'content': json['content'],
58
+ 'contentHtml': json['content_html'] == null ? undefined : json['content_html'],
59
+ 'attachments': json['attachments'] == null ? undefined : json['attachments'],
60
+ 'metadata': json['metadata'] == null ? undefined : json['metadata'],
61
+ };
62
+ }
63
+ function QacConversationMessagePayloadToJSON(json) {
64
+ return QacConversationMessagePayloadToJSONTyped(json, false);
65
+ }
66
+ function QacConversationMessagePayloadToJSONTyped(value, ignoreDiscriminator = false) {
67
+ if (value == null) {
68
+ return value;
69
+ }
70
+ return {
71
+ 'thread': value['thread'],
72
+ 'author_type': value['authorType'],
73
+ 'role': value['role'],
74
+ 'content': value['content'],
75
+ 'content_html': value['contentHtml'],
76
+ 'attachments': value['attachments'],
77
+ 'metadata': value['metadata'],
78
+ };
79
+ }
@@ -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,98 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * TC API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2.3.1
9
+ * Contact: support@testcollab.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.QacConversationThreadStatusEnum = void 0;
17
+ exports.instanceOfQacConversationThread = instanceOfQacConversationThread;
18
+ exports.QacConversationThreadFromJSON = QacConversationThreadFromJSON;
19
+ exports.QacConversationThreadFromJSONTyped = QacConversationThreadFromJSONTyped;
20
+ exports.QacConversationThreadToJSON = QacConversationThreadToJSON;
21
+ exports.QacConversationThreadToJSONTyped = QacConversationThreadToJSONTyped;
22
+ const UserMinified_1 = require("./UserMinified");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.QacConversationThreadStatusEnum = {
27
+ Open: 'open',
28
+ Closed: 'closed',
29
+ Archived: 'archived'
30
+ };
31
+ /**
32
+ * Check if a given object implements the QacConversationThread interface.
33
+ */
34
+ function instanceOfQacConversationThread(value) {
35
+ if (!('id' in value) || value['id'] === undefined)
36
+ return false;
37
+ if (!('company' in value) || value['company'] === undefined)
38
+ return false;
39
+ if (!('status' in value) || value['status'] === undefined)
40
+ return false;
41
+ if (!('sourceUrl' in value) || value['sourceUrl'] === undefined)
42
+ return false;
43
+ if (!('messagesCount' in value) || value['messagesCount'] === undefined)
44
+ return false;
45
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
46
+ return false;
47
+ return true;
48
+ }
49
+ function QacConversationThreadFromJSON(json) {
50
+ return QacConversationThreadFromJSONTyped(json, false);
51
+ }
52
+ function QacConversationThreadFromJSONTyped(json, ignoreDiscriminator) {
53
+ if (json == null) {
54
+ return json;
55
+ }
56
+ return {
57
+ 'id': json['id'],
58
+ 'project': json['project'] == null ? undefined : json['project'],
59
+ 'company': json['company'],
60
+ 'createdBy': json['created_by'] == null ? undefined : (0, UserMinified_1.UserMinifiedFromJSON)(json['created_by']),
61
+ 'title': json['title'] == null ? undefined : json['title'],
62
+ 'status': json['status'],
63
+ 'sourceUrl': json['source_url'],
64
+ 'contextRefs': json['context_refs'] == null ? undefined : json['context_refs'],
65
+ 'messagesCount': json['messages_count'],
66
+ 'lastMessageAt': json['last_message_at'] == null ? undefined : json['last_message_at'],
67
+ 'lastMessagePreview': json['last_message_preview'] == null ? undefined : json['last_message_preview'],
68
+ 'pinned': json['pinned'] == null ? undefined : json['pinned'],
69
+ 'metadata': json['metadata'] == null ? undefined : json['metadata'],
70
+ 'createdAt': json['created_at'],
71
+ 'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
72
+ };
73
+ }
74
+ function QacConversationThreadToJSON(json) {
75
+ return QacConversationThreadToJSONTyped(json, false);
76
+ }
77
+ function QacConversationThreadToJSONTyped(value, ignoreDiscriminator = false) {
78
+ if (value == null) {
79
+ return value;
80
+ }
81
+ return {
82
+ 'id': value['id'],
83
+ 'project': value['project'],
84
+ 'company': value['company'],
85
+ 'created_by': (0, UserMinified_1.UserMinifiedToJSON)(value['createdBy']),
86
+ 'title': value['title'],
87
+ 'status': value['status'],
88
+ 'source_url': value['sourceUrl'],
89
+ 'context_refs': value['contextRefs'],
90
+ 'messages_count': value['messagesCount'],
91
+ 'last_message_at': value['lastMessageAt'],
92
+ 'last_message_preview': value['lastMessagePreview'],
93
+ 'pinned': value['pinned'],
94
+ 'metadata': value['metadata'],
95
+ 'created_at': value['createdAt'],
96
+ 'updated_at': value['updatedAt'],
97
+ };
98
+ }