@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
@@ -123,13 +123,21 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
123
123
  /**
124
124
  * This resource represents an announcement banner. Use it to retrieve and update
125
125
  * banner configuration.
126
+ *
127
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner
126
128
  */
127
129
  this.announcementBanner = new AnnouncementBannerService_1.AnnouncementBannerService(this.getClient);
128
- /** This resource represents app access rule data policies. */
130
+ /**
131
+ * This resource represents app access rule data policies.
132
+ *
133
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-data-policies
134
+ */
129
135
  this.appDataPolicies = new AppDataPoliciesService_1.AppDataPoliciesService(this.getClient);
130
136
  /**
131
137
  * This resource represents application roles. Use it to get details of an
132
138
  * application role or all application roles.
139
+ *
140
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles
133
141
  */
134
142
  this.applicationRoles = new ApplicationRolesService_1.ApplicationRolesService(this.getClient);
135
143
  /**
@@ -141,31 +149,45 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
141
149
  * properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).
142
150
  * - [perform bulk updates of issue custom field
143
151
  * values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/).
152
+ *
153
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration
144
154
  */
145
155
  this.appMigration = new AppMigrationService_1.AppMigrationService(this.getClient);
146
156
  /**
147
157
  * This resource represents app properties. Use it to store arbitrary data for your
148
158
  * [Connect
149
159
  * app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
160
+ *
161
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties
150
162
  */
151
163
  this.appProperties = new AppPropertiesService_1.AppPropertiesService(this.getClient);
152
164
  /**
153
165
  * This resource represents audits that record activities undertaken in Jira. Use
154
166
  * it to get a list of audit records.
167
+ *
168
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records
155
169
  */
156
170
  this.auditRecords = new AuditRecordsService_1.AuditRecordsService(this.getClient);
157
171
  /**
158
172
  * This resource represents system and custom avatars. Use it to obtain the
159
173
  * details of system or custom avatars, add and remove avatars from a project or
160
174
  * issue type, and obtain avatar images.
175
+ *
176
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars
161
177
  */
162
178
  this.avatars = new AvatarsService_1.AvatarsService(this.getClient);
163
- /** This resource represents classification levels. */
179
+ /**
180
+ * This resource represents classification levels.
181
+ *
182
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels
183
+ */
164
184
  this.classificationLevels = new ClassificationLevelsService_1.ClassificationLevelsService(this.getClient);
165
185
  /**
166
186
  * This resource represents dashboards. Use it to obtain the details of dashboards
167
187
  * as well as get, create, update, or remove item properties and gadgets from
168
188
  * dashboards.
189
+ *
190
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dashboards
169
191
  */
170
192
  this.dashboards = new DashboardsService_1.DashboardsService(this.getClient);
171
193
  /**
@@ -173,22 +195,30 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
173
195
  * dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)
174
196
  * by [Connect
175
197
  * apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps).
198
+ *
199
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules
176
200
  */
177
201
  this.dynamicModules = new DynamicModulesService_1.DynamicModulesService(this.getClient);
178
202
  /**
179
203
  * This resource represents options for sharing [filters](#api-group-Filters). Use
180
204
  * it to get share scopes as well as add and remove share scopes from filters.
205
+ *
206
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing
181
207
  */
182
208
  this.filterSharing = new FilterSharingService_1.FilterSharingService(this.getClient);
183
209
  /**
184
210
  * This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ).
185
211
  * Use it to get, create, update, or delete filters. Also use it to configure the
186
212
  * columns for a filter and set favorite filters.
213
+ *
214
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filters
187
215
  */
188
216
  this.filters = new FiltersService_1.FiltersService(this.getClient);
189
217
  /**
190
218
  * This resource represents a list of users and a list of groups. Use it to obtain
191
219
  * the details to populate user and group picker suggestions list.
220
+ *
221
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-group-and-user-picker
192
222
  */
