@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,575 +0,0 @@
-// 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 Priority,
-  registerCommonValidationSchemas,
-} from "../models/common";
-import {
-  type CreatePriorityDetails,
-  type PageBeanPriority,
-  type PriorityId,
-  registerIssuePrioritiesValidationSchemas,
-  type ReorderIssuePriorities,
-  type SetDefaultPriorityRequest,
-  type UpdatePriorityDetails,
-} from "../models/issue-priorities";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents issue priorities. Use it to get, create and update
- * issue priorities and details for individual issue priorities.
- */
-export class IssuePrioritiesService extends CommonHttpService {
-  /**
-   * Creates an issue priority.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "10001"
-   * }
-   * @path {POST} /rest/api/3/priority
-   */
-  createPriority({
-    createPriorityDetails,
-  }: {
-    /**
-     * @example {
-     *     "description": "My priority description",
-     *     "iconUrl": "images/icons/priorities/major.png",
-     *     "name": "My new priority",
-     *     "statusColor": "#ABCDEF"
-     * }
-     */
-    createPriorityDetails: CreatePriorityDetails;
-  }): Promise<PriorityId> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: createPriorityDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: PriorityId;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.createPriority.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes an issue priority.
-   *
-   * This operation is [asynchronous](#async). Follow the `location` link in the
-   * response to determine the status of the task and use [Get
-   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/priority/{id}
-   */
-  deletePriority({
-    id,
-  }: {
-    /** The ID of the issue priority. */
-    id: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/{id}",
-        method: "DELETE",
-        pathParams: {
-          id,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the list of all issue priorities.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @deprecated
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "description": "Major loss of function.",
-   *     "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/major.png",
-   *     "id": "1",
-   *     "name": "Major",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
-   *     "statusColor": "#009900"
-   *   },
-   *   {
-   *     "description": "Very little impact.",
-   *     "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
-   *     "id": "2",
-   *     "name": "Trivial",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
-   *     "statusColor": "#cfcfcf"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/priority
-   * @scopes-current read:jira-work
-   * @scopes-beta read:priority:jira
-   */
-  getPriorities(): Promise<Priority[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Priority[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.getPriorities.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns an issue priority.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "Major loss of function.",
-   *   "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/major.png",
-   *   "id": "1",
-   *   "name": "Major",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
-   *   "statusColor": "#009900"
-   * }
-   * @path {GET} /rest/api/3/priority/{id}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:priority:jira
-   */
-  getPriority({
-    id,
-  }: {
-    /** The ID of the issue priority. */
-    id: string;
-  }): Promise<Priority> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/{id}",
-        method: "GET",
-        pathParams: {
-          id,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Priority;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.getPriority.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Changes the order of issue priorities.
-   *
-   * **[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/priority/move
-   */
-  movePriorities({
-    reorderIssuePriorities,
-  }: {
-    /**
-     * @example {
-     *     "after": "10003",
-     *     "ids": [
-     *         "10004",
-     *         "10005"
-     *     ]
-     * }
-     */
-    reorderIssuePriorities: ReorderIssuePriorities;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/move",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: reorderIssuePriorities,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.movePriorities.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of priorities. The list can contain all
-   * priorities or a subset determined by any combination of these criteria:
-   *
-   *  *  a list of priority IDs. Any invalid priority IDs are ignored.
-   *  *  a list of project IDs. Only priorities that are available in these projects
-   * will be returned. Any invalid project IDs are ignored.
-   *  *  whether the field configuration is a default. This returns priorities from
-   * company-managed (classic) projects only, as there is no concept of default
-   * priorities in team-managed projects.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @deprecated
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 50,
-   *   "startAt": 0,
-   *   "total": 2,
-   *   "values": [
-   *     {
-   *       "description": "Major loss of function.",
-   *       "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/major.png",
-   *       "id": "1",
-   *       "isDefault": true,
-   *       "name": "Major",
-   *       "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
-   *       "statusColor": "#009900"
-   *     },
-   *     {
-   *       "description": "Very little impact.",
-   *       "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
-   *       "id": "2",
-   *       "isDefault": false,
-   *       "name": "Trivial",
-   *       "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
-   *       "statusColor": "#cfcfcf"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/priority/search
-   */
-  searchPriorities({
-    startAt,
-    maxResults,
-    id,
-    projectId,
-    priorityName,
-    onlyDefault,
-    expand,
-  }: {
-    /** The index of the first item to return in a page of results (page offset). */
-    startAt?: string;
-    /** The maximum number of items to return per page. */
-    maxResults?: string;
-    /**
-     * The list of priority IDs. To include multiple IDs, provide an
-     * ampersand-separated list. For example, `id=2&id=3`.
-     */
-    id?: string[];
-    /**
-     * The list of projects IDs. To include multiple IDs, provide an
-     * ampersand-separated list. For example, `projectId=10010&projectId=10111`.
-     */
-    projectId?: string[];
-    /** The name of priority to search for. */
-    priorityName?: string;
-    /** Whether only the default priority is returned. */
-    onlyDefault?: boolean;
-    /**
-     * Use `schemes` to return the associated priority schemes for each priority.
-     * Limited to returning first 15 priority schemes per priority.
-     */
-    expand?: string;
-  }): Promise<PageBeanPriority> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/search",
-        method: "GET",
-        query: {
-          startAt,
-          maxResults,
-          id,
-          projectId,
-          priorityName,
-          onlyDefault,
-          expand,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanPriority;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.searchPriorities.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets default issue priority.
-   *
-   * **[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/priority/default
-   */
-  setDefaultPriority({
-    setDefaultPriorityRequest,
-  }: {
-    /**
-     * @example {
-     *     "id": "3"
-     * }
-     */
-    setDefaultPriorityRequest: SetDefaultPriorityRequest;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/default",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: setDefaultPriorityRequest,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.setDefaultPriority.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates an issue priority.
-   *
-   * **[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/priority/{id}
-   */
-  updatePriority({
-    id,
-    updatePriorityDetails,
-  }: {
-    /** The ID of the issue priority. */
-    id: string;
-    /**
-     * @example {
-     *     "description": "My updated priority description",
-     *     "iconUrl": "images/icons/priorities/minor.png",
-     *     "name": "My updated priority",
-     *     "statusColor": "#123456"
-     * }
-     */
-    updatePriorityDetails: UpdatePriorityDetails;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/priority/{id}",
-        method: "PUT",
-        pathParams: {
-          id,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: updatePriorityDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePrioritiesService.updatePriority.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.getPriorities.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("Priority")),
-        })
-        .describe("IssuePrioritiesService.getPriorities.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.createPriority.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PriorityId"),
-        })
-        .describe("IssuePrioritiesService.createPriority.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.getPriority.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Priority"),
-        })
-        .describe("IssuePrioritiesService.getPriority.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.updatePriority.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssuePrioritiesService.updatePriority.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.setDefaultPriority.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssuePrioritiesService.setDefaultPriority.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.movePriorities.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssuePrioritiesService.movePriorities.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePrioritiesService.searchPriorities.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanPriority"),
-        })
-        .describe("IssuePrioritiesService.searchPriorities.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerCommonValidationSchemas,
-      registerIssuePrioritiesValidationSchemas,
-    ]);
-  }
-}