@resolution/jira-api-client 0.3.0 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (318) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/README.md +123 -1
  3. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +192 -4
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +192 -4
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  6. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +4 -0
  7. package/lib/openapi/platform/services/AnnouncementBannerService.js +4 -0
  8. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  9. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +8 -2
  10. package/lib/openapi/platform/services/AppDataPoliciesService.js +8 -2
  11. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  12. package/lib/openapi/platform/services/AppMigrationService.d.ts +5 -0
  13. package/lib/openapi/platform/services/AppMigrationService.js +5 -0
  14. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  15. package/lib/openapi/platform/services/AppPropertiesService.d.ts +8 -0
  16. package/lib/openapi/platform/services/AppPropertiesService.js +8 -0
  17. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  18. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +4 -0
  19. package/lib/openapi/platform/services/ApplicationRolesService.js +4 -0
  20. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  21. package/lib/openapi/platform/services/AuditRecordsService.d.ts +4 -1
  22. package/lib/openapi/platform/services/AuditRecordsService.js +4 -1
  23. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  24. package/lib/openapi/platform/services/AvatarsService.d.ts +9 -0
  25. package/lib/openapi/platform/services/AvatarsService.js +9 -0
  26. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  27. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +7 -2
  28. package/lib/openapi/platform/services/ClassificationLevelsService.js +7 -2
  29. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  30. package/lib/openapi/platform/services/DashboardsService.d.ts +21 -2
  31. package/lib/openapi/platform/services/DashboardsService.js +21 -2
  32. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  33. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -1
  34. package/lib/openapi/platform/services/DynamicModulesService.js +6 -1
  35. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  36. package/lib/openapi/platform/services/FilterSharingService.d.ts +8 -0
  37. package/lib/openapi/platform/services/FilterSharingService.js +8 -0
  38. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  39. package/lib/openapi/platform/services/FiltersService.d.ts +18 -3
  40. package/lib/openapi/platform/services/FiltersService.js +18 -3
  41. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  42. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +3 -0
  43. package/lib/openapi/platform/services/GroupAndUserPickerService.js +3 -0
  44. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  45. package/lib/openapi/platform/services/GroupsService.d.ts +15 -5
  46. package/lib/openapi/platform/services/GroupsService.js +15 -5
  47. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  48. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +10 -0
  49. package/lib/openapi/platform/services/IssueAttachmentsService.js +10 -0
  50. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  51. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +6 -0
  52. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +6 -0
  53. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  54. package/lib/openapi/platform/services/IssueCommentsService.d.ts +8 -0
  55. package/lib/openapi/platform/services/IssueCommentsService.js +8 -0
  56. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  57. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +4 -0
  58. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +4 -0
  59. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  60. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +15 -0
  61. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +15 -0
  62. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  63. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +10 -0
  64. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +10 -0
  65. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  66. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +9 -0
  67. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +9 -0
  68. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  69. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +4 -0
  70. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +4 -0
  71. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  72. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +20 -3
  73. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +20 -3
  74. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  75. package/lib/openapi/platform/services/IssueFieldsService.d.ts +13 -2
  76. package/lib/openapi/platform/services/IssueFieldsService.js +13 -2
  77. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  78. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +7 -0
  79. package/lib/openapi/platform/services/IssueLinkTypesService.js +7 -0
  80. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  81. package/lib/openapi/platform/services/IssueLinksService.d.ts +5 -0
  82. package/lib/openapi/platform/services/IssueLinksService.js +5 -0
  83. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  84. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +4 -0
  85. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +4 -0
  86. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  87. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +12 -2
  88. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +12 -2
  89. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  90. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +11 -1
  91. package/lib/openapi/platform/services/IssuePrioritiesService.js +11 -1
  92. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  93. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +10 -0
  94. package/lib/openapi/platform/services/IssuePropertiesService.js +10 -0
  95. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  96. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +8 -0
  97. package/lib/openapi/platform/services/IssueRemoteLinksService.js +8 -0
  98. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  99. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +11 -1
  100. package/lib/openapi/platform/services/IssueResolutionsService.js +11 -1
  101. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  102. package/lib/openapi/platform/services/IssueSearchService.d.ts +9 -2
  103. package/lib/openapi/platform/services/IssueSearchService.js +9 -2
  104. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  105. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +4 -0
  106. package/lib/openapi/platform/services/IssueSecurityLevelService.js +4 -0
  107. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  108. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +22 -4
  109. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +22 -4
  110. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  111. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +6 -0
  112. package/lib/openapi/platform/services/IssueTypePropertiesService.js +6 -0
  113. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  114. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +14 -2
  115. package/lib/openapi/platform/services/IssueTypeSchemesService.js +14 -2
  116. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  117. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +15 -2
  118. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +15 -2
  119. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  120. package/lib/openapi/platform/services/IssueTypesService.d.ts +10 -0
  121. package/lib/openapi/platform/services/IssueTypesService.js +10 -0
  122. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  123. package/lib/openapi/platform/services/IssueVotesService.d.ts +5 -0
  124. package/lib/openapi/platform/services/IssueVotesService.js +5 -0
  125. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  126. package/lib/openapi/platform/services/IssueWatchersService.d.ts +6 -0
  127. package/lib/openapi/platform/services/IssueWatchersService.js +6 -0
  128. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  129. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +6 -0
  130. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +6 -0
  131. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  132. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +12 -2
  133. package/lib/openapi/platform/services/IssueWorklogsService.js +12 -2
  134. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  135. package/lib/openapi/platform/services/IssuesService.d.ts +24 -1
  136. package/lib/openapi/platform/services/IssuesService.js +24 -1
  137. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  138. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +4 -0
  139. package/lib/openapi/platform/services/JiraExpressionsService.js +4 -0
  140. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  141. package/lib/openapi/platform/services/JiraSettingsService.d.ts +7 -1
  142. package/lib/openapi/platform/services/JiraSettingsService.js +7 -1
  143. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  144. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +5 -1
  145. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +5 -1
  146. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  147. package/lib/openapi/platform/services/JqlService.d.ts +9 -1
  148. package/lib/openapi/platform/services/JqlService.js +9 -1
  149. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  150. package/lib/openapi/platform/services/LabelsService.d.ts +4 -1
  151. package/lib/openapi/platform/services/LabelsService.js +4 -1
  152. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  153. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +5 -0
  154. package/lib/openapi/platform/services/LicenseMetricsService.js +5 -0
  155. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  156. package/lib/openapi/platform/services/MyselfService.d.ts +10 -1
  157. package/lib/openapi/platform/services/MyselfService.js +10 -1
  158. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  159. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +12 -1
  160. package/lib/openapi/platform/services/PermissionSchemesService.js +12 -1
  161. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  162. package/lib/openapi/platform/services/PermissionsService.d.ts +7 -1
  163. package/lib/openapi/platform/services/PermissionsService.js +7 -1
  164. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  165. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +11 -1
  166. package/lib/openapi/platform/services/PrioritySchemesService.js +11 -1
  167. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  168. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +6 -0
  169. package/lib/openapi/platform/services/ProjectAvatarsService.js +6 -0
  170. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  171. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +7 -0
  172. package/lib/openapi/platform/services/ProjectCategoriesService.js +7 -0
  173. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  174. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +5 -0
  175. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +5 -0
  176. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  177. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +11 -1
  178. package/lib/openapi/platform/services/ProjectComponentsService.js +11 -1
  179. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  180. package/lib/openapi/platform/services/ProjectEmailService.d.ts +4 -0
  181. package/lib/openapi/platform/services/ProjectEmailService.js +4 -0
  182. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  183. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +4 -0
  184. package/lib/openapi/platform/services/ProjectFeaturesService.js +4 -0
  185. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  186. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +10 -3
  187. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +10 -3
  188. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  189. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +6 -0
  190. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +6 -0
  191. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  192. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +6 -0
  193. package/lib/openapi/platform/services/ProjectPropertiesService.js +6 -0
  194. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  195. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +8 -0
  196. package/lib/openapi/platform/services/ProjectRoleActorsService.js +8 -0
  197. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  198. package/lib/openapi/platform/services/ProjectRolesService.d.ts +11 -0
  199. package/lib/openapi/platform/services/ProjectRolesService.js +11 -0
  200. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  201. package/lib/openapi/platform/services/ProjectTypesService.d.ts +6 -0
  202. package/lib/openapi/platform/services/ProjectTypesService.js +6 -0
  203. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  204. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +17 -0
  205. package/lib/openapi/platform/services/ProjectVersionsService.js +17 -0
  206. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  207. package/lib/openapi/platform/services/ProjectsService.d.ts +18 -3
  208. package/lib/openapi/platform/services/ProjectsService.js +18 -3
  209. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  210. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +7 -1
  211. package/lib/openapi/platform/services/ScreenSchemesService.js +7 -1
  212. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  213. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +6 -0
  214. package/lib/openapi/platform/services/ScreenTabFieldsService.js +6 -0
  215. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  216. package/lib/openapi/platform/services/ScreenTabsService.d.ts +9 -1
  217. package/lib/openapi/platform/services/ScreenTabsService.js +9 -1
  218. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  219. package/lib/openapi/platform/services/ScreensService.d.ts +10 -1
  220. package/lib/openapi/platform/services/ScreensService.js +10 -1
  221. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  222. package/lib/openapi/platform/services/ServerInfoService.d.ts +6 -1
  223. package/lib/openapi/platform/services/ServerInfoService.js +6 -1
  224. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  225. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +3 -0
  226. package/lib/openapi/platform/services/ServiceRegistryService.js +3 -0
  227. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  228. package/lib/openapi/platform/services/StatusService.d.ts +8 -1
  229. package/lib/openapi/platform/services/StatusService.js +8 -1
  230. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  231. package/lib/openapi/platform/services/TasksService.d.ts +4 -0
  232. package/lib/openapi/platform/services/TasksService.js +4 -0
  233. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  234. package/lib/openapi/platform/services/TimeTrackingService.d.ts +7 -0
  235. package/lib/openapi/platform/services/TimeTrackingService.js +7 -0
  236. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  237. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +7 -1
  238. package/lib/openapi/platform/services/UiModificationsAppsService.js +7 -1
  239. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  240. package/lib/openapi/platform/services/UserPropertiesService.d.ts +7 -1
  241. package/lib/openapi/platform/services/UserPropertiesService.js +7 -1
  242. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  243. package/lib/openapi/platform/services/UserSearchService.d.ts +13 -3
  244. package/lib/openapi/platform/services/UserSearchService.js +13 -3
  245. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  246. package/lib/openapi/platform/services/UsersService.d.ts +21 -6
  247. package/lib/openapi/platform/services/UsersService.js +21 -6
  248. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  249. package/lib/openapi/platform/services/WebhooksService.d.ts +9 -2
  250. package/lib/openapi/platform/services/WebhooksService.js +9 -2
  251. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  252. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +16 -0
  253. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +16 -0
  254. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  255. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +4 -0
  256. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +4 -0
  257. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  258. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +20 -1
  259. package/lib/openapi/platform/services/WorkflowSchemesService.js +20 -1
  260. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  261. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +4 -0
  262. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +4 -0
  263. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  264. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +4 -0
  265. package/lib/openapi/platform/services/WorkflowStatusesService.js +4 -0
  266. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  267. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +6 -0
  268. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +6 -0
  269. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  270. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +5 -0
  271. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +5 -0
  272. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  273. package/lib/openapi/platform/services/WorkflowsService.d.ts +15 -3
  274. package/lib/openapi/platform/services/WorkflowsService.js +15 -3
  275. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  276. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +41 -5
  277. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +41 -5
  278. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  279. package/lib/openapi/software/services/BacklogService.d.ts +7 -1
  280. package/lib/openapi/software/services/BacklogService.js +7 -1
  281. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  282. package/lib/openapi/software/services/BoardService.d.ts +32 -2
  283. package/lib/openapi/software/services/BoardService.js +32 -2
  284. package/lib/openapi/software/services/BoardService.js.map +1 -1
  285. package/lib/openapi/software/services/BuildsService.d.ts +6 -0
  286. package/lib/openapi/software/services/BuildsService.js +6 -0
  287. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  288. package/lib/openapi/software/services/DeploymentsService.d.ts +7 -0
  289. package/lib/openapi/software/services/DeploymentsService.js +7 -0
  290. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  291. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +6 -0
  292. package/lib/openapi/software/services/DevOpsComponentsService.js +6 -0
  293. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  294. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +8 -0
  295. package/lib/openapi/software/services/DevelopmentInformationService.js +8 -0
  296. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  297. package/lib/openapi/software/services/EpicService.d.ts +13 -2
  298. package/lib/openapi/software/services/EpicService.js +13 -2
  299. package/lib/openapi/software/services/EpicService.js.map +1 -1
  300. package/lib/openapi/software/services/FeatureFlagsService.d.ts +6 -0
  301. package/lib/openapi/software/services/FeatureFlagsService.js +6 -0
  302. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  303. package/lib/openapi/software/services/IssueService.d.ts +9 -1
  304. package/lib/openapi/software/services/IssueService.js +9 -1
  305. package/lib/openapi/software/services/IssueService.js.map +1 -1
  306. package/lib/openapi/software/services/OperationsService.d.ts +11 -0
  307. package/lib/openapi/software/services/OperationsService.js +11 -0
  308. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  309. package/lib/openapi/software/services/RemoteLinksService.d.ts +6 -0
  310. package/lib/openapi/software/services/RemoteLinksService.js +6 -0
  311. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  312. package/lib/openapi/software/services/SecurityInformationService.d.ts +10 -0
  313. package/lib/openapi/software/services/SecurityInformationService.js +10 -0
  314. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  315. package/lib/openapi/software/services/SprintService.d.ts +17 -1
  316. package/lib/openapi/software/services/SprintService.js +17 -1
  317. package/lib/openapi/software/services/SprintService.js.map +1 -1
  318. package/package.json +4 -4
