@resolution/jira-api-client 0.1.0 → 0.1.2

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 (201) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/package.json +10 -3
  3. package/.eslintrc.js +0 -3
  4. package/config/api-typescript-generator.config.ts +0 -91
  5. package/config/compare-schemas.ts +0 -307
  6. package/src/index.ts +0 -47
  7. package/src/openapi/platform/base-jira-platform-api-client.ts +0 -2298
  8. package/src/openapi/platform/core/common-http-client.ts +0 -723
  9. package/src/openapi/platform/core/common-http-service.ts +0 -22
  10. package/src/openapi/platform/core/common-validation-schema-storage.ts +0 -105
  11. package/src/openapi/platform/models/announcement-banner.ts +0 -59
  12. package/src/openapi/platform/models/app-data-policies.ts +0 -79
  13. package/src/openapi/platform/models/app-migration.ts +0 -172
  14. package/src/openapi/platform/models/app-properties.ts +0 -32
  15. package/src/openapi/platform/models/audit-records.ts +0 -140
  16. package/src/openapi/platform/models/avatars.ts +0 -48
  17. package/src/openapi/platform/models/classification-levels.ts +0 -58
  18. package/src/openapi/platform/models/common.ts +0 -2669
  19. package/src/openapi/platform/models/dashboards.ts +0 -849
  20. package/src/openapi/platform/models/dynamic-modules.ts +0 -121
  21. package/src/openapi/platform/models/filter-sharing.ts +0 -103
  22. package/src/openapi/platform/models/filters.ts +0 -319
  23. package/src/openapi/platform/models/group-and-user-picker.ts +0 -85
  24. package/src/openapi/platform/models/groups.ts +0 -247
  25. package/src/openapi/platform/models/issue-attachments.ts +0 -290
  26. package/src/openapi/platform/models/issue-comment-properties.ts +0 -27
  27. package/src/openapi/platform/models/issue-comments.ts +0 -91
  28. package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +0 -96
  29. package/src/openapi/platform/models/issue-custom-field-contexts.ts +0 -1072
  30. package/src/openapi/platform/models/issue-custom-field-options-apps.ts +0 -273
  31. package/src/openapi/platform/models/issue-custom-field-options.ts +0 -283
  32. package/src/openapi/platform/models/issue-custom-field-values-apps.ts +0 -118
  33. package/src/openapi/platform/models/issue-field-configurations.ts +0 -435
  34. package/src/openapi/platform/models/issue-fields.ts +0 -392
  35. package/src/openapi/platform/models/issue-link-types.ts +0 -28
  36. package/src/openapi/platform/models/issue-links.ts +0 -185
  37. package/src/openapi/platform/models/issue-notification-schemes.ts +0 -370
  38. package/src/openapi/platform/models/issue-priorities.ts +0 -196
  39. package/src/openapi/platform/models/issue-properties.ts +0 -259
  40. package/src/openapi/platform/models/issue-remote-links.ts +0 -207
  41. package/src/openapi/platform/models/issue-resolutions.ts +0 -180
  42. package/src/openapi/platform/models/issue-search.ts +0 -367
  43. package/src/openapi/platform/models/issue-security-level.ts +0 -76
  44. package/src/openapi/platform/models/issue-security-schemes.ts +0 -496
  45. package/src/openapi/platform/models/issue-type-schemes.ts +0 -290
  46. package/src/openapi/platform/models/issue-type-screen-schemes.ts +0 -286
  47. package/src/openapi/platform/models/issue-types.ts +0 -66
  48. package/src/openapi/platform/models/issue-votes.ts +0 -38
  49. package/src/openapi/platform/models/issue-watchers.ts +0 -67
  50. package/src/openapi/platform/models/issue-worklogs.ts +0 -190
  51. package/src/openapi/platform/models/issues.ts +0 -1268
  52. package/src/openapi/platform/models/jira-expressions.ts +0 -578
  53. package/src/openapi/platform/models/jira-settings.ts +0 -118
  54. package/src/openapi/platform/models/jql-functions-apps.ts +0 -128
  55. package/src/openapi/platform/models/jql.ts +0 -783
  56. package/src/openapi/platform/models/labels.ts +0 -42
  57. package/src/openapi/platform/models/license-metrics.ts +0 -68
  58. package/src/openapi/platform/models/myself.ts +0 -29
  59. package/src/openapi/platform/models/permission-schemes.ts +0 -89
  60. package/src/openapi/platform/models/permissions.ts +0 -308
  61. package/src/openapi/platform/models/priority-schemes.ts +0 -527
  62. package/src/openapi/platform/models/project-avatars.ts +0 -29
  63. package/src/openapi/platform/models/project-classification-levels.ts +0 -24
  64. package/src/openapi/platform/models/project-components.ts +0 -231
  65. package/src/openapi/platform/models/project-email.ts +0 -27
  66. package/src/openapi/platform/models/project-features.ts +0 -78
  67. package/src/openapi/platform/models/project-permission-schemes.ts +0 -43
  68. package/src/openapi/platform/models/project-role-actors.ts +0 -107
  69. package/src/openapi/platform/models/project-roles.ts +0 -76
  70. package/src/openapi/platform/models/project-types.ts +0 -36
  71. package/src/openapi/platform/models/project-versions.ts +0 -216
  72. package/src/openapi/platform/models/projects.ts +0 -429
  73. package/src/openapi/platform/models/screen-schemes.ts +0 -192
  74. package/src/openapi/platform/models/screen-tab-fields.ts +0 -45
  75. package/src/openapi/platform/models/screens.ts +0 -171
  76. package/src/openapi/platform/models/server-info.ts +0 -100
  77. package/src/openapi/platform/models/service-registry.ts +0 -68
  78. package/src/openapi/platform/models/status.ts +0 -229
  79. package/src/openapi/platform/models/time-tracking.ts +0 -38
  80. package/src/openapi/platform/models/ui-modifications-apps.ts +0 -229
  81. package/src/openapi/platform/models/user-search.ts +0 -69
  82. package/src/openapi/platform/models/users.ts +0 -121
  83. package/src/openapi/platform/models/webhooks.ts +0 -307
  84. package/src/openapi/platform/models/workflow-scheme-drafts.ts +0 -58
  85. package/src/openapi/platform/models/workflow-scheme-project-associations.ts +0 -68
  86. package/src/openapi/platform/models/workflow-schemes.ts +0 -545
  87. package/src/openapi/platform/models/workflow-transition-properties.ts +0 -33
  88. package/src/openapi/platform/models/workflow-transition-rules.ts +0 -261
  89. package/src/openapi/platform/models/workflows.ts +0 -1943
  90. package/src/openapi/platform/services/announcement-banner-service.ts +0 -142
  91. package/src/openapi/platform/services/app-data-policies-service.ts +0 -136
  92. package/src/openapi/platform/services/app-migration-service.ts +0 -289
  93. package/src/openapi/platform/services/app-properties-service.ts +0 -441
  94. package/src/openapi/platform/services/application-roles-service.ts +0 -247
  95. package/src/openapi/platform/services/audit-records-service.ts +0 -164
  96. package/src/openapi/platform/services/avatars-service.ts +0 -769
  97. package/src/openapi/platform/services/classification-levels-service.ts +0 -131
  98. package/src/openapi/platform/services/dashboards-service.ts +0 -1721
  99. package/src/openapi/platform/services/dynamic-modules-service.ts +0 -127
  100. package/src/openapi/platform/services/filter-sharing-service.ts +0 -687
  101. package/src/openapi/platform/services/filters-service.ts +0 -1901
  102. package/src/openapi/platform/services/group-and-user-picker-service.ts +0 -224
  103. package/src/openapi/platform/services/groups-service.ts +0 -751
  104. package/src/openapi/platform/services/issue-attachments-service.ts +0 -900
  105. package/src/openapi/platform/services/issue-comment-properties-service.ts +0 -324
  106. package/src/openapi/platform/services/issue-comments-service.ts +0 -812
  107. package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +0 -277
  108. package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +0 -1339
  109. package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +0 -994
  110. package/src/openapi/platform/services/issue-custom-field-options-service.ts +0 -651
  111. package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +0 -201
  112. package/src/openapi/platform/services/issue-field-configurations-service.ts +0 -1294
  113. package/src/openapi/platform/services/issue-fields-service.ts +0 -837
  114. package/src/openapi/platform/services/issue-link-types-service.ts +0 -360
  115. package/src/openapi/platform/services/issue-links-service.ts +0 -345
  116. package/src/openapi/platform/services/issue-navigator-settings-service.ts +0 -119
  117. package/src/openapi/platform/services/issue-notification-schemes-service.ts +0 -1209
  118. package/src/openapi/platform/services/issue-priorities-service.ts +0 -575
  119. package/src/openapi/platform/services/issue-properties-service.ts +0 -606
  120. package/src/openapi/platform/services/issue-remote-links-service.ts +0 -597
  121. package/src/openapi/platform/services/issue-resolutions-service.ts +0 -534
  122. package/src/openapi/platform/services/issue-search-service.ts +0 -1139
  123. package/src/openapi/platform/services/issue-security-level-service.ts +0 -250
  124. package/src/openapi/platform/services/issue-security-schemes-service.ts +0 -1240
  125. package/src/openapi/platform/services/issue-type-properties-service.ts +0 -325
  126. package/src/openapi/platform/services/issue-type-schemes-service.ts +0 -940
  127. package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +0 -994
  128. package/src/openapi/platform/services/issue-types-service.ts +0 -679
  129. package/src/openapi/platform/services/issue-votes-service.ts +0 -221
  130. package/src/openapi/platform/services/issue-watchers-service.ts +0 -331
  131. package/src/openapi/platform/services/issue-worklog-properties-service.ts +0 -348
  132. package/src/openapi/platform/services/issue-worklogs-service.ts +0 -1089
  133. package/src/openapi/platform/services/issues-service.ts +0 -3346
  134. package/src/openapi/platform/services/jira-expressions-service.ts +0 -407
  135. package/src/openapi/platform/services/jira-settings-service.ts +0 -415
  136. package/src/openapi/platform/services/jql-functions-apps-service.ts +0 -219
  137. package/src/openapi/platform/services/jql-service.ts +0 -896
  138. package/src/openapi/platform/services/labels-service.ts +0 -89
  139. package/src/openapi/platform/services/license-metrics-service.ts +0 -216
  140. package/src/openapi/platform/services/myself-service.ts +0 -520
  141. package/src/openapi/platform/services/permission-schemes-service.ts +0 -926
  142. package/src/openapi/platform/services/permissions-service.ts +0 -407
  143. package/src/openapi/platform/services/priority-schemes-service.ts +0 -1001
  144. package/src/openapi/platform/services/project-avatars-service.ts +0 -341
  145. package/src/openapi/platform/services/project-categories-service.ts +0 -318
  146. package/src/openapi/platform/services/project-classification-levels-service.ts +0 -232
  147. package/src/openapi/platform/services/project-components-service.ts +0 -1332
  148. package/src/openapi/platform/services/project-email-service.ts +0 -161
  149. package/src/openapi/platform/services/project-features-service.ts +0 -207
  150. package/src/openapi/platform/services/project-key-and-name-validation-service.ts +0 -200
  151. package/src/openapi/platform/services/project-permission-schemes-service.ts +0 -384
  152. package/src/openapi/platform/services/project-properties-service.ts +0 -320
  153. package/src/openapi/platform/services/project-role-actors-service.ts +0 -627
  154. package/src/openapi/platform/services/project-roles-service.ts +0 -867
  155. package/src/openapi/platform/services/project-types-service.ts +0 -297
  156. package/src/openapi/platform/services/project-versions-service.ts +0 -1287
  157. package/src/openapi/platform/services/projects-service.ts +0 -2196
  158. package/src/openapi/platform/services/screen-schemes-service.ts +0 -334
  159. package/src/openapi/platform/services/screen-tab-fields-service.ts +0 -276
  160. package/src/openapi/platform/services/screen-tabs-service.ts +0 -421
  161. package/src/openapi/platform/services/screens-service.ts +0 -528
  162. package/src/openapi/platform/services/server-info-service.ts +0 -88
  163. package/src/openapi/platform/services/service-registry-service.ts +0 -89
  164. package/src/openapi/platform/services/status-service.ts +0 -498
  165. package/src/openapi/platform/services/tasks-service.ts +0 -159
  166. package/src/openapi/platform/services/time-tracking-service.ts +0 -386
  167. package/src/openapi/platform/services/ui-modifications-apps-service.ts +0 -403
  168. package/src/openapi/platform/services/user-properties-service.ts +0 -413
  169. package/src/openapi/platform/services/user-search-service.ts +0 -1214
  170. package/src/openapi/platform/services/users-service.ts +0 -1108
  171. package/src/openapi/platform/services/webhooks-service.ts +0 -458
  172. package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +0 -1313
  173. package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +0 -189
  174. package/src/openapi/platform/services/workflow-schemes-service.ts +0 -1617
  175. package/src/openapi/platform/services/workflow-status-categories-service.ts +0 -151
  176. package/src/openapi/platform/services/workflow-statuses-service.ts +0 -176
  177. package/src/openapi/platform/services/workflow-transition-properties-service.ts +0 -388
  178. package/src/openapi/platform/services/workflow-transition-rules-service.ts +0 -485
  179. package/src/openapi/platform/services/workflows-service.ts +0 -3477
  180. package/src/openapi/platform/validation-schema-storage.ts +0 -186
  181. package/src/openapi/software/base-jira-software-api-client.ts +0 -447
  182. package/src/openapi/software/core/common-http-client.ts +0 -723
  183. package/src/openapi/software/core/common-http-service.ts +0 -22
  184. package/src/openapi/software/core/common-validation-schema-storage.ts +0 -105
  185. package/src/openapi/software/models/board.ts +0 -918
  186. package/src/openapi/software/services/backlog-service.ts +0 -160
  187. package/src/openapi/software/services/board-service.ts +0 -4189
  188. package/src/openapi/software/services/builds-service.ts +0 -571
  189. package/src/openapi/software/services/deployments-service.ts +0 -403
  190. package/src/openapi/software/services/dev-ops-components-service.ts +0 -371
  191. package/src/openapi/software/services/development-information-service.ts +0 -2357
  192. package/src/openapi/software/services/epic-service.ts +0 -854
  193. package/src/openapi/software/services/feature-flags-service.ts +0 -303
  194. package/src/openapi/software/services/issue-service.ts +0 -529
  195. package/src/openapi/software/services/operations-service.ts +0 -741
  196. package/src/openapi/software/services/remote-links-service.ts +0 -653
  197. package/src/openapi/software/services/security-information-service.ts +0 -495
  198. package/src/openapi/software/services/sprint-service.ts +0 -969
  199. package/src/openapi/software/validation-schema-storage.ts +0 -186
  200. package/tsconfig.build.json +0 -7
  201. package/tsconfig.json +0 -4
