@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/screen-schemes-service.ts

@@ -1,334 +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 PageBeanScreenScheme,
-  registerScreenSchemesValidationSchemas,
-  type ScreenSchemeDetails,
-  type ScreenSchemeId,
-  type UpdateScreenSchemeDetails,
-} from "../models/screen-schemes";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents screen schemes in classic projects. Use it to get,
- * create, update, and delete screen schemes.
- */
-export class ScreenSchemesService extends CommonHttpService {
-  /**
-   * Creates a screen scheme.
-   *
-   * **[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/screenscheme
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:screen-scheme:jira
-   */
-  createScreenScheme({
-    screenSchemeDetails,
-  }: {
-    /**
-     * @example {
-     *     "description": "Manage employee data",
-     *     "name": "Employee screen scheme",
-     *     "screens": {
-     *         "default": 10017,
-     *         "edit": 10019,
-     *         "view": 10020
-     *     }
-     * }
-     */
-    screenSchemeDetails: ScreenSchemeDetails;
-  }): Promise<ScreenSchemeId> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screenscheme",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: screenSchemeDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: ScreenSchemeId;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenSchemesService.createScreenScheme.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an
-   * issue type screen scheme.
-   *
-   * Only screens schemes used in classic projects can be deleted.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/screenscheme/{screenSchemeId}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:screen-scheme:jira
-   */
-  deleteScreenScheme({
-    screenSchemeId,
-  }: {
-    /** The ID of the screen scheme. */
-    screenSchemeId: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screenscheme/{screenSchemeId}",
-        method: "DELETE",
-        pathParams: {
-          screenSchemeId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of screen schemes.
-   *
-   * Only screen schemes used in classic projects are returned.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": true,
-   *   "maxResults": 100,
-   *   "self":
-   * "https://your-domain.atlassian.net/rest/api/3/screenscheme?maxResults=25&startAt=0",
-   *   "startAt": 0,
-   *   "total": 2,
-   *   "values": [
-   *     {
-   *       "id": 10010,
-   *       "name": "Employee screen scheme",
-   *       "description": "Manage employee data",
-   *       "screens": {
-   *         "default": 10017,
-   *         "edit": 10019,
-   *         "create": 10019,
-   *         "view": 10020
-   *       },
-   *       "issueTypeScreenSchemes": {
-   *         "isLast": true,
-   *         "maxResults": 100,
-   *         "startAt": 0,
-   *         "total": 1,
-   *         "values": [
-   *           {
-   *             "id": "10000",
-   *             "name": "Office issue type screen scheme",
-   *             "description": "Managing office projects"
-   *           }
-   *         ]
-   *       }
-   *     },
-   *     {
-   *       "id": 10032,
-   *       "name": "Office screen scheme",
-   *       "description": "Manage office data",
-   *       "screens": {
-   *         "default": 10020
-   *       }
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/screenscheme
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:screen-scheme:jira, read:issue-type-screen-scheme:jira
-   */
-  getScreenSchemes({
-    startAt,
-    maxResults,
-    id,
-    expand,
-    queryString,
-    orderBy,
-  }: {
-    /** The index of the first item to return in a page of results (page offset). */
-    startAt?: number;
-    /** The maximum number of items to return per page. */
-    maxResults?: number;
-    /**
-     * The list of screen scheme IDs. To include multiple IDs, provide an
-     * ampersand-separated list. For example, `id=10000&id=10001`.
-     */
-    id?: number[];
-    /**
-     * Use [expand](#expansion) include additional information in the response. This
-     * parameter accepts `issueTypeScreenSchemes` that, for each screen schemes,
-     * returns information about the issue type screen scheme the screen scheme is
-     * assigned to.
-     */
-    expand?: string;
-    /** String used to perform a case-insensitive partial match with screen scheme name. */
-    queryString?: string;
-    /**
-     * [Order](#ordering) the results by a field:
-     *
-     *  *  `id` Sorts by screen scheme ID.
-     *  *  `name` Sorts by screen scheme name.
-     */
-    orderBy?: "name" | "-name" | "+name" | "id" | "-id" | "+id";
-  }): Promise<PageBeanScreenScheme> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screenscheme",
-        method: "GET",
-        query: {
-          startAt,
-          maxResults,
-          id,
-          expand,
-          queryString,
-          orderBy,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanScreenScheme;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenSchemesService.getScreenSchemes.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates a screen scheme. Only screen schemes used in classic projects can be
-   * updated.
-   *
-   * **[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/screenscheme/{screenSchemeId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:screen-scheme:jira
-   */
-  updateScreenScheme({
-    screenSchemeId,
-    updateScreenSchemeDetails,
-  }: {
-    /** The ID of the screen scheme. */
-    screenSchemeId: string;
-    /**
-     * The screen scheme update details.
-     *
-     * @example {
-     *     "name": "Employee screen scheme v2",
-     *     "screens": {
-     *         "create": "10019",
-     *         "default": "10018"
-     *     }
-     * }
-     */
-    updateScreenSchemeDetails: UpdateScreenSchemeDetails;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screenscheme/{screenSchemeId}",
-        method: "PUT",
-        pathParams: {
-          screenSchemeId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: updateScreenSchemeDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenSchemesService.updateScreenScheme.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ScreenSchemesService.getScreenSchemes.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanScreenScheme"),
-        })
-        .describe("ScreenSchemesService.getScreenSchemes.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreenSchemesService.createScreenScheme.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ScreenSchemeId"),
-        })
-        .describe("ScreenSchemesService.createScreenScheme.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreenSchemesService.updateScreenScheme.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("ScreenSchemesService.updateScreenScheme.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerScreenSchemesValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/screen-tab-fields-service.ts

@@ -1,276 +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 {
-  registerCommonValidationSchemas,
-  type ScreenableField,
-} from "../models/common";
-import type { AddFieldBean, MoveFieldBean } from "../models/screen-tab-fields";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents the screen tab fields used to record issue details.
- * Use it to get, add, move, and remove fields from screen tabs.
- */
-export class ScreenTabFieldsService extends CommonHttpService {
-  /**
-   * Adds a field to a screen tab.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "summary",
-   *   "name": "Summary"
-   * }
-   * @path {POST} /rest/api/3/screens/{screenId}/tabs/{tabId}/fields
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:screenable-field:jira, write:screenable-field:jira
-   */
-  addScreenTabField({
-    screenId,
-    tabId,
-    addFieldBean,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-    /** The ID of the screen tab. */
-    tabId: number;
-    /**
-     * @example {
-     *     "fieldId": "summary"
-     * }
-     */
-    addFieldBean: AddFieldBean;
-  }): Promise<ScreenableField> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}/fields",
-        method: "POST",
-        pathParams: {
-          screenId,
-          tabId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: addFieldBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ScreenableField;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenTabFieldsService.addScreenTabField.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all fields for a screen tab.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *  *  *Administer projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) when the project key is
-   * specified, providing that the screen is associated with the project through a
-   * Screen Scheme and Issue Type Screen Scheme.
-   *
-   * @returns Returned if the request is successful.
-   * @path {GET} /rest/api/3/screens/{screenId}/tabs/{tabId}/fields
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:screenable-field:jira
-   */
-  getAllScreenTabFields({
-    screenId,
-    tabId,
-    projectKey,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-    /** The ID of the screen tab. */
-    tabId: number;
-    /** The key of the project. */
-    projectKey?: string;
-  }): Promise<ScreenableField[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}/fields",
-        method: "GET",
-        pathParams: {
-          screenId,
-          tabId,
-        },
-        query: {
-          projectKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ScreenableField[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenTabFieldsService.getAllScreenTabFields.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Moves a screen tab field.
-   *
-   * If `after` and `position` are provided in the request, `position` is ignored.
-   *
-   * **[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/screens/{screenId}/tabs/{tabId}/fields/{id}/move
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:screenable-field:jira
-   */
-  moveScreenTabField({
-    screenId,
-    tabId,
-    id,
-    moveFieldBean,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-    /** The ID of the screen tab. */
-    tabId: number;
-    /** The ID of the field. */
-    id: string;
-    moveFieldBean: MoveFieldBean;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move",
-        method: "POST",
-        pathParams: {
-          screenId,
-          tabId,
-          id,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: moveFieldBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreenTabFieldsService.moveScreenTabField.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Removes a field from a screen tab.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:screenable-field:jira
-   */
-  removeScreenTabField({
-    screenId,
-    tabId,
-    id,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-    /** The ID of the screen tab. */
-    tabId: number;
-    /** The ID of the field. */
-    id: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}",
-        method: "DELETE",
-        pathParams: {
-          screenId,
-          tabId,
-          id,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ScreenTabFieldsService.getAllScreenTabFields.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ScreenableField")),
-        })
-        .describe("ScreenTabFieldsService.getAllScreenTabFields.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreenTabFieldsService.addScreenTabField.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ScreenableField"),
-        })
-        .describe("ScreenTabFieldsService.addScreenTabField.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreenTabFieldsService.moveScreenTabField.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("ScreenTabFieldsService.moveScreenTabField.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}