@testcollab/sdk 3.10.0 → 3.12.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 (198) hide show
  1. package/.openapi-generator/FILES +46 -0
  2. package/dist/apis/ProjectsApi.d.ts +5 -5
  3. package/dist/apis/ProjectsApi.js +1 -1
  4. package/dist/apis/ReleasesApi.d.ts +280 -0
  5. package/dist/apis/ReleasesApi.js +379 -0
  6. package/dist/apis/index.d.ts +1 -0
  7. package/dist/apis/index.js +1 -0
  8. package/dist/esm/apis/ProjectsApi.d.ts +5 -5
  9. package/dist/esm/apis/ProjectsApi.js +2 -2
  10. package/dist/esm/apis/ReleasesApi.d.ts +280 -0
  11. package/dist/esm/apis/ReleasesApi.js +375 -0
  12. package/dist/esm/apis/index.d.ts +1 -0
  13. package/dist/esm/apis/index.js +1 -0
  14. package/dist/esm/models/Activity.d.ts +9 -0
  15. package/dist/esm/models/Activity.js +6 -1
  16. package/dist/esm/models/ActivityAuditInfo.d.ts +44 -0
  17. package/dist/esm/models/ActivityAuditInfo.js +45 -0
  18. package/dist/esm/models/ProjectListItem.d.ts +93 -0
  19. package/dist/esm/models/ProjectListItem.js +72 -0
  20. package/dist/esm/models/Release.d.ts +131 -0
  21. package/dist/esm/models/Release.js +95 -0
  22. package/dist/esm/models/ReleaseGoNoGoThreshold.d.ts +45 -0
  23. package/dist/esm/models/ReleaseGoNoGoThreshold.js +45 -0
  24. package/dist/esm/models/ReleaseMinified.d.ts +67 -0
  25. package/dist/esm/models/ReleaseMinified.js +65 -0
  26. package/dist/esm/models/ReleasePayload.d.ts +98 -0
  27. package/dist/esm/models/ReleasePayload.js +75 -0
  28. package/dist/esm/models/ReleaseReadiness.d.ts +106 -0
  29. package/dist/esm/models/ReleaseReadiness.js +79 -0
  30. package/dist/esm/models/ReleaseReadinessComparison.d.ts +52 -0
  31. package/dist/esm/models/ReleaseReadinessComparison.js +47 -0
  32. package/dist/esm/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
  33. package/dist/esm/models/ReleaseReadinessConfigurationCoverage.js +71 -0
  34. package/dist/esm/models/ReleaseReadinessCoverageItem.d.ts +75 -0
  35. package/dist/esm/models/ReleaseReadinessCoverageItem.js +65 -0
  36. package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
  37. package/dist/esm/models/ReleaseReadinessCustomFieldCoverage.js +75 -0
  38. package/dist/esm/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
  39. package/dist/esm/models/ReleaseReadinessCustomFieldGroup.js +69 -0
  40. package/dist/esm/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
  41. package/dist/esm/models/ReleaseReadinessDefectSeverity.js +47 -0
  42. package/dist/esm/models/ReleaseReadinessDefects.d.ts +46 -0
  43. package/dist/esm/models/ReleaseReadinessDefects.js +52 -0
  44. package/dist/esm/models/ReleaseReadinessEvidence.d.ts +45 -0
  45. package/dist/esm/models/ReleaseReadinessEvidence.js +51 -0
  46. package/dist/esm/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
  47. package/dist/esm/models/ReleaseReadinessRequirementCoverage.js +48 -0
  48. package/dist/esm/models/ReleaseReadinessRequirementItem.d.ts +92 -0
  49. package/dist/esm/models/ReleaseReadinessRequirementItem.js +84 -0
  50. package/dist/esm/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
  51. package/dist/esm/models/ReleaseReadinessRequirementSummary.js +59 -0
  52. package/dist/esm/models/ReleaseReadinessSummary.d.ts +70 -0
  53. package/dist/esm/models/ReleaseReadinessSummary.js +51 -0
  54. package/dist/esm/models/ReleaseReadinessTestPlan.d.ts +69 -0
  55. package/dist/esm/models/ReleaseReadinessTestPlan.js +68 -0
  56. package/dist/esm/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
  57. package/dist/esm/models/ReleaseReadinessTestPlanRun.js +51 -0
  58. package/dist/esm/models/ReleaseReadinessVerdict.d.ts +50 -0
  59. package/dist/esm/models/ReleaseReadinessVerdict.js +56 -0
  60. package/dist/esm/models/StepWiseResult.d.ts +6 -0
  61. package/dist/esm/models/StepWiseResult.js +2 -0
  62. package/dist/esm/models/TestDatasetWiseResult.d.ts +6 -0
  63. package/dist/esm/models/TestDatasetWiseResult.js +2 -0
  64. package/dist/esm/models/TestPlan.d.ts +7 -0
  65. package/dist/esm/models/TestPlan.js +2 -0
  66. package/dist/esm/models/TestPlanBulkActionPayload.d.ts +6 -0
  67. package/dist/esm/models/TestPlanBulkActionPayload.js +2 -0
  68. package/dist/esm/models/TestPlanPayload.d.ts +6 -0
  69. package/dist/esm/models/TestPlanPayload.js +2 -0
  70. package/dist/esm/models/TraceabilityMatrixPayload.d.ts +7 -0
  71. package/dist/esm/models/TraceabilityMatrixPayload.js +2 -0
  72. package/dist/esm/models/index.d.ts +22 -0
  73. package/dist/esm/models/index.js +22 -0
  74. package/dist/models/Activity.d.ts +9 -0
  75. package/dist/models/Activity.js +6 -1
  76. package/dist/models/ActivityAuditInfo.d.ts +44 -0
  77. package/dist/models/ActivityAuditInfo.js +52 -0
  78. package/dist/models/ProjectListItem.d.ts +93 -0
  79. package/dist/models/ProjectListItem.js +79 -0
  80. package/dist/models/Release.d.ts +131 -0
  81. package/dist/models/Release.js +103 -0
  82. package/dist/models/ReleaseGoNoGoThreshold.d.ts +45 -0
  83. package/dist/models/ReleaseGoNoGoThreshold.js +52 -0
  84. package/dist/models/ReleaseMinified.d.ts +67 -0
  85. package/dist/models/ReleaseMinified.js +73 -0
  86. package/dist/models/ReleasePayload.d.ts +98 -0
  87. package/dist/models/ReleasePayload.js +83 -0
  88. package/dist/models/ReleaseReadiness.d.ts +106 -0
  89. package/dist/models/ReleaseReadiness.js +86 -0
  90. package/dist/models/ReleaseReadinessComparison.d.ts +52 -0
  91. package/dist/models/ReleaseReadinessComparison.js +54 -0
  92. package/dist/models/ReleaseReadinessConfigurationCoverage.d.ts +84 -0
  93. package/dist/models/ReleaseReadinessConfigurationCoverage.js +78 -0
  94. package/dist/models/ReleaseReadinessCoverageItem.d.ts +75 -0
  95. package/dist/models/ReleaseReadinessCoverageItem.js +72 -0
  96. package/dist/models/ReleaseReadinessCustomFieldCoverage.d.ts +77 -0
  97. package/dist/models/ReleaseReadinessCustomFieldCoverage.js +83 -0
  98. package/dist/models/ReleaseReadinessCustomFieldGroup.d.ts +75 -0
  99. package/dist/models/ReleaseReadinessCustomFieldGroup.js +76 -0
  100. package/dist/models/ReleaseReadinessDefectSeverity.d.ts +38 -0
  101. package/dist/models/ReleaseReadinessDefectSeverity.js +54 -0
  102. package/dist/models/ReleaseReadinessDefects.d.ts +46 -0
  103. package/dist/models/ReleaseReadinessDefects.js +59 -0
  104. package/dist/models/ReleaseReadinessEvidence.d.ts +45 -0
  105. package/dist/models/ReleaseReadinessEvidence.js +58 -0
  106. package/dist/models/ReleaseReadinessRequirementCoverage.d.ts +41 -0
  107. package/dist/models/ReleaseReadinessRequirementCoverage.js +55 -0
  108. package/dist/models/ReleaseReadinessRequirementItem.d.ts +92 -0
  109. package/dist/models/ReleaseReadinessRequirementItem.js +92 -0
  110. package/dist/models/ReleaseReadinessRequirementSummary.d.ts +57 -0
  111. package/dist/models/ReleaseReadinessRequirementSummary.js +66 -0
  112. package/dist/models/ReleaseReadinessSummary.d.ts +70 -0
  113. package/dist/models/ReleaseReadinessSummary.js +58 -0
  114. package/dist/models/ReleaseReadinessTestPlan.d.ts +69 -0
  115. package/dist/models/ReleaseReadinessTestPlan.js +76 -0
  116. package/dist/models/ReleaseReadinessTestPlanRun.d.ts +51 -0
  117. package/dist/models/ReleaseReadinessTestPlanRun.js +58 -0
  118. package/dist/models/ReleaseReadinessVerdict.d.ts +50 -0
  119. package/dist/models/ReleaseReadinessVerdict.js +64 -0
  120. package/dist/models/StepWiseResult.d.ts +6 -0
  121. package/dist/models/StepWiseResult.js +2 -0
  122. package/dist/models/TestDatasetWiseResult.d.ts +6 -0
  123. package/dist/models/TestDatasetWiseResult.js +2 -0
  124. package/dist/models/TestPlan.d.ts +7 -0
  125. package/dist/models/TestPlan.js +2 -0
  126. package/dist/models/TestPlanBulkActionPayload.d.ts +6 -0
  127. package/dist/models/TestPlanBulkActionPayload.js +2 -0
  128. package/dist/models/TestPlanPayload.d.ts +6 -0
  129. package/dist/models/TestPlanPayload.js +2 -0
  130. package/dist/models/TraceabilityMatrixPayload.d.ts +7 -0
  131. package/dist/models/TraceabilityMatrixPayload.js +2 -0
  132. package/dist/models/index.d.ts +22 -0
  133. package/dist/models/index.js +22 -0
  134. package/docs/Activity.md +2 -0
  135. package/docs/ActivityAuditInfo.md +39 -0
  136. package/docs/ProjectListItem.md +54 -0
  137. package/docs/ProjectsApi.md +2 -2
  138. package/docs/Release.md +62 -0
  139. package/docs/ReleaseGoNoGoThreshold.md +39 -0
  140. package/docs/ReleaseMinified.md +42 -0
  141. package/docs/ReleasePayload.md +52 -0
  142. package/docs/ReleaseReadiness.md +55 -0
  143. package/docs/ReleaseReadinessComparison.md +41 -0
  144. package/docs/ReleaseReadinessConfigurationCoverage.md +51 -0
  145. package/docs/ReleaseReadinessCoverageItem.md +49 -0
  146. package/docs/ReleaseReadinessCustomFieldCoverage.md +43 -0
  147. package/docs/ReleaseReadinessCustomFieldGroup.md +49 -0
  148. package/docs/ReleaseReadinessDefectSeverity.md +36 -0
  149. package/docs/ReleaseReadinessDefects.md +39 -0
  150. package/docs/ReleaseReadinessEvidence.md +39 -0
  151. package/docs/ReleaseReadinessRequirementCoverage.md +37 -0
  152. package/docs/ReleaseReadinessRequirementItem.md +51 -0
  153. package/docs/ReleaseReadinessRequirementSummary.md +43 -0
  154. package/docs/ReleaseReadinessSummary.md +47 -0
  155. package/docs/ReleaseReadinessTestPlan.md +43 -0
  156. package/docs/ReleaseReadinessTestPlanRun.md +41 -0
  157. package/docs/ReleaseReadinessVerdict.md +37 -0
  158. package/docs/ReleasesApi.md +655 -0
  159. package/docs/StepWiseResult.md +2 -0
  160. package/docs/TestDatasetWiseResult.md +2 -0
  161. package/docs/TestPlan.md +2 -0
  162. package/docs/TestPlanBulkActionPayload.md +2 -0
  163. package/docs/TestPlanPayload.md +2 -0
  164. package/docs/TraceabilityMatrixPayload.md +2 -0
  165. package/package.json +1 -1
  166. package/src/apis/ProjectsApi.ts +8 -5
  167. package/src/apis/ReleasesApi.ts +663 -0
  168. package/src/apis/index.ts +1 -0
  169. package/src/models/Activity.ts +18 -1
  170. package/src/models/ActivityAuditInfo.ts +81 -0
  171. package/src/models/ProjectListItem.ts +158 -0
  172. package/src/models/Release.ts +227 -0
  173. package/src/models/ReleaseGoNoGoThreshold.ts +82 -0
  174. package/src/models/ReleaseMinified.ts +114 -0
  175. package/src/models/ReleasePayload.ts +162 -0
  176. package/src/models/ReleaseReadiness.ts +233 -0
  177. package/src/models/ReleaseReadinessComparison.ts +98 -0
  178. package/src/models/ReleaseReadinessConfigurationCoverage.ts +138 -0
  179. package/src/models/ReleaseReadinessCoverageItem.ts +127 -0
  180. package/src/models/ReleaseReadinessCustomFieldCoverage.ts +133 -0
  181. package/src/models/ReleaseReadinessCustomFieldGroup.ts +129 -0
  182. package/src/models/ReleaseReadinessDefectSeverity.ts +75 -0
  183. package/src/models/ReleaseReadinessDefects.ts +93 -0
  184. package/src/models/ReleaseReadinessEvidence.ts +85 -0
  185. package/src/models/ReleaseReadinessRequirementCoverage.ts +91 -0
  186. package/src/models/ReleaseReadinessRequirementItem.ts +153 -0
  187. package/src/models/ReleaseReadinessRequirementSummary.ts +103 -0
  188. package/src/models/ReleaseReadinessSummary.ts +124 -0
  189. package/src/models/ReleaseReadinessTestPlan.ts +131 -0
  190. package/src/models/ReleaseReadinessTestPlanRun.ts +92 -0
  191. package/src/models/ReleaseReadinessVerdict.ts +90 -0
  192. package/src/models/StepWiseResult.ts +8 -0
  193. package/src/models/TestDatasetWiseResult.ts +8 -0
  194. package/src/models/TestPlan.ts +15 -0
  195. package/src/models/TestPlanBulkActionPayload.ts +8 -0
  196. package/src/models/TestPlanPayload.ts +8 -0
  197. package/src/models/TraceabilityMatrixPayload.ts +9 -0
  198. package/src/models/index.ts +22 -0
