Clients added to README.md

CHANGELOG.md

@@ -2,10 +2,13 @@
 
 ### 4.1.0
 
-// todo add links to code for new classes and modified methods
-
 - **General Improvements:** Enhanced JSDoc documentation across the project for better clarity and developer experience.
 
+- **Deprecation:** Marked the `InstanceInformation.getLicense` method as deprecated.
+- **Deprecation:** Marked the `Issues.getCreateIssueMeta` method as deprecated.
+- **Deprecation:** Marked the `PageBeanFieldConfigurationDetails` class as deprecated. Use `Paginated<FieldConfigurationDetails>` instead.
+- **Deprecation:** Marked the `WorkflowUpdateResponse` and `WorkflowCreateResponse` classes as deprecated.
+
 - **New APIs:** Added the following classes to support additional Jira APIs:
   - **`AppDataPolicies`**: Manage app access rule data policies, allowing developers to set and retrieve rules controlling app access ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-app-data-policies/#api-group-app-data-policies)).
   - **`ClassificationLevels`**: Define and manage classification levels for sensitive information in Jira ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/#api-group-classification-levels)).
@@ -17,10 +20,6 @@
   - **`TeamsInPlan`**: Configure settings for Atlassian and custom teams within advanced roadmaps plans, including creating, updating, and deleting team configurations ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan/#api-group-teams-in-plan)).
 
 - **Improvement:** Changed the return type of `ProjectKeyAndNameValidation.getValidProjectKey` and `ProjectKeyAndNameValidation.getValidProjectName` from `unknown` to `string` for improved type safety and usability.
-- **Improvement:** Added the `extendAdminPermissions` parameter to the following methods in the `Dashboard` class:
-  - `Dashboard.createDashboard`
-  - `Dashboard.updateDashboard`
-  - `Dashboard.copyDashboard`
 - **Improvement:** Added the `approximateLastUsed` parameter to the `Filters.createFilter` method.
 - **Improvement:** Added the `isSubstringMatch` parameter to the `Filters.getFiltersPaginated` method.
 - **Improvement:** Updated the `IssueComments.updateComment` method to allow passing a plain string for the comment instead of requiring a specific object format.
@@ -38,6 +37,10 @@
 - **Improvement:** Added the optional `componentSource` parameter to the `ProjectComponents.getProjectComponents` method.
 - **Improvement:** Added the `approvers` and `driver` parameters to the `ProjectVersions.createVersion` and `ProjectVersions.updateVersion` methods.
 - **Improvement:** Replaced the `maxResults` property with `maxResult` in the `UserSearch.findUserKeysByQuery` method.
+- **Improvement:** Added the `extendAdminPermissions` parameter to the following methods in the `Dashboard` class:
+  - `Dashboard.createDashboard`
+  - `Dashboard.updateDashboard`
+  - `Dashboard.copyDashboard`
 
 - **New Method:** Added the `getCustomFieldsConfigurations` method to the `IssueCustomFieldConfigurationApps` class.
 - **New Method:** Added the `replaceCustomFieldOption` method to the `IssueCustomFieldOptions` class.
@@ -77,6 +80,12 @@
   - `updateRelatedWork`: Update related work for a version.
   - `createRelatedWork`: Create related work for a version.
   - `getRelatedWork`: Retrieve related work for a version.
+- **New Method:** Added the `getProjectUsagesForWorkflowScheme` method to the `WorkflowSchemes` class.
+- **New Method:** Added the `getWorkflowProjectIssueTypeUsages` method to the `Workflows` class.
+- **New Methods:** Added the following methods to the `Status` class:
+  - `getProjectIssueTypeUsagesForStatus`
+  - `getProjectUsagesForStatus`
+  - `getWorkflowUsagesForStatus`
 
 - **Fix:** Updated the following methods in `Version2Client` and `Version3Client` to make the `parameters` argument mandatory (as it should have been initially):
   - `IssueFieldConfigurations.createFieldConfiguration`
@@ -92,6 +101,8 @@
   - `IssueSearch.matchIssues`
   - `IssueSearch.searchForIssuesUsingJql`
   - `JiraExpressions.evaluateJiraExpression`
