/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { Avatar, IssueTypeBean, IssueTypeCreateBean, IssueTypeUpdateBean } from '../models'; export interface CreateIssueTypeRequest { IssueTypeCreateBean: IssueTypeCreateBean; } export interface CreateIssueTypeAvatarRequest { id: string; size: number; body: object; x?: number; y?: number; } export interface DeleteIssueTypeRequest { id: string; alternativeIssueTypeId?: string; } export interface GetAlternativeIssueTypesRequest { id: string; } export interface GetIssueTypeRequest { id: string; } export interface UpdateIssueTypeRequest { id: string; IssueTypeUpdateBean: IssueTypeUpdateBean; } /** * no description */ export declare class IssueTypesApi extends runtime.BaseAPI { /** * Creates an issue type and adds it to the default issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create issue type */ createIssueTypeRaw(requestParameters: CreateIssueTypeRequest): Promise>; /** * Creates an issue type and adds it to the default issue type scheme. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create issue type */ createIssueType(requestParameters: CreateIssueTypeRequest): Promise; /** * Loads an avatar for the issue type. Specify the avatar\'s local file location in the body of the request. Also, include the following headers: * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG. For example: `curl --request POST \\ --user email@example.com: \\ --header \'X-Atlassian-Token: no-check\' \\ --header \'Content-Type: image/< image_type>\' \\ --data-binary \"<@/path/to/file/with/your/avatar>\" \\ --url \'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}\'This` The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square\'s sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type\'s displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Load issue type avatar */ createIssueTypeAvatarRaw(requestParameters: CreateIssueTypeAvatarRequest): Promise>; /** * Loads an avatar for the issue type. Specify the avatar\'s local file location in the body of the request. Also, include the following headers: * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG. For example: `curl --request POST \\ --user email@example.com: \\ --header \'X-Atlassian-Token: no-check\' \\ --header \'Content-Type: image/< image_type>\' \\ --data-binary \"<@/path/to/file/with/your/avatar>\" \\ --url \'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}\'This` The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square\'s sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type\'s displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Load issue type avatar */ createIssueTypeAvatar(requestParameters: CreateIssueTypeAvatarRequest): Promise; /** * Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete issue type */ deleteIssueTypeRaw(requestParameters: DeleteIssueTypeRequest): Promise>; /** * Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete issue type */ deleteIssueType(requestParameters: DeleteIssueTypeRequest): Promise; /** * Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get alternative issue types */ getAlternativeIssueTypesRaw(requestParameters: GetAlternativeIssueTypesRequest): Promise>>; /** * Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get alternative issue types */ getAlternativeIssueTypes(requestParameters: GetAlternativeIssueTypesRequest): Promise>; /** * Returns all issue types. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issue types are only returned as follows: * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned. * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned. * Get all issue types for user */ getIssueAllTypesRaw(): Promise>>; /** * Returns all issue types. This operation can be accessed anonymously. **[Permissions](#permissions) required:** Issue types are only returned as follows: * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned. * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned. * Get all issue types for user */ getIssueAllTypes(): Promise>; /** * Returns an issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get issue type */ getIssueTypeRaw(requestParameters: GetIssueTypeRequest): Promise>; /** * Returns an issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get issue type */ getIssueType(requestParameters: GetIssueTypeRequest): Promise; /** * Updates the issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update issue type */ updateIssueTypeRaw(requestParameters: UpdateIssueTypeRequest): Promise>; /** * Updates the issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Update issue type */ updateIssueType(requestParameters: UpdateIssueTypeRequest): Promise; }