@resolution/jira-api-client 0.4.2 → 0.4.5

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

@@ -34,11 +34,11 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * read:user:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-post
      */
-    addWorklog({ issueIdOrKey, notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag, worklog, }: {
+    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;
+        notifyUsers?: boolean | undefined;
         /**
          * Defines how to update the issue's time estimate, the options are:
          *
@@ -47,32 +47,32 @@ export declare class IssueWorklogsService extends CommonHttpService {
          *  *  `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";
+        adjustEstimate?: "auto" | "new" | "manual" | "leave" | undefined;
         /**
          * 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;
+        newEstimate?: string | undefined;
         /**
          * 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;
+        reduceBy?: string | undefined;
         /**
          * Use [expand](#expansion) to include additional information about work logs in
          * the response. This parameter accepts `properties`, which returns worklog
          * properties.
          */
-        expand?: string;
+        expand?: string | undefined;
         /**
          * 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;
+        overrideEditableFlag?: boolean | undefined;
         /**
          * @example {
          *     "comment": {
@@ -99,7 +99,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
          * }
          */
         worklog: Worklog;
-    }): Promise<Worklog>;
+    }) => Promise<Worklog>;
     /**
      * Deletes a worklog from an issue.
      *
@@ -128,13 +128,13 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * write:issue.time-tracking:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-delete
      */
-    deleteWorklog({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag, }: {
+    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;
+        notifyUsers?: boolean | undefined;
         /**
          * Defines how to update the issue's time estimate, the options are:
          *
@@ -143,27 +143,27 @@ export declare class IssueWorklogsService extends CommonHttpService {
          *  *  `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";
+        adjustEstimate?: "auto" | "new" | "manual" | "leave" | undefined;
         /**
          * 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;
+        newEstimate?: string | undefined;
         /**
          * 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;
+        increaseBy?: string | undefined;
         /**
          * 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>;
+        overrideEditableFlag?: boolean | undefined;
+    }) => Promise<void>;
     /**
      * Returns a list of IDs and delete timestamps for worklogs deleted after a date
      * and time.
@@ -212,13 +212,13 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-deleted-get
      */
-    getIdsOfWorklogsDeletedSince({ since, }?: {
+    getIdsOfWorklogsDeletedSince: ({ since, }?: {
         /**
          * The date and time, as a UNIX timestamp in milliseconds, after which deleted
          * worklogs are returned.
          */
-        since?: number;
-    }): Promise<ChangedWorklogs>;
+        since?: number | undefined;
+    }) => Promise<ChangedWorklogs>;
     /**
      * Returns a list of IDs and update timestamps for worklogs updated after a date
      * and time.
@@ -272,22 +272,22 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-updated-get
      */
-    getIdsOfWorklogsModifiedSince({ since, expand, }?: {
+    getIdsOfWorklogsModifiedSince: ({ since, expand, }?: {
         /**
          * The date and time, as a UNIX timestamp in milliseconds, after which updated
          * worklogs are returned.
          */
-        since?: number;
+        since?: number | undefined;
         /**
          * 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>;
+        expand?: string | undefined;
+    }) => Promise<ChangedWorklogs>;
     /**
-     * Returns worklogs for an issue, starting from the oldest worklog or from the
-     * worklog started on or after a date and time.
+     * Returns worklogs for an issue (ordered by created time), 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
@@ -365,30 +365,30 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * read:project-role:jira, read:user:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-get
      */
-    getIssueWorklog({ issueIdOrKey, startAt, maxResults, startedAfter, startedBefore, expand, }: {
+    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;
+        startAt?: number | undefined;
         /** The maximum number of items to return per page. */
-        maxResults?: number;
+        maxResults?: number | undefined;
         /**
          * The worklog start date and time, as a UNIX timestamp in milliseconds, after
          * which worklogs are returned.
          */
-        startedAfter?: number;
+        startedAfter?: number | undefined;
         /**
          * The worklog start date and time, as a UNIX timestamp in milliseconds, before
          * which worklogs are returned.
          */
-        startedBefore?: number;
+        startedBefore?: number | undefined;
         /**
          * Use [expand](#expansion) to include additional information about worklogs in
          * the response. This parameter accepts`properties`, which returns worklog
          * properties.
          */
-        expand?: string;
-    }): Promise<PageOfWorklogs>;
+        expand?: string | undefined;
+    }) => Promise<PageOfWorklogs>;
     /**
      * Returns a worklog.
      *
@@ -461,7 +461,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-get
      */
-    getWorklog({ issueIdOrKey, id, expand, }: {
+    getWorklog: ({ issueIdOrKey, id, expand, }: {
         /** The ID or key of the issue. */
         issueIdOrKey: string;
         /** The ID of the worklog. */
@@ -472,8 +472,8 @@ export declare class IssueWorklogsService extends CommonHttpService {
          *
          * `properties`, which returns worklog properties.
          */
-        expand?: string;
-    }): Promise<Worklog>;
+        expand?: string | undefined;
+    }) => Promise<Worklog>;
     /**
      * Returns worklog details for a list of worklog IDs.
      *
@@ -541,13 +541,13 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-list-post
      */
-    getWorklogsForIds({ expand, worklogIdsRequestBean, }: {
+    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;
+        expand?: string | undefined;
         /**
          * A JSON object containing a list of worklog IDs.
          *
@@ -561,7 +561,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
          * }
          */
         worklogIdsRequestBean: WorklogIdsRequestBean;
-    }): Promise<Worklog[]>;
+    }) => Promise<Worklog[]>;
     /**
      * Updates a worklog.
      *
@@ -638,13 +638,13 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * write:issue-worklog.property:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-put
      */
-    updateWorklog({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlag, worklog, }: {
+    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;
+        notifyUsers?: boolean | undefined;
         /**
          * Defines how to update the issue's time estimate, the options are:
          *
@@ -653,26 +653,26 @@ export declare class IssueWorklogsService extends CommonHttpService {
          *  *  `auto` Updates the estimate by the difference between the original and
          * updated value of `timeSpent` or `timeSpentSeconds`.
          */
-        adjustEstimate?: "new" | "leave" | "manual" | "auto";
+        adjustEstimate?: "auto" | "new" | "manual" | "leave" | undefined;
         /**
          * 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;
+        newEstimate?: string | undefined;
         /**
          * Use [expand](#expansion) to include additional information about worklogs in
          * the response. This parameter accepts `properties`, which returns worklog
          * properties.
          */
-        expand?: string;
+        expand?: string | undefined;
         /**
          * 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;
+        overrideEditableFlag?: boolean | undefined;
         /**
          * @example {
          *     "comment": {
@@ -699,6 +699,6 @@ export declare class IssueWorklogsService extends CommonHttpService {
          * }
          */
         worklog: Worklog;
-    }): Promise<Worklog>;
+    }) => Promise<Worklog>;
     static initialize(): void;
 }