@@ -186,13 +186,21 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
186
186
  /**
187
187
  * This resource represents an announcement banner. Use it to retrieve and update
188
188
  * banner configuration.
189
+ *
190
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner
189
191
  */
190
192
  announcementBanner: AnnouncementBannerService;
191
- /** This resource represents app access rule data policies. */
193
+ /**
194
+ * This resource represents app access rule data policies.
195
+ *
196
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-data-policies
197
+ */
192
198
  appDataPolicies: AppDataPoliciesService;
193
199
  /**
194
200
  * This resource represents application roles. Use it to get details of an
195
201
  * application role or all application roles.
202
+ *
203
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles
196
204
  */
197
205
  applicationRoles: ApplicationRolesService;
198
206
  /**
@@ -204,31 +212,45 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
204
212
  * properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
205
213
  * - [perform bulk updates of issue custom field
206
214
  * values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
215
+ *
216
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration
207
217
  */
208
218
  appMigration: AppMigrationService;
209
219
  /**
210
220
  * This resource represents app properties. Use it to store arbitrary data for your
211
221
  * [Connect
212
222
  * app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
223
+ *
224
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties
213
225
  */
214
226
  appProperties: AppPropertiesService;
215
227
  /**
216
228
  * This resource represents audits that record activities undertaken in Jira. Use
217
229
  * it to get a list of audit records.
230
+ *
231
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records
218
232
  */