193
223
  this.groupAndUserPicker = new GroupAndUserPickerService_1.GroupAndUserPickerService(this.getClient);
194
224
  /**
@@ -199,6 +229,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
199
229
  * group jira-software-users or rename it to jsw-users at any point. See
200
230
  * https://support.atlassian.com/user-management/docs/create-and-update-groups/
201
231
  * for details.)
232
+ *
233
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups
202
234
  */
203
235
  this.groups = new GroupsService_1.GroupsService(this.getClient);
204
236
  /**
@@ -206,6 +238,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
206
238
  * Jira. Use it to get the metadata for an attachment, delete an attachment, and
207
239
  * view the metadata for the contents of an attachment. Also, use it to get the
208
240
  * attachment settings for Jira.
241
+ *
242
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments
209
243
  */
210
244
  this.issueAttachments = new IssueAttachmentsService_1.IssueAttachmentsService(this.getClient);
211
245
  /**
@@ -214,6 +248,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
214
248
  * set, and delete issue comment properties as well as obtain the keys of all
215
249
  * properties on a comment. Comment properties are a type of [entity
216
250
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
251
+ *
252
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties
217
253
  */
218
254
  this.issueCommentProperties = new IssueCommentPropertiesService_1.IssueCommentPropertiesService(this.getClient);
219
255
  /**
@@ -222,6 +258,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
222
258
  * * get, create, update, and delete a comment from an issue.
223
259
  * * get all comments from issue.
224
260
  * * get a list of comments by comment ID.
261
+ *
262
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments
225
263
  */
226
264
  this.issueComments = new IssueCommentsService_1.IssueCommentsService(this.getClient);
227
265
  /**
@@ -230,6 +268,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
230
268
  * Configurations are information used by the Forge app at runtime to determine
231
269
  * how to handle or process the data in a custom field in a given context. Use
232
270
  * this resource to set and read configurations.
271
+ *
272
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration-apps-
233
273
  */
234
274
  this.issueCustomFieldConfigurationApps = new IssueCustomFieldConfigurationAppsService_1.IssueCustomFieldConfigurationAppsService(this.getClient);
235
275
  /**
@@ -241,6 +281,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
241
281
  * * assign custom field contexts to projects.
242
282
  * * remove custom field contexts from projects.
243
283
  * * add issue types to custom field contexts.
284
+ *
285
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-contexts
244
286
  */
245
287
  this.issueCustomFieldContexts = new IssueCustomFieldContextsService_1.IssueCustomFieldContextsService(this.getClient);
246
288
  /**
@@ -253,6 +295,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
253
295
  * field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/)
254
296
  * that enables a user to select an option from a list. Use it to add, remove, and
255
297
  * update the options of a select list issue field.
298
+ *
299
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options-apps-
256
300
  */
257
301
  this.issueCustomFieldOptionsApps = new IssueCustomFieldOptionsAppsService_1.IssueCustomFieldOptionsAppsService(this.getClient);
258
302
  /**
@@ -270,22 +314,30 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
270
314
  * issue field select list options created by a Connect app.
271
315
  *
272
316
  * Use it to retrieve, create, update, order, and delete custom field options.
317
+ *
318
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options
273
319
  */
274
320
  this.issueCustomFieldOptions = new IssueCustomFieldOptionsService_1.IssueCustomFieldOptionsService(this.getClient);
275
321
  /**
276
322
  * This resource represents the values of custom fields added by [Forge
277
323
  * apps](https://developer.atlassian.com/platform/forge/). Use it to update the
278
324
  * value of a custom field on issues.
325
+ *
326
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-values-apps-
279
327
  */
280
328
  this.issueCustomFieldValuesApps = new IssueCustomFieldValuesAppsService_1.IssueCustomFieldValuesAppsService(this.getClient);
281
329
  /**
282
330
  * This resource represents issue field configurations. Use it to get, set, and
283
331
  * delete field configurations and field configuration schemes.
332
+ *
333
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations
284
334
  */
