@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,663 @@
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
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ Count,
19
+ DefaultResponseError,
20
+ ForbiddenError,
21
+ Release,
22
+ ReleaseMinified,
23
+ ReleasePayload,
24
+ ReleaseReadiness,
25
+ } from '../models/index';
26
+ import {
27
+ CountFromJSON,
28
+ CountToJSON,
29
+ DefaultResponseErrorFromJSON,
30
+ DefaultResponseErrorToJSON,
31
+ ForbiddenErrorFromJSON,
32
+ ForbiddenErrorToJSON,
33
+ ReleaseFromJSON,
34
+ ReleaseToJSON,
35
+ ReleaseMinifiedFromJSON,
36
+ ReleaseMinifiedToJSON,
37
+ ReleasePayloadFromJSON,
38
+ ReleasePayloadToJSON,
39
+ ReleaseReadinessFromJSON,
40
+ ReleaseReadinessToJSON,
41
+ } from '../models/index';
42
+
43
+ export interface AddReleaseRequest {
44
+ releasePayload?: ReleasePayload;
45
+ }
46
+
47
+ export interface CountReleasesRequest {
48
+ project: number;
49
+ status?: CountReleasesStatusEnum;
50
+ }
51
+
52
+ export interface DeleteReleaseRequest {
53
+ id: number;
54
+ project: number;
55
+ }
56
+
57
+ export interface EditReleaseRequest {
58
+ id: number;
59
+ releasePayload?: ReleasePayload;
60
+ }
61
+
62
+ export interface GetReleaseRequest {
63
+ id: number;
64
+ }
65
+
66
+ export interface GetReleaseReadinessRequest {
67
+ id: number;
68
+ }
69
+
70
+ export interface GetReleaseReadinessByTokenRequest {
71
+ token: string;
72
+ }
73
+
74
+ export interface GetReleasesRequest {
75
+ project: number;
76
+ limit?: number;
77
+ start?: number;
78
+ sort?: string;
79
+ filter?: string;
80
+ status?: GetReleasesStatusEnum;
81
+ }
82
+
83
+ /**
84
+ * ReleasesApi - interface
85
+ *
86
+ * @export
87
+ * @interface ReleasesApiInterface
88
+ */
89
+ export interface ReleasesApiInterface {
90
+ /**
91
+ * Creates a new release
92
+ * @summary Create a release
93
+ * @param {ReleasePayload} [releasePayload] Release to create
94
+ * @param {*} [options] Override http request option.
95
+ * @throws {RequiredError}
96
+ * @memberof ReleasesApiInterface
97
+ */
98
+ addReleaseRaw(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
99
+
100
+ /**
101
+ * Creates a new release
102
+ * Create a release
103
+ */
104
+ addRelease(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
105
+
106
+ /**
107
+ * Get count of releases for a specific project
108
+ * @summary Count releases
109
+ * @param {number} project Project ID
110
+ * @param {'planned' | 'in_progress' | 'ready' | 'shipped' | 'blocked'} [status] Filter by release status
111
+ * @param {*} [options] Override http request option.
112
+ * @throws {RequiredError}
113
+ * @memberof ReleasesApiInterface
114
+ */
115
+ countReleasesRaw(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Count>>;
116
+
117
+ /**
118
+ * Get count of releases for a specific project
119
+ * Count releases
120
+ */
121
+ countReleases(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Count>;
122
+
123
+ /**
124
+ * Deletes a specific release. Does not delete associated test plans.
125
+ * @summary Delete a release
126
+ * @param {number} id Release ID
127
+ * @param {number} project Project ID
128
+ * @param {*} [options] Override http request option.
129
+ * @throws {RequiredError}
130
+ * @memberof ReleasesApiInterface
131
+ */
132
+ deleteReleaseRaw(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
133
+
134
+ /**
135
+ * Deletes a specific release. Does not delete associated test plans.
136
+ * Delete a release
137
+ */
138
+ deleteRelease(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
139
+
140
+ /**
141
+ * Edits a specific release
142
+ * @summary Edit a release
143
+ * @param {number} id Release ID
144
+ * @param {ReleasePayload} [releasePayload] Updated release data
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ * @memberof ReleasesApiInterface
148
+ */
149
+ editReleaseRaw(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>>;
150
+
151
+ /**
152
+ * Edits a specific release
153
+ * Edit a release
154
+ */
155
+ editRelease(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified>;
156
+
157
+ /**
158
+ * Get details of a specific release
159
+ * @summary Get release
160
+ * @param {number} id Release ID
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ * @memberof ReleasesApiInterface
164
+ */
165
+ getReleaseRaw(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Release>>;
166
+
167
+ /**
168
+ * Get details of a specific release
169
+ * Get release
170
+ */
171
+ getRelease(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Release>;
172
+
173
+ /**
174
+ * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
175
+ * @summary Get release readiness dashboard data
176
+ * @param {number} id Release ID
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ * @memberof ReleasesApiInterface
180
+ */
181
+ getReleaseReadinessRaw(requestParameters: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
182
+
183
+ /**
184
+ * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
185
+ * Get release readiness dashboard data
186
+ */
187
+ getReleaseReadiness(requestParameters: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
188
+
189
+ /**
190
+ * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
191
+ * @summary Get release readiness by public token
192
+ * @param {string} token Public sharing token for the release
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ * @memberof ReleasesApiInterface
196
+ */
197
+ getReleaseReadinessByTokenRaw(requestParameters: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>>;
198
+
199
+ /**
200
+ * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
201
+ * Get release readiness by public token
202
+ */
203
+ getReleaseReadinessByToken(requestParameters: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness>;
204
+
205
+ /**
206
+ * Get releases for a specific project
207
+ * @summary Get releases
208
+ * @param {number} project Project ID
209
+ * @param {number} [limit] Limit the size of the returned results
210
+ * @param {number} [start] Skip a specific number of entries (for pagination)
211
+ * @param {string} [sort] Sort according to a specific field.
212
+ * @param {string} [filter] Stringified filter object
213
+ * @param {'planned' | 'in_progress' | 'ready' | 'shipped' | 'blocked'} [status] Filter by release status
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ * @memberof ReleasesApiInterface
217
+ */
218
+ getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Release>>>;
219
+
220
+ /**
221
+ * Get releases for a specific project
222
+ * Get releases
223
+ */
224
+ getReleases(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Release>>;
225
+
226
+ }
227
+
228
+ /**
229
+ *
230
+ */
231
+ export class ReleasesApi extends runtime.BaseAPI implements ReleasesApiInterface {
232
+
233
+ /**
234
+ * Creates a new release
235
+ * Create a release
236
+ */
237
+ async addReleaseRaw(requestParameters: AddReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>> {
238
+ const queryParameters: any = {};
239
+
240
+ const headerParameters: runtime.HTTPHeaders = {};
241
+
242
+ headerParameters['Content-Type'] = 'application/json';
243
+
244
+ if (this.configuration && this.configuration.apiKey) {
245
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
246
+ }
247
+
248
+ if (this.configuration && this.configuration.apiKey) {
249
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
250
+ }
251
+
252
+
253
+ let urlPath = `/releases`;
254
+
255
+ const response = await this.request({
256
+ path: urlPath,
257
+ method: 'POST',
258
+ headers: headerParameters,
259
+ query: queryParameters,
260
+ body: ReleasePayloadToJSON(requestParameters['releasePayload']),
261
+ }, initOverrides);
262
+
263
+ return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseMinifiedFromJSON(jsonValue));
264
+ }
265
+
266
+ /**
267
+ * Creates a new release
268
+ * Create a release
269
+ */
270
+ async addRelease(requestParameters: AddReleaseRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified> {
271
+ const response = await this.addReleaseRaw(requestParameters, initOverrides);
272
+ return await response.value();
273
+ }
274
+
275
+ /**
276
+ * Get count of releases for a specific project
277
+ * Count releases
278
+ */
279
+ async countReleasesRaw(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Count>> {
280
+ if (requestParameters['project'] == null) {
281
+ throw new runtime.RequiredError(
282
+ 'project',
283
+ 'Required parameter "project" was null or undefined when calling countReleases().'
284
+ );
285
+ }
286
+
287
+ const queryParameters: any = {};
288
+
289
+ if (requestParameters['project'] != null) {
290
+ queryParameters['project'] = requestParameters['project'];
291
+ }
292
+
293
+ if (requestParameters['status'] != null) {
294
+ queryParameters['status'] = requestParameters['status'];
295
+ }
296
+
297
+ const headerParameters: runtime.HTTPHeaders = {};
298
+
299
+ if (this.configuration && this.configuration.apiKey) {
300
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
301
+ }
302
+
303
+ if (this.configuration && this.configuration.apiKey) {
304
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
305
+ }
306
+
307
+
308
+ let urlPath = `/releases/count`;
309
+
310
+ const response = await this.request({
311
+ path: urlPath,
312
+ method: 'GET',
313
+ headers: headerParameters,
314
+ query: queryParameters,
315
+ }, initOverrides);
316
+
317
+ return new runtime.JSONApiResponse(response, (jsonValue) => CountFromJSON(jsonValue));
318
+ }
319
+
320
+ /**
321
+ * Get count of releases for a specific project
322
+ * Count releases
323
+ */
324
+ async countReleases(requestParameters: CountReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Count> {
325
+ const response = await this.countReleasesRaw(requestParameters, initOverrides);
326
+ return await response.value();
327
+ }
328
+
329
+ /**
330
+ * Deletes a specific release. Does not delete associated test plans.
331
+ * Delete a release
332
+ */
333
+ async deleteReleaseRaw(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>> {
334
+ if (requestParameters['id'] == null) {
335
+ throw new runtime.RequiredError(
336
+ 'id',
337
+ 'Required parameter "id" was null or undefined when calling deleteRelease().'
338
+ );
339
+ }
340
+
341
+ if (requestParameters['project'] == null) {
342
+ throw new runtime.RequiredError(
343
+ 'project',
344
+ 'Required parameter "project" was null or undefined when calling deleteRelease().'
345
+ );
346
+ }
347
+
348
+ const queryParameters: any = {};
349
+
350
+ if (requestParameters['project'] != null) {
351
+ queryParameters['project'] = requestParameters['project'];
352
+ }
353
+
354
+ const headerParameters: runtime.HTTPHeaders = {};
355
+
356
+ if (this.configuration && this.configuration.apiKey) {
357
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
358
+ }
359
+
360
+ if (this.configuration && this.configuration.apiKey) {
361
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
362
+ }
363
+
364
+
365
+ let urlPath = `/releases/{id}`;
366
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
367
+
368
+ const response = await this.request({
369
+ path: urlPath,
370
+ method: 'DELETE',
371
+ headers: headerParameters,
372
+ query: queryParameters,
373
+ }, initOverrides);
374
+
375
+ return new runtime.JSONApiResponse<any>(response);
376
+ }
377
+
378
+ /**
379
+ * Deletes a specific release. Does not delete associated test plans.
380
+ * Delete a release
381
+ */
382
+ async deleteRelease(requestParameters: DeleteReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object> {
383
+ const response = await this.deleteReleaseRaw(requestParameters, initOverrides);
384
+ return await response.value();
385
+ }
386
+
387
+ /**
388
+ * Edits a specific release
389
+ * Edit a release
390
+ */
391
+ async editReleaseRaw(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseMinified>> {
392
+ if (requestParameters['id'] == null) {
393
+ throw new runtime.RequiredError(
394
+ 'id',
395
+ 'Required parameter "id" was null or undefined when calling editRelease().'
396
+ );
397
+ }
398
+
399
+ const queryParameters: any = {};
400
+
401
+ const headerParameters: runtime.HTTPHeaders = {};
402
+
403
+ headerParameters['Content-Type'] = 'application/json';
404
+
405
+ if (this.configuration && this.configuration.apiKey) {
406
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
407
+ }
408
+
409
+ if (this.configuration && this.configuration.apiKey) {
410
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
411
+ }
412
+
413
+
414
+ let urlPath = `/releases/{id}`;
415
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
416
+
417
+ const response = await this.request({
418
+ path: urlPath,
419
+ method: 'PUT',
420
+ headers: headerParameters,
421
+ query: queryParameters,
422
+ body: ReleasePayloadToJSON(requestParameters['releasePayload']),
423
+ }, initOverrides);
424
+
425
+ return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseMinifiedFromJSON(jsonValue));
426
+ }
427
+
428
+ /**
429
+ * Edits a specific release
430
+ * Edit a release
431
+ */
432
+ async editRelease(requestParameters: EditReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseMinified> {
433
+ const response = await this.editReleaseRaw(requestParameters, initOverrides);
434
+ return await response.value();
435
+ }
436
+
437
+ /**
438
+ * Get details of a specific release
439
+ * Get release
440
+ */
441
+ async getReleaseRaw(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Release>> {
442
+ if (requestParameters['id'] == null) {
443
+ throw new runtime.RequiredError(
444
+ 'id',
445
+ 'Required parameter "id" was null or undefined when calling getRelease().'
446
+ );
447
+ }
448
+
449
+ const queryParameters: any = {};
450
+
451
+ const headerParameters: runtime.HTTPHeaders = {};
452
+
453
+ if (this.configuration && this.configuration.apiKey) {
454
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
455
+ }
456
+
457
+ if (this.configuration && this.configuration.apiKey) {
458
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
459
+ }
460
+
461
+
462
+ let urlPath = `/releases/{id}`;
463
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
464
+
465
+ const response = await this.request({
466
+ path: urlPath,
467
+ method: 'GET',
468
+ headers: headerParameters,
469
+ query: queryParameters,
470
+ }, initOverrides);
471
+
472
+ return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseFromJSON(jsonValue));
473
+ }
474
+
475
+ /**
476
+ * Get details of a specific release
477
+ * Get release
478
+ */
479
+ async getRelease(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Release> {
480
+ const response = await this.getReleaseRaw(requestParameters, initOverrides);
481
+ return await response.value();
482
+ }
483
+
484
+ /**
485
+ * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
486
+ * Get release readiness dashboard data
487
+ */
488
+ async getReleaseReadinessRaw(requestParameters: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>> {
489
+ if (requestParameters['id'] == null) {
490
+ throw new runtime.RequiredError(
491
+ 'id',
492
+ 'Required parameter "id" was null or undefined when calling getReleaseReadiness().'
493
+ );
494
+ }
495
+
496
+ const queryParameters: any = {};
497
+
498
+ const headerParameters: runtime.HTTPHeaders = {};
499
+
500
+ if (this.configuration && this.configuration.apiKey) {
501
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
502
+ }
503
+
504
+ if (this.configuration && this.configuration.apiKey) {
505
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
506
+ }
507
+
508
+
509
+ let urlPath = `/releases/{id}/readiness`;
510
+ urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
511
+
512
+ const response = await this.request({
513
+ path: urlPath,
514
+ method: 'GET',
515
+ headers: headerParameters,
516
+ query: queryParameters,
517
+ }, initOverrides);
518
+
519
+ return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseReadinessFromJSON(jsonValue));
520
+ }
521
+
522
+ /**
523
+ * Returns aggregated readiness data for a release including execution summary, open defects, coverage by suite, evidence metrics, comparison to previous release, and a computed Go/No-Go verdict. Uses the latest run (regression) of each test plan in the release.
524
+ * Get release readiness dashboard data
525
+ */
526
+ async getReleaseReadiness(requestParameters: GetReleaseReadinessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness> {
527
+ const response = await this.getReleaseReadinessRaw(requestParameters, initOverrides);
528
+ return await response.value();
529
+ }
530
+
531
+ /**
532
+ * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
533
+ * Get release readiness by public token
534
+ */
535
+ async getReleaseReadinessByTokenRaw(requestParameters: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseReadiness>> {
536
+ if (requestParameters['token'] == null) {
537
+ throw new runtime.RequiredError(
538
+ 'token',
539
+ 'Required parameter "token" was null or undefined when calling getReleaseReadinessByToken().'
540
+ );
541
+ }
542
+
543
+ const queryParameters: any = {};
544
+
545
+ const headerParameters: runtime.HTTPHeaders = {};
546
+
547
+
548
+ let urlPath = `/releases/readiness/{token}`;
549
+ urlPath = urlPath.replace(`{${"token"}}`, encodeURIComponent(String(requestParameters['token'])));
550
+
551
+ const response = await this.request({
552
+ path: urlPath,
553
+ method: 'GET',
554
+ headers: headerParameters,
555
+ query: queryParameters,
556
+ }, initOverrides);
557
+
558
+ return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseReadinessFromJSON(jsonValue));
559
+ }
560
+
561
+ /**
562
+ * Public endpoint (no authentication required). Returns the same readiness data as the authenticated endpoint, looked up by the release\'s public_token. Only works if is_public is true on the release.
563
+ * Get release readiness by public token
564
+ */
565
+ async getReleaseReadinessByToken(requestParameters: GetReleaseReadinessByTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseReadiness> {
566
+ const response = await this.getReleaseReadinessByTokenRaw(requestParameters, initOverrides);
567
+ return await response.value();
568
+ }
569
+
570
+ /**
571
+ * Get releases for a specific project
572
+ * Get releases
573
+ */
574
+ async getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Release>>> {
575
+ if (requestParameters['project'] == null) {
576
+ throw new runtime.RequiredError(
577
+ 'project',
578
+ 'Required parameter "project" was null or undefined when calling getReleases().'
579
+ );
580
+ }
581
+
582
+ const queryParameters: any = {};
583
+
584
+ if (requestParameters['project'] != null) {
585
+ queryParameters['project'] = requestParameters['project'];
586
+ }
587
+
588
+ if (requestParameters['limit'] != null) {
589
+ queryParameters['_limit'] = requestParameters['limit'];
590
+ }
591
+
592
+ if (requestParameters['start'] != null) {
593
+ queryParameters['_start'] = requestParameters['start'];
594
+ }
595
+
596
+ if (requestParameters['sort'] != null) {
597
+ queryParameters['_sort'] = requestParameters['sort'];
598
+ }
599
+
600
+ if (requestParameters['filter'] != null) {
601
+ queryParameters['_filter'] = requestParameters['filter'];
602
+ }
603
+
604
+ if (requestParameters['status'] != null) {
605
+ queryParameters['status'] = requestParameters['status'];
606
+ }
607
+
608
+ const headerParameters: runtime.HTTPHeaders = {};
609
+
610
+ if (this.configuration && this.configuration.apiKey) {
611
+ queryParameters["token"] = await this.configuration.apiKey("token"); // ApiKeyAuth authentication
612
+ }
613
+
614
+ if (this.configuration && this.configuration.apiKey) {
615
+ headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // bearerAuth authentication
616
+ }
617
+
618
+
619
+ let urlPath = `/releases`;
620
+
621
+ const response = await this.request({
622
+ path: urlPath,
623
+ method: 'GET',
624
+ headers: headerParameters,
625
+ query: queryParameters,
626
+ }, initOverrides);
627
+
628
+ return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReleaseFromJSON));
629
+ }
630
+
631
+ /**
632
+ * Get releases for a specific project
633
+ * Get releases
634
+ */
635
+ async getReleases(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Release>> {
636
+ const response = await this.getReleasesRaw(requestParameters, initOverrides);
637
+ return await response.value();
638
+ }
639
+
640
+ }
641
+
642
+ /**
643
+ * @export
644
+ */
645
+ export const CountReleasesStatusEnum = {
646
+ Planned: 'planned',
647
+ InProgress: 'in_progress',
648
+ Ready: 'ready',
649
+ Shipped: 'shipped',
650
+ Blocked: 'blocked'
651
+ } as const;
652
+ export type CountReleasesStatusEnum = typeof CountReleasesStatusEnum[keyof typeof CountReleasesStatusEnum];
653
+ /**
654
+ * @export
655
+ */
656
+ export const GetReleasesStatusEnum = {
657
+ Planned: 'planned',
658
+ InProgress: 'in_progress',
659
+ Ready: 'ready',
660
+ Shipped: 'shipped',
661
+ Blocked: 'blocked'
662
+ } as const;
663
+ export type GetReleasesStatusEnum = typeof GetReleasesStatusEnum[keyof typeof GetReleasesStatusEnum];
package/src/apis/index.ts CHANGED
@@ -16,6 +16,7 @@ export * from './NotificationsApi';
16
16
  export * from './ProjectUsersApi';
17
17
  export * from './ProjectsApi';
18
18
  export * from './ProjectsettingsApi';
19
+ export * from './ReleasesApi';
19
20
  export * from './ReportsApi';
20
21
  export * from './RequirementFoldersApi';
21
22
  export * from './RequirementsApi';