@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/permissions-service.ts

@@ -1,407 +0,0 @@
-// 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 BulkPermissionGrants,
-  type BulkPermissionsRequestBean,
-  type Permissions,
-  type PermissionsKeysBean,
-  type PermittedProjects,
-  registerPermissionsValidationSchemas,
-} from "../models/permissions";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents permissions. Use it to obtain details of all
- * permissions and determine whether the user has certain permissions.
- */
-export class PermissionsService extends CommonHttpService {
-  /**
-   * Returns all permissions, including:
-   *
-   *  *  global permissions.
-   *  *  project permissions.
-   *  *  global permissions added by plugins.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "permissions": {
-   *     "BULK_CHANGE": {
-   *       "description": "Ability to modify a collection of issues at once. For
-   * example, resolve multiple issues in one step.",
-   *       "key": "BULK_CHANGE",
-   *       "name": "Bulk Change",
-   *       "type": "GLOBAL"
-   *     }
-   *   }
-   * }
-   * @path {GET} /rest/api/3/permissions
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:permission:jira
-   */
-  getAllPermissions(): Promise<Permissions> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/permissions",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Permissions;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "PermissionsService.getAllPermissions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns:
-   *
-   *  *  for a list of global permissions, the global permissions granted to a user.
-   *  *  for a list of project permissions and lists of projects and issues, for
-   * each project permission a list of the projects and issues a user can access or
-   * manipulate.
-   *
-   * If no account ID is provided, the operation returns details for the logged in
-   * user.
-   *
-   * Note that:
-   *
-   *  *  Invalid project and issue IDs are ignored.
-   *  *  A maximum of 1000 projects and 1000 issues can be checked.
-   *  *  Null values in `globalPermissions`, `projectPermissions`,
-   * `projectPermissions.projects`, and `projectPermissions.issues` are ignored.
-   *  *  Empty strings in `projectPermissions.permissions` are ignored.
-   *
-   * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June
-   * 15, 2024.
-   *
-   *  *  **Classic**: `read:jira-work`
-   *  *  **Granular**: `read:permission:jira`
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) to check the permissions
-   * for other users, otherwise none. However, Connect apps can make a call from the
-   * app server to the product to obtain permission details for any user, without
-   * admin permission. This Connect app ability doesn't apply to calls made using
-   * AP.request() in a browser.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "globalPermissions": [
-   *     "ADMINISTER"
-   *   ],
-   *   "projectPermissions": [
-   *     {
-   *       "issues": [
-   *         10010,
-   *         10013,
-   *         10014
-   *       ],
-   *       "permission": "EDIT_ISSUES",
-   *       "projects": [
-   *         10001
-   *       ]
-   *     }
-   *   ]
-   * }
-   * @path {POST} /rest/api/3/permissions/check
-   * @scopes-current
-   * @scopes-beta read:permission:jira
-   */
-  getBulkPermissions({
-    bulkPermissionsRequestBean,
-  }: {
-    /**
-     * Details of the permissions to check.
-     *
-     * @example {
-     *     "accountId": "5b10a2844c20165700ede21g",
-     *     "globalPermissions": [
-     *         "ADMINISTER"
-     *     ],
-     *     "projectPermissions": [
-     *         {
-     *             "issues": [
-     *                 10010,
-     *                 10011,
-     *                 10012,
-     *                 10013,
-     *                 10014
-     *             ],
-     *             "permissions": [
-     *                 "EDIT_ISSUES"
-     *             ],
-     *             "projects": [
-     *                 10001
-     *             ]
-     *         }
-     *     ]
-     * }
-     */
-    bulkPermissionsRequestBean: BulkPermissionsRequestBean;
-  }): Promise<BulkPermissionGrants> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/permissions/check",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: bulkPermissionsRequestBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: BulkPermissionGrants;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "PermissionsService.getBulkPermissions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a list of permissions indicating which permissions the user has.
-   * Details of the user's permissions can be obtained in a global, project, issue
-   * or comment context.
-   *
-   * The user is reported as having a project permission:
-   *
-   *  *  in the global context, if the user has the project permission in any
-   * project.
-   *  *  for a project, where the project permission is determined using issue data,
-   * if the user meets the permission's criteria for any issue in the project.
-   * Otherwise, if the user has the project permission in the project.
-   *  *  for an issue, where a project permission is determined using issue data, if
-   * the user has the permission in the issue. Otherwise, if the user has the
-   * project permission in the project containing the issue.
-   *  *  for a comment, where the user has both the permission to browse the comment
-   * and the project permission for the comment's parent issue. Only the
-   * BROWSE\_PROJECTS permission is supported. If a `commentId` is provided whose
-   * `permissions` does not equal BROWSE\_PROJECTS, a 400 error will be returned.
-   *
-   * This means that users may be shown as having an issue permission (such as
-   * EDIT\_ISSUES) in the global context or a project context but may not have the
-   * permission for any or all issues. For example, if Reporters have the
-   * EDIT\_ISSUES permission a user would be shown as having this permission in the
-   * global context or the context of a project, because any user can be a reporter.
-   * However, if they are not the user who reported the issue queried they would not
-   * have EDIT\_ISSUES permission for that issue.
-   *
-   * Global permissions are unaffected by context.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "permissions": {
-   *     "EDIT_ISSUES": {
-   *       "description": "Ability to edit issues.",
-   *       "havePermission": true,
-   *       "id": "12",
-   *       "key": "EDIT_ISSUES",
-   *       "name": "Edit Issues",
-   *       "type": "PROJECT"
-   *     }
-   *   }
-   * }
-   * @path {GET} /rest/api/3/mypermissions
-   * @scopes-current read:jira-work
-   * @scopes-beta read:permission:jira
-   */
-  getMyPermissions({
-    projectKey,
-    projectId,
-    issueKey,
-    issueId,
-    permissions,
-    projectUuid,
-    projectConfigurationUuid,
-    commentId,
-  }: {
-    /** The key of project. Ignored if `projectId` is provided. */
-    projectKey?: string;
-    /** The ID of project. */
-    projectId?: string;
-    /** The key of the issue. Ignored if `issueId` is provided. */
-    issueKey?: string;
-    /** The ID of the issue. */
-    issueId?: string;
-    /**
-     * A list of permission keys. (Required) This parameter accepts a comma-separated
-     * list. To get the list of available permissions, use [Get all
-     * permissions](#api-rest-api-3-permissions-get).
-     */
-    permissions?: string;
-    projectUuid?: string;
-    projectConfigurationUuid?: string;
-    /** The ID of the comment. */
-    commentId?: string;
-  }): Promise<Permissions> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypermissions",
-        method: "GET",
-        query: {
-          projectKey,
-          projectId,
-          issueKey,
-          issueId,
-          permissions,
-          projectUuid,
-          projectConfigurationUuid,
-          commentId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Permissions;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "PermissionsService.getMyPermissions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all the projects where the user is granted a list of project
-   * permissions.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   * @path {POST} /rest/api/3/permissions/project
-   * @scopes-current read:jira-work
-   * @scopes-beta read:permission:jira, read:project:jira
-   */
-  getPermittedProjects({
-    permissionsKeysBean,
-  }: {
-    permissionsKeysBean: PermissionsKeysBean;
-  }): Promise<PermittedProjects> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/permissions/project",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: permissionsKeysBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PermittedProjects;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "PermissionsService.getPermittedProjects.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "PermissionsService.getMyPermissions.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Permissions"),
-        })
-        .describe("PermissionsService.getMyPermissions.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "PermissionsService.getAllPermissions.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Permissions"),
-        })
-        .describe("PermissionsService.getAllPermissions.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "PermissionsService.getBulkPermissions.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("BulkPermissionGrants"),
-        })
-        .describe("PermissionsService.getBulkPermissions.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "PermissionsService.getPermittedProjects.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PermittedProjects"),
-        })
-        .describe("PermissionsService.getPermittedProjects.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerPermissionsValidationSchemas,
-    ]);
-  }
-}