@@ -33,6 +33,13 @@ export interface TraceabilityMatrixPayload {
33
33
  * @memberof TraceabilityMatrixPayload
34
34
  */
35
35
  forceRefresh?: boolean;
36
+ /**
37
+ * Optional release ID. When provided, the traceability matrix is filtered to only include test cases that belong to test plans in this release, and only requirements linked to this release.
38
+ *
39
+ * @type {number}
40
+ * @memberof TraceabilityMatrixPayload
41
+ */
42
+ release?: number;
36
43
  }
37
44
  /**
38
45
  * Check if a given object implements the TraceabilityMatrixPayload interface.
@@ -30,6 +30,7 @@ export function TraceabilityMatrixPayloadFromJSONTyped(json, ignoreDiscriminator
30
30
  'filterModel': json['filterModel'] == null ? undefined : json['filterModel'],
31
31
  'project': json['project'],
32
32
  'forceRefresh': json['force_refresh'] == null ? undefined : json['force_refresh'],
33
+ 'release': json['release'] == null ? undefined : json['release'],
33
34
  };
34
35
  }
35
36
  export function TraceabilityMatrixPayloadToJSON(json) {
@@ -43,5 +44,6 @@ export function TraceabilityMatrixPayloadToJSONTyped(value, ignoreDiscriminator
43
44
  'filterModel': value['filterModel'],
44
45
  'project': value['project'],
45
46
  'force_refresh': value['forceRefresh'],
47
+ 'release': value['release'],
46
48
  };
47
49
  }
@@ -1,4 +1,5 @@
1
1
  export * from './Activity';
2
+ export * from './ActivityAuditInfo';
2
3
  export * from './AddNewFolderPayload';
3
4
  export * from './AddRequirementPayload';
4
5
  export * from './AddRequirementPayloadFolder';
@@ -145,6 +146,7 @@ export * from './PreferencePayload';
145
146
  export * from './Project';
146
147
  export * from './ProjectActivity';
147
148
  export * from './ProjectCreatePayload';
149
+ export * from './ProjectListItem';
148
150
  export * from './ProjectMetrics';
149
151
  export * from './ProjectMini';
150
152
  export * from './ProjectMinified';
@@ -171,6 +173,26 @@ export * from './QueueStatus';
171
173
  export * from './QueueUpdatePayload';
172
174
  export * from './RegisteredUser';
173
175
  export * from './RegisteredUserUser';
176
+ export * from './Release';
177
+ export * from './ReleaseGoNoGoThreshold';
178
+ export * from './ReleaseMinified';
179
+ export * from './ReleasePayload';
180
+ export * from './ReleaseReadiness';
181
+ export * from './ReleaseReadinessComparison';
182
+ export * from './ReleaseReadinessConfigurationCoverage';
183
+ export * from './ReleaseReadinessCoverageItem';
184
+ export * from './ReleaseReadinessCustomFieldCoverage';
185
+ export * from './ReleaseReadinessCustomFieldGroup';
186
+ export * from './ReleaseReadinessDefectSeverity';
187
+ export * from './ReleaseReadinessDefects';
188
+ export * from './ReleaseReadinessEvidence';
189
+ export * from './ReleaseReadinessRequirementCoverage';
190
+ export * from './ReleaseReadinessRequirementItem';
191
+ export * from './ReleaseReadinessRequirementSummary';
192
+ export * from './ReleaseReadinessSummary';
193
+ export * from './ReleaseReadinessTestPlan';
194
+ export * from './ReleaseReadinessTestPlanRun';
195
+ export * from './ReleaseReadinessVerdict';
174
196
  export * from './ReportPayload';
175
197
  export * from './ReportResult';
176
198
  export * from './Requirement';
@@ -1,6 +1,7 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  export * from './Activity';
4
+ export * from './ActivityAuditInfo';
4
5
  export * from './AddNewFolderPayload';
5
6
  export * from './AddRequirementPayload';
6
7
  export * from './AddRequirementPayloadFolder';
@@ -147,6 +148,7 @@ export * from './PreferencePayload';
147
148
  export * from './Project';
148
149
  export * from './ProjectActivity';
149
150
  export * from './ProjectCreatePayload';
151
+ export * from './ProjectListItem';
150
152
  export * from './ProjectMetrics';
151
153
  export * from './ProjectMini';
152
154
  export * from './ProjectMinified';
@@ -173,6 +175,26 @@ export * from './QueueStatus';
173
175
  export * from './QueueUpdatePayload';
174
176
  export * from './RegisteredUser';
175
177
  export * from './RegisteredUserUser';
178
+ export * from './Release';
179
+ export * from './ReleaseGoNoGoThreshold';
180
+ export * from './ReleaseMinified';
181
+ export * from './ReleasePayload';
182
+ export * from './ReleaseReadiness';
183
+ export * from './ReleaseReadinessComparison';
184
+ export * from './ReleaseReadinessConfigurationCoverage';
185
+ export * from './ReleaseReadinessCoverageItem';
186
+ export * from './ReleaseReadinessCustomFieldCoverage';
187
+ export * from './ReleaseReadinessCustomFieldGroup';
188
+ export * from './ReleaseReadinessDefectSeverity';
189
+ export * from './ReleaseReadinessDefects';
190
+ export * from './ReleaseReadinessEvidence';
191
+ export * from './ReleaseReadinessRequirementCoverage';
192
+ export * from './ReleaseReadinessRequirementItem';
193
+ export * from './ReleaseReadinessRequirementSummary';
194
+ export * from './ReleaseReadinessSummary';
195
+ export * from './ReleaseReadinessTestPlan';
196
+ export * from './ReleaseReadinessTestPlanRun';
197
+ export * from './ReleaseReadinessVerdict';
176
198
  export * from './ReportPayload';
177
199
  export * from './ReportResult';
178
200
  export * from './Requirement';
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { ProjectMini } from './ProjectMini';
13
13
  import type { User } from './User';
14
+ import type { ActivityAuditInfo } from './ActivityAuditInfo';
14
15
  /**
15
16
  *
16
17
  * @export
@@ -65,6 +66,12 @@ export interface Activity {
65
66
  * @memberof Activity
66
67
  */
