@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,534 +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 CreateResolutionDetails,
-  type PageBeanResolutionJsonBean,
-  registerIssueResolutionsValidationSchemas,
-  type ReorderIssueResolutionsRequest,
-  type Resolution,
-  type ResolutionId,
-  type SetDefaultResolutionRequest,
-  type UpdateResolutionDetails,
-} from "../models/issue-resolutions";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents issue resolution values. Use it to obtain a list of
- * all issue resolution values and the details of individual resolution values.
- */
-export class IssueResolutionsService extends CommonHttpService {
-  /**
-   * Creates an issue resolution.
-   *
-   * **[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/resolution
-   */
-  createResolution({
-    createResolutionDetails,
-  }: {
-    /**
-     * @example {
-     *     "description": "My resolution description",
-     *     "name": "My new resolution"
-     * }
-     */
-    createResolutionDetails: CreateResolutionDetails;
-  }): Promise<ResolutionId> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: createResolutionDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: ResolutionId;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.createResolution.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes an issue resolution.
-   *
-   * 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/resolution/{id}
-   */
-  deleteResolution({
-    id,
-    replaceWith,
-  }: {
-    /** The ID of the issue resolution. */
-    id: string;
-    /**
-     * The ID of the issue resolution that will replace the currently selected
-     * resolution.
-     */
-    replaceWith: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/{id}",
-        method: "DELETE",
-        pathParams: {
-          id,
-        },
-        query: {
-          replaceWith,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns an issue resolution value.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "A fix for this issue is checked into the tree and tested.",
-   *   "id": "10000",
-   *   "name": "Fixed",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1"
-   * }
-   * @path {GET} /rest/api/3/resolution/{id}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:resolution:jira
-   */
-  getResolution({
-    id,
-  }: {
-    /** The ID of the issue resolution value. */
-    id: string;
-  }): Promise<Resolution> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/{id}",
-        method: "GET",
-        pathParams: {
-          id,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Resolution;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.getResolution.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a list of all issue resolution values.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @deprecated
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "description": "A fix for this issue is checked into the tree and tested.",
-   *     "id": "10000",
-   *     "name": "Fixed",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1"
-   *   },
-   *   {
-   *     "description": "This is what it is supposed to do.",
-   *     "id": "10001",
-   *     "name": "Works as designed",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/resolution/3"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/resolution
-   * @scopes-current read:jira-work
-   * @scopes-beta read:resolution:jira
-   */
-  getResolutions(): Promise<Resolution[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Resolution[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.getResolutions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Changes the order of issue resolutions.
-   *
-   * **[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/resolution/move
-   */
-  moveResolutions({
-    reorderIssueResolutionsRequest,
-  }: {
-    /**
-     * @example {
-     *     "after": "10002",
-     *     "ids": [
-     *         "10000",
-     *         "10001"
-     *     ]
-     * }
-     */
-    reorderIssueResolutionsRequest: ReorderIssueResolutionsRequest;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/move",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: reorderIssueResolutionsRequest,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.moveResolutions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of resolutions. The list can contain
-   * all resolutions or a subset determined by any combination of these criteria:
-   *
-   *  *  a list of resolutions IDs.
-   *  *  whether the field configuration is a default. This returns resolutions from
-   * company-managed (classic) projects only, as there is no concept of default
-   * resolutions in team-managed projects.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 50,
-   *   "startAt": 0,
-   *   "total": 1,
-   *   "values": [
-   *     {
-   *       "description": "This is what it is supposed to do.",
-   *       "id": "10001",
-   *       "isDefault": true,
-   *       "name": "Works as designed"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/resolution/search
-   * @scopes-current read:jira-work
-   * @scopes-beta read:resolution:jira
-   */
-  searchResolutions({
-    startAt,
-    maxResults,
-    id,
-    onlyDefault,
-  }: {
-    /** 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 resolutions IDs to be filtered out */
-    id?: string[];
-    /**
-     * When set to true, return default only, when IDs provided, if none of them is
-     * default, return empty page. Default value is false
-     */
-    onlyDefault?: boolean;
-  }): Promise<PageBeanResolutionJsonBean> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/search",
-        method: "GET",
-        query: {
-          startAt,
-          maxResults,
-          id,
-          onlyDefault,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanResolutionJsonBean;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.searchResolutions.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets default issue resolution.
-   *
-   * **[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/resolution/default
-   */
-  setDefaultResolution({
-    setDefaultResolutionRequest,
-  }: {
-    /**
-     * @example {
-     *     "id": "3"
-     * }
-     */
-    setDefaultResolutionRequest: SetDefaultResolutionRequest;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/default",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: setDefaultResolutionRequest,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.setDefaultResolution.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates an issue resolution.
-   *
-   * **[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/resolution/{id}
-   */
-  updateResolution({
-    id,
-    updateResolutionDetails,
-  }: {
-    /** The ID of the issue resolution. */
-    id: string;
-    /**
-     * @example {
-     *     "description": "My updated resolution description",
-     *     "name": "My updated resolution"
-     * }
-     */
-    updateResolutionDetails: UpdateResolutionDetails;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/resolution/{id}",
-        method: "PUT",
-        pathParams: {
-          id,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: updateResolutionDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueResolutionsService.updateResolution.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.getResolutions.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("Resolution")),
-        })
-        .describe("IssueResolutionsService.getResolutions.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.createResolution.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ResolutionId"),
-        })
-        .describe("IssueResolutionsService.createResolution.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.getResolution.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Resolution"),
-        })
-        .describe("IssueResolutionsService.getResolution.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.updateResolution.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueResolutionsService.updateResolution.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.setDefaultResolution.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueResolutionsService.setDefaultResolution.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.moveResolutions.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueResolutionsService.moveResolutions.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueResolutionsService.searchResolutions.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanResolutionJsonBean"),
-        })
-        .describe("IssueResolutionsService.searchResolutions.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerIssueResolutionsValidationSchemas,
-    ]);
-  }
-}