@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,769 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import type { Stream } from "stream";
-import { z } from "zod";
-
-import * as commonHttpClient from "../core/common-http-client";
-import { CommonHttpService } from "../core/common-http-service";
-import {
-  type Avatars,
-  registerAvatarsValidationSchemas,
-  type StreamingResponseBody,
-  type SystemAvatars,
-} from "../models/avatars";
-import { type Avatar, registerCommonValidationSchemas } from "../models/common";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents system and custom avatars. Use it to obtain the
- * details of system or custom avatars, add and remove avatars from a project or
- * issue type, and obtain avatar images.
- */
-export class AvatarsService extends CommonHttpService {
-  /**
-   * Deletes an avatar from a project or issue type.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE}
-   * /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta delete:avatar:jira
-   */
-  deleteAvatar({
-    type,
-    owningObjectId,
-    id,
-  }: {
-    /** The avatar type. */
-    type: "project" | "issuetype";
-    /** The ID of the item the avatar is associated with. */
-    owningObjectId: string;
-    /** The ID of the avatar. */
-    id: number;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}",
-        method: "DELETE",
-        pathParams: {
-          type,
-          owningObjectId,
-          id,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * 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.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "system": [
-   *     {
-   *       "id": "1000",
-   *       "isDeletable": false,
-   *       "isSelected": false,
-   *       "isSystemAvatar": true,
-   *       "urls": {
-   *         "16x16":
-   * "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
-   *         "24x24":
-   * "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
-   *         "32x32":
-   * "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
-   *         "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
-   *       }
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/avatar/{type}/system
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:avatar:jira
-   */
-  getAllSystemAvatars({
-    type,
-  }: {
-    /** The avatar type. */
-    type: "issuetype" | "project" | "user";
-  }): Promise<SystemAvatars> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/avatar/{type}/system",
-        method: "GET",
-        pathParams: {
-          type,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: SystemAvatars;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "AvatarsService.getAllSystemAvatars.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a project or issue type avatar image by ID.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  For system avatars, none.
-   *  *  For custom project avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
-   * avatar belongs to.
-   *  *  For custom issue type avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
-   * the issue type is used in.
-   *
-   * @returns * status: 200, mediaType: * /*
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: application/json
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/png
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/svg+xml
-   *
-   *    Returned if the request is successful.
-   * @path {GET} /rest/api/3/universal_avatar/view/type/{type}/avatar/{id}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:avatar:jira
-   */
-  getAvatarImageById({
-    type,
-    id,
-    size,
-    format,
-  }: {
-    /** The icon type of the avatar. */
-    type: "issuetype" | "project";
-    /** The ID of the avatar. */
-    id: number;
-    /** The size of the avatar image. If not provided the default size is returned. */
-    size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
-    /**
-     * The format to return the avatar image in. If not provided the original content
-     * format is returned.
-     */
-    format?: "png" | "svg";
-  }): Promise<
-    commonHttpClient.WithResponse<
-      | {
-          status: 200;
-          mediaType: "*/*" | "image/png" | "image/svg+xml";
-          body: Blob;
-        }
-      | {
-          status: 200;
-          mediaType: "application/json";
-          body: StreamingResponseBody;
-        }
-    >
-  > {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}",
-        method: "GET",
-        pathParams: {
-          type,
-          id,
-        },
-        query: {
-          size,
-          format,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "*/*": "blob",
-            "application/json": "json",
-            "image/png": "blob",
-            "image/svg+xml": "blob",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<
-          | {
-              status: 200;
-              mediaType: "*/*" | "image/png" | "image/svg+xml";
-              body: Blob;
-            }
-          | {
-              status: 200;
-              mediaType: "application/json";
-              body: StreamingResponseBody;
-            }
-        >(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "AvatarsService.getAvatarImageByID.response",
-        ),
-      );
-  }
-  /**
-   * Returns the avatar image for a project or issue type.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  For system avatars, none.
-   *  *  For custom project avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
-   * avatar belongs to.
-   *  *  For custom issue type avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
-   * the issue type is used in.
-   *
-   * @returns * status: 200, mediaType: * /*
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: application/json
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/png
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/svg+xml
-   *
-   *    Returned if the request is successful.
-   * @path {GET} /rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:avatar:jira
-   */
-  getAvatarImageByOwner({
-    type,
-    entityId,
-    size,
-    format,
-  }: {
-    /** The icon type of the avatar. */
-    type: "issuetype" | "project";
-    /** The ID of the project or issue type the avatar belongs to. */
-    entityId: string;
-    /** The size of the avatar image. If not provided the default size is returned. */
-    size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
-    /**
-     * The format to return the avatar image in. If not provided the original content
-     * format is returned.
-     */
-    format?: "png" | "svg";
-  }): Promise<
-    commonHttpClient.WithResponse<
-      | {
-          status: 200;
-          mediaType: "*/*" | "image/png" | "image/svg+xml";
-          body: Blob;
-        }
-      | {
-          status: 200;
-          mediaType: "application/json";
-          body: StreamingResponseBody;
-        }
-    >
-  > {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}",
-        method: "GET",
-        pathParams: {
-          type,
-          entityId,
-        },
-        query: {
-          size,
-          format,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "*/*": "blob",
-            "application/json": "json",
-            "image/png": "blob",
-            "image/svg+xml": "blob",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<
-          | {
-              status: 200;
-              mediaType: "*/*" | "image/png" | "image/svg+xml";
-              body: Blob;
-            }
-          | {
-              status: 200;
-              mediaType: "application/json";
-              body: StreamingResponseBody;
-            }
-        >(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "AvatarsService.getAvatarImageByOwner.response",
-        ),
-      );
-  }
-  /**
-   * Returns the default project or issue type avatar image.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns * status: 200, mediaType: * /*
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: application/json
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/png
-   *
-   *    Returned if the request is successful.
-   *
-   *  * status: 200, mediaType: image/svg+xml
-   *
-   *    Returned if the request is successful.
-   * @path {GET} /rest/api/3/universal_avatar/view/type/{type}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:avatar:jira
-   */
-  getAvatarImageByType({
-    type,
-    size,
-    format,
-  }: {
-    /** The icon type of the avatar. */
-    type: "issuetype" | "project";
-    /** The size of the avatar image. If not provided the default size is returned. */
-    size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
-    /**
-     * The format to return the avatar image in. If not provided the original content
-     * format is returned.
-     */
-    format?: "png" | "svg";
-  }): Promise<
-    commonHttpClient.WithResponse<
-      | {
-          status: 200;
-          mediaType: "*/*" | "image/png" | "image/svg+xml";
-          body: Blob;
-        }
-      | {
-          status: 200;
-          mediaType: "application/json";
-          body: StreamingResponseBody;
-        }
-    >
-  > {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/view/type/{type}",
-        method: "GET",
-        pathParams: {
-          type,
-        },
-        query: {
-          size,
-          format,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "*/*": "blob",
-            "application/json": "json",
-            "image/png": "blob",
-            "image/svg+xml": "blob",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<
-          | {
-              status: 200;
-              mediaType: "*/*" | "image/png" | "image/svg+xml";
-              body: Blob;
-            }
-          | {
-              status: 200;
-              mediaType: "application/json";
-              body: StreamingResponseBody;
-            }
-        >(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "AvatarsService.getAvatarImageByType.response",
-        ),
-      );
-  }
-  /**
-   * Returns the system and custom avatars for a project or issue type.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  for custom project avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project the
-   * avatar belongs to.
-   *  *  for custom issue type avatars, *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for at least one project
-   * the issue type is used in.
-   *  *  for system avatars, none.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "custom": [
-   *     {
-   *       "id": "1010",
-   *       "isDeletable": true,
-   *       "isSelected": false,
-   *       "isSystemAvatar": false,
-   *       "urls": {
-   *         "16x16":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project",
-   *         "24x24":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project",
-   *         "32x32":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project",
-   *         "48x48":
-   * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project"
-   *       }
-   *     }
-   *   ],
-   *   "system": [
-   *     {
-   *       "id": "1000",
-   *       "isDeletable": false,
-   *       "isSelected": false,
-   *       "isSystemAvatar": true,
-   *       "urls": {
-   *         "16x16":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project",
-   *         "24x24":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project",
-   *         "32x32":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project",
-   *         "48x48":
-   * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project"
-   *       }
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:avatar:jira
-   */
-  getAvatars({
-    type,
-    entityId,
-  }: {
-    /** The avatar type. */
-    type: "project" | "issuetype";
-    /** The ID of the item the avatar is associated with. */
-    entityId: string;
-  }): Promise<Avatars> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/type/{type}/owner/{entityId}",
-        method: "GET",
-        pathParams: {
-          type,
-          entityId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Avatars;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator("AvatarsService.getAvatars.response"),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * 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:<api_token> `
-   *
-   * `--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).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "1000",
-   *   "isDeletable": false,
-   *   "isSelected": false,
-   *   "isSystemAvatar": true,
-   *   "urls": {
-   *     "16x16": "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
-   *     "24x24": "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
-   *     "32x32": "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
-   *     "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
-   *   }
-   * }
-   * @path {POST} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:avatar:jira, read:avatar:jira
-   */
-  storeAvatar({
-    type,
-    entityId,
-    x,
-    y,
-    size,
-    mediaType,
-    requestBody,
-  }: {
-    /** The avatar type. */
-    type: "project" | "issuetype";
-    /** The ID of the item the avatar is associated with. */
-    entityId: string;
-    /** The X coordinate of the top-left corner of the crop region. */
-    x?: number;
-    /** The Y coordinate of the top-left corner of the crop region. */
-    y?: number;
-    /** The length of each side of the crop region. */
-    size: number;
-    mediaType: string;
-    requestBody: Blob | Stream;
-  }): Promise<Avatar> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/universal_avatar/type/{type}/owner/{entityId}",
-        method: "POST",
-        pathParams: {
-          type,
-          entityId,
-        },
-        query: {
-          x,
-          y,
-          size,
-        },
-        headers: {
-          "X-Atlassian-Token": "nocheck",
-          "Content-Type": mediaType,
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: Avatar;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "AvatarsService.storeAvatar.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.getAllSystemAvatars.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("SystemAvatars"),
-        })
-        .describe("AvatarsService.getAllSystemAvatars.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.getAvatars.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Avatars"),
-        })
-        .describe("AvatarsService.getAvatars.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.storeAvatar.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Avatar"),
-        })
-        .describe("AvatarsService.storeAvatar.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.getAvatarImageByType.response",
-      z
-        .object({
-          status: z.number(),
-          mediaType: z.string(),
-          body: z.unknown(),
-        })
-        .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
-          if (mediaType === "application/json") {
-            validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
-          } else if (
-            mediaType === "image/png" ||
-            mediaType === "image/svg+xml"
-          ) {
-            return;
-          } else {
-            ctx.addIssue({
-              code: z.ZodIssueCode.custom,
-              path: ["mediaType"],
-              message: `Unexpected media type: ${mediaType}`,
-            });
-          }
-        })
-        .describe("AvatarsService.getAvatarImageByType.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.getAvatarImageByID.response",
-      z
-        .object({
-          status: z.number(),
-          mediaType: z.string(),
-          body: z.unknown(),
-        })
-        .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
-          if (mediaType === "application/json") {
-            validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
-          } else if (
-            mediaType === "image/png" ||
-            mediaType === "image/svg+xml"
-          ) {
-            return;
-          } else {
-            ctx.addIssue({
-              code: z.ZodIssueCode.custom,
-              path: ["mediaType"],
-              message: `Unexpected media type: ${mediaType}`,
-            });
-          }
-        })
-        .describe("AvatarsService.getAvatarImageByID.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "AvatarsService.getAvatarImageByOwner.response",
-      z
-        .object({
-          status: z.number(),
-          mediaType: z.string(),
-          body: z.unknown(),
-        })
-        .superRefine(({ mediaType: mediaType, body: body }, ctx) => {
-          if (mediaType === "application/json") {
-            validationSchemaStorage.lazy("StreamingResponseBody").parse(body);
-          } else if (
-            mediaType === "image/png" ||
-            mediaType === "image/svg+xml"
-          ) {
-            return;
-          } else {
-            ctx.addIssue({
-              code: z.ZodIssueCode.custom,
-              path: ["mediaType"],
-              message: `Unexpected media type: ${mediaType}`,
-            });
-          }
-        })
-        .describe("AvatarsService.getAvatarImageByOwner.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerAvatarsValidationSchemas,
-      registerCommonValidationSchemas,
-    ]);
-  }
-}