@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/issue-link-types-service.ts

@@ -1,360 +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 IssueLinkType,
-  registerCommonValidationSchemas,
-} from "../models/common";
-import {
-  type IssueLinkTypes,
-  registerIssueLinkTypesValidationSchemas,
-} from "../models/issue-link-types";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents [issue link](#api-group-Issue-links) types. Use it to
- * get, create, update, and delete link issue types as well as get lists of all
- * link issue types.
- *
- * To use it, the site must have [issue
- * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
- */
-export class IssueLinkTypesService extends CommonHttpService {
-  /**
-   * Creates an issue link type. Use this operation to create descriptions of the
-   * reasons why issues are linked. The issue link type consists of a name and
-   * descriptions for a link's inward and outward relationships.
-   *
-   * To use this operation, the site must have [issue
-   * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "1000",
-   *   "inward": "Duplicated by",
-   *   "name": "Duplicate",
-   *   "outward": "Duplicates",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
-   * }
-   * @path {POST} /rest/api/3/issueLinkType
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:issue-link-type:jira
-   */
-  createIssueLinkType({
-    issueLinkType,
-  }: {
-    /**
-     * @example {
-     *     "inward": "Duplicated by",
-     *     "name": "Duplicate",
-     *     "outward": "Duplicates"
-     * }
-     */
-    issueLinkType: IssueLinkType;
-  }): Promise<IssueLinkType> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLinkType",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: issueLinkType,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: IssueLinkType;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinkTypesService.createIssueLinkType.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes an issue link type.
-   *
-   * To use this operation, the site must have [issue
-   * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/issueLinkType/{issueLinkTypeId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta delete:issue-link-type:jira
-   */
-  deleteIssueLinkType({
-    issueLinkTypeId,
-  }: {
-    /** The ID of the issue link type. */
-    issueLinkTypeId: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLinkType/{issueLinkTypeId}",
-        method: "DELETE",
-        pathParams: {
-          issueLinkTypeId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns an issue link type.
-   *
-   * To use this operation, the site must have [issue
-   * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for a project in the
-   * site.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "1000",
-   *   "inward": "Duplicated by",
-   *   "name": "Duplicate",
-   *   "outward": "Duplicates",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
-   * }
-   * @path {GET} /rest/api/3/issueLinkType/{issueLinkTypeId}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue-link-type:jira
-   */
-  getIssueLinkType({
-    issueLinkTypeId,
-  }: {
-    /** The ID of the issue link type. */
-    issueLinkTypeId: string;
-  }): Promise<IssueLinkType> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLinkType/{issueLinkTypeId}",
-        method: "GET",
-        pathParams: {
-          issueLinkTypeId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: IssueLinkType;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinkTypesService.getIssueLinkType.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a list of all issue link types.
-   *
-   * To use this operation, the site must have [issue
-   * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for a project in the
-   * site.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "issueLinkTypes": [
-   *     {
-   *       "id": "1000",
-   *       "inward": "Duplicated by",
-   *       "name": "Duplicate",
-   *       "outward": "Duplicates",
-   *       "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
-   *     },
-   *     {
-   *       "id": "1010",
-   *       "inward": "Blocked by",
-   *       "name": "Blocks",
-   *       "outward": "Blocks",
-   *       "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1010"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/issueLinkType
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue-link-type:jira
-   */
-  getIssueLinkTypes(): Promise<IssueLinkTypes> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLinkType",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: IssueLinkTypes;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinkTypesService.getIssueLinkTypes.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Updates an issue link type.
-   *
-   * To use this operation, the site must have [issue
-   * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "1000",
-   *   "inward": "Duplicated by",
-   *   "name": "Duplicate",
-   *   "outward": "Duplicates",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
-   * }
-   * @path {PUT} /rest/api/3/issueLinkType/{issueLinkTypeId}
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:issue-link-type:jira, write:issue-link-type:jira
-   */
-  updateIssueLinkType({
-    issueLinkTypeId,
-    issueLinkType,
-  }: {
-    /** The ID of the issue link type. */
-    issueLinkTypeId: string;
-    /**
-     * @example {
-     *     "inward": "Duplicated by",
-     *     "name": "Duplicate",
-     *     "outward": "Duplicates"
-     * }
-     */
-    issueLinkType: IssueLinkType;
-  }): Promise<IssueLinkType> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLinkType/{issueLinkTypeId}",
-        method: "PUT",
-        pathParams: {
-          issueLinkTypeId,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: issueLinkType,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: IssueLinkType;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinkTypesService.updateIssueLinkType.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueLinkTypesService.getIssueLinkTypes.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("IssueLinkTypes"),
-        })
-        .describe("IssueLinkTypesService.getIssueLinkTypes.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueLinkTypesService.createIssueLinkType.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("IssueLinkType"),
-        })
-        .describe("IssueLinkTypesService.createIssueLinkType.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueLinkTypesService.getIssueLinkType.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("IssueLinkType"),
-        })
-        .describe("IssueLinkTypesService.getIssueLinkType.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueLinkTypesService.updateIssueLinkType.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("IssueLinkType"),
-        })
-        .describe("IssueLinkTypesService.updateIssueLinkType.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerIssueLinkTypesValidationSchemas,
-      registerCommonValidationSchemas,
-    ]);
-  }
-}

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

@@ -1,345 +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 IssueLink,
-  type LinkIssueRequestJsonBean,
-  registerIssueLinksValidationSchemas,
-} from "../models/issue-links";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents links between issues. Use it to get, create, and
- * delete links between issues.
- *
- * To use it, the site must have [issue
- * linking](https://confluence.atlassian.com/x/yoXKM) enabled.
- */
-export class IssueLinksService extends CommonHttpService {
-  /**
-   * Deletes an issue link.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  Browse project [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for all the projects
-   * containing the issues in the link.
-   *  *  *Link issues* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the
-   * projects containing issues in the link.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, permission to view both of the issues.
-   *
-   * @path {DELETE} /rest/api/3/issueLink/{linkId}
-   * @scopes-current write:jira-work
-   * @scopes-beta delete:issue-link:jira
-   */
-  deleteIssueLink({
-    linkId,
-  }: {
-    /** The ID of the issue link. */
-    linkId: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLink/{linkId}",
-        method: "DELETE",
-        pathParams: {
-          linkId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns an issue link.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse project* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for all the projects
-   * containing the linked issues.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, permission to view both of the issues.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "10001",
-   *   "inwardIssue": {
-   *     "fields": {
-   *       "issuetype": {
-   *         "avatarId": 10002,
-   *         "description": "A problem with the software.",
-   *         "entityId": "9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2",
-   *         "hierarchyLevel": 0,
-   *         "iconUrl":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\",",
-   *         "id": "1",
-   *         "name": "Bug",
-   *         "scope": {
-   *           "project": {
-   *             "id": "10000"
-   *           },
-   *           "type": "PROJECT"
-   *         },
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
-   *         "subtask": false
-   *       },
-   *       "priority": {
-   *         "description": "Very little impact.",
-   *         "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/trivial.png",
-   *         "id": "2",
-   *         "name": "Trivial",
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/priority/5",
-   *         "statusColor": "#cfcfcf"
-   *       },
-   *       "status": {
-   *         "description": "The issue is closed.",
-   *         "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
-   *         "id": "5",
-   *         "name": "Closed",
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
-   *         "statusCategory": {
-   *           "colorName": "green",
-   *           "id": 9,
-   *           "key": "completed",
-   *           "self":
-   * "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
-   *         }
-   *       }
-   *     },
-   *     "id": "10004",
-   *     "key": "PR-3",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
-   *   },
-   *   "outwardIssue": {
-   *     "fields": {
-   *       "issuetype": {
-   *         "avatarId": 1,
-   *         "description": "A task that needs to be done.",
-   *         "hierarchyLevel": 0,
-   *         "iconUrl":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\",",
-   *         "id": "3",
-   *         "name": "Task",
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
-   *         "subtask": false
-   *       },
-   *       "priority": {
-   *         "description": "Major loss of function.",
-   *         "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/priorities/major.png",
-   *         "id": "1",
-   *         "name": "Major",
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
-   *         "statusColor": "#009900"
-   *       },
-   *       "status": {
-   *         "description": "The issue is currently being worked on.",
-   *         "iconUrl":
-   * "https://your-domain.atlassian.net/images/icons/progress.gif",
-   *         "id": "10000",
-   *         "name": "In Progress",
-   *         "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
-   *         "statusCategory": {
-   *           "colorName": "yellow",
-   *           "id": 1,
-   *           "key": "in-flight",
-   *           "name": "In Progress",
-   *           "self":
-   * "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
-   *         }
-   *       }
-   *     },
-   *     "id": "10004L",
-   *     "key": "PR-2",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
-   *   },
-   *   "type": {
-   *     "id": "1000",
-   *     "inward": "Duplicated by",
-   *     "name": "Duplicate",
-   *     "outward": "Duplicates",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/issueLinkType/1000"
-   *   }
-   * }
-   * @path {GET} /rest/api/3/issueLink/{linkId}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:field:jira, read:issue-link-type:jira, read:issue:jira,
-   * read:issue-type:jira, read:priority:jira, read:status:jira, read:avatar:jira,
-   * read:issue.time-tracking:jira, read:project-category:jira, read:project:jira,
-   * read:user:jira
-   */
-  getIssueLink({
-    linkId,
-  }: {
-    /** The ID of the issue link. */
-    linkId: string;
-  }): Promise<IssueLink> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLink/{linkId}",
-        method: "GET",
-        pathParams: {
-          linkId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: IssueLink;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinksService.getIssueLink.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Creates a link between two issues. Use this operation to indicate a
-   * relationship between two issues and optionally add a comment to the from
-   * (outward) issue. To use this resource the site must have [Issue
-   * Linking](https://confluence.atlassian.com/x/yoXKM) enabled.
-   *
-   * This resource returns nothing on the creation of an issue link. To obtain the
-   * ID of the issue link, use
-   * `https://your-domain.atlassian.net/rest/api/3/issue/[linked issue
-   * key]?fields=issuelinks`.
-   *
-   * If the link request duplicates a link, the response indicates that the issue
-   * link was created. If the request included a comment, the comment is added.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse project* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for all the projects
-   * containing the issues to be linked,
-   *  *  *Link issues* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) on the project
-   * containing the from (outward) issue,
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  If the comment has visibility restrictions, belongs to the group or has the
-   * role visibility is restricted to.
-   *
-   * @returns Returned if the request is successful.
-   * @path {POST} /rest/api/3/issueLink
-   * @scopes-current write:jira-work
-   * @scopes-beta write:comment:jira, write:issue:jira, write:issue-link:jira
-   */
-  linkIssues({
-    linkIssueRequestJsonBean,
-  }: {
-    /**
-     * The issue link request.
-     *
-     * @example {
-     *     "comment": {
-     *         "body": {
-     *             "content": [
-     *                 {
-     *                     "content": [
-     *                         {
-     *                             "text": "Linked related issue!",
-     *                             "type": "text"
-     *                         }
-     *                     ],
-     *                     "type": "paragraph"
-     *                 }
-     *             ],
-     *             "type": "doc",
-     *             "version": 1
-     *         },
-     *         "visibility": {
-     *             "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
-     *             "type": "group",
-     *             "value": "jira-software-users"
-     *         }
-     *     },
-     *     "inwardIssue": {
-     *         "key": "HSP-1"
-     *     },
-     *     "outwardIssue": {
-     *         "key": "MKY-1"
-     *     },
-     *     "type": {
-     *         "name": "Duplicate"
-     *     }
-     * }
-     */
-    linkIssueRequestJsonBean: LinkIssueRequestJsonBean;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issueLink",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: linkIssueRequestJsonBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueLinksService.linkIssues.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueLinksService.linkIssues.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueLinksService.linkIssues.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueLinksService.getIssueLink.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("IssueLink"),
-        })
-        .describe("IssueLinksService.getIssueLink.response"),
-    );
-    validationSchemaStorage.registerOnce([registerIssueLinksValidationSchemas]);
-  }
-}