@resolution/jira-api-client 0.1.0

package/lib/openapi/software/services/feature-flags-service.d.ts

@@ -0,0 +1,170 @@
+import { CommonHttpService } from "../core/common-http-service";
+/**
+ * Apis related to integrating Feature Flags with Jira Software. These apis are
+ * only available to Atlassian Connect apps. To use these apis you must have the
+ * Feature Flag module (see
+ * https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in
+ * your app's descriptor
+ */
+export declare class FeatureFlagsService extends CommonHttpService {
+    /**
+     * Delete the Feature Flag data currently stored for the given ID.
+     *
+     * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+     * used to confirm that data has been deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/featureflags/0.1/flag/{featureFlagId}
+     */
+    deleteFeatureFlagById({ featureFlagId, updateSequenceId, authorization, }: {
+        /** The ID of the Feature Flag to delete. */
+        featureFlagId: string;
+        /**
+         * This parameter usage is no longer supported.
+         *
+         * An optional `_updateSequenceId` to use to control deletion.
+         *
+         * Only stored data with an `updateSequenceId` less than or equal to that provided
+         * will be deleted.
+         * This can be used help ensure submit/delete requests are applied correctly if
+         * issued close together.
+         *
+         * @deprecated
+         */
+        updateSequenceId?: number;
+        /**
+         * All requests must be signed with a Connect JWT token that corresponds to the
+         * Provider app installed in Jira.
+         *
+         * If the JWT token corresponds to an app that does not define Feature Flags
+         * module it will be rejected with a 403.
+         *
+         * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+         * details.
+         */
+        authorization: string;
+    }): Promise<void>;
+    /**
+     * Bulk delete all Feature Flags that match the given request.
+     *
+     * One or more query params must be supplied to specify Properties to delete by.
+     * Optional param `_updateSequenceId` is no longer supported.
+     * If more than one Property is provided, data will be deleted that matches ALL of
+     * the Properties (e.g. treated as an AND).
+     * See the documentation for the submitFeatureFlags operation for more details.
+     *
+     * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+     *
+     * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+     * used to confirm that data has been deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/featureflags/0.1/bulkByProperties
+     */
+    deleteFeatureFlagsByProperty({ updateSequenceId, authorization, }: {
+        /**
+         * This parameter usage is no longer supported.
+         *
+         * An optional `_updateSequenceId` to use to control deletion.
+         *
+         * Only stored data with an `updateSequenceId` less than or equal to that provided
+         * will be deleted.
+         * This can be used help ensure submit/delete requests are applied correctly if
+         * issued close together.
+         *
+         * If not provided, all stored data that matches the request will be deleted.
+         *
+         * @deprecated
+         */
+        updateSequenceId?: number;
+        /**
+         * All requests must be signed with a Connect JWT token that corresponds to the
+         * Provider app installed in Jira.
+         *
+         * If the JWT token corresponds to an app that does not define Feature Flags
+         * module it will be rejected with a 403.
+         *
+         * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+         * details.
+         */
+        authorization: string;
+    }): Promise<void>;
+    /**
+     * Retrieve the currently stored Feature Flag data for the given ID.
+     *
+     * The result will be what is currently stored, ignoring any pending updates or
+     * deletes.
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'READ' scope for Connect apps.
+     *
+     * @returns The Feature Flag data currently stored for the given ID.
+     * @path {GET} /rest/featureflags/0.1/flag/{featureFlagId}
+     */
+    getFeatureFlagById({ featureFlagId, authorization, }: {
+        /** The ID of the Feature Flag to fetch. */
+        featureFlagId: string;
+        /**
+         * All requests must be signed with a Connect JWT token that corresponds to the
+         * Provider app installed in Jira.
+         *
+         * If the JWT token corresponds to an app that does not define Feature Flags
+         * module it will be rejected with a 403.
+         *
+         * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+         * details.
+         */
+        authorization: string;
+    }): Promise<unknown>;
+    /**
+     * Update / insert Feature Flag data.
+     *
+     * Feature Flags are identified by their ID, and existing Feature Flag data for
+     * the same ID will be replaced if it exists and the updateSequenceId of existing
+     * data is less than the incoming data.
+     *
+     * Submissions are performed asynchronously. Submitted data will eventually be
+     * available in Jira; most updates are available within a short period of time,
+     * but may take some time during peak load and/or maintenance times. The
+     * getFeatureFlagById operation can be used to confirm that data has been stored
+     * successfully (if needed).
+     *
+     * In the case of multiple Feature Flags being submitted in one request, each is
+     * validated individually prior to submission. Details of which Feature Flags
+     * failed submission (if any) are available in the response object.
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'WRITE' scope for Connect apps.
+     *
+     * @returns Submission accepted. Each submitted Feature Flag that is of a valid format will
+     * be eventually available in Jira.
+     *
+     * Details of which Feature Flags were submitted and which failed submission (due
+     * to data format problems etc.) are available in the response object.
+     * @path {POST} /rest/featureflags/0.1/bulk
+     */
+    submitFeatureFlags({ authorization, requestBody, }: {
+        /**
+         * All requests must be signed with a Connect JWT token that corresponds to the
+         * Provider app installed in Jira.
+         *
+         * If the JWT token corresponds to an app that does not define Feature Flags
+         * module it will be rejected with a 403.
+         *
+         * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
+         * details.
+         */
+        authorization: string;
+        /** Feature Flag data to submit. */
+        requestBody: unknown;
+    }): Promise<unknown>;
+    static initialize(): void;
+}

