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

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

export interface GetNotificationSchemes {
  /** 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 list of notification schemes IDs to be filtered by */
  id?: string[];
  /** The list of projects IDs to be filtered by */
  projectId?: string[];
  /**
   * When set to true, returns only the default notification scheme. If you provide project IDs not associated with the
   * default, returns an empty page. The default value is false.
   */
  onlyDefault?: boolean;
  /**
   * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional
   * information in the response. This parameter accepts a comma-separated list. Expand options include:
   *
   * - `all` Returns all expandable information
   * - `field` Returns information about any custom fields assigned to receive an event
   * - `group` Returns information about any groups assigned to receive an event
   * - `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable
   *   information
   * - `projectRole` Returns information about any project roles assigned to receive an event
   * - `user` Returns information about any users assigned to receive an event
   */
  expand?:
    | 'all'
    | 'field'
    | 'group'
    | 'notificationSchemeEvents'
    | 'projectRole'
    | 'user'
    | ('all' | 'field' | 'group' | 'notificationSchemeEvents' | 'projectRole' | 'user')[]
    | string
    | string[];
}