@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/issue-security-schemes-service.d.ts

@@ -0,0 +1,530 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type SecurityScheme } from "../models/common";
+import { type AddSecuritySchemeLevelsRequestBean, type AssociateSecuritySchemeWithProjectDetails, type CreateIssueSecuritySchemeDetails, type PageBeanIssueSecuritySchemeToProjectMapping, type PageBeanSecurityLevel, type PageBeanSecurityLevelMember, type PageBeanSecuritySchemeWithProjects, type SecuritySchemeId, type SecuritySchemeMembersRequest, type SecuritySchemes, type SetDefaultLevelsRequest, type UpdateIssueSecurityLevelDetails, type UpdateIssueSecuritySchemeRequestBean } from "../models/issue-security-schemes";
+/**
+ * This resource represents issue security schemes. Use it to get an issue
+ * security scheme or a list of issue security schemes.
+ *
+ * Issue security schemes control which users or groups of users can view an
+ * issue. When an issue security scheme is associated with a project, its security
+ * levels can be applied to issues in that project. Sub-tasks also inherit the
+ * security level of their parent issue.
+ */
+export declare class IssueSecuritySchemesService extends CommonHttpService {
+    /**
+     * Adds levels and levels' members to the issue security scheme. You can add up to
+     * 100 levels per request.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuesecurityschemes/{schemeId}/level
+     */
+    addSecurityLevel({ schemeId, addSecuritySchemeLevelsRequestBean, }: {
+        /** The ID of the issue security scheme. */
+        schemeId: string;
+        /**
+         * @example {
+         *     "levels": [
+         *         {
+         *             "description": "First Level Description",
+         *             "isDefault": true,
+         *             "members": [
+         *                 {
+         *                     "type": "reporter"
+         *                 },
+         *                 {
+         *                     "parameter": "jira-administrators",
+         *                     "type": "group"
+         *                 }
+         *             ],
+         *             "name": "First Level"
+         *         }
+         *     ]
+         * }
+         */
+        addSecuritySchemeLevelsRequestBean: AddSecuritySchemeLevelsRequestBean;
+    }): Promise<void>;
+    /**
+     * Adds members to the issue security level. You can add up to 100 members per
+     * request.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member
+     */
+    addSecurityLevelMembers({ schemeId, levelId, securitySchemeMembersRequest, }: {
+        /** The ID of the issue security scheme. */
+        schemeId: string;
+        /** The ID of the issue security level. */
+        levelId: string;
+        /**
+         * @example {
+         *     "members": [
+         *         {
+         *             "type": "reporter"
+         *         },
+         *         {
+         *             "parameter": "jira-administrators",
+         *             "type": "group"
+         *         }
+         *     ]
+         * }
+         */
+        securitySchemeMembersRequest: SecuritySchemeMembersRequest;
+    }): Promise<void>;
+    /**
+     * Associates an issue security scheme with a project and remaps security levels
+     * of issues to the new levels, if provided.
+     *
+     * This operation is [asynchronous](#async). Follow the `location` link in the
+     * response to determine the status of the task and use [Get
+     * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {PUT} /rest/api/3/issuesecurityschemes/project
+     */
+    associateSchemesToProjects({ associateSecuritySchemeWithProjectDetails, }: {
+        /**
+         * @example {
+         *     "oldToNewSecurityLevelMappings": [
+         *         {
+         *             "newLevelId": "30001",
+         *             "oldLevelId": "30000"
+         *         }
+         *     ],
+         *     "projectId": "10000",
+         *     "schemeId": "20000"
+         * }
+         */
+        associateSecuritySchemeWithProjectDetails: AssociateSecuritySchemeWithProjectDetails;
+    }): Promise<void>;
+    /**
+     * Creates a security scheme with security scheme levels and levels' members. You
+     * can create up to 100 security scheme levels and security scheme levels' members
+     * per request.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "10001"
+     * }
+     * @path {POST} /rest/api/3/issuesecurityschemes
+     */
+    createIssueSecurityScheme({ createIssueSecuritySchemeDetails, }: {
+        /**
+         * @example {
+         *     "description": "Newly created issue security scheme",
+         *     "levels": [
+         *         {
+         *             "description": "Newly created level",
+         *             "isDefault": true,
+         *             "members": [
+         *                 {
+         *                     "parameter": "administrators",
+         *                     "type": "group"
+         *                 }
+         *             ],
+         *             "name": "New level"
+         *         }
+         *     ],
+         *     "name": "New security scheme"
+         * }
+         */
+        createIssueSecuritySchemeDetails: CreateIssueSecuritySchemeDetails;
+    }): Promise<SecuritySchemeId>;
+    /**
+     * Deletes an issue security scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/issuesecurityschemes/{schemeId}
+     */
+    deleteSecurityScheme({ schemeId, }: {
+        /** The ID of the issue security scheme. */
+        schemeId: string;
+    }): Promise<void>;
+    /**
+     * Returns an issue security scheme along with its security levels.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *  *  *Administer Projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses
+     * the requested issue security scheme.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultSecurityLevelId": 10021,
+     *   "description": "Description for the default issue security scheme",
+     *   "id": 10000,
+     *   "levels": [
+     *     {
+     *       "description": "Only the reporter and internal staff can see this issue.",
+     *       "id": "10021",
+     *       "name": "Reporter Only",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/securitylevel/10021"
+     *     }
+     *   ],
+     *   "name": "Default Issue Security Scheme",
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000"
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes/{id}
+     * @scopes-current manage:jira-project
+     * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
+     */
+    getIssueSecurityScheme({ id, }: {
+        /**
+         * The ID of the issue security scheme. Use the [Get issue security
+         * schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of
+         * issue security scheme IDs.
+         */
+        id: number;
+    }): Promise<SecurityScheme>;
+    /**
+     * Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "issueSecuritySchemes": [
+     *     {
+     *       "defaultSecurityLevelId": 10021,
+     *       "description": "Description for the default issue security scheme",
+     *       "id": 10000,
+     *       "name": "Default Issue Security Scheme",
+     *       "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes
+     * @scopes-current manage:jira-project
+     * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
+     */
+    getIssueSecuritySchemes(): Promise<SecuritySchemes>;
+    /**
+     * Returns a [paginated](#pagination) list of issue security level members.
+     *
+     * Only issue security level members in the context of classic projects are
+     * returned.
+     *
+     * Filtering using parameters is inclusive: if you specify both security scheme
+     * IDs and level IDs, the result will include all issue security level members
+     * from the specified schemes and levels.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 100,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "id": "10000",
+     *       "issueSecurityLevelId": "20010",
+     *       "issueSecuritySchemeId": "10010",
+     *       "holder": {
+     *         "expand": "group",
+     *         "type": "group"
+     *       }
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes/level/member
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
+     */
+    getSecurityLevelMembers({ startAt, maxResults, id, schemeId, levelId, expand, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: string;
+        /** The maximum number of items to return per page. */
+        maxResults?: string;
+        /**
+         * The list of issue security level member IDs. To include multiple issue security
+         * level members separate IDs with an ampersand: `id=10000&id=10001`.
+         */
+        id?: string[];
+        /**
+         * The list of issue security scheme IDs. To include multiple issue security
+         * schemes separate IDs with an ampersand: `schemeId=10000&schemeId=10001`.
+         */
+        schemeId?: string[];
+        /**
+         * The list of issue security level IDs. To include multiple issue security levels
+         * separate IDs with an ampersand: `levelId=10000&levelId=10001`.
+         */
+        levelId?: string[];
+        /**
+         * Use expand to include additional information in the response. This parameter
+         * accepts a comma-separated list. Expand options include:
+         *
+         *  *  `all` Returns all expandable information
+         *  *  `field` Returns information about the custom field granted the permission
+         *  *  `group` Returns information about the group that is granted the permission
+         *  *  `projectRole` Returns information about the project role granted the
+         * permission
+         *  *  `user` Returns information about the user who is granted the permission
+         */
+        expand?: string;
+    }): Promise<PageBeanSecurityLevelMember>;
+    /**
+     * Returns a [paginated](#pagination) list of issue security levels.
+     *
+     * Only issue security levels in the context of classic projects are returned.
+     *
+     * Filtering using IDs is inclusive: if you specify both security scheme IDs and
+     * level IDs, the result will include both specified issue security levels and all
+     * issue security levels from the specified schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 50,
+     *   "startAt": 0,
+     *   "total": 1,
+     *   "values": [
+     *     {
+     *       "description": "Only the reporter and internal staff can see this issue.",
+     *       "id": "10021",
+     *       "isDefault": true,
+     *       "issueSecuritySchemeId": "10001",
+     *       "name": "Reporter Only",
+     *       "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/level?id=10021"
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes/level
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
+     */
+    getSecurityLevels({ startAt, maxResults, id, schemeId, onlyDefault, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: string;
+        /** The maximum number of items to return per page. */
+        maxResults?: string;
+        /**
+         * The list of issue security scheme level IDs. To include multiple issue security
+         * levels, separate IDs with an ampersand: `id=10000&id=10001`.
+         */
+        id?: string[];
+        /**
+         * The list of issue security scheme IDs. To include multiple issue security
+         * schemes, separate IDs with an ampersand: `schemeId=10000&schemeId=10001`.
+         */
+        schemeId?: string[];
+        /**
+         * When set to true, returns multiple default levels for each security scheme
+         * containing a default. If you provide scheme and level IDs not associated with
+         * the default, returns an empty page. The default value is false.
+         */
+        onlyDefault?: boolean;
+    }): Promise<PageBeanSecurityLevel>;
+    /**
+     * Deletes an issue security level.
+     *
+     * This operation is [asynchronous](#async). Follow the `location` link in the
+     * response to determine the status of the task and use [Get
+     * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
+     */
+    removeLevel({ schemeId, levelId, replaceWith, }: {
+        /** The ID of the issue security scheme. */
+        schemeId: string;
+        /** The ID of the issue security level to remove. */
+        levelId: string;
+        /**
+         * The ID of the issue security level that will replace the currently selected
+         * level.
+         */
+        replaceWith?: string;
+    }): Promise<void>;
+    /**
+     * Removes an issue security level member from an issue security scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE}
+     * /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}
+     */
+    removeMemberFromSecurityLevel({ schemeId, levelId, memberId, }: {
+        /** The ID of the issue security scheme. */
+        schemeId: string;
+        /** The ID of the issue security level. */
+        levelId: string;
+        /** The ID of the issue security level member to be removed. */
+        memberId: string;
+    }): Promise<void>;
+    /**
+     * Returns a [paginated](#pagination) mapping of projects that are using security
+     * schemes. You can provide either one or multiple security scheme IDs or project
+     * IDs to filter by. If you don't provide any, this will return a list of all
+     * mappings. Only issue security schemes in the context of classic projects are
+     * supported. **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "issueSecuritySchemeId": "10000",
+     *   "projectId": "10000"
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes/project
+     */
+    searchProjectsUsingSecuritySchemes({ startAt, maxResults, issueSecuritySchemeId, projectId, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: string;
+        /** The maximum number of items to return per page. */
+        maxResults?: string;
+        /** The list of security scheme IDs to be filtered out. */
+        issueSecuritySchemeId?: string[];
+        /** The list of project IDs to be filtered out. */
+        projectId?: string[];
+    }): Promise<PageBeanIssueSecuritySchemeToProjectMapping>;
+    /**
+     * Returns a [paginated](#pagination) list of issue security schemes.
+     * If you specify the project ID parameter, the result will contain issue security
+     * schemes and related project IDs you filter by. Use \{@link
+     * IssueSecuritySchemeResource\#searchProjectsUsingSecuritySchemes(String, String,
+     * Set, Set)\} to obtain all projects related to scheme.
+     *
+     * Only issue security schemes in the context of classic projects are returned.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": 10000,
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issuesecurityscheme/10000",
+     *   "name": "Default scheme",
+     *   "description": "Default scheme description",
+     *   "defaultLevel": 10001,
+     *   "projectIds": [
+     *     10002
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/issuesecurityschemes/search
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
+     */
+    searchSecuritySchemes({ startAt, maxResults, id, projectId, }: {
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: string;
+        /** The maximum number of items to return per page. */
+        maxResults?: string;
+        /**
+         * The list of issue security scheme IDs. To include multiple issue security
+         * scheme IDs, separate IDs with an ampersand: `id=10000&id=10001`.
+         */
+        id?: string[];
+        /**
+         * The list of project IDs. To include multiple project IDs, separate IDs with an
+         * ampersand: `projectId=10000&projectId=10001`.
+         */
+        projectId?: string[];
+    }): Promise<PageBeanSecuritySchemeWithProjects>;
+    /**
+     * Sets default issue security levels for schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuesecurityschemes/level/default
+     */
+    setDefaultLevels({ setDefaultLevelsRequest, }: {
+        /**
+         * @example {
+         *     "defaultValues": [
+         *         {
+         *             "defaultLevelId": "20000",
+         *             "issueSecuritySchemeId": "10000"
+         *         },
+         *         {
+         *             "defaultLevelId": "30000",
+         *             "issueSecuritySchemeId": "12000"
+         *         }
+         *     ]
+         * }
+         */
+        setDefaultLevelsRequest: SetDefaultLevelsRequest;
+    }): Promise<void>;
+    /**
+     * Updates the issue security scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuesecurityschemes/{id}
+     */
+    updateIssueSecurityScheme({ id, updateIssueSecuritySchemeRequestBean, }: {
+        /** The ID of the issue security scheme. */
+        id: string;
+        /**
+         * @example {
+         *     "description": "My issue security scheme description",
+         *     "name": "My issue security scheme name"
+         * }
+         */
+        updateIssueSecuritySchemeRequestBean: UpdateIssueSecuritySchemeRequestBean;
+    }): Promise<void>;
+    /**
+     * Updates the issue security level.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}
+     */
+    updateSecurityLevel({ schemeId, levelId, updateIssueSecurityLevelDetails, }: {
+        /** The ID of the issue security scheme level belongs to. */
+        schemeId: string;
+        /** The ID of the issue security level to update. */
+        levelId: string;
+        /**
+         * @example {
+         *     "description": "New level description",
+         *     "name": "New level name"
+         * }
+         */
+        updateIssueSecurityLevelDetails: UpdateIssueSecurityLevelDetails;
+    }): Promise<void>;
+    static initialize(): void;
+}