@resolution/jira-api-client 0.1.6 → 0.2.0

package/lib/openapi/platform/services/StatusService.js

@@ -0,0 +1,321 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatusService = 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/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const status_1 = require("../models/status");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+/**
+ * This resource represents statuses. Use it to search, get, create, delete, and
+ * change statuses.
+ */
+class StatusService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Creates statuses for a global or project scope.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "description": "The issue is resolved",
+     *     "id": "1000",
+     *     "name": "Finished",
+     *     "scope": {
+     *       "project": {
+     *         "id": "1"
+     *       },
+     *       "type": "PROJECT"
+     *     },
+     *     "statusCategory": "DONE",
+     *     "usages": [],
+     *     "workflowUsages": []
+     *   }
+     * ]
+     * @path {POST} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    createStatuses({ statusCreateRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/statuses",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: statusCreateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("StatusService.createStatuses.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Deletes statuses by ID.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     * @path {DELETE} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    deleteStatusesById({ id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/statuses",
+            method: "DELETE",
+            query: {
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("StatusService.deleteStatusesById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a list of the statuses specified by one or more status IDs.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "description": "The issue is resolved",
+     *     "id": "1000",
+     *     "name": "Finished",
+     *     "scope": {
+     *       "project": {
+     *         "id": "1"
+     *       },
+     *       "type": "PROJECT"
+     *     },
+     *     "statusCategory": "DONE",
+     *     "usages": [
+     *       {
+     *         "issueTypes": [
+     *           "10002"
+     *         ],
+     *         "project": {
+     *           "id": "1"
+     *         }
+     *       }
+     *     ],
+     *     "workflowUsages": [
+     *       {
+     *         "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+     *         "workflowName": "Workflow 1"
+     *       }
+     *     ]
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow:jira
+     */
+    getStatusesById({ expand, id, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/statuses",
+            method: "GET",
+            query: {
+                expand,
+                id,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("StatusService.getStatusesById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns a
+     * [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination)
+     * list of statuses that match a search on name or project.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "isLast": true,
+     *   "maxResults": 2,
+     *   "nextPage":
+     * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2",
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2",
+     *   "startAt": 0,
+     *   "total": 5,
+     *   "values": [
+     *     {
+     *       "description": "The issue is resolved",
+     *       "id": "1000",
+     *       "name": "Finished",
+     *       "scope": {
+     *         "project": {
+     *           "id": "1"
+     *         },
+     *         "type": "PROJECT"
+     *       },
+     *       "statusCategory": "DONE",
+     *       "usages": [
+     *         {
+     *           "issueTypes": [
+     *             "10002"
+     *           ],
+     *           "project": {
+     *             "id": "1"
+     *           }
+     *         }
+     *       ],
+     *       "workflowUsages": [
+     *         {
+     *           "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+     *           "workflowName": "Workflow 1"
+     *         }
+     *       ]
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/statuses/search
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:workflow:jira
+     */
+    search({ expand, projectId, startAt, maxResults, searchString, statusCategory, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/statuses/search",
+            method: "GET",
+            query: {
+                expand,
+                projectId,
+                startAt,
+                maxResults,
+                searchString,
+                statusCategory,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("StatusService.search.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Updates statuses by ID.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Administer projects* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *  *  *Administer Jira* [project
+     * permission.](https://confluence.atlassian.com/x/yodKLg)
+     *
+     * @returns Returned if the request is successful.
+     * @path {PUT} /rest/api/3/statuses
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:workflow:jira
+     */
+    updateStatuses({ statusUpdateRequest, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/statuses",
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: statusUpdateRequest,
+        })
+            .then(this.getClientInstance().responseHandler({
+            204: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("StatusService.updateStatuses.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("StatusService.getStatusesById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("JiraStatus")),
+        })
+            .describe("StatusService.getStatusesById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("StatusService.updateStatuses.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("StatusService.updateStatuses.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("StatusService.createStatuses.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("JiraStatus")),
+        })
+            .describe("StatusService.createStatuses.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("StatusService.deleteStatusesById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(204),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("StatusService.deleteStatusesById.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("StatusService.search.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("PageOfStatuses"),
+        })
+            .describe("StatusService.search.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([status_1.registerStatusValidationSchemas]);
+    }
+}
+exports.StatusService = StatusService;
+//# sourceMappingURL=StatusService.js.map

package/lib/openapi/platform/services/StatusService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatusService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/StatusService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAM0B;AAC1B,wEAAqE;AACrE;;;GAGG;AACH,MAAa,aAAc,SAAQ,qCAAiB;IAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,cAAc,CAAC,EACb,mBAAmB,GAsBpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,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,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,CAAC,EACjB,EAAE,GASH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE;gBACL,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,iDAAuB,CAAC,SAAS,CAC/B,2CAA2C,CAC5C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,eAAe,CAAC,EACd,MAAM,EACN,EAAE,GAkBH;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,MAAM;gBACN,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,iDAAuB,CAAC,SAAS,CAC/B,wCAAwC,CACzC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,MAAM,CAAC,EACL,MAAM,EACN,SAAS,EACT,OAAO,EACP,UAAU,EACV,YAAY,EACZ,cAAc,GA2Bf;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,MAAM;gBACN,SAAS;gBACT,OAAO;gBACP,UAAU;gBACV,YAAY;gBACZ,cAAc;aACf;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,CAAC,iDAAuB,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;aACxE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EACb,mBAAmB,GAiBpB;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,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,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,wCAAwC,EACxC,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,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,wCAAwC,CAAC,CACtD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,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,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+BAA+B,EAC/B,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,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,+BAA+B,CAAC,CAC7C,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA9dD,sCA8dC"}

package/lib/openapi/platform/services/TasksService.d.ts

@@ -0,0 +1,71 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type TaskProgressBeanObject } from "../models/common";
+/**
+ * This resource represents a [long-running asynchronous
+ * tasks](#async-operations). Use it to obtain details about the progress of a
+ * long-running task or cancel a long-running task.
+ */
+export declare class TasksService extends CommonHttpService {
+    /**
+     * Cancels a task.
+     *
+     * **[Permissions](#permissions) required:** either of:
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *  *  Creator of the task.
+     *
+     * @returns Returned if the request is successful.
+     * @path {POST} /rest/api/3/task/{taskId}/cancel
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:async-task:jira
+     */
+    cancelTask({ taskId, }: {
+        /** The ID of the task. */
+        taskId: string;
+    }): Promise<unknown>;
+    /**
+     * Returns the status of a [long-running asynchronous task](#async).
+     *
+     * When a task has finished, this operation returns the JSON blob applicable to
+     * the task. See the documentation of the operation that created the task for
+     * details. Task details are not permanently retained. As of September 2019,
+     * details are retained for 14 days although this period may change without notice.
+     *
+     * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June
+     * 15, 2024.
+     *
+     *  *  `read:jira-work`
+     *
+     * **[Permissions](#permissions) required:** either of:
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *  *  Creator of the task.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/task/1",
+     *   "id": "1",
+     *   "description": "Task description",
+     *   "status": "COMPLETE",
+     *   "result": "the task result, this may be any JSON",
+     *   "submittedBy": 10000,
+     *   "progress": 100,
+     *   "elapsedRuntime": 156,
+     *   "submitted": 1501708132800,
+     *   "started": 1501708132900,
+     *   "finished": 1501708133000,
+     *   "lastUpdate": 1501708133000
+     * }
+     * @path {GET} /rest/api/3/task/{taskId}
+     * @scopes-current read:jira-work
+     * @scopes-beta
+     */
+    getTask({ taskId, }: {
+        /** The ID of the task. */
+        taskId: string;
+    }): Promise<TaskProgressBeanObject>;
+    static initialize(): void;
+}

package/lib/openapi/platform/services/TasksService.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TasksService = 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/CommonHttpClient");
+const CommonHttpService_1 = require("../core/CommonHttpService");
+const common_1 = require("../models/common");
+const validationSchemaStorage_1 = require("../validationSchemaStorage");
+/**
+ * This resource represents a [long-running asynchronous
+ * tasks](#async-operations). Use it to obtain details about the progress of a
+ * long-running task or cancel a long-running task.
+ */
+class TasksService extends CommonHttpService_1.CommonHttpService {
+    /**
+     * Cancels a task.
+     *
+     * **[Permissions](#permissions) required:** either of:
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *  *  Creator of the task.
+     *
+     * @returns Returned if the request is successful.
+     * @path {POST} /rest/api/3/task/{taskId}/cancel
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:async-task:jira
+     */
+    cancelTask({ taskId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/task/{taskId}/cancel",
+            method: "POST",
+            pathParams: {
+                taskId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            202: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TasksService.cancelTask.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Returns the status of a [long-running asynchronous task](#async).
+     *
+     * When a task has finished, this operation returns the JSON blob applicable to
+     * the task. See the documentation of the operation that created the task for
+     * details. Task details are not permanently retained. As of September 2019,
+     * details are retained for 14 days although this period may change without notice.
+     *
+     * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June
+     * 15, 2024.
+     *
+     *  *  `read:jira-work`
+     *
+     * **[Permissions](#permissions) required:** either of:
+     *
+     *  *  *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *  *  Creator of the task.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/task/1",
+     *   "id": "1",
+     *   "description": "Task description",
+     *   "status": "COMPLETE",
+     *   "result": "the task result, this may be any JSON",
+     *   "submittedBy": 10000,
+     *   "progress": 100,
+     *   "elapsedRuntime": 156,
+     *   "submitted": 1501708132800,
+     *   "started": 1501708132900,
+     *   "finished": 1501708133000,
+     *   "lastUpdate": 1501708133000
+     * }
+     * @path {GET} /rest/api/3/task/{taskId}
+     * @scopes-current read:jira-work
+     * @scopes-beta
+     */
+    getTask({ taskId, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/api/3/task/{taskId}",
+            method: "GET",
+            pathParams: {
+                taskId,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validationSchemaStorage_1.validationSchemaStorage.validator("TasksService.getTask.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TasksService.getTask.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: validationSchemaStorage_1.validationSchemaStorage.lazy("TaskProgressBeanObject"),
+        })
+            .describe("TasksService.getTask.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TasksService.cancelTask.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(202),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("TasksService.cancelTask.response"));
+        validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
+    }
+}
+exports.TasksService = TasksService;
+//# sourceMappingURL=TasksService.js.map

package/lib/openapi/platform/services/TasksService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TasksService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/TasksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE;;;;GAIG;AACH,MAAa,YAAa,SAAQ,qCAAiB;IACjD;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EACT,MAAM,GAIP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kCAAkC;YACxC,MAAM,EAAE,MAAM;YACd,UAAU,EAAE;gBACV,MAAM;aACP;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,iDAAuB,CAAC,SAAS,CAAC,kCAAkC,CAAC,CACtE;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,OAAO,CAAC,EACN,MAAM,GAIP;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,MAAM;aACP;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,CAAC,iDAAuB,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;aACxE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,+BAA+B,EAC/B,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,iDAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC;SAC7D,CAAC;aACD,QAAQ,CAAC,+BAA+B,CAAC,CAC7C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kCAAkC,EAClC,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,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,kCAAkC,CAAC,CAChD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA7ID,oCA6IC"}

package/lib/openapi/platform/services/TimeTrackingService.d.ts

@@ -0,0 +1,140 @@
+import * as commonHttpClient from "../core/CommonHttpClient";
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type TimeTrackingConfiguration } from "../models/common";
+import { type TimeTrackingProvider } from "../models/timeTracking";
+/**
+ * This resource represents time tracking and time tracking providers. Use it to
+ * get and set the time tracking provider, get and set the time tracking options,
+ * and disable time tracking.
+ */
+export declare class TimeTrackingService extends CommonHttpService {
+    /**
+     * Returns all time tracking providers. By default, Jira only has one time
+     * tracking provider: *JIRA provided time tracking*. However, you can install
+     * other time tracking providers via apps from the Atlassian Marketplace. For more
+     * information on time tracking providers, see the documentation for the [ Time
+     * Tracking
+     * Provider](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/)
+     * module.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "key": "Jira",
+     *     "name": "JIRA provided time tracking",
+     *     "url": "/example/config/url"
+     *   }
+     * ]
+     * @path {GET} /rest/api/3/configuration/timetracking/list
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue.time-tracking:jira
+     */
+    getAvailableTimeTrackingImplementations(): Promise<TimeTrackingProvider[]>;
+    /**
+     * Returns the time tracking provider that is currently selected. Note that if
+     * time tracking is disabled, then a successful but empty response is returned.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns * status: 200, mediaType: application/json
+     *
+     *    Returned if the request is successful and time tracking is enabled.
+     *
+     *    example: {
+     *      "key": "Jira",
+     *      "name": "JIRA provided time tracking",
+     *      "url": "/example/config/url"
+     *    }
+     *
+     *  * status: 204, mediaType: application/json
+     *
+     *    Returned if the request is successful but time tracking is disabled.
+     * @path {GET} /rest/api/3/configuration/timetracking
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue.time-tracking:jira
+     */
+    getSelectedTimeTrackingImplementation(): Promise<commonHttpClient.WithResponse<{
+        status: 200;
+        mediaType: "application/json";
+        body: TimeTrackingProvider;
+    } | {
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    }>>;
+    /**
+     * Returns the time tracking settings. This includes settings such as the time
+     * format, default time unit, and others. For more information, see [Configuring
+     * time tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultUnit": "hour",
+     *   "timeFormat": "pretty",
+     *   "workingDaysPerWeek": 5.5,
+     *   "workingHoursPerDay": 7.6
+     * }
+     * @path {GET} /rest/api/3/configuration/timetracking/options
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:issue.time-tracking:jira
+     */
+    getSharedTimeTrackingConfiguration(): Promise<TimeTrackingConfiguration>;
+    /**
+     * Selects a time tracking provider.
+     *
+     * **[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/configuration/timetracking
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:issue.time-tracking:jira
+     */
+    selectTimeTrackingImplementation({ timeTrackingProvider, }: {
+        /**
+         * @example {
+         *     "key": "Jira"
+         * }
+         */
+        timeTrackingProvider: TimeTrackingProvider;
+    }): Promise<void>;
+    /**
+     * Sets the time tracking settings.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "defaultUnit": "hour",
+     *   "timeFormat": "pretty",
+     *   "workingDaysPerWeek": 5.5,
+     *   "workingHoursPerDay": 7.6
+     * }
+     * @path {PUT} /rest/api/3/configuration/timetracking/options
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:issue.time-tracking:jira, read:issue.time-tracking:jira
+     */
+    setSharedTimeTrackingConfiguration({ timeTrackingConfiguration, }: {
+        /**
+         * @example {
+         *     "defaultUnit": "hour",
+         *     "timeFormat": "pretty",
+         *     "workingDaysPerWeek": 5.5,
+         *     "workingHoursPerDay": 7.6
+         * }
+         */
+        timeTrackingConfiguration: TimeTrackingConfiguration;
+    }): Promise<TimeTrackingConfiguration>;
+    static initialize(): void;
+}