219
233
  auditRecords: AuditRecordsService;
220
234
  /**
221
235
  * This resource represents system and custom avatars. Use it to obtain the
222
236
  * details of system or custom avatars, add and remove avatars from a project or
223
237
  * issue type, and obtain avatar images.
238
+ *
239
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars
224
240
  */
225
241
  avatars: AvatarsService;
226
- /** This resource represents classification levels. */
242
+ /**
243
+ * This resource represents classification levels.
244
+ *
245
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels
246
+ */
227
247
  classificationLevels: ClassificationLevelsService;
228
248
  /**
229
249
  * This resource represents dashboards. Use it to obtain the details of dashboards
230
250
  * as well as get, create, update, or remove item properties and gadgets from
231
251
  * dashboards.
252
+ *
253
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards
232
254
  */
233
255
  dashboards: DashboardsService;
234
256
  /**
@@ -236,22 +258,30 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
236
258
  * dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)
237
259
  * by [Connect
238
260
  * apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
261
+ *
262
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules
239
263
  */
240
264
  dynamicModules: DynamicModulesService;
241
265
  /**
242
266
  * This resource represents options for sharing [filters](#api-group-Filters). Use
243
267
  * it to get share scopes as well as add and remove share scopes from filters.
268
+ *
269
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing
244
270
  */
