@resolution/jira-api-client 0.1.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 (785) hide show
  1. package/.eslintrc.js +3 -0
  2. package/CHANGELOG.md +11 -0
  3. package/LICENSE.md +19 -0
  4. package/README.md +12 -0
  5. package/config/api-typescript-generator.config.ts +91 -0
  6. package/config/compare-schemas.ts +307 -0
  7. package/lib/index.d.ts +15 -0
  8. package/lib/index.js +25 -0
  9. package/lib/index.js.map +1 -0
  10. package/lib/openapi/platform/base-jira-platform-api-client.d.ts +868 -0
  11. package/lib/openapi/platform/base-jira-platform-api-client.js +808 -0
  12. package/lib/openapi/platform/base-jira-platform-api-client.js.map +1 -0
  13. package/lib/openapi/platform/core/common-http-client.d.ts +196 -0
  14. package/lib/openapi/platform/core/common-http-client.js +390 -0
  15. package/lib/openapi/platform/core/common-http-client.js.map +1 -0
  16. package/lib/openapi/platform/core/common-http-service.d.ts +7 -0
  17. package/lib/openapi/platform/core/common-http-service.js +20 -0
  18. package/lib/openapi/platform/core/common-http-service.js.map +1 -0
  19. package/lib/openapi/platform/core/common-validation-schema-storage.d.ts +35 -0
  20. package/lib/openapi/platform/core/common-validation-schema-storage.js +65 -0
  21. package/lib/openapi/platform/core/common-validation-schema-storage.js.map +1 -0
  22. package/lib/openapi/platform/models/announcement-banner.d.ts +27 -0
  23. package/lib/openapi/platform/models/announcement-banner.js +30 -0
  24. package/lib/openapi/platform/models/announcement-banner.js.map +1 -0
  25. package/lib/openapi/platform/models/app-data-policies.d.ts +31 -0
  26. package/lib/openapi/platform/models/app-data-policies.js +40 -0
  27. package/lib/openapi/platform/models/app-data-policies.js.map +1 -0
  28. package/lib/openapi/platform/models/app-migration.d.ts +86 -0
  29. package/lib/openapi/platform/models/app-migration.js +67 -0
  30. package/lib/openapi/platform/models/app-migration.js.map +1 -0
  31. package/lib/openapi/platform/models/app-properties.d.ts +15 -0
  32. package/lib/openapi/platform/models/app-properties.js +18 -0
  33. package/lib/openapi/platform/models/app-properties.js.map +1 -0
  34. package/lib/openapi/platform/models/audit-records.d.ts +70 -0
  35. package/lib/openapi/platform/models/audit-records.js +62 -0
  36. package/lib/openapi/platform/models/audit-records.js.map +1 -0
  37. package/lib/openapi/platform/models/avatars.d.ts +18 -0
  38. package/lib/openapi/platform/models/avatars.js +27 -0
  39. package/lib/openapi/platform/models/avatars.js.map +1 -0
  40. package/lib/openapi/platform/models/classification-levels.d.ts +25 -0
  41. package/lib/openapi/platform/models/classification-levels.js +31 -0
  42. package/lib/openapi/platform/models/classification-levels.js.map +1 -0
  43. package/lib/openapi/platform/models/common.d.ts +1490 -0
  44. package/lib/openapi/platform/models/common.js +937 -0
  45. package/lib/openapi/platform/models/common.js.map +1 -0
  46. package/lib/openapi/platform/models/dashboards.d.ts +414 -0
  47. package/lib/openapi/platform/models/dashboards.js +325 -0
  48. package/lib/openapi/platform/models/dashboards.js.map +1 -0
  49. package/lib/openapi/platform/models/dynamic-modules.d.ts +92 -0
  50. package/lib/openapi/platform/models/dynamic-modules.js +24 -0
  51. package/lib/openapi/platform/models/dynamic-modules.js.map +1 -0
  52. package/lib/openapi/platform/models/filter-sharing.d.ts +59 -0
  53. package/lib/openapi/platform/models/filter-sharing.js +36 -0
  54. package/lib/openapi/platform/models/filter-sharing.js.map +1 -0
  55. package/lib/openapi/platform/models/filters.d.ts +183 -0
  56. package/lib/openapi/platform/models/filters.js +115 -0
  57. package/lib/openapi/platform/models/filters.js.map +1 -0
  58. package/lib/openapi/platform/models/group-and-user-picker.d.ts +49 -0
  59. package/lib/openapi/platform/models/group-and-user-picker.js +31 -0
  60. package/lib/openapi/platform/models/group-and-user-picker.js.map +1 -0
  61. package/lib/openapi/platform/models/groups.d.ts +127 -0
  62. package/lib/openapi/platform/models/groups.js +98 -0
  63. package/lib/openapi/platform/models/groups.js.map +1 -0
  64. package/lib/openapi/platform/models/issue-attachments.d.ts +124 -0
  65. package/lib/openapi/platform/models/issue-attachments.js +129 -0
  66. package/lib/openapi/platform/models/issue-attachments.js.map +1 -0
  67. package/lib/openapi/platform/models/issue-comment-properties.d.ts +10 -0
  68. package/lib/openapi/platform/models/issue-comment-properties.js +18 -0
  69. package/lib/openapi/platform/models/issue-comment-properties.js.map +1 -0
  70. package/lib/openapi/platform/models/issue-comments.d.ts +36 -0
  71. package/lib/openapi/platform/models/issue-comments.js +49 -0
  72. package/lib/openapi/platform/models/issue-comments.js.map +1 -0
  73. package/lib/openapi/platform/models/issue-custom-field-configuration-apps.d.ts +36 -0
  74. package/lib/openapi/platform/models/issue-custom-field-configuration-apps.js +53 -0
  75. package/lib/openapi/platform/models/issue-custom-field-configuration-apps.js.map +1 -0
  76. package/lib/openapi/platform/models/issue-custom-field-contexts.d.ts +417 -0
  77. package/lib/openapi/platform/models/issue-custom-field-contexts.js +458 -0
  78. package/lib/openapi/platform/models/issue-custom-field-contexts.js.map +1 -0
  79. package/lib/openapi/platform/models/issue-custom-field-options-apps.d.ts +119 -0
  80. package/lib/openapi/platform/models/issue-custom-field-options-apps.js +133 -0
  81. package/lib/openapi/platform/models/issue-custom-field-options-apps.js.map +1 -0
  82. package/lib/openapi/platform/models/issue-custom-field-options.d.ts +136 -0
  83. package/lib/openapi/platform/models/issue-custom-field-options.js +115 -0
  84. package/lib/openapi/platform/models/issue-custom-field-options.js.map +1 -0
  85. package/lib/openapi/platform/models/issue-custom-field-values-apps.d.ts +66 -0
  86. package/lib/openapi/platform/models/issue-custom-field-values-apps.js +42 -0
  87. package/lib/openapi/platform/models/issue-custom-field-values-apps.js.map +1 -0
  88. package/lib/openapi/platform/models/issue-field-configurations.d.ts +194 -0
  89. package/lib/openapi/platform/models/issue-field-configurations.js +182 -0
  90. package/lib/openapi/platform/models/issue-field-configurations.js.map +1 -0
  91. package/lib/openapi/platform/models/issue-fields.d.ts +227 -0
  92. package/lib/openapi/platform/models/issue-fields.js +119 -0
  93. package/lib/openapi/platform/models/issue-fields.js.map +1 -0
  94. package/lib/openapi/platform/models/issue-link-types.d.ts +9 -0
  95. package/lib/openapi/platform/models/issue-link-types.js +21 -0
  96. package/lib/openapi/platform/models/issue-link-types.js.map +1 -0
  97. package/lib/openapi/platform/models/issue-links.d.ts +90 -0
  98. package/lib/openapi/platform/models/issue-links.js +74 -0
  99. package/lib/openapi/platform/models/issue-links.js.map +1 -0
  100. package/lib/openapi/platform/models/issue-notification-schemes.d.ts +158 -0
  101. package/lib/openapi/platform/models/issue-notification-schemes.js +147 -0
  102. package/lib/openapi/platform/models/issue-notification-schemes.js.map +1 -0
  103. package/lib/openapi/platform/models/issue-priorities.d.ts +74 -0
  104. package/lib/openapi/platform/models/issue-priorities.js +89 -0
  105. package/lib/openapi/platform/models/issue-priorities.js.map +1 -0
  106. package/lib/openapi/platform/models/issue-properties.d.ts +80 -0
  107. package/lib/openapi/platform/models/issue-properties.js +158 -0
  108. package/lib/openapi/platform/models/issue-properties.js.map +1 -0
  109. package/lib/openapi/platform/models/issue-remote-links.d.ts +120 -0
  110. package/lib/openapi/platform/models/issue-remote-links.js +70 -0
  111. package/lib/openapi/platform/models/issue-remote-links.js.map +1 -0
  112. package/lib/openapi/platform/models/issue-resolutions.d.ts +81 -0
  113. package/lib/openapi/platform/models/issue-resolutions.js +79 -0
  114. package/lib/openapi/platform/models/issue-resolutions.js.map +1 -0
  115. package/lib/openapi/platform/models/issue-search.d.ts +196 -0
  116. package/lib/openapi/platform/models/issue-search.js +136 -0
  117. package/lib/openapi/platform/models/issue-search.js.map +1 -0
  118. package/lib/openapi/platform/models/issue-security-level.d.ts +36 -0
  119. package/lib/openapi/platform/models/issue-security-level.js +36 -0
  120. package/lib/openapi/platform/models/issue-security-level.js.map +1 -0
  121. package/lib/openapi/platform/models/issue-security-schemes.d.ts +214 -0
  122. package/lib/openapi/platform/models/issue-security-schemes.js +211 -0
  123. package/lib/openapi/platform/models/issue-security-schemes.js.map +1 -0
  124. package/lib/openapi/platform/models/issue-type-schemes.d.ts +146 -0
  125. package/lib/openapi/platform/models/issue-type-schemes.js +115 -0
  126. package/lib/openapi/platform/models/issue-type-schemes.js.map +1 -0
  127. package/lib/openapi/platform/models/issue-type-screen-schemes.d.ts +139 -0
  128. package/lib/openapi/platform/models/issue-type-screen-schemes.js +109 -0
  129. package/lib/openapi/platform/models/issue-type-screen-schemes.js.map +1 -0
  130. package/lib/openapi/platform/models/issue-types.d.ts +36 -0
  131. package/lib/openapi/platform/models/issue-types.js +28 -0
  132. package/lib/openapi/platform/models/issue-types.js.map +1 -0
  133. package/lib/openapi/platform/models/issue-votes.d.ts +18 -0
  134. package/lib/openapi/platform/models/issue-votes.js +22 -0
  135. package/lib/openapi/platform/models/issue-votes.js.map +1 -0
  136. package/lib/openapi/platform/models/issue-watchers.d.ts +27 -0
  137. package/lib/openapi/platform/models/issue-watchers.js +36 -0
  138. package/lib/openapi/platform/models/issue-watchers.js.map +1 -0
  139. package/lib/openapi/platform/models/issue-worklogs.d.ts +93 -0
  140. package/lib/openapi/platform/models/issue-worklogs.js +80 -0
  141. package/lib/openapi/platform/models/issue-worklogs.js.map +1 -0
  142. package/lib/openapi/platform/models/issues.d.ts +583 -0
  143. package/lib/openapi/platform/models/issues.js +545 -0
  144. package/lib/openapi/platform/models/issues.js.map +1 -0
  145. package/lib/openapi/platform/models/jira-expressions.d.ts +329 -0
  146. package/lib/openapi/platform/models/jira-expressions.js +180 -0
  147. package/lib/openapi/platform/models/jira-expressions.js.map +1 -0
  148. package/lib/openapi/platform/models/jira-settings.d.ts +62 -0
  149. package/lib/openapi/platform/models/jira-settings.js +49 -0
  150. package/lib/openapi/platform/models/jira-settings.js.map +1 -0
  151. package/lib/openapi/platform/models/jql-functions-apps.d.ts +61 -0
  152. package/lib/openapi/platform/models/jql-functions-apps.js +57 -0
  153. package/lib/openapi/platform/models/jql-functions-apps.js.map +1 -0
  154. package/lib/openapi/platform/models/jql.d.ts +348 -0
  155. package/lib/openapi/platform/models/jql.js +309 -0
  156. package/lib/openapi/platform/models/jql.js.map +1 -0
  157. package/lib/openapi/platform/models/labels.d.ts +20 -0
  158. package/lib/openapi/platform/models/labels.js +23 -0
  159. package/lib/openapi/platform/models/labels.js.map +1 -0
  160. package/lib/openapi/platform/models/license-metrics.d.ts +27 -0
  161. package/lib/openapi/platform/models/license-metrics.js +32 -0
  162. package/lib/openapi/platform/models/license-metrics.js.map +1 -0
  163. package/lib/openapi/platform/models/myself.d.ts +13 -0
  164. package/lib/openapi/platform/models/myself.js +17 -0
  165. package/lib/openapi/platform/models/myself.js.map +1 -0
  166. package/lib/openapi/platform/models/permission-schemes.d.ts +42 -0
  167. package/lib/openapi/platform/models/permission-schemes.js +39 -0
  168. package/lib/openapi/platform/models/permission-schemes.js.map +1 -0
  169. package/lib/openapi/platform/models/permissions.d.ts +97 -0
  170. package/lib/openapi/platform/models/permissions.js +176 -0
  171. package/lib/openapi/platform/models/permissions.js.map +1 -0
  172. package/lib/openapi/platform/models/priority-schemes.d.ts +233 -0
  173. package/lib/openapi/platform/models/priority-schemes.js +227 -0
  174. package/lib/openapi/platform/models/priority-schemes.js.map +1 -0
  175. package/lib/openapi/platform/models/project-avatars.d.ts +11 -0
  176. package/lib/openapi/platform/models/project-avatars.js +20 -0
  177. package/lib/openapi/platform/models/project-avatars.js.map +1 -0
  178. package/lib/openapi/platform/models/project-classification-levels.d.ts +8 -0
  179. package/lib/openapi/platform/models/project-classification-levels.js +17 -0
  180. package/lib/openapi/platform/models/project-classification-levels.js.map +1 -0
  181. package/lib/openapi/platform/models/project-components.d.ts +122 -0
  182. package/lib/openapi/platform/models/project-components.js +91 -0
  183. package/lib/openapi/platform/models/project-components.js.map +1 -0
  184. package/lib/openapi/platform/models/project-email.d.ts +10 -0
  185. package/lib/openapi/platform/models/project-email.js +18 -0
  186. package/lib/openapi/platform/models/project-email.js.map +1 -0
  187. package/lib/openapi/platform/models/project-features.d.ts +35 -0
  188. package/lib/openapi/platform/models/project-features.js +38 -0
  189. package/lib/openapi/platform/models/project-features.js.map +1 -0
  190. package/lib/openapi/platform/models/project-permission-schemes.d.ts +17 -0
  191. package/lib/openapi/platform/models/project-permission-schemes.js +25 -0
  192. package/lib/openapi/platform/models/project-permission-schemes.js.map +1 -0
  193. package/lib/openapi/platform/models/project-role-actors.d.ts +65 -0
  194. package/lib/openapi/platform/models/project-role-actors.js +37 -0
  195. package/lib/openapi/platform/models/project-role-actors.js.map +1 -0
  196. package/lib/openapi/platform/models/project-roles.d.ts +41 -0
  197. package/lib/openapi/platform/models/project-roles.js +34 -0
  198. package/lib/openapi/platform/models/project-roles.js.map +1 -0
  199. package/lib/openapi/platform/models/project-types.d.ts +16 -0
  200. package/lib/openapi/platform/models/project-types.js +21 -0
  201. package/lib/openapi/platform/models/project-types.js.map +1 -0
  202. package/lib/openapi/platform/models/project-versions.d.ts +110 -0
  203. package/lib/openapi/platform/models/project-versions.js +87 -0
  204. package/lib/openapi/platform/models/project-versions.js.map +1 -0
  205. package/lib/openapi/platform/models/projects.d.ts +216 -0
  206. package/lib/openapi/platform/models/projects.js +149 -0
  207. package/lib/openapi/platform/models/projects.js.map +1 -0
  208. package/lib/openapi/platform/models/screen-schemes.d.ts +94 -0
  209. package/lib/openapi/platform/models/screen-schemes.js +79 -0
  210. package/lib/openapi/platform/models/screen-schemes.js.map +1 -0
  211. package/lib/openapi/platform/models/screen-tab-fields.d.ts +19 -0
  212. package/lib/openapi/platform/models/screen-tab-fields.js +24 -0
  213. package/lib/openapi/platform/models/screen-tab-fields.js.map +1 -0
  214. package/lib/openapi/platform/models/screens.d.ts +82 -0
  215. package/lib/openapi/platform/models/screens.js +72 -0
  216. package/lib/openapi/platform/models/screens.js.map +1 -0
  217. package/lib/openapi/platform/models/server-info.d.ts +51 -0
  218. package/lib/openapi/platform/models/server-info.js +47 -0
  219. package/lib/openapi/platform/models/server-info.js.map +1 -0
  220. package/lib/openapi/platform/models/service-registry.d.ts +32 -0
  221. package/lib/openapi/platform/models/service-registry.js +34 -0
  222. package/lib/openapi/platform/models/service-registry.js.map +1 -0
  223. package/lib/openapi/platform/models/status.d.ts +95 -0
  224. package/lib/openapi/platform/models/status.js +107 -0
  225. package/lib/openapi/platform/models/status.js.map +1 -0
  226. package/lib/openapi/platform/models/time-tracking.d.ts +20 -0
  227. package/lib/openapi/platform/models/time-tracking.js +19 -0
  228. package/lib/openapi/platform/models/time-tracking.js.map +1 -0
  229. package/lib/openapi/platform/models/ui-modifications-apps.d.ts +127 -0
  230. package/lib/openapi/platform/models/ui-modifications-apps.js +85 -0
  231. package/lib/openapi/platform/models/ui-modifications-apps.js.map +1 -0
  232. package/lib/openapi/platform/models/user-search.d.ts +37 -0
  233. package/lib/openapi/platform/models/user-search.js +30 -0
  234. package/lib/openapi/platform/models/user-search.js.map +1 -0
  235. package/lib/openapi/platform/models/users.d.ts +60 -0
  236. package/lib/openapi/platform/models/users.js +53 -0
  237. package/lib/openapi/platform/models/users.js.map +1 -0
  238. package/lib/openapi/platform/models/webhooks.d.ts +147 -0
  239. package/lib/openapi/platform/models/webhooks.js +112 -0
  240. package/lib/openapi/platform/models/webhooks.js.map +1 -0
  241. package/lib/openapi/platform/models/workflow-scheme-drafts.d.ts +17 -0
  242. package/lib/openapi/platform/models/workflow-scheme-drafts.js +37 -0
  243. package/lib/openapi/platform/models/workflow-scheme-drafts.js.map +1 -0
  244. package/lib/openapi/platform/models/workflow-scheme-project-associations.d.ts +29 -0
  245. package/lib/openapi/platform/models/workflow-scheme-project-associations.js +33 -0
  246. package/lib/openapi/platform/models/workflow-scheme-project-associations.js.map +1 -0
  247. package/lib/openapi/platform/models/workflow-schemes.d.ts +217 -0
  248. package/lib/openapi/platform/models/workflow-schemes.js +261 -0
  249. package/lib/openapi/platform/models/workflow-schemes.js.map +1 -0
  250. package/lib/openapi/platform/models/workflow-transition-properties.d.ts +15 -0
  251. package/lib/openapi/platform/models/workflow-transition-properties.js +19 -0
  252. package/lib/openapi/platform/models/workflow-transition-properties.js.map +1 -0
  253. package/lib/openapi/platform/models/workflow-transition-rules.d.ts +106 -0
  254. package/lib/openapi/platform/models/workflow-transition-rules.js +117 -0
  255. package/lib/openapi/platform/models/workflow-transition-rules.js.map +1 -0
  256. package/lib/openapi/platform/models/workflows.d.ts +848 -0
  257. package/lib/openapi/platform/models/workflows.js +824 -0
  258. package/lib/openapi/platform/models/workflows.js.map +1 -0
  259. package/lib/openapi/platform/services/announcement-banner-service.d.ts +49 -0
  260. package/lib/openapi/platform/services/announcement-banner-service.js +99 -0
  261. package/lib/openapi/platform/services/announcement-banner-service.js.map +1 -0
  262. package/lib/openapi/platform/services/app-data-policies-service.d.ts +44 -0
  263. package/lib/openapi/platform/services/app-data-policies-service.js +101 -0
  264. package/lib/openapi/platform/services/app-data-policies-service.js.map +1 -0
  265. package/lib/openapi/platform/services/app-migration-service.d.ts +152 -0
  266. package/lib/openapi/platform/services/app-migration-service.js +178 -0
  267. package/lib/openapi/platform/services/app-migration-service.js.map +1 -0
  268. package/lib/openapi/platform/services/app-properties-service.d.ts +184 -0
  269. package/lib/openapi/platform/services/app-properties-service.js +325 -0
  270. package/lib/openapi/platform/services/app-properties-service.js.map +1 -0
  271. package/lib/openapi/platform/services/application-roles-service.d.ts +158 -0
  272. package/lib/openapi/platform/services/application-roles-service.js +209 -0
  273. package/lib/openapi/platform/services/application-roles-service.js.map +1 -0
  274. package/lib/openapi/platform/services/audit-records-service.d.ts +101 -0
  275. package/lib/openapi/platform/services/audit-records-service.js +125 -0
  276. package/lib/openapi/platform/services/audit-records-service.js.map +1 -0
  277. package/lib/openapi/platform/services/avatars-service.d.ts +363 -0
  278. package/lib/openapi/platform/services/avatars-service.js +523 -0
  279. package/lib/openapi/platform/services/avatars-service.js.map +1 -0
  280. package/lib/openapi/platform/services/classification-levels-service.d.ts +72 -0
  281. package/lib/openapi/platform/services/classification-levels-service.js +104 -0
  282. package/lib/openapi/platform/services/classification-levels-service.js.map +1 -0
  283. package/lib/openapi/platform/services/dashboards-service.d.ts +918 -0
  284. package/lib/openapi/platform/services/dashboards-service.js +1109 -0
  285. package/lib/openapi/platform/services/dashboards-service.js.map +1 -0
  286. package/lib/openapi/platform/services/dynamic-modules-service.d.ts +50 -0
  287. package/lib/openapi/platform/services/dynamic-modules-service.js +96 -0
  288. package/lib/openapi/platform/services/dynamic-modules-service.js.map +1 -0
  289. package/lib/openapi/platform/services/filter-sharing-service.d.ts +446 -0
  290. package/lib/openapi/platform/services/filter-sharing-service.js +565 -0
  291. package/lib/openapi/platform/services/filter-sharing-service.js.map +1 -0
  292. package/lib/openapi/platform/services/filters-service.d.ts +1320 -0
  293. package/lib/openapi/platform/services/filters-service.js +1351 -0
  294. package/lib/openapi/platform/services/filters-service.js.map +1 -0
  295. package/lib/openapi/platform/services/group-and-user-picker-service.d.ts +132 -0
  296. package/lib/openapi/platform/services/group-and-user-picker-service.js +140 -0
  297. package/lib/openapi/platform/services/group-and-user-picker-service.js.map +1 -0
  298. package/lib/openapi/platform/services/groups-service.d.ts +411 -0
  299. package/lib/openapi/platform/services/groups-service.js +448 -0
  300. package/lib/openapi/platform/services/groups-service.js.map +1 -0
  301. package/lib/openapi/platform/services/issue-attachments-service.d.ts +549 -0
  302. package/lib/openapi/platform/services/issue-attachments-service.js +724 -0
  303. package/lib/openapi/platform/services/issue-attachments-service.js.map +1 -0
  304. package/lib/openapi/platform/services/issue-comment-properties-service.d.ts +149 -0
  305. package/lib/openapi/platform/services/issue-comment-properties-service.js +239 -0
  306. package/lib/openapi/platform/services/issue-comment-properties-service.js.map +1 -0
  307. package/lib/openapi/platform/services/issue-comments-service.d.ts +528 -0
  308. package/lib/openapi/platform/services/issue-comments-service.js +563 -0
  309. package/lib/openapi/platform/services/issue-comments-service.js.map +1 -0
  310. package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.d.ts +155 -0
  311. package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.js +163 -0
  312. package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.js.map +1 -0
  313. package/lib/openapi/platform/services/issue-custom-field-contexts-service.d.ts +659 -0
  314. package/lib/openapi/platform/services/issue-custom-field-contexts-service.js +854 -0
  315. package/lib/openapi/platform/services/issue-custom-field-contexts-service.js.map +1 -0
  316. package/lib/openapi/platform/services/issue-custom-field-options-apps-service.d.ts +615 -0
  317. package/lib/openapi/platform/services/issue-custom-field-options-apps-service.js +605 -0
  318. package/lib/openapi/platform/services/issue-custom-field-options-apps-service.js.map +1 -0
  319. package/lib/openapi/platform/services/issue-custom-field-options-service.d.ts +339 -0
  320. package/lib/openapi/platform/services/issue-custom-field-options-service.js +420 -0
  321. package/lib/openapi/platform/services/issue-custom-field-options-service.js.map +1 -0
  322. package/lib/openapi/platform/services/issue-custom-field-values-apps-service.d.ts +90 -0
  323. package/lib/openapi/platform/services/issue-custom-field-values-apps-service.js +117 -0
  324. package/lib/openapi/platform/services/issue-custom-field-values-apps-service.js.map +1 -0
  325. package/lib/openapi/platform/services/issue-field-configurations-service.d.ts +561 -0
  326. package/lib/openapi/platform/services/issue-field-configurations-service.js +801 -0
  327. package/lib/openapi/platform/services/issue-field-configurations-service.js.map +1 -0
  328. package/lib/openapi/platform/services/issue-fields-service.d.ts +420 -0
  329. package/lib/openapi/platform/services/issue-fields-service.js +555 -0
  330. package/lib/openapi/platform/services/issue-fields-service.js.map +1 -0
  331. package/lib/openapi/platform/services/issue-link-types-service.d.ts +165 -0
  332. package/lib/openapi/platform/services/issue-link-types-service.js +263 -0
  333. package/lib/openapi/platform/services/issue-link-types-service.js.map +1 -0
  334. package/lib/openapi/platform/services/issue-links-service.d.ts +237 -0
  335. package/lib/openapi/platform/services/issue-links-service.js +264 -0
  336. package/lib/openapi/platform/services/issue-links-service.js.map +1 -0
  337. package/lib/openapi/platform/services/issue-navigator-settings-service.d.ts +55 -0
  338. package/lib/openapi/platform/services/issue-navigator-settings-service.js +97 -0
  339. package/lib/openapi/platform/services/issue-navigator-settings-service.js.map +1 -0
  340. package/lib/openapi/platform/services/issue-notification-schemes-service.d.ts +809 -0
  341. package/lib/openapi/platform/services/issue-notification-schemes-service.js +917 -0
  342. package/lib/openapi/platform/services/issue-notification-schemes-service.js.map +1 -0
  343. package/lib/openapi/platform/services/issue-priorities-service.d.ts +238 -0
  344. package/lib/openapi/platform/services/issue-priorities-service.js +372 -0
  345. package/lib/openapi/platform/services/issue-priorities-service.js.map +1 -0
  346. package/lib/openapi/platform/services/issue-properties-service.d.ts +368 -0
  347. package/lib/openapi/platform/services/issue-properties-service.js +439 -0
  348. package/lib/openapi/platform/services/issue-properties-service.js.map +1 -0
  349. package/lib/openapi/platform/services/issue-remote-links-service.d.ts +351 -0
  350. package/lib/openapi/platform/services/issue-remote-links-service.js +429 -0
  351. package/lib/openapi/platform/services/issue-remote-links-service.js.map +1 -0
  352. package/lib/openapi/platform/services/issue-resolutions-service.d.ts +202 -0
  353. package/lib/openapi/platform/services/issue-resolutions-service.js +346 -0
  354. package/lib/openapi/platform/services/issue-resolutions-service.js.map +1 -0
  355. package/lib/openapi/platform/services/issue-search-service.d.ts +887 -0
  356. package/lib/openapi/platform/services/issue-search-service.js +878 -0
  357. package/lib/openapi/platform/services/issue-search-service.js.map +1 -0
  358. package/lib/openapi/platform/services/issue-security-level-service.d.ts +136 -0
  359. package/lib/openapi/platform/services/issue-security-level-service.js +174 -0
  360. package/lib/openapi/platform/services/issue-security-level-service.js.map +1 -0
  361. package/lib/openapi/platform/services/issue-security-schemes-service.d.ts +530 -0
  362. package/lib/openapi/platform/services/issue-security-schemes-service.js +721 -0
  363. package/lib/openapi/platform/services/issue-security-schemes-service.js.map +1 -0
  364. package/lib/openapi/platform/services/issue-type-properties-service.d.ts +150 -0
  365. package/lib/openapi/platform/services/issue-type-properties-service.js +227 -0
  366. package/lib/openapi/platform/services/issue-type-properties-service.js.map +1 -0
  367. package/lib/openapi/platform/services/issue-type-schemes-service.d.ts +460 -0
  368. package/lib/openapi/platform/services/issue-type-schemes-service.js +615 -0
  369. package/lib/openapi/platform/services/issue-type-schemes-service.js.map +1 -0
  370. package/lib/openapi/platform/services/issue-type-screen-schemes-service.d.ts +442 -0
  371. package/lib/openapi/platform/services/issue-type-screen-schemes-service.js +606 -0
  372. package/lib/openapi/platform/services/issue-type-screen-schemes-service.js.map +1 -0
  373. package/lib/openapi/platform/services/issue-types-service.d.ts +343 -0
  374. package/lib/openapi/platform/services/issue-types-service.js +495 -0
  375. package/lib/openapi/platform/services/issue-types-service.js.map +1 -0
  376. package/lib/openapi/platform/services/issue-votes-service.d.ts +117 -0
  377. package/lib/openapi/platform/services/issue-votes-service.js +179 -0
  378. package/lib/openapi/platform/services/issue-votes-service.js.map +1 -0
  379. package/lib/openapi/platform/services/issue-watchers-service.d.ts +168 -0
  380. package/lib/openapi/platform/services/issue-watchers-service.js +236 -0
  381. package/lib/openapi/platform/services/issue-watchers-service.js.map +1 -0
  382. package/lib/openapi/platform/services/issue-worklog-properties-service.d.ts +165 -0
  383. package/lib/openapi/platform/services/issue-worklog-properties-service.js +251 -0
  384. package/lib/openapi/platform/services/issue-worklog-properties-service.js.map +1 -0
  385. package/lib/openapi/platform/services/issue-worklogs-service.d.ts +694 -0
  386. package/lib/openapi/platform/services/issue-worklogs-service.js +701 -0
  387. package/lib/openapi/platform/services/issue-worklogs-service.js.map +1 -0
  388. package/lib/openapi/platform/services/issues-service.d.ts +2356 -0
  389. package/lib/openapi/platform/services/issues-service.js +2022 -0
  390. package/lib/openapi/platform/services/issues-service.js.map +1 -0
  391. package/lib/openapi/platform/services/jira-expressions-service.d.ts +298 -0
  392. package/lib/openapi/platform/services/jira-expressions-service.js +272 -0
  393. package/lib/openapi/platform/services/jira-expressions-service.js.map +1 -0
  394. package/lib/openapi/platform/services/jira-settings-service.d.ts +236 -0
  395. package/lib/openapi/platform/services/jira-settings-service.js +325 -0
  396. package/lib/openapi/platform/services/jira-settings-service.js.map +1 -0
  397. package/lib/openapi/platform/services/jql-functions-apps-service.d.ts +113 -0
  398. package/lib/openapi/platform/services/jql-functions-apps-service.js +142 -0
  399. package/lib/openapi/platform/services/jql-functions-apps-service.js.map +1 -0
  400. package/lib/openapi/platform/services/jql-service.d.ts +623 -0
  401. package/lib/openapi/platform/services/jql-service.js +697 -0
  402. package/lib/openapi/platform/services/jql-service.js.map +1 -0
  403. package/lib/openapi/platform/services/labels-service.d.ts +34 -0
  404. package/lib/openapi/platform/services/labels-service.js +67 -0
  405. package/lib/openapi/platform/services/labels-service.js.map +1 -0
  406. package/lib/openapi/platform/services/license-metrics-service.d.ts +82 -0
  407. package/lib/openapi/platform/services/license-metrics-service.js +160 -0
  408. package/lib/openapi/platform/services/license-metrics-service.js.map +1 -0
  409. package/lib/openapi/platform/services/myself-service.d.ts +254 -0
  410. package/lib/openapi/platform/services/myself-service.js +382 -0
  411. package/lib/openapi/platform/services/myself-service.js.map +1 -0
  412. package/lib/openapi/platform/services/permission-schemes-service.d.ts +554 -0
  413. package/lib/openapi/platform/services/permission-schemes-service.js +613 -0
  414. package/lib/openapi/platform/services/permission-schemes-service.js.map +1 -0
  415. package/lib/openapi/platform/services/permissions-service.d.ts +214 -0
  416. package/lib/openapi/platform/services/permissions-service.js +281 -0
  417. package/lib/openapi/platform/services/permissions-service.js.map +1 -0
  418. package/lib/openapi/platform/services/priority-schemes-service.d.ts +578 -0
  419. package/lib/openapi/platform/services/priority-schemes-service.js +655 -0
  420. package/lib/openapi/platform/services/priority-schemes-service.js.map +1 -0
  421. package/lib/openapi/platform/services/project-avatars-service.d.ts +170 -0
  422. package/lib/openapi/platform/services/project-avatars-service.js +254 -0
  423. package/lib/openapi/platform/services/project-avatars-service.js.map +1 -0
  424. package/lib/openapi/platform/services/project-categories-service.d.ts +128 -0
  425. package/lib/openapi/platform/services/project-categories-service.js +226 -0
  426. package/lib/openapi/platform/services/project-categories-service.js.map +1 -0
  427. package/lib/openapi/platform/services/project-classification-levels-service.d.ts +90 -0
  428. package/lib/openapi/platform/services/project-classification-levels-service.js +161 -0
  429. package/lib/openapi/platform/services/project-classification-levels-service.js.map +1 -0
  430. package/lib/openapi/platform/services/project-components-service.d.ts +955 -0
  431. package/lib/openapi/platform/services/project-components-service.js +1075 -0
  432. package/lib/openapi/platform/services/project-components-service.js.map +1 -0
  433. package/lib/openapi/platform/services/project-email-service.d.ts +60 -0
  434. package/lib/openapi/platform/services/project-email-service.js +113 -0
  435. package/lib/openapi/platform/services/project-email-service.js.map +1 -0
  436. package/lib/openapi/platform/services/project-features-service.d.ts +103 -0
  437. package/lib/openapi/platform/services/project-features-service.js +155 -0
  438. package/lib/openapi/platform/services/project-features-service.js.map +1 -0
  439. package/lib/openapi/platform/services/project-key-and-name-validation-service.d.ts +59 -0
  440. package/lib/openapi/platform/services/project-key-and-name-validation-service.js +135 -0
  441. package/lib/openapi/platform/services/project-key-and-name-validation-service.js.map +1 -0
  442. package/lib/openapi/platform/services/project-permission-schemes-service.d.ts +179 -0
  443. package/lib/openapi/platform/services/project-permission-schemes-service.js +255 -0
  444. package/lib/openapi/platform/services/project-permission-schemes-service.js.map +1 -0
  445. package/lib/openapi/platform/services/project-properties-service.d.ts +147 -0
  446. package/lib/openapi/platform/services/project-properties-service.js +224 -0
  447. package/lib/openapi/platform/services/project-properties-service.js.map +1 -0
  448. package/lib/openapi/platform/services/project-role-actors-service.d.ts +351 -0
  449. package/lib/openapi/platform/services/project-role-actors-service.js +413 -0
  450. package/lib/openapi/platform/services/project-role-actors-service.js.map +1 -0
  451. package/lib/openapi/platform/services/project-roles-service.d.ts +484 -0
  452. package/lib/openapi/platform/services/project-roles-service.js +647 -0
  453. package/lib/openapi/platform/services/project-roles-service.js.map +1 -0
  454. package/lib/openapi/platform/services/project-types-service.d.ts +121 -0
  455. package/lib/openapi/platform/services/project-types-service.js +220 -0
  456. package/lib/openapi/platform/services/project-types-service.js.map +1 -0
  457. package/lib/openapi/platform/services/project-versions-service.d.ts +632 -0
  458. package/lib/openapi/platform/services/project-versions-service.js +852 -0
  459. package/lib/openapi/platform/services/project-versions-service.js.map +1 -0
  460. package/lib/openapi/platform/services/projects-service.d.ts +1622 -0
  461. package/lib/openapi/platform/services/projects-service.js +1686 -0
  462. package/lib/openapi/platform/services/projects-service.js.map +1 -0
  463. package/lib/openapi/platform/services/screen-schemes-service.d.ts +166 -0
  464. package/lib/openapi/platform/services/screen-schemes-service.js +216 -0
  465. package/lib/openapi/platform/services/screen-schemes-service.js.map +1 -0
  466. package/lib/openapi/platform/services/screen-tab-fields-service.d.ts +103 -0
  467. package/lib/openapi/platform/services/screen-tab-fields-service.js +181 -0
  468. package/lib/openapi/platform/services/screen-tab-fields-service.js.map +1 -0
  469. package/lib/openapi/platform/services/screen-tabs-service.d.ts +164 -0
  470. package/lib/openapi/platform/services/screen-tabs-service.js +278 -0
  471. package/lib/openapi/platform/services/screen-tabs-service.js.map +1 -0
  472. package/lib/openapi/platform/services/screens-service.d.ts +226 -0
  473. package/lib/openapi/platform/services/screens-service.js +346 -0
  474. package/lib/openapi/platform/services/screens-service.js.map +1 -0
  475. package/lib/openapi/platform/services/server-info-service.d.ts +40 -0
  476. package/lib/openapi/platform/services/server-info-service.js +74 -0
  477. package/lib/openapi/platform/services/server-info-service.js.map +1 -0
  478. package/lib/openapi/platform/services/service-registry-service.d.ts +32 -0
  479. package/lib/openapi/platform/services/service-registry-service.js +60 -0
  480. package/lib/openapi/platform/services/service-registry-service.js.map +1 -0
  481. package/lib/openapi/platform/services/status-service.d.ts +268 -0
  482. package/lib/openapi/platform/services/status-service.js +321 -0
  483. package/lib/openapi/platform/services/status-service.js.map +1 -0
  484. package/lib/openapi/platform/services/tasks-service.d.ts +71 -0
  485. package/lib/openapi/platform/services/tasks-service.js +126 -0
  486. package/lib/openapi/platform/services/tasks-service.js.map +1 -0
  487. package/lib/openapi/platform/services/time-tracking-service.d.ts +140 -0
  488. package/lib/openapi/platform/services/time-tracking-service.js +260 -0
  489. package/lib/openapi/platform/services/time-tracking-service.js.map +1 -0
  490. package/lib/openapi/platform/services/ui-modifications-apps-service.d.ts +212 -0
  491. package/lib/openapi/platform/services/ui-modifications-apps-service.js +262 -0
  492. package/lib/openapi/platform/services/ui-modifications-apps-service.js.map +1 -0
  493. package/lib/openapi/platform/services/user-properties-service.d.ts +218 -0
  494. package/lib/openapi/platform/services/user-properties-service.js +254 -0
  495. package/lib/openapi/platform/services/user-properties-service.js.map +1 -0
  496. package/lib/openapi/platform/services/user-search-service.d.ts +782 -0
  497. package/lib/openapi/platform/services/user-search-service.js +784 -0
  498. package/lib/openapi/platform/services/user-search-service.js.map +1 -0
  499. package/lib/openapi/platform/services/users-service.d.ts +579 -0
  500. package/lib/openapi/platform/services/users-service.js +729 -0
  501. package/lib/openapi/platform/services/users-service.js.map +1 -0
  502. package/lib/openapi/platform/services/webhooks-service.d.ts +258 -0
  503. package/lib/openapi/platform/services/webhooks-service.js +307 -0
  504. package/lib/openapi/platform/services/webhooks-service.js.map +1 -0
  505. package/lib/openapi/platform/services/workflow-scheme-drafts-service.d.ts +744 -0
  506. package/lib/openapi/platform/services/workflow-scheme-drafts-service.js +956 -0
  507. package/lib/openapi/platform/services/workflow-scheme-drafts-service.js.map +1 -0
  508. package/lib/openapi/platform/services/workflow-scheme-project-associations-service.d.ts +85 -0
  509. package/lib/openapi/platform/services/workflow-scheme-project-associations-service.js +134 -0
  510. package/lib/openapi/platform/services/workflow-scheme-project-associations-service.js.map +1 -0
  511. package/lib/openapi/platform/services/workflow-schemes-service.d.ts +843 -0
  512. package/lib/openapi/platform/services/workflow-schemes-service.js +1030 -0
  513. package/lib/openapi/platform/services/workflow-schemes-service.js.map +1 -0
  514. package/lib/openapi/platform/services/workflow-status-categories-service.d.ts +60 -0
  515. package/lib/openapi/platform/services/workflow-status-categories-service.js +115 -0
  516. package/lib/openapi/platform/services/workflow-status-categories-service.js.map +1 -0
  517. package/lib/openapi/platform/services/workflow-statuses-service.d.ts +87 -0
  518. package/lib/openapi/platform/services/workflow-statuses-service.js +142 -0
  519. package/lib/openapi/platform/services/workflow-statuses-service.js.map +1 -0
  520. package/lib/openapi/platform/services/workflow-transition-properties-service.d.ts +189 -0
  521. package/lib/openapi/platform/services/workflow-transition-properties-service.js +224 -0
  522. package/lib/openapi/platform/services/workflow-transition-properties-service.js.map +1 -0
  523. package/lib/openapi/platform/services/workflow-transition-rules-service.d.ts +319 -0
  524. package/lib/openapi/platform/services/workflow-transition-rules-service.js +326 -0
  525. package/lib/openapi/platform/services/workflow-transition-rules-service.js.map +1 -0
  526. package/lib/openapi/platform/services/workflows-service.d.ts +3032 -0
  527. package/lib/openapi/platform/services/workflows-service.js +2529 -0
  528. package/lib/openapi/platform/services/workflows-service.js.map +1 -0
  529. package/lib/openapi/platform/validation-schema-storage.d.ts +3 -0
  530. package/lib/openapi/platform/validation-schema-storage.js +144 -0
  531. package/lib/openapi/platform/validation-schema-storage.js.map +1 -0
  532. package/lib/openapi/software/base-jira-software-api-client.d.ts +426 -0
  533. package/lib/openapi/software/base-jira-software-api-client.js +444 -0
  534. package/lib/openapi/software/base-jira-software-api-client.js.map +1 -0
  535. package/lib/openapi/software/core/common-http-client.d.ts +196 -0
  536. package/lib/openapi/software/core/common-http-client.js +390 -0
  537. package/lib/openapi/software/core/common-http-client.js.map +1 -0
  538. package/lib/openapi/software/core/common-http-service.d.ts +7 -0
  539. package/lib/openapi/software/core/common-http-service.js +20 -0
  540. package/lib/openapi/software/core/common-http-service.js.map +1 -0
  541. package/lib/openapi/software/core/common-validation-schema-storage.d.ts +35 -0
  542. package/lib/openapi/software/core/common-validation-schema-storage.js +65 -0
  543. package/lib/openapi/software/core/common-validation-schema-storage.js.map +1 -0
  544. package/lib/openapi/software/models/board.d.ts +505 -0
  545. package/lib/openapi/software/models/board.js +389 -0
  546. package/lib/openapi/software/models/board.js.map +1 -0
  547. package/lib/openapi/software/services/backlog-service.d.ts +81 -0
  548. package/lib/openapi/software/services/backlog-service.js +113 -0
  549. package/lib/openapi/software/services/backlog-service.js.map +1 -0
  550. package/lib/openapi/software/services/board-service.d.ts +2254 -0
  551. package/lib/openapi/software/services/board-service.js +2653 -0
  552. package/lib/openapi/software/services/board-service.js.map +1 -0
  553. package/lib/openapi/software/services/builds-service.d.ts +368 -0
  554. package/lib/openapi/software/services/builds-service.js +230 -0
  555. package/lib/openapi/software/services/builds-service.js.map +1 -0
  556. package/lib/openapi/software/services/deployments-service.d.ts +217 -0
  557. package/lib/openapi/software/services/deployments-service.js +232 -0
  558. package/lib/openapi/software/services/deployments-service.js.map +1 -0
  559. package/lib/openapi/software/services/dev-ops-components-service.d.ts +246 -0
  560. package/lib/openapi/software/services/dev-ops-components-service.js +280 -0
  561. package/lib/openapi/software/services/dev-ops-components-service.js.map +1 -0
  562. package/lib/openapi/software/services/development-information-service.d.ts +1641 -0
  563. package/lib/openapi/software/services/development-information-service.js +474 -0
  564. package/lib/openapi/software/services/development-information-service.js.map +1 -0
  565. package/lib/openapi/software/services/epic-service.d.ts +596 -0
  566. package/lib/openapi/software/services/epic-service.js +633 -0
  567. package/lib/openapi/software/services/epic-service.js.map +1 -0
  568. package/lib/openapi/software/services/feature-flags-service.d.ts +170 -0
  569. package/lib/openapi/software/services/feature-flags-service.js +182 -0
  570. package/lib/openapi/software/services/feature-flags-service.js.map +1 -0
  571. package/lib/openapi/software/services/issue-service.d.ts +329 -0
  572. package/lib/openapi/software/services/issue-service.js +410 -0
  573. package/lib/openapi/software/services/issue-service.js.map +1 -0
  574. package/lib/openapi/software/services/operations-service.d.ts +456 -0
  575. package/lib/openapi/software/services/operations-service.js +444 -0
  576. package/lib/openapi/software/services/operations-service.js.map +1 -0
  577. package/lib/openapi/software/services/remote-links-service.d.ts +445 -0
  578. package/lib/openapi/software/services/remote-links-service.js +327 -0
  579. package/lib/openapi/software/services/remote-links-service.js.map +1 -0
  580. package/lib/openapi/software/services/security-information-service.d.ts +257 -0
  581. package/lib/openapi/software/services/security-information-service.js +310 -0
  582. package/lib/openapi/software/services/security-information-service.js.map +1 -0
  583. package/lib/openapi/software/services/sprint-service.d.ts +531 -0
  584. package/lib/openapi/software/services/sprint-service.js +665 -0
  585. package/lib/openapi/software/services/sprint-service.js.map +1 -0
  586. package/lib/openapi/software/validation-schema-storage.d.ts +3 -0
  587. package/lib/openapi/software/validation-schema-storage.js +144 -0
  588. package/lib/openapi/software/validation-schema-storage.js.map +1 -0
  589. package/package.json +37 -0
  590. package/src/index.ts +47 -0
  591. package/src/openapi/platform/base-jira-platform-api-client.ts +2298 -0
  592. package/src/openapi/platform/core/common-http-client.ts +723 -0
  593. package/src/openapi/platform/core/common-http-service.ts +22 -0
  594. package/src/openapi/platform/core/common-validation-schema-storage.ts +105 -0
  595. package/src/openapi/platform/models/announcement-banner.ts +59 -0
  596. package/src/openapi/platform/models/app-data-policies.ts +79 -0
  597. package/src/openapi/platform/models/app-migration.ts +172 -0
  598. package/src/openapi/platform/models/app-properties.ts +32 -0
  599. package/src/openapi/platform/models/audit-records.ts +140 -0
  600. package/src/openapi/platform/models/avatars.ts +48 -0
  601. package/src/openapi/platform/models/classification-levels.ts +58 -0
  602. package/src/openapi/platform/models/common.ts +2669 -0
  603. package/src/openapi/platform/models/dashboards.ts +849 -0
  604. package/src/openapi/platform/models/dynamic-modules.ts +121 -0
  605. package/src/openapi/platform/models/filter-sharing.ts +103 -0
  606. package/src/openapi/platform/models/filters.ts +319 -0
  607. package/src/openapi/platform/models/group-and-user-picker.ts +85 -0
  608. package/src/openapi/platform/models/groups.ts +247 -0
  609. package/src/openapi/platform/models/issue-attachments.ts +290 -0
  610. package/src/openapi/platform/models/issue-comment-properties.ts +27 -0
  611. package/src/openapi/platform/models/issue-comments.ts +91 -0
  612. package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +96 -0
  613. package/src/openapi/platform/models/issue-custom-field-contexts.ts +1072 -0
  614. package/src/openapi/platform/models/issue-custom-field-options-apps.ts +273 -0
  615. package/src/openapi/platform/models/issue-custom-field-options.ts +283 -0
  616. package/src/openapi/platform/models/issue-custom-field-values-apps.ts +118 -0
  617. package/src/openapi/platform/models/issue-field-configurations.ts +435 -0
  618. package/src/openapi/platform/models/issue-fields.ts +392 -0
  619. package/src/openapi/platform/models/issue-link-types.ts +28 -0
  620. package/src/openapi/platform/models/issue-links.ts +185 -0
  621. package/src/openapi/platform/models/issue-notification-schemes.ts +370 -0
  622. package/src/openapi/platform/models/issue-priorities.ts +196 -0
  623. package/src/openapi/platform/models/issue-properties.ts +259 -0
  624. package/src/openapi/platform/models/issue-remote-links.ts +207 -0
  625. package/src/openapi/platform/models/issue-resolutions.ts +180 -0
  626. package/src/openapi/platform/models/issue-search.ts +367 -0
  627. package/src/openapi/platform/models/issue-security-level.ts +76 -0
  628. package/src/openapi/platform/models/issue-security-schemes.ts +496 -0
  629. package/src/openapi/platform/models/issue-type-schemes.ts +290 -0
  630. package/src/openapi/platform/models/issue-type-screen-schemes.ts +286 -0
  631. package/src/openapi/platform/models/issue-types.ts +66 -0
  632. package/src/openapi/platform/models/issue-votes.ts +38 -0
  633. package/src/openapi/platform/models/issue-watchers.ts +67 -0
  634. package/src/openapi/platform/models/issue-worklogs.ts +190 -0
  635. package/src/openapi/platform/models/issues.ts +1268 -0
  636. package/src/openapi/platform/models/jira-expressions.ts +578 -0
  637. package/src/openapi/platform/models/jira-settings.ts +118 -0
  638. package/src/openapi/platform/models/jql-functions-apps.ts +128 -0
  639. package/src/openapi/platform/models/jql.ts +783 -0
  640. package/src/openapi/platform/models/labels.ts +42 -0
  641. package/src/openapi/platform/models/license-metrics.ts +68 -0
  642. package/src/openapi/platform/models/myself.ts +29 -0
  643. package/src/openapi/platform/models/permission-schemes.ts +89 -0
  644. package/src/openapi/platform/models/permissions.ts +308 -0
  645. package/src/openapi/platform/models/priority-schemes.ts +527 -0
  646. package/src/openapi/platform/models/project-avatars.ts +29 -0
  647. package/src/openapi/platform/models/project-classification-levels.ts +24 -0
  648. package/src/openapi/platform/models/project-components.ts +231 -0
  649. package/src/openapi/platform/models/project-email.ts +27 -0
  650. package/src/openapi/platform/models/project-features.ts +78 -0
  651. package/src/openapi/platform/models/project-permission-schemes.ts +43 -0
  652. package/src/openapi/platform/models/project-role-actors.ts +107 -0
  653. package/src/openapi/platform/models/project-roles.ts +76 -0
  654. package/src/openapi/platform/models/project-types.ts +36 -0
  655. package/src/openapi/platform/models/project-versions.ts +216 -0
  656. package/src/openapi/platform/models/projects.ts +429 -0
  657. package/src/openapi/platform/models/screen-schemes.ts +192 -0
  658. package/src/openapi/platform/models/screen-tab-fields.ts +45 -0
  659. package/src/openapi/platform/models/screens.ts +171 -0
  660. package/src/openapi/platform/models/server-info.ts +100 -0
  661. package/src/openapi/platform/models/service-registry.ts +68 -0
  662. package/src/openapi/platform/models/status.ts +229 -0
  663. package/src/openapi/platform/models/time-tracking.ts +38 -0
  664. package/src/openapi/platform/models/ui-modifications-apps.ts +229 -0
  665. package/src/openapi/platform/models/user-search.ts +69 -0
  666. package/src/openapi/platform/models/users.ts +121 -0
  667. package/src/openapi/platform/models/webhooks.ts +307 -0
  668. package/src/openapi/platform/models/workflow-scheme-drafts.ts +58 -0
  669. package/src/openapi/platform/models/workflow-scheme-project-associations.ts +68 -0
  670. package/src/openapi/platform/models/workflow-schemes.ts +545 -0
  671. package/src/openapi/platform/models/workflow-transition-properties.ts +33 -0
  672. package/src/openapi/platform/models/workflow-transition-rules.ts +261 -0
  673. package/src/openapi/platform/models/workflows.ts +1943 -0
  674. package/src/openapi/platform/services/announcement-banner-service.ts +142 -0
  675. package/src/openapi/platform/services/app-data-policies-service.ts +136 -0
  676. package/src/openapi/platform/services/app-migration-service.ts +289 -0
  677. package/src/openapi/platform/services/app-properties-service.ts +441 -0
  678. package/src/openapi/platform/services/application-roles-service.ts +247 -0
  679. package/src/openapi/platform/services/audit-records-service.ts +164 -0
  680. package/src/openapi/platform/services/avatars-service.ts +769 -0
  681. package/src/openapi/platform/services/classification-levels-service.ts +131 -0
  682. package/src/openapi/platform/services/dashboards-service.ts +1721 -0
  683. package/src/openapi/platform/services/dynamic-modules-service.ts +127 -0
  684. package/src/openapi/platform/services/filter-sharing-service.ts +687 -0
  685. package/src/openapi/platform/services/filters-service.ts +1901 -0
  686. package/src/openapi/platform/services/group-and-user-picker-service.ts +224 -0
  687. package/src/openapi/platform/services/groups-service.ts +751 -0
  688. package/src/openapi/platform/services/issue-attachments-service.ts +900 -0
  689. package/src/openapi/platform/services/issue-comment-properties-service.ts +324 -0
  690. package/src/openapi/platform/services/issue-comments-service.ts +812 -0
  691. package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +277 -0
  692. package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +1339 -0
  693. package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +994 -0
  694. package/src/openapi/platform/services/issue-custom-field-options-service.ts +651 -0
  695. package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +201 -0
  696. package/src/openapi/platform/services/issue-field-configurations-service.ts +1294 -0
  697. package/src/openapi/platform/services/issue-fields-service.ts +837 -0
  698. package/src/openapi/platform/services/issue-link-types-service.ts +360 -0
  699. package/src/openapi/platform/services/issue-links-service.ts +345 -0
  700. package/src/openapi/platform/services/issue-navigator-settings-service.ts +119 -0
  701. package/src/openapi/platform/services/issue-notification-schemes-service.ts +1209 -0
  702. package/src/openapi/platform/services/issue-priorities-service.ts +575 -0
  703. package/src/openapi/platform/services/issue-properties-service.ts +606 -0
  704. package/src/openapi/platform/services/issue-remote-links-service.ts +597 -0
  705. package/src/openapi/platform/services/issue-resolutions-service.ts +534 -0
  706. package/src/openapi/platform/services/issue-search-service.ts +1139 -0
  707. package/src/openapi/platform/services/issue-security-level-service.ts +250 -0
  708. package/src/openapi/platform/services/issue-security-schemes-service.ts +1240 -0
  709. package/src/openapi/platform/services/issue-type-properties-service.ts +325 -0
  710. package/src/openapi/platform/services/issue-type-schemes-service.ts +940 -0
  711. package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +994 -0
  712. package/src/openapi/platform/services/issue-types-service.ts +679 -0
  713. package/src/openapi/platform/services/issue-votes-service.ts +221 -0
  714. package/src/openapi/platform/services/issue-watchers-service.ts +331 -0
  715. package/src/openapi/platform/services/issue-worklog-properties-service.ts +348 -0
  716. package/src/openapi/platform/services/issue-worklogs-service.ts +1089 -0
  717. package/src/openapi/platform/services/issues-service.ts +3346 -0
  718. package/src/openapi/platform/services/jira-expressions-service.ts +407 -0
  719. package/src/openapi/platform/services/jira-settings-service.ts +415 -0
  720. package/src/openapi/platform/services/jql-functions-apps-service.ts +219 -0
  721. package/src/openapi/platform/services/jql-service.ts +896 -0
  722. package/src/openapi/platform/services/labels-service.ts +89 -0
  723. package/src/openapi/platform/services/license-metrics-service.ts +216 -0
  724. package/src/openapi/platform/services/myself-service.ts +520 -0
  725. package/src/openapi/platform/services/permission-schemes-service.ts +926 -0
  726. package/src/openapi/platform/services/permissions-service.ts +407 -0
  727. package/src/openapi/platform/services/priority-schemes-service.ts +1001 -0
  728. package/src/openapi/platform/services/project-avatars-service.ts +341 -0
  729. package/src/openapi/platform/services/project-categories-service.ts +318 -0
  730. package/src/openapi/platform/services/project-classification-levels-service.ts +232 -0
  731. package/src/openapi/platform/services/project-components-service.ts +1332 -0
  732. package/src/openapi/platform/services/project-email-service.ts +161 -0
  733. package/src/openapi/platform/services/project-features-service.ts +207 -0
  734. package/src/openapi/platform/services/project-key-and-name-validation-service.ts +200 -0
  735. package/src/openapi/platform/services/project-permission-schemes-service.ts +384 -0
  736. package/src/openapi/platform/services/project-properties-service.ts +320 -0
  737. package/src/openapi/platform/services/project-role-actors-service.ts +627 -0
  738. package/src/openapi/platform/services/project-roles-service.ts +867 -0
  739. package/src/openapi/platform/services/project-types-service.ts +297 -0
  740. package/src/openapi/platform/services/project-versions-service.ts +1287 -0
  741. package/src/openapi/platform/services/projects-service.ts +2196 -0
  742. package/src/openapi/platform/services/screen-schemes-service.ts +334 -0
  743. package/src/openapi/platform/services/screen-tab-fields-service.ts +276 -0
  744. package/src/openapi/platform/services/screen-tabs-service.ts +421 -0
  745. package/src/openapi/platform/services/screens-service.ts +528 -0
  746. package/src/openapi/platform/services/server-info-service.ts +88 -0
  747. package/src/openapi/platform/services/service-registry-service.ts +89 -0
  748. package/src/openapi/platform/services/status-service.ts +498 -0
  749. package/src/openapi/platform/services/tasks-service.ts +159 -0
  750. package/src/openapi/platform/services/time-tracking-service.ts +386 -0
  751. package/src/openapi/platform/services/ui-modifications-apps-service.ts +403 -0
  752. package/src/openapi/platform/services/user-properties-service.ts +413 -0
  753. package/src/openapi/platform/services/user-search-service.ts +1214 -0
  754. package/src/openapi/platform/services/users-service.ts +1108 -0
  755. package/src/openapi/platform/services/webhooks-service.ts +458 -0
  756. package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +1313 -0
  757. package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +189 -0
  758. package/src/openapi/platform/services/workflow-schemes-service.ts +1617 -0
  759. package/src/openapi/platform/services/workflow-status-categories-service.ts +151 -0
  760. package/src/openapi/platform/services/workflow-statuses-service.ts +176 -0
  761. package/src/openapi/platform/services/workflow-transition-properties-service.ts +388 -0
  762. package/src/openapi/platform/services/workflow-transition-rules-service.ts +485 -0
  763. package/src/openapi/platform/services/workflows-service.ts +3477 -0
  764. package/src/openapi/platform/validation-schema-storage.ts +186 -0
  765. package/src/openapi/software/base-jira-software-api-client.ts +447 -0
  766. package/src/openapi/software/core/common-http-client.ts +723 -0
  767. package/src/openapi/software/core/common-http-service.ts +22 -0
  768. package/src/openapi/software/core/common-validation-schema-storage.ts +105 -0
  769. package/src/openapi/software/models/board.ts +918 -0
  770. package/src/openapi/software/services/backlog-service.ts +160 -0
  771. package/src/openapi/software/services/board-service.ts +4189 -0
  772. package/src/openapi/software/services/builds-service.ts +571 -0
  773. package/src/openapi/software/services/deployments-service.ts +403 -0
  774. package/src/openapi/software/services/dev-ops-components-service.ts +371 -0
  775. package/src/openapi/software/services/development-information-service.ts +2357 -0
  776. package/src/openapi/software/services/epic-service.ts +854 -0
  777. package/src/openapi/software/services/feature-flags-service.ts +303 -0
  778. package/src/openapi/software/services/issue-service.ts +529 -0
  779. package/src/openapi/software/services/operations-service.ts +741 -0
  780. package/src/openapi/software/services/remote-links-service.ts +653 -0
  781. package/src/openapi/software/services/security-information-service.ts +495 -0
  782. package/src/openapi/software/services/sprint-service.ts +969 -0
  783. package/src/openapi/software/validation-schema-storage.ts +186 -0
  784. package/tsconfig.build.json +7 -0
  785. package/tsconfig.json +4 -0
