@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/issue-types-service.ts

@@ -0,0 +1,679 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type Avatar,
+  type IssueTypeDetails,
+  registerCommonValidationSchemas,
+} from "../models/common";
+import type {
+  IssueTypeCreateBean,
+  IssueTypeUpdateBean,
+} from "../models/issue-types";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents issues types. Use it to:
+ *
+ *  *  get, create, update, and delete issue types.
+ *  *  get all issue types for a user.
+ *  *  get alternative issue types.
+ *  *  set an avatar for an issue type.
+ */
+export class IssueTypesService extends CommonHttpService {
+  /**
+   * 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).
+   *
+   * @returns Returned if the request is successful.
+   * @path {POST} /rest/api/3/issuetype
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:issue-type:jira, read:avatar:jira, read:issue-type:jira,
+   * read:project-category:jira, read:project:jira
+   */
+  createIssueType({
+    issueTypeCreateBean,
+  }: {
+    /**
+     * @example {
+     *     "description": "description",
+     *     "name": "name",
+     *     "type": "standard"
+     * }
+     */
+    issueTypeCreateBean: IssueTypeCreateBean;
+  }): Promise<IssueTypeDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: issueTypeCreateBean,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: IssueTypeDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.createIssueType.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * 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:<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/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).
+   *
+   * @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/issuetype/{id}/avatar2
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:avatar:jira, write:issue-type:jira, read:avatar:jira
+   */
+  createIssueTypeAvatar({
+    id,
+    x,
+    y,
+    size,
+    mediaType,
+    requestBody,
+  }: {
+    /** The ID of the issue type. */
+    id: 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: unknown;
+  }): Promise<Avatar> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/{id}/avatar2",
+        method: "POST",
+        pathParams: {
+          id,
+        },
+        query: {
+          x,
+          y,
+          size,
+        },
+        headers: {
+          "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(
+          "IssueTypesService.createIssueTypeAvatar.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * 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).
+   *
+   * @path {DELETE} /rest/api/3/issuetype/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta delete:issue-type:jira
+   */
+  deleteIssueType({
+    id,
+    alternativeIssueTypeId,
+  }: {
+    /** The ID of the issue type. */
+    id: string;
+    /** The ID of the replacement issue type. */
+    alternativeIssueTypeId?: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/{id}",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+        query: {
+          alternativeIssueTypeId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * 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.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "avatarId": 1,
+   *     "description": "A task that needs to be done.",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+   *     "id": "3",
+   *     "name": "Task",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+   *     "subtask": false
+   *   },
+   *   {
+   *     "avatarId": 10002,
+   *     "description": "A problem with the software.",
+   *     "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+   *     "id": "1",
+   *     "name": "Bug",
+   *     "scope": {
+   *       "project": {
+   *         "id": "10000"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+   *     "subtask": false
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/issuetype/{id}/alternatives
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue-type:jira, read:project-category:jira, read:project:jira,
+   * read:avatar:jira
+   */
+  getAlternativeIssueTypes({
+    id,
+  }: {
+    /** The ID of the issue type. */
+    id: string;
+  }): Promise<IssueTypeDetails[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/{id}/alternatives",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: IssueTypeDetails[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.getAlternativeIssueTypes.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * 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.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "avatarId": 1,
+   *     "description": "A task that needs to be done.",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+   *     "id": "3",
+   *     "name": "Task",
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+   *     "subtask": false
+   *   },
+   *   {
+   *     "avatarId": 10002,
+   *     "description": "A problem with the software.",
+   *     "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+   *     "id": "1",
+   *     "name": "Bug",
+   *     "scope": {
+   *       "project": {
+   *         "id": "10000"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+   *     "subtask": false
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/issuetype
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+   * read:project:jira
+   */
+  getIssueAllTypes(): Promise<IssueTypeDetails[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype",
+        method: "GET",
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: IssueTypeDetails[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.getIssueAllTypes.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * 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).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "avatarId": 1,
+   *   "description": "A task that needs to be done.",
+   *   "hierarchyLevel": 0,
+   *   "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+   *   "id": "3",
+   *   "name": "Task",
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+   *   "subtask": false
+   * }
+   * @path {GET} /rest/api/3/issuetype/{id}
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+   * read:project:jira
+   */
+  getIssueType({
+    id,
+  }: {
+    /** The ID of the issue type. */
+    id: string;
+  }): Promise<IssueTypeDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/{id}",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: IssueTypeDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.getIssueType.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns issue types for a project.
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:** *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project
+   * or *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "avatarId": 10002,
+   *     "description": "A problem with the software.",
+   *     "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
+   *     "id": "1",
+   *     "name": "Bug",
+   *     "scope": {
+   *       "project": {
+   *         "id": "10000"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
+   *     "subtask": false
+   *   },
+   *   {
+   *     "avatarId": 1,
+   *     "description": "A task that needs to be done.",
+   *     "hierarchyLevel": 0,
+   *     "iconUrl":
+   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
+   *     "id": "3",
+   *     "name": "Task",
+   *     "scope": {
+   *       "project": {
+   *         "id": "10000"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+   *     "subtask": false
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/issuetype/project
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+   * read:project:jira
+   */
+  getIssueTypesForProject({
+    projectId,
+    level,
+  }: {
+    /** The ID of the project. */
+    projectId: number;
+    /**
+     * The level of the issue type to filter by. Use:
+     *
+     *  *  `-1` for Subtask.
+     *  *  `0` for Base.
+     *  *  `1` for Epic.
+     */
+    level?: number;
+  }): Promise<IssueTypeDetails[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/project",
+        method: "GET",
+        query: {
+          projectId,
+          level,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: IssueTypeDetails[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.getIssueTypesForProject.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates the issue type.
+   *
+   * **[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/issuetype/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:issue-type:jira, read:avatar:jira, read:issue-type:jira,
+   * read:project-category:jira, read:project:jira
+   */
+  updateIssueType({
+    id,
+    issueTypeUpdateBean,
+  }: {
+    /** The ID of the issue type. */
+    id: string;
+    /**
+     * @example {
+     *     "avatarId": 1,
+     *     "description": "description",
+     *     "name": "name"
+     * }
+     */
+    issueTypeUpdateBean: IssueTypeUpdateBean;
+  }): Promise<IssueTypeDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issuetype/{id}",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: issueTypeUpdateBean,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: IssueTypeDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueTypesService.updateIssueType.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.getIssueAllTypes.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+        .describe("IssueTypesService.getIssueAllTypes.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.createIssueType.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+        .describe("IssueTypesService.createIssueType.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.getIssueType.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+        .describe("IssueTypesService.getIssueType.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.updateIssueType.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+        .describe("IssueTypesService.updateIssueType.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.getAlternativeIssueTypes.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+        .describe("IssueTypesService.getAlternativeIssueTypes.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.createIssueTypeAvatar.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("Avatar"),
+        })
+        .describe("IssueTypesService.createIssueTypeAvatar.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueTypesService.getIssueTypesForProject.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+        .describe("IssueTypesService.getIssueTypesForProject.response"),
+    );
+    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+  }
+}