245
271
  filterSharing: FilterSharingService;
246
272
  /**
247
273
  * This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ).
248
274
  * Use it to get, create, update, or delete filters. Also use it to configure the
249
275
  * columns for a filter and set favorite filters.
276
+ *
277
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters
250
278
  */
251
279
  filters: FiltersService;
252
280
  /**
253
281
  * This resource represents a list of users and a list of groups. Use it to obtain
254
282
  * the details to populate user and group picker suggestions list.
283
+ *
284
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker
255
285
  */
256
286
  groupAndUserPicker: GroupAndUserPickerService;
257
287
  /**
@@ -262,6 +292,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
262
292
  * group jira-software-users or rename it to jsw-users at any point. See
263
293
  * https://support.atlassian.com/user-management/docs/create-and-update-groups/
264
294
  * for details.)
295
+ *
296
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups
265
297
  */
266
298
  groups: GroupsService;
267
299
  /**
@@ -269,6 +301,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
269
301
  * Jira. Use it to get the metadata for an attachment, delete an attachment, and
270
302
  * view the metadata for the contents of an attachment. Also, use it to get the
271
303
  * attachment settings for Jira.
304
+ *
305
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments
272
306
  */
273
307
  issueAttachments: IssueAttachmentsService;
274
308
  /**
@@ -277,6 +311,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
277
311
  * set, and delete issue comment properties as well as obtain the keys of all
278
312
  * properties on a comment. Comment properties are a type of [entity
279
313
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
314
+ *
315
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties
280
316
  */
281
317
  issueCommentProperties: IssueCommentPropertiesService;
282
318
  /**
@@ -285,6 +321,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
285
321
  * * get, create, update, and delete a comment from an issue.
286
322
  * * get all comments from issue.
287
323
  * * get a list of comments by comment ID.
324
+ *
325
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments
288
326
  */
289
327
  issueComments: IssueCommentsService;
290
328
  /**
@@ -293,6 +331,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
293
331
  * Configurations are information used by the Forge app at runtime to determine
294
332
  * how to handle or process the data in a custom field in a given context. Use
295
333
  * this resource to set and read configurations.
334
+ *
335
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-
296
336
  */
297
337
  issueCustomFieldConfigurationApps: IssueCustomFieldConfigurationAppsService;
298
338
  /**
@@ -304,6 +344,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
304
344
  * * assign custom field contexts to projects.
305
345
  * * remove custom field contexts from projects.
306
346
  * * add issue types to custom field contexts.
347
+ *
348
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts
307
349
  */
308
350
  issueCustomFieldContexts: IssueCustomFieldContextsService;
309
351
  /**
@@ -316,6 +358,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
316
358
  * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
317
359
  * that enables a user to select an option from a list. Use it to add, remove, and
318
360
  * update the options of a select list issue field.
361
+ *
362
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-
319
363
  */
320
364
  issueCustomFieldOptionsApps: IssueCustomFieldOptionsAppsService;
321
365
  /**
@@ -333,22 +377,30 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
333
377
  * issue field select list options created by a Connect app.
334
378
  *
335
379
  * Use it to retrieve, create, update, order, and delete custom field options.
380
+ *
381
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options
336
382
  */
337
383
  issueCustomFieldOptions: IssueCustomFieldOptionsService;
