/** * 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, Avatars, SystemAvatars } from '../models'; export interface DeleteAvatarRequest { type: string; owningObjectId: string; id: number; } export interface GetAllSystemAvatarsRequest { type: GetAllSystemAvatarsTypeEnum; } export interface GetAvatarsRequest { type: string; entityId: string; } export interface StoreAvatarRequest { type: string; entityId: string; size: number; body: object; x?: number; y?: number; } /** * no description */ export declare class AvatarsApi extends runtime.BaseAPI { /** * Deletes an avatar from a project or issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete avatar */ deleteAvatarRaw(requestParameters: DeleteAvatarRequest): Promise>; /** * Deletes an avatar from a project or issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Delete avatar */ deleteAvatar(requestParameters: DeleteAvatarRequest): Promise; /** * Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get system avatars by type */ getAllSystemAvatarsRaw(requestParameters: GetAllSystemAvatarsRequest): Promise>; /** * Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get system avatars by type */ getAllSystemAvatars(requestParameters: GetAllSystemAvatarsRequest): Promise; /** * Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get avatars */ getAvatarsRaw(requestParameters: GetAvatarsRequest): Promise>; /** * Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. * Get avatars */ getAvatars(requestParameters: GetAvatarsRequest): Promise; /** * Loads a custom avatar for a project or 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/universal_avatar/type/{type}/owner/{entityId}\'` 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. * [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project\'s displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Load avatar */ storeAvatarRaw(requestParameters: StoreAvatarRequest): Promise>; /** * Loads a custom avatar for a project or 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/universal_avatar/type/{type}/owner/{entityId}\'` 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. * [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project\'s displayed avatar. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Load avatar */ storeAvatar(requestParameters: StoreAvatarRequest): Promise; } /** * @export * @enum {string} */ export declare enum GetAllSystemAvatarsTypeEnum { Issuetype = "issuetype", Project = "project", User = "user" }