@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/screens-service.ts

@@ -1,528 +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 PageBeanScreen,
-  type PageBeanScreenWithTab,
-  registerScreensValidationSchemas,
-  type Screen,
-  type ScreenDetails,
-  type UpdateScreenDetails,
-} from "../models/screens";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents the screens used to record issue details. Use it to:
- *
- *  *  get details of all screens.
- *  *  get details of all the fields available for use on screens.
- *  *  create screens.
- *  *  delete screens.
- *  *  update screens.
- *  *  add a field to the default screen.
- */
-export class ScreensService extends CommonHttpService {
-  /**
-   * Adds a field to the default tab of the default screen.
-   *
-   * **[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/addToDefault/{fieldId}
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project:jira, read:screen:jira, write:screen:jira
-   */
-  addFieldToDefaultScreen({
-    fieldId,
-  }: {
-    /** The ID of the field. */
-    fieldId: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/addToDefault/{fieldId}",
-        method: "POST",
-        pathParams: {
-          fieldId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreensService.addFieldToDefaultScreen.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Creates a screen with a default field tab.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": 10005,
-   *   "name": "Resolve Security Issue Screen",
-   *   "description": "Enables changes to resolution and linked issues."
-   * }
-   * @path {POST} /rest/api/3/screens
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project:jira, read:screen:jira, write:screen:jira, read:avatar:jira,
-   * read:project-category:jira
-   */
-  createScreen({
-    screenDetails,
-  }: {
-    /**
-     * @example {
-     *     "description": "Enables changes to resolution and linked issues.",
-     *     "name": "Resolve Security Issue Screen"
-     * }
-     */
-    screenDetails: ScreenDetails;
-  }): Promise<Screen> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: screenDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: Screen;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreensService.createScreen.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a screen. A screen cannot be deleted if it is used in a screen scheme,
-   * workflow, or workflow draft.
-   *
-   * Only screens used in classic projects can be deleted.
-   *
-   * @path {DELETE} /rest/api/3/screens/{screenId}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:screen:jira
-   */
-  deleteScreen({
-    screenId,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}",
-        method: "DELETE",
-        pathParams: {
-          screenId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the fields that can be added to a tab on a screen.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   * @path {GET} /rest/api/3/screens/{screenId}/availableFields
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:screen-field:jira, read:screenable-field:jira
-   */
-  getAvailableScreenFields({
-    screenId,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-  }): Promise<ScreenableField[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}/availableFields",
-        method: "GET",
-        pathParams: {
-          screenId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ScreenableField[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreensService.getAvailableScreenFields.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of all screens or those specified by
-   * one or more screen IDs.
-   *
-   * **[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/screens",
-   *   "startAt": 0,
-   *   "total": 3,
-   *   "values": [
-   *     {
-   *       "id": 1,
-   *       "name": "Default Screen",
-   *       "description": "Provides for the update all system fields."
-   *     },
-   *     {
-   *       "id": 2,
-   *       "name": "Workflow Screen",
-   *       "description": "This screen is used in the workflow and enables you to
-   * assign issues."
-   *     },
-   *     {
-   *       "id": 3,
-   *       "name": "Resolve Issue Screen",
-   *       "description": "Offers the ability to set resolution, change fix
-   * versions, and assign an issue."
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/screens
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project:jira, read:screen:jira, read:avatar:jira,
-   * read:project-category:jira
-   */
-  getScreens({
-    startAt,
-    maxResults,
-    id,
-    queryString,
-    scope,
-    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 IDs. To include multiple IDs, provide an ampersand-separated
-     * list. For example, `id=10000&id=10001`.
-     */
-    id?: number[];
-    /** String used to perform a case-insensitive partial match with screen name. */
-    queryString?: string;
-    /**
-     * The scope filter string. To filter by multiple scope, provide an
-     * ampersand-separated list. For example, `scope=GLOBAL&scope=PROJECT`.
-     */
-    scope?: ("GLOBAL" | "TEMPLATE" | "PROJECT")[];
-    /**
-     * [Order](#ordering) the results by a field:
-     *
-     *  *  `id` Sorts by screen ID.
-     *  *  `name` Sorts by screen name.
-     */
-    orderBy?: "name" | "-name" | "+name" | "id" | "-id" | "+id";
-  }): Promise<PageBeanScreen> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens",
-        method: "GET",
-        query: {
-          startAt,
-          maxResults,
-          id,
-          queryString,
-          scope,
-          orderBy,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanScreen;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator("ScreensService.getScreens.response"),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a [paginated](#pagination) list of the screens a field is used in.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "isLast": false,
-   *   "maxResults": 1,
-   *   "startAt": 0,
-   *   "total": 5,
-   *   "values": [
-   *     {
-   *       "id": 10001,
-   *       "name": "Default Screen",
-   *       "description": "Provides for the update of all system fields.",
-   *       "tab": {
-   *         "id": 10000,
-   *         "name": "Fields Tab"
-   *       }
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/field/{fieldId}/screens
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:screen:jira, read:avatar:jira, read:project-category:jira,
-   * read:project:jira, read:screen-tab:jira
-   */
-  getScreensForField({
-    fieldId,
-    startAt,
-    maxResults,
-    expand,
-  }: {
-    /** The ID of the field to return screens for. */
-    fieldId: string;
-    /** 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](#expansion) to include additional information about screens in the
-     * response. This parameter accepts `tab` which returns details about the screen
-     * tabs the field is used in.
-     */
-    expand?: string;
-  }): Promise<PageBeanScreenWithTab> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/field/{fieldId}/screens",
-        method: "GET",
-        pathParams: {
-          fieldId,
-        },
-        query: {
-          startAt,
-          maxResults,
-          expand,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PageBeanScreenWithTab;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreensService.getScreensForField.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates a screen. Only screens 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.
-   *
-   * example: {
-   *   "id": 10005,
-   *   "name": "Resolve Security Issue Screen",
-   *   "description": "Enables changes to resolution and linked issues."
-   * }
-   * @path {PUT} /rest/api/3/screens/{screenId}
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project:jira, read:screen:jira, write:screen:jira, read:avatar:jira,
-   * read:project-category:jira
-   */
-  updateScreen({
-    screenId,
-    updateScreenDetails,
-  }: {
-    /** The ID of the screen. */
-    screenId: number;
-    /**
-     * @example {
-     *     "description": "Enables changes to resolution and linked issues for
-     * accessibility related issues.",
-     *     "name": "Resolve Accessibility Issue Screen"
-     * }
-     */
-    updateScreenDetails: UpdateScreenDetails;
-  }): Promise<Screen> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/screens/{screenId}",
-        method: "PUT",
-        pathParams: {
-          screenId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: updateScreenDetails,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Screen;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ScreensService.updateScreen.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.getScreensForField.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanScreenWithTab"),
-        })
-        .describe("ScreensService.getScreensForField.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.getScreens.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PageBeanScreen"),
-        })
-        .describe("ScreensService.getScreens.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.createScreen.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Screen"),
-        })
-        .describe("ScreensService.createScreen.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.updateScreen.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Screen"),
-        })
-        .describe("ScreensService.updateScreen.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.getAvailableScreenFields.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ScreenableField")),
-        })
-        .describe("ScreensService.getAvailableScreenFields.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ScreensService.addFieldToDefaultScreen.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("ScreensService.addFieldToDefaultScreen.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerScreensValidationSchemas,
-      registerCommonValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/server-info-service.ts

@@ -1,88 +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 {
-  registerServerInfoValidationSchemas,
-  type ServerInformation,
-} from "../models/server-info";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/** This resource provides information about the Jira instance. */
-export class ServerInfoService extends CommonHttpService {
-  /**
-   * Returns information about the Jira instance.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "baseUrl": "https://your-domain.atlassian.net",
-   *   "buildDate": "2020-03-26T22:20:59.000+0000",
-   *   "buildNumber": 582,
-   *   "defaultLocale": {
-   *     "locale": "en_AU"
-   *   },
-   *   "displayUrl": "https://instance.jira.your-domain.com",
-   *   "displayUrlServicedeskHelpCenter": "https://instance.help.your-domain.com",
-   *   "scmInfo": "1f51473f5c7b75c1a69a0090f4832cdc5053702a",
-   *   "serverTime": "2020-03-31T16:43:50.000+0000",
-   *   "serverTimeZone": "Australia/Sydney",
-   *   "serverTitle": "My Jira instance",
-   *   "version": "1001.0.0-SNAPSHOT",
-   *   "versionNumbers": [
-   *     5,
-   *     0,
-   *     0
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/serverInfo
-   * @scopes-current
-   * @scopes-beta
-   */
-  getServerInfo(): Promise<ServerInformation> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/serverInfo",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ServerInformation;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ServerInfoService.getServerInfo.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ServerInfoService.getServerInfo.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ServerInformation"),
-        })
-        .describe("ServerInfoService.getServerInfo.response"),
-    );
-    validationSchemaStorage.registerOnce([registerServerInfoValidationSchemas]);
-  }
-}

package/src/openapi/platform/services/service-registry-service.ts

@@ -1,89 +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 {
-  registerServiceRegistryValidationSchemas,
-  type ServiceRegistry,
-} from "../models/service-registry";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents a service registry. Use it to retrieve attributes
- * related to a [service
- * registry](https://support.atlassian.com/jira-service-management-cloud/docs/what-is-services/)
- * in JSM.
- */
-export class ServiceRegistryService extends CommonHttpService {
-  /**
-   * Retrieve the attributes of given service registries.
-   *
-   * **[Permissions](#permissions) required:** Only Connect apps can make this
-   * request and the servicesIds belong to the tenant you are requesting
-   *
-   * @returns Returned if the request is successful.
-   * @path {GET} /rest/atlassian-connect/1/service-registry
-   */
-  serviceRegistryResourceServicesGet({
-    serviceIds,
-  }: {
-    /**
-     * The ID of the services (the strings starting with "b:" need to be decoded in
-     * Base64).
-     *
-     * @example [
-     *   "ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000000",
-     *   "ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000001"
-     * ]
-     */
-    serviceIds: string[];
-  }): Promise<ServiceRegistry[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/atlassian-connect/1/service-registry",
-        method: "GET",
-        query: {
-          serviceIds,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ServiceRegistry[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ServiceRegistryService.ServiceRegistryResource.services_get.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ServiceRegistryService.ServiceRegistryResource.services_get.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ServiceRegistry")),
-        })
-        .describe(
-          "ServiceRegistryService.ServiceRegistryResource.services_get.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([
-      registerServiceRegistryValidationSchemas,
-    ]);
-  }
-}