338
384
  /**
339
385
  * This resource represents the values of custom fields added by [Forge
340
386
  * apps](https://developer.atlassian.com/platform/forge/). Use it to update the
341
387
  * value of a custom field on issues.
388
+ *
389
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-
342
390
  */
343
391
  issueCustomFieldValuesApps: IssueCustomFieldValuesAppsService;
344
392
  /**
345
393
  * This resource represents issue field configurations. Use it to get, set, and
346
394
  * delete field configurations and field configuration schemes.
395
+ *
396
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations
347
397
  */
348
398
  issueFieldConfigurations: IssueFieldConfigurationsService;
349
399
  /**
350
400
  * This resource represents issue fields, both system and custom fields. Use it to
351
401
  * get fields, field configurations, and create custom fields.
402
+ *
403
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields
352
404
  */
353
405
  issueFields: IssueFieldsService;
354
406
  /**
@@ -357,6 +409,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
357
409
  *
358
410
  * To use it, the site must have [issue
359
411
  * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
412
+ *
413
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links
360
414
  */
361
415
  issueLinks: IssueLinksService;
362
416
  /**
@@ -366,11 +420,15 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
366
420
  *
367
421
  * To use it, the site must have [issue
368
422
  * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
423
+ *
424
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types
369
425
  */
370
426
  issueLinkTypes: IssueLinkTypesService;
371
427
  /**
372
428
  * This resource represents issue navigator settings. Use it to get and set issue
373
429
  * navigator default columns.
430
+ *
431
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings
374
432
  */
375
433
  issueNavigatorSettings: IssueNavigatorSettingsService;
376
434
  /**
@@ -405,11 +463,15 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
405
463
  * * `AllWatchers`
406
464
  * * `UserCustomField` (the `parameter` is the ID of the custom field)
407
465
  * * `GroupCustomField`(the `parameter` is the ID of the custom field)
466
+ *
467
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes
408
468
  */
409
469
  issueNotificationSchemes: IssueNotificationSchemesService;
410
470
  /**
411
471
  * This resource represents issue priorities. Use it to get, create and update
412
472
  * issue priorities and details for individual issue priorities.
473
+ *
474
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities
413
475
  */
414
476
  issuePriorities: IssuePrioritiesService;
415
477
  /**
@@ -419,6 +481,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
419
481
  * to bulk update and delete issue properties are also provided. Issue properties
420
482
  * are a type of [entity
421
483
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
484
+ *
485
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties
422
486
  */
423
487
  issueProperties: IssuePropertiesService;
424
488
  /**
@@ -427,22 +491,30 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
427
491
  * issue links either by ID or global ID. The global ID provides a way of
428
492
  * accessing remote issue links using information about the item's remote system
429
493
  * host and remote system identifier.
494
+ *
495
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links
430
496
  */
431
497
  issueRemoteLinks: IssueRemoteLinksService;
432
498
  /**
433
499
  * This resource represents issue resolution values. Use it to obtain a list of
434
500
  * all issue resolution values and the details of individual resolution values.
501
+ *
502
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions
435
503
  */
436
504
  issueResolutions: IssueResolutionsService;
437
505
  /**
438
506
  * This resource represents various ways to search for issues. Use it to search
439
507
  * for issues with a JQL query and find issues to populate an issue picker.
508
+ *
509
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search
440
510
  */
441
511
  issueSearch: IssueSearchService;
442
512
  /**
443
513
  * This resource represents issue security levels. Use it to obtain the details of
444
514
  * any issue security level. For more information about issue security levels, see
445
515
  * [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg).
516
+ *
517
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level
446
518
  */
447
519
  issueSecurityLevel: IssueSecurityLevelService;
448
520
  /**
@@ -453,6 +525,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
453
525
  * issue. When an issue security scheme is associated with a project, its security
454
526
  * levels can be applied to issues in that project. Sub-tasks also inherit the
455
527
  * security level of their parent issue.
528
+ *
529
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes
456
530
  */
457
531
  issueSecuritySchemes: IssueSecuritySchemesService;
458
532
  /**
@@ -469,6 +543,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
469
543
  * * Archive issues.
470
544
  * * Unarchive issues.
471
545
  * * Export archived issues.
546
+ *
547
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues
472
548
  */
473
549
  issues: IssuesService;
474
550
  /**
@@ -477,6 +553,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
477
553
  * and delete issue type properties as well as obtain the keys of all properties
478
554
  * on a issues type. Issue type properties are a type of [entity
479
555
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
556
+ *
557
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties
480
558
  */
481
559
  issueTypeProperties: IssueTypePropertiesService;
482
560
  /**
@@ -488,6 +566,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
488
566
  * * delete issue types from issue type schemes.
489
567
  * * create, update, and delete issue type schemes.
490
568
  * * change the order of issue types in issue type schemes.
569
+ *
570
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes
491
571
  */
492
572
  issueTypeSchemes: IssueTypeSchemesService;
