@resolution/jira-api-client 0.1.0

package/lib/openapi/platform/services/issue-types-service.js

@@ -0,0 +1,495 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IssueTypesService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const common_1 = require("../models/common");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * This resource represents issues types. Use it to:
+ *
+ *  *  get, create, update, and delete issue types.
+ *  *  get all issue types for a user.
+ *  *  get alternative issue types.
+ *  *  set an avatar for an issue type.
+ */
+class IssueTypesService extends common_http_service_1.CommonHttpService {
+    /**
+     * Creates an issue type and adds it to the default issue type scheme.
+     *
+     * **[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/issuetype
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:issue-type:jira, read:avatar:jira, read:issue-type:jira,
+     * read:project-category:jira, read:project:jira
+     */
+    createIssueType({ issueTypeCreateBean, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: issueTypeCreateBean,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.createIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Loads an avatar for the issue type.
+     *
+     * Specify the avatar's local file location in the body of the request. Also,
+     * include the following headers:
+     *
+     *  *  `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the
+     * request, for more information see [Special Headers](#special-request-headers).
+     *  *  `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.
+     *
+     * For example:
+     * `curl --request POST \ --user email@example.com:<api_token> \ --header
+     * 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \
+     * --data-binary "<@/path/to/file/with/your/avatar>" \ --url
+     * 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This`
+     *
+     * The avatar is cropped to a square. If no crop parameters are specified, the
+     * square originates at the top left of the image. The length of the square's
+     * sides is set to the smaller of the height or width of the image.
+     *
+     * The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and
+     * 48x48 in size.
+     *
+     * After creating the avatar, use [ Update issue
+     * type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed
+     * avatar.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "id": "1000",
+     *   "isDeletable": false,
+     *   "isSelected": false,
+     *   "isSystemAvatar": true,
+     *   "urls": {
+     *     "16x16": "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
+     *     "24x24": "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
+     *     "32x32": "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
+     *     "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
+     *   }
+     * }
+     * @path {POST} /rest/api/3/issuetype/{id}/avatar2
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:avatar:jira, write:issue-type:jira, read:avatar:jira
+     */
+    createIssueTypeAvatar({ id, x, y, size, mediaType, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/{id}/avatar2",
+            method: "POST",
+            pathParams: {
+                id,
+            },
+            query: {
+                x,
+                y,
+                size,
+            },
+            headers: {
+                "Content-Type": mediaType,
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            201: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.createIssueTypeAvatar.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes the issue type. If the issue type is in use, all uses are updated with
+     * the alternative issue type (`alternativeIssueTypeId`). A list of alternative
+     * issue types are obtained from the [Get alternative issue
+     * types](#api-rest-api-3-issuetype-id-alternatives-get) resource.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @path {DELETE} /rest/api/3/issuetype/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta delete:issue-type:jira
+     */
+    deleteIssueType({ id, alternativeIssueTypeId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/{id}",
+            method: "DELETE",
+            pathParams: {
+                id,
+            },
+            query: {
+                alternativeIssueTypeId,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Returns a list of issue types that can be used to replace the issue type. The
+     * alternative issue types are those assigned to the same workflow scheme, field
+     * configuration scheme, and screen scheme.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** None.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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
+     *   },
+     *   {
+     *     "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
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/issuetype/{id}/alternatives
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:project-category:jira, read:project:jira,
+     * read:avatar:jira
+     */
+    getAlternativeIssueTypes({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/{id}/alternatives",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.getAlternativeIssueTypes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns all issue types.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** Issue types are only returned as
+     * follows:
+     *
+     *  *  if the user has the *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are
+     * returned.
+     *  *  if the user has the *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for one or more
+     * projects, the issue types associated with the projects the user has permission
+     * to browse are returned.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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
+     *   },
+     *   {
+     *     "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
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/issuetype
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+     * read:project:jira
+     */
+    getIssueAllTypes() {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype",
+            method: "GET",
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.getIssueAllTypes.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns an issue type.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue
+     * type is associated with or *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "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
+     * }
+     * @path {GET} /rest/api/3/issuetype/{id}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+     * read:project:jira
+     */
+    getIssueType({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/{id}",
+            method: "GET",
+            pathParams: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.getIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns issue types for a project.
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) in the relevant project
+     * or *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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
+     *   },
+     *   {
+     *     "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",
+     *     "scope": {
+     *       "project": {
+     *         "id": "10000"
+     *       },
+     *       "type": "PROJECT"
+     *     },
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/issueType/3",
+     *     "subtask": false
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/issuetype/project
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-type:jira, read:avatar:jira, read:project-category:jira,
+     * read:project:jira
+     */
+    getIssueTypesForProject({ projectId, level, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/project",
+            method: "GET",
+            query: {
+                projectId,
+                level,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.getIssueTypesForProject.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates the issue type.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/issuetype/{id}
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:issue-type:jira, read:avatar:jira, read:issue-type:jira,
+     * read:project-category:jira, read:project:jira
+     */
+    updateIssueType({ id, issueTypeUpdateBean, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/issuetype/{id}",
+            method: "PUT",
+            pathParams: {
+                id,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: issueTypeUpdateBean,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("IssueTypesService.updateIssueType.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.getIssueAllTypes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+            .describe("IssueTypesService.getIssueAllTypes.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.createIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+            .describe("IssueTypesService.createIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.getIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+            .describe("IssueTypesService.getIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.updateIssueType.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails"),
+        })
+            .describe("IssueTypesService.updateIssueType.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.getAlternativeIssueTypes.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+            .describe("IssueTypesService.getAlternativeIssueTypes.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.createIssueTypeAvatar.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(201),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validation_schema_storage_1.validationSchemaStorage.lazy("Avatar"),
+        })
+            .describe("IssueTypesService.createIssueTypeAvatar.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("IssueTypesService.getIssueTypesForProject.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validation_schema_storage_1.validationSchemaStorage.lazy("IssueTypeDetails")),
+        })
+            .describe("IssueTypesService.getIssueTypesForProject.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.IssueTypesService = IssueTypesService;
+//# sourceMappingURL=issue-types-service.js.map

package/lib/openapi/platform/services/issue-types-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue-types-service.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/issue-types-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,6CAI0B;AAK1B,4EAAuE;AACvE;;;;;;;GAOG;AACH,MAAa,iBAAkB,SAAQ,uCAAiB;IACtD;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,EACd,mBAAmB,GAUpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,mBAAmB;SAC1B,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,CAAC,EACD,CAAC,EACD,IAAI,EACJ,SAAS,EACT,WAAW,GAYZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,oCAAoC;YAC1C,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,CAAC;gBACD,CAAC;gBACD,IAAI;aACL;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,SAAS;aAC1B;YACD,IAAI,EAAE,WAAW;SAClB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EACd,EAAE,EACF,sBAAsB,GAMvB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,sBAAsB;aACvB;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,wBAAwB,CAAC,EACvB,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,qDAAqD,CACtD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,KAAK;SACd,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,6CAA6C,CAC9C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,YAAY,CAAC,EACX,EAAE,GAIH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,uBAAuB,CAAC,EACtB,SAAS,EACT,KAAK,GAYN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,+BAA+B;YACrC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,SAAS;gBACT,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,EACd,EAAE,EACF,mBAAmB,GAYpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,mBAAmB;SAC1B,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,mDAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC7C,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,KAAK,CAAC,mDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,mDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA7oBD,8CA6oBC"}

package/lib/openapi/platform/services/issue-votes-service.d.ts

@@ -0,0 +1,117 @@
+import { CommonHttpService } from "../core/common-http-service";
+import { type Votes } from "../models/issue-votes";
+/**
+ * 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 declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    static initialize(): void;
+}