@resolution/jira-api-client 0.1.6 → 0.3.0

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

@@ -0,0 +1,694 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import { type ChangedWorklogs, type PageOfWorklogs, type Worklog, type WorklogIdsRequestBean } from "../models/issueWorklogs";
+/**
+ * This resource represents issue worklogs. Use it to:
+ *
+ *  *  get, create, update, and delete worklogs.
+ *  *  obtain lists of updated or deleted worklogs.
+ */
+export declare class IssueWorklogsService extends CommonHttpService {
+    /**
+     * Adds a worklog to an issue.
+     *
+     * Time tracking must be enabled in Jira, otherwise this operation returns an
+     * error. For more information, see [Configuring time
+     * tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Browse projects* and *Work on issues* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+     * issue is in.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *
+     * @returns Returned if the request is successful.
+     * @path {POST} /rest/api/3/issue/{issueIdOrKey}/worklog
+     * @scopes-current write:jira-work
+     * @scopes-beta write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira,
+     * read:group:jira, read:issue-worklog:jira, read:project-role:jira,
+     * read:user:jira, read:issue-worklog.property:jira
+     */
+    addWorklog({ issueIdOrKey, notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag, worklog, }: {
+        /** The ID or key the issue. */
+        issueIdOrKey: string;
+        /** Whether users watching the issue are notified by email. */
+        notifyUsers?: boolean;
+        /**
+         * Defines how to update the issue's time estimate, the options are:
+         *
+         *  *  `new` Sets the estimate to a specific value, defined in `newEstimate`.
+         *  *  `leave` Leaves the estimate unchanged.
+         *  *  `manual` Reduces the estimate by amount specified in `reduceBy`.
+         *  *  `auto` Reduces the estimate by the value of `timeSpent` in the worklog.
+         */
+        adjustEstimate?: "new" | "leave" | "manual" | "auto";
+        /**
+         * The value to set as the issue's remaining time estimate, as days (\#d), hours
+         * (\#h), or minutes (\#m or \#). For example, *2d*. Required when
+         * `adjustEstimate` is `new`.
+         */
+        newEstimate?: string;
+        /**
+         * The amount to reduce the issue's remaining estimate by, as days (\#d), hours
+         * (\#h), or minutes (\#m). For example, *2d*. Required when `adjustEstimate` is
+         * `manual`.
+         */
+        reduceBy?: string;
+        /**
+         * Use [expand](#expansion) to include additional information about work logs in
+         * the response. This parameter accepts `properties`, which returns worklog
+         * properties.
+         */
+        expand?: string;
+        /**
+         * Whether the worklog entry should be added to the issue even if the issue is not
+         * editable, because jira.issue.editable set to false or missing. For example, the
+         * issue is closed. Connect and Forge app users with *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.
+         */
+        overrideEditableFlag?: boolean;
+        /**
+         * @example {
+         *     "comment": {
+         *         "content": [
+         *             {
+         *                 "content": [
+         *                     {
+         *                         "text": "I did some work here.",
+         *                         "type": "text"
+         *                     }
+         *                 ],
+         *                 "type": "paragraph"
+         *             }
+         *         ],
+         *         "type": "doc",
+         *         "version": 1
+         *     },
+         *     "started": "2021-01-17T12:34:00.000+0000",
+         *     "timeSpentSeconds": 12000,
+         *     "visibility": {
+         *         "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+         *         "type": "group"
+         *     }
+         * }
+         */
+        worklog: Worklog;
+    }): Promise<Worklog>;
+    /**
+     * Deletes a worklog from an issue.
+     *
+     * Time tracking must be enabled in Jira, otherwise this operation returns an
+     * error. For more information, see [Configuring time
+     * tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+     * issue is in.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *  *  *Delete all worklogs*[ project
+     * permission](https://confluence.atlassian.com/x/yodKLg) to delete any worklog or
+     * *Delete own worklogs* to delete worklogs created by the user,
+     *  *  If the worklog has visibility restrictions, belongs to the group or has the
+     * role visibility is restricted to.
+     *
+     * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * @scopes-current write:jira-work
+     * @scopes-beta delete:issue-worklog:jira, delete:issue-worklog.property:jira,
+     * write:issue.time-tracking:jira
+     */
+    deleteWorklog({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag, }: {
+        /** The ID or key of the issue. */
+        issueIdOrKey: string;
+        /** The ID of the worklog. */
+        id: string;
+        /** Whether users watching the issue are notified by email. */
+        notifyUsers?: boolean;
+        /**
+         * Defines how to update the issue's time estimate, the options are:
+         *
+         *  *  `new` Sets the estimate to a specific value, defined in `newEstimate`.
+         *  *  `leave` Leaves the estimate unchanged.
+         *  *  `manual` Increases the estimate by amount specified in `increaseBy`.
+         *  *  `auto` Reduces the estimate by the value of `timeSpent` in the worklog.
+         */
+        adjustEstimate?: "new" | "leave" | "manual" | "auto";
+        /**
+         * The value to set as the issue's remaining time estimate, as days (\#d), hours
+         * (\#h), or minutes (\#m or \#). For example, *2d*. Required when
+         * `adjustEstimate` is `new`.
+         */
+        newEstimate?: string;
+        /**
+         * The amount to increase the issue's remaining estimate by, as days (\#d), hours
+         * (\#h), or minutes (\#m or \#). For example, *2d*. Required when
+         * `adjustEstimate` is `manual`.
+         */
+        increaseBy?: string;
+        /**
+         * Whether the work log entry should be added to the issue even if the issue is
+         * not editable, because jira.issue.editable set to false or missing. For example,
+         * the issue is closed. Connect and Forge app users with admin permission can use
+         * this flag.
+         */
+        overrideEditableFlag?: boolean;
+    }): Promise<void>;
+    /**
+     * Returns a list of IDs and delete timestamps for worklogs deleted after a date
+     * and time.
+     *
+     * This resource is paginated, with a limit of 1000 worklogs per page. Each page
+     * lists worklogs from oldest to youngest. If the number of items in the date
+     * range exceeds 1000, `until` indicates the timestamp of the youngest item on the
+     * page. Also, `nextPage` provides the URL for the next page of worklogs. The
+     * `lastPage` parameter is set to true on the last page of worklogs.
+     *
+     * This resource does not return worklogs deleted during the minute preceding the
+     * request.
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "lastPage": true,
+     *   "nextPage":
+     * "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013693136",
+     *   "self":
+     * "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013671562",
+     *   "since": 1438013671562,
+     *   "until": 1438013693136,
+     *   "values": [
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013671562,
+     *       "worklogId": 103
+     *     },
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013672165,
+     *       "worklogId": 104
+     *     },
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013693136,
+     *       "worklogId": 105
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/worklog/deleted
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
+     */
+    getIdsOfWorklogsDeletedSince({ since, }: {
+        /**
+         * The date and time, as a UNIX timestamp in milliseconds, after which deleted
+         * worklogs are returned.
+         */
+        since?: number;
+    }): Promise<ChangedWorklogs>;
+    /**
+     * Returns a list of IDs and update timestamps for worklogs updated after a date
+     * and time.
+     *
+     * This resource is paginated, with a limit of 1000 worklogs per page. Each page
+     * lists worklogs from oldest to youngest. If the number of items in the date
+     * range exceeds 1000, `until` indicates the timestamp of the youngest item on the
+     * page. Also, `nextPage` provides the URL for the next page of worklogs. The
+     * `lastPage` parameter is set to true on the last page of worklogs.
+     *
+     * This resource does not return worklogs updated during the minute preceding the
+     * request.
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira, however,
+     * worklogs are only returned where either of the following is true:
+     *
+     *  *  the worklog is set as *Viewable by All Users*.
+     *  *  the user is a member of a project role or group with permission to view the
+     * worklog.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "lastPage": true,
+     *   "nextPage":
+     * "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013693136",
+     *   "self":
+     * "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013671562",
+     *   "since": 1438013671562,
+     *   "until": 1438013693136,
+     *   "values": [
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013671562,
+     *       "worklogId": 103
+     *     },
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013672165,
+     *       "worklogId": 104
+     *     },
+     *     {
+     *       "properties": [],
+     *       "updatedTime": 1438013693136,
+     *       "worklogId": 105
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/worklog/updated
+     * @scopes-current read:jira-work
+     * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
+     */
+    getIdsOfWorklogsModifiedSince({ since, expand, }: {
+        /**
+         * The date and time, as a UNIX timestamp in milliseconds, after which updated
+         * worklogs are returned.
+         */
+        since?: number;
+        /**
+         * Use [expand](#expansion) to include additional information about worklogs in
+         * the response. This parameter accepts `properties` that returns the properties
+         * of each worklog.
+         */
+        expand?: string;
+    }): Promise<ChangedWorklogs>;
+    /**
+     * Returns worklogs for an issue, starting from the oldest worklog or from the
+     * worklog started on or after a date and time.
+     *
+     * Time tracking must be enabled in Jira, otherwise this operation returns an
+     * error. For more information, see [Configuring time
+     * tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:** Workloads are only returned where the
+     * user has:
+     *
+     *  *  *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.
+     *  *  If the worklog has visibility restrictions, belongs to the group or has the
+     * role visibility is restricted to.
+     *
+     * @returns Returned if the request is successful
+     *
+     * example: {
+     *   "maxResults": 1,
+     *   "startAt": 0,
+     *   "total": 1,
+     *   "worklogs": [
+     *     {
+     *       "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"
+     *       }
+     *     }
+     *   ]
+     * }
+     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/worklog
+     * @scopes-current read:jira-work
+     * @scopes-beta read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira,
+     * read:project-role:jira, read:user:jira, read:avatar:jira
+     */
+    getIssueWorklog({ issueIdOrKey, startAt, maxResults, startedAfter, startedBefore, expand, }: {
+        /** The ID or key of the issue. */
+        issueIdOrKey: string;
+        /** The index of the first item to return in a page of results (page offset). */
+        startAt?: number;
+        /** The maximum number of items to return per page. */
+        maxResults?: number;
+        /**
+         * The worklog start date and time, as a UNIX timestamp in milliseconds, after
+         * which worklogs are returned.
+         */
+        startedAfter?: number;
+        /**
+         * The worklog start date and time, as a UNIX timestamp in milliseconds, before
+         * which worklogs are returned.
+         */
+        startedBefore?: number;
+        /**
+         * Use [expand](#expansion) to include additional information about worklogs in
+         * the response. This parameter accepts`properties`, which returns worklog
+         * properties.
+         */
+        expand?: string;
+    }): Promise<PageOfWorklogs>;
+    /**
+     * Returns a worklog.
+     *
+     * Time tracking must be enabled in Jira, otherwise this operation returns an
+     * error. For more information, see [Configuring time
+     * tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+     * issue is in.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *  *  If the worklog has visibility restrictions, belongs to the group or has the
+     * role visibility is restricted to.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: {
+     *   "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"
+     *   }
+     * }
+     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * @scopes-current read:jira-work
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
+     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
+     * read:avatar:jira
+     */
+    getWorklog({ issueIdOrKey, id, expand, }: {
+        /** The ID or key of the issue. */
+        issueIdOrKey: string;
+        /** The ID of the worklog. */
+        id: string;
+        /**
+         * Use [expand](#expansion) to include additional information about work logs in
+         * the response. This parameter accepts
+         *
+         * `properties`, which returns worklog properties.
+         */
+        expand?: string;
+    }): Promise<Worklog>;
+    /**
+     * Returns worklog details for a list of worklog IDs.
+     *
+     * The returned list of worklogs is limited to 1000 items.
+     *
+     * **[Permissions](#permissions) required:** Permission to access Jira, however,
+     * worklogs are only returned where either of the following is true:
+     *
+     *  *  the worklog is set as *Viewable by All Users*.
+     *  *  the user is a member of a project role or group with permission to view the
+     * worklog.
+     *
+     * @returns Returned if the request is successful.
+     *
+     * example: [
+     *   {
+     *     "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"
+     *     }
+     *   }
+     * ]
+     * @path {POST} /rest/api/3/worklog/list
+     * @scopes-current read:jira-work
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
+     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
+     * read:avatar:jira
+     */
+    getWorklogsForIds({ expand, worklogIdsRequestBean, }: {
+        /**
+         * Use [expand](#expansion) to include additional information about worklogs in
+         * the response. This parameter accepts `properties` that returns the properties
+         * of each worklog.
+         */
+        expand?: string;
+        /**
+         * A JSON object containing a list of worklog IDs.
+         *
+         * @example {
+         *     "ids": [
+         *         1,
+         *         2,
+         *         5,
+         *         10
+         *     ]
+         * }
+         */
+        worklogIdsRequestBean: WorklogIdsRequestBean;
+    }): Promise<Worklog[]>;
+    /**
+     * Updates a worklog.
+     *
+     * Time tracking must be enabled in Jira, otherwise this operation returns an
+     * error. For more information, see [Configuring time
+     * tracking](https://confluence.atlassian.com/x/qoXKM).
+     *
+     * This operation can be accessed anonymously.
+     *
+     * **[Permissions](#permissions) required:**
+     *
+     *  *  *Browse projects* [project
+     * permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
+     * issue is in.
+     *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
+     * configured, issue-level security permission to view the issue.
+     *  *  *Edit all worklogs*[ project
+     * permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or
+     * *Edit own worklogs* to update worklogs created by the user.
+     *  *  If the worklog has visibility restrictions, belongs to the group or has the
+     * role visibility is restricted to.
+     *
+     * @returns Returned if the request is successful
+     *
+     * example: {
+     *   "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"
+     *   }
+     * }
+     * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * @scopes-current write:jira-work
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
+     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
+     * write:comment:jira, write:issue-worklog:jira,
+     * write:issue-worklog.property:jira, read:avatar:jira
+     */
+    updateWorklog({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlag, worklog, }: {
+        /** The ID or key the issue. */
+        issueIdOrKey: string;
+        /** The ID of the worklog. */
+        id: string;
+        /** Whether users watching the issue are notified by email. */
+        notifyUsers?: boolean;
+        /**
+         * Defines how to update the issue's time estimate, the options are:
+         *
+         *  *  `new` Sets the estimate to a specific value, defined in `newEstimate`.
+         *  *  `leave` Leaves the estimate unchanged.
+         *  *  `auto` Updates the estimate by the difference between the original and
+         * updated value of `timeSpent` or `timeSpentSeconds`.
+         */
+        adjustEstimate?: "new" | "leave" | "manual" | "auto";
+        /**
+         * The value to set as the issue's remaining time estimate, as days (\#d), hours
+         * (\#h), or minutes (\#m or \#). For example, *2d*. Required when
+         * `adjustEstimate` is `new`.
+         */
+        newEstimate?: string;
+        /**
+         * Use [expand](#expansion) to include additional information about worklogs in
+         * the response. This parameter accepts `properties`, which returns worklog
+         * properties.
+         */
+        expand?: string;
+        /**
+         * Whether the worklog should be added to the issue even if the issue is not
+         * editable. For example, because the issue is closed. Connect and Forge app users
+         * with *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.
+         */
+        overrideEditableFlag?: boolean;
+        /**
+         * @example {
+         *     "comment": {
+         *         "content": [
+         *             {
+         *                 "content": [
+         *                     {
+         *                         "text": "I did some work here.",
+         *                         "type": "text"
+         *                     }
+         *                 ],
+         *                 "type": "paragraph"
+         *             }
+         *         ],
+         *         "type": "doc",
+         *         "version": 1
+         *     },
+         *     "started": "2021-01-17T12:34:00.000+0000",
+         *     "timeSpentSeconds": 12000,
+         *     "visibility": {
+         *         "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+         *         "type": "group"
+         *     }
+         * }
+         */
+        worklog: Worklog;
+    }): Promise<Worklog>;
+    static initialize(): void;
+}