@resolution/jira-api-client 0.5.2 → 0.5.4

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 (515) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +51 -19
  3. package/lib/openapi/{platform/core → core}/CommonHttpClient.d.ts +54 -3
  4. package/lib/openapi/{serviceManagement/core → core}/CommonHttpClient.js +14 -0
  5. package/lib/openapi/core/CommonHttpClient.js.map +1 -0
  6. package/lib/openapi/{software/core → core}/CommonHttpService.d.ts +17 -0
  7. package/lib/openapi/{platform/core → core}/CommonHttpService.js +11 -0
  8. package/lib/openapi/core/CommonHttpService.js.map +1 -0
  9. package/lib/openapi/core/CommonValidationSchemaStorage.js.map +1 -0
  10. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +5 -5
  11. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +3 -3
  12. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  13. package/lib/openapi/platform/models/announcementBanner.d.ts +1 -1
  14. package/lib/openapi/platform/models/appDataPolicies.d.ts +1 -1
  15. package/lib/openapi/platform/models/appMigration.d.ts +13 -7
  16. package/lib/openapi/platform/models/appMigration.js.map +1 -1
  17. package/lib/openapi/platform/models/appProperties.d.ts +3 -2
  18. package/lib/openapi/platform/models/appProperties.js.map +1 -1
  19. package/lib/openapi/platform/models/auditRecords.d.ts +1 -1
  20. package/lib/openapi/platform/models/avatars.d.ts +1 -1
  21. package/lib/openapi/platform/models/classificationLevels.d.ts +1 -1
  22. package/lib/openapi/platform/models/common.d.ts +3 -5
  23. package/lib/openapi/platform/models/common.js.map +1 -1
  24. package/lib/openapi/platform/models/dashboards.d.ts +2 -3
  25. package/lib/openapi/platform/models/dashboards.js.map +1 -1
  26. package/lib/openapi/platform/models/dynamicModules.d.ts +5 -3
  27. package/lib/openapi/platform/models/dynamicModules.js.map +1 -1
  28. package/lib/openapi/platform/models/filterSharing.d.ts +1 -1
  29. package/lib/openapi/platform/models/filters.d.ts +1 -1
  30. package/lib/openapi/platform/models/groupAndUserPicker.d.ts +1 -1
  31. package/lib/openapi/platform/models/groups.d.ts +1 -1
  32. package/lib/openapi/platform/models/issueAttachments.d.ts +1 -1
  33. package/lib/openapi/platform/models/issueBulkOperations.d.ts +2 -3
  34. package/lib/openapi/platform/models/issueBulkOperations.js.map +1 -1
  35. package/lib/openapi/platform/models/issueCommentProperties.d.ts +1 -1
  36. package/lib/openapi/platform/models/issueComments.d.ts +1 -1
  37. package/lib/openapi/platform/models/issueCustomFieldConfigurationApps.d.ts +1 -1
  38. package/lib/openapi/platform/models/issueCustomFieldContexts.d.ts +1 -1
  39. package/lib/openapi/platform/models/issueCustomFieldOptions.d.ts +1 -1
  40. package/lib/openapi/platform/models/issueCustomFieldOptionsApps.d.ts +1 -1
  41. package/lib/openapi/platform/models/issueCustomFieldValuesApps.d.ts +1 -1
  42. package/lib/openapi/platform/models/issueFieldConfigurations.d.ts +1 -1
  43. package/lib/openapi/platform/models/issueFields.d.ts +1 -1
  44. package/lib/openapi/platform/models/issueLinkTypes.d.ts +1 -1
  45. package/lib/openapi/platform/models/issueLinks.d.ts +1 -1
  46. package/lib/openapi/platform/models/issueNotificationSchemes.d.ts +1 -1
  47. package/lib/openapi/platform/models/issuePriorities.d.ts +1 -1
  48. package/lib/openapi/platform/models/issueProperties.d.ts +1 -1
  49. package/lib/openapi/platform/models/issueRemoteLinks.d.ts +1 -1
  50. package/lib/openapi/platform/models/issueResolutions.d.ts +1 -1
  51. package/lib/openapi/platform/models/issueSearch.d.ts +2 -3
  52. package/lib/openapi/platform/models/issueSearch.js.map +1 -1
  53. package/lib/openapi/platform/models/issueSecurityLevel.d.ts +1 -1
  54. package/lib/openapi/platform/models/issueSecuritySchemes.d.ts +1 -1
  55. package/lib/openapi/platform/models/issueTypeSchemes.d.ts +1 -1
  56. package/lib/openapi/platform/models/issueTypeScreenSchemes.d.ts +1 -1
  57. package/lib/openapi/platform/models/issueTypes.d.ts +1 -1
  58. package/lib/openapi/platform/models/issueVotes.d.ts +1 -1
  59. package/lib/openapi/platform/models/issueWatchers.d.ts +1 -1
  60. package/lib/openapi/platform/models/issueWorklogs.d.ts +1 -1
  61. package/lib/openapi/platform/models/issues.d.ts +16 -14
  62. package/lib/openapi/platform/models/issues.js.map +1 -1
  63. package/lib/openapi/platform/models/jiraExpressions.d.ts +8 -6
  64. package/lib/openapi/platform/models/jiraExpressions.js.map +1 -1
  65. package/lib/openapi/platform/models/jiraSettings.d.ts +1 -1
  66. package/lib/openapi/platform/models/jql.d.ts +9 -5
  67. package/lib/openapi/platform/models/jql.js.map +1 -1
  68. package/lib/openapi/platform/models/jqlFunctionsApps.d.ts +1 -1
  69. package/lib/openapi/platform/models/labels.d.ts +1 -1
  70. package/lib/openapi/platform/models/licenseMetrics.d.ts +1 -1
  71. package/lib/openapi/platform/models/myself.d.ts +1 -1
  72. package/lib/openapi/platform/models/permissionSchemes.d.ts +1 -1
  73. package/lib/openapi/platform/models/permissions.d.ts +2 -3
  74. package/lib/openapi/platform/models/permissions.js.map +1 -1
  75. package/lib/openapi/platform/models/prioritySchemes.d.ts +1 -1
  76. package/lib/openapi/platform/models/projectAvatars.d.ts +1 -1
  77. package/lib/openapi/platform/models/projectClassificationLevels.d.ts +1 -1
  78. package/lib/openapi/platform/models/projectComponents.d.ts +1 -1
  79. package/lib/openapi/platform/models/projectEmail.d.ts +1 -1
  80. package/lib/openapi/platform/models/projectFeatures.d.ts +1 -1
  81. package/lib/openapi/platform/models/projectPermissionSchemes.d.ts +1 -1
  82. package/lib/openapi/platform/models/projectRoleActors.d.ts +1 -1
  83. package/lib/openapi/platform/models/projectRoles.d.ts +1 -1
  84. package/lib/openapi/platform/models/projectTypes.d.ts +1 -1
  85. package/lib/openapi/platform/models/projectVersions.d.ts +1 -1
  86. package/lib/openapi/platform/models/projects.d.ts +1 -1
  87. package/lib/openapi/platform/models/screenSchemes.d.ts +2 -2
  88. package/lib/openapi/platform/models/screenSchemes.js +1 -1
  89. package/lib/openapi/platform/models/screenSchemes.js.map +1 -1
  90. package/lib/openapi/platform/models/screenTabFields.d.ts +1 -1
  91. package/lib/openapi/platform/models/screens.d.ts +1 -1
  92. package/lib/openapi/platform/models/serverInfo.d.ts +1 -1
  93. package/lib/openapi/platform/models/serviceRegistry.d.ts +3 -2
  94. package/lib/openapi/platform/models/serviceRegistry.js.map +1 -1
  95. package/lib/openapi/platform/models/status.d.ts +1 -1
  96. package/lib/openapi/platform/models/timeTracking.d.ts +1 -1
  97. package/lib/openapi/platform/models/uiModificationsApps.d.ts +1 -1
  98. package/lib/openapi/platform/models/userSearch.d.ts +1 -1
  99. package/lib/openapi/platform/models/users.d.ts +1 -1
  100. package/lib/openapi/platform/models/webhooks.d.ts +1 -1
  101. package/lib/openapi/platform/models/workflowSchemeDrafts.d.ts +1 -1
  102. package/lib/openapi/platform/models/workflowSchemeProjectAssociations.d.ts +1 -1
  103. package/lib/openapi/platform/models/workflowSchemes.d.ts +1 -1
  104. package/lib/openapi/platform/models/workflowTransitionProperties.d.ts +1 -1
  105. package/lib/openapi/platform/models/workflowTransitionRules.d.ts +1 -1
  106. package/lib/openapi/platform/models/workflows.d.ts +104 -70
  107. package/lib/openapi/platform/models/workflows.js +12 -0
  108. package/lib/openapi/platform/models/workflows.js.map +1 -1
  109. package/lib/openapi/platform/services/AnnouncementBannerService.d.ts +12 -9
  110. package/lib/openapi/platform/services/AnnouncementBannerService.js +10 -7
  111. package/lib/openapi/platform/services/AnnouncementBannerService.js.map +1 -1
  112. package/lib/openapi/platform/services/AppDataPoliciesService.d.ts +12 -5
  113. package/lib/openapi/platform/services/AppDataPoliciesService.js +13 -6
  114. package/lib/openapi/platform/services/AppDataPoliciesService.js.map +1 -1
  115. package/lib/openapi/platform/services/AppMigrationService.d.ts +13 -6
  116. package/lib/openapi/platform/services/AppMigrationService.js +12 -6
  117. package/lib/openapi/platform/services/AppMigrationService.js.map +1 -1
  118. package/lib/openapi/platform/services/AppPropertiesService.d.ts +43 -19
  119. package/lib/openapi/platform/services/AppPropertiesService.js +44 -20
  120. package/lib/openapi/platform/services/AppPropertiesService.js.map +1 -1
  121. package/lib/openapi/platform/services/ApplicationRolesService.d.ts +20 -21
  122. package/lib/openapi/platform/services/ApplicationRolesService.js +21 -22
  123. package/lib/openapi/platform/services/ApplicationRolesService.js.map +1 -1
  124. package/lib/openapi/platform/services/AuditRecordsService.d.ts +7 -3
  125. package/lib/openapi/platform/services/AuditRecordsService.js +8 -4
  126. package/lib/openapi/platform/services/AuditRecordsService.js.map +1 -1
  127. package/lib/openapi/platform/services/AvatarsService.d.ts +45 -38
  128. package/lib/openapi/platform/services/AvatarsService.js +45 -38
  129. package/lib/openapi/platform/services/AvatarsService.js.map +1 -1
  130. package/lib/openapi/platform/services/ClassificationLevelsService.d.ts +16 -22
  131. package/lib/openapi/platform/services/ClassificationLevelsService.js +17 -23
  132. package/lib/openapi/platform/services/ClassificationLevelsService.js.map +1 -1
  133. package/lib/openapi/platform/services/DashboardsService.d.ts +140 -146
  134. package/lib/openapi/platform/services/DashboardsService.js +122 -130
  135. package/lib/openapi/platform/services/DashboardsService.js.map +1 -1
  136. package/lib/openapi/platform/services/DynamicModulesService.d.ts +6 -4
  137. package/lib/openapi/platform/services/DynamicModulesService.js +7 -5
  138. package/lib/openapi/platform/services/DynamicModulesService.js.map +1 -1
  139. package/lib/openapi/platform/services/FilterSharingService.d.ts +73 -96
  140. package/lib/openapi/platform/services/FilterSharingService.js +70 -95
  141. package/lib/openapi/platform/services/FilterSharingService.js.map +1 -1
  142. package/lib/openapi/platform/services/FiltersService.d.ts +179 -258
  143. package/lib/openapi/platform/services/FiltersService.js +174 -256
  144. package/lib/openapi/platform/services/FiltersService.js.map +1 -1
  145. package/lib/openapi/platform/services/GroupAndUserPickerService.d.ts +9 -7
  146. package/lib/openapi/platform/services/GroupAndUserPickerService.js +10 -8
  147. package/lib/openapi/platform/services/GroupAndUserPickerService.js.map +1 -1
  148. package/lib/openapi/platform/services/GroupsService.d.ts +43 -27
  149. package/lib/openapi/platform/services/GroupsService.js +40 -26
  150. package/lib/openapi/platform/services/GroupsService.js.map +1 -1
  151. package/lib/openapi/platform/services/IssueAttachmentsService.d.ts +174 -170
  152. package/lib/openapi/platform/services/IssueAttachmentsService.js +175 -171
  153. package/lib/openapi/platform/services/IssueAttachmentsService.js.map +1 -1
  154. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +36 -20
  155. package/lib/openapi/platform/services/IssueBulkOperationsService.js +35 -20
  156. package/lib/openapi/platform/services/IssueBulkOperationsService.js.map +1 -1
  157. package/lib/openapi/platform/services/IssueCommentPropertiesService.d.ts +20 -10
  158. package/lib/openapi/platform/services/IssueCommentPropertiesService.js +21 -11
  159. package/lib/openapi/platform/services/IssueCommentPropertiesService.js.map +1 -1
  160. package/lib/openapi/platform/services/IssueCommentsService.d.ts +66 -81
  161. package/lib/openapi/platform/services/IssueCommentsService.js +59 -71
  162. package/lib/openapi/platform/services/IssueCommentsService.js.map +1 -1
  163. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.d.ts +11 -5
  164. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js +10 -5
  165. package/lib/openapi/platform/services/IssueCustomFieldConfigurationAppsService.js.map +1 -1
  166. package/lib/openapi/platform/services/IssueCustomFieldContextsService.d.ts +72 -38
  167. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js +55 -27
  168. package/lib/openapi/platform/services/IssueCustomFieldContextsService.js.map +1 -1
  169. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.d.ts +51 -29
  170. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js +48 -28
  171. package/lib/openapi/platform/services/IssueCustomFieldOptionsAppsService.js.map +1 -1
  172. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.d.ts +38 -17
  173. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js +33 -15
  174. package/lib/openapi/platform/services/IssueCustomFieldOptionsService.js.map +1 -1
  175. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.d.ts +9 -5
  176. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js +6 -4
  177. package/lib/openapi/platform/services/IssueCustomFieldValuesAppsService.js.map +1 -1
  178. package/lib/openapi/platform/services/IssueFieldConfigurationsService.d.ts +78 -35
  179. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js +63 -28
  180. package/lib/openapi/platform/services/IssueFieldConfigurationsService.js.map +1 -1
  181. package/lib/openapi/platform/services/IssueFieldsService.d.ts +57 -47
  182. package/lib/openapi/platform/services/IssueFieldsService.js +52 -42
  183. package/lib/openapi/platform/services/IssueFieldsService.js.map +1 -1
  184. package/lib/openapi/platform/services/IssueLinkTypesService.d.ts +30 -12
  185. package/lib/openapi/platform/services/IssueLinkTypesService.js +27 -11
  186. package/lib/openapi/platform/services/IssueLinkTypesService.js.map +1 -1
  187. package/lib/openapi/platform/services/IssueLinksService.d.ts +21 -24
  188. package/lib/openapi/platform/services/IssueLinksService.js +20 -24
  189. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  190. package/lib/openapi/platform/services/IssueNavigatorSettingsService.d.ts +8 -4
  191. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js +9 -5
  192. package/lib/openapi/platform/services/IssueNavigatorSettingsService.js.map +1 -1
  193. package/lib/openapi/platform/services/IssueNotificationSchemesService.d.ts +64 -70
  194. package/lib/openapi/platform/services/IssueNotificationSchemesService.js +59 -68
  195. package/lib/openapi/platform/services/IssueNotificationSchemesService.js.map +1 -1
  196. package/lib/openapi/platform/services/IssuePrioritiesService.d.ts +45 -27
  197. package/lib/openapi/platform/services/IssuePrioritiesService.js +38 -24
  198. package/lib/openapi/platform/services/IssuePrioritiesService.js.map +1 -1
  199. package/lib/openapi/platform/services/IssuePropertiesService.d.ts +34 -17
  200. package/lib/openapi/platform/services/IssuePropertiesService.js +29 -15
  201. package/lib/openapi/platform/services/IssuePropertiesService.js.map +1 -1
  202. package/lib/openapi/platform/services/IssueRemoteLinksService.d.ts +42 -28
  203. package/lib/openapi/platform/services/IssueRemoteLinksService.js +39 -27
  204. package/lib/openapi/platform/services/IssueRemoteLinksService.js.map +1 -1
  205. package/lib/openapi/platform/services/IssueResolutionsService.d.ts +40 -17
  206. package/lib/openapi/platform/services/IssueResolutionsService.js +33 -14
  207. package/lib/openapi/platform/services/IssueResolutionsService.js.map +1 -1
  208. package/lib/openapi/platform/services/IssueSearchService.d.ts +86 -139
  209. package/lib/openapi/platform/services/IssueSearchService.js +81 -137
  210. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  211. package/lib/openapi/platform/services/IssueSecurityLevelService.d.ts +20 -19
  212. package/lib/openapi/platform/services/IssueSecurityLevelService.js +21 -20
  213. package/lib/openapi/platform/services/IssueSecurityLevelService.js.map +1 -1
  214. package/lib/openapi/platform/services/IssueSecuritySchemesService.d.ts +78 -40
  215. package/lib/openapi/platform/services/IssueSecuritySchemesService.js +65 -34
  216. package/lib/openapi/platform/services/IssueSecuritySchemesService.js.map +1 -1
  217. package/lib/openapi/platform/services/IssueTypePropertiesService.d.ts +22 -11
  218. package/lib/openapi/platform/services/IssueTypePropertiesService.js +21 -11
  219. package/lib/openapi/platform/services/IssueTypePropertiesService.js.map +1 -1
  220. package/lib/openapi/platform/services/IssueTypeSchemesService.d.ts +53 -34
  221. package/lib/openapi/platform/services/IssueTypeSchemesService.js +42 -26
  222. package/lib/openapi/platform/services/IssueTypeSchemesService.js.map +1 -1
  223. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.d.ts +56 -27
  224. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js +45 -22
  225. package/lib/openapi/platform/services/IssueTypeScreenSchemesService.js.map +1 -1
  226. package/lib/openapi/platform/services/IssueTypesService.d.ts +53 -42
  227. package/lib/openapi/platform/services/IssueTypesService.js +50 -41
  228. package/lib/openapi/platform/services/IssueTypesService.js.map +1 -1
  229. package/lib/openapi/platform/services/IssueVotesService.d.ts +17 -17
  230. package/lib/openapi/platform/services/IssueVotesService.js +18 -18
  231. package/lib/openapi/platform/services/IssueVotesService.js.map +1 -1
  232. package/lib/openapi/platform/services/IssueWatchersService.d.ts +20 -10
  233. package/lib/openapi/platform/services/IssueWatchersService.js +19 -10
  234. package/lib/openapi/platform/services/IssueWatchersService.js.map +1 -1
  235. package/lib/openapi/platform/services/IssueWorklogPropertiesService.d.ts +20 -13
  236. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js +21 -14
  237. package/lib/openapi/platform/services/IssueWorklogPropertiesService.js.map +1 -1
  238. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +69 -67
  239. package/lib/openapi/platform/services/IssueWorklogsService.js +64 -65
  240. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  241. package/lib/openapi/platform/services/IssuesService.d.ts +226 -228
  242. package/lib/openapi/platform/services/IssuesService.js +197 -209
  243. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  244. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +25 -24
  245. package/lib/openapi/platform/services/JiraExpressionsService.js +21 -20
  246. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  247. package/lib/openapi/platform/services/JiraSettingsService.d.ts +21 -9
  248. package/lib/openapi/platform/services/JiraSettingsService.js +20 -9
  249. package/lib/openapi/platform/services/JiraSettingsService.js.map +1 -1
  250. package/lib/openapi/platform/services/JqlFunctionsAppsService.d.ts +13 -9
  251. package/lib/openapi/platform/services/JqlFunctionsAppsService.js +12 -9
  252. package/lib/openapi/platform/services/JqlFunctionsAppsService.js.map +1 -1
  253. package/lib/openapi/platform/services/JqlService.d.ts +55 -43
  254. package/lib/openapi/platform/services/JqlService.js +45 -33
  255. package/lib/openapi/platform/services/JqlService.js.map +1 -1
  256. package/lib/openapi/platform/services/LabelsService.d.ts +7 -3
  257. package/lib/openapi/platform/services/LabelsService.js +8 -4
  258. package/lib/openapi/platform/services/LabelsService.js.map +1 -1
  259. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +17 -7
  260. package/lib/openapi/platform/services/LicenseMetricsService.js +18 -8
  261. package/lib/openapi/platform/services/LicenseMetricsService.js.map +1 -1
  262. package/lib/openapi/platform/services/MyselfService.d.ts +28 -21
  263. package/lib/openapi/platform/services/MyselfService.js +27 -21
  264. package/lib/openapi/platform/services/MyselfService.js.map +1 -1
  265. package/lib/openapi/platform/services/PermissionSchemesService.d.ts +67 -55
  266. package/lib/openapi/platform/services/PermissionSchemesService.js +62 -53
  267. package/lib/openapi/platform/services/PermissionSchemesService.js.map +1 -1
  268. package/lib/openapi/platform/services/PermissionsService.d.ts +23 -11
  269. package/lib/openapi/platform/services/PermissionsService.js +22 -11
  270. package/lib/openapi/platform/services/PermissionsService.js.map +1 -1
  271. package/lib/openapi/platform/services/PrioritySchemesService.d.ts +60 -26
  272. package/lib/openapi/platform/services/PrioritySchemesService.js +54 -23
  273. package/lib/openapi/platform/services/PrioritySchemesService.js.map +1 -1
  274. package/lib/openapi/platform/services/ProjectAvatarsService.d.ts +27 -24
  275. package/lib/openapi/platform/services/ProjectAvatarsService.js +26 -24
  276. package/lib/openapi/platform/services/ProjectAvatarsService.js.map +1 -1
  277. package/lib/openapi/platform/services/ProjectCategoriesService.d.ts +30 -12
  278. package/lib/openapi/platform/services/ProjectCategoriesService.js +27 -11
  279. package/lib/openapi/platform/services/ProjectCategoriesService.js.map +1 -1
  280. package/lib/openapi/platform/services/ProjectClassificationLevelsService.d.ts +17 -14
  281. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js +15 -12
  282. package/lib/openapi/platform/services/ProjectClassificationLevelsService.js.map +1 -1
  283. package/lib/openapi/platform/services/ProjectComponentsService.d.ts +198 -321
  284. package/lib/openapi/platform/services/ProjectComponentsService.js +195 -320
  285. package/lib/openapi/platform/services/ProjectComponentsService.js.map +1 -1
  286. package/lib/openapi/platform/services/ProjectEmailService.d.ts +11 -5
  287. package/lib/openapi/platform/services/ProjectEmailService.js +10 -5
  288. package/lib/openapi/platform/services/ProjectEmailService.js.map +1 -1
  289. package/lib/openapi/platform/services/ProjectFeaturesService.d.ts +23 -22
  290. package/lib/openapi/platform/services/ProjectFeaturesService.js +22 -22
  291. package/lib/openapi/platform/services/ProjectFeaturesService.js.map +1 -1
  292. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.d.ts +19 -7
  293. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js +20 -8
  294. package/lib/openapi/platform/services/ProjectKeyAndNameValidationService.js.map +1 -1
  295. package/lib/openapi/platform/services/ProjectPermissionSchemesService.d.ts +32 -23
  296. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js +31 -23
  297. package/lib/openapi/platform/services/ProjectPermissionSchemesService.js.map +1 -1
  298. package/lib/openapi/platform/services/ProjectPropertiesService.d.ts +22 -11
  299. package/lib/openapi/platform/services/ProjectPropertiesService.js +21 -11
  300. package/lib/openapi/platform/services/ProjectPropertiesService.js.map +1 -1
  301. package/lib/openapi/platform/services/ProjectRoleActorsService.d.ts +47 -33
  302. package/lib/openapi/platform/services/ProjectRoleActorsService.js +42 -31
  303. package/lib/openapi/platform/services/ProjectRoleActorsService.js.map +1 -1
  304. package/lib/openapi/platform/services/ProjectRolesService.d.ts +67 -43
  305. package/lib/openapi/platform/services/ProjectRolesService.js +62 -41
  306. package/lib/openapi/platform/services/ProjectRolesService.js.map +1 -1
  307. package/lib/openapi/platform/services/ProjectTypesService.d.ts +29 -21
  308. package/lib/openapi/platform/services/ProjectTypesService.js +30 -22
  309. package/lib/openapi/platform/services/ProjectTypesService.js.map +1 -1
  310. package/lib/openapi/platform/services/ProjectVersionsService.d.ts +87 -36
  311. package/lib/openapi/platform/services/ProjectVersionsService.js +78 -32
  312. package/lib/openapi/platform/services/ProjectVersionsService.js.map +1 -1
  313. package/lib/openapi/platform/services/ProjectsService.d.ts +207 -313
  314. package/lib/openapi/platform/services/ProjectsService.js +203 -310
  315. package/lib/openapi/platform/services/ProjectsService.js.map +1 -1
  316. package/lib/openapi/platform/services/ScreenSchemesService.d.ts +22 -11
  317. package/lib/openapi/platform/services/ScreenSchemesService.js +19 -10
  318. package/lib/openapi/platform/services/ScreenSchemesService.js.map +1 -1
  319. package/lib/openapi/platform/services/ScreenTabFieldsService.d.ts +15 -7
  320. package/lib/openapi/platform/services/ScreenTabFieldsService.js +14 -7
  321. package/lib/openapi/platform/services/ScreenTabFieldsService.js.map +1 -1
  322. package/lib/openapi/platform/services/ScreenTabsService.d.ts +27 -11
  323. package/lib/openapi/platform/services/ScreenTabsService.js +26 -11
  324. package/lib/openapi/platform/services/ScreenTabsService.js.map +1 -1
  325. package/lib/openapi/platform/services/ScreensService.d.ts +42 -28
  326. package/lib/openapi/platform/services/ScreensService.js +38 -25
  327. package/lib/openapi/platform/services/ScreensService.js.map +1 -1
  328. package/lib/openapi/platform/services/ServerInfoService.d.ts +6 -3
  329. package/lib/openapi/platform/services/ServerInfoService.js +7 -4
  330. package/lib/openapi/platform/services/ServerInfoService.js.map +1 -1
  331. package/lib/openapi/platform/services/ServiceRegistryService.d.ts +5 -3
  332. package/lib/openapi/platform/services/ServiceRegistryService.js +4 -3
  333. package/lib/openapi/platform/services/ServiceRegistryService.js.map +1 -1
  334. package/lib/openapi/platform/services/StatusService.d.ts +29 -15
  335. package/lib/openapi/platform/services/StatusService.js +26 -14
  336. package/lib/openapi/platform/services/StatusService.js.map +1 -1
  337. package/lib/openapi/platform/services/TasksService.d.ts +9 -4
  338. package/lib/openapi/platform/services/TasksService.js +10 -5
  339. package/lib/openapi/platform/services/TasksService.js.map +1 -1
  340. package/lib/openapi/platform/services/TimeTrackingService.d.ts +31 -14
  341. package/lib/openapi/platform/services/TimeTrackingService.js +27 -12
  342. package/lib/openapi/platform/services/TimeTrackingService.js.map +1 -1
  343. package/lib/openapi/platform/services/UiModificationsAppsService.d.ts +26 -19
  344. package/lib/openapi/platform/services/UiModificationsAppsService.js +23 -18
  345. package/lib/openapi/platform/services/UiModificationsAppsService.js.map +1 -1
  346. package/lib/openapi/platform/services/UserPropertiesService.d.ts +20 -10
  347. package/lib/openapi/platform/services/UserPropertiesService.js +21 -11
  348. package/lib/openapi/platform/services/UserPropertiesService.js.map +1 -1
  349. package/lib/openapi/platform/services/UserSearchService.d.ts +95 -126
  350. package/lib/openapi/platform/services/UserSearchService.js +96 -127
  351. package/lib/openapi/platform/services/UserSearchService.js.map +1 -1
  352. package/lib/openapi/platform/services/UsersService.d.ts +97 -95
  353. package/lib/openapi/platform/services/UsersService.js +96 -95
  354. package/lib/openapi/platform/services/UsersService.js.map +1 -1
  355. package/lib/openapi/platform/services/WebhooksService.d.ts +35 -18
  356. package/lib/openapi/platform/services/WebhooksService.js +30 -16
  357. package/lib/openapi/platform/services/WebhooksService.js.map +1 -1
  358. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.d.ts +133 -147
  359. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js +124 -143
  360. package/lib/openapi/platform/services/WorkflowSchemeDraftsService.js.map +1 -1
  361. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.d.ts +13 -10
  362. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js +12 -10
  363. package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map +1 -1
  364. package/lib/openapi/platform/services/WorkflowSchemesService.d.ts +121 -82
  365. package/lib/openapi/platform/services/WorkflowSchemesService.js +106 -75
  366. package/lib/openapi/platform/services/WorkflowSchemesService.js.map +1 -1
  367. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.d.ts +12 -5
  368. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js +13 -6
  369. package/lib/openapi/platform/services/WorkflowStatusCategoriesService.js.map +1 -1
  370. package/lib/openapi/platform/services/WorkflowStatusesService.d.ts +12 -5
  371. package/lib/openapi/platform/services/WorkflowStatusesService.js +13 -6
  372. package/lib/openapi/platform/services/WorkflowStatusesService.js.map +1 -1
  373. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.d.ts +25 -10
  374. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js +22 -9
  375. package/lib/openapi/platform/services/WorkflowTransitionPropertiesService.js.map +1 -1
  376. package/lib/openapi/platform/services/WorkflowTransitionRulesService.d.ts +25 -13
  377. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js +22 -12
  378. package/lib/openapi/platform/services/WorkflowTransitionRulesService.js.map +1 -1
  379. package/lib/openapi/platform/services/WorkflowsService.d.ts +791 -693
  380. package/lib/openapi/platform/services/WorkflowsService.js +754 -644
  381. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  382. package/lib/openapi/platform/validationSchemaStorage.d.ts +1 -1
  383. package/lib/openapi/platform/validationSchemaStorage.js +1 -1
  384. package/lib/openapi/platform/validationSchemaStorage.js.map +1 -1
  385. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +3 -3
  386. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +3 -3
  387. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js.map +1 -1
  388. package/lib/openapi/serviceManagement/models/assets.d.ts +1 -1
  389. package/lib/openapi/serviceManagement/models/common.d.ts +1 -1
  390. package/lib/openapi/serviceManagement/models/customer.d.ts +1 -1
  391. package/lib/openapi/serviceManagement/models/info.d.ts +1 -1
  392. package/lib/openapi/serviceManagement/models/knowledgebase.d.ts +1 -1
  393. package/lib/openapi/serviceManagement/models/organization.d.ts +1 -1
  394. package/lib/openapi/serviceManagement/models/request.d.ts +1 -1
  395. package/lib/openapi/serviceManagement/models/servicedesk.d.ts +4 -7
  396. package/lib/openapi/serviceManagement/models/servicedesk.js.map +1 -1
  397. package/lib/openapi/serviceManagement/services/AssetsService.d.ts +11 -8
  398. package/lib/openapi/serviceManagement/services/AssetsService.js +12 -9
  399. package/lib/openapi/serviceManagement/services/AssetsService.js.map +1 -1
  400. package/lib/openapi/serviceManagement/services/CustomerService.d.ts +17 -20
  401. package/lib/openapi/serviceManagement/services/CustomerService.js +16 -20
  402. package/lib/openapi/serviceManagement/services/CustomerService.js.map +1 -1
  403. package/lib/openapi/serviceManagement/services/InfoService.d.ts +6 -3
  404. package/lib/openapi/serviceManagement/services/InfoService.js +7 -4
  405. package/lib/openapi/serviceManagement/services/InfoService.js.map +1 -1
  406. package/lib/openapi/serviceManagement/services/KnowledgebaseService.d.ts +11 -11
  407. package/lib/openapi/serviceManagement/services/KnowledgebaseService.js +12 -12
  408. package/lib/openapi/serviceManagement/services/KnowledgebaseService.js.map +1 -1
  409. package/lib/openapi/serviceManagement/services/OrganizationService.d.ts +108 -104
  410. package/lib/openapi/serviceManagement/services/OrganizationService.js +97 -99
  411. package/lib/openapi/serviceManagement/services/OrganizationService.js.map +1 -1
  412. package/lib/openapi/serviceManagement/services/RequestService.d.ts +420 -578
  413. package/lib/openapi/serviceManagement/services/RequestService.js +405 -571
  414. package/lib/openapi/serviceManagement/services/RequestService.js.map +1 -1
  415. package/lib/openapi/serviceManagement/services/RequesttypeService.d.ts +25 -39
  416. package/lib/openapi/serviceManagement/services/RequesttypeService.js +26 -40
  417. package/lib/openapi/serviceManagement/services/RequesttypeService.js.map +1 -1
  418. package/lib/openapi/serviceManagement/services/ServicedeskService.d.ts +195 -215
  419. package/lib/openapi/serviceManagement/services/ServicedeskService.js +190 -213
  420. package/lib/openapi/serviceManagement/services/ServicedeskService.js.map +1 -1
  421. package/lib/openapi/serviceManagement/validationSchemaStorage.d.ts +1 -1
  422. package/lib/openapi/serviceManagement/validationSchemaStorage.js +1 -1
  423. package/lib/openapi/serviceManagement/validationSchemaStorage.js.map +1 -1
  424. package/lib/openapi/software/BaseJiraSoftwareApiClient.d.ts +2 -2
  425. package/lib/openapi/software/BaseJiraSoftwareApiClient.js +2 -2
  426. package/lib/openapi/software/BaseJiraSoftwareApiClient.js.map +1 -1
  427. package/lib/openapi/software/models/board.d.ts +4 -7
  428. package/lib/openapi/software/models/board.js.map +1 -1
  429. package/lib/openapi/software/models/builds.d.ts +39 -20
  430. package/lib/openapi/software/models/builds.js.map +1 -1
  431. package/lib/openapi/software/models/common.d.ts +8 -6
  432. package/lib/openapi/software/models/common.js.map +1 -1
  433. package/lib/openapi/software/models/deployments.d.ts +37 -18
  434. package/lib/openapi/software/models/deployments.js.map +1 -1
  435. package/lib/openapi/software/models/devOpsComponents.d.ts +7 -4
  436. package/lib/openapi/software/models/devOpsComponents.js.map +1 -1
  437. package/lib/openapi/software/models/developmentInformation.d.ts +107 -55
  438. package/lib/openapi/software/models/developmentInformation.js.map +1 -1
  439. package/lib/openapi/software/models/epic.d.ts +1 -1
  440. package/lib/openapi/software/models/featureFlags.d.ts +17 -9
  441. package/lib/openapi/software/models/featureFlags.js.map +1 -1
  442. package/lib/openapi/software/models/issue.d.ts +1 -1
  443. package/lib/openapi/software/models/operations.d.ts +61 -31
  444. package/lib/openapi/software/models/operations.js.map +1 -1
  445. package/lib/openapi/software/models/remoteLinks.d.ts +37 -19
  446. package/lib/openapi/software/models/remoteLinks.js.map +1 -1
  447. package/lib/openapi/software/models/securityInformation.d.ts +53 -27
  448. package/lib/openapi/software/models/securityInformation.js.map +1 -1
  449. package/lib/openapi/software/models/sprint.d.ts +1 -1
  450. package/lib/openapi/software/services/BacklogService.d.ts +14 -8
  451. package/lib/openapi/software/services/BacklogService.js +11 -7
  452. package/lib/openapi/software/services/BacklogService.js.map +1 -1
  453. package/lib/openapi/software/services/BoardService.d.ts +200 -204
  454. package/lib/openapi/software/services/BoardService.js +197 -203
  455. package/lib/openapi/software/services/BoardService.js.map +1 -1
  456. package/lib/openapi/software/services/BuildsService.d.ts +11 -9
  457. package/lib/openapi/software/services/BuildsService.js +12 -10
  458. package/lib/openapi/software/services/BuildsService.js.map +1 -1
  459. package/lib/openapi/software/services/DeploymentsService.d.ts +13 -13
  460. package/lib/openapi/software/services/DeploymentsService.js +14 -14
  461. package/lib/openapi/software/services/DeploymentsService.js.map +1 -1
  462. package/lib/openapi/software/services/DevOpsComponentsService.d.ts +33 -20
  463. package/lib/openapi/software/services/DevOpsComponentsService.js +12 -10
  464. package/lib/openapi/software/services/DevOpsComponentsService.js.map +1 -1
  465. package/lib/openapi/software/services/DevelopmentInformationService.d.ts +14 -9
  466. package/lib/openapi/software/services/DevelopmentInformationService.js +15 -10
  467. package/lib/openapi/software/services/DevelopmentInformationService.js.map +1 -1
  468. package/lib/openapi/software/services/EpicService.d.ts +67 -76
  469. package/lib/openapi/software/services/EpicService.js +60 -73
  470. package/lib/openapi/software/services/EpicService.js.map +1 -1
  471. package/lib/openapi/software/services/FeatureFlagsService.d.ts +11 -9
  472. package/lib/openapi/software/services/FeatureFlagsService.js +12 -10
  473. package/lib/openapi/software/services/FeatureFlagsService.js.map +1 -1
  474. package/lib/openapi/software/services/IssueService.d.ts +45 -44
  475. package/lib/openapi/software/services/IssueService.js +42 -43
  476. package/lib/openapi/software/services/IssueService.js.map +1 -1
  477. package/lib/openapi/software/services/OperationsService.d.ts +66 -38
  478. package/lib/openapi/software/services/OperationsService.js +23 -17
  479. package/lib/openapi/software/services/OperationsService.js.map +1 -1
  480. package/lib/openapi/software/services/RemoteLinksService.d.ts +18 -13
  481. package/lib/openapi/software/services/RemoteLinksService.js +12 -10
  482. package/lib/openapi/software/services/RemoteLinksService.js.map +1 -1
  483. package/lib/openapi/software/services/SecurityInformationService.d.ts +19 -13
  484. package/lib/openapi/software/services/SecurityInformationService.js +20 -14
  485. package/lib/openapi/software/services/SecurityInformationService.js.map +1 -1
  486. package/lib/openapi/software/services/SprintService.d.ts +79 -55
  487. package/lib/openapi/software/services/SprintService.js +70 -51
  488. package/lib/openapi/software/services/SprintService.js.map +1 -1
  489. package/lib/openapi/software/validationSchemaStorage.d.ts +1 -1
  490. package/lib/openapi/software/validationSchemaStorage.js +1 -1
  491. package/lib/openapi/software/validationSchemaStorage.js.map +1 -1
  492. package/package.json +3 -3
  493. package/lib/openapi/platform/core/CommonHttpClient.js +0 -390
  494. package/lib/openapi/platform/core/CommonHttpClient.js.map +0 -1
  495. package/lib/openapi/platform/core/CommonHttpService.d.ts +0 -9
  496. package/lib/openapi/platform/core/CommonHttpService.js.map +0 -1
  497. package/lib/openapi/platform/core/CommonValidationSchemaStorage.js.map +0 -1
  498. package/lib/openapi/serviceManagement/core/CommonHttpClient.d.ts +0 -196
  499. package/lib/openapi/serviceManagement/core/CommonHttpClient.js.map +0 -1
  500. package/lib/openapi/serviceManagement/core/CommonHttpService.d.ts +0 -9
  501. package/lib/openapi/serviceManagement/core/CommonHttpService.js +0 -29
  502. package/lib/openapi/serviceManagement/core/CommonHttpService.js.map +0 -1
  503. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.d.ts +0 -35
  504. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js +0 -65
  505. package/lib/openapi/serviceManagement/core/CommonValidationSchemaStorage.js.map +0 -1
  506. package/lib/openapi/software/core/CommonHttpClient.d.ts +0 -196
  507. package/lib/openapi/software/core/CommonHttpClient.js +0 -390
  508. package/lib/openapi/software/core/CommonHttpClient.js.map +0 -1
  509. package/lib/openapi/software/core/CommonHttpService.js +0 -29
  510. package/lib/openapi/software/core/CommonHttpService.js.map +0 -1
  511. package/lib/openapi/software/core/CommonValidationSchemaStorage.d.ts +0 -35
  512. package/lib/openapi/software/core/CommonValidationSchemaStorage.js +0 -65
  513. package/lib/openapi/software/core/CommonValidationSchemaStorage.js.map +0 -1
  514. /package/lib/openapi/{platform/core → core}/CommonValidationSchemaStorage.d.ts +0 -0
  515. /package/lib/openapi/{platform/core → core}/CommonValidationSchemaStorage.js +0 -0