package/lib/openapi/software/services/feature-flags-service.js

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureFlagsService = 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 validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * Apis related to integrating Feature Flags with Jira Software. These apis are
+ * only available to Atlassian Connect apps. To use these apis you must have the
+ * Feature Flag module (see
+ * https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/) in
+ * your app's descriptor
+ */
+class FeatureFlagsService extends common_http_service_1.CommonHttpService {
+    /**
+     * Delete the Feature Flag data currently stored for the given ID.
+     *
+     * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+     * used to confirm that data has been deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/featureflags/0.1/flag/{featureFlagId}
+     */
+    deleteFeatureFlagById({ featureFlagId, updateSequenceId, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/featureflags/0.1/flag/{featureFlagId}",
+            method: "DELETE",
+            pathParams: {
+                featureFlagId,
+            },
+            query: {
+                _updateSequenceId: updateSequenceId,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Bulk delete all Feature Flags that match the given request.
+     *
+     * One or more query params must be supplied to specify Properties to delete by.
+     * Optional param `_updateSequenceId` is no longer supported.
+     * If more than one Property is provided, data will be deleted that matches ALL of
+     * the Properties (e.g. treated as an AND).
+     * See the documentation for the submitFeatureFlags operation for more details.
+     *
+     * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+     *
+     * Deletion is performed asynchronously. The getFeatureFlagById operation can be
+     * used to confirm that data has been deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/featureflags/0.1/bulkByProperties
+     */
+    deleteFeatureFlagsByProperty({ updateSequenceId, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/featureflags/0.1/bulkByProperties",
+            method: "DELETE",
+            query: {
+                _updateSequenceId: updateSequenceId,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Retrieve the currently stored Feature Flag data for the given ID.
+     *
+     * The result will be what is currently stored, ignoring any pending updates or
+     * deletes.
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'READ' scope for Connect apps.
+     *
+     * @returns The Feature Flag data currently stored for the given ID.
+     * @path {GET} /rest/featureflags/0.1/flag/{featureFlagId}
+     */
+    getFeatureFlagById({ featureFlagId, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/featureflags/0.1/flag/{featureFlagId}",
+            method: "GET",
+            pathParams: {
+                featureFlagId,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("FeatureFlagsService.getFeatureFlagById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Update / insert Feature Flag data.
+     *
+     * Feature Flags are identified by their ID, and existing Feature Flag data for
+     * the same ID will be replaced if it exists and the updateSequenceId of existing
+     * data is less than the incoming data.
+     *
+     * Submissions are performed asynchronously. Submitted data will eventually be
+     * available in Jira; most updates are available within a short period of time,
+     * but may take some time during peak load and/or maintenance times. The
+     * getFeatureFlagById operation can be used to confirm that data has been stored
+     * successfully (if needed).
+     *
+     * In the case of multiple Feature Flags being submitted in one request, each is
+     * validated individually prior to submission. Details of which Feature Flags
+     * failed submission (if any) are available in the response object.
+     *
+     * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can
+     * access this resource.
+     * This resource requires the 'WRITE' scope for Connect apps.
+     *
+     * @returns Submission accepted. Each submitted Feature Flag that is of a valid format will
+     * be eventually available in Jira.
+     *
+     * Details of which Feature Flags were submitted and which failed submission (due
+     * to data format problems etc.) are available in the response object.
+     * @path {POST} /rest/featureflags/0.1/bulk
+     */
+    submitFeatureFlags({ authorization, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/featureflags/0.1/bulk",
+            method: "POST",
+            headers: {
+                Authorization: authorization,
+                "Content-Type": "application/json",
+            },
+            body: requestBody,
+        })
+            .then(this.getClientInstance().responseHandler({
+            202: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("FeatureFlagsService.submitFeatureFlags.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("FeatureFlagsService.submitFeatureFlags.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(202),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("FeatureFlagsService.submitFeatureFlags.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("FeatureFlagsService.getFeatureFlagById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("FeatureFlagsService.getFeatureFlagById.response"));
+    }
+}
+exports.FeatureFlagsService = FeatureFlagsService;
+//# sourceMappingURL=feature-flags-service.js.map

package/lib/openapi/software/services/feature-flags-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature-flags-service.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/feature-flags-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,4EAAuE;AACvE;;;;;;GAMG;AACH,MAAa,mBAAoB,SAAQ,uCAAiB;IACxD;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EACpB,aAAa,EACb,gBAAgB,EAChB,aAAa,GA4Bd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,aAAa;aACd;YACD,KAAK,EAAE;gBACL,iBAAiB,EAAE,gBAAgB;aACpC;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,4BAA4B,CAAC,EAC3B,gBAAgB,EAChB,aAAa,GA4Bd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yCAAyC;YAC/C,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE;gBACL,iBAAiB,EAAE,gBAAgB;aACpC;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EACjB,aAAa,EACb,aAAa,GAed;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6CAA6C;YACnD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,aAAa;aACd;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;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,iDAAiD,CAClD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,kBAAkB,CAAC,EACjB,aAAa,EACb,WAAW,GAeZ;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;gBAC5B,cAAc,EAAE,kBAAkB;aACnC;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,iDAAiD,CAClD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,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,iDAAiD,CAAC,CAC/D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,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,iDAAiD,CAAC,CAC/D,CAAC;IACJ,CAAC;CACF;AA/RD,kDA+RC"}

package/lib/openapi/software/services/issue-service.d.ts

@@ -0,0 +1,329 @@
+import { CommonHttpService } from "../core/common-http-service";
+/** Apis related to issues */
+export declare class IssueService extends CommonHttpService {
+    /**
+     * Updates the estimation of the issue. boardId param is required. This param
+     * determines which field will be updated on a issue.
+     *
+     * Note that this resource changes the estimation field of the issue regardless of
+     * appearance the field on the screen.
+     *
+     * Original time tracking estimation field accepts estimation in formats like
+     * "1w", "2d", "3h", "20m" or number which represent number of minutes. However,
+     * internally the field stores and returns the estimation as a number of seconds.
+     *
+     * The field used for estimation on the given board can be obtained from [board
+     * configuration resource](#agile/1.0/board-getConfiguration). More information
+     * about the field are returned by [edit meta
+     * resource](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) or [field
+     * resource](#api-rest-api-3-field-get).
+     *
+     * @returns Returns the estimation of the issue and a fieldId of the field that is used for
+     * it.
+     *
+     * example: {
+     *   "fieldId": "customfield_12532",
+     *   "value": "8.0"
+     * }
+     * @path {PUT} /rest/agile/1.0/issue/{issueIdOrKey}/estimation
+     */
+    estimateIssueForBoard({ issueIdOrKey, boardId, requestBody, }: {
+        /** The ID or key of the requested issue. */
+        issueIdOrKey: string;
+        /** The ID of the board required to determine which field is used for estimation. */
+        boardId?: number;
+        /**
+         * bean that contains value of a new estimation.
+         *
+         * @example {
+         *     "value": "8.0"
+         * }
+         */
+        requestBody: {
+            value?: string;
+        };
+    }): Promise<unknown>;
+    /**
+     * Returns a single issue, for a given issue ID or issue key. Issues returned from
+     * this resource include Agile fields, like sprint, closedSprints, flagged, and
+     * epic.
+     *
+     * @returns Returns the requested issue.
+     *
+     * example: {
+     *   "expand": "",
+     *   "fields": {
+     *     "flagged": true,
+     *     "sprint": {
+     *       "id": 37,
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
+     *       "state": "future",
+     *       "name": "sprint 2",
+     *       "goal": "sprint 2 goal"
+     *     },
+     *     "closedSprints": [
+     *       {
+     *         "id": 37,
+     *         "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+     *         "state": "closed",
+     *         "name": "sprint 1",
+     *         "startDate": "2015-04-11T15:22:00.000+10:00",
+     *         "endDate": "2015-04-20T01:22:00.000+10:00",
+     *         "completeDate": "2015-04-20T11:04:00.000+10:00",
+     *         "goal": "sprint 1 goal"
+     *       }
+     *     ],
+     *     "description": "example bug report",
+     *     "project": {
+     *       "avatarUrls": {
+     *         "16x16":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *         "24x24":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *         "32x32":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *         "48x48":
+     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *       },
+     *       "id": "10000",
+     *       "insight": {
+     *         "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
+     *         "totalIssueCount": 100
+     *       },
+     *       "key": "EX",
+     *       "name": "Example",
+     *       "projectCategory": {
+     *         "description": "First Project Category",
+     *         "id": "10000",
+     *         "name": "FIRST",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *       },
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
+     *       "simplified": false,
+     *       "style": "classic"
+     *     },
+     *     "comment": [
+     *       {
+     *         "author": {
+     *           "accountId": "5b10a2844c20165700ede21g",
+     *           "active": false,
+     *           "displayName": "Mia Krystof",
+     *           "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         },
+     *         "body": {
+     *           "type": "doc",
+     *           "version": 1,
+     *           "content": [
+     *             {
+     *               "type": "paragraph",
+     *               "content": [
+     *                 {
+     *                   "type": "text",
+     *                   "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
+     * elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
+     * fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
+     *                 }
+     *               ]
+     *             }
+     *           ]
+     *         },
+     *         "created": "2021-01-17T12:34:00.000+0000",
+     *         "id": "10000",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+     *         "updateAuthor": {
+     *           "accountId": "5b10a2844c20165700ede21g",
+     *           "active": false,
+     *           "displayName": "Mia Krystof",
+     *           "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         },
+     *         "updated": "2021-01-18T23:45:00.000+0000",
+     *         "visibility": {
+     *           "identifier": "Administrators",
+     *           "type": "role",
+     *           "value": "Administrators"
+     *         }
+     *       }
+     *     ],
+     *     "epic": {
+     *       "id": 37,
+     *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
+     *       "name": "epic 1",
+     *       "summary": "epic 1 summary",
+     *       "color": {
+     *         "key": "color_4"
+     *       },
+     *       "done": true
+     *     },
+     *     "worklog": [
+     *       {
+     *         "author": {
+     *           "accountId": "5b10a2844c20165700ede21g",
+     *           "active": false,
+     *           "displayName": "Mia Krystof",
+     *           "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         },
+     *         "comment": {
+     *           "type": "doc",
+     *           "version": 1,
+     *           "content": [
+     *             {
+     *               "type": "paragraph",
+     *               "content": [
+     *                 {
+     *                   "type": "text",
+     *                   "text": "I did some work here."
+     *                 }
+     *               ]
+     *             }
+     *           ]
+     *         },
+     *         "id": "100028",
+     *         "issueId": "10002",
+     *         "self":
+     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *         "started": "2021-01-17T12:34:00.000+0000",
+     *         "timeSpent": "3h 20m",
+     *         "timeSpentSeconds": 12000,
+     *         "updateAuthor": {
+     *           "accountId": "5b10a2844c20165700ede21g",
+     *           "active": false,
+     *           "displayName": "Mia Krystof",
+     *           "self":
+     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         },
+     *         "updated": "2021-01-18T23:45:00.000+0000",
+     *         "visibility": {
+     *           "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+     *           "type": "group",
+     *           "value": "jira-developers"
+     *         }
+     *       }
+     *     ],
+     *     "updated": 1,
+     *     "timetracking": {
+     *       "originalEstimate": "10m",
+     *       "originalEstimateSeconds": 600,
+     *       "remainingEstimate": "3m",
+     *       "remainingEstimateSeconds": 200,
+     *       "timeSpent": "6m",
+     *       "timeSpentSeconds": 400
+     *     }
+     *   },
+     *   "id": "10001",
+     *   "key": "HSP-1",
+     *   "self":
+     * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+     * }
+     * @path {GET} /rest/agile/1.0/issue/{issueIdOrKey}
+     */
+    getIssue({ issueIdOrKey, fields, expand, updateHistory, }: {
+        /** The ID or key of the requested issue. */
+        issueIdOrKey: string;
+        /**
+         * The list of fields to return for each issue. By default, all navigable and
+         * Agile fields are returned.
+         */
+        fields?: {}[];
+        /** A comma-separated list of the parameters to expand. */
+        expand?: string;
+        /**
+         * A boolean indicating whether the issue retrieved by this method should be added
+         * to the current user's issue history
+         */
+        updateHistory?: boolean;
+    }): Promise<unknown>;
+    /**
+     * Returns the estimation of the issue and a fieldId of the field that is used for
+     * it. `boardId` param is required. This param determines which field will be
+     * updated on a issue.
+     *
+     * Original time internally stores and returns the estimation as a number of
+     * seconds.
+     *
+     * The field used for estimation on the given board can be obtained from [board
+     * configuration resource](#agile/1.0/board-getConfiguration). More information
+     * about the field are returned by [edit meta
+     * resource](#api-rest-api-3-issue-getEditIssueMeta) or [field
+     * resource](#api-rest-api-3-field-get).
+     *
+     * @returns Returns the estimation of the issue and a fieldId of the field that is used for
+     * it.
+     *
+     * example: {
+     *   "fieldId": "customfield_12532",
+     *   "value": "8.0"
+     * }
+     * @path {GET} /rest/agile/1.0/issue/{issueIdOrKey}/estimation
+     */
+    getIssueEstimationForBoard({ issueIdOrKey, boardId, }: {
+        /** The ID or key of the requested issue. */
+        issueIdOrKey: string;
+        /** The ID of the board required to determine which field is used for estimation. */
+        boardId?: number;
+    }): Promise<unknown>;
+    /**
+     * Moves (ranks) issues before or after a given issue. At most 50 issues may be
+     * ranked at once.
+     *
+     * This operation may fail for some issues, although this will be rare. In that
+     * case the 207 status code is returned for the whole response and detailed
+     * information regarding each issue is available in the response body.
+     *
+     * If rankCustomFieldId is not defined, the default rank field will be used.
+     *
+     * @returns Returns the list of issue with status of rank operation.
+     *
+     * example: {
+     *   "entries": [
+     *     {
+     *       "issueId": 10000,
+     *       "issueKey": "PR-1",
+     *       "status": 200
+     *     },
+     *     {
+     *       "issueId": 10001,
+     *       "issueKey": "PR-2",
+     *       "status": 200
+     *     },
+     *     {
+     *       "errors": [
+     *         "JIRA Agile cannot execute the rank operation at this time. Please try
+     * again later."
+     *       ],
+     *       "issueId": 10002,
+     *       "issueKey": "PR-3",
+     *       "status": 503
+     *     }
+     *   ]
+     * }
+     * @path {PUT} /rest/agile/1.0/issue/rank
+     */
+    rankIssues({ requestBody, }: {
+        /**
+         * bean which contains list of issues to rank and information where it should be
+         * ranked.
+         *
+         * @example {
+         *     "issues": [
+         *         "PR-1",
+         *         "10001",
+         *         "PR-3"
+         *     ],
+         *     "rankBeforeIssue": "PR-4",
+         *     "rankCustomFieldId": 10521
+         * }
+         */
+        requestBody: {
+            issues?: string[];
+            rankAfterIssue?: string;
+            rankBeforeIssue?: string;
+            rankCustomFieldId?: number;
+        };
+    }): Promise<unknown>;
+    static initialize(): void;
+}