67
68
  user: User;
69
+ /**
70
+ *
71
+ * @type {ActivityAuditInfo}
72
+ * @memberof Activity
73
+ */
74
+ auditInfo?: ActivityAuditInfo;
68
75
  /**
69
76
  * Time when the activity was performed
70
77
  * @type {string}
@@ -94,6 +101,8 @@ export declare const ActivityActivityTypeEnum: {
94
101
  readonly FinishedRun: "finished_run";
95
102
  readonly AssigneeChange: "assignee_change";
96
103
  readonly Comment: "comment";
104
+ readonly ReleaseVerdictChange: "release_verdict_change";
105
+ readonly Link: "link";
97
106
  };
98
107
  export type ActivityActivityTypeEnum = typeof ActivityActivityTypeEnum[keyof typeof ActivityActivityTypeEnum];
99
108
  /**
@@ -21,6 +21,7 @@ exports.ActivityToJSON = ActivityToJSON;
21
21
  exports.ActivityToJSONTyped = ActivityToJSONTyped;
22
22
  const ProjectMini_1 = require("./ProjectMini");
23
23
  const User_1 = require("./User");
24
+ const ActivityAuditInfo_1 = require("./ActivityAuditInfo");
24
25
  /**
25
26
  * @export
26
27
  */
@@ -36,7 +37,9 @@ exports.ActivityActivityTypeEnum = {
36
37
  Reopen: 'reopen',
37
38
  FinishedRun: 'finished_run',
38
39
  AssigneeChange: 'assignee_change',
39
- Comment: 'comment'
40
+ Comment: 'comment',
41
+ ReleaseVerdictChange: 'release_verdict_change',
42
+ Link: 'link'
40
43
  };