285
335
  this.issueFieldConfigurations = new IssueFieldConfigurationsService_1.IssueFieldConfigurationsService(this.getClient);
286
336
  /**
287
337
  * This resource represents issue fields, both system and custom fields. Use it to
288
338
  * get fields, field configurations, and create custom fields.
339
+ *
340
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields
289
341
  */
290
342
  this.issueFields = new IssueFieldsService_1.IssueFieldsService(this.getClient);
291
343
  /**
@@ -294,6 +346,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
294
346
  *
295
347
  * To use it, the site must have [issue
296
348
  * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
349
+ *
350
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-links
297
351
  */
298
352
  this.issueLinks = new IssueLinksService_1.IssueLinksService(this.getClient);
299
353
  /**
@@ -303,11 +357,15 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
303
357
  *
304
358
  * To use it, the site must have [issue
305
359
  * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
360
+ *
361
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-link-types
306
362
  */
307
363
  this.issueLinkTypes = new IssueLinkTypesService_1.IssueLinkTypesService(this.getClient);
308
364
  /**
309
365
  * This resource represents issue navigator settings. Use it to get and set issue
310
366
  * navigator default columns.
367
+ *
368
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-navigator-settings
311
369
  */
312
370
  this.issueNavigatorSettings = new IssueNavigatorSettingsService_1.IssueNavigatorSettingsService(this.getClient);
313
371
  /**
@@ -342,11 +400,15 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
342
400
  * * `AllWatchers`
343
401
  * * `UserCustomField` (the `parameter` is the ID of the custom field)
344
402
  * * `GroupCustomField`(the `parameter` is the ID of the custom field)
403
+ *
404
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-notification-schemes
345
405
  */
346
406
  this.issueNotificationSchemes = new IssueNotificationSchemesService_1.IssueNotificationSchemesService(this.getClient);
347
407
  /**
348
408
  * This resource represents issue priorities. Use it to get, create and update
349
409
  * issue priorities and details for individual issue priorities.
410
+ *
411
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-priorities
350
412
  */
351
413
  this.issuePriorities = new IssuePrioritiesService_1.IssuePrioritiesService(this.getClient);
352
414
  /**
@@ -356,6 +418,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
356
418
  * to bulk update and delete issue properties are also provided. Issue properties
357
419
  * are a type of [entity
358
420
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
421
+ *
422
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-properties
359
423
  */
360
424
  this.issueProperties = new IssuePropertiesService_1.IssuePropertiesService(this.getClient);
361
425
  /**
@@ -364,22 +428,30 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
364
428
  * issue links either by ID or global ID. The global ID provides a way of
365
429
  * accessing remote issue links using information about the item's remote system
366
430
  * host and remote system identifier.
431
+ *
432
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-remote-links
367
433
  */
368
434
  this.issueRemoteLinks = new IssueRemoteLinksService_1.IssueRemoteLinksService(this.getClient);
369
435
  /**
370
436
  * This resource represents issue resolution values. Use it to obtain a list of
371
437
  * all issue resolution values and the details of individual resolution values.
438
+ *
439
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-resolutions
372
440
  */
373
441
  this.issueResolutions = new IssueResolutionsService_1.IssueResolutionsService(this.getClient);
374
442
  /**
375
443
  * This resource represents various ways to search for issues. Use it to search
376
444
  * for issues with a JQL query and find issues to populate an issue picker.
445
+ *
446
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search
377
447
  */
378
448
  this.issueSearch = new IssueSearchService_1.IssueSearchService(this.getClient);
379
449
  /**
380
450
  * This resource represents issue security levels. Use it to obtain the details of
381
451
  * any issue security level. For more information about issue security levels, see
382
452
  * [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg).
453
+ *
454
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-level
383
455
  */