493
573
  /**
@@ -501,6 +581,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
501
581
  * * append issue type to screen scheme mappings to issue type screen schemes.
502
582
  * * remove issue type to screen scheme mappings from issue type screen schemes.
503
583
  * * update default screen scheme of issue type screen scheme.
584
+ *
585
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes
504
586
  */
505
587
  issueTypeScreenSchemes: IssueTypeScreenSchemesService;
506
588
  /**
@@ -510,16 +592,22 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
510
592
  * * get all issue types for a user.
511
593
  * * get alternative issue types.
512
594
  * * set an avatar for an issue type.
595
+ *
596
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types
513
597
  */
514
598
  issueTypes: IssueTypesService;
515
599
  /**
516
600
  * This resource represents votes cast by users on an issue. Use it to get details
517
601
  * of votes on an issue as well as cast and withdrawal votes.
602
+ *
603
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-votes
518
604
  */
519
605
  issueVotes: IssueVotesService;
520
606
  /**
521
607
  * This resource represents users watching an issue. Use it to get details of
522
608
  * users watching an issue as well as start and stop a user watching an issue.
609
+ *
610
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers
523
611
  */
524
612
  issueWatchers: IssueWatchersService;
525
613
  /**
@@ -528,6 +616,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
528
616
  * create, and delete issue worklog properties as well as obtain the keys of all
529
617
  * properties on a issue worklog. Issue worklog properties are a type of [entity
530
618
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
619
+ *
620
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties
531
621
  */
532
622
  issueWorklogProperties: IssueWorklogPropertiesService;
533
623
  /**
@@ -535,22 +625,30 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
535
625
  *
536
626
  * * get, create, update, and delete worklogs.
537
627
  * * obtain lists of updated or deleted worklogs.
628
+ *
629
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs
538
630
  */
539
631
  issueWorklogs: IssueWorklogsService;
540
632
  /**
541
633
  * This resource is a collection of operations for [Jira
542
634
  * expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
635
+ *
636
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions
543
637
  */
544
638
  jiraExpressions: JiraExpressionsService;
545
639
  /**
546
640
  * This resource represents various settings in Jira. Use it to get and update
547
641
  * Jira settings and properties.
642
+ *
643
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings
548
644
  */
549
645
  jiraSettings: JiraSettingsService;
550
646
  /**
551
647
  * This resource represents JQL function's precomputations. Precomputation is a
552
648
  * mapping between custom function call and JQL fragment returned by this
553
649
  * function. Use it to get and update precomputations.
650
+ *
651
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql-functions-apps-
554
652
  */
555
653
  jqlFunctionsApps: JqlFunctionsAppsService;
556
654
  /**
@@ -562,16 +660,22 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
562
660
  * key) to equivalent JQL queries with account IDs.
563
661
  * * convert readable details in one or more JQL queries to IDs where a user
564
662
  * doesn't have permission to view the entity whose details are readable.
663
+ *
664
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql
565
665
  */
566
666
  jql: JqlService;
567
667
  /**
568
668
  * This resource represents available labels. Use it to get available labels for
569
669
  * the global label field.
670
+ *
671
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels
570
672
  */
571
673
  labels: LabelsService;
572
674
  /**
573
675
  * This resource represents license metrics. Use it to get available metrics for
574
676
  * Jira licences.
677
+ *
678
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics
575
679
  */
576
680
  licenseMetrics: LicenseMetricsService;
577
681
  /**
@@ -579,27 +683,37 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
579
683
  * details, group membership, application roles, preferences, and locale. Use it
580
684
  * to get, create, update, and delete (restore default) values of the user's
581
685
  * preferences and locale.
686
+ *
687
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself
582
688
  */
583
689
  myself: MyselfService;
584
690
  /**
585
691
  * This resource represents permission schemes. Use it to get, create, update, and
586
692
  * delete permission schemes as well as get, create, update, and delete details of
587
693
  * the permissions granted in those schemes.
694
+ *
695
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes
588
696
  */
589
697
  permissionSchemes: PermissionSchemesService;
590
698
  /**
591
699
  * This resource represents permissions. Use it to obtain details of all
592
700
  * permissions and determine whether the user has certain permissions.
701
+ *
702
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions
593
703
  */
594
704
  permissions: PermissionsService;
595
705
  /**
596
706
  * This resource represents issue priority schemes. Use it to get priority schemes
597
707
  * and related information, and to create, update and delete priority schemes.
708
+ *
709
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes
598
710
  */
599
711
  prioritySchemes: PrioritySchemesService;
600
712
  /**
601
713
  * This resource represents avatars associated with a project. Use it to get,
602
714
  * load, set, and remove project avatars.
715
+ *
716
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars
603
717
  */
604
718
  projectAvatars: ProjectAvatarsService;
605
719
  /**
@@ -608,23 +722,31 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
608
722
  * and details of individual categories. For more information on managing project
609
723
  * categories, see [Adding, assigning, and deleting project
610
724
  * categories](https://confluence.atlassian.com/x/-A5WMg).
725
+ *
726
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories
611
727
  */