41
44
  /**
42
45
  * Check if a given object implements the Activity interface.
@@ -70,6 +73,7 @@ function ActivityFromJSONTyped(json, ignoreDiscriminator) {
70
73
  'project': json['project'] == null ? undefined : (0, ProjectMini_1.ProjectMiniFromJSON)(json['project']),
71
74
  'activityType': json['activity_type'],
72
75
  'user': (0, User_1.UserFromJSON)(json['user']),
76
+ 'auditInfo': json['audit_info'] == null ? undefined : (0, ActivityAuditInfo_1.ActivityAuditInfoFromJSON)(json['audit_info']),
73
77
  'createdAt': json['created_at'] == null ? undefined : json['created_at'],
74
78
  'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
75
79
  };
@@ -90,6 +94,7 @@ function ActivityToJSONTyped(value, ignoreDiscriminator = false) {
90
94
  'project': (0, ProjectMini_1.ProjectMiniToJSON)(value['project']),
91
95
  'activity_type': value['activityType'],
92
96
  'user': (0, User_1.UserToJSON)(value['user']),
97
+ 'audit_info': (0, ActivityAuditInfo_1.ActivityAuditInfoToJSON)(value['auditInfo']),
93
98
  'created_at': value['createdAt'],
94
99
  'updated_at': value['updatedAt'],
95
100
  };
@@ -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
+ * Additional metadata for the activity (e.g. release name, old/new verdict)
14
+ * @export
15
+ * @interface ActivityAuditInfo
16
+ */
17
+ export interface ActivityAuditInfo {
18
+ /**
19
+ * Name of the release
20
+ * @type {string}
21
+ * @memberof ActivityAuditInfo
22
+ */
23
+ releaseName?: string;
24
+ /**
25
+ * Previous verdict value
26
+ * @type {string}
27
+ * @memberof ActivityAuditInfo
28
+ */
29
+ oldVerdict?: string;
30
+ /**
31
+ * New verdict value
32
+ * @type {string}
33
+ * @memberof ActivityAuditInfo
34
+ */
35
+ newVerdict?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the ActivityAuditInfo interface.
39
+ */
40
+ export declare function instanceOfActivityAuditInfo(value: object): value is ActivityAuditInfo;
41
+ export declare function ActivityAuditInfoFromJSON(json: any): ActivityAuditInfo;
42
+ export declare function ActivityAuditInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActivityAuditInfo;
43
+ export declare function ActivityAuditInfoToJSON(json: any): ActivityAuditInfo;
44
+ export declare function ActivityAuditInfoToJSONTyped(value?: ActivityAuditInfo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
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.instanceOfActivityAuditInfo = instanceOfActivityAuditInfo;
17
+ exports.ActivityAuditInfoFromJSON = ActivityAuditInfoFromJSON;
18
+ exports.ActivityAuditInfoFromJSONTyped = ActivityAuditInfoFromJSONTyped;
19
+ exports.ActivityAuditInfoToJSON = ActivityAuditInfoToJSON;
20
+ exports.ActivityAuditInfoToJSONTyped = ActivityAuditInfoToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ActivityAuditInfo interface.
23
+ */
24
+ function instanceOfActivityAuditInfo(value) {
25
+ return true;
26
+ }
27
+ function ActivityAuditInfoFromJSON(json) {
28
+ return ActivityAuditInfoFromJSONTyped(json, false);
29
+ }
30
+ function ActivityAuditInfoFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'releaseName': json['release_name'] == null ? undefined : json['release_name'],
36
+ 'oldVerdict': json['old_verdict'] == null ? undefined : json['old_verdict'],
37
+ 'newVerdict': json['new_verdict'] == null ? undefined : json['new_verdict'],
38
+ };
39
+ }
40
+ function ActivityAuditInfoToJSON(json) {
41
+ return ActivityAuditInfoToJSONTyped(json, false);
42
+ }
43
+ function ActivityAuditInfoToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'release_name': value['releaseName'],
49
+ 'old_verdict': value['oldVerdict'],
50
+ 'new_verdict': value['newVerdict'],
51
+ };
52
+ }
@@ -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 { ProjectUserMinified } from './ProjectUserMinified';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ProjectListItem
17
+ */
18
+ export interface ProjectListItem {
19
+ /**
20
+ *
21
+ * @type {number}
22
+ * @memberof ProjectListItem
23
+ */
24
+ id: number;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof ProjectListItem
29
+ */
30
+ name: string;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof ProjectListItem
35
+ */
36
+ description?: string;
37
+ /**
38
+ *
39
+ * @type {boolean}
40
+ * @memberof ProjectListItem
41
+ */
42
+ archived: boolean;
43
+ /**
44
+ *
45
+ * @type {Array<ProjectUserMinified>}
46
+ * @memberof ProjectListItem
47
+ */
48
+ team?: Array<ProjectUserMinified>;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof ProjectListItem
53
+ */
54
+ activity?: string;
55
+ /**
56
+ *
57
+ * @type {string}
58
+ * @memberof ProjectListItem
59
+ */
60
+ createdAt: string;
61
+ /**
62
+ *
63
+ * @type {string}
64
+ * @memberof ProjectListItem
65
+ */
66
+ updatedAt: string;
67
+ /**
68
+ * Indicates that the project is a sample project or not
69
+ * @type {boolean}
70
+ * @memberof ProjectListItem
71
+ */
72
+ isSample?: boolean;
73
+ /**
74
+ * Number of test cases in the project
75
+ * @type {number}
76
+ * @memberof ProjectListItem
77
+ */
78
+ testCaseCount?: number;
79
+ /**
80
+ * Number of active test plans in the project
81
+ * @type {number}
82
+ * @memberof ProjectListItem
83
+ */
84
+ testPlanCount?: number;
85
+ }
86
+ /**
87
+ * Check if a given object implements the ProjectListItem interface.
88
+ */
89
+ export declare function instanceOfProjectListItem(value: object): value is ProjectListItem;
90
+ export declare function ProjectListItemFromJSON(json: any): ProjectListItem;
91
+ export declare function ProjectListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProjectListItem;
92
+ export declare function ProjectListItemToJSON(json: any): ProjectListItem;
93
+ export declare function ProjectListItemToJSONTyped(value?: ProjectListItem | 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.instanceOfProjectListItem = instanceOfProjectListItem;
17
+ exports.ProjectListItemFromJSON = ProjectListItemFromJSON;
18
+ exports.ProjectListItemFromJSONTyped = ProjectListItemFromJSONTyped;
19
+ exports.ProjectListItemToJSON = ProjectListItemToJSON;
20
+ exports.ProjectListItemToJSONTyped = ProjectListItemToJSONTyped;
21
+ const ProjectUserMinified_1 = require("./ProjectUserMinified");
22
+ /**
23
+ * Check if a given object implements the ProjectListItem interface.
24
+ */
25
+ function instanceOfProjectListItem(value) {
26
+ if (!('id' in value) || value['id'] === undefined)
27
+ return false;
28
+ if (!('name' in value) || value['name'] === undefined)
29
+ return false;
30
+ if (!('archived' in value) || value['archived'] === undefined)
31
+ return false;
32
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
33
+ return false;
34
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
35
+ return false;
36
+ return true;
37
+ }
38
+ function ProjectListItemFromJSON(json) {
39
+ return ProjectListItemFromJSONTyped(json, false);
40
+ }
41
+ function ProjectListItemFromJSONTyped(json, ignoreDiscriminator) {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'id': json['id'],
47
+ 'name': json['name'],
48
+ 'description': json['description'] == null ? undefined : json['description'],
49
+ 'archived': json['archived'],
50
+ 'team': json['team'] == null ? undefined : (json['team'].map(ProjectUserMinified_1.ProjectUserMinifiedFromJSON)),
51
+ 'activity': json['activity'] == null ? undefined : json['activity'],
52
+ 'createdAt': json['created_at'],
53
+ 'updatedAt': json['updated_at'],
54
+ 'isSample': json['is_sample'] == null ? undefined : json['is_sample'],
55
+ 'testCaseCount': json['test_case_count'] == null ? undefined : json['test_case_count'],
56
+ 'testPlanCount': json['test_plan_count'] == null ? undefined : json['test_plan_count'],
57
+ };
58
+ }
59
+ function ProjectListItemToJSON(json) {
60
+ return ProjectListItemToJSONTyped(json, false);
61
+ }
62
+ function ProjectListItemToJSONTyped(value, ignoreDiscriminator = false) {
63
+ if (value == null) {
64
+ return value;
65
+ }
66
+ return {
67
+ 'id': value['id'],
68
+ 'name': value['name'],
69
+ 'description': value['description'],
70
+ 'archived': value['archived'],
71
+ 'team': value['team'] == null ? undefined : (value['team'].map(ProjectUserMinified_1.ProjectUserMinifiedToJSON)),
72
+ 'activity': value['activity'],
73
+ 'created_at': value['createdAt'],
74
+ 'updated_at': value['updatedAt'],
75
+ 'is_sample': value['isSample'],
76
+ 'test_case_count': value['testCaseCount'],
77
+ 'test_plan_count': value['testPlanCount'],
78
+ };
79
+ }
@@ -0,0 +1,131 @@
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 { ReleaseGoNoGoThreshold } from './ReleaseGoNoGoThreshold';
13
+ import type { RequirementMinified } from './RequirementMinified';
14
+ import type { UserMinified } from './UserMinified';
15
+ import type { TestPlanMinified } from './TestPlanMinified';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface Release
20
+ */
21
+ export interface Release {
22
+ /**
23
+ *
24
+ * @type {number}
25
+ * @memberof Release
26
+ */
27
+ id: number;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof Release
32
+ */
33
+ name: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof Release
38
+ */
39
+ description?: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof Release
44
+ */
45
+ status: ReleaseStatusEnum;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof Release
50
+ */
51
+ targetDate?: string;
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof Release
56
+ */
57
+ releaseDate?: string;
58
+ /**
59
+ *
60
+ * @type {ReleaseGoNoGoThreshold}
61
+ * @memberof Release
62
+ */
63
+ goNoGoThreshold?: ReleaseGoNoGoThreshold;
64
+ /**
65
+ *
66
+ * @type {boolean}
67
+ * @memberof Release
68
+ */
69
+ isPublic?: boolean;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof Release
74
+ */
75
+ publicToken?: string;
76
+ /**
77
+ *
78
+ * @type {Array<TestPlanMinified>}
79
+ * @memberof Release
80
+ */
81
+ testPlans?: Array<TestPlanMinified>;
82
+ /**
83
+ * Requirements associated with this release
84
+ * @type {Array<RequirementMinified>}
85
+ * @memberof Release
86
+ */
87
+ requirements?: Array<RequirementMinified>;
88
+ /**
89
+ *
90
+ * @type {number}
91
+ * @memberof Release
92
+ */
93
+ project: number;
94
+ /**
95
+ *
96
+ * @type {UserMinified}
97
+ * @memberof Release
98
+ */
99
+ createdBy: UserMinified;
100
+ /**
101
+ *
102
+ * @type {string}
103
+ * @memberof Release
104
+ */
105
+ createdAt: string;
106
+ /**
107
+ *
108
+ * @type {string}
109
+ * @memberof Release
110
+ */
111
+ updatedAt: string;
112
+ }
113
+ /**
114
+ * @export
115
+ */
116
+ export declare const ReleaseStatusEnum: {
117
+ readonly Planned: "planned";
118
+ readonly InProgress: "in_progress";
119
+ readonly Ready: "ready";
120
+ readonly Shipped: "shipped";
121
+ readonly Blocked: "blocked";
122
+ };
123
+ export type ReleaseStatusEnum = typeof ReleaseStatusEnum[keyof typeof ReleaseStatusEnum];
124
+ /**
125
+ * Check if a given object implements the Release interface.
126
+ */
127
+ export declare function instanceOfRelease(value: object): value is Release;
128
+ export declare function ReleaseFromJSON(json: any): Release;
129
+ export declare function ReleaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): Release;
130
+ export declare function ReleaseToJSON(json: any): Release;
131
+ export declare function ReleaseToJSONTyped(value?: Release | null, ignoreDiscriminator?: boolean): any;