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

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

export interface GetNotificationScheme {
  /**
   * The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-2-notificationscheme-get)
   * to get a list of notification scheme IDs.
   */
  id: number;
  /**
   * 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[];
}