384
456
  this.issueSecurityLevel = new IssueSecurityLevelService_1.IssueSecurityLevelService(this.getClient);
385
457
  /**
@@ -390,6 +462,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
390
462
  * issue. When an issue security scheme is associated with a project, its security
391
463
  * levels can be applied to issues in that project. Sub-tasks also inherit the
392
464
  * security level of their parent issue.
465
+ *
466
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-security-schemes
393
467
  */
394
468
  this.issueSecuritySchemes = new IssueSecuritySchemesService_1.IssueSecuritySchemesService(this.getClient);
395
469
  /**
@@ -406,6 +480,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
406
480
  * * Archive issues.
407
481
  * * Unarchive issues.
408
482
  * * Export archived issues.
483
+ *
484
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues
409
485
  */
410
486
  this.issues = new IssuesService_1.IssuesService(this.getClient);
411
487
  /**
@@ -414,6 +490,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
414
490
  * and delete issue type properties as well as obtain the keys of all properties
415
491
  * on a issues type. Issue type properties are a type of [entity
416
492
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
493
+ *
494
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-properties
417
495
  */
418
496
  this.issueTypeProperties = new IssueTypePropertiesService_1.IssueTypePropertiesService(this.getClient);
419
497
  /**
@@ -425,6 +503,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
425
503
  * * delete issue types from issue type schemes.
426
504
  * * create, update, and delete issue type schemes.
427
505
  * * change the order of issue types in issue type schemes.
506
+ *
507
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-schemes
428
508
  */
429
509
  this.issueTypeSchemes = new IssueTypeSchemesService_1.IssueTypeSchemesService(this.getClient);
430
510
  /**
@@ -438,6 +518,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
438
518
  * * append issue type to screen scheme mappings to issue type screen schemes.
439
519
  * * remove issue type to screen scheme mappings from issue type screen schemes.
440
520
  * * update default screen scheme of issue type screen scheme.
521
+ *
522
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes
441
523
  */
442
524
  this.issueTypeScreenSchemes = new IssueTypeScreenSchemesService_1.IssueTypeScreenSchemesService(this.getClient);
443
525
  /**
@@ -447,16 +529,22 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
447
529
  * * get all issue types for a user.
448
530
  * * get alternative issue types.
449
531
  * * set an avatar for an issue type.
532
+ *
533
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types
450
534
  */
451
535
  this.issueTypes = new IssueTypesService_1.IssueTypesService(this.getClient);
452
536
  /**
453
537
  * This resource represents votes cast by users on an issue. Use it to get details
454
538
  * of votes on an issue as well as cast and withdrawal votes.
539
+ *
540
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-votes
455
541
  */
456
542
  this.issueVotes = new IssueVotesService_1.IssueVotesService(this.getClient);
457
543
  /**
458
544
  * This resource represents users watching an issue. Use it to get details of
459
545
  * users watching an issue as well as start and stop a user watching an issue.
546
+ *
547
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers
460
548
  */
461
549
  this.issueWatchers = new IssueWatchersService_1.IssueWatchersService(this.getClient);
462
550
  /**
@@ -465,6 +553,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
465
553
  * create, and delete issue worklog properties as well as obtain the keys of all
466
554
  * properties on a issue worklog. Issue worklog properties are a type of [entity
467
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-worklog-properties
468
558
  */
469
559
  this.issueWorklogProperties = new IssueWorklogPropertiesService_1.IssueWorklogPropertiesService(this.getClient);
470
560
  /**
@@ -472,22 +562,30 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
472
562
  *
473
563
  * * get, create, update, and delete worklogs.
474
564
  * * obtain lists of updated or deleted worklogs.
565
+ *
566
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs
475
567
  */
476
568
  this.issueWorklogs = new IssueWorklogsService_1.IssueWorklogsService(this.getClient);
477
569
  /**
478
570
  * This resource is a collection of operations for [Jira
479
571
  * expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
572
+ *
573
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-expressions
480
574
  */