612
728
  projectCategories: ProjectCategoriesService;
613
729
  /**
614
730
  * This resource represents classification levels used in a project. Use it to
615
731
  * view and manage classification levels in your projects.
732
+ *
733
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels
616
734
  */
617
735
  projectClassificationLevels: ProjectClassificationLevelsService;
618
736
  /**
619
737
  * This resource represents project components. Use it to get, create, update, and
620
738
  * delete project components. Also get components for project and get a count of
621
739
  * issues by component.
740
+ *
741
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components
622
742
  */
623
743
  projectComponents: ProjectComponentsService;
624
744
  /**
625
745
  * This resource represents the email address used to send a project's
626
746
  * notifications. Use it to get and set the [project's sender email
627
747
  * address](https://confluence.atlassian.com/x/dolKLg).
748
+ *
749
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email
628
750
  */
629
751
  projectEmail: ProjectEmailService;
630
752
  /**
@@ -632,9 +754,15 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
632
754
  * for a project and modify the state of a feature. The project feature endpoint
633
755
  * is available only for Jira Software, both for team- and company-managed
634
756
  * projects.
757
+ *
758
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-features
635
759
  */
636
760
  projectFeatures: ProjectFeaturesService;
637
- /** This resource provides validation for project keys and names. */
761
+ /**
762
+ * This resource provides validation for project keys and names.
763
+ *
764
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation
765
+ */
638
766
  projectKeyAndNameValidation: ProjectKeyAndNameValidationService;
639
767
  /**
640
768
  * This resource represents permission schemes for a project. Use this resource to:
@@ -647,6 +775,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
647
775
  *
648
776
  * See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg)
649
777
  * for more information about permission schemes.
778
+ *
779
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes
650
780
  */
651
781
  projectPermissionSchemes: ProjectPermissionSchemesService;
652
782
  /**
@@ -655,6 +785,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
655
785
  * delete project properties as well as get a list of property keys for a project.
656
786
  * Project properties are a type of [entity
657
787
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
788
+ *
789
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-properties
658
790
  */
659
791
  projectProperties: ProjectPropertiesService;
660
792
  /**
@@ -662,34 +794,46 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
662
794
  * roles](#api-group-Issue-comments). Use it to get, add, and remove default users
663
795
  * from project roles. Also use it to add and remove users from a project role
664
796
  * associated with a project.
797
+ *
798
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-role-actors
665
799
  */
666
800
  projectRoleActors: ProjectRoleActorsService;
667
801
  /**
668
802
  * This resource represents the roles that users can play in projects. Use this
669
803
  * resource to get, create, update, and delete project roles.
804
+ *
805
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles
670
806
  */
671
807
  projectRoles: ProjectRolesService;
672
808
  /**
673
809
  * This resource represents projects. Use it to get, create, update, and delete
674
810
  * projects. Also get statuses available to a project, a project's notification
675
811
  * schemes, and update a project's type.
812
+ *
813
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects
676
814
  */
677
815
  projects: ProjectsService;
678
816
  /**
679
817
  * This resource represents project types. Use it to obtain a list of all project
680
818
  * types, a list of project types accessible to the calling user, and details of a
681
819
  * project type.
820
+ *
821
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types
682
822
  */
683
823
  projectTypes: ProjectTypesService;
684
824
  /**
685
825
  * This resource represents project versions. Use it to get, get lists of, create,
686
826
  * update, move, merge, and delete project versions. This resource also provides
687
827
  * counts of issues by version.
828
+ *
829
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions
688
830
  */
689
831
  projectVersions: ProjectVersionsService;
690
832
  /**
691
833
  * This resource represents screen schemes in classic projects. Use it to get,
692
834
  * create, update, and delete screen schemes.
835
+ *
836
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes
693
837
  */
694
838
  screenSchemes: ScreenSchemesService;
695
839
  /**
@@ -701,42 +845,60 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
701
845
  * * delete screens.
702
846
  * * update screens.
703
847
  * * add a field to the default screen.
848
+ *
849
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens
704
850
  */
705
851
  screens: ScreensService;
706
852
  /**
707
853
  * This resource represents the screen tab fields used to record issue details.
708
854
  * Use it to get, add, move, and remove fields from screen tabs.
855
+ *
856
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields
709
857
  */
710
858
  screenTabFields: ScreenTabFieldsService;
711
859
  /**
712
860
  * This resource represents the screen tabs used to record issue details. Use it
713
861
  * to get, create, update, move, and delete screen tabs.
862
+ *
863
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tabs
714
864
  */
715
865
  screenTabs: ScreenTabsService;
716
- /** This resource provides information about the Jira instance. */
866
+ /**
867
+ * This resource provides information about the Jira instance.
868
+ *
869
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info
870
+ */
717
871
  serverInfo: ServerInfoService;
718
872
  /**
719
873
  * This resource represents a service registry. Use it to retrieve attributes
720
874
  * related to a [service
721
875
  * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
722
876
  * in JSM.
877
+ *
878
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry
723
879
  */
