@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/platform/services/ProjectRolesService.js

@@ -17,579 +17,582 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles
  */
 class ProjectRolesService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a new project role with no [default
-     * actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to
-     * project role](#api-rest-api-3-role-id-actors-post) operation to add default
-     * actors to the project role after creating it.
-     *
-     * *Note that although a new project role is available to all projects upon
-     * creation, any default actors that are associated with the project role are not
-     * added to projects that existed prior to the role being created.*<
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "description": "A project role that represents developers in a project",
-     *   "id": 10360,
-     *   "name": "Developers",
-     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     * }
-     * @path {POST} /rest/api/3/role
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
-     * read:avatar:jira, read:project-category:jira, read:project-role:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-post
-     */
-    createProjectRole({ createUpdateRoleRequestBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: createUpdateRoleRequestBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.createProjectRole.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deletes a project role. You must specify a replacement project role if you wish
-     * to delete a project role that is in use.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @path {DELETE} /rest/api/3/role/{id}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta delete:project-role:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-delete
-     */
-    deleteProjectRole({ id, swap, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role/{id}",
-            method: "DELETE",
-            pathParams: {
-                id,
-            },
-            query: {
-                swap,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Updates the project role's name and description. You must include both a name
-     * and a description in the request.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "actors": [
-     *     {
-     *       "actorGroup": {
-     *         "displayName": "jira-developers",
-     *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
-     *         "name": "jira-developers"
-     *       },
-     *       "displayName": "jira-developers",
-     *       "id": 10240,
-     *       "name": "jira-developers",
-     *       "type": "atlassian-group-role-actor",
-     *       "user": "jira-developers"
-     *     },
-     *     {
-     *       "actorUser": {
-     *         "accountId": "5b10a2844c20165700ede21g"
-     *       },
-     *       "displayName": "Mia Krystof",
-     *       "id": 10241,
-     *       "type": "atlassian-user-role-actor"
-     *     }
-     *   ],
-     *   "description": "A project role that represents developers in a project",
-     *   "id": 10360,
-     *   "name": "Developers",
-     *   "scope": {
-     *     "project": {
-     *       "id": "10000",
-     *       "key": "KEY",
-     *       "name": "Next Gen Project"
-     *     },
-     *     "type": "PROJECT"
-     *   },
-     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     * }
-     * @path {PUT} /rest/api/3/role/{id}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
-     * read:avatar:jira, read:project-category:jira, read:project-role:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-put
-     */
-    fullyUpdateProjectRole({ id, createUpdateRoleRequestBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role/{id}",
-            method: "PUT",
-            pathParams: {
-                id,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: createUpdateRoleRequestBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.fullyUpdateProjectRole.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Gets a list of all project roles, complete with project role details and
-     * default actors.
-     *
-     * ### About project roles ###
-     *
-     * [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
-     * levels](#api-rest-api-3-issuesecurityschemes-get), [comment
-     * visibility](#api-rest-api-3-comment-list-post), and workflow conditions.
-     *
-     * #### Members and actors ####
-     *
-     * In the Jira REST API, a member of a project role is called an *actor*. An
-     * *actor* is a group or user associated with a project role.
-     *
-     * Actors may be set as [default
-     * 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 actors can be removed at the project
-     * level later if desired.
-     *  *  Actors: Users and groups that are associated with a project role for a
-     * project, which may differ from the default actors. This enables you to assign a
-     * user to different roles in different projects.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: [
-     *   {
-     *     "actors": [
-     *       {
-     *         "actorGroup": {
-     *           "displayName": "jira-developers",
-     *           "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
-     *           "name": "jira-developers"
-     *         },
-     *         "displayName": "jira-developers",
-     *         "id": 10240,
-     *         "name": "jira-developers",
-     *         "type": "atlassian-group-role-actor",
-     *         "user": "jira-developers"
-     *       },
-     *       {
-     *         "actorUser": {
-     *           "accountId": "5b10a2844c20165700ede21g"
-     *         },
-     *         "displayName": "Mia Krystof",
-     *         "id": 10241,
-     *         "type": "atlassian-user-role-actor"
-     *       }
-     *     ],
-     *     "description": "A project role that represents developers in a project",
-     *     "id": 10360,
-     *     "name": "Developers",
-     *     "scope": {
-     *       "project": {
-     *         "id": "10000",
-     *         "key": "KEY",
-     *         "name": "Next Gen Project"
-     *       },
-     *       "type": "PROJECT"
-     *     },
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     *   }
-     * ]
-     * @path {GET} /rest/api/3/role
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
-     * read:avatar:jira, read:project-category:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-get
-     */
-    getAllProjectRoles() {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role",
-            method: "GET",
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getAllProjectRoles.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns a project role's details and actors associated with the project. The
-     * list of actors is sorted by display name.
-     *
-     * To check whether a user belongs to a role based on their group memberships, use
-     * [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter
-     * selected. Then check whether the user keys and groups match with the actors
-     * returned for the project.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** *Administer Projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for the project or
-     * *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "actors": [
-     *     {
-     *       "actorGroup": {
-     *         "displayName": "jira-developers",
-     *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
-     *         "name": "jira-developers"
-     *       },
-     *       "displayName": "jira-developers",
-     *       "id": 10240,
-     *       "name": "jira-developers",
-     *       "type": "atlassian-group-role-actor",
-     *       "user": "jira-developers"
-     *     },
-     *     {
-     *       "actorUser": {
-     *         "accountId": "5b10a2844c20165700ede21g"
-     *       },
-     *       "displayName": "Mia Krystof",
-     *       "id": 10241,
-     *       "type": "atlassian-user-role-actor"
-     *     }
-     *   ],
-     *   "description": "A project role that represents developers in a project",
-     *   "id": 10360,
-     *   "name": "Developers",
-     *   "scope": {
-     *     "project": {
-     *       "id": "10000",
-     *       "key": "KEY",
-     *       "name": "Next Gen Project"
-     *     },
-     *     "type": "PROJECT"
-     *   },
-     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     * }
-     * @path {GET} /rest/api/3/project/{projectIdOrKey}/role/{id}
-     * @scopes-current read:jira-work
-     * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
-     * read:avatar:jira, read:project-category:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-role-id-get
-     */
-    getProjectRole({ projectIdOrKey, id, excludeInactiveUsers, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/project/{projectIdOrKey}/role/{id}",
-            method: "GET",
-            pathParams: {
-                projectIdOrKey,
-                id,
-            },
-            query: {
-                excludeInactiveUsers,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRole.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Gets the project role details and the default actors associated with the role.
-     * The list of default actors is sorted by display name.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "actors": [
-     *     {
-     *       "actorGroup": {
-     *         "displayName": "jira-developers",
-     *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
-     *         "name": "jira-developers"
-     *       },
-     *       "displayName": "jira-developers",
-     *       "id": 10240,
-     *       "name": "jira-developers",
-     *       "type": "atlassian-group-role-actor",
-     *       "user": "jira-developers"
-     *     },
-     *     {
-     *       "actorUser": {
-     *         "accountId": "5b10a2844c20165700ede21g"
-     *       },
-     *       "displayName": "Mia Krystof",
-     *       "id": 10241,
-     *       "type": "atlassian-user-role-actor"
-     *     }
-     *   ],
-     *   "description": "A project role that represents developers in a project",
-     *   "id": 10360,
-     *   "name": "Developers",
-     *   "scope": {
-     *     "project": {
-     *       "id": "10000",
-     *       "key": "KEY",
-     *       "name": "Next Gen Project"
-     *     },
-     *     "type": "PROJECT"
-     *   },
-     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     * }
-     * @path {GET} /rest/api/3/role/{id}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
-     * read:avatar:jira, read:project-category:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-get
-     */
-    getProjectRoleById({ id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role/{id}",
-            method: "GET",
-            pathParams: {
-                id,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoleById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
-     * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: [
-     *   {
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
-     *     "name": "Developers",
-     *     "id": 10360,
-     *     "description": "A project role that represents developers in a project",
-     *     "admin": false,
-     *     "default": true,
-     *     "roleConfigurable": true,
-     *     "translatedName": "Developers"
-     *   }
-     * ]
-     * @path {GET} /rest/api/3/project/{projectIdOrKey}/roledetails
-     * @scopes-current read:jira-work
-     * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
-     * read:avatar:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-roledetails-get
-     */
-    getProjectRoleDetails({ projectIdOrKey, currentMember, excludeConnectAddons, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/project/{projectIdOrKey}/roledetails",
-            method: "GET",
-            pathParams: {
-                projectIdOrKey,
-            },
-            query: {
-                currentMember,
-                excludeConnectAddons,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoleDetails.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * 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.
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** *Administer Projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for any project on the
-     * site or *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "Administrators":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002",
-     *   "Developers":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10000",
-     *   "Users": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001"
-     * }
-     * @path {GET} /rest/api/3/project/{projectIdOrKey}/role
-     * @scopes-current read:jira-work
-     * @scopes-beta read:project-role:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-role-get
-     */
-    getProjectRoles({ projectIdOrKey, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/project/{projectIdOrKey}/role",
-            method: "GET",
-            pathParams: {
-                projectIdOrKey,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoles.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Updates either the project role's name or its description.
-     *
-     * You cannot update both the name and description at the same time using this
-     * operation. If you send a request with a name and a description only the name is
-     * updated.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "actors": [
-     *     {
-     *       "actorGroup": {
-     *         "displayName": "jira-developers",
-     *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
-     *         "name": "jira-developers"
-     *       },
-     *       "displayName": "jira-developers",
-     *       "id": 10240,
-     *       "name": "jira-developers",
-     *       "type": "atlassian-group-role-actor",
-     *       "user": "jira-developers"
-     *     },
-     *     {
-     *       "actorUser": {
-     *         "accountId": "5b10a2844c20165700ede21g"
-     *       },
-     *       "displayName": "Mia Krystof",
-     *       "id": 10241,
-     *       "type": "atlassian-user-role-actor"
-     *     }
-     *   ],
-     *   "description": "A project role that represents developers in a project",
-     *   "id": 10360,
-     *   "name": "Developers",
-     *   "scope": {
-     *     "project": {
-     *       "id": "10000",
-     *       "key": "KEY",
-     *       "name": "Next Gen Project"
-     *     },
-     *     "type": "PROJECT"
-     *   },
-     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
-     * }
-     * @path {POST} /rest/api/3/role/{id}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
-     * read:avatar:jira, read:project-category:jira, read:project-role:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-post
-     */
-    partialUpdateProjectRole({ id, createUpdateRoleRequestBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/role/{id}",
-            method: "POST",
-            pathParams: {
-                id,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: createUpdateRoleRequestBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.partialUpdateProjectRole.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a new project role with no [default
+         * actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to
+         * project role](#api-rest-api-3-role-id-actors-post) operation to add default
+         * actors to the project role after creating it.
+         *
+         * *Note that although a new project role is available to all projects upon
+         * creation, any default actors that are associated with the project role are not
+         * added to projects that existed prior to the role being created.*<
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "description": "A project role that represents developers in a project",
+         *   "id": 10360,
+         *   "name": "Developers",
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         * }
+         * @path {POST} /rest/api/3/role
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
+         * read:avatar:jira, read:project-category:jira, read:project-role:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-post
+         */
+        this.createProjectRole = ({ createUpdateRoleRequestBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: createUpdateRoleRequestBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.createProjectRole.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deletes a project role. You must specify a replacement project role if you wish
+         * to delete a project role that is in use.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @path {DELETE} /rest/api/3/role/{id}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta delete:project-role:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-delete
+         */
+        this.deleteProjectRole = ({ id, swap, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role/{id}",
+                method: "DELETE",
+                pathParams: {
+                    id,
+                },
+                query: {
+                    swap,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Updates the project role's name and description. You must include both a name
+         * and a description in the request.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "actors": [
+         *     {
+         *       "actorGroup": {
+         *         "displayName": "jira-developers",
+         *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
+         *         "name": "jira-developers"
+         *       },
+         *       "displayName": "jira-developers",
+         *       "id": 10240,
+         *       "name": "jira-developers",
+         *       "type": "atlassian-group-role-actor",
+         *       "user": "jira-developers"
+         *     },
+         *     {
+         *       "actorUser": {
+         *         "accountId": "5b10a2844c20165700ede21g"
+         *       },
+         *       "displayName": "Mia Krystof",
+         *       "id": 10241,
+         *       "type": "atlassian-user-role-actor"
+         *     }
+         *   ],
+         *   "description": "A project role that represents developers in a project",
+         *   "id": 10360,
+         *   "name": "Developers",
+         *   "scope": {
+         *     "project": {
+         *       "id": "10000",
+         *       "key": "KEY",
+         *       "name": "Next Gen Project"
+         *     },
+         *     "type": "PROJECT"
+         *   },
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         * }
+         * @path {PUT} /rest/api/3/role/{id}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
+         * read:avatar:jira, read:project-category:jira, read:project-role:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-put
+         */
+        this.fullyUpdateProjectRole = ({ id, createUpdateRoleRequestBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role/{id}",
+                method: "PUT",
+                pathParams: {
+                    id,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: createUpdateRoleRequestBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.fullyUpdateProjectRole.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Gets a list of all project roles, complete with project role details and
+         * default actors.
+         *
+         * ### About project roles ###
+         *
+         * [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
+         * levels](#api-rest-api-3-issuesecurityschemes-get), [comment
+         * visibility](#api-rest-api-3-comment-list-post), and workflow conditions.
+         *
+         * #### Members and actors ####
+         *
+         * In the Jira REST API, a member of a project role is called an *actor*. An
+         * *actor* is a group or user associated with a project role.
+         *
+         * Actors may be set as [default
+         * 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 actors can be removed at the project
+         * level later if desired.
+         *  *  Actors: Users and groups that are associated with a project role for a
+         * project, which may differ from the default actors. This enables you to assign a
+         * user to different roles in different projects.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: [
+         *   {
+         *     "actors": [
+         *       {
+         *         "actorGroup": {
+         *           "displayName": "jira-developers",
+         *           "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
+         *           "name": "jira-developers"
+         *         },
+         *         "displayName": "jira-developers",
+         *         "id": 10240,
+         *         "name": "jira-developers",
+         *         "type": "atlassian-group-role-actor",
+         *         "user": "jira-developers"
+         *       },
+         *       {
+         *         "actorUser": {
+         *           "accountId": "5b10a2844c20165700ede21g"
+         *         },
+         *         "displayName": "Mia Krystof",
+         *         "id": 10241,
+         *         "type": "atlassian-user-role-actor"
+         *       }
+         *     ],
+         *     "description": "A project role that represents developers in a project",
+         *     "id": 10360,
+         *     "name": "Developers",
+         *     "scope": {
+         *       "project": {
+         *         "id": "10000",
+         *         "key": "KEY",
+         *         "name": "Next Gen Project"
+         *       },
+         *       "type": "PROJECT"
+         *     },
+         *     "self":
+         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         *   }
+         * ]
+         * @path {GET} /rest/api/3/role
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+         * read:avatar:jira, read:project-category:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-get
+         */
+        this.getAllProjectRoles = () => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role",
+                method: "GET",
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getAllProjectRoles.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns a project role's details and actors associated with the project. The
+         * list of actors is sorted by display name.
+         *
+         * To check whether a user belongs to a role based on their group memberships, use
+         * [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter
+         * selected. Then check whether the user keys and groups match with the actors
+         * returned for the project.
+         *
+         * This operation can be accessed anonymously.
+         *
+         * **[Permissions](#permissions) required:** *Administer Projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for the project or
+         * *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "actors": [
+         *     {
+         *       "actorGroup": {
+         *         "displayName": "jira-developers",
+         *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
+         *         "name": "jira-developers"
+         *       },
+         *       "displayName": "jira-developers",
+         *       "id": 10240,
+         *       "name": "jira-developers",
+         *       "type": "atlassian-group-role-actor",
+         *       "user": "jira-developers"
+         *     },
+         *     {
+         *       "actorUser": {
+         *         "accountId": "5b10a2844c20165700ede21g"
+         *       },
+         *       "displayName": "Mia Krystof",
+         *       "id": 10241,
+         *       "type": "atlassian-user-role-actor"
+         *     }
+         *   ],
+         *   "description": "A project role that represents developers in a project",
+         *   "id": 10360,
+         *   "name": "Developers",
+         *   "scope": {
+         *     "project": {
+         *       "id": "10000",
+         *       "key": "KEY",
+         *       "name": "Next Gen Project"
+         *     },
+         *     "type": "PROJECT"
+         *   },
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         * }
+         * @path {GET} /rest/api/3/project/{projectIdOrKey}/role/{id}
+         * @scopes-current read:jira-work
+         * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+         * read:avatar:jira, read:project-category:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-role-id-get
+         */
+        this.getProjectRole = ({ projectIdOrKey, id, excludeInactiveUsers, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/project/{projectIdOrKey}/role/{id}",
+                method: "GET",
+                pathParams: {
+                    projectIdOrKey,
+                    id,
+                },
+                query: {
+                    excludeInactiveUsers,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRole.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Gets the project role details and the default actors associated with the role.
+         * The list of default actors is sorted by display name.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "actors": [
+         *     {
+         *       "actorGroup": {
+         *         "displayName": "jira-developers",
+         *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
+         *         "name": "jira-developers"
+         *       },
+         *       "displayName": "jira-developers",
+         *       "id": 10240,
+         *       "name": "jira-developers",
+         *       "type": "atlassian-group-role-actor",
+         *       "user": "jira-developers"
+         *     },
+         *     {
+         *       "actorUser": {
+         *         "accountId": "5b10a2844c20165700ede21g"
+         *       },
+         *       "displayName": "Mia Krystof",
+         *       "id": 10241,
+         *       "type": "atlassian-user-role-actor"
+         *     }
+         *   ],
+         *   "description": "A project role that represents developers in a project",
+         *   "id": 10360,
+         *   "name": "Developers",
+         *   "scope": {
+         *     "project": {
+         *       "id": "10000",
+         *       "key": "KEY",
+         *       "name": "Next Gen Project"
+         *     },
+         *     "type": "PROJECT"
+         *   },
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         * }
+         * @path {GET} /rest/api/3/role/{id}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+         * read:avatar:jira, read:project-category:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-get
+         */
+        this.getProjectRoleById = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role/{id}",
+                method: "GET",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoleById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
+         * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: [
+         *   {
+         *     "self":
+         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+         *     "name": "Developers",
+         *     "id": 10360,
+         *     "description": "A project role that represents developers in a project",
+         *     "admin": false,
+         *     "default": true,
+         *     "roleConfigurable": true,
+         *     "translatedName": "Developers"
+         *   }
+         * ]
+         * @path {GET} /rest/api/3/project/{projectIdOrKey}/roledetails
+         * @scopes-current read:jira-work
+         * @scopes-beta read:project-category:jira, read:project-role:jira, read:project:jira,
+         * read:avatar:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-roledetails-get
+         */
+        this.getProjectRoleDetails = ({ projectIdOrKey, currentMember, excludeConnectAddons, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/project/{projectIdOrKey}/roledetails",
+                method: "GET",
+                pathParams: {
+                    projectIdOrKey,
+                },
+                query: {
+                    currentMember,
+                    excludeConnectAddons,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoleDetails.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * 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.
+         *
+         * This operation can be accessed anonymously.
+         *
+         * **[Permissions](#permissions) required:** *Administer Projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for any project on the
+         * site or *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "Administrators":
+         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002",
+         *   "Developers":
+         * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10000",
+         *   "Users": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001"
+         * }
+         * @path {GET} /rest/api/3/project/{projectIdOrKey}/role
+         * @scopes-current read:jira-work
+         * @scopes-beta read:project-role:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-project-projectidorkey-role-get
+         */
+        this.getProjectRoles = ({ projectIdOrKey, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/project/{projectIdOrKey}/role",
+                method: "GET",
+                pathParams: {
+                    projectIdOrKey,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.getProjectRoles.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Updates either the project role's name or its description.
+         *
+         * You cannot update both the name and description at the same time using this
+         * operation. If you send a request with a name and a description only the name is
+         * updated.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "actors": [
+         *     {
+         *       "actorGroup": {
+         *         "displayName": "jira-developers",
+         *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2",
+         *         "name": "jira-developers"
+         *       },
+         *       "displayName": "jira-developers",
+         *       "id": 10240,
+         *       "name": "jira-developers",
+         *       "type": "atlassian-group-role-actor",
+         *       "user": "jira-developers"
+         *     },
+         *     {
+         *       "actorUser": {
+         *         "accountId": "5b10a2844c20165700ede21g"
+         *       },
+         *       "displayName": "Mia Krystof",
+         *       "id": 10241,
+         *       "type": "atlassian-user-role-actor"
+         *     }
+         *   ],
+         *   "description": "A project role that represents developers in a project",
+         *   "id": 10360,
+         *   "name": "Developers",
+         *   "scope": {
+         *     "project": {
+         *       "id": "10000",
+         *       "key": "KEY",
+         *       "name": "Next Gen Project"
+         *     },
+         *     "type": "PROJECT"
+         *   },
+         *   "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360"
+         * }
+         * @path {POST} /rest/api/3/role/{id}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta read:user:jira, read:group:jira, read:project:jira, write:project-role:jira,
+         * read:avatar:jira, read:project-category:jira, read:project-role:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-roles#api-rest-api-3-role-id-post
+         */
+        this.partialUpdateProjectRole = ({ id, createUpdateRoleRequestBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/role/{id}",
+                method: "POST",
+                pathParams: {
+                    id,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: createUpdateRoleRequestBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("ProjectRolesService.partialUpdateProjectRole.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ProjectRolesService.getProjectRoles.response", zod_1.z