@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/project-role-actors-service.ts

@@ -0,0 +1,627 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type ProjectRole,
+  registerCommonValidationSchemas,
+} from "../models/common";
+import type {
+  ActorInputBean,
+  ActorsMap,
+  ProjectRoleActorsUpdateBean,
+} from "../models/project-role-actors";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents the users assigned to [project
+ * roles](#api-group-Issue-comments). Use it to get, add, and remove default users
+ * from project roles. Also use it to add and remove users from a project role
+ * associated with a project.
+ */
+export class ProjectRoleActorsService extends CommonHttpService {
+  /**
+   * Adds actors to a project role for the project.
+   *
+   * To replace all actors for the project, use [Set actors for project
+   * role](#api-rest-api-3-project-projectIdOrKey-role-id-put).
+   *
+   * 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. The complete list of actors for the
+   * project is returned.
+   *
+   * For example, the cURL request above adds a group, *jira-developers*. For the
+   * response below to be returned as a result of that request, the user *Mia
+   * Krystof* would have previously been added as a `user` actor for this project.
+   *
+   * 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/project/{projectIdOrKey}/role/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+   * write:project-role:jira, read:avatar:jira, read:project-category:jira
+   */
+  addActorUsers({
+    projectIdOrKey,
+    id,
+    actorsMap,
+  }: {
+    /** The project ID or project key (case sensitive). */
+    projectIdOrKey: string;
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+    /**
+     * The groups or users to associate with the project role for this project.
+     * Provide the user account ID, group name, or group ID. As a group's name can
+     * change, use of group ID is recommended.
+     *
+     * @example {
+     *     "groupId": [
+     *         "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *     ]
+     * }
+     */
+    actorsMap: ActorsMap;
+  }): Promise<ProjectRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/project/{projectIdOrKey}/role/{id}",
+        method: "POST",
+        pathParams: {
+          projectIdOrKey,
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: actorsMap,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ProjectRoleActorsService.addActorUsers.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Adds [default actors](#api-rest-api-3-resolution-get) to a role. You may add
+   * groups or users, but you cannot add groups and users in the same request.
+   *
+   * Changing a project role's default actors does not affect project role members
+   * for projects already created.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "actors": [
+   *     {
+   *       "actorGroup": {
+   *         "name": "jira-developers",
+   *         "displayName": "jira-developers",
+   *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+   *       },
+   *       "displayName": "jira-developers",
+   *       "id": 10240,
+   *       "name": "jira-developers",
+   *       "type": "atlassian-group-role-actor"
+   *     }
+   *   ]
+   * }
+   * @path {POST} /rest/api/3/role/{id}/actors
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+   * write:project-role:jira, read:avatar:jira, read:project-category:jira
+   */
+  addProjectRoleActorsToRole({
+    id,
+    actorInputBean,
+  }: {
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+    /**
+     * @example {
+     *     "user": [
+     *         "admin"
+     *     ]
+     * }
+     */
+    actorInputBean: ActorInputBean;
+  }): Promise<ProjectRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/role/{id}/actors",
+        method: "POST",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: actorInputBean,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ProjectRoleActorsService.addProjectRoleActorsToRole.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes actors from a project role for the project.
+   *
+   * To remove default actors from the project role, use [Delete default actors from
+   * project role](#api-rest-api-3-role-id-actors-delete).
+   *
+   * 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).
+   *
+   * @path {DELETE} /rest/api/3/project/{projectIdOrKey}/role/{id}
+   * @scopes-current manage:jira-project
+   * @scopes-beta delete:project-role:jira
+   */
+  deleteActor({
+    projectIdOrKey,
+    id,
+    user,
+    group,
+    groupId,
+  }: {
+    /** The project ID or project key (case sensitive). */
+    projectIdOrKey: string;
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+    /** The user account ID of the user to remove from the project role. */
+    user?: string;
+    /**
+     * The name of the group to remove from the project role. This parameter cannot be
+     * used with the `groupId` parameter. As a group's name can change, use of
+     * `groupId` is recommended.
+     */
+    group?: string;
+    /**
+     * The ID of the group to remove from the project role. This parameter cannot be
+     * used with the `group` parameter.
+     */
+    groupId?: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/project/{projectIdOrKey}/role/{id}",
+        method: "DELETE",
+        pathParams: {
+          projectIdOrKey,
+          id,
+        },
+        query: {
+          user,
+          group,
+          groupId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Deletes the [default actors](#api-rest-api-3-resolution-get) from a project
+   * role. You may delete a group or user, but you cannot delete a group and a user
+   * in the same request.
+   *
+   * Changing a project role's default actors does not affect project role members
+   * for projects already created.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "actors": [
+   *     {
+   *       "actorGroup": {
+   *         "name": "jira-developers",
+   *         "displayName": "jira-developers",
+   *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+   *       },
+   *       "displayName": "jira-developers",
+   *       "id": 10240,
+   *       "name": "jira-developers",
+   *       "type": "atlassian-group-role-actor"
+   *     }
+   *   ]
+   * }
+   * @path {DELETE} /rest/api/3/role/{id}/actors
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:project-role:jira, read:user:jira, read:group:jira,
+   * read:project-role:jira, read:project:jira, read:avatar:jira,
+   * read:project-category:jira
+   */
+  deleteProjectRoleActorsFromRole({
+    id,
+    user,
+    groupId,
+    group,
+  }: {
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+    /** The user account ID of the user to remove as a default actor. */
+    user?: string;
+    /**
+     * The group ID of the group to be removed as a default actor. This parameter
+     * cannot be used with the `group` parameter.
+     */
+    groupId?: string;
+    /**
+     * The group name of the group to be removed as a default actor.This parameter
+     * cannot be used with the `groupId` parameter. As a group's name can change, use
+     * of `groupId` is recommended.
+     */
+    group?: string;
+  }): Promise<ProjectRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/role/{id}/actors",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+        query: {
+          user,
+          groupId,
+          group,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ProjectRoleActorsService.deleteProjectRoleActorsFromRole.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the [default actors](#api-rest-api-3-resolution-get) for the project
+   * role.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "actors": [
+   *     {
+   *       "actorGroup": {
+   *         "name": "jira-developers",
+   *         "displayName": "jira-developers",
+   *         "groupId": "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+   *       },
+   *       "displayName": "jira-developers",
+   *       "id": 10240,
+   *       "name": "jira-developers",
+   *       "type": "atlassian-group-role-actor"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/role/{id}/actors
+   * @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
+   */
+  getProjectRoleActorsForRole({
+    id,
+  }: {
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+  }): Promise<ProjectRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/role/{id}/actors",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ProjectRoleActorsService.getProjectRoleActorsForRole.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Sets the actors for a project role for a project, replacing all existing actors.
+   *
+   * To add actors to the project without overwriting the existing list, use [Add
+   * actors to project role](#api-rest-api-3-project-projectIdOrKey-role-id-post).
+   *
+   * **[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. The complete list of actors for the
+   * project is returned.
+   *
+   * 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/project/{projectIdOrKey}/role/{id}
+   * @scopes-current manage:jira-project
+   * @scopes-beta read:user:jira, read:group:jira, read:project-role:jira, read:project:jira,
+   * write:project-role:jira, read:avatar:jira, read:project-category:jira
+   */
+  setActors({
+    projectIdOrKey,
+    id,
+    projectRoleActorsUpdateBean,
+  }: {
+    /** The project ID or project key (case sensitive). */
+    projectIdOrKey: string;
+    /**
+     * The ID of the project role. Use [Get all project
+     * roles](#api-rest-api-3-role-get) to get a list of project role IDs.
+     */
+    id: number;
+    /**
+     * The groups or users to associate with the project role for this project.
+     * Provide the user account ID, group name, or group ID. As a group's name can
+     * change, use of group ID is recommended.
+     *
+     * @example {
+     *     "categorisedActors": {
+     *         "atlassian-group-role-actor-id": [
+     *             "952d12c3-5b5b-4d04-bb32-44d383afc4b2"
+     *         ],
+     *         "atlassian-user-role-actor": [
+     *             "12345678-9abc-def1-2345-6789abcdef12"
+     *         ]
+     *     }
+     * }
+     */
+    projectRoleActorsUpdateBean: ProjectRoleActorsUpdateBean;
+  }): Promise<ProjectRole> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/project/{projectIdOrKey}/role/{id}",
+        method: "PUT",
+        pathParams: {
+          projectIdOrKey,
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: projectRoleActorsUpdateBean,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ProjectRole;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ProjectRoleActorsService.setActors.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "ProjectRoleActorsService.setActors.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectRole"),
+        })
+        .describe("ProjectRoleActorsService.setActors.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ProjectRoleActorsService.addActorUsers.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectRole"),
+        })
+        .describe("ProjectRoleActorsService.addActorUsers.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ProjectRoleActorsService.getProjectRoleActorsForRole.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectRole"),
+        })
+        .describe(
+          "ProjectRoleActorsService.getProjectRoleActorsForRole.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ProjectRoleActorsService.addProjectRoleActorsToRole.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectRole"),
+        })
+        .describe(
+          "ProjectRoleActorsService.addProjectRoleActorsToRole.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ProjectRoleActorsService.deleteProjectRoleActorsFromRole.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ProjectRole"),
+        })
+        .describe(
+          "ProjectRoleActorsService.deleteProjectRoleActorsFromRole.response",
+        ),
+    );
+    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+  }
+}