481
575
  this.jiraExpressions = new JiraExpressionsService_1.JiraExpressionsService(this.getClient);
482
576
  /**
483
577
  * This resource represents various settings in Jira. Use it to get and update
484
578
  * Jira settings and properties.
579
+ *
580
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings
485
581
  */
486
582
  this.jiraSettings = new JiraSettingsService_1.JiraSettingsService(this.getClient);
487
583
  /**
488
584
  * This resource represents JQL function's precomputations. Precomputation is a
489
585
  * mapping between custom function call and JQL fragment returned by this
490
586
  * function. Use it to get and update precomputations.
587
+ *
588
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql-functions-apps-
491
589
  */
492
590
  this.jqlFunctionsApps = new JqlFunctionsAppsService_1.JqlFunctionsAppsService(this.getClient);
493
591
  /**
@@ -499,16 +597,22 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
499
597
  * key) to equivalent JQL queries with account IDs.
500
598
  * * convert readable details in one or more JQL queries to IDs where a user
501
599
  * doesn't have permission to view the entity whose details are readable.
600
+ *
601
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql
502
602
  */
503
603
  this.jql = new JqlService_1.JqlService(this.getClient);
504
604
  /**
505
605
  * This resource represents available labels. Use it to get available labels for
506
606
  * the global label field.
607
+ *
608
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels
507
609
  */
508
610
  this.labels = new LabelsService_1.LabelsService(this.getClient);
509
611
  /**
510
612
  * This resource represents license metrics. Use it to get available metrics for
511
613
  * Jira licences.
614
+ *
615
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics
512
616
  */
513
617
  this.licenseMetrics = new LicenseMetricsService_1.LicenseMetricsService(this.getClient);
514
618
  /**
@@ -516,27 +620,37 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
516
620
  * details, group membership, application roles, preferences, and locale. Use it
517
621
  * to get, create, update, and delete (restore default) values of the user's
518
622
  * preferences and locale.
623
+ *
624
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself
519
625
  */
520
626
  this.myself = new MyselfService_1.MyselfService(this.getClient);
521
627
  /**
522
628
  * This resource represents permission schemes. Use it to get, create, update, and
523
629
  * delete permission schemes as well as get, create, update, and delete details of
524
630
  * the permissions granted in those schemes.
631
+ *
632
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes
525
633
  */
526
634
  this.permissionSchemes = new PermissionSchemesService_1.PermissionSchemesService(this.getClient);
527
635
  /**
528
636
  * This resource represents permissions. Use it to obtain details of all
529
637
  * permissions and determine whether the user has certain permissions.
638
+ *
639
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions
530
640
  */
531
641
  this.permissions = new PermissionsService_1.PermissionsService(this.getClient);
532
642
  /**
533
643
  * This resource represents issue priority schemes. Use it to get priority schemes
534
644
  * and related information, and to create, update and delete priority schemes.
645
+ *
646
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes
535
647
  */
536
648
  this.prioritySchemes = new PrioritySchemesService_1.PrioritySchemesService(this.getClient);
537
649
  /**
538
650
  * This resource represents avatars associated with a project. Use it to get,
539
651
  * load, set, and remove project avatars.
652
+ *
653
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-avatars
540
654
  */
541
655
  this.projectAvatars = new ProjectAvatarsService_1.ProjectAvatarsService(this.getClient);
542
656
  /**
@@ -545,23 +659,31 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
545
659
  * and details of individual categories. For more information on managing project
546
660
  * categories, see [Adding, assigning, and deleting project
547
661
  * categories](https://confluence.atlassian.com/x/-A5WMg).
662
+ *
663
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories
548
664
  */
549
665
  this.projectCategories = new ProjectCategoriesService_1.ProjectCategoriesService(this.getClient);
550
666
  /**
551
667
  * This resource represents classification levels used in a project. Use it to
552
668
  * view and manage classification levels in your projects.
669
+ *
670
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels
553
671
  */
