Version 3 simple updates

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",

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 {

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,15 +12,15 @@ 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<T = unknown>(parameters: Parameters.UpdateIssueFields, callback: Callback<T>): Promise<void>;
   /**
    * Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom
    * 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<T = unknown>(parameters: Parameters.UpdateIssueFields, callback?: never): Promise<T>;
   async updateIssueFields<T = unknown>(
@@ -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<T = unknown>(
     parameters: Parameters.UpdateEntityPropertiesValue,
     callback: Callback<T>,
   ): Promise<void>;
   /**
-   * 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<T = unknown>(
     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<T = Models.WorkflowRulesSearchDetails>(
     parameters: Parameters.WorkflowRuleSearch,
     callback: Callback<T>,
   ): Promise<void>;
   /**
-   * 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<T = Models.WorkflowRulesSearchDetails>(
     parameters: Parameters.WorkflowRuleSearch,

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<T = Models.PropertyKeys>(
     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<T = Models.PropertyKeys>(
     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<T = Models.EntityProperty>(
     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<T = Models.EntityProperty>(
     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<T = Models.OperationMessage>(
     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<T = Models.OperationMessage>(
     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<T = void>(parameters: Parameters.DeleteAddonProperty, callback: Callback<T>): Promise<void>;
   /**
    * 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<T = void>(parameters: Parameters.DeleteAddonProperty, callback?: never): Promise<T>;
   async deleteAddonProperty<T = void>(
@@ -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<T = Models.OperationMessage>(
     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<T = Models.OperationMessage>(
     parameters: Parameters.PutAppProperty,
@@ -200,13 +206,19 @@ 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<T = void>(parameters: Parameters.DeleteAppProperty, callback: Callback<T>): Promise<void>;
   /**
    * Deletes a Forge app's property.
    *
    * **[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<T = void>(parameters: Parameters.DeleteAppProperty, callback?: never): Promise<T>;
   async deleteAppProperty<T = void>(

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 {

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 {

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 {

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,
       },
     };
 

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 {

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<T = Models.PageUserDetails>(
     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<T = Models.PageUserDetails>(
     parameters: Parameters.GetUsersFromGroup,