@esm-js/jira.js/src/version2/parameters/addWorklog.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

import type { Worklog } from '../models';

export interface AddWorklog extends 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' | string;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#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;
}