@resolution/jira-api-client 0.1.0

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

@@ -0,0 +1,597 @@
+// 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 {
+  registerIssueRemoteLinksValidationSchemas,
+  type RemoteIssueLink,
+  type RemoteIssueLinkIdentifies,
+  type RemoteIssueLinkRequest,
+} from "../models/issue-remote-links";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents remote issue links, a way of linking Jira to
+ * information in other systems. Use it to get, create, update, and delete remote
+ * issue links either by ID or global ID. The global ID provides a way of
+ * accessing remote issue links using information about the item's remote system
+ * host and remote system identifier.
+ */
+export class IssueRemoteLinksService extends CommonHttpService {
+  /**
+   * Creates or updates a remote issue link for an issue.
+   *
+   * If a `globalId` is provided and a remote issue link with that global ID is
+   * found it is updated. Any fields without values in the request are set to null.
+   * Otherwise, the remote issue link is created.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects* and *Link issues* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * configured, issue-level security permission to view the issue.
+   *
+   * @returns * status: 200, mediaType: application/json
+   *
+   *    Returned if the remote issue link is updated.
+   *
+   *    example: {
+   *      "id": 10000,
+   *      "self":
+   * "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
+   *    }
+   *
+   *  * status: 201, mediaType: application/json
+   *
+   *    Returned if the remote issue link is created.
+   *
+   *    example: {
+   *      "id": 10000,
+   *      "self":
+   * "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
+   *    }
+   * @path {POST} /rest/api/3/issue/{issueIdOrKey}/remotelink
+   * @scopes-current write:jira-work
+   * @scopes-beta write:issue:jira, write:issue.remote-link:jira, read:issue.remote-link:jira
+   */
+  createOrUpdateRemoteIssueLink({
+    issueIdOrKey,
+    remoteIssueLinkRequest,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /**
+     * @example {
+     *     "application": {
+     *         "name": "My Acme Tracker",
+     *         "type": "com.acme.tracker"
+     *     },
+     *     "globalId": "system=http://www.mycompany.com/support&id=1",
+     *     "object": {
+     *         "icon": {
+     *             "title": "Support Ticket",
+     *             "url16x16": "http://www.mycompany.com/support/ticket.png"
+     *         },
+     *         "status": {
+     *             "icon": {
+     *                 "link": "http://www.mycompany.com/support?id=1&details=closed",
+     *                 "title": "Case Closed",
+     *                 "url16x16": "http://www.mycompany.com/support/resolved.png"
+     *             },
+     *             "resolved": true
+     *         },
+     *         "summary": "Customer support issue",
+     *         "title": "TSTSUP-111",
+     *         "url": "http://www.mycompany.com/support?id=1"
+     *     },
+     *     "relationship": "causes"
+     * }
+     */
+    remoteIssueLinkRequest: RemoteIssueLinkRequest;
+  }): Promise<{
+    created: boolean;
+    remoteIssueLinkIdentifies: RemoteIssueLinkIdentifies;
+  }> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink",
+        method: "POST",
+        pathParams: {
+          issueIdOrKey,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: remoteIssueLinkRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200 | 201;
+          mediaType: "application/json";
+          body: RemoteIssueLinkIdentifies;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueRemoteLinksService.createOrUpdateRemoteIssueLink.response",
+        ),
+      )
+      .then(commonHttpClient.asCreatedResponse("remoteIssueLinkIdentifies"));
+  }
+  /**
+   * Deletes the remote issue link from the issue using the link's global ID. Where
+   * the global ID includes reserved URL characters these must be escaped in the
+   * request. For example, pass `system=http://www.mycompany.com/support&id=1` as
+   * `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects* and *Link issues* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * implemented, issue-level security permission to view the issue.
+   *
+   * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/remotelink
+   * @scopes-current write:jira-work
+   * @scopes-beta delete:issue.remote-link:jira, write:issue:jira
+   */
+  deleteRemoteIssueLinkByGlobalId({
+    issueIdOrKey,
+    globalId,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /** The global ID of a remote issue link. */
+    globalId: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink",
+        method: "DELETE",
+        pathParams: {
+          issueIdOrKey,
+        },
+        query: {
+          globalId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Deletes a remote issue link from an issue.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects*, *Edit issues*, and *Link issues* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * configured, issue-level security permission to view the issue.
+   *
+   * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
+   * @scopes-current write:jira-work
+   * @scopes-beta delete:issue.remote-link:jira, write:issue:jira
+   */
+  deleteRemoteIssueLinkById({
+    issueIdOrKey,
+    linkId,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /** The ID of a remote issue link. */
+    linkId: string;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}",
+        method: "DELETE",
+        pathParams: {
+          issueIdOrKey,
+          linkId,
+        },
+      })
+      .then(commonHttpClient.discardResult);
+  }
+  /**
+   * Returns a remote issue link for an issue.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * configured, issue-level security permission to view the issue.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "application": {
+   *     "name": "My Acme Tracker",
+   *     "type": "com.acme.tracker"
+   *   },
+   *   "globalId": "system=http://www.mycompany.com/support&id=1",
+   *   "id": 10000,
+   *   "object": {
+   *     "icon": {
+   *       "title": "Support Ticket",
+   *       "url16x16": "http://www.mycompany.com/support/ticket.png"
+   *     },
+   *     "status": {
+   *       "icon": {
+   *         "link": "http://www.mycompany.com/support?id=1&details=closed",
+   *         "title": "Case Closed",
+   *         "url16x16": "http://www.mycompany.com/support/resolved.png"
+   *       },
+   *       "resolved": true
+   *     },
+   *     "summary": "Customer support issue",
+   *     "title": "TSTSUP-111",
+   *     "url": "http://www.mycompany.com/support?id=1"
+   *   },
+   *   "relationship": "causes",
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
+   * }
+   * @path {GET} /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue.remote-link:jira, read:status:jira
+   */
+  getRemoteIssueLinkById({
+    issueIdOrKey,
+    linkId,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /** The ID of the remote issue link. */
+    linkId: string;
+  }): Promise<RemoteIssueLink> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}",
+        method: "GET",
+        pathParams: {
+          issueIdOrKey,
+          linkId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: RemoteIssueLink;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueRemoteLinksService.getRemoteIssueLinkById.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the remote issue links for an issue. When a remote issue link global ID
+   * is provided the record with that global ID is returned, otherwise all remote
+   * issue links are returned. Where a global ID includes reserved URL characters
+   * these must be escaped in the request. For example, pass
+   * `system=http://www.mycompany.com/support&id=1` as
+   * `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * configured, issue-level security permission to view the issue.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "application": {
+   *       "name": "My Acme Tracker",
+   *       "type": "com.acme.tracker"
+   *     },
+   *     "globalId": "system=http://www.mycompany.com/support&id=1",
+   *     "id": 10000,
+   *     "object": {
+   *       "icon": {
+   *         "title": "Support Ticket",
+   *         "url16x16": "http://www.mycompany.com/support/ticket.png"
+   *       },
+   *       "status": {
+   *         "icon": {
+   *           "link": "http://www.mycompany.com/support?id=1&details=closed",
+   *           "title": "Case Closed",
+   *           "url16x16": "http://www.mycompany.com/support/resolved.png"
+   *         },
+   *         "resolved": true
+   *       },
+   *       "summary": "Customer support issue",
+   *       "title": "TSTSUP-111",
+   *       "url": "http://www.mycompany.com/support?id=1"
+   *     },
+   *     "relationship": "causes",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10000"
+   *   },
+   *   {
+   *     "application": {
+   *       "name": "My Acme Tester",
+   *       "type": "com.acme.tester"
+   *     },
+   *     "globalId": "system=http://www.anothercompany.com/tester&id=1234",
+   *     "id": 10001,
+   *     "object": {
+   *       "icon": {
+   *         "title": "Test Case",
+   *         "url16x16": "http://www.anothercompany.com/tester/images/testcase.gif"
+   *       },
+   *       "status": {
+   *         "icon": {
+   *           "link":
+   * "http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g",
+   *           "title": "Tested by Mia Krystof",
+   *           "url16x16":
+   * "http://www.anothercompany.com/tester/images/person/mia.gif"
+   *         },
+   *         "resolved": false
+   *       },
+   *       "summary": "Test that the submit button saves the item",
+   *       "title": "Test Case #1234",
+   *       "url": "http://www.anothercompany.com/tester/testcase/1234"
+   *     },
+   *     "relationship": "is tested by",
+   *     "self":
+   * "https://your-domain.atlassian.net/rest/api/issue/MKY-1/remotelink/10001"
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/issue/{issueIdOrKey}/remotelink
+   * @scopes-current read:jira-work
+   * @scopes-beta read:issue.remote-link:jira, read:status:jira
+   */
+  getRemoteIssueLinks({
+    issueIdOrKey,
+    globalId,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /** The global ID of the remote issue link. */
+    globalId?: string;
+  }): Promise<RemoteIssueLink> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink",
+        method: "GET",
+        pathParams: {
+          issueIdOrKey,
+        },
+        query: {
+          globalId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: RemoteIssueLink;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueRemoteLinksService.getRemoteIssueLinks.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates a remote issue link for an issue.
+   *
+   * Note: Fields without values in the request are set to null.
+   *
+   * This operation requires [issue linking to be
+   * active](https://confluence.atlassian.com/x/yoXKM).
+   *
+   * This operation can be accessed anonymously.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Browse projects* and *Link issues* [project
+   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+   * issue is in.
+   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+   * configured, issue-level security permission to view the issue.
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}
+   * @scopes-current write:jira-work
+   * @scopes-beta write:issue:jira, write:issue.remote-link:jira
+   */
+  updateRemoteIssueLink({
+    issueIdOrKey,
+    linkId,
+    remoteIssueLinkRequest,
+  }: {
+    /** The ID or key of the issue. */
+    issueIdOrKey: string;
+    /** The ID of the remote issue link. */
+    linkId: string;
+    /**
+     * @example {
+     *     "application": {
+     *         "name": "My Acme Tracker",
+     *         "type": "com.acme.tracker"
+     *     },
+     *     "globalId": "system=http://www.mycompany.com/support&id=1",
+     *     "object": {
+     *         "icon": {
+     *             "title": "Support Ticket",
+     *             "url16x16": "http://www.mycompany.com/support/ticket.png"
+     *         },
+     *         "status": {
+     *             "icon": {
+     *                 "link": "http://www.mycompany.com/support?id=1&details=closed",
+     *                 "title": "Case Closed",
+     *                 "url16x16": "http://www.mycompany.com/support/resolved.png"
+     *             },
+     *             "resolved": true
+     *         },
+     *         "summary": "Customer support issue",
+     *         "title": "TSTSUP-111",
+     *         "url": "http://www.mycompany.com/support?id=1"
+     *     },
+     *     "relationship": "causes"
+     * }
+     */
+    remoteIssueLinkRequest: RemoteIssueLinkRequest;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}",
+        method: "PUT",
+        pathParams: {
+          issueIdOrKey,
+          linkId,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: remoteIssueLinkRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueRemoteLinksService.updateRemoteIssueLink.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "IssueRemoteLinksService.getRemoteIssueLinks.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("RemoteIssueLink"),
+        })
+        .describe("IssueRemoteLinksService.getRemoteIssueLinks.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueRemoteLinksService.createOrUpdateRemoteIssueLink.response",
+      z
+        .object({
+          status: z.number(),
+          mediaType: z.string(),
+          body: z.unknown(),
+        })
+        .superRefine(({ status: status, body: body }, ctx) => {
+          if (status === 200 || status === 201) {
+            validationSchemaStorage
+              .lazy("RemoteIssueLinkIdentifies")
+              .parse(body);
+          } else {
+            ctx.addIssue({
+              code: z.ZodIssueCode.custom,
+              path: ["status"],
+              message: `Unexpected status code: ${status}`,
+            });
+          }
+        })
+        .describe(
+          "IssueRemoteLinksService.createOrUpdateRemoteIssueLink.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueRemoteLinksService.getRemoteIssueLinkById.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("RemoteIssueLink"),
+        })
+        .describe("IssueRemoteLinksService.getRemoteIssueLinkById.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueRemoteLinksService.updateRemoteIssueLink.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("IssueRemoteLinksService.updateRemoteIssueLink.response"),
+    );
+    validationSchemaStorage.registerOnce([
+      registerIssueRemoteLinksValidationSchemas,
+    ]);
+  }
+}