@resolution/jira-api-client 0.1.0

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

@@ -0,0 +1,421 @@
+// 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 ScreenableTab,
+} from "../models/common";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents the screen tabs used to record issue details. Use it
+ * to get, create, update, move, and delete screen tabs.
+ */
+export class ScreenTabsService extends CommonHttpService {
+  /**
+   * Creates a tab for a screen.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "id": 10000,
+   *   "name": "Fields Tab"
+   * }
+   * @path {POST} /rest/api/3/screens/{screenId}/tabs
+   * @scopes-current manage:jira-project
+   * @scopes-beta read:screen-tab:jira, write:screen-tab:jira
+   */
+  addScreenTab({
+    screenId,
+    screenableTab,
+  }: {
+    /** The ID of the screen. */
+    screenId: number;
+    /**
+     * @example {
+     *     "name": "Fields Tab"
+     * }
+     */
+    screenableTab: ScreenableTab;
+  }): Promise<ScreenableTab> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/{screenId}/tabs",
+        method: "POST",
+        pathParams: {
+          screenId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: screenableTab,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ScreenableTab;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ScreenTabsService.addScreenTab.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes 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}
+   * @scopes-current manage:jira-project
+   * @scopes-beta delete:screen-tab:jira
+   */
+  deleteScreenTab({
+    screenId,
+    tabId,
+  }: {
+    /** The ID of the screen. */
+    screenId: number;
+    /** The ID of the screen tab. */
+    tabId: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}",
+        method: "DELETE",
+        pathParams: {
+          screenId,
+          tabId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Returns the list of tabs for a screen.
+   *
+   * **[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
+   * @scopes-current manage:jira-project
+   * @scopes-beta read:screen-tab:jira
+   */
+  getAllScreenTabs({
+    screenId,
+    projectKey,
+  }: {
+    /** The ID of the screen. */
+    screenId: number;
+    /** The key of the project. */
+    projectKey?: string;
+  }): Promise<ScreenableTab[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/{screenId}/tabs",
+        method: "GET",
+        pathParams: {
+          screenId,
+        },
+        query: {
+          projectKey,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ScreenableTab[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ScreenTabsService.getAllScreenTabs.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the list of tabs for a bulk of screens.
+   *
+   * **[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,
+   *   "startAt": 0,
+   *   "total": 2,
+   *   "values": [
+   *     {
+   *       "screenId": 10000,
+   *       "tabId": 10001,
+   *       "tabName": "My Custom Tab 1"
+   *     },
+   *     {
+   *       "screenId": 10001,
+   *       "tabId": 10002,
+   *       "tabName": "My Custom Tab 2"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/screens/tabs
+   * @scopes-current manage:jira-project
+   * @scopes-beta read:screen-tab:jira
+   */
+  getBulkScreenTabs({
+    screenId,
+    tabId,
+    startAt,
+    maxResult,
+  }: {
+    /**
+     * The list of screen IDs. To include multiple screen IDs, provide an
+     * ampersand-separated list. For example, `screenId=10000&screenId=10001`.
+     */
+    screenId?: number[];
+    /**
+     * The list of tab IDs. To include multiple tab IDs, provide an
+     * ampersand-separated list. For example, `tabId=10000&tabId=10001`.
+     */
+    tabId?: number[];
+    /** 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. The maximum number is 100, */
+    maxResult?: number;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/tabs",
+        method: "GET",
+        query: {
+          screenId,
+          tabId,
+          startAt,
+          maxResult,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ScreenTabsService.getBulkScreenTabs.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Moves a screen tab.
+   *
+   * **[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}/move/{pos}
+   * @scopes-current manage:jira-project
+   * @scopes-beta write:screen:jira
+   */
+  moveScreenTab({
+    screenId,
+    tabId,
+    pos,
+  }: {
+    /** The ID of the screen. */
+    screenId: number;
+    /** The ID of the screen tab. */
+    tabId: number;
+    /** The position of tab. The base index is 0. */
+    pos: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}",
+        method: "POST",
+        pathParams: {
+          screenId,
+          tabId,
+          pos,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ScreenTabsService.moveScreenTab.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates the name of 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": 10000,
+   *   "name": "Fields Tab"
+   * }
+   * @path {PUT} /rest/api/3/screens/{screenId}/tabs/{tabId}
+   * @scopes-current manage:jira-project
+   * @scopes-beta read:screen-tab:jira, write:screen-tab:jira
+   */
+  renameScreenTab({
+    screenId,
+    tabId,
+    screenableTab,
+  }: {
+    /** The ID of the screen. */
+    screenId: number;
+    /** The ID of the screen tab. */
+    tabId: number;
+    screenableTab: ScreenableTab;
+  }): Promise<ScreenableTab> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/screens/{screenId}/tabs/{tabId}",
+        method: "PUT",
+        pathParams: {
+          screenId,
+          tabId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: screenableTab,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: ScreenableTab;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "ScreenTabsService.renameScreenTab.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "ScreenTabsService.getAllScreenTabs.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("ScreenableTab")),
+        })
+        .describe("ScreenTabsService.getAllScreenTabs.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ScreenTabsService.addScreenTab.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ScreenableTab"),
+        })
+        .describe("ScreenTabsService.addScreenTab.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ScreenTabsService.renameScreenTab.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("ScreenableTab"),
+        })
+        .describe("ScreenTabsService.renameScreenTab.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ScreenTabsService.moveScreenTab.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("ScreenTabsService.moveScreenTab.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "ScreenTabsService.getBulkScreenTabs.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("ScreenTabsService.getBulkScreenTabs.response"),
+    );
+    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+  }
+}