+  - `Users.setUserColumns`
+  - `Users.getUser`
 - **Fix:** Improved the `Avatars.storeAvatar` method:
   - Added the `mimeType` parameter to specify the type of the uploaded avatar.
   - Updated the type of the `avatar` parameter from `any` to `Buffer | ArrayBuffer | Uint8Array | any` for better type safety.
@@ -106,11 +117,6 @@
   - Set the default value of the `size` parameter to `0`.
 
 - **Change:** Removed the `filter` parameter from the `JqlFunctionsApps.getPrecomputations` method (experimental method, not a breaking change).
-
-- **Deprecation:** Marked the `InstanceInformation.getLicense` method as deprecated.
-- **Deprecation:** Marked the `Issues.getCreateIssueMeta` method as deprecated.
-- **Deprecation:** Marked the `PageBeanFieldConfigurationDetails` class as deprecated. Use `Paginated<FieldConfigurationDetails>` instead.
-
 - **Change:** Renamed `JiraExpressionEvaluateContextBean` to `JiraExpressionEvaluateContext`.
 
 - **Improvement:** Added type `string` for properties `projectId` in parameters and models:
@@ -156,15 +162,6 @@
 - **Special thanks to Ness Li ([nessgor](https://github.com/nessgor)) for implementing the changes above. PR: [#356](https://github.com/MrRefactoring/jira.js/pull/356).**
 - **Thanks to Niklas Correnz ([uncaught](https://github.com/uncaught)) for reporting the issue: [#352](https://github.com/MrRefactoring/jira.js/issues/352).**
 
-// todo
-
-- `getProjectUsagesForWorkflowScheme` added to `WorkflowSchemes`
-- `getWorkflowProjectIssueTypeUsages` added to `Workflows`
-- `WorkflowUpdateResponse`, `WorkflowCreateResponse` was deprecated
-- `Users.setUserColumns` parameters are required now
-- `Users.getUser` parameters are required now
-- Added `getProjectIssueTypeUsagesForStatus`, `getProjectUsagesForStatus`, `getWorkflowUsagesForStatus` to `Status`
-
 ---
 
 ### 4.0.6

README.md

@@ -294,9 +294,12 @@ Available groups:
   - [myself](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-myself/#api-group-myself)
   - [permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permissions/#api-group-permissions)
   - [permissionSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permission-schemes/#api-group-permission-schemes)
+  - [plans](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-plans/#api-group-plans)
+  - [prioritySchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-priority-schemes/#api-group-priority-schemes)
   - [projects](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-projects/#api-group-projects)
   - [projectAvatars](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-avatars/#api-group-project-avatars)
   - [projectCategories](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-categories/#api-group-project-categories)
+  - [projectClassificationLevels](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-classification-levels/#api-group-project-classification-levels)
   - [projectComponents](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-components/#api-group-project-components)
   - [projectEmail](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-email/#api-group-project-email)
   - [projectFeatures](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-features/#api-group-project-features)
@@ -312,8 +315,10 @@ Available groups:
   - [screenTabFields](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-tab-fields/#api-group-screen-tab-fields)
   - [screenSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/#api-group-screen-schemes)
   - [serverInfo](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-server-info/#api-group-server-info)
+  - [serviceRegistry](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-service-registry/#api-group-service-registry)
   - [status](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-status/#api-group-status)
   - [tasks](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-group-tasks)
+  - [teamsInPlan](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-teams-in-plan/#api-group-teams-in-plan)
   - [timeTracking](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-time-tracking/#api-group-time-tracking)
   - [uiModificationsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-ui-modifications--apps-/#api-group-ui-modifications--apps-)
   - [users](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-group-users)

package.json

@@ -58,18 +58,18 @@
   },
   "devDependencies": {
     "@types/node": "^18.19.76",
-    "@types/sinon": "^17.0.3",
+    "@types/sinon": "^17.0.4",
     "@typescript-eslint/eslint-plugin": "^8.24.1",
     "@typescript-eslint/parser": "^8.24.1",
     "dotenv": "^16.4.7",
     "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-import-resolver-typescript": "^3.8.3",
     "eslint-plugin-import": "^2.31.0",
-    "prettier": "^3.5.1",
+    "prettier": "^3.5.2",
     "prettier-plugin-jsdoc": "^1.3.2",
     "sinon": "^18.0.1",
-    "typedoc": "^0.27.7",
+    "typedoc": "^0.27.8",
     "typescript": "^5.7.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.0.6"