@@ -0,0 +1,4189 @@
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
+ registerBoardValidationSchemas,
10
+ type SearchResults,
11
+ } from "../models/board";
12
+ import { validationSchemaStorage } from "../validation-schema-storage";
13
+ /** Apis related to boards */
14
+ export class BoardService extends CommonHttpService {
15
+ /**
16
+ * Creates a new board. Board name, type and filter ID is required.
17
+ *
18
+ * * `name` \- Must be less than 255 characters.
19
+ * * `type` \- Valid values: scrum, kanban
20
+ * * `filterId` \- ID of a filter that the user has permissions to view. Note,
21
+ * if the user does not have the 'Create shared objects' permission and tries to
22
+ * create a shared board, a private board will be created instead (remember that
23
+ * board sharing depends on the filter sharing).
24
+ * * `location` \- The container that the board will be located in. `location`
25
+ * must include the `type` property (Valid values: project, user). If choosing
26
+ * 'project', then a project must be specified by a `projectKeyOrId` property in
27
+ * `location`. If choosing 'user', the current user is chosen by default. The
28
+ * `projectKeyOrId` property should not be provided.
29
+ *
30
+ * Note:
31
+ *
32
+ * * If you want to create a new project with an associated board, use the [Jira
33
+ * platform REST API](https://docs.atlassian.com/jira/REST/latest). For more
34
+ * information, see the [Create project](#api-rest-api-3-project-post) method. The
35
+ * `projectTypeKey` for software boards must be 'software' and the
36
+ * `projectTemplateKey` must be either
37
+ * `com.pyxis.greenhopper.jira:gh-kanban-template` or
38
+ * `com.pyxis.greenhopper.jira:gh-scrum-template`.
39
+ * * You can create a filter using the [Jira REST
40
+ * API](https://docs.atlassian.com/jira/REST/latest). For more information, see
41
+ * the [Create filter](#api-rest-api-3-filter-post) method.
42
+ * * If you do not ORDER BY the Rank field for the filter of your board, you
43
+ * will not be able to reorder issues on the board.
44
+ *
45
+ * @returns Returns the created board.
46
+ *
47
+ * example: {
48
+ * "id": 84,
49
+ * "name": "scrum board",
50
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
51
+ * "type": "scrum"
52
+ * }
53
+ * @path {POST} /rest/agile/1.0/board
54
+ */
55
+ createBoard({
56
+ requestBody,
57
+ }: {
58
+ /**
59
+ * @example {
60
+ * "filterId": 10040,
61
+ * "location": {
62
+ * "projectKeyOrId": "10000",
63
+ * "type": "project"
64
+ * },
65
+ * "name": "scrum board",
66
+ * "type": "scrum"
67
+ * }
68
+ */
69
+ requestBody: {
70
+ filterId?: number;
71
+ location?: {
72
+ projectKeyOrId?: string;
73
+ type?: "project" | "user";
74
+ };
75
+ name?: string;
76
+ type?: "kanban" | "scrum" | "agility";
77
+ };
78
+ }): Promise<{
79
+ admins?: {
80
+ groups?: {
81
+ name?: string;
82
+ self?: string;
83
+ }[];
84
+ users?: {
85
+ /**
86
+ * The account ID of the user, which uniquely identifies the user across all
87
+ * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
88
+ */
89
+ accountId?: string;
90
+ /** Whether the user is active. */
91
+ active?: boolean;
92
+ /** The avatars of the user. */
93
+ avatarUrls?: {
94
+ /** The URL of the user's 16x16 pixel avatar. */
95
+ "16x16"?: string;
96
+ /** The URL of the user's 24x24 pixel avatar. */
97
+ "24x24"?: string;
98
+ /** The URL of the user's 32x32 pixel avatar. */
99
+ "32x32"?: string;
100
+ /** The URL of the user's 48x48 pixel avatar. */
101
+ "48x48"?: string;
102
+ };
103
+ /**
104
+ * The display name of the user. Depending on the user’s privacy setting, this may
105
+ * return an alternative value.
106
+ */
107
+ displayName?: string;
108
+ /**
109
+ * This property is deprecated in favor of `accountId` because of privacy changes.
110
+ * See the [migration
111
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
112
+ * for details.
113
+ * The key of the user.
114
+ */
115
+ key?: string;
116
+ /**
117
+ * This property is deprecated in favor of `accountId` because of privacy changes.
118
+ * See the [migration
119
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
120
+ * for details.
121
+ * The username of the user.
122
+ */
123
+ name?: string;
124
+ /** The URL of the user. */
125
+ self?: string;
126
+ }[];
127
+ };
128
+ /** Whether the board can be edited. */
129
+ canEdit?: boolean;
130
+ /** Whether the board is selected as a favorite. */
131
+ favourite?: boolean;
132
+ /** The ID of the board. */
133
+ id?: number;
134
+ /** Whether the board is private. */
135
+ isPrivate?: boolean;
136
+ /** The container that the board is located in. */
137
+ location?: {
138
+ avatarURI?: string;
139
+ displayName?: string;
140
+ name?: string;
141
+ projectId?: number;
142
+ projectKey?: string;
143
+ projectName?: string;
144
+ projectTypeKey?: string;
145
+ userAccountId?: string;
146
+ userId?: number;
147
+ };
148
+ /** The name of the board. */
149
+ name?: string;
150
+ /** The URL of the board. */
151
+ self?: string;
152
+ /** The type the board. */
153
+ type?: string;
154
+ }> {
155
+ return this.getClientInstance()
156
+ .request({
157
+ path: "/rest/agile/1.0/board",
158
+ method: "POST",
159
+ headers: {
160
+ "Content-Type": "application/json",
161
+ },
162
+ body: requestBody,
163
+ })
164
+ .then(
165
+ this.getClientInstance().responseHandler({
166
+ 201: {
167
+ "application/json": "json",
168
+ },
169
+ }),
170
+ )
171
+ .then(
172
+ commonHttpClient.castResponse<{
173
+ status: 201;
174
+ mediaType: "application/json";
175
+ body: {
176
+ admins?: {
177
+ groups?: {
178
+ name?: string;
179
+ self?: string;
180
+ }[];
181
+ users?: {
182
+ accountId?: string;
183
+ active?: boolean;
184
+ avatarUrls?: {
185
+ "16x16"?: string;
186
+ "24x24"?: string;
187
+ "32x32"?: string;
188
+ "48x48"?: string;
189
+ };
190
+ displayName?: string;
191
+ key?: string;
192
+ name?: string;
193
+ self?: string;
194
+ }[];
195
+ };
196
+ canEdit?: boolean;
197
+ favourite?: boolean;
198
+ id?: number;
199
+ isPrivate?: boolean;
200
+ location?: {
201
+ avatarURI?: string;
202
+ displayName?: string;
203
+ name?: string;
204
+ projectId?: number;
205
+ projectKey?: string;
206
+ projectName?: string;
207
+ projectTypeKey?: string;
208
+ userAccountId?: string;
209
+ userId?: number;
210
+ };
211
+ name?: string;
212
+ self?: string;
213
+ type?: string;
214
+ };
215
+ }>(),
216
+ )
217
+ .then(
218
+ validationSchemaStorage.validator("BoardService.createBoard.response"),
219
+ )
220
+ .then(commonHttpClient.getBody);
221
+ }
222
+ /**
223
+ * Deletes the board. Admin without the view permission can still remove the board.
224
+ *
225
+ * @path {DELETE} /rest/agile/1.0/board/{boardId}
226
+ */
227
+ deleteBoard({
228
+ boardId,
229
+ }: {
230
+ /** ID of the board to be deleted */
231
+ boardId: number;
232
+ }): Promise<void> {
233
+ return this.getClientInstance()
234
+ .request({
235
+ path: "/rest/agile/1.0/board/{boardId}",
236
+ method: "DELETE",
237
+ pathParams: {
238
+ boardId,
239
+ },
240
+ })
241
+ .then(commonHttpClient.discardResult);
242
+ }
243
+ /**
244
+ * Removes the property from the board identified by the id. Ths user removing the
245
+ * property is required to have permissions to modify the board.
246
+ *
247
+ * @path {DELETE} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
248
+ */
249
+ deleteBoardProperty({
250
+ boardId,
251
+ propertyKey,
252
+ }: {
253
+ /** the id of the board from which the property will be removed. */
254
+ boardId: string;
255
+ /** the key of the property to remove. */
256
+ propertyKey: string;
257
+ }): Promise<void> {
258
+ return this.getClientInstance()
259
+ .request({
260
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
261
+ method: "DELETE",
262
+ pathParams: {
263
+ boardId,
264
+ propertyKey,
265
+ },
266
+ })
267
+ .then(commonHttpClient.discardResult);
268
+ }
269
+ /**
270
+ * Returns all boards. This only includes boards that the user has permission to
271
+ * view.
272
+ *
273
+ * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on
274
+ * February 15, 2024.
275
+ *
276
+ * * `read:board-scope:jira-software`, `read:project:jira`
277
+ *
278
+ * @returns Returns the requested boards, at the specified page of the results.
279
+ *
280
+ * example: {
281
+ * "isLast": false,
282
+ * "maxResults": 2,
283
+ * "startAt": 1,
284
+ * "total": 5,
285
+ * "values": [
286
+ * {
287
+ * "id": 84,
288
+ * "name": "scrum board",
289
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
290
+ * "type": "scrum"
291
+ * },
292
+ * {
293
+ * "id": 92,
294
+ * "name": "kanban board",
295
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
296
+ * "type": "kanban"
297
+ * }
298
+ * ]
299
+ * }
300
+ * @path {GET} /rest/agile/1.0/board
301
+ */
302
+ getAllBoards({
303
+ startAt,
304
+ maxResults,
305
+ type,
306
+ name,
307
+ projectKeyOrId,
308
+ accountIdLocation,
309
+ projectLocation,
310
+ includePrivate,
311
+ negateLocationFiltering,
312
+ orderBy,
313
+ expand,
314
+ projectTypeLocation,
315
+ filterId,
316
+ }: {
317
+ /**
318
+ * The starting index of the returned boards. Base index: 0. See the 'Pagination'
319
+ * section at the top of this page for more details.
320
+ */
321
+ startAt?: number;
322
+ /**
323
+ * The maximum number of boards to return per page. See the 'Pagination' section
324
+ * at the top of this page for more details.
325
+ */
326
+ maxResults?: number;
327
+ /**
328
+ * Filters results to boards of the specified types. Valid values: scrum, kanban,
329
+ * simple.
330
+ */
331
+ type?: {};
332
+ /** Filters results to boards that match or partially match the specified name. */
333
+ name?: string;
334
+ /**
335
+ * Filters results to boards that are relevant to a project. Relevance means that
336
+ * the jql filter defined in board contains a reference to a project.
337
+ */
338
+ projectKeyOrId?: string;
339
+ accountIdLocation?: string;
340
+ projectLocation?: string;
341
+ /**
342
+ * Appends private boards to the end of the list. The name and type fields are
343
+ * excluded for security reasons.
344
+ */
345
+ includePrivate?: boolean;
346
+ /** If set to true, negate filters used for querying by location. By default false. */
347
+ negateLocationFiltering?: boolean;
348
+ /**
349
+ * Ordering of the results by a given field. If not provided, values will not be
350
+ * sorted. Valid values: name.
351
+ */
352
+ orderBy?: "name" | "-name" | "+name";
353
+ /** List of fields to expand for each board. Valid values: admins, permissions. */
354
+ expand?: string;
355
+ /**
356
+ * Filters results to boards that are relevant to a project types. Support Jira
357
+ * Software, Jira Service Management. Valid values: software, service\_desk. By
358
+ * default software.
359
+ */
360
+ projectTypeLocation?: string[];
361
+ /**
362
+ * Filters results to boards that are relevant to a filter. Not supported for
363
+ * next-gen boards.
364
+ */
365
+ filterId?: number;
366
+ }): Promise<{
367
+ isLast?: boolean;
368
+ maxResults?: number;
369
+ startAt?: number;
370
+ total?: number;
371
+ values?: {
372
+ admins?: {
373
+ groups?: {
374
+ name?: string;
375
+ self?: string;
376
+ }[];
377
+ users?: {
378
+ /**
379
+ * The account ID of the user, which uniquely identifies the user across all
380
+ * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
381
+ */
382
+ accountId?: string;
383
+ /** Whether the user is active. */
384
+ active?: boolean;
385
+ /** The avatars of the user. */
386
+ avatarUrls?: {
387
+ /** The URL of the user's 16x16 pixel avatar. */
388
+ "16x16"?: string;
389
+ /** The URL of the user's 24x24 pixel avatar. */
390
+ "24x24"?: string;
391
+ /** The URL of the user's 32x32 pixel avatar. */
392
+ "32x32"?: string;
393
+ /** The URL of the user's 48x48 pixel avatar. */
394
+ "48x48"?: string;
395
+ };
396
+ /**
397
+ * The display name of the user. Depending on the user’s privacy setting, this may
398
+ * return an alternative value.
399
+ */
400
+ displayName?: string;
401
+ /**
402
+ * This property is deprecated in favor of `accountId` because of privacy changes.
403
+ * See the [migration
404
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
405
+ * for details.
406
+ * The key of the user.
407
+ */
408
+ key?: string;
409
+ /**
410
+ * This property is deprecated in favor of `accountId` because of privacy changes.
411
+ * See the [migration
412
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
413
+ * for details.
414
+ * The username of the user.
415
+ */
416
+ name?: string;
417
+ /** The URL of the user. */
418
+ self?: string;
419
+ }[];
420
+ };
421
+ /** Whether the board can be edited. */
422
+ canEdit?: boolean;
423
+ /** Whether the board is selected as a favorite. */
424
+ favourite?: boolean;
425
+ /** The ID of the board. */
426
+ id?: number;
427
+ /** Whether the board is private. */
428
+ isPrivate?: boolean;
429
+ /** The container that the board is located in. */
430
+ location?: {
431
+ avatarURI?: string;
432
+ displayName?: string;
433
+ name?: string;
434
+ projectId?: number;
435
+ projectKey?: string;
436
+ projectName?: string;
437
+ projectTypeKey?: string;
438
+ userAccountId?: string;
439
+ userId?: number;
440
+ };
441
+ /** The name of the board. */
442
+ name?: string;
443
+ /** The URL of the board. */
444
+ self?: string;
445
+ /** The type the board. */
446
+ type?: string;
447
+ }[];
448
+ }> {
449
+ return this.getClientInstance()
450
+ .request({
451
+ path: "/rest/agile/1.0/board",
452
+ method: "GET",
453
+ query: {
454
+ startAt,
455
+ maxResults,
456
+ type,
457
+ name,
458
+ projectKeyOrId,
459
+ accountIdLocation,
460
+ projectLocation,
461
+ includePrivate,
462
+ negateLocationFiltering,
463
+ orderBy,
464
+ expand,
465
+ projectTypeLocation,
466
+ filterId,
467
+ },
468
+ })
469
+ .then(
470
+ this.getClientInstance().responseHandler({
471
+ 200: {
472
+ "application/json": "json",
473
+ },
474
+ }),
475
+ )
476
+ .then(
477
+ commonHttpClient.castResponse<{
478
+ status: 200;
479
+ mediaType: "application/json";
480
+ body: {
481
+ isLast?: boolean;
482
+ maxResults?: number;
483
+ startAt?: number;
484
+ total?: number;
485
+ values?: {
486
+ admins?: {
487
+ groups?: {
488
+ name?: string;
489
+ self?: string;
490
+ }[];
491
+ users?: {
492
+ accountId?: string;
493
+ active?: boolean;
494
+ avatarUrls?: {
495
+ "16x16"?: string;
496
+ "24x24"?: string;
497
+ "32x32"?: string;
498
+ "48x48"?: string;
499
+ };
500
+ displayName?: string;
501
+ key?: string;
502
+ name?: string;
503
+ self?: string;
504
+ }[];
505
+ };
506
+ canEdit?: boolean;
507
+ favourite?: boolean;
508
+ id?: number;
509
+ isPrivate?: boolean;
510
+ location?: {
511
+ avatarURI?: string;
512
+ displayName?: string;
513
+ name?: string;
514
+ projectId?: number;
515
+ projectKey?: string;
516
+ projectName?: string;
517
+ projectTypeKey?: string;
518
+ userAccountId?: string;
519
+ userId?: number;
520
+ };
521
+ name?: string;
522
+ self?: string;
523
+ type?: string;
524
+ }[];
525
+ };
526
+ }>(),
527
+ )
528
+ .then(
529
+ validationSchemaStorage.validator("BoardService.getAllBoards.response"),
530
+ )
531
+ .then(commonHttpClient.getBody);
532
+ }
533
+ /**
534
+ * Returns all quick filters from a board, for a given board ID.
535
+ *
536
+ * @returns Returns the requested quick filters, at the specified page of the results.
537
+ * Quick filters will be ordered first by position.
538
+ *
539
+ * example: {
540
+ * "isLast": false,
541
+ * "maxResults": 2,
542
+ * "startAt": 1,
543
+ * "total": 5,
544
+ * "values": [
545
+ * {
546
+ * "boardId": 1,
547
+ * "description": "Issues of type bug",
548
+ * "id": 1,
549
+ * "jql": "issueType = bug",
550
+ * "name": "Bugs",
551
+ * "position": 0
552
+ * },
553
+ * {
554
+ * "boardId": 1,
555
+ * "description": "Issues of type task",
556
+ * "id": 2,
557
+ * "jql": "issueType = task",
558
+ * "name": "Tasks",
559
+ * "position": 0
560
+ * }
561
+ * ]
562
+ * }
563
+ * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter
564
+ */
565
+ getAllQuickFilters({
566
+ boardId,
567
+ startAt,
568
+ maxResults,
569
+ }: {
570
+ /** The ID of the board that contains the requested quick filters. */
571
+ boardId: number;
572
+ /**
573
+ * The starting index of the returned quick filters. Base index: 0. See the
574
+ * 'Pagination' section at the top of this page for more details.
575
+ */
576
+ startAt?: number;
577
+ /**
578
+ * The maximum number of sprints to return per page. See the 'Pagination' section
579
+ * at the top of this page for more details.
580
+ */
581
+ maxResults?: number;
582
+ }): Promise<{
583
+ isLast?: boolean;
584
+ maxResults?: number;
585
+ startAt?: number;
586
+ total?: number;
587
+ values?: {
588
+ boardId?: number;
589
+ description?: string;
590
+ id?: number;
591
+ jql?: string;
592
+ name?: string;
593
+ position?: number;
594
+ }[];
595
+ }> {
596
+ return this.getClientInstance()
597
+ .request({
598
+ path: "/rest/agile/1.0/board/{boardId}/quickfilter",
599
+ method: "GET",
600
+ pathParams: {
601
+ boardId,
602
+ },
603
+ query: {
604
+ startAt,
605
+ maxResults,
606
+ },
607
+ })
608
+ .then(
609
+ this.getClientInstance().responseHandler({
610
+ 200: {
611
+ "application/json": "json",
612
+ },
613
+ }),
614
+ )
615
+ .then(
616
+ commonHttpClient.castResponse<{
617
+ status: 200;
618
+ mediaType: "application/json";
619
+ body: {
620
+ isLast?: boolean;
621
+ maxResults?: number;
622
+ startAt?: number;
623
+ total?: number;
624
+ values?: {
625
+ boardId?: number;
626
+ description?: string;
627
+ id?: number;
628
+ jql?: string;
629
+ name?: string;
630
+ position?: number;
631
+ }[];
632
+ };
633
+ }>(),
634
+ )
635
+ .then(
636
+ validationSchemaStorage.validator(
637
+ "BoardService.getAllQuickFilters.response",
638
+ ),
639
+ )
640
+ .then(commonHttpClient.getBody);
641
+ }
642
+ /**
643
+ * Returns all sprints from a board, for a given board ID. This only includes
644
+ * sprints that the user has permission to view.
645
+ *
646
+ * @returns Returns the requested sprints, at the specified page of the results. Sprints
647
+ * will be ordered first by state (i.e. closed, active, future) then by their
648
+ * position in the backlog.
649
+ *
650
+ * example: {
651
+ * "isLast": false,
652
+ * "maxResults": 2,
653
+ * "startAt": 1,
654
+ * "total": 5,
655
+ * "values": [
656
+ * {
657
+ * "id": 37,
658
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
659
+ * "state": "closed",
660
+ * "name": "sprint 1",
661
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
662
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
663
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
664
+ * "originBoardId": 5,
665
+ * "goal": "sprint 1 goal"
666
+ * },
667
+ * {
668
+ * "id": 72,
669
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
670
+ * "state": "future",
671
+ * "name": "sprint 2",
672
+ * "goal": "sprint 2 goal"
673
+ * }
674
+ * ]
675
+ * }
676
+ * @path {GET} /rest/agile/1.0/board/{boardId}/sprint
677
+ */
678
+ getAllSprints({
679
+ boardId,
680
+ startAt,
681
+ maxResults,
682
+ state,
683
+ }: {
684
+ /** The ID of the board that contains the requested sprints. */
685
+ boardId: number;
686
+ /**
687
+ * The starting index of the returned sprints. Base index: 0. See the 'Pagination'
688
+ * section at the top of this page for more details.
689
+ */
690
+ startAt?: number;
691
+ /**
692
+ * The maximum number of sprints to return per page. See the 'Pagination' section
693
+ * at the top of this page for more details.
694
+ */
695
+ maxResults?: number;
696
+ /**
697
+ * Filters results to sprints in specified states. Valid values: future, active,
698
+ * closed. You can define multiple states separated by commas, e.g.
699
+ * state=active,closed
700
+ */
701
+ state?: {};
702
+ }): Promise<unknown> {
703
+ return this.getClientInstance()
704
+ .request({
705
+ path: "/rest/agile/1.0/board/{boardId}/sprint",
706
+ method: "GET",
707
+ pathParams: {
708
+ boardId,
709
+ },
710
+ query: {
711
+ startAt,
712
+ maxResults,
713
+ state,
714
+ },
715
+ })
716
+ .then(
717
+ this.getClientInstance().responseHandler({
718
+ 200: {
719
+ "application/json": "json",
720
+ },
721
+ }),
722
+ )
723
+ .then(
724
+ commonHttpClient.castResponse<{
725
+ status: 200;
726
+ mediaType: "application/json";
727
+ body: unknown;
728
+ }>(),
729
+ )
730
+ .then(
731
+ validationSchemaStorage.validator(
732
+ "BoardService.getAllSprints.response",
733
+ ),
734
+ )
735
+ .then(commonHttpClient.getBody);
736
+ }
737
+ /**
738
+ * Returns all versions from a board, for a given board ID. This only includes
739
+ * versions that the user has permission to view. Note, if the user does not have
740
+ * permission to view the board, no versions will be returned at all. Returned
741
+ * versions are ordered by the name of the project from which they belong and then
742
+ * by sequence defined by user.
743
+ *
744
+ * @returns Returns the requested versions, at the specified page of the results.
745
+ *
746
+ * example: {
747
+ * "isLast": false,
748
+ * "maxResults": 2,
749
+ * "startAt": 1,
750
+ * "total": 5,
751
+ * "values": [
752
+ * {
753
+ * "archived": false,
754
+ * "description": "A first version",
755
+ * "id": 10000,
756
+ * "name": "Version 1",
757
+ * "projectId": 10000,
758
+ * "releaseDate": "2015-04-20T01:02:00.000+10:00",
759
+ * "released": true,
760
+ * "self": "https://your-domain.atlassian.net/version/10000"
761
+ * },
762
+ * {
763
+ * "archived": false,
764
+ * "description": "Minor Bugfix version",
765
+ * "id": 10010,
766
+ * "name": "Next Version",
767
+ * "projectId": 10000,
768
+ * "released": false,
769
+ * "self": "https://your-domain.atlassian.net/version/10010"
770
+ * }
771
+ * ]
772
+ * }
773
+ * @path {GET} /rest/agile/1.0/board/{boardId}/version
774
+ */
775
+ getAllVersions({
776
+ boardId,
777
+ startAt,
778
+ maxResults,
779
+ released,
780
+ }: {
781
+ /** The ID of the board that contains the requested versions. */
782
+ boardId: number;
783
+ /**
784
+ * The starting index of the returned versions. Base index: 0. See the
785
+ * 'Pagination' section at the top of this page for more details.
786
+ */
787
+ startAt?: number;
788
+ /**
789
+ * The maximum number of versions to return per page. See the 'Pagination' section
790
+ * at the top of this page for more details.
791
+ */
792
+ maxResults?: number;
793
+ /**
794
+ * Filters results to versions that are either released or unreleased. Valid
795
+ * values: true, false.
796
+ */
797
+ released?: string;
798
+ }): Promise<unknown> {
799
+ return this.getClientInstance()
800
+ .request({
801
+ path: "/rest/agile/1.0/board/{boardId}/version",
802
+ method: "GET",
803
+ pathParams: {
804
+ boardId,
805
+ },
806
+ query: {
807
+ startAt,
808
+ maxResults,
809
+ released,
810
+ },
811
+ })
812
+ .then(
813
+ this.getClientInstance().responseHandler({
814
+ 200: {
815
+ "application/json": "json",
816
+ },
817
+ }),
818
+ )
819
+ .then(
820
+ commonHttpClient.castResponse<{
821
+ status: 200;
822
+ mediaType: "application/json";
823
+ body: unknown;
824
+ }>(),
825
+ )
826
+ .then(
827
+ validationSchemaStorage.validator(
828
+ "BoardService.getAllVersions.response",
829
+ ),
830
+ )
831
+ .then(commonHttpClient.getBody);
832
+ }
833
+ /**
834
+ * Returns the board for the given board ID. This board will only be returned if
835
+ * the user has permission to view it. Admins without the view permission will see
836
+ * the board as a private one, so will see only a subset of the board's data
837
+ * (board location for instance).
838
+ *
839
+ * @returns Returns the requested board.
840
+ *
841
+ * example: {
842
+ * "id": 84,
843
+ * "location": {
844
+ * "displayName": "Example Project",
845
+ * "name": "Example Project",
846
+ * "projectId": 10040,
847
+ * "projectKey": "Example Project Key",
848
+ * "projectName": "Example Project",
849
+ * "projectTypeKey": "KEY",
850
+ * "userAccountId": "5b10a2844c20165700ede21g",
851
+ * "userId": 10040
852
+ * },
853
+ * "name": "scrum board",
854
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
855
+ * "type": "scrum"
856
+ * }
857
+ * @path {GET} /rest/agile/1.0/board/{boardId}
858
+ */
859
+ getBoard({
860
+ boardId,
861
+ }: {
862
+ /** The ID of the requested board. */
863
+ boardId: number;
864
+ }): Promise<{
865
+ admins?: {
866
+ groups?: {
867
+ name?: string;
868
+ self?: string;
869
+ }[];
870
+ users?: {
871
+ /**
872
+ * The account ID of the user, which uniquely identifies the user across all
873
+ * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
874
+ */
875
+ accountId?: string;
876
+ /** Whether the user is active. */
877
+ active?: boolean;
878
+ /** The avatars of the user. */
879
+ avatarUrls?: {
880
+ /** The URL of the user's 16x16 pixel avatar. */
881
+ "16x16"?: string;
882
+ /** The URL of the user's 24x24 pixel avatar. */
883
+ "24x24"?: string;
884
+ /** The URL of the user's 32x32 pixel avatar. */
885
+ "32x32"?: string;
886
+ /** The URL of the user's 48x48 pixel avatar. */
887
+ "48x48"?: string;
888
+ };
889
+ /**
890
+ * The display name of the user. Depending on the user’s privacy setting, this may
891
+ * return an alternative value.
892
+ */
893
+ displayName?: string;
894
+ /**
895
+ * This property is deprecated in favor of `accountId` because of privacy changes.
896
+ * See the [migration
897
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
898
+ * for details.
899
+ * The key of the user.
900
+ */
901
+ key?: string;
902
+ /**
903
+ * This property is deprecated in favor of `accountId` because of privacy changes.
904
+ * See the [migration
905
+ * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
906
+ * for details.
907
+ * The username of the user.
908
+ */
909
+ name?: string;
910
+ /** The URL of the user. */
911
+ self?: string;
912
+ }[];
913
+ };
914
+ /** Whether the board can be edited. */
915
+ canEdit?: boolean;
916
+ /** Whether the board is selected as a favorite. */
917
+ favourite?: boolean;
918
+ /** The ID of the board. */
919
+ id?: number;
920
+ /** Whether the board is private. */
921
+ isPrivate?: boolean;
922
+ /** The container that the board is located in. */
923
+ location?: {
924
+ avatarURI?: string;
925
+ displayName?: string;
926
+ name?: string;
927
+ projectId?: number;
928
+ projectKey?: string;
929
+ projectName?: string;
930
+ projectTypeKey?: string;
931
+ userAccountId?: string;
932
+ userId?: number;
933
+ };
934
+ /** The name of the board. */
935
+ name?: string;
936
+ /** The URL of the board. */
937
+ self?: string;
938
+ /** The type the board. */
939
+ type?: string;
940
+ }> {
941
+ return this.getClientInstance()
942
+ .request({
943
+ path: "/rest/agile/1.0/board/{boardId}",
944
+ method: "GET",
945
+ pathParams: {
946
+ boardId,
947
+ },
948
+ })
949
+ .then(
950
+ this.getClientInstance().responseHandler({
951
+ 200: {
952
+ "application/json": "json",
953
+ },
954
+ }),
955
+ )
956
+ .then(
957
+ commonHttpClient.castResponse<{
958
+ status: 200;
959
+ mediaType: "application/json";
960
+ body: {
961
+ admins?: {
962
+ groups?: {
963
+ name?: string;
964
+ self?: string;
965
+ }[];
966
+ users?: {
967
+ accountId?: string;
968
+ active?: boolean;
969
+ avatarUrls?: {
970
+ "16x16"?: string;
971
+ "24x24"?: string;
972
+ "32x32"?: string;
973
+ "48x48"?: string;
974
+ };
975
+ displayName?: string;
976
+ key?: string;
977
+ name?: string;
978
+ self?: string;
979
+ }[];
980
+ };
981
+ canEdit?: boolean;
982
+ favourite?: boolean;
983
+ id?: number;
984
+ isPrivate?: boolean;
985
+ location?: {
986
+ avatarURI?: string;
987
+ displayName?: string;
988
+ name?: string;
989
+ projectId?: number;
990
+ projectKey?: string;
991
+ projectName?: string;
992
+ projectTypeKey?: string;
993
+ userAccountId?: string;
994
+ userId?: number;
995
+ };
996
+ name?: string;
997
+ self?: string;
998
+ type?: string;
999
+ };
1000
+ }>(),
1001
+ )
1002
+ .then(validationSchemaStorage.validator("BoardService.getBoard.response"))
1003
+ .then(commonHttpClient.getBody);
1004
+ }
1005
+ /**
1006
+ * Returns any boards which use the provided filter id. This method can be
1007
+ * executed by users without a valid software license in order to find which
1008
+ * boards are using a particular filter.
1009
+ *
1010
+ * @returns Returns the requested boards, at the specified page of the results.
1011
+ *
1012
+ * example: {
1013
+ * "id": 84,
1014
+ * "name": "scrum board",
1015
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
1016
+ * }
1017
+ * @path {GET} /rest/agile/1.0/board/filter/{filterId}
1018
+ */
1019
+ getBoardByFilterId({
1020
+ filterId,
1021
+ startAt,
1022
+ maxResults,
1023
+ }: {
1024
+ /**
1025
+ * Filters results to boards that are relevant to a filter. Not supported for
1026
+ * next-gen boards.
1027
+ */
1028
+ filterId: number;
1029
+ /**
1030
+ * The starting index of the returned boards. Base index: 0. See the 'Pagination'
1031
+ * section at the top of this page for more details.
1032
+ */
1033
+ startAt?: number;
1034
+ /**
1035
+ * The maximum number of boards to return per page. Default: 50. See the
1036
+ * 'Pagination' section at the top of this page for more details.
1037
+ */
1038
+ maxResults?: number;
1039
+ }): Promise<{
1040
+ isLast?: boolean;
1041
+ maxResults?: number;
1042
+ startAt?: number;
1043
+ total?: number;
1044
+ values?: {
1045
+ id?: number;
1046
+ name?: string;
1047
+ self?: string;
1048
+ }[];
1049
+ }> {
1050
+ return this.getClientInstance()
1051
+ .request({
1052
+ path: "/rest/agile/1.0/board/filter/{filterId}",
1053
+ method: "GET",
1054
+ pathParams: {
1055
+ filterId,
1056
+ },
1057
+ query: {
1058
+ startAt,
1059
+ maxResults,
1060
+ },
1061
+ })
1062
+ .then(
1063
+ this.getClientInstance().responseHandler({
1064
+ 200: {
1065
+ "application/json": "json",
1066
+ },
1067
+ }),
1068
+ )
1069
+ .then(
1070
+ commonHttpClient.castResponse<{
1071
+ status: 200;
1072
+ mediaType: "application/json";
1073
+ body: {
1074
+ isLast?: boolean;
1075
+ maxResults?: number;
1076
+ startAt?: number;
1077
+ total?: number;
1078
+ values?: {
1079
+ id?: number;
1080
+ name?: string;
1081
+ self?: string;
1082
+ }[];
1083
+ };
1084
+ }>(),
1085
+ )
1086
+ .then(
1087
+ validationSchemaStorage.validator(
1088
+ "BoardService.getBoardByFilterId.response",
1089
+ ),
1090
+ )
1091
+ .then(commonHttpClient.getBody);
1092
+ }
1093
+ /**
1094
+ * Returns all issues that belong to an epic on the board, for the given epic ID
1095
+ * and the board ID. This only includes issues that the user has permission to
1096
+ * view. Issues returned from this resource include Agile fields, like sprint,
1097
+ * closedSprints, flagged, and epic. By default, the returned issues are ordered
1098
+ * by rank.
1099
+ *
1100
+ * @returns Returns the requested issues, at the specified page of the results.
1101
+ *
1102
+ * example: {
1103
+ * "expand": "names,schema",
1104
+ * "issues": [
1105
+ * {
1106
+ * "expand": "",
1107
+ * "fields": {
1108
+ * "flagged": true,
1109
+ * "sprint": {
1110
+ * "id": 37,
1111
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1112
+ * "state": "future",
1113
+ * "name": "sprint 2",
1114
+ * "goal": "sprint 2 goal"
1115
+ * },
1116
+ * "closedSprints": [
1117
+ * {
1118
+ * "id": 37,
1119
+ * "self":
1120
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1121
+ * "state": "closed",
1122
+ * "name": "sprint 1",
1123
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
1124
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
1125
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
1126
+ * "goal": "sprint 1 goal"
1127
+ * }
1128
+ * ],
1129
+ * "description": "example bug report",
1130
+ * "project": {
1131
+ * "avatarUrls": {
1132
+ * "16x16":
1133
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1134
+ * "24x24":
1135
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1136
+ * "32x32":
1137
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1138
+ * "48x48":
1139
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1140
+ * },
1141
+ * "id": "10000",
1142
+ * "insight": {
1143
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1144
+ * "totalIssueCount": 100
1145
+ * },
1146
+ * "key": "EX",
1147
+ * "name": "Example",
1148
+ * "projectCategory": {
1149
+ * "description": "First Project Category",
1150
+ * "id": "10000",
1151
+ * "name": "FIRST",
1152
+ * "self":
1153
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1154
+ * },
1155
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1156
+ * "simplified": false,
1157
+ * "style": "classic"
1158
+ * },
1159
+ * "comment": [
1160
+ * {
1161
+ * "author": {
1162
+ * "accountId": "5b10a2844c20165700ede21g",
1163
+ * "active": false,
1164
+ * "displayName": "Mia Krystof",
1165
+ * "self":
1166
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1167
+ * },
1168
+ * "body": {
1169
+ * "type": "doc",
1170
+ * "version": 1,
1171
+ * "content": [
1172
+ * {
1173
+ * "type": "paragraph",
1174
+ * "content": [
1175
+ * {
1176
+ * "type": "text",
1177
+ * "text": "Lorem ipsum dolor sit amet, consectetur
1178
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1179
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1180
+ * semper."
1181
+ * }
1182
+ * ]
1183
+ * }
1184
+ * ]
1185
+ * },
1186
+ * "created": "2021-01-17T12:34:00.000+0000",
1187
+ * "id": "10000",
1188
+ * "self":
1189
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1190
+ * "updateAuthor": {
1191
+ * "accountId": "5b10a2844c20165700ede21g",
1192
+ * "active": false,
1193
+ * "displayName": "Mia Krystof",
1194
+ * "self":
1195
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1196
+ * },
1197
+ * "updated": "2021-01-18T23:45:00.000+0000",
1198
+ * "visibility": {
1199
+ * "identifier": "Administrators",
1200
+ * "type": "role",
1201
+ * "value": "Administrators"
1202
+ * }
1203
+ * }
1204
+ * ],
1205
+ * "epic": {
1206
+ * "id": 37,
1207
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1208
+ * "name": "epic 1",
1209
+ * "summary": "epic 1 summary",
1210
+ * "color": {
1211
+ * "key": "color_4"
1212
+ * },
1213
+ * "done": true
1214
+ * },
1215
+ * "worklog": [
1216
+ * {
1217
+ * "author": {
1218
+ * "accountId": "5b10a2844c20165700ede21g",
1219
+ * "active": false,
1220
+ * "displayName": "Mia Krystof",
1221
+ * "self":
1222
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1223
+ * },
1224
+ * "comment": {
1225
+ * "type": "doc",
1226
+ * "version": 1,
1227
+ * "content": [
1228
+ * {
1229
+ * "type": "paragraph",
1230
+ * "content": [
1231
+ * {
1232
+ * "type": "text",
1233
+ * "text": "I did some work here."
1234
+ * }
1235
+ * ]
1236
+ * }
1237
+ * ]
1238
+ * },
1239
+ * "id": "100028",
1240
+ * "issueId": "10002",
1241
+ * "self":
1242
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1243
+ * "started": "2021-01-17T12:34:00.000+0000",
1244
+ * "timeSpent": "3h 20m",
1245
+ * "timeSpentSeconds": 12000,
1246
+ * "updateAuthor": {
1247
+ * "accountId": "5b10a2844c20165700ede21g",
1248
+ * "active": false,
1249
+ * "displayName": "Mia Krystof",
1250
+ * "self":
1251
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1252
+ * },
1253
+ * "updated": "2021-01-18T23:45:00.000+0000",
1254
+ * "visibility": {
1255
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1256
+ * "type": "group",
1257
+ * "value": "jira-developers"
1258
+ * }
1259
+ * }
1260
+ * ],
1261
+ * "updated": 1,
1262
+ * "timetracking": {
1263
+ * "originalEstimate": "10m",
1264
+ * "originalEstimateSeconds": 600,
1265
+ * "remainingEstimate": "3m",
1266
+ * "remainingEstimateSeconds": 200,
1267
+ * "timeSpent": "6m",
1268
+ * "timeSpentSeconds": 400
1269
+ * }
1270
+ * },
1271
+ * "id": "10001",
1272
+ * "key": "HSP-1",
1273
+ * "self":
1274
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1275
+ * }
1276
+ * ],
1277
+ * "maxResults": 50,
1278
+ * "startAt": 0,
1279
+ * "total": 1
1280
+ * }
1281
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
1282
+ */
1283
+ getBoardIssuesForEpic({
1284
+ boardId,
1285
+ epicId,
1286
+ startAt,
1287
+ maxResults,
1288
+ jql,
1289
+ validateQuery,
1290
+ fields,
1291
+ expand,
1292
+ }: {
1293
+ /** The ID of the board that contains the requested issues. */
1294
+ boardId: number;
1295
+ /** The ID of the epic that contains the requested issues. */
1296
+ epicId: number;
1297
+ /**
1298
+ * The starting index of the returned issues. Base index: 0. See the 'Pagination'
1299
+ * section at the top of this page for more details.
1300
+ */
1301
+ startAt?: number;
1302
+ /**
1303
+ * The maximum number of issues to return per page. Default: 50. See the
1304
+ * 'Pagination' section at the top of this page for more details. Note, the total
1305
+ * number of issues returned is limited by the property
1306
+ * 'jira.search.views.default.max' in your Jira instance. If you exceed this
1307
+ * limit, your results will be truncated.
1308
+ */
1309
+ maxResults?: number;
1310
+ /**
1311
+ * Filters results using a JQL query. If you define an order in your JQL query, it
1312
+ * will override the default order of the returned issues.
1313
+ */
1314
+ jql?: string;
1315
+ /** Specifies whether to validate the JQL query or not. Default: true. */
1316
+ validateQuery?: boolean;
1317
+ /**
1318
+ * The list of fields to return for each issue. By default, all navigable and
1319
+ * Agile fields are returned.
1320
+ */
1321
+ fields?: {}[];
1322
+ /** A comma-separated list of the parameters to expand. */
1323
+ expand?: string;
1324
+ }): Promise<unknown> {
1325
+ return this.getClientInstance()
1326
+ .request({
1327
+ path: "/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue",
1328
+ method: "GET",
1329
+ pathParams: {
1330
+ boardId,
1331
+ epicId,
1332
+ },
1333
+ query: {
1334
+ startAt,
1335
+ maxResults,
1336
+ jql,
1337
+ validateQuery,
1338
+ fields,
1339
+ expand,
1340
+ },
1341
+ })
1342
+ .then(
1343
+ this.getClientInstance().responseHandler({
1344
+ 200: {
1345
+ "application/json": "json",
1346
+ },
1347
+ }),
1348
+ )
1349
+ .then(
1350
+ commonHttpClient.castResponse<{
1351
+ status: 200;
1352
+ mediaType: "application/json";
1353
+ body: unknown;
1354
+ }>(),
1355
+ )
1356
+ .then(
1357
+ validationSchemaStorage.validator(
1358
+ "BoardService.getBoardIssuesForEpic.response",
1359
+ ),
1360
+ )
1361
+ .then(commonHttpClient.getBody);
1362
+ }
1363
+ /**
1364
+ * Get all issues you have access to that belong to the sprint from the board.
1365
+ * Issue returned from this resource contains additional fields like: sprint,
1366
+ * closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order
1367
+ * has higher priority than default rank.
1368
+ *
1369
+ * @returns Returns the requested issues, at the specified page of the results.
1370
+ *
1371
+ * example: {
1372
+ * "expand": "names,schema",
1373
+ * "issues": [
1374
+ * {
1375
+ * "expand": "",
1376
+ * "fields": {
1377
+ * "flagged": true,
1378
+ * "sprint": {
1379
+ * "id": 37,
1380
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
1381
+ * "state": "future",
1382
+ * "name": "sprint 2",
1383
+ * "goal": "sprint 2 goal"
1384
+ * },
1385
+ * "closedSprints": [
1386
+ * {
1387
+ * "id": 37,
1388
+ * "self":
1389
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
1390
+ * "state": "closed",
1391
+ * "name": "sprint 1",
1392
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
1393
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
1394
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
1395
+ * "goal": "sprint 1 goal"
1396
+ * }
1397
+ * ],
1398
+ * "description": "example bug report",
1399
+ * "project": {
1400
+ * "avatarUrls": {
1401
+ * "16x16":
1402
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
1403
+ * "24x24":
1404
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
1405
+ * "32x32":
1406
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
1407
+ * "48x48":
1408
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
1409
+ * },
1410
+ * "id": "10000",
1411
+ * "insight": {
1412
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
1413
+ * "totalIssueCount": 100
1414
+ * },
1415
+ * "key": "EX",
1416
+ * "name": "Example",
1417
+ * "projectCategory": {
1418
+ * "description": "First Project Category",
1419
+ * "id": "10000",
1420
+ * "name": "FIRST",
1421
+ * "self":
1422
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
1423
+ * },
1424
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
1425
+ * "simplified": false,
1426
+ * "style": "classic"
1427
+ * },
1428
+ * "comment": [
1429
+ * {
1430
+ * "author": {
1431
+ * "accountId": "5b10a2844c20165700ede21g",
1432
+ * "active": false,
1433
+ * "displayName": "Mia Krystof",
1434
+ * "self":
1435
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1436
+ * },
1437
+ * "body": {
1438
+ * "type": "doc",
1439
+ * "version": 1,
1440
+ * "content": [
1441
+ * {
1442
+ * "type": "paragraph",
1443
+ * "content": [
1444
+ * {
1445
+ * "type": "text",
1446
+ * "text": "Lorem ipsum dolor sit amet, consectetur
1447
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
1448
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
1449
+ * semper."
1450
+ * }
1451
+ * ]
1452
+ * }
1453
+ * ]
1454
+ * },
1455
+ * "created": "2021-01-17T12:34:00.000+0000",
1456
+ * "id": "10000",
1457
+ * "self":
1458
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
1459
+ * "updateAuthor": {
1460
+ * "accountId": "5b10a2844c20165700ede21g",
1461
+ * "active": false,
1462
+ * "displayName": "Mia Krystof",
1463
+ * "self":
1464
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1465
+ * },
1466
+ * "updated": "2021-01-18T23:45:00.000+0000",
1467
+ * "visibility": {
1468
+ * "identifier": "Administrators",
1469
+ * "type": "role",
1470
+ * "value": "Administrators"
1471
+ * }
1472
+ * }
1473
+ * ],
1474
+ * "epic": {
1475
+ * "id": 37,
1476
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1477
+ * "name": "epic 1",
1478
+ * "summary": "epic 1 summary",
1479
+ * "color": {
1480
+ * "key": "color_4"
1481
+ * },
1482
+ * "done": true
1483
+ * },
1484
+ * "worklog": [
1485
+ * {
1486
+ * "author": {
1487
+ * "accountId": "5b10a2844c20165700ede21g",
1488
+ * "active": false,
1489
+ * "displayName": "Mia Krystof",
1490
+ * "self":
1491
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1492
+ * },
1493
+ * "comment": {
1494
+ * "type": "doc",
1495
+ * "version": 1,
1496
+ * "content": [
1497
+ * {
1498
+ * "type": "paragraph",
1499
+ * "content": [
1500
+ * {
1501
+ * "type": "text",
1502
+ * "text": "I did some work here."
1503
+ * }
1504
+ * ]
1505
+ * }
1506
+ * ]
1507
+ * },
1508
+ * "id": "100028",
1509
+ * "issueId": "10002",
1510
+ * "self":
1511
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
1512
+ * "started": "2021-01-17T12:34:00.000+0000",
1513
+ * "timeSpent": "3h 20m",
1514
+ * "timeSpentSeconds": 12000,
1515
+ * "updateAuthor": {
1516
+ * "accountId": "5b10a2844c20165700ede21g",
1517
+ * "active": false,
1518
+ * "displayName": "Mia Krystof",
1519
+ * "self":
1520
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
1521
+ * },
1522
+ * "updated": "2021-01-18T23:45:00.000+0000",
1523
+ * "visibility": {
1524
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
1525
+ * "type": "group",
1526
+ * "value": "jira-developers"
1527
+ * }
1528
+ * }
1529
+ * ],
1530
+ * "updated": 1,
1531
+ * "timetracking": {
1532
+ * "originalEstimate": "10m",
1533
+ * "originalEstimateSeconds": 600,
1534
+ * "remainingEstimate": "3m",
1535
+ * "remainingEstimateSeconds": 200,
1536
+ * "timeSpent": "6m",
1537
+ * "timeSpentSeconds": 400
1538
+ * }
1539
+ * },
1540
+ * "id": "10001",
1541
+ * "key": "HSP-1",
1542
+ * "self":
1543
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
1544
+ * }
1545
+ * ],
1546
+ * "maxResults": 50,
1547
+ * "startAt": 0,
1548
+ * "total": 1
1549
+ * }
1550
+ * @path {GET} /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
1551
+ */
1552
+ getBoardIssuesForSprint({
1553
+ boardId,
1554
+ sprintId,
1555
+ startAt,
1556
+ maxResults,
1557
+ jql,
1558
+ validateQuery,
1559
+ fields,
1560
+ expand,
1561
+ }: {
1562
+ /** The ID of the board that contains requested issues. */
1563
+ boardId: number;
1564
+ /** The ID of the sprint that contains requested issues. */
1565
+ sprintId: number;
1566
+ /**
1567
+ * The starting index of the returned issues. Base index: 0. See the 'Pagination'
1568
+ * section at the top of this page for more details.
1569
+ */
1570
+ startAt?: number;
1571
+ /**
1572
+ * The maximum number of issues to return per page. See the 'Pagination' section
1573
+ * at the top of this page for more details. Note, the total number of issues
1574
+ * returned is limited by the property 'jira.search.views.default.max' in your
1575
+ * Jira instance. If you exceed this limit, your results will be truncated.
1576
+ */
1577
+ maxResults?: number;
1578
+ /**
1579
+ * Filters results using a JQL query. If you define an order in your JQL query, it
1580
+ * will override the default order of the returned issues.
1581
+ * Note that `username` and `userkey` can't be used as search terms for this
1582
+ * parameter due to privacy reasons. Use `accountId` instead.
1583
+ */
1584
+ jql?: string;
1585
+ /** Specifies whether to validate the JQL query or not. Default: true. */
1586
+ validateQuery?: boolean;
1587
+ /**
1588
+ * The list of fields to return for each issue. By default, all navigable and
1589
+ * Agile fields are returned.
1590
+ */
1591
+ fields?: {}[];
1592
+ /** A comma-separated list of the parameters to expand. */
1593
+ expand?: string;
1594
+ }): Promise<unknown> {
1595
+ return this.getClientInstance()
1596
+ .request({
1597
+ path: "/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue",
1598
+ method: "GET",
1599
+ pathParams: {
1600
+ boardId,
1601
+ sprintId,
1602
+ },
1603
+ query: {
1604
+ startAt,
1605
+ maxResults,
1606
+ jql,
1607
+ validateQuery,
1608
+ fields,
1609
+ expand,
1610
+ },
1611
+ })
1612
+ .then(
1613
+ this.getClientInstance().responseHandler({
1614
+ 200: {
1615
+ "application/json": "json",
1616
+ },
1617
+ }),
1618
+ )
1619
+ .then(
1620
+ commonHttpClient.castResponse<{
1621
+ status: 200;
1622
+ mediaType: "application/json";
1623
+ body: unknown;
1624
+ }>(),
1625
+ )
1626
+ .then(
1627
+ validationSchemaStorage.validator(
1628
+ "BoardService.getBoardIssuesForSprint.response",
1629
+ ),
1630
+ )
1631
+ .then(commonHttpClient.getBody);
1632
+ }
1633
+ /**
1634
+ * Returns the value of the property with a given key from the board identified by
1635
+ * the provided id. The user who retrieves the property is required to have
1636
+ * permissions to view the board.
1637
+ *
1638
+ * @returns Returned if the board exists and the property was found.
1639
+ * @path {GET} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
1640
+ */
1641
+ getBoardProperty({
1642
+ boardId,
1643
+ propertyKey,
1644
+ }: {
1645
+ /** the ID of the board from which the property will be returned. */
1646
+ boardId: string;
1647
+ /** the key of the property to return. */
1648
+ propertyKey: string;
1649
+ }): Promise<unknown> {
1650
+ return this.getClientInstance()
1651
+ .request({
1652
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
1653
+ method: "GET",
1654
+ pathParams: {
1655
+ boardId,
1656
+ propertyKey,
1657
+ },
1658
+ })
1659
+ .then(
1660
+ this.getClientInstance().responseHandler({
1661
+ 200: {
1662
+ "application/json": "json",
1663
+ },
1664
+ }),
1665
+ )
1666
+ .then(
1667
+ commonHttpClient.castResponse<{
1668
+ status: 200;
1669
+ mediaType: "application/json";
1670
+ body: unknown;
1671
+ }>(),
1672
+ )
1673
+ .then(
1674
+ validationSchemaStorage.validator(
1675
+ "BoardService.getBoardProperty.response",
1676
+ ),
1677
+ )
1678
+ .then(commonHttpClient.getBody);
1679
+ }
1680
+ /**
1681
+ * Returns the keys of all properties for the board identified by the id. The user
1682
+ * who retrieves the property keys is required to have permissions to view the
1683
+ * board.
1684
+ *
1685
+ * @returns Returned if the board with given id exists.
1686
+ * @path {GET} /rest/agile/1.0/board/{boardId}/properties
1687
+ */
1688
+ getBoardPropertyKeys({
1689
+ boardId,
1690
+ }: {
1691
+ /** the ID of the board from which property keys will be returned. */
1692
+ boardId: string;
1693
+ }): Promise<unknown> {
1694
+ return this.getClientInstance()
1695
+ .request({
1696
+ path: "/rest/agile/1.0/board/{boardId}/properties",
1697
+ method: "GET",
1698
+ pathParams: {
1699
+ boardId,
1700
+ },
1701
+ })
1702
+ .then(
1703
+ this.getClientInstance().responseHandler({
1704
+ 200: {
1705
+ "application/json": "json",
1706
+ },
1707
+ }),
1708
+ )
1709
+ .then(
1710
+ commonHttpClient.castResponse<{
1711
+ status: 200;
1712
+ mediaType: "application/json";
1713
+ body: unknown;
1714
+ }>(),
1715
+ )
1716
+ .then(
1717
+ validationSchemaStorage.validator(
1718
+ "BoardService.getBoardPropertyKeys.response",
1719
+ ),
1720
+ )
1721
+ .then(commonHttpClient.getBody);
1722
+ }
1723
+ /**
1724
+ * Get the board configuration. The response contains the following fields:
1725
+ *
1726
+ * * `id` \- ID of the board.
1727
+ * * `name` \- Name of the board.
1728
+ * * `filter` \- Reference to the filter used by the given board.
1729
+ * * `location` \- Reference to the container that the board is located in.
1730
+ * Includes the container type (Valid values: project, user).
1731
+ * * `subQuery` (Kanban only) - JQL subquery used by the given board.
1732
+ * * `columnConfig` \- The column configuration lists the columns for the board,
1733
+ * in the order defined in the column configuration. For each column, it shows the
1734
+ * issue status mapping as well as the constraint type (Valid values: none,
1735
+ * issueCount, issueCountExclSubs) for the min/max number of issues. Note, the
1736
+ * last column with statuses mapped to it is treated as the "Done" column, which
1737
+ * means that issues in that column will be marked as already completed.
1738
+ * * `estimation` (Scrum only) - Contains information about type of estimation
1739
+ * used for the board. Valid values: none, issueCount, field. If the estimation
1740
+ * type is "field", the ID and display name of the field used for estimation is
1741
+ * also returned. Note, estimates for an issue can be updated by a PUT
1742
+ * /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the
1743
+ * screen. "timeoriginalestimate" field will never be on the screen, so in order
1744
+ * to update it "originalEstimate" in "timetracking" field should be updated.
1745
+ * * `ranking` \- Contains information about custom field used for ranking in
1746
+ * the given board.
1747
+ *
1748
+ * @returns Returns the configuration of the board for given boardId.
1749
+ *
1750
+ * example: {
1751
+ * "columnConfig": {
1752
+ * "columns": [
1753
+ * {
1754
+ * "name": "To Do",
1755
+ * "statuses": [
1756
+ * {
1757
+ * "id": "1",
1758
+ * "self": "https://your-domain.atlassian.net/status/1"
1759
+ * },
1760
+ * {
1761
+ * "id": "4",
1762
+ * "self": "https://your-domain.atlassian.net/status/4"
1763
+ * }
1764
+ * ]
1765
+ * },
1766
+ * {
1767
+ * "max": 4,
1768
+ * "min": 2,
1769
+ * "name": "In progress",
1770
+ * "statuses": [
1771
+ * {
1772
+ * "id": "3",
1773
+ * "self": "https://your-domain.atlassian.net/status/3"
1774
+ * }
1775
+ * ]
1776
+ * },
1777
+ * {
1778
+ * "name": "Done",
1779
+ * "statuses": [
1780
+ * {
1781
+ * "id": "5",
1782
+ * "self": "https://your-domain.atlassian.net/status/5"
1783
+ * }
1784
+ * ]
1785
+ * }
1786
+ * ],
1787
+ * "constraintType": "issueCount"
1788
+ * },
1789
+ * "estimation": {
1790
+ * "field": {
1791
+ * "displayName": "Story Points",
1792
+ * "fieldId": "customfield_10002"
1793
+ * },
1794
+ * "type": "field"
1795
+ * },
1796
+ * "filter": {
1797
+ * "id": "1001",
1798
+ * "self": "https://your-domain.atlassian.net/filter/1001"
1799
+ * },
1800
+ * "id": 10000,
1801
+ * "location": {
1802
+ * "id": "10010",
1803
+ * "key": "PROJ",
1804
+ * "name": "name",
1805
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/10010",
1806
+ * "type": "project"
1807
+ * },
1808
+ * "name": "Board",
1809
+ * "ranking": {
1810
+ * "rankCustomFieldId": 10020
1811
+ * },
1812
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
1813
+ * }
1814
+ * @path {GET} /rest/agile/1.0/board/{boardId}/configuration
1815
+ */
1816
+ getConfiguration({
1817
+ boardId,
1818
+ }: {
1819
+ /** The ID of the board for which configuration is requested. */
1820
+ boardId: number;
1821
+ }): Promise<{
1822
+ columnConfig?: {
1823
+ columns?: {
1824
+ max?: number;
1825
+ min?: number;
1826
+ name?: string;
1827
+ statuses?: {
1828
+ id?: string;
1829
+ self?: string;
1830
+ }[];
1831
+ }[];
1832
+ constraintType?: string;
1833
+ };
1834
+ estimation?: {
1835
+ field?: {
1836
+ displayName?: string;
1837
+ fieldId?: string;
1838
+ };
1839
+ type?: string;
1840
+ };
1841
+ filter?: {
1842
+ id?: string;
1843
+ self?: string;
1844
+ };
1845
+ id?: number;
1846
+ location?: {
1847
+ projectKeyOrId?: string;
1848
+ type?: "project" | "user";
1849
+ };
1850
+ name?: string;
1851
+ ranking?: {
1852
+ rankCustomFieldId?: number;
1853
+ };
1854
+ self?: string;
1855
+ subQuery?: {
1856
+ query?: string;
1857
+ };
1858
+ type?: string;
1859
+ }> {
1860
+ return this.getClientInstance()
1861
+ .request({
1862
+ path: "/rest/agile/1.0/board/{boardId}/configuration",
1863
+ method: "GET",
1864
+ pathParams: {
1865
+ boardId,
1866
+ },
1867
+ })
1868
+ .then(
1869
+ this.getClientInstance().responseHandler({
1870
+ 200: {
1871
+ "application/json": "json",
1872
+ },
1873
+ }),
1874
+ )
1875
+ .then(
1876
+ commonHttpClient.castResponse<{
1877
+ status: 200;
1878
+ mediaType: "application/json";
1879
+ body: {
1880
+ columnConfig?: {
1881
+ columns?: {
1882
+ max?: number;
1883
+ min?: number;
1884
+ name?: string;
1885
+ statuses?: {
1886
+ id?: string;
1887
+ self?: string;
1888
+ }[];
1889
+ }[];
1890
+ constraintType?: string;
1891
+ };
1892
+ estimation?: {
1893
+ field?: {
1894
+ displayName?: string;
1895
+ fieldId?: string;
1896
+ };
1897
+ type?: string;
1898
+ };
1899
+ filter?: {
1900
+ id?: string;
1901
+ self?: string;
1902
+ };
1903
+ id?: number;
1904
+ location?: {
1905
+ projectKeyOrId?: string;
1906
+ type?: "project" | "user";
1907
+ };
1908
+ name?: string;
1909
+ ranking?: {
1910
+ rankCustomFieldId?: number;
1911
+ };
1912
+ self?: string;
1913
+ subQuery?: {
1914
+ query?: string;
1915
+ };
1916
+ type?: string;
1917
+ };
1918
+ }>(),
1919
+ )
1920
+ .then(
1921
+ validationSchemaStorage.validator(
1922
+ "BoardService.getConfiguration.response",
1923
+ ),
1924
+ )
1925
+ .then(commonHttpClient.getBody);
1926
+ }
1927
+ /**
1928
+ * Returns all epics from the board, for the given board ID. This only includes
1929
+ * epics that the user has permission to view. Note, if the user does not have
1930
+ * permission to view the board, no epics will be returned at all.
1931
+ *
1932
+ * @returns Returns the requested epics, at the specified page of the results.
1933
+ *
1934
+ * example: {
1935
+ * "isLast": false,
1936
+ * "maxResults": 2,
1937
+ * "startAt": 1,
1938
+ * "total": 5,
1939
+ * "values": [
1940
+ * {
1941
+ * "id": 37,
1942
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
1943
+ * "name": "epic 1",
1944
+ * "summary": "epic 1 summary",
1945
+ * "color": {
1946
+ * "key": "color_4"
1947
+ * },
1948
+ * "done": true
1949
+ * },
1950
+ * {
1951
+ * "id": 37,
1952
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/13",
1953
+ * "name": "epic 2",
1954
+ * "summary": "epic 2 summary",
1955
+ * "color": {
1956
+ * "key": "color_2"
1957
+ * },
1958
+ * "done": false
1959
+ * }
1960
+ * ]
1961
+ * }
1962
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic
1963
+ */
1964
+ getEpics({
1965
+ boardId,
1966
+ startAt,
1967
+ maxResults,
1968
+ done,
1969
+ }: {
1970
+ /** The ID of the board that contains the requested epics. */
1971
+ boardId: number;
1972
+ /**
1973
+ * The starting index of the returned epics. Base index: 0. See the 'Pagination'
1974
+ * section at the top of this page for more details.
1975
+ */
1976
+ startAt?: number;
1977
+ /**
1978
+ * The maximum number of epics to return per page. See the 'Pagination' section at
1979
+ * the top of this page for more details.
1980
+ */
1981
+ maxResults?: number;
1982
+ /**
1983
+ * Filters results to epics that are either done or not done. Valid values: true,
1984
+ * false.
1985
+ */
1986
+ done?: string;
1987
+ }): Promise<unknown> {
1988
+ return this.getClientInstance()
1989
+ .request({
1990
+ path: "/rest/agile/1.0/board/{boardId}/epic",
1991
+ method: "GET",
1992
+ pathParams: {
1993
+ boardId,
1994
+ },
1995
+ query: {
1996
+ startAt,
1997
+ maxResults,
1998
+ done,
1999
+ },
2000
+ })
2001
+ .then(
2002
+ this.getClientInstance().responseHandler({
2003
+ 200: {
2004
+ "application/json": "json",
2005
+ },
2006
+ }),
2007
+ )
2008
+ .then(
2009
+ commonHttpClient.castResponse<{
2010
+ status: 200;
2011
+ mediaType: "application/json";
2012
+ body: unknown;
2013
+ }>(),
2014
+ )
2015
+ .then(validationSchemaStorage.validator("BoardService.getEpics.response"))
2016
+ .then(commonHttpClient.getBody);
2017
+ }
2018
+ /**
2019
+ * @returns 200 response
2020
+ * @path {GET} /rest/agile/1.0/board/{boardId}/features
2021
+ */
2022
+ getFeaturesForBoard({ boardId }: { boardId: number }): Promise<{
2023
+ features?: {
2024
+ boardFeature?:
2025
+ | "SIMPLE_ROADMAP"
2026
+ | "BACKLOG"
2027
+ | "SPRINTS"
2028
+ | "CALENDAR"
2029
+ | "DEVTOOLS"
2030
+ | "REPORTS"
2031
+ | "ESTIMATION"
2032
+ | "PAGES"
2033
+ | "CODE"
2034
+ | "SECURITY"
2035
+ | "REQUESTS"
2036
+ | "INCIDENTS"
2037
+ | "RELEASES"
2038
+ | "DEPLOYMENTS"
2039
+ | "ISSUE_NAVIGATOR"
2040
+ | "ON_CALL_SCHEDULE"
2041
+ | "BOARD"
2042
+ | "GOALS"
2043
+ | "LIST_VIEW";
2044
+ boardId?: number;
2045
+ featureId?: string;
2046
+ featureType?: "BASIC" | "ESTIMATION";
2047
+ imageUri?: string;
2048
+ learnMoreArticleId?: string;
2049
+ learnMoreLink?: string;
2050
+ localisedDescription?: string;
2051
+ localisedGroup?: string;
2052
+ localisedName?: string;
2053
+ permissibleEstimationTypes?: {
2054
+ localisedDescription?: string;
2055
+ localisedName?: string;
2056
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
2057
+ }[];
2058
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
2059
+ toggleLocked?: boolean;
2060
+ }[];
2061
+ }> {
2062
+ return this.getClientInstance()
2063
+ .request({
2064
+ path: "/rest/agile/1.0/board/{boardId}/features",
2065
+ method: "GET",
2066
+ pathParams: {
2067
+ boardId,
2068
+ },
2069
+ })
2070
+ .then(
2071
+ this.getClientInstance().responseHandler({
2072
+ 200: {
2073
+ "application/json": "json",
2074
+ },
2075
+ }),
2076
+ )
2077
+ .then(
2078
+ commonHttpClient.castResponse<{
2079
+ status: 200;
2080
+ mediaType: "application/json";
2081
+ body: {
2082
+ features?: {
2083
+ boardFeature?:
2084
+ | "SIMPLE_ROADMAP"
2085
+ | "BACKLOG"
2086
+ | "SPRINTS"
2087
+ | "CALENDAR"
2088
+ | "DEVTOOLS"
2089
+ | "REPORTS"
2090
+ | "ESTIMATION"
2091
+ | "PAGES"
2092
+ | "CODE"
2093
+ | "SECURITY"
2094
+ | "REQUESTS"
2095
+ | "INCIDENTS"
2096
+ | "RELEASES"
2097
+ | "DEPLOYMENTS"
2098
+ | "ISSUE_NAVIGATOR"
2099
+ | "ON_CALL_SCHEDULE"
2100
+ | "BOARD"
2101
+ | "GOALS"
2102
+ | "LIST_VIEW";
2103
+ boardId?: number;
2104
+ featureId?: string;
2105
+ featureType?: "BASIC" | "ESTIMATION";
2106
+ imageUri?: string;
2107
+ learnMoreArticleId?: string;
2108
+ learnMoreLink?: string;
2109
+ localisedDescription?: string;
2110
+ localisedGroup?: string;
2111
+ localisedName?: string;
2112
+ permissibleEstimationTypes?: {
2113
+ localisedDescription?: string;
2114
+ localisedName?: string;
2115
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
2116
+ }[];
2117
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
2118
+ toggleLocked?: boolean;
2119
+ }[];
2120
+ };
2121
+ }>(),
2122
+ )
2123
+ .then(
2124
+ validationSchemaStorage.validator(
2125
+ "BoardService.getFeaturesForBoard.response",
2126
+ ),
2127
+ )
2128
+ .then(commonHttpClient.getBody);
2129
+ }
2130
+ /**
2131
+ * Returns all issues from the board's backlog, for the given board ID. This only
2132
+ * includes issues that the user has permission to view. The backlog contains
2133
+ * incomplete issues that are not assigned to any future or active sprint. Note,
2134
+ * if the user does not have permission to view the board, no issues will be
2135
+ * returned at all. Issues returned from this resource include Agile fields, like
2136
+ * sprint, closedSprints, flagged, and epic. By default, the returned issues are
2137
+ * ordered by rank.
2138
+ *
2139
+ * @returns Returns the requested issues, at the specified page of the results.
2140
+ *
2141
+ * example: {
2142
+ * "expand": "names,schema",
2143
+ * "issues": [
2144
+ * {
2145
+ * "expand": "",
2146
+ * "fields": {
2147
+ * "flagged": true,
2148
+ * "sprint": {
2149
+ * "id": 37,
2150
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
2151
+ * "state": "future",
2152
+ * "name": "sprint 2",
2153
+ * "goal": "sprint 2 goal"
2154
+ * },
2155
+ * "closedSprints": [
2156
+ * {
2157
+ * "id": 37,
2158
+ * "self":
2159
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
2160
+ * "state": "closed",
2161
+ * "name": "sprint 1",
2162
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
2163
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
2164
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
2165
+ * "goal": "sprint 1 goal"
2166
+ * }
2167
+ * ],
2168
+ * "description": "example bug report",
2169
+ * "project": {
2170
+ * "avatarUrls": {
2171
+ * "16x16":
2172
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
2173
+ * "24x24":
2174
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
2175
+ * "32x32":
2176
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
2177
+ * "48x48":
2178
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
2179
+ * },
2180
+ * "id": "10000",
2181
+ * "insight": {
2182
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
2183
+ * "totalIssueCount": 100
2184
+ * },
2185
+ * "key": "EX",
2186
+ * "name": "Example",
2187
+ * "projectCategory": {
2188
+ * "description": "First Project Category",
2189
+ * "id": "10000",
2190
+ * "name": "FIRST",
2191
+ * "self":
2192
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
2193
+ * },
2194
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
2195
+ * "simplified": false,
2196
+ * "style": "classic"
2197
+ * },
2198
+ * "comment": [
2199
+ * {
2200
+ * "author": {
2201
+ * "accountId": "5b10a2844c20165700ede21g",
2202
+ * "active": false,
2203
+ * "displayName": "Mia Krystof",
2204
+ * "self":
2205
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2206
+ * },
2207
+ * "body": {
2208
+ * "type": "doc",
2209
+ * "version": 1,
2210
+ * "content": [
2211
+ * {
2212
+ * "type": "paragraph",
2213
+ * "content": [
2214
+ * {
2215
+ * "type": "text",
2216
+ * "text": "Lorem ipsum dolor sit amet, consectetur
2217
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
2218
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
2219
+ * semper."
2220
+ * }
2221
+ * ]
2222
+ * }
2223
+ * ]
2224
+ * },
2225
+ * "created": "2021-01-17T12:34:00.000+0000",
2226
+ * "id": "10000",
2227
+ * "self":
2228
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
2229
+ * "updateAuthor": {
2230
+ * "accountId": "5b10a2844c20165700ede21g",
2231
+ * "active": false,
2232
+ * "displayName": "Mia Krystof",
2233
+ * "self":
2234
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2235
+ * },
2236
+ * "updated": "2021-01-18T23:45:00.000+0000",
2237
+ * "visibility": {
2238
+ * "identifier": "Administrators",
2239
+ * "type": "role",
2240
+ * "value": "Administrators"
2241
+ * }
2242
+ * }
2243
+ * ],
2244
+ * "epic": {
2245
+ * "id": 37,
2246
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
2247
+ * "name": "epic 1",
2248
+ * "summary": "epic 1 summary",
2249
+ * "color": {
2250
+ * "key": "color_4"
2251
+ * },
2252
+ * "done": true
2253
+ * },
2254
+ * "worklog": [
2255
+ * {
2256
+ * "author": {
2257
+ * "accountId": "5b10a2844c20165700ede21g",
2258
+ * "active": false,
2259
+ * "displayName": "Mia Krystof",
2260
+ * "self":
2261
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2262
+ * },
2263
+ * "comment": {
2264
+ * "type": "doc",
2265
+ * "version": 1,
2266
+ * "content": [
2267
+ * {
2268
+ * "type": "paragraph",
2269
+ * "content": [
2270
+ * {
2271
+ * "type": "text",
2272
+ * "text": "I did some work here."
2273
+ * }
2274
+ * ]
2275
+ * }
2276
+ * ]
2277
+ * },
2278
+ * "id": "100028",
2279
+ * "issueId": "10002",
2280
+ * "self":
2281
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
2282
+ * "started": "2021-01-17T12:34:00.000+0000",
2283
+ * "timeSpent": "3h 20m",
2284
+ * "timeSpentSeconds": 12000,
2285
+ * "updateAuthor": {
2286
+ * "accountId": "5b10a2844c20165700ede21g",
2287
+ * "active": false,
2288
+ * "displayName": "Mia Krystof",
2289
+ * "self":
2290
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2291
+ * },
2292
+ * "updated": "2021-01-18T23:45:00.000+0000",
2293
+ * "visibility": {
2294
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
2295
+ * "type": "group",
2296
+ * "value": "jira-developers"
2297
+ * }
2298
+ * }
2299
+ * ],
2300
+ * "updated": 1,
2301
+ * "timetracking": {
2302
+ * "originalEstimate": "10m",
2303
+ * "originalEstimateSeconds": 600,
2304
+ * "remainingEstimate": "3m",
2305
+ * "remainingEstimateSeconds": 200,
2306
+ * "timeSpent": "6m",
2307
+ * "timeSpentSeconds": 400
2308
+ * }
2309
+ * },
2310
+ * "id": "10001",
2311
+ * "key": "HSP-1",
2312
+ * "self":
2313
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
2314
+ * }
2315
+ * ],
2316
+ * "maxResults": 50,
2317
+ * "startAt": 0,
2318
+ * "total": 1
2319
+ * }
2320
+ * @path {GET} /rest/agile/1.0/board/{boardId}/backlog
2321
+ */
2322
+ getIssuesForBacklog({
2323
+ boardId,
2324
+ startAt,
2325
+ maxResults,
2326
+ jql,
2327
+ validateQuery,
2328
+ fields,
2329
+ expand,
2330
+ }: {
2331
+ /** The ID of the board that has the backlog containing the requested issues. */
2332
+ boardId: number;
2333
+ /**
2334
+ * The starting index of the returned issues. Base index: 0. See the 'Pagination'
2335
+ * section at the top of this page for more details.
2336
+ */
2337
+ startAt?: number;
2338
+ /**
2339
+ * The maximum number of issues to return per page. Default: 50. See the
2340
+ * 'Pagination' section at the top of this page for more details. Note, the total
2341
+ * number of issues returned is limited by the property
2342
+ * 'jira.search.views.default.max' in your Jira instance. If you exceed this
2343
+ * limit, your results will be truncated.
2344
+ */
2345
+ maxResults?: number;
2346
+ /**
2347
+ * Filters results using a JQL query. If you define an order in your JQL query, it
2348
+ * will override the default order of the returned issues.
2349
+ * Note that `username` and `userkey` can't be used as search terms for this
2350
+ * parameter due to privacy reasons. Use `accountId` instead.
2351
+ */
2352
+ jql?: string;
2353
+ /** Specifies whether to validate the JQL query or not. Default: true. */
2354
+ validateQuery?: boolean;
2355
+ /**
2356
+ * The list of fields to return for each issue. By default, all navigable and
2357
+ * Agile fields are returned.
2358
+ */
2359
+ fields?: {}[];
2360
+ /** This parameter is currently not used. */
2361
+ expand?: string;
2362
+ }): Promise<SearchResults> {
2363
+ return this.getClientInstance()
2364
+ .request({
2365
+ path: "/rest/agile/1.0/board/{boardId}/backlog",
2366
+ method: "GET",
2367
+ pathParams: {
2368
+ boardId,
2369
+ },
2370
+ query: {
2371
+ startAt,
2372
+ maxResults,
2373
+ jql,
2374
+ validateQuery,
2375
+ fields,
2376
+ expand,
2377
+ },
2378
+ })
2379
+ .then(
2380
+ this.getClientInstance().responseHandler({
2381
+ 200: {
2382
+ "application/json": "json",
2383
+ },
2384
+ }),
2385
+ )
2386
+ .then(
2387
+ commonHttpClient.castResponse<{
2388
+ status: 200;
2389
+ mediaType: "application/json";
2390
+ body: SearchResults;
2391
+ }>(),
2392
+ )
2393
+ .then(
2394
+ validationSchemaStorage.validator(
2395
+ "BoardService.getIssuesForBacklog.response",
2396
+ ),
2397
+ )
2398
+ .then(commonHttpClient.getBody);
2399
+ }
2400
+ /**
2401
+ * Returns all issues from a board, for a given board ID. This only includes
2402
+ * issues that the user has permission to view. An issue belongs to the board if
2403
+ * its status is mapped to the board's column. Epic issues do not belongs to the
2404
+ * scrum boards. Note, if the user does not have permission to view the board, no
2405
+ * issues will be returned at all. Issues returned from this resource include
2406
+ * Agile fields, like sprint, closedSprints, flagged, and epic. By default, the
2407
+ * returned issues are ordered by rank.
2408
+ *
2409
+ * @returns Returns the requested issues, at the specified page of the results.
2410
+ *
2411
+ * example: {
2412
+ * "expand": "names,schema",
2413
+ * "issues": [
2414
+ * {
2415
+ * "expand": "",
2416
+ * "fields": {
2417
+ * "flagged": true,
2418
+ * "sprint": {
2419
+ * "id": 37,
2420
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
2421
+ * "state": "future",
2422
+ * "name": "sprint 2",
2423
+ * "goal": "sprint 2 goal"
2424
+ * },
2425
+ * "closedSprints": [
2426
+ * {
2427
+ * "id": 37,
2428
+ * "self":
2429
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
2430
+ * "state": "closed",
2431
+ * "name": "sprint 1",
2432
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
2433
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
2434
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
2435
+ * "goal": "sprint 1 goal"
2436
+ * }
2437
+ * ],
2438
+ * "description": "example bug report",
2439
+ * "project": {
2440
+ * "avatarUrls": {
2441
+ * "16x16":
2442
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
2443
+ * "24x24":
2444
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
2445
+ * "32x32":
2446
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
2447
+ * "48x48":
2448
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
2449
+ * },
2450
+ * "id": "10000",
2451
+ * "insight": {
2452
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
2453
+ * "totalIssueCount": 100
2454
+ * },
2455
+ * "key": "EX",
2456
+ * "name": "Example",
2457
+ * "projectCategory": {
2458
+ * "description": "First Project Category",
2459
+ * "id": "10000",
2460
+ * "name": "FIRST",
2461
+ * "self":
2462
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
2463
+ * },
2464
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
2465
+ * "simplified": false,
2466
+ * "style": "classic"
2467
+ * },
2468
+ * "comment": [
2469
+ * {
2470
+ * "author": {
2471
+ * "accountId": "5b10a2844c20165700ede21g",
2472
+ * "active": false,
2473
+ * "displayName": "Mia Krystof",
2474
+ * "self":
2475
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2476
+ * },
2477
+ * "body": {
2478
+ * "type": "doc",
2479
+ * "version": 1,
2480
+ * "content": [
2481
+ * {
2482
+ * "type": "paragraph",
2483
+ * "content": [
2484
+ * {
2485
+ * "type": "text",
2486
+ * "text": "Lorem ipsum dolor sit amet, consectetur
2487
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
2488
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
2489
+ * semper."
2490
+ * }
2491
+ * ]
2492
+ * }
2493
+ * ]
2494
+ * },
2495
+ * "created": "2021-01-17T12:34:00.000+0000",
2496
+ * "id": "10000",
2497
+ * "self":
2498
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
2499
+ * "updateAuthor": {
2500
+ * "accountId": "5b10a2844c20165700ede21g",
2501
+ * "active": false,
2502
+ * "displayName": "Mia Krystof",
2503
+ * "self":
2504
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2505
+ * },
2506
+ * "updated": "2021-01-18T23:45:00.000+0000",
2507
+ * "visibility": {
2508
+ * "identifier": "Administrators",
2509
+ * "type": "role",
2510
+ * "value": "Administrators"
2511
+ * }
2512
+ * }
2513
+ * ],
2514
+ * "epic": {
2515
+ * "id": 37,
2516
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
2517
+ * "name": "epic 1",
2518
+ * "summary": "epic 1 summary",
2519
+ * "color": {
2520
+ * "key": "color_4"
2521
+ * },
2522
+ * "done": true
2523
+ * },
2524
+ * "worklog": [
2525
+ * {
2526
+ * "author": {
2527
+ * "accountId": "5b10a2844c20165700ede21g",
2528
+ * "active": false,
2529
+ * "displayName": "Mia Krystof",
2530
+ * "self":
2531
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2532
+ * },
2533
+ * "comment": {
2534
+ * "type": "doc",
2535
+ * "version": 1,
2536
+ * "content": [
2537
+ * {
2538
+ * "type": "paragraph",
2539
+ * "content": [
2540
+ * {
2541
+ * "type": "text",
2542
+ * "text": "I did some work here."
2543
+ * }
2544
+ * ]
2545
+ * }
2546
+ * ]
2547
+ * },
2548
+ * "id": "100028",
2549
+ * "issueId": "10002",
2550
+ * "self":
2551
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
2552
+ * "started": "2021-01-17T12:34:00.000+0000",
2553
+ * "timeSpent": "3h 20m",
2554
+ * "timeSpentSeconds": 12000,
2555
+ * "updateAuthor": {
2556
+ * "accountId": "5b10a2844c20165700ede21g",
2557
+ * "active": false,
2558
+ * "displayName": "Mia Krystof",
2559
+ * "self":
2560
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2561
+ * },
2562
+ * "updated": "2021-01-18T23:45:00.000+0000",
2563
+ * "visibility": {
2564
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
2565
+ * "type": "group",
2566
+ * "value": "jira-developers"
2567
+ * }
2568
+ * }
2569
+ * ],
2570
+ * "updated": 1,
2571
+ * "timetracking": {
2572
+ * "originalEstimate": "10m",
2573
+ * "originalEstimateSeconds": 600,
2574
+ * "remainingEstimate": "3m",
2575
+ * "remainingEstimateSeconds": 200,
2576
+ * "timeSpent": "6m",
2577
+ * "timeSpentSeconds": 400
2578
+ * }
2579
+ * },
2580
+ * "id": "10001",
2581
+ * "key": "HSP-1",
2582
+ * "self":
2583
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
2584
+ * }
2585
+ * ],
2586
+ * "maxResults": 50,
2587
+ * "startAt": 0,
2588
+ * "total": 1
2589
+ * }
2590
+ * @path {GET} /rest/agile/1.0/board/{boardId}/issue
2591
+ */
2592
+ getIssuesForBoard({
2593
+ boardId,
2594
+ startAt,
2595
+ maxResults,
2596
+ jql,
2597
+ validateQuery,
2598
+ fields,
2599
+ expand,
2600
+ }: {
2601
+ /** The ID of the board that contains the requested issues. */
2602
+ boardId: number;
2603
+ /**
2604
+ * The starting index of the returned issues. Base index: 0. See the 'Pagination'
2605
+ * section at the top of this page for more details.
2606
+ */
2607
+ startAt?: number;
2608
+ /**
2609
+ * The maximum number of issues to return per page. See the 'Pagination' section
2610
+ * at the top of this page for more details. Note, the total number of issues
2611
+ * returned is limited by the property 'jira.search.views.default.max' in your
2612
+ * Jira instance. If you exceed this limit, your results will be truncated.
2613
+ */
2614
+ maxResults?: number;
2615
+ /**
2616
+ * Filters results using a JQL query. If you define an order in your JQL query, it
2617
+ * will override the default order of the returned issues.
2618
+ * Note that `username` and `userkey` can't be used as search terms for this
2619
+ * parameter due to privacy reasons. Use `accountId` instead.
2620
+ */
2621
+ jql?: string;
2622
+ /** Specifies whether to validate the JQL query or not. Default: true. */
2623
+ validateQuery?: boolean;
2624
+ /**
2625
+ * The list of fields to return for each issue. By default, all navigable and
2626
+ * Agile fields are returned.
2627
+ */
2628
+ fields?: {}[];
2629
+ /** This parameter is currently not used. */
2630
+ expand?: string;
2631
+ }): Promise<SearchResults> {
2632
+ return this.getClientInstance()
2633
+ .request({
2634
+ path: "/rest/agile/1.0/board/{boardId}/issue",
2635
+ method: "GET",
2636
+ pathParams: {
2637
+ boardId,
2638
+ },
2639
+ query: {
2640
+ startAt,
2641
+ maxResults,
2642
+ jql,
2643
+ validateQuery,
2644
+ fields,
2645
+ expand,
2646
+ },
2647
+ })
2648
+ .then(
2649
+ this.getClientInstance().responseHandler({
2650
+ 200: {
2651
+ "application/json": "json",
2652
+ },
2653
+ }),
2654
+ )
2655
+ .then(
2656
+ commonHttpClient.castResponse<{
2657
+ status: 200;
2658
+ mediaType: "application/json";
2659
+ body: SearchResults;
2660
+ }>(),
2661
+ )
2662
+ .then(
2663
+ validationSchemaStorage.validator(
2664
+ "BoardService.getIssuesForBoard.response",
2665
+ ),
2666
+ )
2667
+ .then(commonHttpClient.getBody);
2668
+ }
2669
+ /**
2670
+ * Returns all issues that do not belong to any epic on a board, for a given board
2671
+ * ID. This only includes issues that the user has permission to view. Issues
2672
+ * returned from this resource include Agile fields, like sprint, closedSprints,
2673
+ * flagged, and epic. By default, the returned issues are ordered by rank.
2674
+ *
2675
+ * @returns Returns the requested issues, at the specified page of the results.
2676
+ *
2677
+ * example: {
2678
+ * "expand": "names,schema",
2679
+ * "issues": [
2680
+ * {
2681
+ * "expand": "",
2682
+ * "fields": {
2683
+ * "flagged": true,
2684
+ * "sprint": {
2685
+ * "id": 37,
2686
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
2687
+ * "state": "future",
2688
+ * "name": "sprint 2",
2689
+ * "goal": "sprint 2 goal"
2690
+ * },
2691
+ * "closedSprints": [
2692
+ * {
2693
+ * "id": 37,
2694
+ * "self":
2695
+ * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
2696
+ * "state": "closed",
2697
+ * "name": "sprint 1",
2698
+ * "startDate": "2015-04-11T15:22:00.000+10:00",
2699
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
2700
+ * "completeDate": "2015-04-20T11:04:00.000+10:00",
2701
+ * "goal": "sprint 1 goal"
2702
+ * }
2703
+ * ],
2704
+ * "description": "example bug report",
2705
+ * "project": {
2706
+ * "avatarUrls": {
2707
+ * "16x16":
2708
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
2709
+ * "24x24":
2710
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
2711
+ * "32x32":
2712
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
2713
+ * "48x48":
2714
+ * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
2715
+ * },
2716
+ * "id": "10000",
2717
+ * "insight": {
2718
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
2719
+ * "totalIssueCount": 100
2720
+ * },
2721
+ * "key": "EX",
2722
+ * "name": "Example",
2723
+ * "projectCategory": {
2724
+ * "description": "First Project Category",
2725
+ * "id": "10000",
2726
+ * "name": "FIRST",
2727
+ * "self":
2728
+ * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
2729
+ * },
2730
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
2731
+ * "simplified": false,
2732
+ * "style": "classic"
2733
+ * },
2734
+ * "comment": [
2735
+ * {
2736
+ * "author": {
2737
+ * "accountId": "5b10a2844c20165700ede21g",
2738
+ * "active": false,
2739
+ * "displayName": "Mia Krystof",
2740
+ * "self":
2741
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2742
+ * },
2743
+ * "body": {
2744
+ * "type": "doc",
2745
+ * "version": 1,
2746
+ * "content": [
2747
+ * {
2748
+ * "type": "paragraph",
2749
+ * "content": [
2750
+ * {
2751
+ * "type": "text",
2752
+ * "text": "Lorem ipsum dolor sit amet, consectetur
2753
+ * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
2754
+ * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
2755
+ * semper."
2756
+ * }
2757
+ * ]
2758
+ * }
2759
+ * ]
2760
+ * },
2761
+ * "created": "2021-01-17T12:34:00.000+0000",
2762
+ * "id": "10000",
2763
+ * "self":
2764
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
2765
+ * "updateAuthor": {
2766
+ * "accountId": "5b10a2844c20165700ede21g",
2767
+ * "active": false,
2768
+ * "displayName": "Mia Krystof",
2769
+ * "self":
2770
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2771
+ * },
2772
+ * "updated": "2021-01-18T23:45:00.000+0000",
2773
+ * "visibility": {
2774
+ * "identifier": "Administrators",
2775
+ * "type": "role",
2776
+ * "value": "Administrators"
2777
+ * }
2778
+ * }
2779
+ * ],
2780
+ * "epic": {
2781
+ * "id": 37,
2782
+ * "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
2783
+ * "name": "epic 1",
2784
+ * "summary": "epic 1 summary",
2785
+ * "color": {
2786
+ * "key": "color_4"
2787
+ * },
2788
+ * "done": true
2789
+ * },
2790
+ * "worklog": [
2791
+ * {
2792
+ * "author": {
2793
+ * "accountId": "5b10a2844c20165700ede21g",
2794
+ * "active": false,
2795
+ * "displayName": "Mia Krystof",
2796
+ * "self":
2797
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2798
+ * },
2799
+ * "comment": {
2800
+ * "type": "doc",
2801
+ * "version": 1,
2802
+ * "content": [
2803
+ * {
2804
+ * "type": "paragraph",
2805
+ * "content": [
2806
+ * {
2807
+ * "type": "text",
2808
+ * "text": "I did some work here."
2809
+ * }
2810
+ * ]
2811
+ * }
2812
+ * ]
2813
+ * },
2814
+ * "id": "100028",
2815
+ * "issueId": "10002",
2816
+ * "self":
2817
+ * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
2818
+ * "started": "2021-01-17T12:34:00.000+0000",
2819
+ * "timeSpent": "3h 20m",
2820
+ * "timeSpentSeconds": 12000,
2821
+ * "updateAuthor": {
2822
+ * "accountId": "5b10a2844c20165700ede21g",
2823
+ * "active": false,
2824
+ * "displayName": "Mia Krystof",
2825
+ * "self":
2826
+ * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
2827
+ * },
2828
+ * "updated": "2021-01-18T23:45:00.000+0000",
2829
+ * "visibility": {
2830
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
2831
+ * "type": "group",
2832
+ * "value": "jira-developers"
2833
+ * }
2834
+ * }
2835
+ * ],
2836
+ * "updated": 1,
2837
+ * "timetracking": {
2838
+ * "originalEstimate": "10m",
2839
+ * "originalEstimateSeconds": 600,
2840
+ * "remainingEstimate": "3m",
2841
+ * "remainingEstimateSeconds": 200,
2842
+ * "timeSpent": "6m",
2843
+ * "timeSpentSeconds": 400
2844
+ * }
2845
+ * },
2846
+ * "id": "10001",
2847
+ * "key": "HSP-1",
2848
+ * "self":
2849
+ * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
2850
+ * }
2851
+ * ],
2852
+ * "maxResults": 50,
2853
+ * "startAt": 0,
2854
+ * "total": 1
2855
+ * }
2856
+ * @path {GET} /rest/agile/1.0/board/{boardId}/epic/none/issue
2857
+ */
2858
+ getIssuesWithoutEpicForBoard({
2859
+ boardId,
2860
+ startAt,
2861
+ maxResults,
2862
+ jql,
2863
+ validateQuery,
2864
+ fields,
2865
+ expand,
2866
+ }: {
2867
+ /** The ID of the board that contains the requested issues. */
2868
+ boardId: number;
2869
+ /**
2870
+ * The starting index of the returned issues. Base index: 0. See the 'Pagination'
2871
+ * section at the top of this page for more details.
2872
+ */
2873
+ startAt?: number;
2874
+ /**
2875
+ * The maximum number of issues to return per page. See the 'Pagination' section
2876
+ * at the top of this page for more details. Note, the total number of issues
2877
+ * returned is limited by the property 'jira.search.views.default.max' in your
2878
+ * Jira instance. If you exceed this limit, your results will be truncated.
2879
+ */
2880
+ maxResults?: number;
2881
+ /**
2882
+ * Filters results using a JQL query. If you define an order in your JQL query, it
2883
+ * will override the default order of the returned issues.
2884
+ * Note that `username` and `userkey` can't be used as search terms for this
2885
+ * parameter due to privacy reasons. Use `accountId` instead.
2886
+ */
2887
+ jql?: string;
2888
+ /** Specifies whether to validate the JQL query or not. Default: true. */
2889
+ validateQuery?: boolean;
2890
+ /**
2891
+ * The list of fields to return for each issue. By default, all navigable and
2892
+ * Agile fields are returned.
2893
+ */
2894
+ fields?: {}[];
2895
+ /** A comma-separated list of the parameters to expand. */
2896
+ expand?: string;
2897
+ }): Promise<unknown> {
2898
+ return this.getClientInstance()
2899
+ .request({
2900
+ path: "/rest/agile/1.0/board/{boardId}/epic/none/issue",
2901
+ method: "GET",
2902
+ pathParams: {
2903
+ boardId,
2904
+ },
2905
+ query: {
2906
+ startAt,
2907
+ maxResults,
2908
+ jql,
2909
+ validateQuery,
2910
+ fields,
2911
+ expand,
2912
+ },
2913
+ })
2914
+ .then(
2915
+ this.getClientInstance().responseHandler({
2916
+ 200: {
2917
+ "application/json": "json",
2918
+ },
2919
+ }),
2920
+ )
2921
+ .then(
2922
+ commonHttpClient.castResponse<{
2923
+ status: 200;
2924
+ mediaType: "application/json";
2925
+ body: unknown;
2926
+ }>(),
2927
+ )
2928
+ .then(
2929
+ validationSchemaStorage.validator(
2930
+ "BoardService.getIssuesWithoutEpicForBoard.response",
2931
+ ),
2932
+ )
2933
+ .then(commonHttpClient.getBody);
2934
+ }
2935
+ /**
2936
+ * Returns all projects that are associated with the board, for the given board
2937
+ * ID. If the user does not have permission to view the board, no projects will be
2938
+ * returned at all. Returned projects are ordered by the name.
2939
+ *
2940
+ * A project is associated with a board if the board filter contains reference the
2941
+ * project or there is an issue from the project that belongs to the board.
2942
+ *
2943
+ * The board filter contains reference the project only if JQL query guarantees
2944
+ * that returned issues will be returned from the project set defined in JQL. For
2945
+ * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
2946
+ * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
2947
+ * doesn't have reference to any project.
2948
+ *
2949
+ * An issue belongs to the board if its status is mapped to the board's column.
2950
+ * Epic issues do not belongs to the scrum boards.
2951
+ *
2952
+ * @returns Returns the board's projects, at the specified page of the results.
2953
+ *
2954
+ * example: {
2955
+ * "isLast": true,
2956
+ * "maxResults": 10,
2957
+ * "startAt": 0,
2958
+ * "total": 2,
2959
+ * "values": [
2960
+ * {
2961
+ * "avatarUrls": {
2962
+ * "16x16": "secure/projectavatar?size=xsmall&pid=10000",
2963
+ * "24x24": "secure/projectavatar?size=small&pid=10000",
2964
+ * "32x32": "secure/projectavatar?size=medium&pid=10000",
2965
+ * "48x48": "secure/projectavatar?size=large&pid=10000"
2966
+ * },
2967
+ * "id": "10000",
2968
+ * "key": "EX",
2969
+ * "name": "Example",
2970
+ * "projectCategory": {
2971
+ * "description": "Project category description",
2972
+ * "id": "10000",
2973
+ * "name": "A project category"
2974
+ * },
2975
+ * "projectTypeKey": "ProjectTypeKey{key='software'}",
2976
+ * "self": "project/EX",
2977
+ * "simplified": false
2978
+ * }
2979
+ * ]
2980
+ * }
2981
+ * @path {GET} /rest/agile/1.0/board/{boardId}/project
2982
+ */
2983
+ getProjects({
2984
+ boardId,
2985
+ startAt,
2986
+ maxResults,
2987
+ }: {
2988
+ /** The ID of the board that contains returned projects. */
2989
+ boardId: number;
2990
+ /**
2991
+ * The starting index of the returned projects. Base index: 0. See the
2992
+ * 'Pagination' section at the top of this page for more details.
2993
+ */
2994
+ startAt?: number;
2995
+ /**
2996
+ * The maximum number of projects to return per page. See the 'Pagination' section
2997
+ * at the top of this page for more details.
2998
+ */
2999
+ maxResults?: number;
3000
+ }): Promise<unknown> {
3001
+ return this.getClientInstance()
3002
+ .request({
3003
+ path: "/rest/agile/1.0/board/{boardId}/project",
3004
+ method: "GET",
3005
+ pathParams: {
3006
+ boardId,
3007
+ },
3008
+ query: {
3009
+ startAt,
3010
+ maxResults,
3011
+ },
3012
+ })
3013
+ .then(
3014
+ this.getClientInstance().responseHandler({
3015
+ 200: {
3016
+ "application/json": "json",
3017
+ },
3018
+ }),
3019
+ )
3020
+ .then(
3021
+ commonHttpClient.castResponse<{
3022
+ status: 200;
3023
+ mediaType: "application/json";
3024
+ body: unknown;
3025
+ }>(),
3026
+ )
3027
+ .then(
3028
+ validationSchemaStorage.validator("BoardService.getProjects.response"),
3029
+ )
3030
+ .then(commonHttpClient.getBody);
3031
+ }
3032
+ /**
3033
+ * Returns all projects that are statically associated with the board, for the
3034
+ * given board ID. Returned projects are ordered by the name.
3035
+ *
3036
+ * A project is associated with a board if the board filter contains reference the
3037
+ * project.
3038
+ *
3039
+ * The board filter contains reference the project only if JQL query guarantees
3040
+ * that returned issues will be returned from the project set defined in JQL. For
3041
+ * instance the query `project in (ABC, BCD) AND reporter = admin` have reference
3042
+ * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
3043
+ * doesn't have reference to any project.
3044
+ *
3045
+ * @path {GET} /rest/agile/1.0/board/{boardId}/project/full
3046
+ */
3047
+ getProjectsFull({
3048
+ boardId,
3049
+ }: {
3050
+ /** The ID of the board that contains returned projects. */
3051
+ boardId: number;
3052
+ }): Promise<void> {
3053
+ return this.getClientInstance()
3054
+ .request({
3055
+ path: "/rest/agile/1.0/board/{boardId}/project/full",
3056
+ method: "GET",
3057
+ pathParams: {
3058
+ boardId,
3059
+ },
3060
+ })
3061
+ .then(commonHttpClient.discardResult);
3062
+ }
3063
+ /**
3064
+ * Returns the quick filter for a given quick filter ID. The quick filter will
3065
+ * only be returned if the user can view the board that the quick filter belongs
3066
+ * to.
3067
+ *
3068
+ * @returns Returns the requested quick filter.
3069
+ *
3070
+ * example: {
3071
+ * "boardId": 1,
3072
+ * "description": "Issues of type bug",
3073
+ * "id": 1,
3074
+ * "jql": "issueType = bug",
3075
+ * "name": "Bugs",
3076
+ * "position": 0
3077
+ * }
3078
+ * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
3079
+ */
3080
+ getQuickFilter({
3081
+ boardId,
3082
+ quickFilterId,
3083
+ }: {
3084
+ boardId: number;
3085
+ /** The ID of the requested quick filter. */
3086
+ quickFilterId: number;
3087
+ }): Promise<{
3088
+ boardId?: number;
3089
+ description?: string;
3090
+ id?: number;
3091
+ jql?: string;
3092
+ name?: string;
3093
+ position?: number;
3094
+ }> {
3095
+ return this.getClientInstance()
3096
+ .request({
3097
+ path: "/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}",
3098
+ method: "GET",
3099
+ pathParams: {
3100
+ boardId,
3101
+ quickFilterId,
3102
+ },
3103
+ })
3104
+ .then(
3105
+ this.getClientInstance().responseHandler({
3106
+ 200: {
3107
+ "application/json": "json",
3108
+ },
3109
+ }),
3110
+ )
3111
+ .then(
3112
+ commonHttpClient.castResponse<{
3113
+ status: 200;
3114
+ mediaType: "application/json";
3115
+ body: {
3116
+ boardId?: number;
3117
+ description?: string;
3118
+ id?: number;
3119
+ jql?: string;
3120
+ name?: string;
3121
+ position?: number;
3122
+ };
3123
+ }>(),
3124
+ )
3125
+ .then(
3126
+ validationSchemaStorage.validator(
3127
+ "BoardService.getQuickFilter.response",
3128
+ ),
3129
+ )
3130
+ .then(commonHttpClient.getBody);
3131
+ }
3132
+ /**
3133
+ * @returns 200 response
3134
+ * @path {GET} /rest/agile/1.0/board/{boardId}/reports
3135
+ */
3136
+ getReportsForBoard({ boardId }: { boardId: number }): Promise<{
3137
+ reports?: {}[];
3138
+ }> {
3139
+ return this.getClientInstance()
3140
+ .request({
3141
+ path: "/rest/agile/1.0/board/{boardId}/reports",
3142
+ method: "GET",
3143
+ pathParams: {
3144
+ boardId,
3145
+ },
3146
+ })
3147
+ .then(
3148
+ this.getClientInstance().responseHandler({
3149
+ 200: {
3150
+ "application/json": "json",
3151
+ },
3152
+ }),
3153
+ )
3154
+ .then(
3155
+ commonHttpClient.castResponse<{
3156
+ status: 200;
3157
+ mediaType: "application/json";
3158
+ body: {
3159
+ reports?: {}[];
3160
+ };
3161
+ }>(),
3162
+ )
3163
+ .then(
3164
+ validationSchemaStorage.validator(
3165
+ "BoardService.getReportsForBoard.response",
3166
+ ),
3167
+ )
3168
+ .then(commonHttpClient.getBody);
3169
+ }
3170
+ /**
3171
+ * Move issues from the backog to the board (if they are already in the backlog of
3172
+ * that board).
3173
+ * This operation either moves an issue(s) onto a board from the backlog (by
3174
+ * adding it to the issueList for the board) Or transitions the issue(s) to the
3175
+ * first column for a kanban board with backlog. At most 50 issues may be moved at
3176
+ * once.
3177
+ *
3178
+ * @returns Returns the list of issue with status of rank operation.
3179
+ *
3180
+ * example: {
3181
+ * "entries": [
3182
+ * {
3183
+ * "issueId": 10000,
3184
+ * "issueKey": "PR-1",
3185
+ * "status": 200
3186
+ * },
3187
+ * {
3188
+ * "issueId": 10001,
3189
+ * "issueKey": "PR-2",
3190
+ * "status": 200
3191
+ * },
3192
+ * {
3193
+ * "errors": [
3194
+ * "JIRA Agile cannot execute the rank operation at this time. Please try
3195
+ * again later."
3196
+ * ],
3197
+ * "issueId": 10002,
3198
+ * "issueKey": "PR-3",
3199
+ * "status": 503
3200
+ * }
3201
+ * ]
3202
+ * }
3203
+ * @path {POST} /rest/agile/1.0/board/{boardId}/issue
3204
+ */
3205
+ moveIssuesToBoard({
3206
+ boardId,
3207
+ requestBody,
3208
+ }: {
3209
+ boardId: number;
3210
+ /**
3211
+ * @example {
3212
+ * "issues": [
3213
+ * "PR-1",
3214
+ * "10001",
3215
+ * "PR-3"
3216
+ * ],
3217
+ * "rankBeforeIssue": "PR-4",
3218
+ * "rankCustomFieldId": 10521
3219
+ * }
3220
+ */
3221
+ requestBody: {
3222
+ issues?: string[];
3223
+ rankAfterIssue?: string;
3224
+ rankBeforeIssue?: string;
3225
+ rankCustomFieldId?: number;
3226
+ };
3227
+ }): Promise<{
3228
+ entries?: {
3229
+ errors?: string[];
3230
+ issueId?: number;
3231
+ issueKey?: string;
3232
+ status?: number;
3233
+ }[];
3234
+ }> {
3235
+ return this.getClientInstance()
3236
+ .request({
3237
+ path: "/rest/agile/1.0/board/{boardId}/issue",
3238
+ method: "POST",
3239
+ pathParams: {
3240
+ boardId,
3241
+ },
3242
+ headers: {
3243
+ "Content-Type": "application/json",
3244
+ },
3245
+ body: requestBody,
3246
+ })
3247
+ .then(
3248
+ this.getClientInstance().responseHandler({
3249
+ 204: {},
3250
+ 207: {
3251
+ "application/json": "json",
3252
+ },
3253
+ }),
3254
+ )
3255
+ .then(
3256
+ commonHttpClient.castResponse<{
3257
+ status: 207;
3258
+ mediaType: "application/json";
3259
+ body: {
3260
+ entries?: {
3261
+ errors?: string[];
3262
+ issueId?: number;
3263
+ issueKey?: string;
3264
+ status?: number;
3265
+ }[];
3266
+ };
3267
+ }>(),
3268
+ )
3269
+ .then(
3270
+ validationSchemaStorage.validator(
3271
+ "BoardService.moveIssuesToBoard.response",
3272
+ ),
3273
+ )
3274
+ .then(commonHttpClient.getBody);
3275
+ }
3276
+ /**
3277
+ * Sets the value of the specified board's property.
3278
+ *
3279
+ * You can use this resource to store a custom data against the board identified
3280
+ * by the id. The user who stores the data is required to have permissions to
3281
+ * modify the board.
3282
+ *
3283
+ * @returns * status: 200, mediaType: application/json
3284
+ *
3285
+ * Returned if the board property is successfully updated.
3286
+ *
3287
+ * * status: 201, mediaType: application/json
3288
+ *
3289
+ * Returned if the board property is successfully created.
3290
+ * @path {PUT} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
3291
+ */
3292
+ setBoardProperty({
3293
+ boardId,
3294
+ propertyKey,
3295
+ requestBody,
3296
+ }: {
3297
+ /** the ID of the board on which the property will be set. */
3298
+ boardId: string;
3299
+ /** the key of the board's property. The maximum length of the key is 255 bytes. */
3300
+ propertyKey: string;
3301
+ /**
3302
+ * The value of the property. The value has to be a valid, non-empty
3303
+ * [JSON](https://tools.ietf.org/html/rfc4627) value. The maximum length of the
3304
+ * property value is 32768 bytes.
3305
+ */
3306
+ requestBody: unknown;
3307
+ }): Promise<{
3308
+ created: boolean;
3309
+ body: unknown;
3310
+ }> {
3311
+ return this.getClientInstance()
3312
+ .request({
3313
+ path: "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}",
3314
+ method: "PUT",
3315
+ pathParams: {
3316
+ boardId,
3317
+ propertyKey,
3318
+ },
3319
+ headers: {
3320
+ "Content-Type": "application/json",
3321
+ },
3322
+ body: requestBody,
3323
+ })
3324
+ .then(
3325
+ this.getClientInstance().responseHandler({
3326
+ 200: {
3327
+ "application/json": "json",
3328
+ },
3329
+ 201: {
3330
+ "application/json": "json",
3331
+ },
3332
+ }),
3333
+ )
3334
+ .then(
3335
+ commonHttpClient.castResponse<{
3336
+ status: 200 | 201;
3337
+ mediaType: "application/json";
3338
+ body: unknown;
3339
+ }>(),
3340
+ )
3341
+ .then(
3342
+ validationSchemaStorage.validator(
3343
+ "BoardService.setBoardProperty.response",
3344
+ ),
3345
+ )
3346
+ .then(commonHttpClient.asCreatedResponse("body"));
3347
+ }
3348
+ /**
3349
+ * @returns 200 response
3350
+ * @path {PUT} /rest/agile/1.0/board/{boardId}/features
3351
+ */
3352
+ toggleFeatures({
3353
+ boardId,
3354
+ requestBody,
3355
+ }: {
3356
+ boardId: number;
3357
+ requestBody: {
3358
+ boardId?: number;
3359
+ enabling?: boolean;
3360
+ feature?: string;
3361
+ };
3362
+ }): Promise<{
3363
+ features?: {
3364
+ boardFeature?:
3365
+ | "SIMPLE_ROADMAP"
3366
+ | "BACKLOG"
3367
+ | "SPRINTS"
3368
+ | "CALENDAR"
3369
+ | "DEVTOOLS"
3370
+ | "REPORTS"
3371
+ | "ESTIMATION"
3372
+ | "PAGES"
3373
+ | "CODE"
3374
+ | "SECURITY"
3375
+ | "REQUESTS"
3376
+ | "INCIDENTS"
3377
+ | "RELEASES"
3378
+ | "DEPLOYMENTS"
3379
+ | "ISSUE_NAVIGATOR"
3380
+ | "ON_CALL_SCHEDULE"
3381
+ | "BOARD"
3382
+ | "GOALS"
3383
+ | "LIST_VIEW";
3384
+ boardId?: number;
3385
+ featureId?: string;
3386
+ featureType?: "BASIC" | "ESTIMATION";
3387
+ imageUri?: string;
3388
+ learnMoreArticleId?: string;
3389
+ learnMoreLink?: string;
3390
+ localisedDescription?: string;
3391
+ localisedGroup?: string;
3392
+ localisedName?: string;
3393
+ permissibleEstimationTypes?: {
3394
+ localisedDescription?: string;
3395
+ localisedName?: string;
3396
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
3397
+ }[];
3398
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
3399
+ toggleLocked?: boolean;
3400
+ }[];
3401
+ }> {
3402
+ return this.getClientInstance()
3403
+ .request({
3404
+ path: "/rest/agile/1.0/board/{boardId}/features",
3405
+ method: "PUT",
3406
+ pathParams: {
3407
+ boardId,
3408
+ },
3409
+ headers: {
3410
+ "Content-Type": "application/json",
3411
+ },
3412
+ body: requestBody,
3413
+ })
3414
+ .then(
3415
+ this.getClientInstance().responseHandler({
3416
+ 200: {
3417
+ "application/json": "json",
3418
+ },
3419
+ }),
3420
+ )
3421
+ .then(
3422
+ commonHttpClient.castResponse<{
3423
+ status: 200;
3424
+ mediaType: "application/json";
3425
+ body: {
3426
+ features?: {
3427
+ boardFeature?:
3428
+ | "SIMPLE_ROADMAP"
3429
+ | "BACKLOG"
3430
+ | "SPRINTS"
3431
+ | "CALENDAR"
3432
+ | "DEVTOOLS"
3433
+ | "REPORTS"
3434
+ | "ESTIMATION"
3435
+ | "PAGES"
3436
+ | "CODE"
3437
+ | "SECURITY"
3438
+ | "REQUESTS"
3439
+ | "INCIDENTS"
3440
+ | "RELEASES"
3441
+ | "DEPLOYMENTS"
3442
+ | "ISSUE_NAVIGATOR"
3443
+ | "ON_CALL_SCHEDULE"
3444
+ | "BOARD"
3445
+ | "GOALS"
3446
+ | "LIST_VIEW";
3447
+ boardId?: number;
3448
+ featureId?: string;
3449
+ featureType?: "BASIC" | "ESTIMATION";
3450
+ imageUri?: string;
3451
+ learnMoreArticleId?: string;
3452
+ learnMoreLink?: string;
3453
+ localisedDescription?: string;
3454
+ localisedGroup?: string;
3455
+ localisedName?: string;
3456
+ permissibleEstimationTypes?: {
3457
+ localisedDescription?: string;
3458
+ localisedName?: string;
3459
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
3460
+ }[];
3461
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
3462
+ toggleLocked?: boolean;
3463
+ }[];
3464
+ };
3465
+ }>(),
3466
+ )
3467
+ .then(
3468
+ validationSchemaStorage.validator(
3469
+ "BoardService.toggleFeatures.response",
3470
+ ),
3471
+ )
3472
+ .then(commonHttpClient.getBody);
3473
+ }
3474
+ static initialize() {
3475
+ validationSchemaStorage.registerExtensible(
3476
+ "BoardService.getAllBoards.response",
3477
+ z
3478
+ .object({
3479
+ status: z.literal(200),
3480
+ mediaType: z.literal("application/json"),
3481
+ body: z
3482
+ .object({
3483
+ isLast: z.boolean().optional(),
3484
+ maxResults: z.number().int().optional(),
3485
+ startAt: z.number().int().optional(),
3486
+ total: z.number().int().optional(),
3487
+ values: z
3488
+ .array(
3489
+ z
3490
+ .object({
3491
+ admins: z
3492
+ .object({
3493
+ groups: z
3494
+ .array(
3495
+ z
3496
+ .object({
3497
+ name: z.string().optional(),
3498
+ self: z.string().optional(),
3499
+ })
3500
+ .strict(),
3501
+ )
3502
+ .optional(),
3503
+ users: z
3504
+ .array(
3505
+ z
3506
+ .object({
3507
+ accountId: z.string().max(128).optional(),
3508
+ active: z.boolean().optional(),
3509
+ avatarUrls: z
3510
+ .object({
3511
+ "16x16": z.string().optional(),
3512
+ "24x24": z.string().optional(),
3513
+ "32x32": z.string().optional(),
3514
+ "48x48": z.string().optional(),
3515
+ })
3516
+ .strict()
3517
+ .optional(),
3518
+ displayName: z.string().optional(),
3519
+ key: z.string().optional(),
3520
+ name: z.string().optional(),
3521
+ self: z.string().optional(),
3522
+ })
3523
+ .strict(),
3524
+ )
3525
+ .optional(),
3526
+ })
3527
+ .strict()
3528
+ .optional(),
3529
+ canEdit: z.boolean().optional(),
3530
+ favourite: z.boolean().optional(),
3531
+ id: z.number().int().optional(),
3532
+ isPrivate: z.boolean().optional(),
3533
+ location: z
3534
+ .object({
3535
+ avatarURI: z.string().optional(),
3536
+ displayName: z.string().optional(),
3537
+ name: z.string().optional(),
3538
+ projectId: z.number().int().optional(),
3539
+ projectKey: z.string().optional(),
3540
+ projectName: z.string().optional(),
3541
+ projectTypeKey: z.string().optional(),
3542
+ userAccountId: z.string().optional(),
3543
+ userId: z.number().int().optional(),
3544
+ })
3545
+ .strict()
3546
+ .optional(),
3547
+ name: z.string().optional(),
3548
+ self: z.string().optional(),
3549
+ type: z.string().optional(),
3550
+ })
3551
+ .strict(),
3552
+ )
3553
+ .optional(),
3554
+ })
3555
+ .strict(),
3556
+ })
3557
+ .describe("BoardService.getAllBoards.response"),
3558
+ );
3559
+ validationSchemaStorage.registerExtensible(
3560
+ "BoardService.createBoard.response",
3561
+ z
3562
+ .object({
3563
+ status: z.literal(201),
3564
+ mediaType: z.literal("application/json"),
3565
+ body: z
3566
+ .object({
3567
+ admins: z
3568
+ .object({
3569
+ groups: z
3570
+ .array(
3571
+ z
3572
+ .object({
3573
+ name: z.string().optional(),
3574
+ self: z.string().optional(),
3575
+ })
3576
+ .strict(),
3577
+ )
3578
+ .optional(),
3579
+ users: z
3580
+ .array(
3581
+ z
3582
+ .object({
3583
+ accountId: z.string().max(128).optional(),
3584
+ active: z.boolean().optional(),
3585
+ avatarUrls: z
3586
+ .object({
3587
+ "16x16": z.string().optional(),
3588
+ "24x24": z.string().optional(),
3589
+ "32x32": z.string().optional(),
3590
+ "48x48": z.string().optional(),
3591
+ })
3592
+ .strict()
3593
+ .optional(),
3594
+ displayName: z.string().optional(),
3595
+ key: z.string().optional(),
3596
+ name: z.string().optional(),
3597
+ self: z.string().optional(),
3598
+ })
3599
+ .strict(),
3600
+ )
3601
+ .optional(),
3602
+ })
3603
+ .strict()
3604
+ .optional(),
3605
+ canEdit: z.boolean().optional(),
3606
+ favourite: z.boolean().optional(),
3607
+ id: z.number().int().optional(),
3608
+ isPrivate: z.boolean().optional(),
3609
+ location: z
3610
+ .object({
3611
+ avatarURI: z.string().optional(),
3612
+ displayName: z.string().optional(),
3613
+ name: z.string().optional(),
3614
+ projectId: z.number().int().optional(),
3615
+ projectKey: z.string().optional(),
3616
+ projectName: z.string().optional(),
3617
+ projectTypeKey: z.string().optional(),
3618
+ userAccountId: z.string().optional(),
3619
+ userId: z.number().int().optional(),
3620
+ })
3621
+ .strict()
3622
+ .optional(),
3623
+ name: z.string().optional(),
3624
+ self: z.string().optional(),
3625
+ type: z.string().optional(),
3626
+ })
3627
+ .strict(),
3628
+ })
3629
+ .describe("BoardService.createBoard.response"),
3630
+ );
3631
+ validationSchemaStorage.registerExtensible(
3632
+ "BoardService.getBoard.response",
3633
+ z
3634
+ .object({
3635
+ status: z.literal(200),
3636
+ mediaType: z.literal("application/json"),
3637
+ body: z
3638
+ .object({
3639
+ admins: z
3640
+ .object({
3641
+ groups: z
3642
+ .array(
3643
+ z
3644
+ .object({
3645
+ name: z.string().optional(),
3646
+ self: z.string().optional(),
3647
+ })
3648
+ .strict(),
3649
+ )
3650
+ .optional(),
3651
+ users: z
3652
+ .array(
3653
+ z
3654
+ .object({
3655
+ accountId: z.string().max(128).optional(),
3656
+ active: z.boolean().optional(),
3657
+ avatarUrls: z
3658
+ .object({
3659
+ "16x16": z.string().optional(),
3660
+ "24x24": z.string().optional(),
3661
+ "32x32": z.string().optional(),
3662
+ "48x48": z.string().optional(),
3663
+ })
3664
+ .strict()
3665
+ .optional(),
3666
+ displayName: z.string().optional(),
3667
+ key: z.string().optional(),
3668
+ name: z.string().optional(),
3669
+ self: z.string().optional(),
3670
+ })
3671
+ .strict(),
3672
+ )
3673
+ .optional(),
3674
+ })
3675
+ .strict()
3676
+ .optional(),
3677
+ canEdit: z.boolean().optional(),
3678
+ favourite: z.boolean().optional(),
3679
+ id: z.number().int().optional(),
3680
+ isPrivate: z.boolean().optional(),
3681
+ location: z
3682
+ .object({
3683
+ avatarURI: z.string().optional(),
3684
+ displayName: z.string().optional(),
3685
+ name: z.string().optional(),
3686
+ projectId: z.number().int().optional(),
3687
+ projectKey: z.string().optional(),
3688
+ projectName: z.string().optional(),
3689
+ projectTypeKey: z.string().optional(),
3690
+ userAccountId: z.string().optional(),
3691
+ userId: z.number().int().optional(),
3692
+ })
3693
+ .strict()
3694
+ .optional(),
3695
+ name: z.string().optional(),
3696
+ self: z.string().optional(),
3697
+ type: z.string().optional(),
3698
+ })
3699
+ .strict(),
3700
+ })
3701
+ .describe("BoardService.getBoard.response"),
3702
+ );
3703
+ validationSchemaStorage.registerExtensible(
3704
+ "BoardService.getIssuesForBacklog.response",
3705
+ z
3706
+ .object({
3707
+ status: z.literal(200),
3708
+ mediaType: z.literal("application/json"),
3709
+ body: validationSchemaStorage.lazy("SearchResults"),
3710
+ })
3711
+ .describe("BoardService.getIssuesForBacklog.response"),
3712
+ );
3713
+ validationSchemaStorage.registerExtensible(
3714
+ "BoardService.getConfiguration.response",
3715
+ z
3716
+ .object({
3717
+ status: z.literal(200),
3718
+ mediaType: z.literal("application/json"),
3719
+ body: z
3720
+ .object({
3721
+ columnConfig: z
3722
+ .object({
3723
+ columns: z
3724
+ .array(
3725
+ z
3726
+ .object({
3727
+ max: z.number().int().optional(),
3728
+ min: z.number().int().optional(),
3729
+ name: z.string().optional(),
3730
+ statuses: z
3731
+ .array(
3732
+ z
3733
+ .object({
3734
+ id: z.string().optional(),
3735
+ self: z.string().optional(),
3736
+ })
3737
+ .strict(),
3738
+ )
3739
+ .optional(),
3740
+ })
3741
+ .strict(),
3742
+ )
3743
+ .optional(),
3744
+ constraintType: z.string().optional(),
3745
+ })
3746
+ .strict()
3747
+ .optional(),
3748
+ estimation: z
3749
+ .object({
3750
+ field: z
3751
+ .object({
3752
+ displayName: z.string().optional(),
3753
+ fieldId: z.string().optional(),
3754
+ })
3755
+ .strict()
3756
+ .optional(),
3757
+ type: z.string().optional(),
3758
+ })
3759
+ .strict()
3760
+ .optional(),
3761
+ filter: z
3762
+ .object({
3763
+ id: z.string().optional(),
3764
+ self: z.string().optional(),
3765
+ })
3766
+ .strict()
3767
+ .optional(),
3768
+ id: z.number().int().optional(),
3769
+ location: z
3770
+ .object({
3771
+ projectKeyOrId: z.string().optional(),
3772
+ type: z.enum(["project", "user"]).optional(),
3773
+ })
3774
+ .strict()
3775
+ .optional(),
3776
+ name: z.string().optional(),
3777
+ ranking: z
3778
+ .object({
3779
+ rankCustomFieldId: z.number().int().optional(),
3780
+ })
3781
+ .strict()
3782
+ .optional(),
3783
+ self: z.string().optional(),
3784
+ subQuery: z
3785
+ .object({
3786
+ query: z.string().optional(),
3787
+ })
3788
+ .strict()
3789
+ .optional(),
3790
+ type: z.string().optional(),
3791
+ })
3792
+ .strict(),
3793
+ })
3794
+ .describe("BoardService.getConfiguration.response"),
3795
+ );
3796
+ validationSchemaStorage.registerExtensible(
3797
+ "BoardService.getEpics.response",
3798
+ z
3799
+ .object({
3800
+ status: z.literal(200),
3801
+ mediaType: z.literal("application/json"),
3802
+ body: z.unknown(),
3803
+ })
3804
+ .describe("BoardService.getEpics.response"),
3805
+ );
3806
+ validationSchemaStorage.registerExtensible(
3807
+ "BoardService.getBoardIssuesForEpic.response",
3808
+ z
3809
+ .object({
3810
+ status: z.literal(200),
3811
+ mediaType: z.literal("application/json"),
3812
+ body: z.unknown(),
3813
+ })
3814
+ .describe("BoardService.getBoardIssuesForEpic.response"),
3815
+ );
3816
+ validationSchemaStorage.registerExtensible(
3817
+ "BoardService.getIssuesWithoutEpicForBoard.response",
3818
+ z
3819
+ .object({
3820
+ status: z.literal(200),
3821
+ mediaType: z.literal("application/json"),
3822
+ body: z.unknown(),
3823
+ })
3824
+ .describe("BoardService.getIssuesWithoutEpicForBoard.response"),
3825
+ );
3826
+ validationSchemaStorage.registerExtensible(
3827
+ "BoardService.getFeaturesForBoard.response",
3828
+ z
3829
+ .object({
3830
+ status: z.literal(200),
3831
+ mediaType: z.literal("application/json"),
3832
+ body: z
3833
+ .object({
3834
+ features: z
3835
+ .array(
3836
+ z
3837
+ .object({
3838
+ boardFeature: z
3839
+ .enum([
3840
+ "SIMPLE_ROADMAP",
3841
+ "BACKLOG",
3842
+ "SPRINTS",
3843
+ "CALENDAR",
3844
+ "DEVTOOLS",
3845
+ "REPORTS",
3846
+ "ESTIMATION",
3847
+ "PAGES",
3848
+ "CODE",
3849
+ "SECURITY",
3850
+ "REQUESTS",
3851
+ "INCIDENTS",
3852
+ "RELEASES",
3853
+ "DEPLOYMENTS",
3854
+ "ISSUE_NAVIGATOR",
3855
+ "ON_CALL_SCHEDULE",
3856
+ "BOARD",
3857
+ "GOALS",
3858
+ "LIST_VIEW",
3859
+ ])
3860
+ .optional(),
3861
+ boardId: z.number().int().optional(),
3862
+ featureId: z.string().optional(),
3863
+ featureType: z.enum(["BASIC", "ESTIMATION"]).optional(),
3864
+ imageUri: z.string().optional(),
3865
+ learnMoreArticleId: z.string().optional(),
3866
+ learnMoreLink: z.string().optional(),
3867
+ localisedDescription: z.string().optional(),
3868
+ localisedGroup: z.string().optional(),
3869
+ localisedName: z.string().optional(),
3870
+ permissibleEstimationTypes: z
3871
+ .array(
3872
+ z
3873
+ .object({
3874
+ localisedDescription: z.string().optional(),
3875
+ localisedName: z.string().optional(),
3876
+ value: z
3877
+ .enum(["STORY_POINTS", "ORIGINAL_ESTIMATE"])
3878
+ .optional(),
3879
+ })
3880
+ .strict(),
3881
+ )
3882
+ .optional(),
3883
+ state: z
3884
+ .enum(["ENABLED", "DISABLED", "COMING_SOON"])
3885
+ .optional(),
3886
+ toggleLocked: z.boolean().optional(),
3887
+ })
3888
+ .strict(),
3889
+ )
3890
+ .optional(),
3891
+ })
3892
+ .strict(),
3893
+ })
3894
+ .describe("BoardService.getFeaturesForBoard.response"),
3895
+ );
3896
+ validationSchemaStorage.registerExtensible(
3897
+ "BoardService.toggleFeatures.response",
3898
+ z
3899
+ .object({
3900
+ status: z.literal(200),
3901
+ mediaType: z.literal("application/json"),
3902
+ body: z
3903
+ .object({
3904
+ features: z
3905
+ .array(
3906
+ z
3907
+ .object({
3908
+ boardFeature: z
3909
+ .enum([
3910
+ "SIMPLE_ROADMAP",
3911
+ "BACKLOG",
3912
+ "SPRINTS",
3913
+ "CALENDAR",
3914
+ "DEVTOOLS",
3915
+ "REPORTS",
3916
+ "ESTIMATION",
3917
+ "PAGES",
3918
+ "CODE",
3919
+ "SECURITY",
3920
+ "REQUESTS",
3921
+ "INCIDENTS",
3922
+ "RELEASES",
3923
+ "DEPLOYMENTS",
3924
+ "ISSUE_NAVIGATOR",
3925
+ "ON_CALL_SCHEDULE",
3926
+ "BOARD",
3927
+ "GOALS",
3928
+ "LIST_VIEW",
3929
+ ])
3930
+ .optional(),
3931
+ boardId: z.number().int().optional(),
3932
+ featureId: z.string().optional(),
3933
+ featureType: z.enum(["BASIC", "ESTIMATION"]).optional(),
3934
+ imageUri: z.string().optional(),
3935
+ learnMoreArticleId: z.string().optional(),
3936
+ learnMoreLink: z.string().optional(),
3937
+ localisedDescription: z.string().optional(),
3938
+ localisedGroup: z.string().optional(),
3939
+ localisedName: z.string().optional(),
3940
+ permissibleEstimationTypes: z
3941
+ .array(
3942
+ z
3943
+ .object({
3944
+ localisedDescription: z.string().optional(),
3945
+ localisedName: z.string().optional(),
3946
+ value: z
3947
+ .enum(["STORY_POINTS", "ORIGINAL_ESTIMATE"])
3948
+ .optional(),
3949
+ })
3950
+ .strict(),
3951
+ )
3952
+ .optional(),
3953
+ state: z
3954
+ .enum(["ENABLED", "DISABLED", "COMING_SOON"])
3955
+ .optional(),
3956
+ toggleLocked: z.boolean().optional(),
3957
+ })
3958
+ .strict(),
3959
+ )
3960
+ .optional(),
3961
+ })
3962
+ .strict(),
3963
+ })
3964
+ .describe("BoardService.toggleFeatures.response"),
3965
+ );
3966
+ validationSchemaStorage.registerExtensible(
3967
+ "BoardService.getIssuesForBoard.response",
3968
+ z
3969
+ .object({
3970
+ status: z.literal(200),
3971
+ mediaType: z.literal("application/json"),
3972
+ body: validationSchemaStorage.lazy("SearchResults"),
3973
+ })
3974
+ .describe("BoardService.getIssuesForBoard.response"),
3975
+ );
3976
+ validationSchemaStorage.registerExtensible(
3977
+ "BoardService.moveIssuesToBoard.response",
3978
+ z
3979
+ .object({
3980
+ status: z.number(),
3981
+ mediaType: z.string(),
3982
+ body: z.unknown(),
3983
+ })
3984
+ .superRefine(({ status: status, body: body }, ctx) => {
3985
+ if (status === 204) {
3986
+ return;
3987
+ } else if (status === 207) {
3988
+ z.object({
3989
+ entries: z
3990
+ .array(
3991
+ z
3992
+ .object({
3993
+ errors: z.array(z.string()).optional(),
3994
+ issueId: z.number().int().optional(),
3995
+ issueKey: z.string().optional(),
3996
+ status: z.number().int().optional(),
3997
+ })
3998
+ .strict(),
3999
+ )
4000
+ .optional(),
4001
+ })
4002
+ .strict()
4003
+ .parse(body);
4004
+ } else {
4005
+ ctx.addIssue({
4006
+ code: z.ZodIssueCode.custom,
4007
+ path: ["status"],
4008
+ message: `Unexpected status code: ${status}`,
4009
+ });
4010
+ }
4011
+ })
4012
+ .describe("BoardService.moveIssuesToBoard.response"),
4013
+ );
4014
+ validationSchemaStorage.registerExtensible(
4015
+ "BoardService.getProjects.response",
4016
+ z
4017
+ .object({
4018
+ status: z.literal(200),
4019
+ mediaType: z.literal("application/json"),
4020
+ body: z.unknown(),
4021
+ })
4022
+ .describe("BoardService.getProjects.response"),
4023
+ );
4024
+ validationSchemaStorage.registerExtensible(
4025
+ "BoardService.getBoardPropertyKeys.response",
4026
+ z
4027
+ .object({
4028
+ status: z.literal(200),
4029
+ mediaType: z.literal("application/json"),
4030
+ body: z.unknown(),
4031
+ })
4032
+ .describe("BoardService.getBoardPropertyKeys.response"),
4033
+ );
4034
+ validationSchemaStorage.registerExtensible(
4035
+ "BoardService.getBoardProperty.response",
4036
+ z
4037
+ .object({
4038
+ status: z.literal(200),
4039
+ mediaType: z.literal("application/json"),
4040
+ body: z.unknown(),
4041
+ })
4042
+ .describe("BoardService.getBoardProperty.response"),
4043
+ );
4044
+ validationSchemaStorage.registerExtensible(
4045
+ "BoardService.setBoardProperty.response",
4046
+ z
4047
+ .object({
4048
+ status: z.number(),
4049
+ mediaType: z.string(),
4050
+ body: z.unknown(),
4051
+ })
4052
+ .superRefine(({ status: status, body: body }, ctx) => {
4053
+ if (status === 200 || status === 201) {
4054
+ z.unknown().parse(body);
4055
+ } else {
4056
+ ctx.addIssue({
4057
+ code: z.ZodIssueCode.custom,
4058
+ path: ["status"],
4059
+ message: `Unexpected status code: ${status}`,
4060
+ });
4061
+ }
4062
+ })
4063
+ .describe("BoardService.setBoardProperty.response"),
4064
+ );
4065
+ validationSchemaStorage.registerExtensible(
4066
+ "BoardService.getAllQuickFilters.response",
4067
+ z
4068
+ .object({
4069
+ status: z.literal(200),
4070
+ mediaType: z.literal("application/json"),
4071
+ body: z
4072
+ .object({
4073
+ isLast: z.boolean().optional(),
4074
+ maxResults: z.number().int().optional(),
4075
+ startAt: z.number().int().optional(),
4076
+ total: z.number().int().optional(),
4077
+ values: z
4078
+ .array(
4079
+ z
4080
+ .object({
4081
+ boardId: z.number().int().optional(),
4082
+ description: z.string().optional(),
4083
+ id: z.number().int().optional(),
4084
+ jql: z.string().optional(),
4085
+ name: z.string().optional(),
4086
+ position: z.number().int().optional(),
4087
+ })
4088
+ .strict(),
4089
+ )
4090
+ .optional(),
4091
+ })
4092
+ .strict(),
4093
+ })
4094
+ .describe("BoardService.getAllQuickFilters.response"),
4095
+ );
4096
+ validationSchemaStorage.registerExtensible(
4097
+ "BoardService.getQuickFilter.response",
4098
+ z
4099
+ .object({
4100
+ status: z.literal(200),
4101
+ mediaType: z.literal("application/json"),
4102
+ body: z
4103
+ .object({
4104
+ boardId: z.number().int().optional(),
4105
+ description: z.string().optional(),
4106
+ id: z.number().int().optional(),
4107
+ jql: z.string().optional(),
4108
+ name: z.string().optional(),
4109
+ position: z.number().int().optional(),
4110
+ })
4111
+ .strict(),
4112
+ })
4113
+ .describe("BoardService.getQuickFilter.response"),
4114
+ );
4115
+ validationSchemaStorage.registerExtensible(
4116
+ "BoardService.getReportsForBoard.response",
4117
+ z
4118
+ .object({
4119
+ status: z.literal(200),
4120
+ mediaType: z.literal("application/json"),
4121
+ body: z
4122
+ .object({
4123
+ reports: z.array(z.object({}).strict()).optional(),
4124
+ })
4125
+ .strict(),
4126
+ })
4127
+ .describe("BoardService.getReportsForBoard.response"),
4128
+ );
4129
+ validationSchemaStorage.registerExtensible(
4130
+ "BoardService.getAllSprints.response",
4131
+ z
4132
+ .object({
4133
+ status: z.literal(200),
4134
+ mediaType: z.literal("application/json"),
4135
+ body: z.unknown(),
4136
+ })
4137
+ .describe("BoardService.getAllSprints.response"),
4138
+ );
4139
+ validationSchemaStorage.registerExtensible(
4140
+ "BoardService.getBoardIssuesForSprint.response",
4141
+ z
4142
+ .object({
4143
+ status: z.literal(200),
4144
+ mediaType: z.literal("application/json"),
4145
+ body: z.unknown(),
4146
+ })
4147
+ .describe("BoardService.getBoardIssuesForSprint.response"),
4148
+ );
4149
+ validationSchemaStorage.registerExtensible(
4150
+ "BoardService.getAllVersions.response",
4151
+ z
4152
+ .object({
4153
+ status: z.literal(200),
4154
+ mediaType: z.literal("application/json"),
4155
+ body: z.unknown(),
4156
+ })
4157
+ .describe("BoardService.getAllVersions.response"),
4158
+ );
4159
+ validationSchemaStorage.registerExtensible(
4160
+ "BoardService.getBoardByFilterId.response",
4161
+ z
4162
+ .object({
4163
+ status: z.literal(200),
4164
+ mediaType: z.literal("application/json"),
4165
+ body: z
4166
+ .object({
4167
+ isLast: z.boolean().optional(),
4168
+ maxResults: z.number().int().optional(),
4169
+ startAt: z.number().int().optional(),
4170
+ total: z.number().int().optional(),
4171
+ values: z
4172
+ .array(
4173
+ z
4174
+ .object({
4175
+ id: z.number().int().optional(),
4176
+ name: z.string().optional(),
4177
+ self: z.string().optional(),
4178
+ })
4179
+ .strict(),
4180
+ )
4181
+ .optional(),
4182
+ })
4183
+ .strict(),
4184
+ })
4185
+ .describe("BoardService.getBoardByFilterId.response"),
4186
+ );
4187
+ validationSchemaStorage.registerOnce([registerBoardValidationSchemas]);
4188
+ }
4189
+ }