554
672
  this.projectClassificationLevels = new ProjectClassificationLevelsService_1.ProjectClassificationLevelsService(this.getClient);
555
673
  /**
556
674
  * This resource represents project components. Use it to get, create, update, and
557
675
  * delete project components. Also get components for project and get a count of
558
676
  * issues by component.
677
+ *
678
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components
559
679
  */
560
680
  this.projectComponents = new ProjectComponentsService_1.ProjectComponentsService(this.getClient);
561
681
  /**
562
682
  * This resource represents the email address used to send a project's
563
683
  * notifications. Use it to get and set the [project's sender email
564
684
  * address](https://confluence.atlassian.com/x/dolKLg).
685
+ *
686
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-email
565
687
  */
566
688
  this.projectEmail = new ProjectEmailService_1.ProjectEmailService(this.getClient);
567
689
  /**
@@ -569,9 +691,15 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
569
691
  * for a project and modify the state of a feature. The project feature endpoint
570
692
  * is available only for Jira Software, both for team- and company-managed
571
693
  * projects.
694
+ *
695
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-features
572
696
  */
573
697
  this.projectFeatures = new ProjectFeaturesService_1.ProjectFeaturesService(this.getClient);
574
- /** This resource provides validation for project keys and names. */
698
+ /**
699
+ * This resource provides validation for project keys and names.
700
+ *
701
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation
702
+ */
575
703
  this.projectKeyAndNameValidation = new ProjectKeyAndNameValidationService_1.ProjectKeyAndNameValidationService(this.getClient);
576
704
  /**
577
705
  * This resource represents permission schemes for a project. Use this resource to:
@@ -584,6 +712,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
584
712
  *
585
713
  * See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg)
586
714
  * for more information about permission schemes.
715
+ *
716
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-permission-schemes
587
717
  */
588
718
  this.projectPermissionSchemes = new ProjectPermissionSchemesService_1.ProjectPermissionSchemesService(this.getClient);
589
719
  /**
@@ -592,6 +722,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
592
722
  * delete project properties as well as get a list of property keys for a project.
593
723
  * Project properties are a type of [entity
594
724
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
725
+ *
726
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-properties
595
727
  */
596
728
  this.projectProperties = new ProjectPropertiesService_1.ProjectPropertiesService(this.getClient);
597
729
  /**
@@ -599,34 +731,46 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
599
731
  * roles](#api-group-Issue-comments). Use it to get, add, and remove default users
600
732
  * from project roles. Also use it to add and remove users from a project role
601
733
  * associated with a project.
734
+ *
735
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-role-actors
602
736
  */
603
737
  this.projectRoleActors = new ProjectRoleActorsService_1.ProjectRoleActorsService(this.getClient);
604
738
  /**
605
739
  * This resource represents the roles that users can play in projects. Use this
606
740
  * resource to get, create, update, and delete project roles.
741
+ *
742
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles
607
743
  */
608
744
  this.projectRoles = new ProjectRolesService_1.ProjectRolesService(this.getClient);
609
745
  /**
610
746
  * This resource represents projects. Use it to get, create, update, and delete
611
747
  * projects. Also get statuses available to a project, a project's notification
612
748
  * schemes, and update a project's type.
749
+ *
750
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects
613
751
  */
614
752
  this.projects = new ProjectsService_1.ProjectsService(this.getClient);
615
753
  /**
616
754
  * This resource represents project types. Use it to obtain a list of all project
617
755
  * types, a list of project types accessible to the calling user, and details of a
618
756
  * project type.
757
+ *
758
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types
619
759
  */
620
760
  this.projectTypes = new ProjectTypesService_1.ProjectTypesService(this.getClient);
621
761
  /**
622
762
  * This resource represents project versions. Use it to get, get lists of, create,
623
763
  * update, move, merge, and delete project versions. This resource also provides
624
764
  * counts of issues by version.
765
+ *
766
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions
625
767
  */
