From b8b0020d83317509173dd39f4ecb16d8cc86a261 Mon Sep 17 00:00:00 2001 From: Vladislav Tupikin Date: Tue, 7 Jan 2025 22:45:47 +0300 Subject: [PATCH] Version 3 simple updates --- package-lock.json | 266 +++++++++--------- package.json | 6 +- src/version3/announcementBanner.ts | 2 +- src/version3/appMigration.ts | 22 +- src/version3/appProperties.ts | 46 +-- src/version3/applicationRoles.ts | 2 +- src/version3/auditRecords.ts | 2 +- src/version3/dynamicModules.ts | 2 +- src/version3/filterSharing.ts | 10 +- src/version3/groupAndUserPicker.ts | 2 +- src/version3/groups.ts | 16 +- src/version3/issueAttachments.ts | 12 +- src/version3/issueCommentProperties.ts | 2 +- src/version3/issueCustomFieldContexts.ts | 14 +- src/version3/issueCustomFieldOptionsApps.ts | 18 +- src/version3/issueCustomFieldValuesApps.ts | 52 +++- src/version3/issueFieldConfigurations.ts | 26 +- src/version3/issueLinkTypes.ts | 2 +- src/version3/issueLinks.ts | 16 +- src/version3/issueNavigatorSettings.ts | 2 +- src/version3/issueProperties.ts | 22 +- src/version3/issueRemoteLinks.ts | 10 +- src/version3/issueSecurityLevel.ts | 2 +- src/version3/issueSecuritySchemes.ts | 8 +- src/version3/issueTypeProperties.ts | 2 +- src/version3/issueTypeSchemes.ts | 22 +- src/version3/issueTypeScreenSchemes.ts | 16 +- src/version3/issueVotes.ts | 2 +- src/version3/issueWatchers.ts | 2 +- src/version3/issueWorklogProperties.ts | 2 +- src/version3/jQL.ts | 14 +- src/version3/jiraSettings.ts | 48 ++-- src/version3/labels.ts | 2 +- src/version3/licenseMetrics.ts | 2 +- src/version3/myself.ts | 38 ++- src/version3/permissionSchemes.ts | 16 +- src/version3/permissions.ts | 38 ++- src/version3/projectCategories.ts | 2 +- src/version3/projectEmail.ts | 12 +- src/version3/projectFeatures.ts | 2 +- src/version3/projectKeyAndNameValidation.ts | 14 +- src/version3/projectPermissionSchemes.ts | 2 +- src/version3/projectProperties.ts | 2 +- src/version3/projectRoleActors.ts | 8 +- src/version3/projectRoles.ts | 46 +-- src/version3/projectTypes.ts | 2 +- src/version3/screenSchemes.ts | 4 +- src/version3/screenTabFields.ts | 2 +- src/version3/screens.ts | 6 +- src/version3/serverInfo.ts | 2 +- src/version3/status.ts | 4 +- src/version3/tasks.ts | 14 +- src/version3/timeTracking.ts | 8 +- src/version3/userProperties.ts | 2 +- src/version3/users.ts | 32 ++- src/version3/webhooks.ts | 4 +- src/version3/workflowSchemeDrafts.ts | 18 +- .../workflowSchemeProjectAssociations.ts | 4 +- src/version3/workflowStatusCategories.ts | 2 +- src/version3/workflowStatuses.ts | 2 +- src/version3/workflowTransitionProperties.ts | 2 +- src/version3/workflowTransitionRules.ts | 16 +- 62 files changed, 564 insertions(+), 414 deletions(-) diff --git a/package-lock.json b/package-lock.json index 185c7ba660..194913b067 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "jira.js", - "version": "4.0.5", + "version": "4.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "jira.js", - "version": "4.0.5", + "version": "4.1.0", "license": "MIT", "dependencies": { "axios": "^1.7.9", @@ -17,8 +17,8 @@ "devDependencies": { "@types/node": "^18.19.70", "@types/sinon": "^17.0.3", - "@typescript-eslint/eslint-plugin": "^8.19.0", - "@typescript-eslint/parser": "^8.19.0", + "@typescript-eslint/eslint-plugin": "^8.19.1", + "@typescript-eslint/parser": "^8.19.1", "dotenv": "^16.4.7", "eslint": "^8.57.1", "eslint-config-airbnb-base": "^15.0.0", @@ -641,9 +641,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.30.0.tgz", - "integrity": "sha512-qFcFto9figFLz2g25DxJ1WWL9+c91fTxnGuwhToCl8BaqDsDYMl/kOnBXAyAqkkzAWimYMSWNPWEjt+ADAHuoQ==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.30.1.tgz", + "integrity": "sha512-pSWY+EVt3rJ9fQ3IqlrEUtXh3cGqGtPDH1FQlNZehO2yYxCHEX1SPsz1M//NXwYfbTlcKr9WObLnJX9FsS9K1Q==", "cpu": [ "arm" ], @@ -655,9 +655,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.30.0.tgz", - "integrity": "sha512-vqrQdusvVl7dthqNjWCL043qelBK+gv9v3ZiqdxgaJvmZyIAAXMjeGVSqZynKq69T7062T5VrVTuikKSAAVP6A==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.30.1.tgz", + "integrity": "sha512-/NA2qXxE3D/BRjOJM8wQblmArQq1YoBVJjrjoTSBS09jgUisq7bqxNHJ8kjCHeV21W/9WDGwJEWSN0KQ2mtD/w==", "cpu": [ "arm64" ], @@ -669,9 +669,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.30.0.tgz", - "integrity": "sha512-617pd92LhdA9+wpixnzsyhVft3szYiN16aNUMzVkf2N+yAk8UXY226Bfp36LvxYTUt7MO/ycqGFjQgJ0wlMaWQ==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.30.1.tgz", + "integrity": "sha512-r7FQIXD7gB0WJ5mokTUgUWPl0eYIH0wnxqeSAhuIwvnnpjdVB8cRRClyKLQr7lgzjctkbp5KmswWszlwYln03Q==", "cpu": [ "arm64" ], @@ -683,9 +683,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.30.0.tgz", - "integrity": "sha512-Y3b4oDoaEhCypg8ajPqigKDcpi5ZZovemQl9Edpem0uNv6UUjXv7iySBpGIUTSs2ovWOzYpfw9EbFJXF/fJHWw==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.30.1.tgz", + "integrity": "sha512-x78BavIwSH6sqfP2xeI1hd1GpHL8J4W2BXcVM/5KYKoAD3nNsfitQhvWSw+TFtQTLZ9OmlF+FEInEHyubut2OA==", "cpu": [ "x64" ], @@ -697,9 +697,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.30.0.tgz", - "integrity": "sha512-3REQJ4f90sFIBfa0BUokiCdrV/E4uIjhkWe1bMgCkhFXbf4D8YN6C4zwJL881GM818qVYE9BO3dGwjKhpo2ABA==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.30.1.tgz", + "integrity": "sha512-HYTlUAjbO1z8ywxsDFWADfTRfTIIy/oUlfIDmlHYmjUP2QRDTzBuWXc9O4CXM+bo9qfiCclmHk1x4ogBjOUpUQ==", "cpu": [ "arm64" ], @@ -711,9 +711,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.30.0.tgz", - "integrity": "sha512-ZtY3Y8icbe3Cc+uQicsXG5L+CRGUfLZjW6j2gn5ikpltt3Whqjfo5mkyZ86UiuHF9Q3ZsaQeW7YswlHnN+lAcg==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.30.1.tgz", + "integrity": "sha512-1MEdGqogQLccphhX5myCJqeGNYTNcmTyaic9S7CG3JhwuIByJ7J05vGbZxsizQthP1xpVx7kd3o31eOogfEirw==", "cpu": [ "x64" ], @@ -725,9 +725,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.30.0.tgz", - "integrity": "sha512-bsPGGzfiHXMhQGuFGpmo2PyTwcrh2otL6ycSZAFTESviUoBOuxF7iBbAL5IJXc/69peXl5rAtbewBFeASZ9O0g==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.30.1.tgz", + "integrity": "sha512-PaMRNBSqCx7K3Wc9QZkFx5+CX27WFpAMxJNiYGAXfmMIKC7jstlr32UhTgK6T07OtqR+wYlWm9IxzennjnvdJg==", "cpu": [ "arm" ], @@ -739,9 +739,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.30.0.tgz", - "integrity": "sha512-kvyIECEhs2DrrdfQf++maCWJIQ974EI4txlz1nNSBaCdtf7i5Xf1AQCEJWOC5rEBisdaMFFnOWNLYt7KpFqy5A==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.30.1.tgz", + "integrity": "sha512-B8Rcyj9AV7ZlEFqvB5BubG5iO6ANDsRKlhIxySXcF1axXYUyqwBok+XZPgIYGBgs7LDXfWfifxhw0Ik57T0Yug==", "cpu": [ "arm" ], @@ -753,9 +753,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.30.0.tgz", - "integrity": "sha512-CFE7zDNrokaotXu+shwIrmWrFxllg79vciH4E/zeK7NitVuWEaXRzS0mFfFvyhZfn8WfVOG/1E9u8/DFEgK7WQ==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.30.1.tgz", + "integrity": "sha512-hqVyueGxAj3cBKrAI4aFHLV+h0Lv5VgWZs9CUGqr1z0fZtlADVV1YPOij6AhcK5An33EXaxnDLmJdQikcn5NEw==", "cpu": [ "arm64" ], @@ -767,9 +767,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.30.0.tgz", - "integrity": "sha512-MctNTBlvMcIBP0t8lV/NXiUwFg9oK5F79CxLU+a3xgrdJjfBLVIEHSAjQ9+ipofN2GKaMLnFFXLltg1HEEPaGQ==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.30.1.tgz", + "integrity": "sha512-i4Ab2vnvS1AE1PyOIGp2kXni69gU2DAUVt6FSXeIqUCPIR3ZlheMW3oP2JkukDfu3PsexYRbOiJrY+yVNSk9oA==", "cpu": [ "arm64" ], @@ -781,9 +781,9 @@ ] }, "node_modules/@rollup/rollup-linux-loongarch64-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.30.0.tgz", - "integrity": "sha512-fBpoYwLEPivL3q368+gwn4qnYnr7GVwM6NnMo8rJ4wb0p/Y5lg88vQRRP077gf+tc25akuqd+1Sxbn9meODhwA==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.30.1.tgz", + "integrity": "sha512-fARcF5g296snX0oLGkVxPmysetwUk2zmHcca+e9ObOovBR++9ZPOhqFUM61UUZ2EYpXVPN1redgqVoBB34nTpQ==", "cpu": [ "loong64" ], @@ -795,9 +795,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.30.0.tgz", - "integrity": "sha512-1hiHPV6dUaqIMXrIjN+vgJqtfkLpqHS1Xsg0oUfUVD98xGp1wX89PIXgDF2DWra1nxAd8dfE0Dk59MyeKaBVAw==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.30.1.tgz", + "integrity": "sha512-GLrZraoO3wVT4uFXh67ElpwQY0DIygxdv0BNW9Hkm3X34wu+BkqrDrkcsIapAY+N2ATEbvak0XQ9gxZtCIA5Rw==", "cpu": [ "ppc64" ], @@ -809,9 +809,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.30.0.tgz", - "integrity": "sha512-U0xcC80SMpEbvvLw92emHrNjlS3OXjAM0aVzlWfar6PR0ODWCTQtKeeB+tlAPGfZQXicv1SpWwRz9Hyzq3Jx3g==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.30.1.tgz", + "integrity": "sha512-0WKLaAUUHKBtll0wvOmh6yh3S0wSU9+yas923JIChfxOaaBarmb/lBKPF0w/+jTVozFnOXJeRGZ8NvOxvk/jcw==", "cpu": [ "riscv64" ], @@ -823,9 +823,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.30.0.tgz", - "integrity": "sha512-VU/P/IODrNPasgZDLIFJmMiLGez+BN11DQWfTVlViJVabyF3JaeaJkP6teI8760f18BMGCQOW9gOmuzFaI1pUw==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.30.1.tgz", + "integrity": "sha512-GWFs97Ruxo5Bt+cvVTQkOJ6TIx0xJDD/bMAOXWJg8TCSTEK8RnFeOeiFTxKniTc4vMIaWvCplMAFBt9miGxgkA==", "cpu": [ "s390x" ], @@ -837,9 +837,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.30.0.tgz", - "integrity": "sha512-laQVRvdbKmjXuFA3ZiZj7+U24FcmoPlXEi2OyLfbpY2MW1oxLt9Au8q9eHd0x6Pw/Kw4oe9gwVXWwIf2PVqblg==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.30.1.tgz", + "integrity": "sha512-UtgGb7QGgXDIO+tqqJ5oZRGHsDLO8SlpE4MhqpY9Llpzi5rJMvrK6ZGhsRCST2abZdBqIBeXW6WPD5fGK5SDwg==", "cpu": [ "x64" ], @@ -851,9 +851,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.30.0.tgz", - "integrity": "sha512-3wzKzduS7jzxqcOvy/ocU/gMR3/QrHEFLge5CD7Si9fyHuoXcidyYZ6jyx8OPYmCcGm3uKTUl+9jUSAY74Ln5A==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.30.1.tgz", + "integrity": "sha512-V9U8Ey2UqmQsBT+xTOeMzPzwDzyXmnAoO4edZhL7INkwQcaW1Ckv3WJX3qrrp/VHaDkEWIBWhRwP47r8cdrOow==", "cpu": [ "x64" ], @@ -865,9 +865,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.30.0.tgz", - "integrity": "sha512-jROwnI1+wPyuv696rAFHp5+6RFhXGGwgmgSfzE8e4xfit6oLRg7GyMArVUoM3ChS045OwWr9aTnU+2c1UdBMyw==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.30.1.tgz", + "integrity": "sha512-WabtHWiPaFF47W3PkHnjbmWawnX/aE57K47ZDT1BXTS5GgrBUEpvOzq0FI0V/UYzQJgdb8XlhVNH8/fwV8xDjw==", "cpu": [ "arm64" ], @@ -879,9 +879,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.30.0.tgz", - "integrity": "sha512-duzweyup5WELhcXx5H1jokpr13i3BV9b48FMiikYAwk/MT1LrMYYk2TzenBd0jj4ivQIt58JWSxc19y4SvLP4g==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.30.1.tgz", + "integrity": "sha512-pxHAU+Zv39hLUTdQQHUVHf4P+0C47y/ZloorHpzs2SXMRqeAWmGghzAhfOlzFHHwjvgokdFAhC4V+6kC1lRRfw==", "cpu": [ "ia32" ], @@ -893,9 +893,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.30.0.tgz", - "integrity": "sha512-DYvxS0M07PvgvavMIybCOBYheyrqlui6ZQBHJs6GqduVzHSZ06TPPvlfvnYstjODHQ8UUXFwt5YE+h0jFI8kwg==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.30.1.tgz", + "integrity": "sha512-D6qjsXGcvhTjv0kI4fU8tUuBDF/Ueee4SVX79VfNDXZa64TfCW1Slkb6Z7O1p7vflqZjcmOVdZlqf8gvJxc6og==", "cpu": [ "x64" ], @@ -1077,21 +1077,21 @@ "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.19.0.tgz", - "integrity": "sha512-NggSaEZCdSrFddbctrVjkVZvFC6KGfKfNK0CU7mNK/iKHGKbzT4Wmgm08dKpcZECBu9f5FypndoMyRHkdqfT1Q==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.19.1.tgz", + "integrity": "sha512-tJzcVyvvb9h/PB96g30MpxACd9IrunT7GF9wfA9/0TJ1LxGOJx1TdPzSbBBnNED7K9Ka8ybJsnEpiXPktolTLg==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.19.0", - "@typescript-eslint/type-utils": "8.19.0", - "@typescript-eslint/utils": "8.19.0", - "@typescript-eslint/visitor-keys": "8.19.0", + "@typescript-eslint/scope-manager": "8.19.1", + "@typescript-eslint/type-utils": "8.19.1", + "@typescript-eslint/utils": "8.19.1", + "@typescript-eslint/visitor-keys": "8.19.1", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1107,16 +1107,16 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.19.0.tgz", - "integrity": "sha512-6M8taKyOETY1TKHp0x8ndycipTVgmp4xtg5QpEZzXxDhNvvHOJi5rLRkLr8SK3jTgD5l4fTlvBiRdfsuWydxBw==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.19.1.tgz", + "integrity": "sha512-67gbfv8rAwawjYx3fYArwldTQKoYfezNUT4D5ioWetr/xCrxXxvleo3uuiFuKfejipvq+og7mjz3b0G2bVyUCw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.19.0", - "@typescript-eslint/types": "8.19.0", - "@typescript-eslint/typescript-estree": "8.19.0", - "@typescript-eslint/visitor-keys": "8.19.0", + "@typescript-eslint/scope-manager": "8.19.1", + "@typescript-eslint/types": "8.19.1", + "@typescript-eslint/typescript-estree": "8.19.1", + "@typescript-eslint/visitor-keys": "8.19.1", "debug": "^4.3.4" }, "engines": { @@ -1132,14 +1132,14 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.19.0.tgz", - "integrity": "sha512-hkoJiKQS3GQ13TSMEiuNmSCvhz7ujyqD1x3ShbaETATHrck+9RaDdUbt+osXaUuns9OFwrDTTrjtwsU8gJyyRA==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.19.1.tgz", + "integrity": "sha512-60L9KIuN/xgmsINzonOcMDSB8p82h95hoBfSBtXuO4jlR1R9L1xSkmVZKgCPVfavDlXihh4ARNjXhh1gGnLC7Q==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.19.0", - "@typescript-eslint/visitor-keys": "8.19.0" + "@typescript-eslint/types": "8.19.1", + "@typescript-eslint/visitor-keys": "8.19.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1150,16 +1150,16 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.19.0.tgz", - "integrity": "sha512-TZs0I0OSbd5Aza4qAMpp1cdCYVnER94IziudE3JU328YUHgWu9gwiwhag+fuLeJ2LkWLXI+F/182TbG+JaBdTg==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.19.1.tgz", + "integrity": "sha512-Rp7k9lhDKBMRJB/nM9Ksp1zs4796wVNyihG9/TU9R6KCJDNkQbc2EOKjrBtLYh3396ZdpXLtr/MkaSEmNMtykw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.19.0", - "@typescript-eslint/utils": "8.19.0", + "@typescript-eslint/typescript-estree": "8.19.1", + "@typescript-eslint/utils": "8.19.1", "debug": "^4.3.4", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1174,9 +1174,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.19.0.tgz", - "integrity": "sha512-8XQ4Ss7G9WX8oaYvD4OOLCjIQYgRQxO+qCiR2V2s2GxI9AUpo7riNwo6jDhKtTcaJjT8PY54j2Yb33kWtSJsmA==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.19.1.tgz", + "integrity": "sha512-JBVHMLj7B1K1v1051ZaMMgLW4Q/jre5qGK0Ew6UgXz1Rqh+/xPzV1aW581OM00X6iOfyr1be+QyW8LOUf19BbA==", "dev": true, "license": "MIT", "engines": { @@ -1188,20 +1188,20 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.19.0.tgz", - "integrity": "sha512-WW9PpDaLIFW9LCbucMSdYUuGeFUz1OkWYS/5fwZwTA+l2RwlWFdJvReQqMUMBw4yJWJOfqd7An9uwut2Oj8sLw==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.19.1.tgz", + "integrity": "sha512-jk/TZwSMJlxlNnqhy0Eod1PNEvCkpY6MXOXE/WLlblZ6ibb32i2We4uByoKPv1d0OD2xebDv4hbs3fm11SMw8Q==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.19.0", - "@typescript-eslint/visitor-keys": "8.19.0", + "@typescript-eslint/types": "8.19.1", + "@typescript-eslint/visitor-keys": "8.19.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1215,16 +1215,16 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.19.0.tgz", - "integrity": "sha512-PTBG+0oEMPH9jCZlfg07LCB2nYI0I317yyvXGfxnvGvw4SHIOuRnQ3kadyyXY6tGdChusIHIbM5zfIbp4M6tCg==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.19.1.tgz", + "integrity": "sha512-IxG5gLO0Ne+KaUc8iW1A+XuKLd63o4wlbI1Zp692n1xojCl/THvgIKXJXBZixTh5dd5+yTJ/VXH7GJaaw21qXA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.19.0", - "@typescript-eslint/types": "8.19.0", - "@typescript-eslint/typescript-estree": "8.19.0" + "@typescript-eslint/scope-manager": "8.19.1", + "@typescript-eslint/types": "8.19.1", + "@typescript-eslint/typescript-estree": "8.19.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -1239,13 +1239,13 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.19.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.19.0.tgz", - "integrity": "sha512-mCFtBbFBJDCNCWUl5y6sZSCHXw1DEFEk3c/M3nRK2a4XUB8StGFtmcEMizdjKuBzB6e/smJAAWYug3VrdLMr1w==", + "version": "8.19.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.19.1.tgz", + "integrity": "sha512-fzmjU8CHK853V/avYZAvuVut3ZTfwN5YtMaoi+X9Y9MA9keaWNHC3zEQ9zvyX/7Hj+5JkNyK1l7TOR2hevHB6Q==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.19.0", + "@typescript-eslint/types": "8.19.1", "eslint-visitor-keys": "^4.2.0" }, "engines": { @@ -5078,9 +5078,9 @@ } }, "node_modules/rollup": { - "version": "4.30.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.30.0.tgz", - "integrity": "sha512-sDnr1pcjTgUT69qBksNF1N1anwfbyYG6TBQ22b03bII8EdiUQ7J0TlozVaTMjT/eEJAO49e1ndV7t+UZfL1+vA==", + "version": "4.30.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.30.1.tgz", + "integrity": "sha512-mlJ4glW020fPuLi7DkM/lN97mYEZGWeqBnrljzN0gs7GLctqX3lNWxKQ7Gl712UAX+6fog/L3jh4gb7R6aVi3w==", "dev": true, "license": "MIT", "dependencies": { @@ -5094,25 +5094,25 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.30.0", - "@rollup/rollup-android-arm64": "4.30.0", - "@rollup/rollup-darwin-arm64": "4.30.0", - "@rollup/rollup-darwin-x64": "4.30.0", - "@rollup/rollup-freebsd-arm64": "4.30.0", - "@rollup/rollup-freebsd-x64": "4.30.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.30.0", - "@rollup/rollup-linux-arm-musleabihf": "4.30.0", - "@rollup/rollup-linux-arm64-gnu": "4.30.0", - "@rollup/rollup-linux-arm64-musl": "4.30.0", - "@rollup/rollup-linux-loongarch64-gnu": "4.30.0", - "@rollup/rollup-linux-powerpc64le-gnu": "4.30.0", - "@rollup/rollup-linux-riscv64-gnu": "4.30.0", - "@rollup/rollup-linux-s390x-gnu": "4.30.0", - "@rollup/rollup-linux-x64-gnu": "4.30.0", - "@rollup/rollup-linux-x64-musl": "4.30.0", - "@rollup/rollup-win32-arm64-msvc": "4.30.0", - "@rollup/rollup-win32-ia32-msvc": "4.30.0", - "@rollup/rollup-win32-x64-msvc": "4.30.0", + "@rollup/rollup-android-arm-eabi": "4.30.1", + "@rollup/rollup-android-arm64": "4.30.1", + "@rollup/rollup-darwin-arm64": "4.30.1", + "@rollup/rollup-darwin-x64": "4.30.1", + "@rollup/rollup-freebsd-arm64": "4.30.1", + "@rollup/rollup-freebsd-x64": "4.30.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.30.1", + "@rollup/rollup-linux-arm-musleabihf": "4.30.1", + "@rollup/rollup-linux-arm64-gnu": "4.30.1", + "@rollup/rollup-linux-arm64-musl": "4.30.1", + "@rollup/rollup-linux-loongarch64-gnu": "4.30.1", + "@rollup/rollup-linux-powerpc64le-gnu": "4.30.1", + "@rollup/rollup-linux-riscv64-gnu": "4.30.1", + "@rollup/rollup-linux-s390x-gnu": "4.30.1", + "@rollup/rollup-linux-x64-gnu": "4.30.1", + "@rollup/rollup-linux-x64-musl": "4.30.1", + "@rollup/rollup-win32-arm64-msvc": "4.30.1", + "@rollup/rollup-win32-ia32-msvc": "4.30.1", + "@rollup/rollup-win32-x64-msvc": "4.30.1", "fsevents": "~2.3.2" } }, @@ -5609,16 +5609,16 @@ } }, "node_modules/ts-api-utils": { - "version": "1.4.3", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.3.tgz", - "integrity": "sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.0.0.tgz", + "integrity": "sha512-xCt/TOAc+EOHS1XPnijD3/yzpH6qg2xppZO1YDqGoVsNXfQfzHpOdNuXwrwOU8u4ITXJyDCTyt8w5g1sZv9ynQ==", "dev": true, "license": "MIT", "engines": { - "node": ">=16" + "node": ">=18.12" }, "peerDependencies": { - "typescript": ">=4.2.0" + "typescript": ">=4.8.4" } }, "node_modules/tsconfck": { diff --git a/package.json b/package.json index 70b30e9424..6d64ddc3e7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jira.js", - "version": "4.0.5", + "version": "4.1.0", "description": "A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.", "main": "out/index.js", "types": "out/index.d.ts", @@ -55,8 +55,8 @@ "devDependencies": { "@types/node": "^18.19.70", "@types/sinon": "^17.0.3", - "@typescript-eslint/eslint-plugin": "^8.19.0", - "@typescript-eslint/parser": "^8.19.0", + "@typescript-eslint/eslint-plugin": "^8.19.1", + "@typescript-eslint/parser": "^8.19.1", "dotenv": "^16.4.7", "eslint": "^8.57.1", "eslint-config-airbnb-base": "^15.0.0", diff --git a/src/version3/announcementBanner.ts b/src/version3/announcementBanner.ts index e0e8ff2b27..6838dce374 100644 --- a/src/version3/announcementBanner.ts +++ b/src/version3/announcementBanner.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class AnnouncementBanner { diff --git a/src/version3/appMigration.ts b/src/version3/appMigration.ts index cbea50328c..97bfe8ac36 100644 --- a/src/version3/appMigration.ts +++ b/src/version3/appMigration.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class AppMigration { @@ -12,7 +12,7 @@ export class AppMigration { * fields can be updated. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * Connect apps can make this request. + * Connect apps can make this request */ async updateIssueFields(parameters: Parameters.UpdateIssueFields, callback: Callback): Promise; /** @@ -20,7 +20,7 @@ export class AppMigration { * fields can be updated. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * Connect apps can make this request. + * Connect apps can make this request */ async updateIssueFields(parameters: Parameters.UpdateIssueFields, callback?: never): Promise; async updateIssueFields( @@ -43,16 +43,16 @@ export class AppMigration { } /** - * Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for - * use by Connect apps during app migration. + * Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is + * for use by Connect apps during app migration. */ async updateEntityPropertiesValue( parameters: Parameters.UpdateEntityPropertiesValue, callback: Callback, ): Promise; /** - * Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for - * use by Connect apps during app migration. + * Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is + * for use by Connect apps during app migration. */ async updateEntityPropertiesValue( parameters: Parameters.UpdateEntityPropertiesValue, @@ -77,16 +77,16 @@ export class AppMigration { } /** - * Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect - * app. + * Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling + * Connect app. */ async workflowRuleSearch( parameters: Parameters.WorkflowRuleSearch, callback: Callback, ): Promise; /** - * Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect - * app. + * Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling + * Connect app. */ async workflowRuleSearch( parameters: Parameters.WorkflowRuleSearch, diff --git a/src/version3/appProperties.ts b/src/version3/appProperties.ts index 9dd3e5722f..0bc4f1a0ee 100644 --- a/src/version3/appProperties.ts +++ b/src/version3/appProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class AppProperties { @@ -11,9 +11,8 @@ export class AppProperties { * Gets all the properties of an app. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the - * Marketplace can access properties of Connect apps they were [migrated - * from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/). + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async getAddonProperties( parameters: Parameters.GetAddonProperties | string, @@ -23,9 +22,8 @@ export class AppProperties { * Gets all the properties of an app. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the - * Marketplace can access properties of Connect apps they were [migrated - * from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/). + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async getAddonProperties( parameters: Parameters.GetAddonProperties | string, @@ -49,9 +47,8 @@ export class AppProperties { * Returns the key and value of an app's property. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the - * Marketplace can access properties of Connect apps they were [migrated - * from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/). + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async getAddonProperty( parameters: Parameters.GetAddonProperty, @@ -61,9 +58,8 @@ export class AppProperties { * Returns the key and value of an app's property. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the - * Marketplace can access properties of Connect apps they were [migrated - * from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/). + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async getAddonProperty( parameters: Parameters.GetAddonProperty, @@ -88,7 +84,8 @@ export class AppProperties { * maximum length is 32768 characters. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async putAddonProperty( parameters: Parameters.PutAddonProperty, @@ -101,7 +98,8 @@ export class AppProperties { * maximum length is 32768 characters. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async putAddonProperty( parameters: Parameters.PutAddonProperty, @@ -124,14 +122,16 @@ export class AppProperties { * Deletes an app's property. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async deleteAddonProperty(parameters: Parameters.DeleteAddonProperty, callback: Callback): Promise; /** * Deletes an app's property. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only a - * Connect app whose key matches `addonKey` can make this request. + * Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps can access Connect app + * properties (stored against the same `app.connect.key`). */ async deleteAddonProperty(parameters: Parameters.DeleteAddonProperty, callback?: never): Promise; async deleteAddonProperty( @@ -159,6 +159,9 @@ export class AppProperties { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only * Forge apps can make this request. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async putAppProperty( parameters: Parameters.PutAppProperty, @@ -177,6 +180,9 @@ export class AppProperties { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only * Forge apps can make this request. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async putAppProperty( parameters: Parameters.PutAppProperty, @@ -200,6 +206,9 @@ export class AppProperties { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only * Forge apps can make this request. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async deleteAppProperty(parameters: Parameters.DeleteAppProperty, callback: Callback): Promise; /** @@ -207,6 +216,9 @@ export class AppProperties { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only * Forge apps can make this request. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async deleteAppProperty(parameters: Parameters.DeleteAppProperty, callback?: never): Promise; async deleteAppProperty( diff --git a/src/version3/applicationRoles.ts b/src/version3/applicationRoles.ts index 6ffd77f954..da42434b82 100644 --- a/src/version3/applicationRoles.ts +++ b/src/version3/applicationRoles.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ApplicationRoles { diff --git a/src/version3/auditRecords.ts b/src/version3/auditRecords.ts index 4dd4989a93..2d6e824134 100644 --- a/src/version3/auditRecords.ts +++ b/src/version3/auditRecords.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class AuditRecords { diff --git a/src/version3/dynamicModules.ts b/src/version3/dynamicModules.ts index 205b9af6c2..e799a499b7 100644 --- a/src/version3/dynamicModules.ts +++ b/src/version3/dynamicModules.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class DynamicModules { diff --git a/src/version3/filterSharing.ts b/src/version3/filterSharing.ts index be262344a7..715e1e98ef 100644 --- a/src/version3/filterSharing.ts +++ b/src/version3/filterSharing.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class FilterSharing { @@ -159,13 +159,13 @@ export class FilterSharing { url: `/rest/api/3/filter/${parameters.id}/permission`, method: 'POST', data: { - type: parameters.type, - projectId: parameters.projectId, + accountId: parameters.accountId, + groupId: parameters.groupId, groupname: parameters.groupname, + projectId: parameters.projectId, projectRoleId: parameters.projectRoleId, - accountId: parameters.accountId, rights: parameters.rights, - groupId: parameters.groupId, + type: parameters.type, }, }; diff --git a/src/version3/groupAndUserPicker.ts b/src/version3/groupAndUserPicker.ts index c1f42bbc73..e72ef3b63f 100644 --- a/src/version3/groupAndUserPicker.ts +++ b/src/version3/groupAndUserPicker.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class GroupAndUserPicker { diff --git a/src/version3/groups.ts b/src/version3/groups.ts index 1b30b6cd9e..555647b4d3 100644 --- a/src/version3/groups.ts +++ b/src/version3/groups.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Groups { @@ -106,8 +106,11 @@ export class Groups { * Note that users are ordered by username, however the username is not returned in the results due to privacy * reasons. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** either + * of: + * + * - _Browse users and groups_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * - _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getUsersFromGroup( parameters: Parameters.GetUsersFromGroup, @@ -120,8 +123,11 @@ export class Groups { * Note that users are ordered by username, however the username is not returned in the results due to privacy * reasons. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** either + * of: + * + * - _Browse users and groups_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * - _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getUsersFromGroup( parameters: Parameters.GetUsersFromGroup, diff --git a/src/version3/issueAttachments.ts b/src/version3/issueAttachments.ts index 4c83e6fb18..8da71b34a4 100644 --- a/src/version3/issueAttachments.ts +++ b/src/version3/issueAttachments.ts @@ -1,8 +1,8 @@ import { FormData, File } from 'formdata-node'; import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueAttachments { @@ -25,6 +25,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachmentContent( parameters: Parameters.GetAttachmentContent | string, @@ -47,6 +48,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachmentContent( parameters: Parameters.GetAttachmentContent | string, @@ -115,6 +117,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachmentThumbnail( parameters: Parameters.GetAttachmentThumbnail | string, @@ -134,6 +137,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachmentThumbnail( parameters: Parameters.GetAttachmentThumbnail | string, @@ -171,6 +175,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachment( parameters: Parameters.GetAttachment | string, @@ -187,6 +192,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async getAttachment( parameters: Parameters.GetAttachment | string, @@ -270,6 +276,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async expandAttachmentForHumans( parameters: Parameters.ExpandAttachmentForHumans | string, @@ -294,6 +301,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async expandAttachmentForHumans( parameters: Parameters.ExpandAttachmentForHumans | string, @@ -332,6 +340,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async expandAttachmentForMachines( parameters: Parameters.ExpandAttachmentForMachines | string, @@ -356,6 +365,7 @@ export class IssueAttachments { * in. * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. + * - If attachments are added in private comments, the comment-level restriction will be applied. */ async expandAttachmentForMachines( parameters: Parameters.ExpandAttachmentForMachines | string, diff --git a/src/version3/issueCommentProperties.ts b/src/version3/issueCommentProperties.ts index 2fdecdea69..db07e92cc0 100644 --- a/src/version3/issueCommentProperties.ts +++ b/src/version3/issueCommentProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueCommentProperties { diff --git a/src/version3/issueCustomFieldContexts.ts b/src/version3/issueCustomFieldContexts.ts index c4ade17d87..20aa790f52 100644 --- a/src/version3/issueCustomFieldContexts.ts +++ b/src/version3/issueCustomFieldContexts.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueCustomFieldContexts { @@ -100,11 +100,11 @@ export class IssueCustomFieldContexts { url: `/rest/api/3/field/${parameters.fieldId}/context`, method: 'POST', data: { + description: parameters.description, id: parameters.id, + issueTypeIds: parameters.issueTypeIds, name: parameters.name, - description: parameters.description, projectIds: parameters.projectIds, - issueTypeIds: parameters.issueTypeIds, }, }; @@ -114,7 +114,8 @@ export class IssueCustomFieldContexts { /** * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of * defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no - * defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: + * defaults are set for a context, nothing is returned.\ + * The returned object depends on type of the custom field: * * - `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields. * - `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields. @@ -164,7 +165,8 @@ export class IssueCustomFieldContexts { /** * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of * defaults for a custom field. The results can be filtered by `contextId`, otherwise all values are returned. If no - * defaults are set for a context, nothing is returned. The returned object depends on type of the custom field: + * defaults are set for a context, nothing is returned.\ + * The returned object depends on type of the custom field: * * - `CustomFieldContextDefaultValueDate` (type `datepicker`) for date fields. * - `CustomFieldContextDefaultValueDateTime` (type `datetimepicker`) for date-time fields. @@ -513,8 +515,8 @@ export class IssueCustomFieldContexts { url: `/rest/api/3/field/${parameters.fieldId}/context/${parameters.contextId}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; diff --git a/src/version3/issueCustomFieldOptionsApps.ts b/src/version3/issueCustomFieldOptionsApps.ts index 9786d24053..616ebcbe65 100644 --- a/src/version3/issueCustomFieldOptionsApps.ts +++ b/src/version3/issueCustomFieldOptionsApps.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueCustomFieldOptionsApps { @@ -68,6 +68,8 @@ export class IssueCustomFieldOptionsApps { * used with issue field select list options created in Jira or using operations from the [Issue custom field * options](#api-group-Issue-custom-field-options) resource. * + * Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes. + * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required * for the app providing the field. @@ -83,6 +85,8 @@ export class IssueCustomFieldOptionsApps { * used with issue field select list options created in Jira or using operations from the [Issue custom field * options](#api-group-Issue-custom-field-options) resource. * + * Each field can have a maximum of 10000 options, and each option can have a maximum of 10000 scopes. + * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required * for the app providing the field. @@ -99,9 +103,9 @@ export class IssueCustomFieldOptionsApps { url: `/rest/api/3/field/${parameters.fieldKey}/option`, method: 'POST', data: { - value: parameters.value, - properties: parameters.properties, config: parameters.config, + properties: parameters.properties, + value: parameters.value, }, }; @@ -290,10 +294,10 @@ export class IssueCustomFieldOptionsApps { url: `/rest/api/3/field/${parameters.fieldKey}/option/${parameters.optionId}`, method: 'PUT', data: { + config: parameters.config, id: parameters.id, - value: parameters.value, properties: parameters.properties, - config: parameters.config, + value: parameters.value, }, }; @@ -348,7 +352,7 @@ export class IssueCustomFieldOptionsApps { * can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`. * * This is an [asynchronous - * operation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). The response + * operation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). The response * object contains a link to the long-running task. * * Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be @@ -372,7 +376,7 @@ export class IssueCustomFieldOptionsApps { * can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`. * * This is an [asynchronous - * operation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). The response + * operation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). The response * object contains a link to the long-running task. * * Note that this operation **only works for issue field select list options added by Connect apps**, it cannot be diff --git a/src/version3/issueCustomFieldValuesApps.ts b/src/version3/issueCustomFieldValuesApps.ts index 890dbb8fa9..b22d1ab2b0 100644 --- a/src/version3/issueCustomFieldValuesApps.ts +++ b/src/version3/issueCustomFieldValuesApps.ts @@ -1,6 +1,6 @@ import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueCustomFieldValuesApps { @@ -8,10 +8,18 @@ export class IssueCustomFieldValuesApps { /** * Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should - * be unique within the request. Custom fields can only be updated by the Forge app that created them. + * be unique within the request. + * + * Apps can only perform this operation on [custom + * fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom + * field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) + * declared in their own manifests. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * the app that created the custom field can update its values with this operation. + * the app that owns the custom field or custom field type can update its values with this operation. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async updateMultipleCustomFieldValues( parameters: Parameters.UpdateMultipleCustomFieldValues, @@ -19,10 +27,18 @@ export class IssueCustomFieldValuesApps { ): Promise; /** * Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should - * be unique within the request. Custom fields can only be updated by the Forge app that created them. + * be unique within the request. + * + * Apps can only perform this operation on [custom + * fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom + * field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) + * declared in their own manifests. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * the app that created the custom field can update its values with this operation. + * the app that owns the custom field or custom field type can update its values with this operation. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async updateMultipleCustomFieldValues( parameters: Parameters.UpdateMultipleCustomFieldValues, @@ -47,22 +63,36 @@ export class IssueCustomFieldValuesApps { } /** - * Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that - * created them. + * Updates the value of a custom field on one or more issues. + * + * Apps can only perform this operation on [custom + * fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom + * field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) + * declared in their own manifests. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * the app that created the custom field can update its values with this operation. + * the app that owns the custom field or custom field type can update its values with this operation. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async updateCustomFieldValue( parameters: Parameters.UpdateCustomFieldValue, callback: Callback, ): Promise; /** - * Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that - * created them. + * Updates the value of a custom field on one or more issues. + * + * Apps can only perform this operation on [custom + * fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/) and [custom + * field types](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) + * declared in their own manifests. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * the app that created the custom field can update its values with this operation. + * the app that owns the custom field or custom field type can update its values with this operation. + * + * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we + * recommend adding it to your app's scope list because we will eventually make it mandatory. */ async updateCustomFieldValue(parameters: Parameters.UpdateCustomFieldValue, callback?: never): Promise; async updateCustomFieldValue( diff --git a/src/version3/issueFieldConfigurations.ts b/src/version3/issueFieldConfigurations.ts index 49b233448c..82f27dcae6 100644 --- a/src/version3/issueFieldConfigurations.ts +++ b/src/version3/issueFieldConfigurations.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueFieldConfigurations { @@ -72,7 +72,7 @@ export class IssueFieldConfigurations { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createFieldConfiguration( - parameters: Parameters.CreateFieldConfiguration | undefined, + parameters: Parameters.CreateFieldConfiguration, callback: Callback, ): Promise; /** @@ -85,19 +85,19 @@ export class IssueFieldConfigurations { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createFieldConfiguration( - parameters?: Parameters.CreateFieldConfiguration, + parameters: Parameters.CreateFieldConfiguration, callback?: never, ): Promise; async createFieldConfiguration( - parameters?: Parameters.CreateFieldConfiguration, + parameters: Parameters.CreateFieldConfiguration, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/3/fieldconfiguration', method: 'POST', data: { - name: parameters?.name, - description: parameters?.description, + description: parameters.description, + name: parameters.name, }, }; @@ -136,8 +136,8 @@ export class IssueFieldConfigurations { url: `/rest/api/3/fieldconfiguration/${parameters.id}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; @@ -323,7 +323,7 @@ export class IssueFieldConfigurations { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createFieldConfigurationScheme( - parameters: Parameters.CreateFieldConfigurationScheme | undefined, + parameters: Parameters.CreateFieldConfigurationScheme, callback: Callback, ): Promise; /** @@ -335,19 +335,19 @@ export class IssueFieldConfigurations { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createFieldConfigurationScheme( - parameters?: Parameters.CreateFieldConfigurationScheme, + parameters: Parameters.CreateFieldConfigurationScheme, callback?: never, ): Promise; async createFieldConfigurationScheme( - parameters?: Parameters.CreateFieldConfigurationScheme, + parameters: Parameters.CreateFieldConfigurationScheme, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/3/fieldconfigurationscheme', method: 'POST', data: { - name: parameters?.name, - description: parameters?.description, + description: parameters.description, + name: parameters.name, }, }; @@ -520,8 +520,8 @@ export class IssueFieldConfigurations { url: `/rest/api/3/fieldconfigurationscheme/${parameters.id}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; diff --git a/src/version3/issueLinkTypes.ts b/src/version3/issueLinkTypes.ts index 06b4fc987b..3b82d6d72a 100644 --- a/src/version3/issueLinkTypes.ts +++ b/src/version3/issueLinkTypes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueLinkTypes { diff --git a/src/version3/issueLinks.ts b/src/version3/issueLinks.ts index e89e9fcda9..f4684aa995 100644 --- a/src/version3/issueLinks.ts +++ b/src/version3/issueLinks.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueLinks { @@ -30,7 +30,7 @@ export class IssueLinks { * to view the issue. * - If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to. */ - async linkIssues(parameters: Parameters.LinkIssues | undefined, callback: Callback): Promise; + async linkIssues(parameters: Parameters.LinkIssues, callback: Callback): Promise; /** * Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally * add a comment to the from (outward) issue. To use this resource the site must have [Issue @@ -54,16 +54,16 @@ export class IssueLinks { * to view the issue. * - If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to. */ - async linkIssues(parameters?: Parameters.LinkIssues, callback?: never): Promise; - async linkIssues(parameters?: Parameters.LinkIssues, callback?: Callback): Promise { + async linkIssues(parameters: Parameters.LinkIssues, callback?: never): Promise; + async linkIssues(parameters: Parameters.LinkIssues, callback?: Callback): Promise { const config: RequestConfig = { url: '/rest/api/3/issueLink', method: 'POST', data: { - type: parameters?.type, - inwardIssue: parameters?.inwardIssue, - outwardIssue: parameters?.outwardIssue, - comment: parameters?.comment, + comment: parameters.comment, + inwardIssue: parameters.inwardIssue, + outwardIssue: parameters.outwardIssue, + type: parameters.type, }, }; diff --git a/src/version3/issueNavigatorSettings.ts b/src/version3/issueNavigatorSettings.ts index 470e0a389c..05e89df1ed 100644 --- a/src/version3/issueNavigatorSettings.ts +++ b/src/version3/issueNavigatorSettings.ts @@ -1,6 +1,6 @@ import * as Models from './models'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueNavigatorSettings { diff --git a/src/version3/issueProperties.ts b/src/version3/issueProperties.ts index bd873db325..d1973c7107 100644 --- a/src/version3/issueProperties.ts +++ b/src/version3/issueProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueProperties { @@ -18,7 +18,7 @@ export class IssueProperties { * * - Transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are * updated. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -44,7 +44,7 @@ export class IssueProperties { * * - Transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are * updated. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -83,7 +83,7 @@ export class IssueProperties { * * This operation is: * - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * - Non-transactional. Updating some entities may fail. Such information will available in the task result. @@ -107,7 +107,7 @@ export class IssueProperties { * * This operation is: * - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * - Non-transactional. Updating some entities may fail. Such information will available in the task result. @@ -171,7 +171,7 @@ export class IssueProperties { * This operation is: * * - Transactional, either all eligible issues are updated or, when errors occur, none are updated. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -220,7 +220,7 @@ export class IssueProperties { * This operation is: * * - Transactional, either all eligible issues are updated or, when errors occur, none are updated. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -241,9 +241,9 @@ export class IssueProperties { url: `/rest/api/3/issue/properties/${parameters.propertyKey}`, method: 'PUT', data: { - value: parameters.value, expression: parameters.expression, filter: parameters.filter, + value: parameters.value, }, }; @@ -268,7 +268,7 @@ export class IssueProperties { * * - Transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are * deleted. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -302,7 +302,7 @@ export class IssueProperties { * * - Transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are * deleted. - * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * - [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. * @@ -326,8 +326,8 @@ export class IssueProperties { url: `/rest/api/3/issue/properties/${parameters.propertyKey}`, method: 'DELETE', data: { - entityIds: parameters.entityIds, currentValue: parameters.currentValue, + entityIds: parameters.entityIds, }, }; diff --git a/src/version3/issueRemoteLinks.ts b/src/version3/issueRemoteLinks.ts index 188d1f5376..ea816d56f7 100644 --- a/src/version3/issueRemoteLinks.ts +++ b/src/version3/issueRemoteLinks.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueRemoteLinks { @@ -114,10 +114,10 @@ export class IssueRemoteLinks { url: `/rest/api/3/issue/${parameters.issueIdOrKey}/remotelink`, method: 'POST', data: { - globalId: parameters.globalId, application: parameters.application, - relationship: parameters.relationship, + globalId: parameters.globalId, object: parameters.object, + relationship: parameters.relationship, }, }; @@ -272,10 +272,10 @@ export class IssueRemoteLinks { url: `/rest/api/3/issue/${parameters.issueIdOrKey}/remotelink/${parameters.linkId}`, method: 'PUT', data: { - globalId: parameters.globalId, application: parameters.application, - relationship: parameters.relationship, + globalId: parameters.globalId, object: parameters.object, + relationship: parameters.relationship, }, }; diff --git a/src/version3/issueSecurityLevel.ts b/src/version3/issueSecurityLevel.ts index 1a3e866999..39a5fd8fa2 100644 --- a/src/version3/issueSecurityLevel.ts +++ b/src/version3/issueSecurityLevel.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueSecurityLevel { diff --git a/src/version3/issueSecuritySchemes.ts b/src/version3/issueSecuritySchemes.ts index 4618823f56..ebe2eddb81 100644 --- a/src/version3/issueSecuritySchemes.ts +++ b/src/version3/issueSecuritySchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueSecuritySchemes { @@ -299,7 +299,8 @@ export class IssueSecuritySchemes { * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of issue * security schemes.\ * If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you - * filter by. + * filter by. Use {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to + * obtain all projects related to scheme. * * Only issue security schemes in the context of classic projects are returned. * @@ -314,7 +315,8 @@ export class IssueSecuritySchemes { * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of issue * security schemes.\ * If you specify the project ID parameter, the result will contain issue security schemes and related project IDs you - * filter by. + * filter by. Use {@link IssueSecuritySchemeResource#searchProjectsUsingSecuritySchemes(String, String, Set, Set)} to + * obtain all projects related to scheme. * * Only issue security schemes in the context of classic projects are returned. * diff --git a/src/version3/issueTypeProperties.ts b/src/version3/issueTypeProperties.ts index 03c2088b67..41ff4f4da0 100644 --- a/src/version3/issueTypeProperties.ts +++ b/src/version3/issueTypeProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueTypeProperties { diff --git a/src/version3/issueTypeSchemes.ts b/src/version3/issueTypeSchemes.ts index 3aec7af581..3e238d7d42 100644 --- a/src/version3/issueTypeSchemes.ts +++ b/src/version3/issueTypeSchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueTypeSchemes { @@ -60,7 +60,7 @@ export class IssueTypeSchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createIssueTypeScheme( - parameters: Parameters.CreateIssueTypeScheme | undefined, + parameters: Parameters.CreateIssueTypeScheme, callback: Callback, ): Promise; /** @@ -70,21 +70,21 @@ export class IssueTypeSchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createIssueTypeScheme( - parameters?: Parameters.CreateIssueTypeScheme, + parameters: Parameters.CreateIssueTypeScheme, callback?: never, ): Promise; async createIssueTypeScheme( - parameters?: Parameters.CreateIssueTypeScheme, + parameters: Parameters.CreateIssueTypeScheme, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/3/issuetypescheme', method: 'POST', data: { - name: parameters?.name, - description: parameters?.description, - defaultIssueTypeId: parameters?.defaultIssueTypeId, - issueTypeIds: parameters?.issueTypeIds, + defaultIssueTypeId: parameters.defaultIssueTypeId, + description: parameters.description, + issueTypeIds: parameters.issueTypeIds, + name: parameters.name, }, }; @@ -248,9 +248,9 @@ export class IssueTypeSchemes { url: `/rest/api/3/issuetypescheme/${parameters.issueTypeSchemeId}`, method: 'PUT', data: { - name: parameters.name, - description: parameters.description, defaultIssueTypeId: parameters.defaultIssueTypeId, + description: parameters.description, + name: parameters.name, }, }; @@ -377,8 +377,8 @@ export class IssueTypeSchemes { url: `/rest/api/3/issuetypescheme/${parameters.issueTypeSchemeId}/issuetype/move`, method: 'PUT', data: { - issueTypeIds: parameters.issueTypeIds, after: parameters.after, + issueTypeIds: parameters.issueTypeIds, position: parameters.position, }, }; diff --git a/src/version3/issueTypeScreenSchemes.ts b/src/version3/issueTypeScreenSchemes.ts index 2b52cba239..3f6b5be5a0 100644 --- a/src/version3/issueTypeScreenSchemes.ts +++ b/src/version3/issueTypeScreenSchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueTypeScreenSchemes { @@ -60,7 +60,7 @@ export class IssueTypeScreenSchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createIssueTypeScreenScheme( - parameters: Parameters.CreateIssueTypeScreenScheme | undefined, + parameters: Parameters.CreateIssueTypeScreenScheme, callback: Callback, ): Promise; /** @@ -70,20 +70,20 @@ export class IssueTypeScreenSchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createIssueTypeScreenScheme( - parameters?: Parameters.CreateIssueTypeScreenScheme, + parameters: Parameters.CreateIssueTypeScreenScheme, callback?: never, ): Promise; async createIssueTypeScreenScheme( - parameters?: Parameters.CreateIssueTypeScreenScheme, + parameters: Parameters.CreateIssueTypeScreenScheme, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/3/issuetypescreenscheme', method: 'POST', data: { - name: parameters?.name, - description: parameters?.description, - issueTypeMappings: parameters?.issueTypeMappings, + description: parameters.description, + issueTypeMappings: parameters.issueTypeMappings, + name: parameters.name, }, }; @@ -244,8 +244,8 @@ export class IssueTypeScreenSchemes { url: `/rest/api/3/issuetypescreenscheme/${parameters.issueTypeScreenSchemeId}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; diff --git a/src/version3/issueVotes.ts b/src/version3/issueVotes.ts index f115e57588..72ee3e4296 100644 --- a/src/version3/issueVotes.ts +++ b/src/version3/issueVotes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueVotes { diff --git a/src/version3/issueWatchers.ts b/src/version3/issueWatchers.ts index 69e2c03035..efbcc65f97 100644 --- a/src/version3/issueWatchers.ts +++ b/src/version3/issueWatchers.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueWatchers { diff --git a/src/version3/issueWorklogProperties.ts b/src/version3/issueWorklogProperties.ts index 14a743ca9f..b52b7b6f5d 100644 --- a/src/version3/issueWorklogProperties.ts +++ b/src/version3/issueWorklogProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class IssueWorklogProperties { diff --git a/src/version3/jQL.ts b/src/version3/jQL.ts index e630da739d..2d2100ea63 100644 --- a/src/version3/jQL.ts +++ b/src/version3/jQL.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class JQL { @@ -96,8 +96,8 @@ export class JQL { url: '/rest/api/3/jql/autocompletedata', method: 'POST', data: { - projectIds: parameters?.projectIds, includeCollapsedFields: parameters?.includeCollapsedFields, + projectIds: parameters?.projectIds, }, }; @@ -170,7 +170,7 @@ export class JQL { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ async parseJqlQueries( - parameters: Parameters.ParseJqlQueries | undefined, + parameters: Parameters.ParseJqlQueries, callback: Callback, ): Promise; /** @@ -183,21 +183,21 @@ export class JQL { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ async parseJqlQueries( - parameters?: Parameters.ParseJqlQueries, + parameters: Parameters.ParseJqlQueries, callback?: never, ): Promise; async parseJqlQueries( - parameters?: Parameters.ParseJqlQueries, + parameters: Parameters.ParseJqlQueries, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/3/jql/parse', method: 'POST', params: { - validation: parameters?.validation, + validation: parameters.validation, }, data: { - queries: parameters?.queries, + queries: parameters.queries, }, }; diff --git a/src/version3/jiraSettings.ts b/src/version3/jiraSettings.ts index 530adff118..3a7e1406b4 100644 --- a/src/version3/jiraSettings.ts +++ b/src/version3/jiraSettings.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class JiraSettings { @@ -88,18 +88,17 @@ export class JiraSettings { * * The advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM). * - * | Key | Description | Default value | - * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | - * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | - * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | - * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | - * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | - * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | - * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | - * | `jira.table.cols.subtasks` | The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue. | `issuetype, status, assignee, progress` | - * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | - * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | - * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | + * | Key | Description | Default value | + * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | + * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | + * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | + * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | + * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | + * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | + * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | + * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | + * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | + * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | * * #### Look and feel * @@ -148,18 +147,17 @@ export class JiraSettings { * * The advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM). * - * | Key | Description | Default value | - * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | - * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | - * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | - * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | - * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | - * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | - * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | - * | `jira.table.cols.subtasks` | The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue. | `issuetype, status, assignee, progress` | - * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | - * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | - * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | + * | Key | Description | Default value | + * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | + * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | + * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | + * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | + * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | + * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | + * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | + * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | + * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | + * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | * * #### Look and feel * diff --git a/src/version3/labels.ts b/src/version3/labels.ts index d05b19261f..f2a1098be2 100644 --- a/src/version3/labels.ts +++ b/src/version3/labels.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Labels { diff --git a/src/version3/licenseMetrics.ts b/src/version3/licenseMetrics.ts index 4cd2204fac..2f17676a1c 100644 --- a/src/version3/licenseMetrics.ts +++ b/src/version3/licenseMetrics.ts @@ -1,6 +1,6 @@ import * as Models from './models'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class LicenseMetrics { diff --git a/src/version3/myself.ts b/src/version3/myself.ts index c7b333331f..cc2ea6e448 100644 --- a/src/version3/myself.ts +++ b/src/version3/myself.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Myself { @@ -17,6 +17,14 @@ export class Myself { * - _jira.user.timezone_ The time zone of the user. By default this is not set and the user takes the timezone of the * instance. * + * These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not + * have any impact on Notification behaviour. + * + * - _user.notifications.watcher_ Whether the user gets notified when they are watcher. + * - _user.notifications.assignee_ Whether the user gets notified when they are assignee. + * - _user.notifications.reporter_ Whether the user gets notified when they are reporter. + * - _user.notifications.mentions_ Whether the user gets notified when they are mentions. + * * Use [ Update a user * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) * from the user management REST API to manage timezone and locale instead. @@ -35,6 +43,14 @@ export class Myself { * - _jira.user.timezone_ The time zone of the user. By default this is not set and the user takes the timezone of the * instance. * + * These system preferences keys will be deprecated by 15/07/2024. You can still retrieve these keys, but it will not + * have any impact on Notification behaviour. + * + * - _user.notifications.watcher_ Whether the user gets notified when they are watcher. + * - _user.notifications.assignee_ Whether the user gets notified when they are assignee. + * - _user.notifications.reporter_ Whether the user gets notified when they are reporter. + * - _user.notifications.mentions_ Whether the user gets notified when they are mentions. + * * Use [ Update a user * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) * from the user management REST API to manage timezone and locale instead. @@ -61,18 +77,26 @@ export class Myself { * following keys define system preferences that can be set or created: * * - _user.notifications.mimetype_ The mime type used in notifications sent to the user. Defaults to `html`. - * - _user.notify.own.changes_ Whether the user gets notified of their own changes. Defaults to `false`. * - _user.default.share.private_ Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. * Defaults to `true`. * - _user.keyboard.shortcuts.disabled_ Whether keyboard shortcuts are disabled. Defaults to `false`. * - _user.autowatch.disabled_ Whether the user automatically watches issues they create or add a comment to. By * default, not set: the user takes the instance autowatch setting. + * - _user.notifiy.own.changes_ Whether the user gets notified of their own changes. * * Note that these keys are deprecated: * * - _jira.user.locale_ The locale of the user. By default, not set. The user takes the instance locale. * - _jira.user.timezone_ The time zone of the user. By default, not set. The user takes the instance timezone. * + * These system preferences keys will be deprecated by 15/07/2024. You can still use these keys to create arbitrary + * preferences, but it will not have any impact on Notification behaviour. + * + * - _user.notifications.watcher_ Whether the user gets notified when they are watcher. + * - _user.notifications.assignee_ Whether the user gets notified when they are assignee. + * - _user.notifications.reporter_ Whether the user gets notified when they are reporter. + * - _user.notifications.mentions_ Whether the user gets notified when they are mentions. + * * Use [ Update a user * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) * from the user management REST API to manage timezone and locale instead. @@ -87,18 +111,26 @@ export class Myself { * following keys define system preferences that can be set or created: * * - _user.notifications.mimetype_ The mime type used in notifications sent to the user. Defaults to `html`. - * - _user.notify.own.changes_ Whether the user gets notified of their own changes. Defaults to `false`. * - _user.default.share.private_ Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. * Defaults to `true`. * - _user.keyboard.shortcuts.disabled_ Whether keyboard shortcuts are disabled. Defaults to `false`. * - _user.autowatch.disabled_ Whether the user automatically watches issues they create or add a comment to. By * default, not set: the user takes the instance autowatch setting. + * - _user.notifiy.own.changes_ Whether the user gets notified of their own changes. * * Note that these keys are deprecated: * * - _jira.user.locale_ The locale of the user. By default, not set. The user takes the instance locale. * - _jira.user.timezone_ The time zone of the user. By default, not set. The user takes the instance timezone. * + * These system preferences keys will be deprecated by 15/07/2024. You can still use these keys to create arbitrary + * preferences, but it will not have any impact on Notification behaviour. + * + * - _user.notifications.watcher_ Whether the user gets notified when they are watcher. + * - _user.notifications.assignee_ Whether the user gets notified when they are assignee. + * - _user.notifications.reporter_ Whether the user gets notified when they are reporter. + * - _user.notifications.mentions_ Whether the user gets notified when they are mentions. + * * Use [ Update a user * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) * from the user management REST API to manage timezone and locale instead. diff --git a/src/version3/permissionSchemes.ts b/src/version3/permissionSchemes.ts index 9add325b3f..f4f5f1f44a 100644 --- a/src/version3/permissionSchemes.ts +++ b/src/version3/permissionSchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class PermissionSchemes { @@ -20,8 +20,9 @@ export class PermissionSchemes { * The `holder` object contains information about the user or group being granted the permission. For example, the * _Administer projects_ permission is granted to a group named _Teams in space administrators_. In this case, the * type is `"type": "group"`, and the parameter is the group name, `"parameter": "Teams in space administrators"` and - * the value is group ID, `"value": "ca85fac0-d974-40ca-a615-7af99c48d24f"`. The `holder` object is defined by the - * following properties: + * the value is group ID, `"value": "ca85fac0-d974-40ca-a615-7af99c48d24f"`. + * + * The `holder` object is defined by the following properties: * * - `type` Identifies the user or group (see the list of types below). * - `parameter` As a group's name can change, use of `value` is recommended. The value of this property depends on the @@ -130,8 +131,9 @@ export class PermissionSchemes { * The `holder` object contains information about the user or group being granted the permission. For example, the * _Administer projects_ permission is granted to a group named _Teams in space administrators_. In this case, the * type is `"type": "group"`, and the parameter is the group name, `"parameter": "Teams in space administrators"` and - * the value is group ID, `"value": "ca85fac0-d974-40ca-a615-7af99c48d24f"`. The `holder` object is defined by the - * following properties: + * the value is group ID, `"value": "ca85fac0-d974-40ca-a615-7af99c48d24f"`. + * + * The `holder` object is defined by the following properties: * * - `type` Identifies the user or group (see the list of types below). * - `parameter` As a group's name can change, use of `value` is recommended. The value of this property depends on the @@ -477,10 +479,10 @@ export class PermissionSchemes { expand: parameters.expand, }, data: { - id: parameters.id, - self: parameters.self, holder: parameters.holder, + id: parameters.id, permission: parameters.permission, + self: parameters.self, }, }; diff --git a/src/version3/permissions.ts b/src/version3/permissions.ts index 6936121d24..45d29a9048 100644 --- a/src/version3/permissions.ts +++ b/src/version3/permissions.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Permissions { @@ -28,6 +28,12 @@ export class Permissions { * project, because any user can be a reporter. However, if they are not the user who reported the issue queried they * would not have EDIT_ISSUES permission for that issue. * + * For [Jira Service Management project + * permissions](https://support.atlassian.com/jira-cloud-administration/docs/customize-jira-service-management-permissions/), + * this will be evaluated similarly to a user in the customer portal. For example, if the BROWSE_PROJECTS permission + * is granted to Service Project Customer - Portal Access, any users with access to the customer portal will have the + * BROWSE_PROJECTS permission. + * * Global permissions are unaffected by context. * * This operation can be accessed anonymously. @@ -59,6 +65,12 @@ export class Permissions { * project, because any user can be a reporter. However, if they are not the user who reported the issue queried they * would not have EDIT_ISSUES permission for that issue. * + * For [Jira Service Management project + * permissions](https://support.atlassian.com/jira-cloud-administration/docs/customize-jira-service-management-permissions/), + * this will be evaluated similarly to a user in the customer portal. For example, if the BROWSE_PROJECTS permission + * is granted to Service Project Customer - Portal Access, any users with access to the customer portal will have the + * BROWSE_PROJECTS permission. + * * Global permissions are unaffected by context. * * This operation can be accessed anonymously. @@ -98,8 +110,9 @@ export class Permissions { * - Project permissions. * - Global permissions added by plugins. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * This operation can be accessed anonymously. + * + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ async getAllPermissions(callback: Callback): Promise; /** @@ -109,8 +122,9 @@ export class Permissions { * - Project permissions. * - Global permissions added by plugins. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * This operation can be accessed anonymously. + * + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ async getAllPermissions(callback?: never): Promise; async getAllPermissions(callback?: Callback): Promise { @@ -139,6 +153,11 @@ export class Permissions { * `projectPermissions.issues` are ignored. * - Empty strings in `projectPermissions.permissions` are ignored. * + * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. + * + * - **Classic**: `read:jira-work` + * - **Granular**: `read:permission:jira` + * * This operation can be accessed anonymously. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** @@ -168,6 +187,11 @@ export class Permissions { * `projectPermissions.issues` are ignored. * - Empty strings in `projectPermissions.permissions` are ignored. * + * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. + * + * - **Classic**: `read:jira-work` + * - **Granular**: `read:permission:jira` + * * This operation can be accessed anonymously. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** @@ -188,9 +212,9 @@ export class Permissions { url: '/rest/api/3/permissions/check', method: 'POST', data: { - projectPermissions: parameters?.projectPermissions, - globalPermissions: parameters?.globalPermissions, accountId: parameters?.accountId, + globalPermissions: parameters?.globalPermissions, + projectPermissions: parameters?.projectPermissions, }, }; diff --git a/src/version3/projectCategories.ts b/src/version3/projectCategories.ts index 8e5ff3c321..93c1040aca 100644 --- a/src/version3/projectCategories.ts +++ b/src/version3/projectCategories.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectCategories { diff --git a/src/version3/projectEmail.ts b/src/version3/projectEmail.ts index ae27bbbdea..c7c07671b2 100644 --- a/src/version3/projectEmail.ts +++ b/src/version3/projectEmail.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectEmail { @@ -46,8 +46,9 @@ export class ProjectEmail { * * If `emailAddress` is an empty string, the default email address is restored. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse - * projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** + * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project + * permission.](https://confluence.atlassian.com/x/yodKLg) */ async updateProjectEmail(parameters: Parameters.UpdateProjectEmail, callback: Callback): Promise; /** @@ -55,8 +56,9 @@ export class ProjectEmail { * * If `emailAddress` is an empty string, the default email address is restored. * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** _Browse - * projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** + * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project + * permission.](https://confluence.atlassian.com/x/yodKLg) */ async updateProjectEmail(parameters: Parameters.UpdateProjectEmail, callback?: never): Promise; async updateProjectEmail( diff --git a/src/version3/projectFeatures.ts b/src/version3/projectFeatures.ts index c7c080500c..3ea858612d 100644 --- a/src/version3/projectFeatures.ts +++ b/src/version3/projectFeatures.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectFeatures { diff --git a/src/version3/projectKeyAndNameValidation.ts b/src/version3/projectKeyAndNameValidation.ts index 811c7d0d93..bd6fe78813 100644 --- a/src/version3/projectKeyAndNameValidation.ts +++ b/src/version3/projectKeyAndNameValidation.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectKeyAndNameValidation { @@ -47,7 +47,7 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getValidProjectKey( + async getValidProjectKey( parameters: Parameters.GetValidProjectKey | string | undefined, callback: Callback, ): Promise; @@ -56,11 +56,11 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getValidProjectKey( + async getValidProjectKey( parameters?: Parameters.GetValidProjectKey | string, callback?: never, ): Promise; - async getValidProjectKey( + async getValidProjectKey( parameters?: Parameters.GetValidProjectKey | string, callback?: Callback, ): Promise { @@ -84,7 +84,7 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getValidProjectName( + async getValidProjectName( parameters: Parameters.GetValidProjectName | string, callback: Callback, ): Promise; @@ -95,11 +95,11 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getValidProjectName( + async getValidProjectName( parameters: Parameters.GetValidProjectName | string, callback?: never, ): Promise; - async getValidProjectName( + async getValidProjectName( parameters: Parameters.GetValidProjectName | string, callback?: Callback, ): Promise { diff --git a/src/version3/projectPermissionSchemes.ts b/src/version3/projectPermissionSchemes.ts index 3beb67dca1..ab4e145326 100644 --- a/src/version3/projectPermissionSchemes.ts +++ b/src/version3/projectPermissionSchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectPermissionSchemes { diff --git a/src/version3/projectProperties.ts b/src/version3/projectProperties.ts index 9c80b3a9ee..333400b5d2 100644 --- a/src/version3/projectProperties.ts +++ b/src/version3/projectProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectProperties { diff --git a/src/version3/projectRoleActors.ts b/src/version3/projectRoleActors.ts index 227a24ac32..6f41714e38 100644 --- a/src/version3/projectRoleActors.ts +++ b/src/version3/projectRoleActors.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectRoleActors { @@ -44,9 +44,9 @@ export class ProjectRoleActors { url: `/rest/api/3/project/${parameters.projectIdOrKey}/role/${parameters.id}`, method: 'POST', data: { - user: parameters.user, group: parameters.group, groupId: parameters.groupId, + user: parameters.user, }, }; @@ -195,9 +195,9 @@ export class ProjectRoleActors { url: `/rest/api/3/role/${parameters.id}/actors`, method: 'POST', data: { - user: parameters.user, - groupId: parameters.groupId, group: parameters.group, + groupId: parameters.groupId, + user: parameters.user, }, }; diff --git a/src/version3/projectRoles.ts b/src/version3/projectRoles.ts index 36bf07a571..64005bdc68 100644 --- a/src/version3/projectRoles.ts +++ b/src/version3/projectRoles.ts @@ -1,15 +1,16 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectRoles { constructor(private client: Client) {} /** - * Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and - * self URL for each role. + * Returns a list of [project + * roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) for the project + * returning the name and self URL for each role. * * Note that all project roles are shared with all projects in Jira Cloud. See [Get all project * roles](#api-rest-api-3-role-get) for more information. @@ -25,8 +26,9 @@ export class ProjectRoles { callback: Callback, ): Promise; /** - * Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and - * self URL for each role. + * Returns a list of [project + * roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) for the project + * returning the name and self URL for each role. * * Note that all project roles are shared with all projects in Jira Cloud. See [Get all project * roles](#api-rest-api-3-role-get) for more information. @@ -104,8 +106,8 @@ export class ProjectRoles { } /** - * Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the - * list of project roles is common to all projects. + * Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) and + * the details for each role. Note that the list of project roles is common to all projects. * * This operation can be accessed anonymously. * @@ -118,8 +120,8 @@ export class ProjectRoles { callback: Callback, ): Promise; /** - * Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the - * list of project roles is common to all projects. + * Returns all [project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) and + * the details for each role. Note that the list of project roles is common to all projects. * * This operation can be accessed anonymously. * @@ -154,10 +156,10 @@ export class ProjectRoles { * * ### About project roles * - * [Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with - * projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have - * a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira - * applications). + * [Project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) are a flexible + * way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally + * with all projects, but each project can have a different set of actors associated with it (unlike groups, which + * have the same membership throughout all Jira applications). * * Project roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification * schemes](#api-rest-api-3-notificationscheme-get), [issue security @@ -170,7 +172,7 @@ export class ProjectRoles { * with a project role. * * Actors may be set as [default - * members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) + * members](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/#Specifying-'default-members'-for-a-project-role) * of the project role or set at the project level: * * - Default actors: Users and groups that are assigned to the project role for all newly created projects. The default @@ -187,10 +189,10 @@ export class ProjectRoles { * * ### About project roles * - * [Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with - * projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have - * a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira - * applications). + * [Project roles](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/) are a flexible + * way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally + * with all projects, but each project can have a different set of actors associated with it (unlike groups, which + * have the same membership throughout all Jira applications). * * Project roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification * schemes](#api-rest-api-3-notificationscheme-get), [issue security @@ -203,7 +205,7 @@ export class ProjectRoles { * with a project role. * * Actors may be set as [default - * members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) + * members](https://support.atlassian.com/jira-cloud-administration/docs/manage-project-roles/#Specifying-'default-members'-for-a-project-role) * of the project role or set at the project level: * * - Default actors: Users and groups that are assigned to the project role for all newly created projects. The default @@ -262,8 +264,8 @@ export class ProjectRoles { url: '/rest/api/3/role', method: 'POST', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; @@ -340,8 +342,8 @@ export class ProjectRoles { url: `/rest/api/3/role/${parameters.id}`, method: 'POST', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; @@ -376,8 +378,8 @@ export class ProjectRoles { url: `/rest/api/3/role/${parameters.id}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; diff --git a/src/version3/projectTypes.ts b/src/version3/projectTypes.ts index 580dc24706..0544663c72 100644 --- a/src/version3/projectTypes.ts +++ b/src/version3/projectTypes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ProjectTypes { diff --git a/src/version3/screenSchemes.ts b/src/version3/screenSchemes.ts index 0d105c2fdf..3f57c7a5aa 100644 --- a/src/version3/screenSchemes.ts +++ b/src/version3/screenSchemes.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ScreenSchemes { @@ -114,8 +114,8 @@ export class ScreenSchemes { url: `/rest/api/3/screenscheme/${parameters.screenSchemeId}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, screens: parameters.screens, }, }; diff --git a/src/version3/screenTabFields.ts b/src/version3/screenTabFields.ts index 96de3f640e..9ef07edd53 100644 --- a/src/version3/screenTabFields.ts +++ b/src/version3/screenTabFields.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ScreenTabFields { diff --git a/src/version3/screens.ts b/src/version3/screens.ts index 7a1c41365c..11bb5be54b 100644 --- a/src/version3/screens.ts +++ b/src/version3/screens.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Screens { @@ -109,8 +109,8 @@ export class Screens { url: '/rest/api/3/screens', method: 'POST', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; @@ -173,8 +173,8 @@ export class Screens { url: `/rest/api/3/screens/${parameters.screenId}`, method: 'PUT', data: { - name: parameters.name, description: parameters.description, + name: parameters.name, }, }; diff --git a/src/version3/serverInfo.ts b/src/version3/serverInfo.ts index d1eb84ee3f..0e5d52465a 100644 --- a/src/version3/serverInfo.ts +++ b/src/version3/serverInfo.ts @@ -1,6 +1,6 @@ import * as Models from './models'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class ServerInfo { diff --git a/src/version3/status.ts b/src/version3/status.ts index ac52b3a0a0..5a5e0ec726 100644 --- a/src/version3/status.ts +++ b/src/version3/status.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Status { @@ -78,8 +78,8 @@ export class Status { url: '/rest/api/3/statuses', method: 'POST', data: { - statuses: parameters.statuses, scope: parameters.scope, + statuses: parameters.statuses, }, }; diff --git a/src/version3/tasks.ts b/src/version3/tasks.ts index 12997fe418..1c5252e079 100644 --- a/src/version3/tasks.ts +++ b/src/version3/tasks.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Tasks { @@ -9,12 +9,16 @@ export class Tasks { /** * Returns the status of a [long-running asynchronous - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). * * When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the * operation that created the task for details. Task details are not permanently retained. As of September 2019, * details are retained for 14 days although this period may change without notice. * + * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. + * + * - `read:jira-work` + * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** either * of: * @@ -27,12 +31,16 @@ export class Tasks { ): Promise; /** * Returns the status of a [long-running asynchronous - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). * * When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the * operation that created the task for details. Task details are not permanently retained. As of September 2019, * details are retained for 14 days although this period may change without notice. * + * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June 15, 2024. + * + * - `read:jira-work` + * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** either * of: * diff --git a/src/version3/timeTracking.ts b/src/version3/timeTracking.ts index aaae78b612..cd9a868e92 100644 --- a/src/version3/timeTracking.ts +++ b/src/version3/timeTracking.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class TimeTracking { @@ -157,10 +157,10 @@ export class TimeTracking { url: '/rest/api/3/configuration/timetracking/options', method: 'PUT', data: { - workingHoursPerDay: parameters?.workingHoursPerDay, - workingDaysPerWeek: parameters?.workingDaysPerWeek, - timeFormat: parameters?.timeFormat, defaultUnit: parameters?.defaultUnit, + timeFormat: parameters?.timeFormat, + workingDaysPerWeek: parameters?.workingDaysPerWeek, + workingHoursPerDay: parameters?.workingHoursPerDay, }, }; diff --git a/src/version3/userProperties.ts b/src/version3/userProperties.ts index a65acc1c60..7ccd353459 100644 --- a/src/version3/userProperties.ts +++ b/src/version3/userProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class UserProperties { diff --git a/src/version3/users.ts b/src/version3/users.ts index bdbfc46c98..1e4d017f20 100644 --- a/src/version3/users.ts +++ b/src/version3/users.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { paramSerializer } from '../paramSerializer'; import { RequestConfig } from '../requestConfig'; @@ -36,9 +36,9 @@ export class Users { method: 'GET', params: { accountId: parameters?.accountId, - expand: parameters?.expand, - key: parameters?.key, username: parameters?.username, + key: parameters?.key, + expand: parameters?.expand, }, }; @@ -105,8 +105,8 @@ export class Users { method: 'DELETE', params: { accountId: parameters.accountId, - key: parameters.key, username: parameters.username, + key: parameters.key, }, }; @@ -137,9 +137,9 @@ export class Users { url: '/rest/api/3/user/bulk', method: 'GET', params: { - accountId: paramSerializer('accountId', parameters.accountId), - maxResults: parameters.maxResults, startAt: parameters.startAt, + maxResults: parameters.maxResults, + accountId: paramSerializer('accountId', parameters.accountId), }, }; @@ -311,16 +311,20 @@ export class Users { } /** - * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these + * Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is + * only available to apps approved by Atlassian, according to these * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). + * For Forge apps, this API only supports access via asApp() requests. */ async getUserEmail( parameters: Parameters.GetUserEmail | string, callback: Callback, ): Promise; /** - * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these + * Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is + * only available to apps approved by Atlassian, according to these * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). + * For Forge apps, this API only supports access via asApp() requests. */ async getUserEmail( parameters: Parameters.GetUserEmail | string, @@ -344,16 +348,20 @@ export class Users { } /** - * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these + * Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is + * only available to apps approved by Atlassian, according to these * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). + * For Forge apps, this API only supports access via asApp() requests. */ async getUserEmailBulk( parameters: Parameters.GetUserEmailBulk | string, callback: Callback, ): Promise; /** - * Returns a user's email address. This API is only available to apps approved by Atlassian, according to these + * Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is + * only available to apps approved by Atlassian, according to these * [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). + * For Forge apps, this API only supports access via asApp() requests. */ async getUserEmailBulk( parameters: Parameters.GetUserEmailBulk | string, @@ -443,8 +451,8 @@ export class Users { url: '/rest/api/3/users', method: 'GET', params: { - maxResults: parameters?.maxResults, startAt: parameters?.startAt, + maxResults: parameters?.maxResults, }, }; @@ -483,8 +491,8 @@ export class Users { url: '/rest/api/3/users/search', method: 'GET', params: { - maxResults: parameters?.maxResults, startAt: parameters?.startAt, + maxResults: parameters?.maxResults, }, }; diff --git a/src/version3/webhooks.ts b/src/version3/webhooks.ts index 64d597fbc9..ea06f3e805 100644 --- a/src/version3/webhooks.ts +++ b/src/version3/webhooks.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class Webhooks { @@ -83,8 +83,8 @@ export class Webhooks { url: '/rest/api/3/webhook', method: 'POST', data: { - webhooks: parameters.webhooks, url: parameters.url, + webhooks: parameters.webhooks, }, }; diff --git a/src/version3/workflowSchemeDrafts.ts b/src/version3/workflowSchemeDrafts.ts index 9472a21faa..e75d434f27 100644 --- a/src/version3/workflowSchemeDrafts.ts +++ b/src/version3/workflowSchemeDrafts.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowSchemeDrafts { @@ -47,7 +47,8 @@ export class WorkflowSchemeDrafts { * Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to * the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is * modified, then the changes in the draft are copied back to the active workflow scheme. See [Configuring workflow - * schemes](https://confluence.atlassian.com/x/tohKLg) for more information. Note that: + * schemes](https://confluence.atlassian.com/x/tohKLg) for more information.\ + * Note that: * * - Only active workflow schemes can have draft workflow schemes. * - An active workflow scheme can only have one draft workflow scheme. @@ -63,7 +64,8 @@ export class WorkflowSchemeDrafts { * Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to * the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is * modified, then the changes in the draft are copied back to the active workflow scheme. See [Configuring workflow - * schemes](https://confluence.atlassian.com/x/tohKLg) for more information. Note that: + * schemes](https://confluence.atlassian.com/x/tohKLg) for more information.\ + * Note that: * * - Only active workflow schemes can have draft workflow schemes. * - An active workflow scheme can only have one draft workflow scheme. @@ -230,8 +232,8 @@ export class WorkflowSchemeDrafts { url: `/rest/api/3/workflowscheme/${parameters.id}/draft/default`, method: 'PUT', data: { - workflow: parameters.workflow, updateDraftIfNeeded: parameters.updateDraftIfNeeded, + workflow: parameters.workflow, }, }; @@ -378,7 +380,7 @@ export class WorkflowSchemeDrafts { * with the original workflow status to the new workflow status. * * This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain updates. * @@ -396,7 +398,7 @@ export class WorkflowSchemeDrafts { * with the original workflow status to the new workflow status. * * This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the + * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the * `location` link in the response to determine the status of the task and use [Get * task](#api-rest-api-3-task-taskId-get) to obtain updates. * @@ -495,10 +497,10 @@ export class WorkflowSchemeDrafts { workflowName: parameters.workflowName, }, data: { - workflow: parameters.workflow, - issueTypes: parameters.issueTypes, defaultMapping: parameters.defaultMapping, + issueTypes: parameters.issueTypes, updateDraftIfNeeded: parameters.updateDraftIfNeeded, + workflow: parameters.workflow, }, }; diff --git a/src/version3/workflowSchemeProjectAssociations.ts b/src/version3/workflowSchemeProjectAssociations.ts index 8c1596f10f..74f20cd0f8 100644 --- a/src/version3/workflowSchemeProjectAssociations.ts +++ b/src/version3/workflowSchemeProjectAssociations.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowSchemeProjectAssociations { @@ -81,8 +81,8 @@ export class WorkflowSchemeProjectAssociations { url: '/rest/api/3/workflowscheme/project', method: 'PUT', data: { - workflowSchemeId: parameters?.workflowSchemeId, projectId: parameters?.projectId, + workflowSchemeId: parameters?.workflowSchemeId, }, }; diff --git a/src/version3/workflowStatusCategories.ts b/src/version3/workflowStatusCategories.ts index 261b9b4d63..ae0a487616 100644 --- a/src/version3/workflowStatusCategories.ts +++ b/src/version3/workflowStatusCategories.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowStatusCategories { diff --git a/src/version3/workflowStatuses.ts b/src/version3/workflowStatuses.ts index d65c6f16de..36ccf84310 100644 --- a/src/version3/workflowStatuses.ts +++ b/src/version3/workflowStatuses.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowStatuses { diff --git a/src/version3/workflowTransitionProperties.ts b/src/version3/workflowTransitionProperties.ts index 4305996be4..934c9f8b56 100644 --- a/src/version3/workflowTransitionProperties.ts +++ b/src/version3/workflowTransitionProperties.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowTransitionProperties { diff --git a/src/version3/workflowTransitionRules.ts b/src/version3/workflowTransitionRules.ts index 21d2a8e41d..a16dde3e85 100644 --- a/src/version3/workflowTransitionRules.ts +++ b/src/version3/workflowTransitionRules.ts @@ -1,7 +1,7 @@ import * as Models from './models'; import * as Parameters from './parameters'; -import { Callback } from '../callback'; import { Client } from '../clients'; +import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; export class WorkflowTransitionRules { @@ -84,7 +84,9 @@ export class WorkflowTransitionRules { * - [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * - [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) * - * Only rules created by the calling Connect app can be updated. + * Only rules created by the calling + * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or + * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app can be updated. * * To assist with app migration, this operation can be used to: * @@ -95,7 +97,8 @@ export class WorkflowTransitionRules { * Rules are enabled if the `disabled` parameter is not provided. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * Connect apps can use this operation. + * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or + * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation. */ async updateWorkflowTransitionRuleConfigurations( parameters: Parameters.UpdateWorkflowTransitionRuleConfigurations, @@ -108,7 +111,9 @@ export class WorkflowTransitionRules { * - [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/) * - [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/) * - * Only rules created by the calling Connect app can be updated. + * Only rules created by the calling + * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or + * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app can be updated. * * To assist with app migration, this operation can be used to: * @@ -119,7 +124,8 @@ export class WorkflowTransitionRules { * Rules are enabled if the `disabled` parameter is not provided. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** Only - * Connect apps can use this operation. + * [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or + * [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation. */ async updateWorkflowTransitionRuleConfigurations( parameters: Parameters.UpdateWorkflowTransitionRuleConfigurations,