/** * 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, ProjectAvatars } from '../models'; export interface CreateProjectAvatarRequest { projectIdOrKey: string; body: object; x?: number; y?: number; size?: number; } export interface DeleteProjectAvatarRequest { projectIdOrKey: string; id: number; } export interface GetAllProjectAvatarsRequest { projectIdOrKey: string; } export interface UpdateProjectAvatarRequest { projectIdOrKey: string; Avatar: Avatar; } /** * no description */ export declare class ProjectAvatarsApi extends runtime.BaseAPI { /** * Loads an avatar for a project. 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/project/{projectIdOrKey}/avatar2\'` 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 [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project\'s displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Load project avatar */ createProjectAvatarRaw(requestParameters: CreateProjectAvatarRequest): Promise>; /** * Loads an avatar for a project. 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/project/{projectIdOrKey}/avatar2\'` 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 [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project\'s displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Load project avatar */ createProjectAvatar(requestParameters: CreateProjectAvatarRequest): Promise; /** * Deletes a custom avatar from a project. Note that system avatars cannot be deleted. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Delete project avatar */ deleteProjectAvatarRaw(requestParameters: DeleteProjectAvatarRequest): Promise>; /** * Deletes a custom avatar from a project. Note that system avatars cannot be deleted. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Delete project avatar */ deleteProjectAvatar(requestParameters: DeleteProjectAvatarRequest): Promise; /** * Returns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get all project avatars */ getAllProjectAvatarsRaw(requestParameters: GetAllProjectAvatarsRequest): Promise>; /** * Returns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. * Get all project avatars */ getAllProjectAvatars(requestParameters: GetAllProjectAvatarsRequest): Promise; /** * Sets the avatar displayed for a project. Use [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Set project avatar */ updateProjectAvatarRaw(requestParameters: UpdateProjectAvatarRequest): Promise>; /** * Sets the avatar displayed for a project. Use [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar. **[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg). * Set project avatar */ updateProjectAvatar(requestParameters: UpdateProjectAvatarRequest): Promise; }