626
768
  this.projectVersions = new ProjectVersionsService_1.ProjectVersionsService(this.getClient);
627
769
  /**
628
770
  * This resource represents screen schemes in classic projects. Use it to get,
629
771
  * create, update, and delete screen schemes.
772
+ *
773
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes
630
774
  */
631
775
  this.screenSchemes = new ScreenSchemesService_1.ScreenSchemesService(this.getClient);
632
776
  /**
@@ -638,42 +782,60 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
638
782
  * * delete screens.
639
783
  * * update screens.
640
784
  * * add a field to the default screen.
785
+ *
786
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens
641
787
  */
642
788
  this.screens = new ScreensService_1.ScreensService(this.getClient);
643
789
  /**
644
790
  * This resource represents the screen tab fields used to record issue details.
645
791
  * Use it to get, add, move, and remove fields from screen tabs.
792
+ *
793
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields
646
794
  */
647
795
  this.screenTabFields = new ScreenTabFieldsService_1.ScreenTabFieldsService(this.getClient);
648
796
  /**
649
797
  * This resource represents the screen tabs used to record issue details. Use it
650
798
  * to get, create, update, move, and delete screen tabs.
799
+ *
800
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tabs
651
801
  */
652
802
  this.screenTabs = new ScreenTabsService_1.ScreenTabsService(this.getClient);
653
- /** This resource provides information about the Jira instance. */
803
+ /**
804
+ * This resource provides information about the Jira instance.
805
+ *
806
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info
807
+ */
654
808
  this.serverInfo = new ServerInfoService_1.ServerInfoService(this.getClient);
655
809
  /**
656
810
  * This resource represents a service registry. Use it to retrieve attributes
657
811
  * related to a [service
658
812
  * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
659
813
  * in JSM.
814
+ *
815
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry
660
816
  */
661
817
  this.serviceRegistry = new ServiceRegistryService_1.ServiceRegistryService(this.getClient);
662
818
  /**
663
819
  * This resource represents statuses. Use it to search, get, create, delete, and
664
820
  * change statuses.
821
+ *
822
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status
665
823
  */
666
824
  this.status = new StatusService_1.StatusService(this.getClient);
667
825
  /**
668
826
  * This resource represents a [long-running asynchronous
669
827
  * tasks](#async-operations). Use it to obtain details about the progress of a
670
828
  * long-running task or cancel a long-running task.
829
+ *
830
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks
671
831
  */
672
832
  this.tasks = new TasksService_1.TasksService(this.getClient);
673
833
  /**
674
834
  * This resource represents time tracking and time tracking providers. Use it to
675
835
  * get and set the time tracking provider, get and set the time tracking options,
676
836
  * and disable time tracking.
837
+ *
838
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking
677
839
  */
678
840
  this.timeTracking = new TimeTrackingService_1.TimeTrackingService(this.getClient);
679
841
  /**
@@ -681,6 +843,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
681
843
  * Forge apps to control how selected Jira fields behave on the following views:
682
844
  * global issue create, issue view. For example: hide specific fields, set them as
683
845
  * required, etc.
846
+ *
847
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-
684
848
  */
685
849
  this.uiModificationsApps = new UiModificationsAppsService_1.UiModificationsAppsService(this.getClient);
686
850
  /**
@@ -695,6 +859,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
695
859
  * This resource does not access the [user
696
860
  * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
697
861
  * Jira.
862
+ *
863
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties
698
864
  */
699
865
  this.userProperties = new UserPropertiesService_1.UserPropertiesService(this.getClient);
700
866
  /**
@@ -703,6 +869,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
703
869
  * with permissions, user lists for pickup fields, and user lists generated using
704
870
  * structured queries. Note that the operations in this resource only return users
705
871
  * found within the first 1000 users.
872
+ *
873
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search
706
874
  */