724
880
  serviceRegistry: ServiceRegistryService;
725
881
  /**
726
882
  * This resource represents statuses. Use it to search, get, create, delete, and
727
883
  * change statuses.
884
+ *
885
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status
728
886
  */
729
887
  status: StatusService;
730
888
  /**
731
889
  * This resource represents a [long-running asynchronous
732
890
  * tasks](#async-operations). Use it to obtain details about the progress of a
733
891
  * long-running task or cancel a long-running task.
892
+ *
893
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks
734
894
  */
735
895
  tasks: TasksService;
736
896
  /**
737
897
  * This resource represents time tracking and time tracking providers. Use it to
738
898
  * get and set the time tracking provider, get and set the time tracking options,
739
899
  * and disable time tracking.
900
+ *
901
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking
740
902
  */
741
903
  timeTracking: TimeTrackingService;
742
904
  /**
@@ -744,6 +906,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
744
906
  * Forge apps to control how selected Jira fields behave on the following views:
745
907
  * global issue create, issue view. For example: hide specific fields, set them as
746
908
  * required, etc.
909
+ *
910
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-
747
911
  */
748
912
  uiModificationsApps: UiModificationsAppsService;
749
913
  /**
@@ -758,6 +922,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
758
922
  * This resource does not access the [user
759
923
  * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
760
924
  * Jira.
925
+ *
926
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties
761
927
  */
762
928
  userProperties: UserPropertiesService;
763
929
  /**
@@ -766,6 +932,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
766
932
  * with permissions, user lists for pickup fields, and user lists generated using
767
933
  * structured queries. Note that the operations in this resource only return users
768
934
  * found within the first 1000 users.
935
+ *
936
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search
769
937
  */
770
938
  userSearch: UserSearchService;
771
939
  /**
@@ -775,6 +943,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
775
943
  * * get, set, and reset a user's default issue table columns.
776
944
  * * get a list of the groups the user belongs to.
777
945
  * * get a list of user account IDs for a list of usernames or user keys.
946
+ *
947
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users
778
948
  */
779
949
  users: UsersService;
780
950
  /**
@@ -782,6 +952,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
782
952
  * event occurs in Jira for issues specified by a JQL query. Only Connect and
783
953
  * OAuth 2.0 apps can register and manage webhooks. For more information, see
784
954
  * [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
955
+ *
956
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks
785
957
  */
786
958
  webhooks: WebhooksService;
787
959
  /**
@@ -799,6 +971,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
799
971
  *
800
972
  * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
801
973
  * for more information.
974
+ *
975
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts
802
976
  */
803
977
  workflowSchemeDrafts: WorkflowSchemeDraftsService;
804
978
  /**
@@ -806,6 +980,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
806
980
  *
807
981
  * For more information, see [Managing your
808
982
  * workflows](https://confluence.atlassian.com/x/q4hKLg).
983
+ *
984
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations
809
985
  */
810
986
  workflowSchemeProjectAssociations: WorkflowSchemeProjectAssociationsService;
811
987
  /**
@@ -823,6 +999,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
823
999
  *
824
1000
  * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
825
1001
  * for more information.
1002
+ *
1003
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes
826
1004
  */
827
1005
  workflowSchemes: WorkflowSchemesService;
828
1006
  /**
@@ -833,17 +1011,23 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
833
1011
  * * Update workflows
834
1012
  * * Delete inactive workflows
835
1013
  * * Get workflow capabilities
1014
+ *
1015
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows
836
1016
  */
837
1017
  workflows: WorkflowsService;
838
1018
  /**
839
1019
  * This resource represents status categories. Use it to obtain a list of all
840
1020
  * status categories and the details of a category. Status categories provided a
841
1021
  * mechanism for categorizing [statuses](#api-group-Workflow-statuses).
1022
+ *
1023
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories
842
1024
  */
843
1025
  workflowStatusCategories: WorkflowStatusCategoriesService;
844
1026
  /**
845
1027
  * This resource represents issue workflow statuses. Use it to obtain a list of
846
1028
  * all statuses associated with workflows and the details of a status.
1029
+ *
1030
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses
847
1031
  */
848
1032
  workflowStatuses: WorkflowStatusesService;
849
1033
  /**
@@ -852,6 +1036,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
852
1036
  * delete workflow transition properties as well as get a list of property keys
853
1037
  * for a workflow transition. Workflow transition properties are a type of [entity
854
1038
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
1039
+ *
1040
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties
855
1041
  */
856
1042
  workflowTransitionProperties: WorkflowTransitionPropertiesService;
857
1043
  /**
@@ -860,6 +1046,8 @@ export declare class BaseJiraPlatformApiClient extends CommonHttpService {
860
1046
  * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
861
1047
  * that is executed in association with the workflow. Use it to read and modify
862
1048
  * configuration of workflow transition rules.
1049
+ *
1050
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules
863
1051
  */
864
1052
  workflowTransitionRules: WorkflowTransitionRulesService;
865
1053
  constructor(options?: BaseJiraPlatformApiClientOptions);