@@ -5,8 +5,8 @@ exports.ServicedeskService = void 0;
5
5
  // This file is generated by "api-typescript-generator".
6
6
  // To update this file run "yarn build:openapi".
7
7
  const zod_1 = require("zod");
8
- const commonHttpClient = require("../core/CommonHttpClient");
9
- const CommonHttpService_1 = require("../core/CommonHttpService");
8
+ const commonHttpClient = require("../../core/CommonHttpClient");
9
+ const CommonHttpService_1 = require("../../core/CommonHttpService");
10
10
  const common_1 = require("../models/common");
11
11
  const servicedesk_1 = require("../models/servicedesk");
12
12
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
@@ -21,11 +21,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
21
21
  *
22
22
  * **[Permissions](#permissions) required**: Service desk administrator
23
23
  *
24
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
24
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
25
25
  * @scopes-current manage:servicedesk-customer
26
- * @scopes-beta read:servicedesk.customer:jira-service-management,
27
- * write:servicedesk.customer:jira-service-management
26
+ * @scopes-beta read:servicedesk.customer:jira-service-management, write:servicedesk.customer:jira-service-management
28
27
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-post
28
+ * @param params
29
29
  */
30
30
  this.addCustomers = ({ serviceDeskId, serviceDeskCustomerDto, }) => {
31
31
  return this.getClientInstance()
@@ -65,17 +65,20 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
65
65
  *
66
66
  * For example, to upload a file called `myfile.txt` in the Service Desk with ID
67
67
  * 10001 use
68
- *
69
- * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H
68
+ * ```
69
+ * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H
70
70
  * "X-Atlassian-Token: no-check" -F "file=@myfile.txt"
71
71
  * https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001/attachTemporaryFile
72
+ * ```
72
73
  *
73
74
  * **[Permissions](#permissions) required**: Permission to add attachments in this
74
75
  * Service Desk.
75
76
  *
76
77
  * @returns Returns if the file(s) were attached.
77
78
  *
78
- * example: {
79
+ * example:
80
+ * ```
81
+ * {
79
82
  * "temporaryAttachments": [
80
83
  * {
81
84
  * "temporaryAttachmentId": "temp8186986881700442965",
@@ -87,11 +90,12 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
87
90
  * }
88
91
  * ]
89
92
  * }
90
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile
93
+ * ```
94
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile`
91
95
  * @scopes-current write:servicedesk-request
92
- * @scopes-beta read:request.attachment:jira-service-management,
93
- * write:request.attachment:jira-service-management
96
+ * @scopes-beta read:request.attachment:jira-service-management, write:request.attachment:jira-service-management
94
97
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post
98
+ * @param params
95
99
  */
96
100
  this.attachTemporaryFile = ({ serviceDeskId, multipartFiles, }) => {
97
101
  return this.getClientInstance()
@@ -141,12 +145,13 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
141
145
  *
142
146
  * @returns Returns the customer request type created.
143
147
  *
144
- * example: {
148
+ * example:
149
+ * ```
150
+ * {
145
151
  * "_expands": [],
146
152
  * "id": "11001",
147
153
  * "_links": {
148
- * "self":
149
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
154
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
150
155
  * },
151
156
  * "name": "Get IT Help",
152
157
  * "description": "Get IT Help",
@@ -161,20 +166,18 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
161
166
  * "id": "12345",
162
167
  * "_links": {
163
168
  * "iconUrls": {
164
- * "48x48":
165
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
166
- * "24x24":
167
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
168
- * "16x16":
169
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
170
- * "32x32":
171
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
169
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
170
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
171
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
172
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
172
173
  * }
173
174
  * }
174
175
  * }
175
176
  * }
176
- * @path {POST} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
177
+ * ```
178
+ * @path POST `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype`
177
179
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-post
180
+ * @param params
178
181
  */
179
182
  this.createRequestType = ({ serviceDeskId, requestTypeCreateDto, }) => {
180
183
  return this.getClientInstance()
@@ -210,12 +213,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
210
213
  * **[Permissions](#permissions) required**: Jira project administrator with a
211
214
  * Jira Service Management agent license.
212
215
  *
213
- * @path {DELETE}
214
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
216
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
215
217
  * @scopes-current manage:jira-project
216
- * @scopes-beta read:requesttype.property:jira-service-management,
217
- * delete:requesttype.property:jira-service-management
218
+ * @scopes-beta read:requesttype.property:jira-service-management, delete:requesttype.property:jira-service-management
218
219
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-delete
220
+ * @param params
219
221
  */
220
222
  this.deleteProperty = ({ serviceDeskId, requestTypeId, propertyKey, }) => {
221
223
  return this.getClientInstance()
@@ -237,9 +239,9 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
237
239
  *
238
240
  * **[Permissions](#permissions) required**: Service desk administrator.
239
241
  *
240
- * @path {DELETE}
241
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
242
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}`
242
243
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-delete
244
+ * @param params
243
245
  */
244
246
  this.deleteRequestType = ({ serviceDeskId, requestTypeId, }) => {
245
247
  return this.getClientInstance()
@@ -261,7 +263,9 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
261
263
  *
262
264
  * @returns Returns the articles, on the specified page of the results.
263
265
  *
264
- * example: {
266
+ * example:
267
+ * ```
268
+ * {
265
269
  * "_expands": [],
266
270
  * "size": 2,
267
271
  * "start": 2,
@@ -270,10 +274,8 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
270
274
  * "_links": {
271
275
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
272
276
  * "context": "context",
273
- * "next":
274
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=4&limit=2",
275
- * "prev":
276
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=0&limit=2"
277
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=4&limit=2",
278
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/knowledgebase/article?start=0&limit=2"
277
279
  * },
278
280
  * "values": [
279
281
  * {
@@ -285,8 +287,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
285
287
  * "spaceKey": "IT"
286
288
  * },
287
289
  * "content": {
288
- * "iframeSrc":
289
- * "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
290
+ * "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177"
290
291
  * }
291
292
  * },
292
293
  * {
@@ -298,14 +299,15 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
298
299
  * "spaceKey": "IT"
299
300
  * },
300
301
  * "content": {
301
- * "iframeSrc":
302
- * "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
302
+ * "iframeSrc": "https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228"
303
303
  * }
304
304
  * }
305
305
  * ]
306
306
  * }
307
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article
307
+ * ```
308
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article`
308
309
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-knowledgebase-article-get
310
+ * @param params
309
311
  */
310
312
  this.getArticles = ({ serviceDeskId, query, highlight, start, limit, }) => {
311
313
  return this.getClientInstance()
@@ -344,7 +346,9 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
344
346
  *
345
347
  * @returns Returns the service desk's customer list.
346
348
  *
347
- * example: {
349
+ * example:
350
+ * ```
351
+ * {
348
352
  * "_expands": [],
349
353
  * "size": 1,
350
354
  * "start": 1,
@@ -353,15 +357,12 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
353
357
  * "_links": {
354
358
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
355
359
  * "context": "context",
356
- * "next":
357
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=2&limit=1",
358
- * "prev":
359
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=0&limit=1"
360
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=2&limit=1",
361
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/customer?start=0&limit=1"
360
362
  * },
361
363
  * "values": [
362
364
  * {
363
- * "accountId":
364
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
365
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
365
366
  * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
366
367
  * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
367
368
  * "emailAddress": "fred@example.com",
@@ -369,28 +370,24 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
369
370
  * "active": true,
370
371
  * "timeZone": "Australia/Sydney",
371
372
  * "_links": {
372
- * "jiraRest":
373
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
373
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
374
374
  * "avatarUrls": {
375
- * "16x16":
376
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
377
- * "24x24":
378
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
379
- * "32x32":
380
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
381
- * "48x48":
382
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
375
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
376
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
377
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
378
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
383
379
  * },
384
- * "self":
385
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
380
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
386
381
  * }
387
382
  * }
388
383
  * ]
389
384
  * }
390
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
385
+ * ```
386
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
391
387
  * @scopes-current manage:servicedesk-customer
392
388
  * @scopes-beta read:servicedesk.customer:jira-service-management, read:user:jira
393
389
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-get
390
+ * @param params
394
391
  */
395
392
  this.getCustomers = ({ serviceDeskId, query, start, limit, }) => {
396
393
  return this.getClientInstance()
@@ -423,10 +420,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
423
420
  *
424
421
  * **[Permissions](#permissions) required**: Service desk's agent.
425
422
  *
426
- * @returns Returns the customer requests belonging to the queue, on the specified page of
427
- * the results.
423
+ * @returns Returns the customer requests belonging to the queue, on the specified page of the results.
428
424
  *
429
- * example: {
425
+ * example:
426
+ * ```
427
+ * {
430
428
  * "_expands": [],
431
429
  * "size": 1,
432
430
  * "start": 1,
@@ -435,10 +433,8 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
435
433
  * "_links": {
436
434
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
437
435
  * "context": "context",
438
- * "next":
439
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=2&limit=1",
440
- * "prev":
441
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=0&limit=1"
436
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=2&limit=1",
437
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=0&limit=1"
442
438
  * },
443
439
  * "values": [
444
440
  * {
@@ -446,10 +442,8 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
446
442
  * "summary": "My keyboard is broken",
447
443
  * "issuetype": {
448
444
  * "avatarId": 10002,
449
- * "description": "For general IT problems and questions. Created by
450
- * Jira Service Management.",
451
- * "iconUrl":
452
- * "https://your-domain.atlassian.net/servicedesk/issue-type-icons?icon=it-help",
445
+ * "description": "For general IT problems and questions. Created by Jira Service Management.",
446
+ * "iconUrl": "https://your-domain.atlassian.net/servicedesk/issue-type-icons?icon=it-help",
453
447
  * "id": "13",
454
448
  * "name": "IT Help",
455
449
  * "self": "https://your-domain.atlassian.net/rest/api/2/issuetype/13",
@@ -458,45 +452,37 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
458
452
  * "duedate": "2015-11-11T14:17:13.000+0700",
459
453
  * "created": "2015-11-09T14:17:13.000+0700",
460
454
  * "reporter": {
461
- * "accountId":
462
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
463
- * "name":
464
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
465
- * "key":
466
- * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
455
+ * "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
456
+ * "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
457
+ * "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
467
458
  * "emailAddress": "fred@example.com",
468
459
  * "displayName": "Fred F. User",
469
460
  * "active": true,
470
461
  * "timeZone": "Australia/Sydney",
471
462
  * "_links": {
472
- * "jiraRest":
473
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
463
+ * "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
474
464
  * "avatarUrls": {
475
- * "16x16":
476
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
477
- * "24x24":
478
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
479
- * "32x32":
480
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
481
- * "48x48":
482
- * "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
465
+ * "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
466
+ * "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
467
+ * "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
468
+ * "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
483
469
  * },
484
- * "self":
485
- * "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
470
+ * "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
486
471
  * }
487
472
  * }
488
473
  * },
489
474
  * "id": "10001",
490
475
  * "key": "SD-1",
491
- * "self":
492
- * "https://your-domain.atlassian.net/rest/servicedeskapi/rest/api/2/issue/10001"
476
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/api/2/issue/10001"
493
477
  * }
494
478
  * ]
495
479
  * }
496
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue
480
+ * ```
481
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue`
497
482
  * @scopes-current read:jira-work
498
483
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:issue:jira
499
484
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-queueid-issue-get
485
+ * @param params
500
486
  */
501
487
  this.getIssuesInQueue = ({ serviceDeskId, queueId, start, limit, }) => {
502
488
  return this.getClientInstance()
@@ -535,20 +521,22 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
535
521
  *
536
522
  * @returns Returned if the request type was found.
537
523
  *
538
- * example: {
524
+ * example:
525
+ * ```
526
+ * {
539
527
  * "entityPropertyKeyBeans": [
540
528
  * {
541
529
  * "key": "requestType.attributes",
542
- * "self":
543
- * "/rest/servicedeskapi/servicedesk/1/requestType/2/property/propertyKey"
530
+ * "self": "/rest/servicedeskapi/servicedesk/1/requestType/2/property/propertyKey"
544
531
  * }
545
532
  * ]
546
533
  * }
547
- * @path {GET}
548
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property
534
+ * ```
535
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property`
549
536
  * @scopes-current read:servicedesk-request
550
537
  * @scopes-beta read:requesttype.property:jira-service-management
551
538
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-get
539
+ * @param params
552
540
  */
553
541
  this.getPropertiesKeys = ({ requestTypeId, serviceDeskId, }) => {
554
542
  return this.getClientInstance()
@@ -582,18 +570,21 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
582
570
  *
583
571
  * @returns Returned if the request type property was returned.
584
572
  *
585
- * example: {
573
+ * example:
574
+ * ```
575
+ * {
586
576
  * "key": "organization.attributes",
587
577
  * "value": {
588
578
  * "color": "green",
589
579
  * "priority": "high"
590
580
  * }
591
581
  * }
592
- * @path {GET}
593
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
582
+ * ```
583
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
594
584
  * @scopes-current read:servicedesk-request
595
585
  * @scopes-beta read:requesttype.property:jira-service-management
596
586
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-get
587
+ * @param params
597
588
  */
598
589
  this.getProperty = ({ serviceDeskId, requestTypeId, propertyKey, }) => {
599
590
  return this.getClientInstance()
@@ -624,11 +615,12 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
624
615
  *
625
616
  * @returns Returns the specific queue of the service desk.
626
617
  *
627
- * example: {
618
+ * example:
619
+ * ```
620
+ * {
628
621
  * "id": "20",
629
622
  * "name": "Assigned to me",
630
- * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved
631
- * ORDER BY \"Time to resolution\" ASC",
623
+ * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
632
624
  * "fields": [
633
625
  * "issuetype",
634
626
  * "issuekey",
@@ -639,14 +631,15 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
639
631
  * ],
640
632
  * "issueCount": 10,
641
633
  * "_links": {
642
- * "self":
643
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
634
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
644
635
  * }
645
636
  * }
646
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}
637
+ * ```
638
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}`
647
639
  * @scopes-current read:jira-work
648
640
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:jql:jira
649
641
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-queueid-get
642
+ * @param params
650
643
  */
651
644
  this.getQueue = ({ serviceDeskId, queueId, includeCount, }) => {
652
645
  return this.getClientInstance()
@@ -679,7 +672,9 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
679
672
  *
680
673
  * @returns Returns the queues of the service desk, on the specified page of the results.
681
674
  *
682
- * example: {
675
+ * example:
676
+ * ```
677
+ * {
683
678
  * "_expands": [],
684
679
  * "size": 2,
685
680
  * "start": 2,
@@ -688,17 +683,14 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
688
683
  * "_links": {
689
684
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
690
685
  * "context": "context",
691
- * "next":
692
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=4&limit=2",
693
- * "prev":
694
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=0&limit=2"
686
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=4&limit=2",
687
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue?start=0&limit=2"
695
688
  * },
696
689
  * "values": [
697
690
  * {
698
691
  * "id": "10",
699
692
  * "name": "Unassigned issues",
700
- * "jql": "project = SD AND assignee is EMPTY AND resolution = Unresolved
701
- * ORDER BY \"Time to resolution\" ASC",
693
+ * "jql": "project = SD AND assignee is EMPTY AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
702
694
  * "fields": [
703
695
  * "issuetype",
704
696
  * "issuekey",
@@ -709,15 +701,13 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
709
701
  * ],
710
702
  * "issueCount": 10,
711
703
  * "_links": {
712
- * "self":
713
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10"
704
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/10"
714
705
  * }
715
706
  * },
716
707
  * {
717
708
  * "id": "20",
718
709
  * "name": "Assigned to me",
719
- * "jql": "project = SD AND assignee = currentUser() AND resolution =
720
- * Unresolved ORDER BY \"Time to resolution\" ASC",
710
+ * "jql": "project = SD AND assignee = currentUser() AND resolution = Unresolved ORDER BY \"Time to resolution\" ASC",
721
711
  * "fields": [
722
712
  * "issuetype",
723
713
  * "issuekey",
@@ -728,16 +718,17 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
728
718
  * ],
729
719
  * "issueCount": 10,
730
720
  * "_links": {
731
- * "self":
732
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
721
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/1/queue/20"
733
722
  * }
734
723
  * }
735
724
  * ]
736
725
  * }
737
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue
726
+ * ```
727
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue`
738
728
  * @scopes-current read:jira-work
739
729
  * @scopes-beta read:queue:jira-service-management, read:user:jira, read:jql:jira
740
730
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-queue-get
731
+ * @param params
741
732
  */
742
733
  this.getQueues = ({ serviceDeskId, includeCount, start, limit, }) => {
743
734
  return this.getClientInstance()
@@ -771,12 +762,13 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
771
762
  *
772
763
  * @returns Returns the customer request type item.
773
764
  *
774
- * example: {
765
+ * example:
766
+ * ```
767
+ * {
775
768
  * "_expands": [],
776
769
  * "id": "11001",
777
770
  * "_links": {
778
- * "self":
779
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
771
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
780
772
  * },
781
773
  * "name": "Get IT Help",
782
774
  * "description": "Get IT Help",
@@ -791,23 +783,20 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
791
783
  * "id": "12345",
792
784
  * "_links": {
793
785
  * "iconUrls": {
794
- * "48x48":
795
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
796
- * "24x24":
797
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
798
- * "16x16":
799
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
800
- * "32x32":
801
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
786
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
787
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
788
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
789
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
802
790
  * }
803
791
  * }
804
792
  * }
805
793
  * }
806
- * @path {GET}
807
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}
794
+ * ```
795
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}`
808
796
  * @scopes-current read:servicedesk-request
809
797
  * @scopes-beta read:requesttype:jira-service-management
810
798
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-get
799
+ * @param params
811
800
  */
812
801
  this.getRequestTypeById = ({ serviceDeskId, requestTypeId, expand, }) => {
813
802
  return this.getClientInstance()
@@ -845,10 +834,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
845
834
  * **[Permissions](#permissions) required**: Permission to view the Service Desk.
846
835
  * However, hidden fields would be visible to only Service desk's Administrator.
847
836
  *
848
- * @returns Returns the request type's fields and user permission details, on the specified
849
- * page of the results.
837
+ * @returns Returns the request type's fields and user permission details, on the specified page of the results.
850
838
  *
851
- * example: {
839
+ * example:
840
+ * ```
841
+ * {
852
842
  * "canAddRequestParticipants": true,
853
843
  * "canRaiseOnBehalfOf": true,
854
844
  * "requestTypeFields": [
@@ -866,8 +856,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
866
856
  * {
867
857
  * "fieldId": "customfield_10000",
868
858
  * "jiraSchema": {
869
- * "custom":
870
- * "com.atlassian.jira.plugin.system.customfieldtypes:userpicker",
859
+ * "custom": "com.atlassian.jira.plugin.system.customfieldtypes:userpicker",
871
860
  * "customId": 10000,
872
861
  * "type": "user"
873
862
  * },
@@ -879,8 +868,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
879
868
  * {
880
869
  * "fieldId": "customfield_10001",
881
870
  * "jiraSchema": {
882
- * "custom":
883
- * "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons",
871
+ * "custom": "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons",
884
872
  * "customId": 10001,
885
873
  * "type": "string"
886
874
  * },
@@ -907,11 +895,12 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
907
895
  * }
908
896
  * ]
909
897
  * }
910
- * @path {GET}
911
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field
898
+ * ```
899
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field`
912
900
  * @scopes-current read:servicedesk-request
913
901
  * @scopes-beta read:requesttype:jira-service-management
914
902
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get
903
+ * @param params
915
904
  */
916
905
  this.getRequestTypeFields = ({ serviceDeskId, requestTypeId, expand, }) => {
917
906
  return this.getClientInstance()
@@ -943,10 +932,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
943
932
  *
944
933
  * **[Permissions](#permissions) required**: Permission to view the service desk.
945
934
  *
946
- * @returns Returns the service desk's customer request type groups, on the specified page
947
- * of the results.
935
+ * @returns Returns the service desk's customer request type groups, on the specified page of the results.
948
936
  *
949
- * example: {
937
+ * example:
938
+ * ```
939
+ * {
950
940
  * "_expands": [],
951
941
  * "size": 3,
952
942
  * "start": 3,
@@ -955,10 +945,8 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
955
945
  * "_links": {
956
946
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
957
947
  * "context": "context",
958
- * "next":
959
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=6&limit=3",
960
- * "prev":
961
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=0&limit=3"
948
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=6&limit=3",
949
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/%7BserviceDeskId%7D/requesttypegroup?start=0&limit=3"
962
950
  * },
963
951
  * "values": [
964
952
  * {
@@ -975,10 +963,12 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
975
963
  * }
976
964
  * ]
977
965
  * }
978
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup
966
+ * ```
967
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup`
979
968
  * @scopes-current read:servicedesk-request
980
969
  * @scopes-beta read:requesttype:jira-service-management
981
970
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttypegroup-get
971
+ * @param params
982
972
  */
983
973
  this.getRequestTypeGroups = ({ serviceDeskId, start, limit, }) => {
984
974
  return this.getClientInstance()
@@ -1019,10 +1009,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1019
1009
  *
1020
1010
  * **[Permissions](#permissions) required**: Permission to access the service desk.
1021
1011
  *
1022
- * @returns Returns the requested customer request types, on the specified page of the
1023
- * results.
1012
+ * @returns Returns the requested customer request types, on the specified page of the results.
1024
1013
  *
1025
- * example: {
1014
+ * example:
1015
+ * ```
1016
+ * {
1026
1017
  * "_expands": [],
1027
1018
  * "size": 3,
1028
1019
  * "start": 3,
@@ -1031,23 +1022,19 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1031
1022
  * "_links": {
1032
1023
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1033
1024
  * "context": "context",
1034
- * "next":
1035
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
1036
- * "prev":
1037
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
1025
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=6&limit=3",
1026
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype?start=0&limit=3"
1038
1027
  * },
1039
1028
  * "values": [
1040
1029
  * {
1041
1030
  * "_expands": [],
1042
1031
  * "id": "11001",
1043
1032
  * "_links": {
1044
- * "self":
1045
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
1033
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11001"
1046
1034
  * },
1047
1035
  * "name": "Get IT Help",
1048
1036
  * "description": "Get IT Help",
1049
- * "helpText": "Please tell us clearly the problem you have within 100
1050
- * words.",
1037
+ * "helpText": "Please tell us clearly the problem you have within 100 words.",
1051
1038
  * "issueTypeId": "12345",
1052
1039
  * "serviceDeskId": "28",
1053
1040
  * "portalId": "2",
@@ -1058,14 +1045,10 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1058
1045
  * "id": "12345",
1059
1046
  * "_links": {
1060
1047
  * "iconUrls": {
1061
- * "48x48":
1062
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
1063
- * "24x24":
1064
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
1065
- * "16x16":
1066
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
1067
- * "32x32":
1068
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
1048
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=large",
1049
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=small",
1050
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=xsmall",
1051
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12345?size=medium"
1069
1052
  * }
1070
1053
  * }
1071
1054
  * }
@@ -1074,8 +1057,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1074
1057
  * "_expands": [],
1075
1058
  * "id": "11002",
1076
1059
  * "_links": {
1077
- * "self":
1078
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
1060
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11002"
1079
1061
  * },
1080
1062
  * "name": "Request a new account",
1081
1063
  * "description": "Request a new account",
@@ -1090,14 +1072,10 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1090
1072
  * "id": "12346",
1091
1073
  * "_links": {
1092
1074
  * "iconUrls": {
1093
- * "48x48":
1094
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
1095
- * "24x24":
1096
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
1097
- * "16x16":
1098
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
1099
- * "32x32":
1100
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
1075
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=large",
1076
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=small",
1077
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=xsmall",
1078
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12346?size=medium"
1101
1079
  * }
1102
1080
  * }
1103
1081
  * }
@@ -1106,8 +1084,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1106
1084
  * "_expands": [],
1107
1085
  * "id": "11003",
1108
1086
  * "_links": {
1109
- * "self":
1110
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
1087
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/28/requesttype/11003"
1111
1088
  * },
1112
1089
  * "name": "Hardware request",
1113
1090
  * "description": "Request a hardware support",
@@ -1121,24 +1098,22 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1121
1098
  * "id": "12347",
1122
1099
  * "_links": {
1123
1100
  * "iconUrls": {
1124
- * "48x48":
1125
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
1126
- * "24x24":
1127
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
1128
- * "16x16":
1129
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
1130
- * "32x32":
1131
- * "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
1101
+ * "48x48": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=large",
1102
+ * "24x24": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=small",
1103
+ * "16x16": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=xsmall",
1104
+ * "32x32": "https://your-domain.atlassian.net/rest/api/2/universal_avatar/view/type/SD_REQTYPE/avatar/12347?size=medium"
1132
1105
  * }
1133
1106
  * }
1134
1107
  * }
1135
1108
  * }
1136
1109
  * ]
1137
1110
  * }
1138
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype
1111
+ * ```
1112
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype`
1139
1113
  * @scopes-current read:servicedesk-request
1140
1114
  * @scopes-beta read:requesttype:jira-service-management
1141
1115
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-get
1116
+ * @param params
1142
1117
  */
1143
1118
  this.getRequestTypes = ({ serviceDeskId, groupId, expand, searchQuery, start, limit, includeHiddenRequestTypesInSearch, }) => {
1144
1119
  return this.getClientInstance()
@@ -1177,20 +1152,23 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1177
1152
  *
1178
1153
  * @returns Returns the requested service desk.
1179
1154
  *
1180
- * example: {
1155
+ * example:
1156
+ * ```
1157
+ * {
1181
1158
  * "id": "10001",
1182
1159
  * "projectId": "11001",
1183
1160
  * "projectName": "IT Help Desk",
1184
1161
  * "projectKey": "ITH",
1185
1162
  * "_links": {
1186
- * "self":
1187
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1163
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1188
1164
  * }
1189
1165
  * }
1190
- * @path {GET} /rest/servicedeskapi/servicedesk/{serviceDeskId}
1166
+ * ```
1167
+ * @path GET `/rest/servicedeskapi/servicedesk/{serviceDeskId}`
1191
1168
  * @scopes-current read:servicedesk-request
1192
1169
  * @scopes-beta read:servicedesk:jira-service-management
1193
1170
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-get
1171
+ * @param params
1194
1172
  */
1195
1173
  this.getServiceDeskById = ({ serviceDeskId, }) => {
1196
1174
  return this.getClientInstance()
@@ -1224,7 +1202,9 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1224
1202
  *
1225
1203
  * @returns Returns the service desks, on the specified page of the results.
1226
1204
  *
1227
- * example: {
1205
+ * example:
1206
+ * ```
1207
+ * {
1228
1208
  * "_expands": [],
1229
1209
  * "size": 3,
1230
1210
  * "start": 3,
@@ -1233,10 +1213,8 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1233
1213
  * "_links": {
1234
1214
  * "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
1235
1215
  * "context": "context",
1236
- * "next":
1237
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=6&limit=3",
1238
- * "prev":
1239
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=0&limit=3"
1216
+ * "next": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=6&limit=3",
1217
+ * "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk?start=0&limit=3"
1240
1218
  * },
1241
1219
  * "values": [
1242
1220
  * {
@@ -1245,8 +1223,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1245
1223
  * "projectName": "IT Help Desk",
1246
1224
  * "projectKey": "ITH",
1247
1225
  * "_links": {
1248
- * "self":
1249
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1226
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001"
1250
1227
  * }
1251
1228
  * },
1252
1229
  * {
@@ -1255,8 +1232,7 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1255
1232
  * "projectName": "HR Self Serve Desk",
1256
1233
  * "projectKey": "HR",
1257
1234
  * "_links": {
1258
- * "self":
1259
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10002"
1235
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10002"
1260
1236
  * }
1261
1237
  * },
1262
1238
  * {
@@ -1265,16 +1241,17 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1265
1241
  * "projectName": "Foundation Leave",
1266
1242
  * "projectKey": "FL",
1267
1243
  * "_links": {
1268
- * "self":
1269
- * "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10003"
1244
+ * "self": "https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10003"
1270
1245
  * }
1271
1246
  * }
1272
1247
  * ]
1273
1248
  * }
1274
- * @path {GET} /rest/servicedeskapi/servicedesk
1249
+ * ```
1250
+ * @path GET `/rest/servicedeskapi/servicedesk`
1275
1251
  * @scopes-current read:servicedesk-request
1276
1252
  * @scopes-beta read:servicedesk:jira-service-management
1277
1253
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-get
1254
+ * @param params
1278
1255
  */
1279
1256
  this.getServiceDesks = ({ start, limit, } = {}) => {
1280
1257
  return this.getClientInstance()
@@ -1303,11 +1280,11 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1303
1280
  *
1304
1281
  * **[Permissions](#permissions) required**: Services desk administrator
1305
1282
  *
1306
- * @path {DELETE} /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
1283
+ * @path DELETE `/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer`
1307
1284
  * @scopes-current manage:servicedesk-customer
1308
- * @scopes-beta read:servicedesk.customer:jira-service-management,
1309
- * delete:servicedesk.customer:jira-service-management
1285
+ * @scopes-beta read:servicedesk.customer:jira-service-management, delete:servicedesk.customer:jira-service-management
1310
1286
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-customer-delete
1287
+ * @param params
1311
1288
  */
1312
1289
  this.removeCustomers = ({ serviceDeskId, serviceDeskCustomerDto, }) => {
1313
1290
  return this.getClientInstance()
@@ -1337,19 +1314,19 @@ class ServicedeskService extends CommonHttpService_1.CommonHttpService {
1337
1314
  * **[Permissions](#permissions) required**: Jira project administrator with a
1338
1315
  * Jira Service Management agent license.
1339
1316
  *
1340
- * @returns * status: 200, mediaType: application/json
1317
+ * @returns
1318
+ * * status: 200, mediaType: application/json
1341
1319
  *
1342
1320
  * Returned if the request type property is updated.
1343
1321
  *
1344
1322
  * * status: 201, mediaType: application/json
1345
1323
  *
1346
1324
  * Returned if the request type property is created.
1347
- * @path {PUT}
1348
- * /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}
1325
+ * @path PUT `/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}`
1349
1326
  * @scopes-current manage:jira-project
1350
- * @scopes-beta read:requesttype.property:jira-service-management,
1351
- * write:requesttype.property:jira-service-management
1327
+ * @scopes-beta read:requesttype.property:jira-service-management, write:requesttype.property:jira-service-management
1352
1328
  * @see https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-property-propertykey-put
1329
+ * @param params
1353
1330
  */
1354
1331
  this.setProperty = ({ serviceDeskId, requestTypeId, propertyKey, }) => {
1355
1332
  return this.getClientInstance()