import type { Document } from './document';
import type { EntityProperty } from './entityProperty';
import type { UserDetails } from './userDetails';
import type { Visibility } from './visibility';

/** Details of a worklog. */
export interface Worklog {
  /** The URL of the worklog item. */
  self?: string;
  author?: UserDetails;
  updateAuthor?: UserDetails;
  /**
   * A comment about the worklog in [Atlassian Document
   * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or
   * updating a worklog.
   */
  comment?: Document;
  /** The datetime on which the worklog was created. */
  created?: string;
  /** The datetime on which the worklog was last updated. */
  updated?: string;
  visibility?: Visibility;
  /**
   * The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a
   * worklog.
   */
  started?: string;
  /**
   * The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a
   * worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if
   * `timeSpentSecond` is provided.
   */
  timeSpent?: string;
  /**
   * The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided.
   * Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.
   */
  timeSpentSeconds?: number;
  /** The ID of the worklog record. */
  id?: string;
  /** The ID of the issue this worklog is for. */
  issueId?: string;
  /** Details of properties for the worklog. Optional when creating or updating a worklog. */
  properties?: EntityProperty[];
}