@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/ui-modifications-apps-service.ts

@@ -0,0 +1,403 @@
+// 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 CreateUiModificationDetails,
+  type PageBeanUiModificationDetails,
+  registerUiModificationsAppsValidationSchemas,
+  type UiModificationIdentifiers,
+  type UpdateUiModificationDetails,
+} from "../models/ui-modifications-apps";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * UI modifications is a feature available for **Forge apps only**. It enables
+ * Forge apps to control how selected Jira fields behave on the following views:
+ * global issue create, issue view. For example: hide specific fields, set them as
+ * required, etc.
+ */
+export class UiModificationsAppsService extends CommonHttpService {
+  /**
+   * Creates a UI modification. UI modification can only be created by Forge apps.
+   *
+   * Each app can define up to 3000 UI modifications. Each UI modification can
+   * define up to 1000 contexts. The same context can be assigned to maximum 100 UI
+   * modifications.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *None* if the UI modification is created without contexts.
+   *  *  *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for one or more
+   * projects, if the UI modification is created with contexts.
+   *
+   * @returns Returned if the UI modification is created.
+   *
+   * example: {
+   *   "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+   *   "self":
+   * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61"
+   * }
+   * @path {POST} /rest/api/3/uiModifications
+   */
+  createUiModification({
+    createUiModificationDetails,
+  }: {
+    /**
+     * Details of the UI modification.
+     *
+     * @example {
+     *     "contexts": [
+     *         {
+     *             "issueTypeId": "10000",
+     *             "projectId": "10000",
+     *             "viewType": "GIC"
+     *         },
+     *         {
+     *             "issueTypeId": "10001",
+     *             "projectId": "10000",
+     *             "viewType": "IssueView"
+     *         },
+     *         {
+     *             "issueTypeId": "10002",
+     *             "projectId": "10000",
+     *             "viewType": null
+     *         }
+     *     ],
+     *     "data": "{field: 'Story Points', config: {hidden: false}}",
+     *     "description": "Reveals Story Points field when any Sprint is selected.",
+     *     "name": "Reveal Story Points"
+     * }
+     */
+    createUiModificationDetails: CreateUiModificationDetails;
+  }): Promise<UiModificationIdentifiers> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/uiModifications",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: createUiModificationDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: UiModificationIdentifiers;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UiModificationsAppsService.createUiModification.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes a UI modification. All the contexts that belong to the UI modification
+   * are deleted too. UI modification can only be deleted by Forge apps.
+   *
+   * **[Permissions](#permissions) required:** None.
+   *
+   * @returns Returned if the UI modification is deleted.
+   * @path {DELETE} /rest/api/3/uiModifications/{uiModificationId}
+   */
+  deleteUiModification({
+    uiModificationId,
+  }: {
+    /** The ID of the UI modification. */
+    uiModificationId: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/uiModifications/{uiModificationId}",
+        method: "DELETE",
+        pathParams: {
+          uiModificationId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UiModificationsAppsService.deleteUiModification.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Gets UI modifications. UI modifications can only be retrieved by Forge apps.
+   *
+   * **[Permissions](#permissions) required:** None.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 100,
+   *   "startAt": 0,
+   *   "total": 3,
+   *   "values": [
+   *     {
+   *       "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+   *       "name": "Reveal Story Points",
+   *       "description": "Reveals Story Points field when any Sprint is selected.",
+   *       "self":
+   * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+   *       "data": "{field: 'Story Points', config: {hidden: false}}",
+   *       "contexts": [
+   *         {
+   *           "id": "1533537a-bda3-4ac6-8481-846128cd9ef4",
+   *           "projectId": "10000",
+   *           "issueTypeId": "10000",
+   *           "viewType": "GIC",
+   *           "isAvailable": true
+   *         },
+   *         {
+   *           "id": "c016fefa-6eb3-40c9-8596-4c4ef273e67c",
+   *           "projectId": "10000",
+   *           "issueTypeId": "10001",
+   *           "viewType": "IssueView",
+   *           "isAvailable": true
+   *         }
+   *       ]
+   *     },
+   *     {
+   *       "id": "e4fe8db5-f82f-416b-a3aa-b260b55da577",
+   *       "name": "Set Assignee",
+   *       "description": "Sets the Assignee field automatically.",
+   *       "self":
+   * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577",
+   *       "contexts": [
+   *         {
+   *           "id": "8b3740f9-8780-4958-8228-69dcfbda11d9",
+   *           "projectId": "10000",
+   *           "issueTypeId": "10000",
+   *           "viewType": "GIC",
+   *           "isAvailable": true
+   *         }
+   *       ]
+   *     },
+   *     {
+   *       "id": "1453f993-79ce-4389-a36d-eb72d5c85dd6",
+   *       "name": "Hide Labels",
+   *       "description": "Hides Labels if any component is provided.",
+   *       "self":
+   * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/1453f993-79ce-4389-a36d-eb72d5c85dd6",
+   *       "contexts": []
+   *     },
+   *     {
+   *       "id": "d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
+   *       "name": "Wildcard example",
+   *       "description": "This context is applied to all issue types",
+   *       "self":
+   * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
+   *       "contexts": [
+   *         {
+   *           "id": "521f2181-5d5e-46ea-9fc9-871bbf245b8b",
+   *           "projectId": "10000",
+   *           "issueTypeId": null,
+   *           "viewType": "GIC",
+   *           "isAvailable": true
+   *         }
+   *       ]
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/uiModifications
+   */
+  getUiModifications({
+    startAt,
+    maxResults,
+    expand,
+  }: {
+    /** 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;
+    /**
+     * Use expand to include additional information in the response. This parameter
+     * accepts a comma-separated list. Expand options include:
+     *
+     *  *  `data` Returns UI modification data.
+     *  *  `contexts` Returns UI modification contexts.
+     */
+    expand?: string;
+  }): Promise<PageBeanUiModificationDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/uiModifications",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          expand,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanUiModificationDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UiModificationsAppsService.getUiModifications.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates a UI modification. UI modification can only be updated by Forge apps.
+   *
+   * Each UI modification can define up to 1000 contexts. The same context can be
+   * assigned to maximum 100 UI modifications.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *None* if the UI modification is created without contexts.
+   *  *  *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for one or more
+   * projects, if the UI modification is created with contexts.
+   *
+   * @returns Returned if the UI modification is updated.
+   * @path {PUT} /rest/api/3/uiModifications/{uiModificationId}
+   */
+  updateUiModification({
+    uiModificationId,
+    updateUiModificationDetails,
+  }: {
+    /** The ID of the UI modification. */
+    uiModificationId: string;
+    /**
+     * Details of the UI modification.
+     *
+     * @example {
+     *     "contexts": [
+     *         {
+     *             "issueTypeId": "10000",
+     *             "projectId": "10000",
+     *             "viewType": "GIC"
+     *         },
+     *         {
+     *             "issueTypeId": "10001",
+     *             "projectId": "10000",
+     *             "viewType": "IssueView"
+     *         }
+     *     ],
+     *     "data": "{field: 'Story Points', config: {hidden: true}}",
+     *     "name": "Updated Reveal Story Points"
+     * }
+     */
+    updateUiModificationDetails: UpdateUiModificationDetails;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/uiModifications/{uiModificationId}",
+        method: "PUT",
+        pathParams: {
+          uiModificationId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: updateUiModificationDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "UiModificationsAppsService.updateUiModification.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "UiModificationsAppsService.getUiModifications.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageBeanUiModificationDetails"),
+        })
+        .describe("UiModificationsAppsService.getUiModifications.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UiModificationsAppsService.createUiModification.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("UiModificationIdentifiers"),
+        })
+        .describe("UiModificationsAppsService.createUiModification.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UiModificationsAppsService.updateUiModification.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("UiModificationsAppsService.updateUiModification.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "UiModificationsAppsService.deleteUiModification.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("UiModificationsAppsService.deleteUiModification.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerUiModificationsAppsValidationSchemas,
+    ]);
+  }
+}