707
875
  this.userSearch = new UserSearchService_1.UserSearchService(this.getClient);
708
876
  /**
@@ -712,6 +880,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
712
880
  * * get, set, and reset a user's default issue table columns.
713
881
  * * get a list of the groups the user belongs to.
714
882
  * * get a list of user account IDs for a list of usernames or user keys.
883
+ *
884
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users
715
885
  */
716
886
  this.users = new UsersService_1.UsersService(this.getClient);
717
887
  /**
@@ -719,6 +889,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
719
889
  * event occurs in Jira for issues specified by a JQL query. Only Connect and
720
890
  * OAuth 2.0 apps can register and manage webhooks. For more information, see
721
891
  * [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).
892
+ *
893
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks
722
894
  */
723
895
  this.webhooks = new WebhooksService_1.WebhooksService(this.getClient);
724
896
  /**
@@ -736,6 +908,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
736
908
  *
737
909
  * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
738
910
  * for more information.
911
+ *
912
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-drafts
739
913
  */
740
914
  this.workflowSchemeDrafts = new WorkflowSchemeDraftsService_1.WorkflowSchemeDraftsService(this.getClient);
741
915
  /**
@@ -743,6 +917,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
743
917
  *
744
918
  * For more information, see [Managing your
745
919
  * workflows](https://confluence.atlassian.com/x/q4hKLg).
920
+ *
921
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations
746
922
  */
747
923
  this.workflowSchemeProjectAssociations = new WorkflowSchemeProjectAssociationsService_1.WorkflowSchemeProjectAssociationsService(this.getClient);
748
924
  /**
@@ -760,6 +936,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
760
936
  *
761
937
  * See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg)
762
938
  * for more information.
939
+ *
940
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes
763
941
  */
764
942
  this.workflowSchemes = new WorkflowSchemesService_1.WorkflowSchemesService(this.getClient);
765
943
  /**
@@ -770,17 +948,23 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
770
948
  * * Update workflows
771
949
  * * Delete inactive workflows
772
950
  * * Get workflow capabilities
951
+ *
952
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows
773
953
  */
774
954
  this.workflows = new WorkflowsService_1.WorkflowsService(this.getClient);
775
955
  /**
776
956
  * This resource represents status categories. Use it to obtain a list of all
777
957
  * status categories and the details of a category. Status categories provided a
778
958
  * mechanism for categorizing [statuses](#api-group-Workflow-statuses).
959
+ *
960
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-status-categories
779
961
  */
780
962
  this.workflowStatusCategories = new WorkflowStatusCategoriesService_1.WorkflowStatusCategoriesService(this.getClient);
781
963
  /**
782
964
  * This resource represents issue workflow statuses. Use it to obtain a list of
783
965
  * all statuses associated with workflows and the details of a status.
966
+ *
967
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-statuses
784
968
  */
785
969
  this.workflowStatuses = new WorkflowStatusesService_1.WorkflowStatusesService(this.getClient);
786
970
  /**
@@ -789,6 +973,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
789
973
  * delete workflow transition properties as well as get a list of property keys
790
974
  * for a workflow transition. Workflow transition properties are a type of [entity
791
975
  * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
976
+ *
977
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties
792
978
  */
793
979
  this.workflowTransitionProperties = new WorkflowTransitionPropertiesService_1.WorkflowTransitionPropertiesService(this.getClient);
794
980
  /**
@@ -797,6 +983,8 @@ class BaseJiraPlatformApiClient extends CommonHttpService_1.CommonHttpService {
797
983
  * functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
798
984
  * that is executed in association with the workflow. Use it to read and modify
799
985
  * configuration of workflow transition rules.
986
+ *
987
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules
800
988
  */
801
989
  this.workflowTransitionRules = new WorkflowTransitionRulesService_1.WorkflowTransitionRulesService(this.getClient);
802
990
  this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));