@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
@@ -0,0 +1,93 @@
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
+ import { mapValues } from '../runtime';
16
+ import type { ReleaseReadinessDefectSeverity } from './ReleaseReadinessDefectSeverity';
17
+ import {
18
+ ReleaseReadinessDefectSeverityFromJSON,
19
+ ReleaseReadinessDefectSeverityFromJSONTyped,
20
+ ReleaseReadinessDefectSeverityToJSON,
21
+ ReleaseReadinessDefectSeverityToJSONTyped,
22
+ } from './ReleaseReadinessDefectSeverity';
23
+
24
+ /**
25
+ * Defects linked to test plans in this release, with open count and severity breakdown.
26
+ *
27
+ * @export
28
+ * @interface ReleaseReadinessDefects
29
+ */
30
+ export interface ReleaseReadinessDefects {
31
+ /**
32
+ * Total number of defects (all statuses) across all test plans
33
+ * @type {number}
34
+ * @memberof ReleaseReadinessDefects
35
+ */
36
+ total: number;
37
+ /**
38
+ * Total number of open defects across all test plans
39
+ * @type {number}
40
+ * @memberof ReleaseReadinessDefects
41
+ */
42
+ totalOpen: number;
43
+ /**
44
+ *
45
+ * @type {Array<ReleaseReadinessDefectSeverity>}
46
+ * @memberof ReleaseReadinessDefects
47
+ */
48
+ bySeverity: Array<ReleaseReadinessDefectSeverity>;
49
+ }
50
+
51
+ /**
52
+ * Check if a given object implements the ReleaseReadinessDefects interface.
53
+ */
54
+ export function instanceOfReleaseReadinessDefects(value: object): value is ReleaseReadinessDefects {
55
+ if (!('total' in value) || value['total'] === undefined) return false;
56
+ if (!('totalOpen' in value) || value['totalOpen'] === undefined) return false;
57
+ if (!('bySeverity' in value) || value['bySeverity'] === undefined) return false;
58
+ return true;
59
+ }
60
+
61
+ export function ReleaseReadinessDefectsFromJSON(json: any): ReleaseReadinessDefects {
62
+ return ReleaseReadinessDefectsFromJSONTyped(json, false);
63
+ }
64
+
65
+ export function ReleaseReadinessDefectsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessDefects {
66
+ if (json == null) {
67
+ return json;
68
+ }
69
+ return {
70
+
71
+ 'total': json['total'],
72
+ 'totalOpen': json['total_open'],
73
+ 'bySeverity': ((json['by_severity'] as Array<any>).map(ReleaseReadinessDefectSeverityFromJSON)),
74
+ };
75
+ }
76
+
77
+ export function ReleaseReadinessDefectsToJSON(json: any): ReleaseReadinessDefects {
78
+ return ReleaseReadinessDefectsToJSONTyped(json, false);
79
+ }
80
+
81
+ export function ReleaseReadinessDefectsToJSONTyped(value?: ReleaseReadinessDefects | null, ignoreDiscriminator: boolean = false): any {
82
+ if (value == null) {
83
+ return value;
84
+ }
85
+
86
+ return {
87
+
88
+ 'total': value['total'],
89
+ 'total_open': value['totalOpen'],
90
+ 'by_severity': ((value['bySeverity'] as Array<any>).map(ReleaseReadinessDefectSeverityToJSON)),
91
+ };
92
+ }
93
+
@@ -0,0 +1,85 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Metrics about test evidence (attachments) on executed test cases, particularly for failed executions.
18
+ *
19
+ * @export
20
+ * @interface ReleaseReadinessEvidence
21
+ */
22
+ export interface ReleaseReadinessEvidence {
23
+ /**
24
+ * Total failed executions across the release
25
+ * @type {number}
26
+ * @memberof ReleaseReadinessEvidence
27
+ */
28
+ totalFailed: number;
29
+ /**
30
+ * Failed executions that have at least one attachment
31
+ * @type {number}
32
+ * @memberof ReleaseReadinessEvidence
33
+ */
34
+ failedWithAttachments: number;
35
+ /**
36
+ * Percentage of failed executions with attachments
37
+ * @type {number}
38
+ * @memberof ReleaseReadinessEvidence
39
+ */
40
+ evidenceCoverage: number;
41
+ }
42
+
43
+ /**
44
+ * Check if a given object implements the ReleaseReadinessEvidence interface.
45
+ */
46
+ export function instanceOfReleaseReadinessEvidence(value: object): value is ReleaseReadinessEvidence {
47
+ if (!('totalFailed' in value) || value['totalFailed'] === undefined) return false;
48
+ if (!('failedWithAttachments' in value) || value['failedWithAttachments'] === undefined) return false;
49
+ if (!('evidenceCoverage' in value) || value['evidenceCoverage'] === undefined) return false;
50
+ return true;
51
+ }
52
+
53
+ export function ReleaseReadinessEvidenceFromJSON(json: any): ReleaseReadinessEvidence {
54
+ return ReleaseReadinessEvidenceFromJSONTyped(json, false);
55
+ }
56
+
57
+ export function ReleaseReadinessEvidenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessEvidence {
58
+ if (json == null) {
59
+ return json;
60
+ }
61
+ return {
62
+
63
+ 'totalFailed': json['total_failed'],
64
+ 'failedWithAttachments': json['failed_with_attachments'],
65
+ 'evidenceCoverage': json['evidence_coverage'],
66
+ };
67
+ }
68
+
69
+ export function ReleaseReadinessEvidenceToJSON(json: any): ReleaseReadinessEvidence {
70
+ return ReleaseReadinessEvidenceToJSONTyped(json, false);
71
+ }
72
+
73
+ export function ReleaseReadinessEvidenceToJSONTyped(value?: ReleaseReadinessEvidence | null, ignoreDiscriminator: boolean = false): any {
74
+ if (value == null) {
75
+ return value;
76
+ }
77
+
78
+ return {
79
+
80
+ 'total_failed': value['totalFailed'],
81
+ 'failed_with_attachments': value['failedWithAttachments'],
82
+ 'evidence_coverage': value['evidenceCoverage'],
83
+ };
84
+ }
85
+
@@ -0,0 +1,91 @@
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
+ import { mapValues } from '../runtime';
16
+ import type { ReleaseReadinessRequirementSummary } from './ReleaseReadinessRequirementSummary';
17
+ import {
18
+ ReleaseReadinessRequirementSummaryFromJSON,
19
+ ReleaseReadinessRequirementSummaryFromJSONTyped,
20
+ ReleaseReadinessRequirementSummaryToJSON,
21
+ ReleaseReadinessRequirementSummaryToJSONTyped,
22
+ } from './ReleaseReadinessRequirementSummary';
23
+ import type { ReleaseReadinessRequirementItem } from './ReleaseReadinessRequirementItem';
24
+ import {
25
+ ReleaseReadinessRequirementItemFromJSON,
26
+ ReleaseReadinessRequirementItemFromJSONTyped,
27
+ ReleaseReadinessRequirementItemToJSON,
28
+ ReleaseReadinessRequirementItemToJSONTyped,
29
+ } from './ReleaseReadinessRequirementItem';
30
+
31
+ /**
32
+ * Requirement coverage analysis for the release. Shows how well the requirements linked to this release are covered by test execution.
33
+ *
34
+ * @export
35
+ * @interface ReleaseReadinessRequirementCoverage
36
+ */
37
+ export interface ReleaseReadinessRequirementCoverage {
38
+ /**
39
+ *
40
+ * @type {ReleaseReadinessRequirementSummary}
41
+ * @memberof ReleaseReadinessRequirementCoverage
42
+ */
43
+ summary: ReleaseReadinessRequirementSummary;
44
+ /**
45
+ *
46
+ * @type {Array<ReleaseReadinessRequirementItem>}
47
+ * @memberof ReleaseReadinessRequirementCoverage
48
+ */
49
+ items: Array<ReleaseReadinessRequirementItem>;
50
+ }
51
+
52
+ /**
53
+ * Check if a given object implements the ReleaseReadinessRequirementCoverage interface.
54
+ */
55
+ export function instanceOfReleaseReadinessRequirementCoverage(value: object): value is ReleaseReadinessRequirementCoverage {
56
+ if (!('summary' in value) || value['summary'] === undefined) return false;
57
+ if (!('items' in value) || value['items'] === undefined) return false;
58
+ return true;
59
+ }
60
+
61
+ export function ReleaseReadinessRequirementCoverageFromJSON(json: any): ReleaseReadinessRequirementCoverage {
62
+ return ReleaseReadinessRequirementCoverageFromJSONTyped(json, false);
63
+ }
64
+
65
+ export function ReleaseReadinessRequirementCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementCoverage {
66
+ if (json == null) {
67
+ return json;
68
+ }
69
+ return {
70
+
71
+ 'summary': json['summary'],
72
+ 'items': ((json['items'] as Array<any>).map(ReleaseReadinessRequirementItemFromJSON)),
73
+ };
74
+ }
75
+
76
+ export function ReleaseReadinessRequirementCoverageToJSON(json: any): ReleaseReadinessRequirementCoverage {
77
+ return ReleaseReadinessRequirementCoverageToJSONTyped(json, false);
78
+ }
79
+
80
+ export function ReleaseReadinessRequirementCoverageToJSONTyped(value?: ReleaseReadinessRequirementCoverage | null, ignoreDiscriminator: boolean = false): any {
81
+ if (value == null) {
82
+ return value;
83
+ }
84
+
85
+ return {
86
+
87
+ 'summary': value['summary'],
88
+ 'items': ((value['items'] as Array<any>).map(ReleaseReadinessRequirementItemToJSON)),
89
+ };
90
+ }
91
+
@@ -0,0 +1,153 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Coverage data for a single requirement associated with the release.
18
+ *
19
+ * @export
20
+ * @interface ReleaseReadinessRequirementItem
21
+ */
22
+ export interface ReleaseReadinessRequirementItem {
23
+ /**
24
+ *
25
+ * @type {number}
26
+ * @memberof ReleaseReadinessRequirementItem
27
+ */
28
+ requirementId: number;
29
+ /**
30
+ * Human-readable requirement identifier
31
+ * @type {string}
32
+ * @memberof ReleaseReadinessRequirementItem
33
+ */
34
+ requirementKey: string;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof ReleaseReadinessRequirementItem
39
+ */
40
+ title: string;
41
+ /**
42
+ * Total test cases linked to this requirement (across all projects)
43
+ * @type {number}
44
+ * @memberof ReleaseReadinessRequirementItem
45
+ */
46
+ totalLinkedCases: number;
47
+ /**
48
+ * Number of linked test cases that appear in this release's test plans
49
+ * @type {number}
50
+ * @memberof ReleaseReadinessRequirementItem
51
+ */
52
+ casesInRelease: number;
53
+ /**
54
+ * Number of cases_in_release that have been executed
55
+ * @type {number}
56
+ * @memberof ReleaseReadinessRequirementItem
57
+ */
58
+ executed: number;
59
+ /**
60
+ *
61
+ * @type {number}
62
+ * @memberof ReleaseReadinessRequirementItem
63
+ */
64
+ passed: number;
65
+ /**
66
+ *
67
+ * @type {number}
68
+ * @memberof ReleaseReadinessRequirementItem
69
+ */
70
+ failed: number;
71
+ /**
72
+ * fully_covered = all cases_in_release passed, partially_covered = some executed but not all passed, not_covered = none executed, no_cases = no linked test cases in the release
73
+ *
74
+ * @type {string}
75
+ * @memberof ReleaseReadinessRequirementItem
76
+ */
77
+ coverageStatus: ReleaseReadinessRequirementItemCoverageStatusEnum;
78
+ }
79
+
80
+
81
+ /**
82
+ * @export
83
+ */
84
+ export const ReleaseReadinessRequirementItemCoverageStatusEnum = {
85
+ FullyCovered: 'fully_covered',
86
+ PartiallyCovered: 'partially_covered',
87
+ NotCovered: 'not_covered',
88
+ NoCases: 'no_cases'
89
+ } as const;
90
+ export type ReleaseReadinessRequirementItemCoverageStatusEnum = typeof ReleaseReadinessRequirementItemCoverageStatusEnum[keyof typeof ReleaseReadinessRequirementItemCoverageStatusEnum];
91
+
92
+
93
+ /**
94
+ * Check if a given object implements the ReleaseReadinessRequirementItem interface.
95
+ */
96
+ export function instanceOfReleaseReadinessRequirementItem(value: object): value is ReleaseReadinessRequirementItem {
97
+ if (!('requirementId' in value) || value['requirementId'] === undefined) return false;
98
+ if (!('requirementKey' in value) || value['requirementKey'] === undefined) return false;
99
+ if (!('title' in value) || value['title'] === undefined) return false;
100
+ if (!('totalLinkedCases' in value) || value['totalLinkedCases'] === undefined) return false;
101
+ if (!('casesInRelease' in value) || value['casesInRelease'] === undefined) return false;
102
+ if (!('executed' in value) || value['executed'] === undefined) return false;
103
+ if (!('passed' in value) || value['passed'] === undefined) return false;
104
+ if (!('failed' in value) || value['failed'] === undefined) return false;
105
+ if (!('coverageStatus' in value) || value['coverageStatus'] === undefined) return false;
106
+ return true;
107
+ }
108
+
109
+ export function ReleaseReadinessRequirementItemFromJSON(json: any): ReleaseReadinessRequirementItem {
110
+ return ReleaseReadinessRequirementItemFromJSONTyped(json, false);
111
+ }
112
+
113
+ export function ReleaseReadinessRequirementItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementItem {
114
+ if (json == null) {
115
+ return json;
116
+ }
117
+ return {
118
+
119
+ 'requirementId': json['requirement_id'],
120
+ 'requirementKey': json['requirement_key'],
121
+ 'title': json['title'],
122
+ 'totalLinkedCases': json['total_linked_cases'],
123
+ 'casesInRelease': json['cases_in_release'],
124
+ 'executed': json['executed'],
125
+ 'passed': json['passed'],
126
+ 'failed': json['failed'],
127
+ 'coverageStatus': json['coverage_status'],
128
+ };
129
+ }
130
+
131
+ export function ReleaseReadinessRequirementItemToJSON(json: any): ReleaseReadinessRequirementItem {
132
+ return ReleaseReadinessRequirementItemToJSONTyped(json, false);
133
+ }
134
+
135
+ export function ReleaseReadinessRequirementItemToJSONTyped(value?: ReleaseReadinessRequirementItem | null, ignoreDiscriminator: boolean = false): any {
136
+ if (value == null) {
137
+ return value;
138
+ }
139
+
140
+ return {
141
+
142
+ 'requirement_id': value['requirementId'],
143
+ 'requirement_key': value['requirementKey'],
144
+ 'title': value['title'],
145
+ 'total_linked_cases': value['totalLinkedCases'],
146
+ 'cases_in_release': value['casesInRelease'],
147
+ 'executed': value['executed'],
148
+ 'passed': value['passed'],
149
+ 'failed': value['failed'],
150
+ 'coverage_status': value['coverageStatus'],
151
+ };
152
+ }
153
+
@@ -0,0 +1,103 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Summary statistics for requirement coverage within the release.
18
+ *
19
+ * @export
20
+ * @interface ReleaseReadinessRequirementSummary
21
+ */
22
+ export interface ReleaseReadinessRequirementSummary {
23
+ /**
24
+ * Total number of requirements linked to this release
25
+ * @type {number}
26
+ * @memberof ReleaseReadinessRequirementSummary
27
+ */
28
+ total: number;
29
+ /**
30
+ * Requirements where all linked test cases in the release passed
31
+ * @type {number}
32
+ * @memberof ReleaseReadinessRequirementSummary
33
+ */
34
+ fullyCovered: number;
35
+ /**
36
+ * Requirements where some test cases were executed but not all passed
37
+ * @type {number}
38
+ * @memberof ReleaseReadinessRequirementSummary
39
+ */
40
+ partiallyCovered: number;
41
+ /**
42
+ * Requirements where no linked test cases were executed
43
+ * @type {number}
44
+ * @memberof ReleaseReadinessRequirementSummary
45
+ */
46
+ notCovered: number;
47
+ /**
48
+ * Percentage of fully covered requirements out of total
49
+ * @type {number}
50
+ * @memberof ReleaseReadinessRequirementSummary
51
+ */
52
+ coverageRate: number;
53
+ }
54
+
55
+ /**
56
+ * Check if a given object implements the ReleaseReadinessRequirementSummary interface.
57
+ */
58
+ export function instanceOfReleaseReadinessRequirementSummary(value: object): value is ReleaseReadinessRequirementSummary {
59
+ if (!('total' in value) || value['total'] === undefined) return false;
60
+ if (!('fullyCovered' in value) || value['fullyCovered'] === undefined) return false;
61
+ if (!('partiallyCovered' in value) || value['partiallyCovered'] === undefined) return false;
62
+ if (!('notCovered' in value) || value['notCovered'] === undefined) return false;
63
+ if (!('coverageRate' in value) || value['coverageRate'] === undefined) return false;
64
+ return true;
65
+ }
66
+
67
+ export function ReleaseReadinessRequirementSummaryFromJSON(json: any): ReleaseReadinessRequirementSummary {
68
+ return ReleaseReadinessRequirementSummaryFromJSONTyped(json, false);
69
+ }
70
+
71
+ export function ReleaseReadinessRequirementSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessRequirementSummary {
72
+ if (json == null) {
73
+ return json;
74
+ }
75
+ return {
76
+
77
+ 'total': json['total'],
78
+ 'fullyCovered': json['fully_covered'],
79
+ 'partiallyCovered': json['partially_covered'],
80
+ 'notCovered': json['not_covered'],
81
+ 'coverageRate': json['coverage_rate'],
82
+ };
83
+ }
84
+
85
+ export function ReleaseReadinessRequirementSummaryToJSON(json: any): ReleaseReadinessRequirementSummary {
86
+ return ReleaseReadinessRequirementSummaryToJSONTyped(json, false);
87
+ }
88
+
89
+ export function ReleaseReadinessRequirementSummaryToJSONTyped(value?: ReleaseReadinessRequirementSummary | null, ignoreDiscriminator: boolean = false): any {
90
+ if (value == null) {
91
+ return value;
92
+ }
93
+
94
+ return {
95
+
96
+ 'total': value['total'],
97
+ 'fully_covered': value['fullyCovered'],
98
+ 'partially_covered': value['partiallyCovered'],
99
+ 'not_covered': value['notCovered'],
100
+ 'coverage_rate': value['coverageRate'],
101
+ };
102
+ }
103
+
@@ -0,0 +1,124 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Aggregated execution results across all test plans in the release, using the latest run (regression) of each test plan.
18
+ *
19
+ * @export
20
+ * @interface ReleaseReadinessSummary
21
+ */
22
+ export interface ReleaseReadinessSummary {
23
+ [key: string]: number | any;
24
+ /**
25
+ * Total number of test case executions across all plans
26
+ * @type {number}
27
+ * @memberof ReleaseReadinessSummary
28
+ */
29
+ total: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ReleaseReadinessSummary
34
+ */
35
+ passed: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof ReleaseReadinessSummary
40
+ */
41
+ failed: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof ReleaseReadinessSummary
46
+ */
47
+ blocked: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof ReleaseReadinessSummary
52
+ */
53
+ skipped: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof ReleaseReadinessSummary
58
+ */
59
+ unexecuted: number;
60
+ /**
61
+ * Percentage of passed out of total (excluding unexecuted)
62
+ * @type {number}
63
+ * @memberof ReleaseReadinessSummary
64
+ */
65
+ passRate: number;
66
+ }
67
+
68
+ /**
69
+ * Check if a given object implements the ReleaseReadinessSummary interface.
70
+ */
71
+ export function instanceOfReleaseReadinessSummary(value: object): value is ReleaseReadinessSummary {
72
+ if (!('total' in value) || value['total'] === undefined) return false;
73
+ if (!('passed' in value) || value['passed'] === undefined) return false;
74
+ if (!('failed' in value) || value['failed'] === undefined) return false;
75
+ if (!('blocked' in value) || value['blocked'] === undefined) return false;
76
+ if (!('skipped' in value) || value['skipped'] === undefined) return false;
77
+ if (!('unexecuted' in value) || value['unexecuted'] === undefined) return false;
78
+ if (!('passRate' in value) || value['passRate'] === undefined) return false;
79
+ return true;
80
+ }
81
+
82
+ export function ReleaseReadinessSummaryFromJSON(json: any): ReleaseReadinessSummary {
83
+ return ReleaseReadinessSummaryFromJSONTyped(json, false);
84
+ }
85
+
86
+ export function ReleaseReadinessSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleaseReadinessSummary {
87
+ if (json == null) {
88
+ return json;
89
+ }
90
+ return {
91
+
92
+ ...json,
93
+ 'total': json['total'],
94
+ 'passed': json['passed'],
95
+ 'failed': json['failed'],
96
+ 'blocked': json['blocked'],
97
+ 'skipped': json['skipped'],
98
+ 'unexecuted': json['unexecuted'],
99
+ 'passRate': json['pass_rate'],
100
+ };
101
+ }
102
+
103
+ export function ReleaseReadinessSummaryToJSON(json: any): ReleaseReadinessSummary {
104
+ return ReleaseReadinessSummaryToJSONTyped(json, false);
105
+ }
106
+
107
+ export function ReleaseReadinessSummaryToJSONTyped(value?: ReleaseReadinessSummary | null, ignoreDiscriminator: boolean = false): any {
108
+ if (value == null) {
109
+ return value;
110
+ }
111
+
112
+ return {
113
+
114
+ ...value,
115
+ 'total': value['total'],
116
+ 'passed': value['passed'],
117
+ 'failed': value['failed'],
118
+ 'blocked': value['blocked'],
119
+ 'skipped': value['skipped'],
120
+ 'unexecuted': value['unexecuted'],
121
+ 'pass_rate': value['passRate'],
122
+ };
123
+ }
124
+