@@ -1,1287 +0,0 @@
1
- // DO NOT EDIT!
2
- // This file is generated by "api-typescript-generator".
3
- // To update this file run "yarn build:openapi".
4
- import { z } from "zod";
5
-
6
- import * as commonHttpClient from "../core/common-http-client";
7
- import { CommonHttpService } from "../core/common-http-service";
8
- import {
9
- registerCommonValidationSchemas,
10
- type Version,
11
- } from "../models/common";
12
- import {
13
- type DeleteAndReplaceVersionBean,
14
- type PageBeanVersion,
15
- registerProjectVersionsValidationSchemas,
16
- type VersionIssueCounts,
17
- type VersionMoveBean,
18
- type VersionRelatedWork,
19
- type VersionUnresolvedIssuesCount,
20
- } from "../models/project-versions";
21
- import { validationSchemaStorage } from "../validation-schema-storage";
22
- /**
23
- * This resource represents project versions. Use it to get, get lists of, create,
24
- * update, move, merge, and delete project versions. This resource also provides
25
- * counts of issues by version.
26
- */
27
- export class ProjectVersionsService extends CommonHttpService {
28
- /**
29
- * Creates a related work for the given version. You can only create a generic
30
- * link type of related works via this API. relatedWorkId will be auto-generated
31
- * UUID, that does not need to be provided.
32
- *
33
- * This operation can be accessed anonymously.
34
- *
35
- * **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues*
36
- * [Managing project
37
- * permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html)
38
- * for the project that contains the version.
39
- *
40
- * @returns Returned if the request is successful.
41
- *
42
- * example: {
43
- * "category": "Design",
44
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
45
- * "title": "Design link",
46
- * "url": "https://www.atlassian.com"
47
- * }
48
- * @path {POST} /rest/api/3/version/{id}/relatedwork
49
- * @scopes-current write:jira-work
50
- * @scopes-beta write:issue:jira
51
- */
52
- createRelatedWork({
53
- id,
54
- versionRelatedWork,
55
- }: {
56
- id: string;
57
- /**
58
- * @example {
59
- * "category": "Design",
60
- * "title": "Design link",
61
- * "url": "https://www.atlassian.com"
62
- * }
63
- */
64
- versionRelatedWork: VersionRelatedWork;
65
- }): Promise<VersionRelatedWork> {
66
- return this.getClientInstance()
67
- .request({
68
- path: "/rest/api/3/version/{id}/relatedwork",
69
- method: "POST",
70
- pathParams: {
71
- id,
72
- },
73
- headers: {
74
- "Content-Type": "application/json",
75
- },
76
- body: versionRelatedWork,
77
- })
78
- .then(
79
- this.getClientInstance().responseHandler({
80
- 201: {
81
- "application/json": "json",
82
- },
83
- }),
84
- )
85
- .then(
86
- commonHttpClient.castResponse<{
87
- status: 201;
88
- mediaType: "application/json";
89
- body: VersionRelatedWork;
90
- }>(),
91
- )
92
- .then(
93
- validationSchemaStorage.validator(
94
- "ProjectVersionsService.createRelatedWork.response",
95
- ),
96
- )
97
- .then(commonHttpClient.getBody);
98
- }
99
- /**
100
- * Creates a project version.
101
- *
102
- * This operation can be accessed anonymously.
103
- *
104
- * **[Permissions](#permissions) required:** *Administer Jira* [global
105
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
106
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
107
- * the version is added to.
108
- *
109
- * @returns Returned if the request is successful.
110
- *
111
- * example: {
112
- * "archived": false,
113
- * "description": "An excellent version",
114
- * "id": "10000",
115
- * "name": "New Version 1",
116
- * "project": "PXA",
117
- * "projectId": 10000,
118
- * "releaseDate": "2010-07-06",
119
- * "released": true,
120
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
121
- * "userReleaseDate": "6/Jul/2010"
122
- * }
123
- * @path {POST} /rest/api/3/version
124
- * @scopes-current manage:jira-project
125
- * @scopes-beta write:project-version:jira, read:project-version:jira
126
- */
127
- createVersion({
128
- version,
129
- }: {
130
- /**
131
- * @example {
132
- * "archived": false,
133
- * "description": "An excellent version",
134
- * "name": "New Version 1",
135
- * "projectId": 10000,
136
- * "releaseDate": "2010-07-06",
137
- * "released": true
138
- * }
139
- */
140
- version: Version;
141
- }): Promise<Version> {
142
- return this.getClientInstance()
143
- .request({
144
- path: "/rest/api/3/version",
145
- method: "POST",
146
- headers: {
147
- "Content-Type": "application/json",
148
- },
149
- body: version,
150
- })
151
- .then(
152
- this.getClientInstance().responseHandler({
153
- 201: {
154
- "application/json": "json",
155
- },
156
- }),
157
- )
158
- .then(
159
- commonHttpClient.castResponse<{
160
- status: 201;
161
- mediaType: "application/json";
162
- body: Version;
163
- }>(),
164
- )
165
- .then(
166
- validationSchemaStorage.validator(
167
- "ProjectVersionsService.createVersion.response",
168
- ),
169
- )
170
- .then(commonHttpClient.getBody);
171
- }
172
- /**
173
- * Deletes a project version.
174
- *
175
- * Alternative versions can be provided to update issues that use the deleted
176
- * version in `fixVersion`, `affectedVersion`, or any version picker custom
177
- * fields. If alternatives are not provided, occurrences of `fixVersion`,
178
- * `affectedVersion`, and any version picker custom field, that contain the
179
- * deleted version, are cleared. Any replacement version must be in the same
180
- * project as the version being deleted and cannot be the version being deleted.
181
- *
182
- * This operation can be accessed anonymously.
183
- *
184
- * **[Permissions](#permissions) required:** *Administer Jira* [global
185
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
186
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
187
- * that contains the version.
188
- *
189
- * @returns Returned if the version is deleted.
190
- * @path {POST} /rest/api/3/version/{id}/removeAndSwap
191
- * @scopes-current manage:jira-project
192
- * @scopes-beta delete:project-version:jira, write:project-version:jira
193
- */
194
- deleteAndReplaceVersion({
195
- id,
196
- deleteAndReplaceVersionBean,
197
- }: {
198
- /** The ID of the version. */
199
- id: string;
200
- deleteAndReplaceVersionBean: DeleteAndReplaceVersionBean;
201
- }): Promise<void> {
202
- return this.getClientInstance()
203
- .request({
204
- path: "/rest/api/3/version/{id}/removeAndSwap",
205
- method: "POST",
206
- pathParams: {
207
- id,
208
- },
209
- headers: {
210
- "Content-Type": "application/json",
211
- },
212
- body: deleteAndReplaceVersionBean,
213
- })
214
- .then(
215
- this.getClientInstance().responseHandler({
216
- 204: {
217
- "application/json": "json",
218
- },
219
- }),
220
- )
221
- .then(
222
- commonHttpClient.castResponse<{
223
- status: 204;
224
- mediaType: "application/json";
225
- body: void;
226
- }>(),
227
- )
228
- .then(
229
- validationSchemaStorage.validator(
230
- "ProjectVersionsService.deleteAndReplaceVersion.response",
231
- ),
232
- )
233
- .then(commonHttpClient.getBody);
234
- }
235
- /**
236
- * Deletes the given related work for the given version.
237
- *
238
- * This operation can be accessed anonymously.
239
- *
240
- * **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues*
241
- * [Managing project
242
- * permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html)
243
- * for the project that contains the version.
244
- *
245
- * @path {DELETE} /rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}
246
- * @scopes-current write:jira-work
247
- * @scopes-beta write:issue:jira
248
- */
249
- deleteRelatedWork({
250
- versionId,
251
- relatedWorkId,
252
- }: {
253
- /** The ID of the version that the target related work belongs to. */
254
- versionId: string;
255
- /** The ID of the related work to delete. */
256
- relatedWorkId: string;
257
- }): Promise<void> {
258
- return this.getClientInstance()
259
- .request({
260
- path: "/rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}",
261
- method: "DELETE",
262
- pathParams: {
263
- versionId,
264
- relatedWorkId,
265
- },
266
- })
267
- .then(commonHttpClient.discardResult);
268
- }
269
- /**
270
- * Deletes a project version.
271
- *
272
- * Deprecated, use [ Delete and replace
273
- * version](#api-rest-api-3-version-id-removeAndSwap-post) that supports swapping
274
- * version values in custom fields, in addition to the swapping for `fixVersion`
275
- * and `affectedVersion` provided in this resource.
276
- *
277
- * Alternative versions can be provided to update issues that use the deleted
278
- * version in `fixVersion` or `affectedVersion`. If alternatives are not provided,
279
- * occurrences of `fixVersion` and `affectedVersion` that contain the deleted
280
- * version are cleared.
281
- *
282
- * This operation can be accessed anonymously.
283
- *
284
- * **[Permissions](#permissions) required:** *Administer Jira* [global
285
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
286
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
287
- * that contains the version.
288
- *
289
- * @deprecated
290
- * @path {DELETE} /rest/api/3/version/{id}
291
- * @scopes-current manage:jira-project
292
- * @scopes-beta delete:project-version:jira
293
- */
294
- deleteVersion({
295
- id,
296
- moveFixIssuesTo,
297
- moveAffectedIssuesTo,
298
- }: {
299
- /** The ID of the version. */
300
- id: string;
301
- /**
302
- * The ID of the version to update `fixVersion` to when the field contains the
303
- * deleted version. The replacement version must be in the same project as the
304
- * version being deleted and cannot be the version being deleted.
305
- */
306
- moveFixIssuesTo?: string;
307
- /**
308
- * The ID of the version to update `affectedVersion` to when the field contains
309
- * the deleted version. The replacement version must be in the same project as the
310
- * version being deleted and cannot be the version being deleted.
311
- */
312
- moveAffectedIssuesTo?: string;
313
- }): Promise<void> {
314
- return this.getClientInstance()
315
- .request({
316
- path: "/rest/api/3/version/{id}",
317
- method: "DELETE",
318
- pathParams: {
319
- id,
320
- },
321
- query: {
322
- moveFixIssuesTo,
323
- moveAffectedIssuesTo,
324
- },
325
- })
326
- .then(commonHttpClient.discardResult);
327
- }
328
- /**
329
- * Returns all versions in a project. The response is not paginated. Use [Get
330
- * project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get)
331
- * if you want to get the versions in a project with pagination.
332
- *
333
- * This operation can be accessed anonymously.
334
- *
335
- * **[Permissions](#permissions) required:** *Browse Projects* [project
336
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
337
- *
338
- * @returns Returned if the request is successful.
339
- *
340
- * example: [
341
- * {
342
- * "archived": false,
343
- * "description": "An excellent version",
344
- * "id": "10000",
345
- * "name": "New Version 1",
346
- * "overdue": true,
347
- * "projectId": 10000,
348
- * "releaseDate": 1278385482288,
349
- * "releaseDateSet": false,
350
- * "released": true,
351
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
352
- * "startDateSet": false,
353
- * "userReleaseDate": "6/Jul/2010"
354
- * },
355
- * {
356
- * "archived": false,
357
- * "description": "Minor Bugfix version",
358
- * "id": "10010",
359
- * "issuesStatusForFixVersion": {
360
- * "done": 100,
361
- * "inProgress": 20,
362
- * "toDo": 10,
363
- * "unmapped": 0
364
- * },
365
- * "name": "Next Version",
366
- * "overdue": false,
367
- * "projectId": 10000,
368
- * "releaseDateSet": false,
369
- * "released": false,
370
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10010",
371
- * "startDateSet": false
372
- * }
373
- * ]
374
- * @path {GET} /rest/api/3/project/{projectIdOrKey}/versions
375
- * @scopes-current read:jira-work
376
- * @scopes-beta read:project-version:jira
377
- */
378
- getProjectVersions({
379
- projectIdOrKey,
380
- expand,
381
- }: {
382
- /** The project ID or project key (case sensitive). */
383
- projectIdOrKey: string;
384
- /**
385
- * Use [expand](#expansion) to include additional information in the response.
386
- * This parameter accepts `operations`, which returns actions that can be
387
- * performed on the version.
388
- */
389
- expand?: string;
390
- }): Promise<Version[]> {
391
- return this.getClientInstance()
392
- .request({
393
- path: "/rest/api/3/project/{projectIdOrKey}/versions",
394
- method: "GET",
395
- pathParams: {
396
- projectIdOrKey,
397
- },
398
- query: {
399
- expand,
400
- },
401
- })
402
- .then(
403
- this.getClientInstance().responseHandler({
404
- 200: {
405
- "application/json": "json",
406
- },
407
- }),
408
- )
409
- .then(
410
- commonHttpClient.castResponse<{
411
- status: 200;
412
- mediaType: "application/json";
413
- body: Version[];
414
- }>(),
415
- )
416
- .then(
417
- validationSchemaStorage.validator(
418
- "ProjectVersionsService.getProjectVersions.response",
419
- ),
420
- )
421
- .then(commonHttpClient.getBody);
422
- }
423
- /**
424
- * Returns a [paginated](#pagination) list of all versions in a project. See the
425
- * [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get)
426
- * resource if you want to get a full list of versions without pagination.
427
- *
428
- * This operation can be accessed anonymously.
429
- *
430
- * **[Permissions](#permissions) required:** *Browse Projects* [project
431
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
432
- *
433
- * @returns Returned if the request is successful.
434
- *
435
- * example: {
436
- * "isLast": false,
437
- * "maxResults": 2,
438
- * "nextPage":
439
- * "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
440
- * "self":
441
- * "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
442
- * "startAt": 0,
443
- * "total": 7,
444
- * "values": [
445
- * {
446
- * "archived": false,
447
- * "description": "An excellent version",
448
- * "id": "10000",
449
- * "name": "New Version 1",
450
- * "overdue": true,
451
- * "projectId": 10000,
452
- * "releaseDate": "2010-07-06",
453
- * "released": true,
454
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
455
- * "userReleaseDate": "6/Jul/2010"
456
- * },
457
- * {
458
- * "archived": false,
459
- * "description": "Minor Bugfix version",
460
- * "id": "10010",
461
- * "issuesStatusForFixVersion": {
462
- * "done": 100,
463
- * "inProgress": 20,
464
- * "toDo": 10,
465
- * "unmapped": 0
466
- * },
467
- * "name": "Next Version",
468
- * "overdue": false,
469
- * "projectId": 10000,
470
- * "released": false,
471
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10010"
472
- * }
473
- * ]
474
- * }
475
- * @path {GET} /rest/api/3/project/{projectIdOrKey}/version
476
- * @scopes-current read:jira-work
477
- * @scopes-beta read:project-version:jira
478
- */
479
- getProjectVersionsPaginated({
480
- projectIdOrKey,
481
- startAt,
482
- maxResults,
483
- orderBy,
484
- query,
485
- status,
486
- expand,
487
- }: {
488
- /** The project ID or project key (case sensitive). */
489
- projectIdOrKey: string;
490
- /** The index of the first item to return in a page of results (page offset). */
491
- startAt?: number;
492
- /** The maximum number of items to return per page. */
493
- maxResults?: number;
494
- /**
495
- * [Order](#ordering) the results by a field:
496
- *
497
- * * `description` Sorts by version description.
498
- * * `name` Sorts by version name.
499
- * * `releaseDate` Sorts by release date, starting with the oldest date.
500
- * Versions with no release date are listed last.
501
- * * `sequence` Sorts by the order of appearance in the user interface.
502
- * * `startDate` Sorts by start date, starting with the oldest date. Versions
503
- * with no start date are listed last.
504
- */
505
- orderBy?:
506
- | "description"
507
- | "-description"
508
- | "+description"
509
- | "name"
510
- | "-name"
511
- | "+name"
512
- | "releaseDate"
513
- | "-releaseDate"
514
- | "+releaseDate"
515
- | "sequence"
516
- | "-sequence"
517
- | "+sequence"
518
- | "startDate"
519
- | "-startDate"
520
- | "+startDate";
521
- /**
522
- * Filter the results using a literal string. Versions with matching `name` or
523
- * `description` are returned (case insensitive).
524
- */
525
- query?: string;
526
- /**
527
- * A list of status values used to filter the results by version status. This
528
- * parameter accepts a comma-separated list. The status values are `released`,
529
- * `unreleased`, and `archived`.
530
- */
531
- status?: string;
532
- /**
533
- * Use [expand](#expansion) to include additional information in the response.
534
- * This parameter accepts a comma-separated list. Expand options include:
535
- *
536
- * * `issuesstatus` Returns the number of issues in each status category for
537
- * each version.
538
- * * `operations` Returns actions that can be performed on the specified version.
539
- * * `driver` Returns the Atlassian account ID of the version driver.
540
- * * `approvers` Returns a list containing the approvers for this version.
541
- */
542
- expand?: string;
543
- }): Promise<PageBeanVersion> {
544
- return this.getClientInstance()
545
- .request({
546
- path: "/rest/api/3/project/{projectIdOrKey}/version",
547
- method: "GET",
548
- pathParams: {
549
- projectIdOrKey,
550
- },
551
- query: {
552
- startAt,
553
- maxResults,
554
- orderBy,
555
- query,
556
- status,
557
- expand,
558
- },
559
- })
560
- .then(
561
- this.getClientInstance().responseHandler({
562
- 200: {
563
- "application/json": "json",
564
- },
565
- }),
566
- )
567
- .then(
568
- commonHttpClient.castResponse<{
569
- status: 200;
570
- mediaType: "application/json";
571
- body: PageBeanVersion;
572
- }>(),
573
- )
574
- .then(
575
- validationSchemaStorage.validator(
576
- "ProjectVersionsService.getProjectVersionsPaginated.response",
577
- ),
578
- )
579
- .then(commonHttpClient.getBody);
580
- }
581
- /**
582
- * Returns related work items for the given version id.
583
- *
584
- * This operation can be accessed anonymously.
585
- *
586
- * **[Permissions](#permissions) required:** *Browse projects* [project
587
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project
588
- * containing the version.
589
- *
590
- * @returns Returned if the request is successful.
591
- *
592
- * example: [
593
- * {
594
- * "category": "Design",
595
- * "issueId": 10001,
596
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
597
- * "title": "Design link",
598
- * "url": "https://www.atlassian.com"
599
- * },
600
- * {
601
- * "category": "Communications",
602
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abce",
603
- * "title": "Chat application",
604
- * "url": "https://www.atlassian.com"
605
- * },
606
- * {
607
- * "category": "External Link",
608
- * "issueId": 10003,
609
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcf",
610
- * "url": "https://www.atlassian.com"
611
- * }
612
- * ]
613
- * @path {GET} /rest/api/3/version/{id}/relatedwork
614
- * @scopes-current read:jira-work
615
- * @scopes-beta read:project-version:jira
616
- */
617
- getRelatedWork({
618
- id,
619
- }: {
620
- /** The ID of the version. */
621
- id: string;
622
- }): Promise<VersionRelatedWork[]> {
623
- return this.getClientInstance()
624
- .request({
625
- path: "/rest/api/3/version/{id}/relatedwork",
626
- method: "GET",
627
- pathParams: {
628
- id,
629
- },
630
- })
631
- .then(
632
- this.getClientInstance().responseHandler({
633
- 200: {
634
- "application/json": "json",
635
- },
636
- }),
637
- )
638
- .then(
639
- commonHttpClient.castResponse<{
640
- status: 200;
641
- mediaType: "application/json";
642
- body: VersionRelatedWork[];
643
- }>(),
644
- )
645
- .then(
646
- validationSchemaStorage.validator(
647
- "ProjectVersionsService.getRelatedWork.response",
648
- ),
649
- )
650
- .then(commonHttpClient.getBody);
651
- }
652
- /**
653
- * Returns a project version.
654
- *
655
- * This operation can be accessed anonymously.
656
- *
657
- * **[Permissions](#permissions) required:** *Browse projects* [project
658
- * permission](https://confluence.atlassian.com/x/yodKLg) for the project
659
- * containing the version.
660
- *
661
- * @returns Returned if the request is successful.
662
- *
663
- * example: {
664
- * "archived": false,
665
- * "description": "An excellent version",
666
- * "id": "10000",
667
- * "name": "New Version 1",
668
- * "overdue": true,
669
- * "projectId": 10000,
670
- * "releaseDate": "2010-07-06",
671
- * "released": true,
672
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
673
- * "userReleaseDate": "6/Jul/2010"
674
- * }
675
- * @path {GET} /rest/api/3/version/{id}
676
- * @scopes-current read:jira-work
677
- * @scopes-beta read:project-version:jira
678
- */
679
- getVersion({
680
- id,
681
- expand,
682
- }: {
683
- /** The ID of the version. */
684
- id: string;
685
- /**
686
- * Use [expand](#expansion) to include additional information about version in the
687
- * response. This parameter accepts a comma-separated list. Expand options include:
688
- *
689
- * * `operations` Returns the list of operations available for this version.
690
- * * `issuesstatus` Returns the count of issues in this version for each of the
691
- * status categories *to do*, *in progress*, *done*, and *unmapped*. The
692
- * *unmapped* property represents the number of issues with a status other than
693
- * *to do*, *in progress*, and *done*.
694
- * * `driver` Returns the Atlassian account ID of the version driver.
695
- * * `approvers` Returns a list containing the Atlassian account IDs of
696
- * approvers for this version.
697
- */
698
- expand?: string;
699
- }): Promise<Version> {
700
- return this.getClientInstance()
701
- .request({
702
- path: "/rest/api/3/version/{id}",
703
- method: "GET",
704
- pathParams: {
705
- id,
706
- },
707
- query: {
708
- expand,
709
- },
710
- })
711
- .then(
712
- this.getClientInstance().responseHandler({
713
- 200: {
714
- "application/json": "json",
715
- },
716
- }),
717
- )
718
- .then(
719
- commonHttpClient.castResponse<{
720
- status: 200;
721
- mediaType: "application/json";
722
- body: Version;
723
- }>(),
724
- )
725
- .then(
726
- validationSchemaStorage.validator(
727
- "ProjectVersionsService.getVersion.response",
728
- ),
729
- )
730
- .then(commonHttpClient.getBody);
731
- }
732
- /**
733
- * Returns the following counts for a version:
734
- *
735
- * * Number of issues where the `fixVersion` is set to the version.
736
- * * Number of issues where the `affectedVersion` is set to the version.
737
- * * Number of issues where a version custom field is set to the version.
738
- *
739
- * This operation can be accessed anonymously.
740
- *
741
- * **[Permissions](#permissions) required:** *Browse projects* project permission
742
- * for the project that contains the version.
743
- *
744
- * @returns Returned if the request is successful.
745
- *
746
- * example: {
747
- * "customFieldUsage": [
748
- * {
749
- * "customFieldId": 10000,
750
- * "fieldName": "Field1",
751
- * "issueCountWithVersionInCustomField": 2
752
- * },
753
- * {
754
- * "customFieldId": 10010,
755
- * "fieldName": "Field2",
756
- * "issueCountWithVersionInCustomField": 3
757
- * }
758
- * ],
759
- * "issueCountWithCustomFieldsShowingVersion": 54,
760
- * "issuesAffectedCount": 101,
761
- * "issuesFixedCount": 23,
762
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000"
763
- * }
764
- * @path {GET} /rest/api/3/version/{id}/relatedIssueCounts
765
- * @scopes-current read:jira-work
766
- * @scopes-beta read:field:jira, read:project-version:jira
767
- */
768
- getVersionRelatedIssues({
769
- id,
770
- }: {
771
- /** The ID of the version. */
772
- id: string;
773
- }): Promise<VersionIssueCounts> {
774
- return this.getClientInstance()
775
- .request({
776
- path: "/rest/api/3/version/{id}/relatedIssueCounts",
777
- method: "GET",
778
- pathParams: {
779
- id,
780
- },
781
- })
782
- .then(
783
- this.getClientInstance().responseHandler({
784
- 200: {
785
- "application/json": "json",
786
- },
787
- }),
788
- )
789
- .then(
790
- commonHttpClient.castResponse<{
791
- status: 200;
792
- mediaType: "application/json";
793
- body: VersionIssueCounts;
794
- }>(),
795
- )
796
- .then(
797
- validationSchemaStorage.validator(
798
- "ProjectVersionsService.getVersionRelatedIssues.response",
799
- ),
800
- )
801
- .then(commonHttpClient.getBody);
802
- }
803
- /**
804
- * Returns counts of the issues and unresolved issues for the project version.
805
- *
806
- * This operation can be accessed anonymously.
807
- *
808
- * **[Permissions](#permissions) required:** *Browse projects* project permission
809
- * for the project that contains the version.
810
- *
811
- * @returns Returned if the request is successful.
812
- *
813
- * example: {
814
- * "issuesCount": 30,
815
- * "issuesUnresolvedCount": 23,
816
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000"
817
- * }
818
- * @path {GET} /rest/api/3/version/{id}/unresolvedIssueCount
819
- * @scopes-current read:jira-work
820
- * @scopes-beta read:project-version:jira
821
- */
822
- getVersionUnresolvedIssues({
823
- id,
824
- }: {
825
- /** The ID of the version. */
826
- id: string;
827
- }): Promise<VersionUnresolvedIssuesCount> {
828
- return this.getClientInstance()
829
- .request({
830
- path: "/rest/api/3/version/{id}/unresolvedIssueCount",
831
- method: "GET",
832
- pathParams: {
833
- id,
834
- },
835
- })
836
- .then(
837
- this.getClientInstance().responseHandler({
838
- 200: {
839
- "application/json": "json",
840
- },
841
- }),
842
- )
843
- .then(
844
- commonHttpClient.castResponse<{
845
- status: 200;
846
- mediaType: "application/json";
847
- body: VersionUnresolvedIssuesCount;
848
- }>(),
849
- )
850
- .then(
851
- validationSchemaStorage.validator(
852
- "ProjectVersionsService.getVersionUnresolvedIssues.response",
853
- ),
854
- )
855
- .then(commonHttpClient.getBody);
856
- }
857
- /**
858
- * Merges two project versions. The merge is completed by deleting the version
859
- * specified in `id` and replacing any occurrences of its ID in `fixVersion` with
860
- * the version ID specified in `moveIssuesTo`.
861
- *
862
- * Consider using [ Delete and replace
863
- * version](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource
864
- * supports swapping version values in `fixVersion`, `affectedVersion`, and custom
865
- * fields.
866
- *
867
- * This operation can be accessed anonymously.
868
- *
869
- * **[Permissions](#permissions) required:** *Administer Jira* [global
870
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
871
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
872
- * that contains the version.
873
- *
874
- * @returns Returned if the version is deleted.
875
- * @path {PUT} /rest/api/3/version/{id}/mergeto/{moveIssuesTo}
876
- * @scopes-current manage:jira-project
877
- * @scopes-beta delete:project-version:jira, write:project-version:jira
878
- */
879
- mergeVersions({
880
- id,
881
- moveIssuesTo,
882
- }: {
883
- /** The ID of the version to delete. */
884
- id: string;
885
- /** The ID of the version to merge into. */
886
- moveIssuesTo: string;
887
- }): Promise<void> {
888
- return this.getClientInstance()
889
- .request({
890
- path: "/rest/api/3/version/{id}/mergeto/{moveIssuesTo}",
891
- method: "PUT",
892
- pathParams: {
893
- id,
894
- moveIssuesTo,
895
- },
896
- })
897
- .then(
898
- this.getClientInstance().responseHandler({
899
- 204: {
900
- "application/json": "json",
901
- },
902
- }),
903
- )
904
- .then(
905
- commonHttpClient.castResponse<{
906
- status: 204;
907
- mediaType: "application/json";
908
- body: void;
909
- }>(),
910
- )
911
- .then(
912
- validationSchemaStorage.validator(
913
- "ProjectVersionsService.mergeVersions.response",
914
- ),
915
- )
916
- .then(commonHttpClient.getBody);
917
- }
918
- /**
919
- * Modifies the version's sequence within the project, which affects the display
920
- * order of the versions in Jira.
921
- *
922
- * This operation can be accessed anonymously.
923
- *
924
- * **[Permissions](#permissions) required:** *Browse projects* project permission
925
- * for the project that contains the version.
926
- *
927
- * @returns Returned if the request is successful.
928
- *
929
- * example: {
930
- * "archived": false,
931
- * "description": "An excellent version",
932
- * "id": "10000",
933
- * "name": "New Version 1",
934
- * "overdue": true,
935
- * "projectId": 10000,
936
- * "releaseDate": "2010-07-06",
937
- * "released": true,
938
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
939
- * "userReleaseDate": "6/Jul/2010"
940
- * }
941
- * @path {POST} /rest/api/3/version/{id}/move
942
- * @scopes-current manage:jira-project
943
- * @scopes-beta write:project-version:jira, read:project-version:jira
944
- */
945
- moveVersion({
946
- id,
947
- versionMoveBean,
948
- }: {
949
- /** The ID of the version to be moved. */
950
- id: string;
951
- /**
952
- * @example {
953
- * "after": "https://your-domain.atlassian.net/rest/api/~ver~/version/10000"
954
- * }
955
- */
956
- versionMoveBean: VersionMoveBean;
957
- }): Promise<Version> {
958
- return this.getClientInstance()
959
- .request({
960
- path: "/rest/api/3/version/{id}/move",
961
- method: "POST",
962
- pathParams: {
963
- id,
964
- },
965
- headers: {
966
- "Content-Type": "application/json",
967
- },
968
- body: versionMoveBean,
969
- })
970
- .then(
971
- this.getClientInstance().responseHandler({
972
- 200: {
973
- "application/json": "json",
974
- },
975
- }),
976
- )
977
- .then(
978
- commonHttpClient.castResponse<{
979
- status: 200;
980
- mediaType: "application/json";
981
- body: Version;
982
- }>(),
983
- )
984
- .then(
985
- validationSchemaStorage.validator(
986
- "ProjectVersionsService.moveVersion.response",
987
- ),
988
- )
989
- .then(commonHttpClient.getBody);
990
- }
991
- /**
992
- * Updates the given related work. You can only update generic link related works
993
- * via Rest APIs. Any archived version related works can't be edited.
994
- *
995
- * This operation can be accessed anonymously.
996
- *
997
- * **[Permissions](#permissions) required:** *Resolve issues:* and *Edit issues*
998
- * [Managing project
999
- * permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html)
1000
- * for the project that contains the version.
1001
- *
1002
- * @returns Returned if the request is successful together with updated related work.
1003
- *
1004
- * example: {
1005
- * "category": "Design",
1006
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
1007
- * "title": "Design link",
1008
- * "url": "https://www.atlassian.com"
1009
- * }
1010
- * @path {PUT} /rest/api/3/version/{id}/relatedwork
1011
- * @scopes-current write:jira-work
1012
- * @scopes-beta write:issue:jira
1013
- */
1014
- updateRelatedWork({
1015
- id,
1016
- versionRelatedWork,
1017
- }: {
1018
- /**
1019
- * The ID of the version to update the related work on. For the related work id,
1020
- * pass it to the input JSON.
1021
- */
1022
- id: string;
1023
- /**
1024
- * @example {
1025
- * "category": "Design",
1026
- * "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
1027
- * "title": "Design link",
1028
- * "url": "https://www.atlassian.com"
1029
- * }
1030
- */
1031
- versionRelatedWork: VersionRelatedWork;
1032
- }): Promise<VersionRelatedWork> {
1033
- return this.getClientInstance()
1034
- .request({
1035
- path: "/rest/api/3/version/{id}/relatedwork",
1036
- method: "PUT",
1037
- pathParams: {
1038
- id,
1039
- },
1040
- headers: {
1041
- "Content-Type": "application/json",
1042
- },
1043
- body: versionRelatedWork,
1044
- })
1045
- .then(
1046
- this.getClientInstance().responseHandler({
1047
- 200: {
1048
- "application/json": "json",
1049
- },
1050
- }),
1051
- )
1052
- .then(
1053
- commonHttpClient.castResponse<{
1054
- status: 200;
1055
- mediaType: "application/json";
1056
- body: VersionRelatedWork;
1057
- }>(),
1058
- )
1059
- .then(
1060
- validationSchemaStorage.validator(
1061
- "ProjectVersionsService.updateRelatedWork.response",
1062
- ),
1063
- )
1064
- .then(commonHttpClient.getBody);
1065
- }
1066
- /**
1067
- * Updates a project version.
1068
- *
1069
- * This operation can be accessed anonymously.
1070
- *
1071
- * **[Permissions](#permissions) required:** *Administer Jira* [global
1072
- * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
1073
- * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
1074
- * that contains the version.
1075
- *
1076
- * @returns Returned if the request is successful.
1077
- *
1078
- * example: {
1079
- * "archived": false,
1080
- * "description": "An excellent version",
1081
- * "id": "10000",
1082
- * "name": "New Version 1",
1083
- * "project": "PXA",
1084
- * "projectId": 10000,
1085
- * "releaseDate": "2010-07-06",
1086
- * "released": true,
1087
- * "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
1088
- * "userReleaseDate": "6/Jul/2010"
1089
- * }
1090
- * @path {PUT} /rest/api/3/version/{id}
1091
- * @scopes-current manage:jira-project
1092
- * @scopes-beta write:project-version:jira, read:project-version:jira
1093
- */
1094
- updateVersion({
1095
- id,
1096
- version,
1097
- }: {
1098
- /** The ID of the version. */
1099
- id: string;
1100
- /**
1101
- * @example {
1102
- * "archived": false,
1103
- * "description": "An excellent version",
1104
- * "id": "10000",
1105
- * "name": "New Version 1",
1106
- * "overdue": true,
1107
- * "projectId": 10000,
1108
- * "releaseDate": "2010-07-06",
1109
- * "released": true,
1110
- * "self": "https://your-domain.atlassian.net/rest/api/~ver~/version/10000",
1111
- * "userReleaseDate": "6/Jul/2010"
1112
- * }
1113
- */
1114
- version: Version;
1115
- }): Promise<Version> {
1116
- return this.getClientInstance()
1117
- .request({
1118
- path: "/rest/api/3/version/{id}",
1119
- method: "PUT",
1120
- pathParams: {
1121
- id,
1122
- },
1123
- headers: {
1124
- "Content-Type": "application/json",
1125
- },
1126
- body: version,
1127
- })
1128
- .then(
1129
- this.getClientInstance().responseHandler({
1130
- 200: {
1131
- "application/json": "json",
1132
- },
1133
- }),
1134
- )
1135
- .then(
1136
- commonHttpClient.castResponse<{
1137
- status: 200;
1138
- mediaType: "application/json";
1139
- body: Version;
1140
- }>(),
1141
- )
1142
- .then(
1143
- validationSchemaStorage.validator(
1144
- "ProjectVersionsService.updateVersion.response",
1145
- ),
1146
- )
1147
- .then(commonHttpClient.getBody);
1148
- }
1149
- static initialize() {
1150
- validationSchemaStorage.registerExtensible(
1151
- "ProjectVersionsService.getProjectVersionsPaginated.response",
1152
- z
1153
- .object({
1154
- status: z.literal(200),
1155
- mediaType: z.literal("application/json"),
1156
- body: validationSchemaStorage.lazy("PageBeanVersion"),
1157
- })
1158
- .describe(
1159
- "ProjectVersionsService.getProjectVersionsPaginated.response",
1160
- ),
1161
- );
1162
- validationSchemaStorage.registerExtensible(
1163
- "ProjectVersionsService.getProjectVersions.response",
1164
- z
1165
- .object({
1166
- status: z.literal(200),
1167
- mediaType: z.literal("application/json"),
1168
- body: z.array(validationSchemaStorage.lazy("Version")),
1169
- })
1170
- .describe("ProjectVersionsService.getProjectVersions.response"),
1171
- );
1172
- validationSchemaStorage.registerExtensible(
1173
- "ProjectVersionsService.createVersion.response",
1174
- z
1175
- .object({
1176
- status: z.literal(201),
1177
- mediaType: z.literal("application/json"),
1178
- body: validationSchemaStorage.lazy("Version"),
1179
- })
1180
- .describe("ProjectVersionsService.createVersion.response"),
1181
- );
1182
- validationSchemaStorage.registerExtensible(
1183
- "ProjectVersionsService.getVersion.response",
1184
- z
1185
- .object({
1186
- status: z.literal(200),
1187
- mediaType: z.literal("application/json"),
1188
- body: validationSchemaStorage.lazy("Version"),
1189
- })
1190
- .describe("ProjectVersionsService.getVersion.response"),
1191
- );
1192
- validationSchemaStorage.registerExtensible(
1193
- "ProjectVersionsService.updateVersion.response",
1194
- z
1195
- .object({
1196
- status: z.literal(200),
1197
- mediaType: z.literal("application/json"),
1198
- body: validationSchemaStorage.lazy("Version"),
1199
- })
1200
- .describe("ProjectVersionsService.updateVersion.response"),
1201
- );
1202
- validationSchemaStorage.registerExtensible(
1203
- "ProjectVersionsService.mergeVersions.response",
1204
- z
1205
- .object({
1206
- status: z.literal(204),
1207
- mediaType: z.literal("application/json"),
1208
- body: z.unknown(),
1209
- })
1210
- .describe("ProjectVersionsService.mergeVersions.response"),
1211
- );
1212
- validationSchemaStorage.registerExtensible(
1213
- "ProjectVersionsService.moveVersion.response",
1214
- z
1215
- .object({
1216
- status: z.literal(200),
1217
- mediaType: z.literal("application/json"),
1218
- body: validationSchemaStorage.lazy("Version"),
1219
- })
1220
- .describe("ProjectVersionsService.moveVersion.response"),
1221
- );
1222
- validationSchemaStorage.registerExtensible(
1223
- "ProjectVersionsService.getVersionRelatedIssues.response",
1224
- z
1225
- .object({
1226
- status: z.literal(200),
1227
- mediaType: z.literal("application/json"),
1228
- body: validationSchemaStorage.lazy("VersionIssueCounts"),
1229
- })
1230
- .describe("ProjectVersionsService.getVersionRelatedIssues.response"),
1231
- );
1232
- validationSchemaStorage.registerExtensible(
1233
- "ProjectVersionsService.getRelatedWork.response",
1234
- z
1235
- .object({
1236
- status: z.literal(200),
1237
- mediaType: z.literal("application/json"),
1238
- body: z.array(validationSchemaStorage.lazy("VersionRelatedWork")),
1239
- })
1240
- .describe("ProjectVersionsService.getRelatedWork.response"),
1241
- );
1242
- validationSchemaStorage.registerExtensible(
1243
- "ProjectVersionsService.updateRelatedWork.response",
1244
- z
1245
- .object({
1246
- status: z.literal(200),
1247
- mediaType: z.literal("application/json"),
1248
- body: validationSchemaStorage.lazy("VersionRelatedWork"),
1249
- })
1250
- .describe("ProjectVersionsService.updateRelatedWork.response"),
1251
- );
1252
- validationSchemaStorage.registerExtensible(
1253
- "ProjectVersionsService.createRelatedWork.response",
1254
- z
1255
- .object({
1256
- status: z.literal(201),
1257
- mediaType: z.literal("application/json"),
1258
- body: validationSchemaStorage.lazy("VersionRelatedWork"),
1259
- })
1260
- .describe("ProjectVersionsService.createRelatedWork.response"),
1261
- );
1262
- validationSchemaStorage.registerExtensible(
1263
- "ProjectVersionsService.deleteAndReplaceVersion.response",
1264
- z
1265
- .object({
1266
- status: z.literal(204),
1267
- mediaType: z.literal("application/json"),
1268
- body: z.unknown(),
1269
- })
1270
- .describe("ProjectVersionsService.deleteAndReplaceVersion.response"),
1271
- );
1272
- validationSchemaStorage.registerExtensible(
1273
- "ProjectVersionsService.getVersionUnresolvedIssues.response",
1274
- z
1275
- .object({
1276
- status: z.literal(200),
1277
- mediaType: z.literal("application/json"),
1278
- body: validationSchemaStorage.lazy("VersionUnresolvedIssuesCount"),
1279
- })
1280
- .describe("ProjectVersionsService.getVersionUnresolvedIssues.response"),
1281
- );
1282
- validationSchemaStorage.registerOnce([
1283
- registerProjectVersionsValidationSchemas,
1284
- registerCommonValidationSchemas,
1285
- ]);
1286
- }
1287
- }