@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,221 +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 {
-  registerIssueVotesValidationSchemas,
-  type Votes,
-} from "../models/issue-votes";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents votes cast by users on an issue. Use it to get details
- * of votes on an issue as well as cast and withdrawal votes.
- */
-export class IssueVotesService extends CommonHttpService {
-  /**
-   * Adds the user's vote to an issue. This is the equivalent of the user clicking
-   * *Vote* on an issue in Jira.
-   *
-   * This operation requires the **Allow users to vote on issues** option to be
-   * *ON*. This option is set in General configuration for Jira. See [Configuring
-   * Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * **[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.
-   * @path {POST} /rest/api/3/issue/{issueIdOrKey}/votes
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.vote:jira
-   */
-  addVote({
-    issueIdOrKey,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/votes",
-        method: "POST",
-        pathParams: {
-          issueIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator("IssueVotesService.addVote.response"),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns details about the votes on an issue.
-   *
-   * This operation requires the **Allow users to vote on issues** option to be
-   * *ON*. This option is set in General configuration for Jira. See [Configuring
-   * Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * 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 ini
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * Note that users with the necessary permissions for this operation but without
-   * the *View voters and watchers* project permissions are not returned details in
-   * the `voters` field.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "hasVoted": true,
-   *   "self": "https://your-domain.atlassian.net/rest/api/issue/MKY-1/votes",
-   *   "voters": [
-   *     {
-   *       "accountId": "5b10a2844c20165700ede21g",
-   *       "accountType": "atlassian",
-   *       "active": false,
-   *       "avatarUrls": {
-   *         "16x16":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-   *         "24x24":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-   *         "32x32":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-   *         "48x48":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
-   *       },
-   *       "displayName": "Mia Krystof",
-   *       "key": "",
-   *       "name": "",
-   *       "self":
-   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-   *     }
-   *   ],
-   *   "votes": 24
-   * }
-   * @path {GET} /rest/api/3/issue/{issueIdOrKey}/votes
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue.vote:jira, read:user:jira, read:application-role:jira,
-   * read:avatar:jira, read:group:jira
-   */
-  getVotes({
-    issueIdOrKey,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-  }): Promise<Votes> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/votes",
-        method: "GET",
-        pathParams: {
-          issueIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Votes;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueVotesService.getVotes.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a user's vote from an issue. This is the equivalent of the user
-   * clicking *Unvote* on an issue in Jira.
-   *
-   * This operation requires the **Allow users to vote on issues** option to be
-   * *ON*. This option is set in General configuration for Jira. See [Configuring
-   * Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * **[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.
-   *
-   * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/votes
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.vote:jira
-   */
-  removeVote({
-    issueIdOrKey,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/votes",
-        method: "DELETE",
-        pathParams: {
-          issueIdOrKey,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueVotesService.getVotes.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Votes"),
-        })
-        .describe("IssueVotesService.getVotes.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueVotesService.addVote.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueVotesService.addVote.response"),
-    );
-    validationSchemaStorage.registerOnce([registerIssueVotesValidationSchemas]);
-  }
-}

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

@@ -1,331 +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 BulkIssueIsWatching,
-  type IssueList,
-  registerIssueWatchersValidationSchemas,
-  type Watchers,
-} from "../models/issue-watchers";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents users watching an issue. Use it to get details of
- * users watching an issue as well as start and stop a user watching an issue.
- */
-export class IssueWatchersService extends CommonHttpService {
-  /**
-   * Adds a user as a watcher of an issue by passing the account ID of the user. For
-   * example, `"5b10ac8d82e05b22cc7d4ef5"`. If no user is specified the calling user
-   * is added.
-   *
-   * This operation requires the **Allow users to watch issues** option to be *ON*.
-   * This option is set in General configuration for Jira. See [Configuring Jira
-   * application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * **[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.
-   *  *  To add users other than themselves to the watchlist, *Manage watcher list*
-   * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * that the issue is in.
-   *
-   * @returns Returned if the request is successful.
-   * @path {POST} /rest/api/3/issue/{issueIdOrKey}/watchers
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.watcher:jira
-   */
-  addWatcher({
-    issueIdOrKey,
-    requestBody,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-    /**
-     * The account ID of the user. Note that username cannot be used due to privacy
-     * changes.
-     */
-    requestBody: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/watchers",
-        method: "POST",
-        pathParams: {
-          issueIdOrKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueWatchersService.addWatcher.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the watchers for an issue.
-   *
-   * This operation requires the **Allow users to watch issues** option to be *ON*.
-   * This option is set in General configuration for Jira. See [Configuring Jira
-   * application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * 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 ini
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  To see details of users on the watchlist other than themselves, *View
-   * voters and watchers* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
-   * issue is in.
-   *
-   * @returns Returned if the request is successful
-   *
-   * example: {
-   *   "isWatching": false,
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
-   *   "watchCount": 1,
-   *   "watchers": [
-   *     {
-   *       "accountId": "5b10a2844c20165700ede21g",
-   *       "active": false,
-   *       "displayName": "Mia Krystof",
-   *       "self":
-   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/issue/{issueIdOrKey}/watchers
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue.watcher:jira, read:user:jira, read:avatar:jira
-   */
-  getIssueWatchers({
-    issueIdOrKey,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-  }): Promise<Watchers> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/watchers",
-        method: "GET",
-        pathParams: {
-          issueIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Watchers;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueWatchersService.getIssueWatchers.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns, for the user, details of the watched status of issues from a list. If
-   * an issue ID is invalid, the returned watched status is `false`.
-   *
-   * This operation requires the **Allow users to watch issues** option to be *ON*.
-   * This option is set in General configuration for Jira. See [Configuring Jira
-   * application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * **[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: {
-   *   "issuesIsWatching": {
-   *     "10001": true,
-   *     "10002": false,
-   *     "10005": true
-   *   }
-   * }
-   * @path {POST} /rest/api/3/issue/watching
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue.watcher:jira, read:user:jira
-   */
-  getIsWatchingIssueBulk({
-    issueList,
-  }: {
-    /**
-     * A list of issue IDs.
-     *
-     * @example {
-     *     "issueIds": [
-     *         "10001",
-     *         "10002",
-     *         "10005"
-     *     ]
-     * }
-     */
-    issueList: IssueList;
-  }): Promise<BulkIssueIsWatching> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/watching",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: issueList,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: BulkIssueIsWatching;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueWatchersService.getIsWatchingIssueBulk.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a user as a watcher of an issue.
-   *
-   * This operation requires the **Allow users to watch issues** option to be *ON*.
-   * This option is set in General configuration for Jira. See [Configuring Jira
-   * application options](https://confluence.atlassian.com/x/uYXKM) for details.
-   *
-   * **[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.
-   *  *  To remove users other than themselves from the watchlist, *Manage watcher
-   * list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the
-   * project that the issue is in.
-   *
-   * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/watchers
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.watcher:jira
-   */
-  removeWatcher({
-    issueIdOrKey,
-    username,
-    accountId,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-    /**
-     * This parameter is no longer available. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: string;
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.
-     */
-    accountId?: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/watchers",
-        method: "DELETE",
-        pathParams: {
-          issueIdOrKey,
-        },
-        query: {
-          username,
-          accountId,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueWatchersService.getIssueWatchers.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Watchers"),
-        })
-        .describe("IssueWatchersService.getIssueWatchers.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueWatchersService.addWatcher.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("IssueWatchersService.addWatcher.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueWatchersService.getIsWatchingIssueBulk.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("BulkIssueIsWatching"),
-        })
-        .describe("IssueWatchersService.getIsWatchingIssueBulk.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerIssueWatchersValidationSchemas,
-    ]);
-  }
-}