Function: createServerClient()

function createServerClient(clientConfig): object;

Defined in: src/server/createServerClient.ts:611

Parameters

Parameter	Type
`clientConfig`	\| `Client` \| `ServerClientConfig`

Returns

object

applicationProperties

applicationProperties: object;

applicationProperties.getAdvancedSettings

getAdvancedSettings: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

applicationProperties.getApplicationProperties

getApplicationProperties: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `key?`: `string`; `keyFilter?`: `string`; `permissionLevel?`: `string`; }	-
`parameters.key?`	`string`	A String containing the property key.
`parameters.keyFilter?`	`string`	When fetching a list allows the list to be filtered by the property's start of key e.g. "jira.lf." whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This is a regex.
`parameters.permissionLevel?`	`string`	When fetching a list specifies the permission level of all items in the list see ApplicationPropertiesService.EditPermissionLevel
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

applicationProperties.setPropertyViaRestfulTable

setPropertyViaRestfulTable: (parameters, options?) => Promise<{
[key: string]: unknown;
  allowedValues?: string[];
  defaultValue?: string;
  desc?: string;
  example?: string;
  id?: string;
  key?: string;
  name?: string;
  type?: string;
  value?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `id?`: `string`; `value?`: `string`; }; `id`: `string`; }	-
`parameters.body`	{ `id?`: `string`; `value?`: `string`; }	-
`parameters.body.id?`	`string`	-
`parameters.body.value?`	`string`	-
`parameters.id?`	`string`	A String containing the property key.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; allowedValues?: string[]; defaultValue?: string; desc?: string; example?: string; id?: string; key?: string; name?: string; type?: string; value?: string; }>

applicationRoles

applicationRoles: object;

applicationRoles.getAll

getAll: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

applicationRoles.getApplicationRole

getApplicationRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultGroups?: string[];
  defined?: boolean;
  groups?: string[];
  hasUnlimitedSeats?: boolean;
  key?: string;
  name?: string;
  numberOfSeats?: number;
  platform?: boolean;
  remainingSeats?: number;
  selectedByDefault?: boolean;
  userCount?: number;
  userCountDescription?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `key`: `string`; }	-
`parameters.key`	`string`	The key of the role to use.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; defaultGroups?: string[]; defined?: boolean; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }>

applicationRoles.putBulk

putBulk: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type
`parameters`	{ `body?`: `object`[]; `If-Match?`: `string`; }
`parameters.body?`	`object`[]
`parameters.If-Match?`	`string`
`options?`	`RequestOptions`

Returns

Promise<object[]>

applicationRoles.updateApplicationRole

updateApplicationRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultGroups?: string[];
  defined?: boolean;
  groups?: string[];
  hasUnlimitedSeats?: boolean;
  key?: string;
  name?: string;
  numberOfSeats?: number;
  platform?: boolean;
  remainingSeats?: number;
  selectedByDefault?: boolean;
  userCount?: number;
  userCountDescription?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `defaultGroups?`: `string`[]; `defined?`: `boolean`; `groups?`: `string`[]; `hasUnlimitedSeats?`: `boolean`; `key?`: `string`; `name?`: `string`; `numberOfSeats?`: `number`; `platform?`: `boolean`; `remainingSeats?`: `number`; `selectedByDefault?`: `boolean`; `userCount?`: `number`; `userCountDescription?`: `string`; }; `If-Match?`: `string`; `key`: `string`; `versionHash?`: `string`; }	-
`parameters.body?`	{ `defaultGroups?`: `string`[]; `defined?`: `boolean`; `groups?`: `string`[]; `hasUnlimitedSeats?`: `boolean`; `key?`: `string`; `name?`: `string`; `numberOfSeats?`: `number`; `platform?`: `boolean`; `remainingSeats?`: `number`; `selectedByDefault?`: `boolean`; `userCount?`: `number`; `userCountDescription?`: `string`; }	-
`parameters.body.defaultGroups?`	`string`[]	-
`parameters.body.defined?`	`boolean`	-
`parameters.body.groups?`	`string`[]	-
`parameters.body.hasUnlimitedSeats?`	`boolean`	-
`parameters.body.key?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.numberOfSeats?`	`number`	-
`parameters.body.platform?`	`boolean`	-
`parameters.body.remainingSeats?`	`number`	-
`parameters.body.selectedByDefault?`	`boolean`	-
`parameters.body.userCount?`	`number`	-
`parameters.body.userCountDescription?`	`string`	-
`parameters.If-Match?`	`string`	-
`parameters.key?`	`string`	The key of the role to update.
`parameters.versionHash?`	`string`	The hash of the version to update. Optional Param
`options?`	`RequestOptions`	-

Returns

avatars

avatars: object;

avatars.createAvatarFromTemporary

createAvatarFromTemporary: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cropperOffsetX?`: `number`; `cropperOffsetY?`: `number`; `cropperWidth?`: `number`; `needsCropping?`: `boolean`; `owningObjectId`: `string`; `type`: `string`; `url?`: `string`; }	-
`parameters.cropperOffsetX?`	`number`	-
`parameters.cropperOffsetY?`	`number`	-
`parameters.cropperWidth?`	`number`	-
`parameters.needsCropping?`	`boolean`	-
`parameters.owningObjectId?`	`string`	Entity id where to change avatar
`parameters.type?`	`string`	-
`parameters.url?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; fileName?: string; id?: string; isDeletable?: boolean; isSelected?: boolean; isSystemAvatar?: boolean; owner?: string; selected?: boolean; urls?: Record<string, string>; }>

avatars.deleteAvatar

deleteAvatar: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `owningObjectId`: `string`; `type`: `string`; }	-
`parameters.id`	`number`	Database id for avatar
`parameters.owningObjectId?`	`string`	Entity id where to change avatar
`parameters.type?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

avatars.getAllSystemAvatars

getAllSystemAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `type`: `string`; }	-
`parameters.type`	`string`	The avatar type
`options?`	`RequestOptions`	-

Returns

avatars.getAvatars

getAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;

Parameters

Parameter	Type
`parameters`	{ `owningObjectId`: `string`; `type`: `string`; }
`parameters.owningObjectId`	`string`
`parameters.type?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>

avatars.storeTemporaryAvatarUsingMultiPart

storeTemporaryAvatarUsingMultiPart: (parameters, options?) => Promise<{
[key: string]: unknown;
  cropperOffsetX?: number;
  cropperOffsetY?: number;
  cropperWidth?: number;
  needsCropping?: boolean;
  url?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `avatar`: \| `AttachmentInput` \| `AttachmentInput`[]; `owningObjectId`: `string`; `type`: `string`; }	-
`parameters.avatar`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.owningObjectId?`	`string`	Entity id where to change avatar
`parameters.type?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; cropperOffsetX?: number; cropperOffsetY?: number; cropperWidth?: number; needsCropping?: boolean; url?: string; }>

backlog

backlog: object;

backlog.moveIssuesToBacklog

moveIssuesToBacklog: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `issues?`: `string`[]; }
`parameters.issues?`	`string`[]
`options?`	`RequestOptions`

Returns

Promise<void>

board

board: object;

board.createBoard

createBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name?: string;
  self?: string;
  type?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `filterId?`: `number`; `name?`: `string`; `type?`: `string`; }
`parameters.filterId?`	`number`
`parameters.name?`	`string`
`parameters.type?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; id?: number; name?: string; self?: string; type?: string; }>

board.deleteBoard

deleteBoard: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; }	-
`parameters.boardId`	`number`	Id of the board to be deleted
`options?`	`RequestOptions`	-

Returns

Promise<void>

board.deleteBoardProperty

deleteBoardProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `propertyKey`: `string`; }	-
`parameters.boardId`	`number`	The id of the board from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

board.getAllBoards

getAllBoards: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `name?`: `string`; `projectKeyOrId?`: `string`; `startAt?`: `number`; `type?`: `string` \| `string`[]; }	-
`parameters.maxResults?`	`number`	The maximum number of boards to return per page. Default: 50.
`parameters.name?`	`string`	Filters results to boards that match or partially match the specified name.
`parameters.projectKeyOrId?`	`string`	Filters results to boards that are relevant to a project.
`parameters.startAt?`	`number`	The starting index of the returned boards. Base index: 0.
`parameters.type?`	`string` \| `string`[]	Filters results to boards of the specified type. Valid values: scrum, kanban.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

board.getAllSprints

getAllSprints: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `maxResults?`: `number`; `startAt?`: `number`; `state?`: `string` \| `string`[]; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested sprints.
`parameters.maxResults?`	`number`	The maximum number of sprints to return per page. Default: 50.
`parameters.startAt?`	`number`	The starting index of the returned sprints. Base index: 0.
`parameters.state?`	`string` \| `string`[]	Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

board.getAllVersions

getAllVersions: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `maxResults?`: `number`; `released?`: `string`; `startAt?`: `number`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested versions.
`parameters.maxResults?`	`number`	The maximum number of versions to return per page. Default: 50.
`parameters.released?`	`string`	Filters results to versions that are either released or unreleased. Valid values: true, false.
`parameters.startAt?`	`number`	The starting index of the returned versions. Base index: 0.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

board.getBoard

getBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name?: string;
  self?: string;
  type?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; }	-
`parameters.boardId`	`number`	The Id of the requested board.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: number; name?: string; self?: string; type?: string; }>

board.getBoardConfiguration

getBoardConfiguration: (parameters, options?) => Promise<{
[key: string]: unknown;
  columnConfig?: {
   [key: string]: unknown;
     columns?: object[];
     constraintType?: string;
  };
  estimation?: {
   [key: string]: unknown;
     field?: {
      [key: string]: unknown;
        displayName?: string;
        fieldId?: string;
     };
     type?: string;
  };
  filter?: {
   [key: string]: unknown;
     id?: string;
     self?: string;
  };
  id?: number;
  name?: string;
  ranking?: {
   [key: string]: unknown;
     rankCustomFieldId?: number;
  };
  self?: string;
  subQuery?: {
   [key: string]: unknown;
     query?: string;
  };
  type?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; }	-
`parameters.boardId`	`number`	The id of the board for which configuration is requested.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; columnConfig?: { [key: string]: unknown; columns?: object[]; constraintType?: string; }; estimation?: { [key: string]: unknown; field?: { [key: string]: unknown; displayName?: string; fieldId?: string; }; type?: string; }; filter?: { [key: string]: unknown; id?: string; self?: string; }; id?: number; name?: string; ranking?: { [key: string]: unknown; rankCustomFieldId?: number; }; self?: string; subQuery?: { [key: string]: unknown; query?: string; }; type?: string; }>

board.getBoardProperty

getBoardProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `propertyKey`: `string`; }	-
`parameters.boardId`	`number`	The id of the board from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

board.getBoardPropertyKeys

getBoardPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; }	-
`parameters.boardId`	`number`	The id of the board from which property keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

board.getEpics

getEpics: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `done?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested epics.
`parameters.done?`	`string`	Filters results to epics that are either done or not done. Valid values: true, false.
`parameters.maxResults?`	`number`	The maximum number of epics to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
`parameters.startAt?`	`number`	The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

board.getIssuesForBacklog

getIssuesForBacklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `expand?`: `string`; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested issues.
`parameters.expand?`	`string`	This parameter is currently not used.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; expand?: string | null; issues?: object[]; maxResults?: number; maxResultWindow?: number; names?: Record<string, string> | null; schema?: | Record<string, { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }> | null; startAt?: number; total?: number; warningMessages?: string[] | null; }>

board.getIssuesForBoard

getIssuesForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `expand?`: `string`; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested issues.
`parameters.expand?`	`string`	This parameter is currently not used.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

board.getIssuesForBoardEpic

getIssuesForBoardEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `epicId`: `number`; `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested issues.
`parameters.epicId?`	`number`	The Id of the epic that contains the requested issues.
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your JIRA instance. If you exceed this limit, your results will be truncated.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

board.getIssuesForBoardSprint

getIssuesForBoardSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `sprintId`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.boardId`	`number`	The Id of the board that contains requested issues.
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of sprints to return per page. Default: 50.
`parameters.sprintId?`	`number`	The Id of the sprint that contains requested issues.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

board.getIssuesWithoutEpicForBoard

getIssuesWithoutEpicForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.boardId`	`number`	The Id of the board that contains the requested issues.
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your JIRA instance. If you exceed this limit, your results will be truncated.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

board.getProjects

getProjects: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `maxResults?`: `number`; `startAt?`: `number`; }	-
`parameters.boardId`	`number`	The Id of the board that contains returned projects.
`parameters.maxResults?`	`number`	The maximum number of projects to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
`parameters.startAt?`	`number`	The starting index of the returned projects. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

board.getRefinedVelocity

getRefinedVelocity: (parameters, options?) => Promise<{
[key: string]: unknown;
  value?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; }	-
`parameters.boardId`	`number`	The id of the board from which the settings will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; value?: boolean; }>

board.setBoardProperty

setBoardProperty: (parameters, options?) => Promise<
  | {
[key: string]: unknown;
  keys?: object[];
}
| undefined>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `body`: `Record`<`string`, `any`>; `propertyKey`: `string`; }	-
`parameters.boardId`	`number`	The id of the board on which the property will be set.
`parameters.body?`	`Record`<`string`, `any`>	-
`parameters.propertyKey?`	`string`	The key of the board's property.
`options?`	`RequestOptions`	-

Returns

Promise< | { [key: string]: unknown; keys?: object[]; } | undefined>

board.setRefinedVelocity

setRefinedVelocity: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId`: `number`; `value?`: `boolean`; }	-
`parameters.boardId`	`number`	The id of the board on which the property will be set.
`parameters.value?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

cluster

cluster: object;

cluster.acknowledgeErrors

acknowledgeErrors: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

cluster.approveUpgrade

approveUpgrade: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

cluster.cancelUpgrade

cancelUpgrade: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

cluster.changeNodeStateToOffline

changeNodeStateToOffline: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `nodeId`: `string`; }	-
`parameters.nodeId`	`string`	ID of the node to change state
`options?`	`RequestOptions`	-

Returns

Promise<void>

cluster.deleteNode

deleteNode: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `nodeId`: `string`; }	-
`parameters.nodeId`	`string`	ID of the node to delete
`options?`	`RequestOptions`	-

Returns

Promise<void>

cluster.getAllNodes

getAllNodes: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

cluster.getState

getState: (options?) => Promise<{
[key: string]: unknown;
  build?: {
   [key: string]: unknown;
     buildNumber?: number;
     version?: string;
  };
  state?:   | string & object
     | "STABLE"
     | "READY_TO_UPGRADE"
     | "MIXED"
     | "READY_TO_RUN_UPGRADE_TASKS"
     | "RUNNING_UPGRADE_TASKS"
     | "UPGRADE_TASKS_FAILED";
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; build?: { [key: string]: unknown; buildNumber?: number; version?: string; }; state?: | string & object | "STABLE" | "READY_TO_UPGRADE" | "MIXED" | "READY_TO_RUN_UPGRADE_TASKS" | "RUNNING_UPGRADE_TASKS" | "UPGRADE_TASKS_FAILED"; }>

cluster.setReadyToUpgrade

setReadyToUpgrade: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

configuration

configuration: object;

configuration.getConfiguration

getConfiguration: (options?) => Promise<{
[key: string]: unknown;
  attachmentsEnabled?: boolean;
  issueLinkingEnabled?: boolean;
  subTasksEnabled?: boolean;
  timeTrackingConfiguration?: {
   [key: string]: unknown;
     defaultUnit?: "day" | "hour" | "minute" | "week" | string & object;
     timeFormat?: "days" | "hours" | string & object | "pretty";
     workingDaysPerWeek?: number;
     workingHoursPerDay?: number;
  };
  timeTrackingEnabled?: boolean;
  unassignedIssuesAllowed?: boolean;
  votingEnabled?: boolean;
  watchingEnabled?: boolean;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; attachmentsEnabled?: boolean; issueLinkingEnabled?: boolean; subTasksEnabled?: boolean; timeTrackingConfiguration?: { [key: string]: unknown; defaultUnit?: "day" | "hour" | "minute" | "week" | string & object; timeFormat?: "days" | "hours" | string & object | "pretty"; workingDaysPerWeek?: number; workingHoursPerDay?: number; }; timeTrackingEnabled?: boolean; unassignedIssuesAllowed?: boolean; votingEnabled?: boolean; watchingEnabled?: boolean; }>

dashboards

dashboards: object;

dashboards.deleteDashboardItemProperty

deleteDashboardItemProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `dashboardId`: `string`; `itemId`: `string`; `propertyKey`: `string`; }	-
`parameters.dashboardId`	`string`	The dashboard id.
`parameters.itemId?`	`string`	The dashboard item from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

dashboards.getDashboard

getDashboard: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  name?: string;
  self?: string;
  view?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The dashboard id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; name?: string; self?: string; view?: string; }>

dashboards.getDashboardItemProperty

getDashboardItemProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `dashboardId`: `string`; `itemId`: `string`; `propertyKey`: `string`; }	-
`parameters.dashboardId`	`string`	The dashboard id.
`parameters.itemId?`	`string`	The dashboard item from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

dashboards.getDashboardItemPropertyKeys

getDashboardItemPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `dashboardId`: `string`; `itemId`: `string`; }	-
`parameters.dashboardId`	`string`	The dashboard id.
`parameters.itemId?`	`string`	The dashboard item from which keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

dashboards.list

list: (parameters?, options?) => Promise<{
[key: string]: unknown;
  dashboards?: object[];
  maxResults?: number;
  next?: string;
  prev?: string;
  startAt?: number;
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `filter?`: `string`; `maxResults?`: `string`; `startAt?`: `string`; }	-
`parameters.filter?`	`string`	An optional filter that is applied to the list of dashboards.
`parameters.maxResults?`	`string`	A hint as to the maximum number of dashboards to return in each call.
`parameters.startAt?`	`string`	The index of the first dashboard to return (0-based).
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; dashboards?: object[]; maxResults?: number; next?: string; prev?: string; startAt?: number; total?: number; }>

dashboards.setDashboardItemProperty

setDashboardItemProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `dashboardId`: `string`; `itemId`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.dashboardId?`	`string`	The dashboard id.
`parameters.itemId?`	`string`	The dashboard item on which the property will be set.
`parameters.propertyKey?`	`string`	The key of the dashboard item's property. The maximum length of the key is 255 bytes.
`options?`	`RequestOptions`	-

Returns

Promise<void>

emailTemplates

emailTemplates: object;

emailTemplates.applyEmailTemplates

applyEmailTemplates: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

emailTemplates.downloadEmailTemplates

downloadEmailTemplates: (options?) => Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<ArrayBuffer | ArrayBufferView<ArrayBufferLike>>

emailTemplates.getEmailTypes

getEmailTypes: (options?) => Promise<{
[key: string]: unknown;
  emailTypes?: object[];
  userEmailAddress?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; emailTypes?: object[]; userEmailAddress?: string; }>

emailTemplates.revertEmailTemplatesToDefault

revertEmailTemplatesToDefault: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

emailTemplates.uploadEmailTemplates

uploadEmailTemplates: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `body`: `Blob`; }
`parameters.body`	`Blob`
`options?`	`RequestOptions`

Returns

Promise<void>

epic

epic: object;

epic.getEpic

getEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?:   | string & object
        | "color_1"
        | "color_2"
        | "color_3"
        | "color_4"
        | "color_5"
        | "color_6"
        | "color_7"
        | "color_8"
        | "color_9"
        | "color_10"
        | "color_11"
        | "color_12"
        | "color_13"
        | "color_14";
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `epicIdOrKey`: `string`; }	-
`parameters.epicIdOrKey`	`string`	The id or key of the requested epic.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; color?: { [key: string]: unknown; key?: | string & object | "color_1" | "color_2" | "color_3" | "color_4" | "color_5" | "color_6" | "color_7" | "color_8" | "color_9" | "color_10" | "color_11" | "color_12" | "color_13" | "color_14"; }; done?: boolean; id?: number; key?: string; name?: string; self?: string; summary?: string; }>

epic.getIssuesForEpic

getIssuesForEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `epicIdOrKey`: `string`; `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.epicIdOrKey`	`string`	The id or key of the epic that contains the requested issues.
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max'. in your JIRA instance. If you exceed this limit, your results will be truncated.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

epic.getIssuesWithoutEpic

getIssuesWithoutEpic: (parameters?, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max'. in your JIRA instance. If you exceed this limit, your results will be truncated.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

epic.moveIssuesToEpic

moveIssuesToEpic: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `epicIdOrKey`: `string`; `issues?`: `string`[]; }	-
`parameters.epicIdOrKey`	`string`	The id or key of the epic that you want to assign issues to.
`parameters.issues?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

epic.partiallyUpdateEpic

partiallyUpdateEpic: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: {
   [key: string]: unknown;
     key?:   | string & object
        | "color_1"
        | "color_2"
        | "color_3"
        | "color_4"
        | "color_5"
        | "color_6"
        | "color_7"
        | "color_8"
        | "color_9"
        | "color_10"
        | "color_11"
        | "color_12"
        | "color_13"
        | "color_14";
  };
  done?: boolean;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
  summary?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `color?`: { `key?`: \| `string` & `object` \| `"color_1"` \| `"color_2"` \| `"color_3"` \| `"color_4"` \| `"color_5"` \| `"color_6"` \| `"color_7"` \| `"color_8"` \| `"color_9"` \| `"color_10"` \| `"color_11"` \| `"color_12"` \| `"color_13"` \| `"color_14"`; }; `done?`: `boolean`; `epicIdOrKey`: `string`; `name?`: `string`; `summary?`: `string`; }	-
`parameters.color?`	{ `key?`: \| `string` & `object` \| `"color_1"` \| `"color_2"` \| `"color_3"` \| `"color_4"` \| `"color_5"` \| `"color_6"` \| `"color_7"` \| `"color_8"` \| `"color_9"` \| `"color_10"` \| `"color_11"` \| `"color_12"` \| `"color_13"` \| `"color_14"`; }	-
`parameters.color.key?`	\| `string` & `object` \| `"color_1"` \| `"color_2"` \| `"color_3"` \| `"color_4"` \| `"color_5"` \| `"color_6"` \| `"color_7"` \| `"color_8"` \| `"color_9"` \| `"color_10"` \| `"color_11"` \| `"color_12"` \| `"color_13"` \| `"color_14"`	-
`parameters.done?`	`boolean`	-
`parameters.epicIdOrKey?`	`string`	The id or key of the epic to update.
`parameters.name?`	`string`	-
`parameters.summary?`	`string`	-
`options?`	`RequestOptions`	-

Returns

epic.rankEpics

rankEpics: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `epicIdOrKey`: `string`; `rankAfterEpic?`: `string`; `rankBeforeEpic?`: `string`; `rankCustomFieldId?`: `number`; }	-
`parameters.epicIdOrKey`	`string`	The id or key of the epic to rank.
`parameters.rankAfterEpic?`	`string`	-
`parameters.rankBeforeEpic?`	`string`	-
`parameters.rankCustomFieldId?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

epic.removeIssuesFromEpic

removeIssuesFromEpic: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `issues?`: `string`[]; }
`parameters.issues?`	`string`[]
`options?`	`RequestOptions`

Returns

Promise<void>

filters

filters: object;

filters.addSharePermission

addSharePermission: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `edit?`: `boolean`; `groupname?`: `string`; `id`: `string`; `projectId?`: `string`; `projectRoleId?`: `string`; `type?`: `string`; `userKey?`: `string`; `view?`: `boolean`; }	-
`parameters.edit?`	`boolean`	-
`parameters.groupname?`	`string`	-
`parameters.id?`	`string`	The filter id.
`parameters.projectId?`	`string`	-
`parameters.projectRoleId?`	`string`	-
`parameters.type?`	`string`	-
`parameters.userKey?`	`string`	-
`parameters.view?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

filters.createFilter

createFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  editable?: boolean;
  favourite?: boolean;
  id?: string;
  jql?: string;
  name?: string;
  owner?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  searchUrl?: string;
  self?: string;
  sharedUsers?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  sharePermissions?: object[];
  viewUrl?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `editable?`: `boolean`; `expand?`: `string` \| `string`[]; `favourite?`: `boolean`; `id?`: `string`; `jql?`: `string`; `name?`: `string`; `owner?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `searchUrl?`: `string`; `self?`: `string`; `sharedUsers?`: { `backingListSize?`: `number`; `callback?`: `Record`<`string`, `never`>; `items?`: `object`[]; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `sharePermissions?`: `object`[]; `viewUrl?`: `string`; }
`parameters.description?`	`string`
`parameters.editable?`	`boolean`
`parameters.expand?`	`string` \| `string`[]
`parameters.favourite?`	`boolean`
`parameters.id?`	`string`
`parameters.jql?`	`string`
`parameters.name?`	`string`
`parameters.owner?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }
`parameters.owner.active?`	`boolean`
`parameters.owner.applicationRoles?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.owner.applicationRoles.callback?`	`Record`<`string`, `never`>
`parameters.owner.applicationRoles.maxResults?`	`number`
`parameters.owner.applicationRoles.pagingCallback?`	`Record`<`string`, `never`>
`parameters.owner.applicationRoles.size?`	`number`
`parameters.owner.avatarUrls?`	`Record`<`string`, `string`>
`parameters.owner.deleted?`	`boolean`
`parameters.owner.displayName?`	`string`
`parameters.owner.emailAddress?`	`string`
`parameters.owner.expand?`	`string`
`parameters.owner.groups?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.owner.groups.callback?`	`Record`<`string`, `never`>
`parameters.owner.groups.maxResults?`	`number`
`parameters.owner.groups.pagingCallback?`	`Record`<`string`, `never`>
`parameters.owner.groups.size?`	`number`
`parameters.owner.key?`	`string`
`parameters.owner.lastLoginTime?`	`string`
`parameters.owner.locale?`	`string`
`parameters.owner.name?`	`string`
`parameters.owner.self?`	`string`
`parameters.owner.timeZone?`	`string`
`parameters.searchUrl?`	`string`
`parameters.self?`	`string`
`parameters.sharedUsers?`	{ `backingListSize?`: `number`; `callback?`: `Record`<`string`, `never`>; `items?`: `object`[]; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.sharedUsers.backingListSize?`	`number`
`parameters.sharedUsers.callback?`	`Record`<`string`, `never`>
`parameters.sharedUsers.items?`	`object`[]
`parameters.sharedUsers.maxResults?`	`number`
`parameters.sharedUsers.pagingCallback?`	`Record`<`string`, `never`>
`parameters.sharedUsers.size?`	`number`
`parameters.sharePermissions?`	`object`[]
`parameters.viewUrl?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; description?: string; editable?: boolean; favourite?: boolean; id?: string; jql?: string; name?: string; owner?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; searchUrl?: string; self?: string; sharedUsers?: { [key: string]: unknown; backingListSize?: number; callback?: { [key: string]: unknown; }; items?: object[]; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; sharePermissions?: object[]; viewUrl?: string; }>

filters.deleteFilter

deleteFilter: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The ID of the filter to delete.
`options?`	`RequestOptions`	-

Returns

Promise<void>

filters.deleteSharePermission

deleteSharePermission: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `permissionId`: `string`; }	-
`parameters.id`	`string`	The filter id.
`parameters.permissionId?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

filters.editFilter

editFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  editable?: boolean;
  favourite?: boolean;
  id?: string;
  jql?: string;
  name?: string;
  owner?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  searchUrl?: string;
  self?: string;
  sharedUsers?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  sharePermissions?: object[];
  viewUrl?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `description?`: `string`; `editable?`: `boolean`; `favourite?`: `boolean`; `id?`: `string`; `jql?`: `string`; `name?`: `string`; `owner?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `searchUrl?`: `string`; `self?`: `string`; `sharedUsers?`: { `backingListSize?`: `number`; `callback?`: `Record`<`string`, `never`>; `items?`: `object`[]; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `sharePermissions?`: `object`[]; `viewUrl?`: `string`; }; `expand?`: `string` \| `string`[]; `id`: `string`; }	-
`parameters.body?`	{ `description?`: `string`; `editable?`: `boolean`; `favourite?`: `boolean`; `id?`: `string`; `jql?`: `string`; `name?`: `string`; `owner?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `searchUrl?`: `string`; `self?`: `string`; `sharedUsers?`: { `backingListSize?`: `number`; `callback?`: `Record`<`string`, `never`>; `items?`: `object`[]; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `sharePermissions?`: `object`[]; `viewUrl?`: `string`; }	-
`parameters.body.description?`	`string`	-
`parameters.body.editable?`	`boolean`	-
`parameters.body.favourite?`	`boolean`	-
`parameters.body.id?`	`string`	-
`parameters.body.jql?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.owner?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.owner.active?`	`boolean`	-
`parameters.body.owner.applicationRoles?`	{ `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }	-
`parameters.body.owner.applicationRoles.callback?`	... \| ...	-
`parameters.body.owner.applicationRoles.maxResults?`	... \| ...	-
`parameters.body.owner.applicationRoles.pagingCallback?`	... \| ...	-
`parameters.body.owner.applicationRoles.size?`	... \| ...	-
`parameters.body.owner.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.owner.deleted?`	`boolean`	-
`parameters.body.owner.displayName?`	`string`	-
`parameters.body.owner.emailAddress?`	`string`	-
`parameters.body.owner.expand?`	`string`	-
`parameters.body.owner.groups?`	{ `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }	-
`parameters.body.owner.groups.callback?`	... \| ...	-
`parameters.body.owner.groups.maxResults?`	... \| ...	-
`parameters.body.owner.groups.pagingCallback?`	... \| ...	-
`parameters.body.owner.groups.size?`	... \| ...	-
`parameters.body.owner.key?`	`string`	-
`parameters.body.owner.lastLoginTime?`	`string`	-
`parameters.body.owner.locale?`	`string`	-
`parameters.body.owner.name?`	`string`	-
`parameters.body.owner.self?`	`string`	-
`parameters.body.owner.timeZone?`	`string`	-
`parameters.body.searchUrl?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.body.sharedUsers?`	{ `backingListSize?`: `number`; `callback?`: `Record`<`string`, `never`>; `items?`: `object`[]; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }	-
`parameters.body.sharedUsers.backingListSize?`	`number`	-
`parameters.body.sharedUsers.callback?`	`Record`<`string`, `never`>	-
`parameters.body.sharedUsers.items?`	`object`[]	-
`parameters.body.sharedUsers.maxResults?`	`number`	-
`parameters.body.sharedUsers.pagingCallback?`	`Record`<`string`, `never`>	-
`parameters.body.sharedUsers.size?`	`number`	-
`parameters.body.sharePermissions?`	`object`[]	-
`parameters.body.viewUrl?`	`string`	-
`parameters.expand?`	`string` \| `string`[]	-
`parameters.id?`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

filters.getDefaultShareScope

getDefaultShareScope: (options?) => Promise<{
[key: string]: unknown;
  scope?: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; scope?: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>

filters.getFavouriteFilters

getFavouriteFilters: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type
`parameters?`	{ `expand?`: `string` \| `string`[]; }
`parameters.expand?`	`string` \| `string`[]
`options?`	`RequestOptions`

Returns

Promise<object[]>

filters.getFilter

getFilter: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  editable?: boolean;
  favourite?: boolean;
  id?: string;
  jql?: string;
  name?: string;
  owner?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  searchUrl?: string;
  self?: string;
  sharedUsers?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  sharePermissions?: object[];
  viewUrl?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `id`: `string`; }	-
`parameters.expand?`	`string` \| `string`[]	-
`parameters.id?`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

filters.getFilterColumns

getFilterColumns: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

filters.getSharePermission

getSharePermission: (parameters, options?) => Promise<{
[key: string]: unknown;
  edit?: boolean;
  group?: {
   [key: string]: unknown;
     name?: string;
     self?: string;
  };
  id?: number;
  project?: {
   [key: string]: unknown;
     archived?: boolean;
     avatarUrls?: Record<string, string>;
     description?: string;
     id?: string;
     key?: string;
     name?: string;
     self?: string;
  };
  role?: {
   [key: string]: unknown;
     actors?: object[];
     description?: string;
     id?: number;
     name?: string;
     self?: string;
  };
  type?: string;
  user?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  view?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `permissionId`: `string`; }	-
`parameters.id`	`string`	The filter id.
`parameters.permissionId?`	`string`	The permission id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; edit?: boolean; group?: { [key: string]: unknown; name?: string; self?: string; }; id?: number; project?: { [key: string]: unknown; archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; }; role?: { [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; view?: boolean; }>

filters.getSharePermissions

getSharePermissions: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

filters.resetColumns

resetColumns: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

filters.setColumns

setColumns: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `columns?`: `string`[]; `id`: `string`; }	-
`parameters.columns?`	`string`[]	-
`parameters.id?`	`string`	The filter id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

filters.setDefaultShareScope

setDefaultShareScope: (parameters, options?) => Promise<{
[key: string]: unknown;
  scope?: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE";
}>;

Parameters

Parameter	Type
`parameters`	{ `scope?`: `string` & `object` \| `"GLOBAL"` \| `"AUTHENTICATED"` \| `"PRIVATE"`; }
`parameters.scope?`	`string` & `object` \| `"GLOBAL"` \| `"AUTHENTICATED"` \| `"PRIVATE"`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; scope?: string & object | "GLOBAL" | "AUTHENTICATED" | "PRIVATE"; }>

groupAndUserPicker

groupAndUserPicker: object;

groupAndUserPicker.findUsersAndGroups

findUsersAndGroups: (parameters?, options?) => Promise<{
[key: string]: unknown;
  groups?: {
   [key: string]: unknown;
     groups?: object[];
     header?: string;
     total?: number;
  };
  users?: {
   [key: string]: unknown;
     header?: string;
     total?: number;
     users?: object[];
  };
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `fieldId?`: `string`; `issueTypeId?`: `string`; `maxResults?`: `string`; `projectId?`: `string`; `query?`: `string`; `showAvatar?`: `string`; }	-
`parameters.fieldId?`	`string`	The custom field id
`parameters.issueTypeId?`	`string`	The list of issue type ids to further restrict the search
`parameters.maxResults?`	`string`	The maximum number of users to return
`parameters.projectId?`	`string`	The list of project ids to further restrict the search
`parameters.query?`	`string`	A string used to search username, Name or e-mail address
`parameters.showAvatar?`	`string`	Show avatar
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; groups?: { [key: string]: unknown; groups?: object[]; header?: string; total?: number; }; users?: { [key: string]: unknown; header?: string; total?: number; users?: object[]; }; }>

groups

groups: object;

groups.addUserToGroup

addUserToGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  name?: string;
  self?: string;
  users?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `groupname`: `string`; `name?`: `string`; }	-
`parameters.groupname`	`string`	A name of requested group.
`parameters.name?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; name?: string; self?: string; users?: { [key: string]: unknown; backingListSize?: number; callback?: { [key: string]: unknown; }; items?: object[]; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; }>

groups.createGroup

createGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  name?: string;
  self?: string;
  users?: {
   [key: string]: unknown;
     backingListSize?: number;
     callback?: {
      [key: string]: unknown;
     };
     items?: object[];
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
}>;

Parameters

Parameter	Type
`parameters`	{ `name?`: `string`; }
`parameters.name?`	`string`
`options?`	`RequestOptions`

Returns

groups.findGroups

findGroups: (parameters?, options?) => Promise<{
[key: string]: unknown;
  groups?: object[];
  header?: string;
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `exclude?`: `string`; `maxResults?`: `string`; `query?`: `string`; `userName?`: `string`; }	-
`parameters.exclude?`	`string`	List of groups to exclude
`parameters.maxResults?`	`string`	Maximum number of results to return
`parameters.query?`	`string`	A String to match groups against
`parameters.userName?`	`string`	Username for the context
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; groups?: object[]; header?: string; total?: number; }>

groups.getUsersFromGroup

getUsersFromGroup: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  self?: string;
  startAt?: number;
  total?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `groupname`: `string`; `includeInactiveUsers?`: `string`; `maxResults?`: `string`; `startAt?`: `string`; }	-
`parameters.groupname`	`string`	The group name.
`parameters.includeInactiveUsers?`	`string`	Include inactive users.
`parameters.maxResults?`	`string`	The maximum number of users to return.
`parameters.startAt?`	`string`	The index of the first user in group to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; self?: string; startAt?: number; total?: number; values?: object[]; }>

groups.removeGroup

removeGroup: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `groupname`: `string`; `swapGroup?`: `string`; }	-
`parameters.groupname`	`string`	The name of the group to delete.
`parameters.swapGroup?`	`string`	A different group to transfer the restrictions to.
`options?`	`RequestOptions`	-

Returns

Promise<void>

groups.removeUserFromGroup

removeUserFromGroup: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `groupname`: `string`; `username`: `string`; }	-
`parameters.groupname`	`string`	A name of requested group.
`parameters.username?`	`string`	User to remove from a group
`options?`	`RequestOptions`	-

Returns

Promise<void>

indexing

indexing: object;

indexing.createIndexSnapshot

createIndexSnapshot: (options?) => Promise<{
[key: string]: unknown;
  futureAbsolutePath?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; futureAbsolutePath?: string; }>

indexing.getIndexSummary

getIndexSummary: (options?) => Promise<{
[key: string]: unknown;
  externalPlatformIndexReplay?: Record<string, {
   [key: string]: unknown;
     lastConsumedOperation?: {
      [key: string]: unknown;
        id?: ... | ...;
        journalWriteTime?: ... | ...;
     };
     lastOperationInQueue?: {
      [key: string]: unknown;
        id?: ... | ...;
        journalWriteTime?: ... | ...;
     };
     queueSize?: number;
  }>;
  issueIndex?: {
   [key: string]: unknown;
     countInArchive?: number;
     countInDatabase?: number;
     countInIndex?: number;
     indexReadable?: boolean;
     lastUpdatedInDatabase?: Date;
     lastUpdatedInIndex?: Date;
  };
  nodeId?: string;
  replicationQueues?: Record<string, {
   [key: string]: unknown;
     lastConsumedOperation?: {
      [key: string]: unknown;
        id?: ... | ...;
        replicationTime?: ... | ...;
     };
     lastOperationInQueue?: {
      [key: string]: unknown;
        id?: ... | ...;
        replicationTime?: ... | ...;
     };
     queueSize?: number;
  }>;
  reportTime?: Date;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; externalPlatformIndexReplay?: Record<string, { [key: string]: unknown; lastConsumedOperation?: { [key: string]: unknown; id?: ... | ...; journalWriteTime?: ... | ...; }; lastOperationInQueue?: { [key: string]: unknown; id?: ... | ...; journalWriteTime?: ... | ...; }; queueSize?: number; }>; issueIndex?: { [key: string]: unknown; countInArchive?: number; countInDatabase?: number; countInIndex?: number; indexReadable?: boolean; lastUpdatedInDatabase?: Date; lastUpdatedInIndex?: Date; }; nodeId?: string; replicationQueues?: Record<string, { [key: string]: unknown; lastConsumedOperation?: { [key: string]: unknown; id?: ... | ...; replicationTime?: ... | ...; }; lastOperationInQueue?: { [key: string]: unknown; id?: ... | ...; replicationTime?: ... | ...; }; queueSize?: number; }>; reportTime?: Date; }>

indexing.getProgressBulk

getProgressBulk: (parameters?, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters?`	{ `requestId?`: `number`[]; }	-
`parameters.requestId?`	`number`[]	The reindex request IDs.
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

indexing.getReindexInfo

getReindexInfo: (parameters?, options?) => Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `taskId?`: `number`; }	-
`parameters.taskId?`	`number`	The id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; currentProgress?: number; currentSubTask?: string; finishTime?: Date; progressUrl?: string; startTime?: Date; submittedTime?: Date; success?: boolean; type?: | string & object | "FOREGROUND" | "BACKGROUND" | "BACKGROUND_PREFFERED" | "BACKGROUND_PREFERRED"; }>

indexing.getReindexProgress

getReindexProgress: (parameters?, options?) => Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `taskId?`: `number`; }	-
`parameters.taskId?`	`number`	The id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place.
`options?`	`RequestOptions`	-

Returns

indexing.getReindexRequestProgress

getReindexRequestProgress: (parameters, options?) => Promise<{
[key: string]: unknown;
  completionTime?: Date;
  id?: number;
  requestTime?: Date;
  startTime?: Date;
  status?:   | string & object
     | "RUNNING"
     | "COMPLETE"
     | "FAILED"
     | "PENDING"
     | "ACTIVE";
  type?: string & object | "IMMEDIATE" | "DELAYED";
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `requestId`: `number`; }	-
`parameters.requestId`	`number`	The reindex request ID.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; completionTime?: Date; id?: number; requestTime?: Date; startTime?: Date; status?: | string & object | "RUNNING" | "COMPLETE" | "FAILED" | "PENDING" | "ACTIVE"; type?: string & object | "IMMEDIATE" | "DELAYED"; }>

indexing.isIndexSnapshotRunning

isIndexSnapshotRunning: (options?) => Promise<{
[key: string]: unknown;
  running?: boolean;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; running?: boolean; }>

indexing.listIndexSnapshot

listIndexSnapshot: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

indexing.processRequests

processRequests: (options?) => Promise<number[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<number[]>

indexing.reindex

reindex: (parameters, options?) => Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `indexChangeHistory?`: `boolean`; `indexComments?`: `boolean`; `indexWorklogs?`: `boolean`; `type?`: `string`; }	-
`parameters.indexChangeHistory?`	`boolean`	Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.
`parameters.indexComments?`	`boolean`	Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.
`parameters.indexWorklogs?`	`boolean`	Indicates that worklogs should also be reindexed. Not relevant for foreground reindex, where worklogs are always reindexed.
`parameters.type?`	`string`	Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED. Not relevant for Search Platform that only supports BACKGROUND reindexing e.g. OpenSearch.
`options?`	`RequestOptions`	-

Returns

indexing.reindexIssues

reindexIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `indexChangeHistory?`: `boolean`; `indexComments?`: `boolean`; `indexWorklogs?`: `boolean`; `issueId?`: `string`[]; }	-
`parameters.indexChangeHistory?`	`boolean`	Indicates that changeHistory should also be reindexed.
`parameters.indexComments?`	`boolean`	Indicates that comments should also be reindexed.
`parameters.indexWorklogs?`	`boolean`	Indicates that worklogs should also be reindexed.
`parameters.issueId?`	`string`[]	The IDs or keys of one or more issues to reindex.
`options?`	`RequestOptions`	-

Returns

issueAttachments

issueAttachments: object;

issueAttachments.expandForHumans

expandForHumans: (parameters, options?) => Promise<{
[key: string]: unknown;
  entries?: Record<string, any>;
  id?: number;
  mediaType?: string;
  name?: string;
  totalEntryCount?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The id of the attachment to expand.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; entries?: Record<string, any>; id?: number; mediaType?: string; name?: string; totalEntryCount?: number; }>

issueAttachments.expandForMachines

expandForMachines: (parameters, options?) => Promise<{
[key: string]: unknown;
  entries?: object[];
  totalEntryCount?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The id of the attachment to expand.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; entries?: object[]; totalEntryCount?: number; }>

issueAttachments.getAttachment

getAttachment: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  content?: string;
  created?: string;
  filename?: string;
  id?: string;
  mimeType?: string;
  properties?: Record<string, any>;
  self?: string;
  size?: number;
  thumbnail?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	Id of the attachment to view
`options?`	`RequestOptions`	-

Returns

issueAttachments.getAttachmentMeta

getAttachmentMeta: (options?) => Promise<{
[key: string]: unknown;
  enabled?: boolean;
  uploadLimit?: number;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; enabled?: boolean; uploadLimit?: number; }>

issueAttachments.removeAttachment

removeAttachment: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	Id of the attachment to remove
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueComments

issueComments: object;

issueComments.deleteCommentProperty

deleteCommentProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `commentId`: `string`; `propertyKey`: `string`; }	-
`parameters.commentId`	`string`	The comment from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueComments.getCommentProperty

getCommentProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `commentId`: `string`; `propertyKey`: `string`; }	-
`parameters.commentId`	`string`	The comment from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueComments.getCommentPropertyKeys

getCommentPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `commentId`: `string`; }	-
`parameters.commentId`	`string`	The comment from which keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueComments.setCommentProperty

setCommentProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `commentId`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.commentId?`	`string`	The comment on which the property will be set.
`parameters.propertyKey?`	`string`	The key of the comment's property. The maximum length of the key is 255 bytes.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueCustomFieldOptions

issueCustomFieldOptions: object;

issueCustomFieldOptions.getCustomFieldOption

getCustomFieldOption: (parameters, options?) => Promise<{
[key: string]: unknown;
  childrenIds?: number[];
  disabled?: boolean;
  id?: number;
  self?: string;
  value?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	A String containing an Custom Field Option id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; childrenIds?: number[]; disabled?: boolean; id?: number; self?: string; value?: string; }>

issueFields

issueFields: object;

issueFields.bulkDeleteCustomFields

bulkDeleteCustomFields: (parameters, options?) => Promise<{
[key: string]: unknown;
  deletedCustomFields?: string[];
  message?: string;
  notDeletedCustomFields?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `ids`: `string`; }	-
`parameters.ids`	`string`	A list of custom field IDs to delete.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; deletedCustomFields?: string[]; message?: string; notDeletedCustomFields?: Record<string, string>; }>

issueFields.createCustomField

createCustomField: (parameters, options?) => Promise<{
[key: string]: unknown;
  clauseNames?: string[];
  custom?: boolean;
  id?: string;
  name?: string;
  navigable?: boolean;
  orderable?: boolean;
  schema?: {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
  };
  searchable?: boolean;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `id?`: `string`; `issueTypeIds?`: `string`[]; `name?`: `string`; `projectIds?`: `number`[]; `searcherKey?`: `string`; `self?`: `string`; `type?`: `string`; }
`parameters.description?`	`string`
`parameters.id?`	`string`
`parameters.issueTypeIds?`	`string`[]
`parameters.name?`	`string`
`parameters.projectIds?`	`number`[]
`parameters.searcherKey?`	`string`
`parameters.self?`	`string`
`parameters.type?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; clauseNames?: string[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }; searchable?: boolean; }>

issueFields.getCustomFieldOptions

getCustomFieldOptions: (parameters, options?) => Promise<{
[key: string]: unknown;
  options?: object[];
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `customFieldId`: `string`; `issueTypeIds?`: `string`; `maxResults?`: `string`; `page?`: `string`; `projectIds?`: `string`; `query?`: `string`; `sortByOptionName?`: `string`; `useAllContexts?`: `string`; }	-
`parameters.customFieldId`	`string`	The ID of the custom field.
`parameters.issueTypeIds?`	`string`	A list of issue type IDs in a context.
`parameters.maxResults?`	`string`	The maximum number of results to return.
`parameters.page?`	`string`	The page of options to return.
`parameters.projectIds?`	`string`	A list of project IDs in a context.
`parameters.query?`	`string`	A string used to filter options.
`parameters.sortByOptionName?`	`string`	Flag to sort options by their names.
`parameters.useAllContexts?`	`string`	Flag to fetch all options regardless of context, project IDs, or issue type IDs.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; options?: object[]; total?: number; }>

issueFields.getCustomFields

getCustomFields: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `lastValueUpdate?`: `string`; `maxResults?`: `string`; `projectIds?`: `string`; `screenIds?`: `string`; `search?`: `string`; `sortColumn?`: `string`; `sortOrder?`: `string`; `startAt?`: `string`; `types?`: `string`; }	-
`parameters.lastValueUpdate?`	`string`	The last value update to filter the custom fields.
`parameters.maxResults?`	`string`	The maximum number of custom fields to return.
`parameters.projectIds?`	`string`	A list of project IDs to filter the custom fields.
`parameters.screenIds?`	`string`	A list of screen IDs to filter the custom fields.
`parameters.search?`	`string`	A query string used to search custom fields.
`parameters.sortColumn?`	`string`	The column by which to sort the returned custom fields.
`parameters.sortOrder?`	`string`	The order in which to sort the returned custom fields.
`parameters.startAt?`	`string`	The starting index of the returned custom fields.
`parameters.types?`	`string`	A list of custom field types to filter the custom fields.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issueFields.getFields

getFields: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

issueLinks

issueLinks: object;

issueLinks.deleteIssueLink

deleteIssueLink: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `linkId`: `string`; }	-
`parameters.linkId`	`string`	The issue link id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueLinks.getIssueLink

getIssueLink: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inwardIssue?: {
   [key: string]: unknown;
     fields?: {
      [key: string]: unknown;
        issuetype?: {
         [key: ...]: ...;
           avatarId?: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           subtask?: ...;
        };
        priority?: {
         [key: ...]: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           statusColor?: ...;
        };
        status?: {
         [key: ...]: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           statusCategory?: ...;
           statusColor?: ...;
        };
        summary?: string;
     };
     id?: string;
     key?: string;
     self?: string;
  };
  outwardIssue?: {
   [key: string]: unknown;
     fields?: {
      [key: string]: unknown;
        issuetype?: {
         [key: ...]: ...;
           avatarId?: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           subtask?: ...;
        };
        priority?: {
         [key: ...]: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           statusColor?: ...;
        };
        status?: {
         [key: ...]: ...;
           description?: ...;
           iconUrl?: ...;
           id?: ...;
           name?: ...;
           self?: ...;
           statusCategory?: ...;
           statusColor?: ...;
        };
        summary?: string;
     };
     id?: string;
     key?: string;
     self?: string;
  };
  self?: string;
  type?: {
   [key: string]: unknown;
     id?: string;
     inward?: string;
     name?: string;
     outward?: string;
     self?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `linkId`: `string`; }	-
`parameters.linkId`	`string`	The issue link id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; inwardIssue?: { [key: string]: unknown; fields?: { [key: string]: unknown; issuetype?: { [key: ...]: ...; avatarId?: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; subtask?: ...; }; priority?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; statusColor?: ...; }; status?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; statusCategory?: ...; statusColor?: ...; }; summary?: string; }; id?: string; key?: string; self?: string; }; outwardIssue?: { [key: string]: unknown; fields?: { [key: string]: unknown; issuetype?: { [key: ...]: ...; avatarId?: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; subtask?: ...; }; priority?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; statusColor?: ...; }; status?: { [key: ...]: ...; description?: ...; iconUrl?: ...; id?: ...; name?: ...; self?: ...; statusCategory?: ...; statusColor?: ...; }; summary?: string; }; id?: string; key?: string; self?: string; }; self?: string; type?: { [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }; }>

issueLinks.linkIssues

linkIssues: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `comment?`: { `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `body?`: `string`; `created?`: `string`; `id?`: `string`; `properties?`: `object`[]; `renderedBody?`: `string`; `self?`: `string`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }; `inwardIssue?`: { `fields?`: { `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }; `id?`: `string`; `key?`: `string`; `self?`: `string`; }; `outwardIssue?`: { `fields?`: { `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }; `id?`: `string`; `key?`: `string`; `self?`: `string`; }; `type?`: { `id?`: `string`; `inward?`: `string`; `name?`: `string`; `outward?`: `string`; `self?`: `string`; }; }
`parameters.comment?`	{ `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `body?`: `string`; `created?`: `string`; `id?`: `string`; `properties?`: `object`[]; `renderedBody?`: `string`; `self?`: `string`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }
`parameters.comment.author?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }
`parameters.comment.author.active?`	`boolean`
`parameters.comment.author.avatarUrls?`	`Record`<`string`, `string`>
`parameters.comment.author.displayName?`	`string`
`parameters.comment.author.emailAddress?`	`string`
`parameters.comment.author.key?`	`string`
`parameters.comment.author.name?`	`string`
`parameters.comment.author.self?`	`string`
`parameters.comment.author.timeZone?`	`string`
`parameters.comment.body?`	`string`
`parameters.comment.created?`	`string`
`parameters.comment.id?`	`string`
`parameters.comment.properties?`	`object`[]
`parameters.comment.renderedBody?`	`string`
`parameters.comment.self?`	`string`
`parameters.comment.updateAuthor?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }
`parameters.comment.updateAuthor.active?`	`boolean`
`parameters.comment.updateAuthor.avatarUrls?`	`Record`<`string`, `string`>
`parameters.comment.updateAuthor.displayName?`	`string`
`parameters.comment.updateAuthor.emailAddress?`	`string`
`parameters.comment.updateAuthor.key?`	`string`
`parameters.comment.updateAuthor.name?`	`string`
`parameters.comment.updateAuthor.self?`	`string`
`parameters.comment.updateAuthor.timeZone?`	`string`
`parameters.comment.updated?`	`string`
`parameters.comment.visibility?`	{ `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }
`parameters.comment.visibility.type?`	`"role"` \| `"group"` \| `string` & `object`
`parameters.comment.visibility.value?`	`string`
`parameters.inwardIssue?`	{ `fields?`: { `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }; `id?`: `string`; `key?`: `string`; `self?`: `string`; }
`parameters.inwardIssue.fields?`	{ `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }
`parameters.inwardIssue.fields.issuetype?`	{ `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }
`parameters.inwardIssue.fields.issuetype.avatarId?`	... \| ...
`parameters.inwardIssue.fields.issuetype.description?`	... \| ...
`parameters.inwardIssue.fields.issuetype.iconUrl?`	... \| ...
`parameters.inwardIssue.fields.issuetype.id?`	... \| ...
`parameters.inwardIssue.fields.issuetype.name?`	... \| ...
`parameters.inwardIssue.fields.issuetype.self?`	... \| ...
`parameters.inwardIssue.fields.issuetype.subtask?`	... \| ... \| ...
`parameters.inwardIssue.fields.priority?`	{ `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }
`parameters.inwardIssue.fields.priority.description?`	... \| ...
`parameters.inwardIssue.fields.priority.iconUrl?`	... \| ...
`parameters.inwardIssue.fields.priority.id?`	... \| ...
`parameters.inwardIssue.fields.priority.name?`	... \| ...
`parameters.inwardIssue.fields.priority.self?`	... \| ...
`parameters.inwardIssue.fields.priority.statusColor?`	... \| ...
`parameters.inwardIssue.fields.status?`	{ `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }
`parameters.inwardIssue.fields.status.description?`	... \| ...
`parameters.inwardIssue.fields.status.iconUrl?`	... \| ...
`parameters.inwardIssue.fields.status.id?`	... \| ...
`parameters.inwardIssue.fields.status.name?`	... \| ...
`parameters.inwardIssue.fields.status.self?`	... \| ...
`parameters.inwardIssue.fields.status.statusCategory?`	... \| ...
`parameters.inwardIssue.fields.status.statusColor?`	... \| ...
`parameters.inwardIssue.fields.summary?`	`string`
`parameters.inwardIssue.id?`	`string`
`parameters.inwardIssue.key?`	`string`
`parameters.inwardIssue.self?`	`string`
`parameters.outwardIssue?`	{ `fields?`: { `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }; `id?`: `string`; `key?`: `string`; `self?`: `string`; }
`parameters.outwardIssue.fields?`	{ `issuetype?`: { `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }; `priority?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }; `status?`: { `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }; `summary?`: `string`; }
`parameters.outwardIssue.fields.issuetype?`	{ `avatarId?`: ... \| ...; `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `subtask?`: ... \| ... \| ...; }
`parameters.outwardIssue.fields.issuetype.avatarId?`	... \| ...
`parameters.outwardIssue.fields.issuetype.description?`	... \| ...
`parameters.outwardIssue.fields.issuetype.iconUrl?`	... \| ...
`parameters.outwardIssue.fields.issuetype.id?`	... \| ...
`parameters.outwardIssue.fields.issuetype.name?`	... \| ...
`parameters.outwardIssue.fields.issuetype.self?`	... \| ...
`parameters.outwardIssue.fields.issuetype.subtask?`	... \| ... \| ...
`parameters.outwardIssue.fields.priority?`	{ `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusColor?`: ... \| ...; }
`parameters.outwardIssue.fields.priority.description?`	... \| ...
`parameters.outwardIssue.fields.priority.iconUrl?`	... \| ...
`parameters.outwardIssue.fields.priority.id?`	... \| ...
`parameters.outwardIssue.fields.priority.name?`	... \| ...
`parameters.outwardIssue.fields.priority.self?`	... \| ...
`parameters.outwardIssue.fields.priority.statusColor?`	... \| ...
`parameters.outwardIssue.fields.status?`	{ `description?`: ... \| ...; `iconUrl?`: ... \| ...; `id?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; `statusCategory?`: ... \| ...; `statusColor?`: ... \| ...; }
`parameters.outwardIssue.fields.status.description?`	... \| ...
`parameters.outwardIssue.fields.status.iconUrl?`	... \| ...
`parameters.outwardIssue.fields.status.id?`	... \| ...
`parameters.outwardIssue.fields.status.name?`	... \| ...
`parameters.outwardIssue.fields.status.self?`	... \| ...
`parameters.outwardIssue.fields.status.statusCategory?`	... \| ...
`parameters.outwardIssue.fields.status.statusColor?`	... \| ...
`parameters.outwardIssue.fields.summary?`	`string`
`parameters.outwardIssue.id?`	`string`
`parameters.outwardIssue.key?`	`string`
`parameters.outwardIssue.self?`	`string`
`parameters.type?`	{ `id?`: `string`; `inward?`: `string`; `name?`: `string`; `outward?`: `string`; `self?`: `string`; }
`parameters.type.id?`	`string`
`parameters.type.inward?`	`string`
`parameters.type.name?`	`string`
`parameters.type.outward?`	`string`
`parameters.type.self?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

issueLinkTypes

issueLinkTypes: object;

issueLinkTypes.createIssueLinkType

createIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `id?`: `string`; `inward?`: `string`; `name?`: `string`; `outward?`: `string`; `self?`: `string`; }
`parameters.id?`	`string`
`parameters.inward?`	`string`
`parameters.name?`	`string`
`parameters.outward?`	`string`
`parameters.self?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueLinkTypes.deleteIssueLinkType

deleteIssueLinkType: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueLinkTypeId`: `string`; }	-
`parameters.issueLinkTypeId`	`string`	The issue link type id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueLinkTypes.getIssueLinkType

getIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueLinkTypeId`: `string`; }	-
`parameters.issueLinkTypeId`	`string`	The issue link type id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueLinkTypes.getIssueLinkTypes

getIssueLinkTypes: (options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; }>

issueLinkTypes.moveIssueLinkType

moveIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueLinkTypeId`: `string`; `newPosition?`: `number`; }	-
`parameters.issueLinkTypeId`	`string`	Id of the issue link type to move.
`parameters.newPosition?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueLinkTypes.resetOrder

resetOrder: (parameters, options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type
`parameters`	{ `direction?`: `string`; }
`parameters.direction?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; }>

issueLinkTypes.updateIssueLinkType

updateIssueLinkType: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  inward?: string;
  name?: string;
  outward?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id?`: `string`; `inward?`: `string`; `issueLinkTypeId`: `string`; `name?`: `string`; `outward?`: `string`; `self?`: `string`; }	-
`parameters.id?`	`string`	-
`parameters.inward?`	`string`	-
`parameters.issueLinkTypeId?`	`string`	The issue link type id.
`parameters.name?`	`string`	-
`parameters.outward?`	`string`	-
`parameters.self?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; inward?: string; name?: string; outward?: string; self?: string; }>

issueNotificationSchemes

issueNotificationSchemes: object;

issueNotificationSchemes.getNotificationScheme

getNotificationScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  notificationSchemeEvents?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `id`: `number`; }	-
`parameters.expand?`	`string`	Optional information to be expanded in the response: group, user, projectRole or field.
`parameters.id?`	`number`	The id of the notification scheme to retrieve
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; notificationSchemeEvents?: object[]; self?: string; }>

issueNotificationSchemes.getNotificationSchemes

getNotificationSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: Record<string, any>[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; }	-
`parameters.expand?`	`string`	Optional information to be expanded in the response: group, user, projectRole or field.
`parameters.maxResults?`	`number`	The maximum number of notification schemes to return (max 50).
`parameters.startAt?`	`number`	The index of the first notification scheme to return (0 based).
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: Record<string, any>[]; }>

issuePriorities

issuePriorities: object;

issuePriorities.getPriorities

getPriorities: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

issuePriorities.getPrioritiesPaginated

getPrioritiesPaginated: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `projectIds?`: `number`[]; `query?`: `string`; `startAt?`: `number`; }	-
`parameters.maxResults?`	`number`	How many results on the page should be included. Defaults to 100
`parameters.projectIds?`	`number`[]	The list of project ids to filter priorities
`parameters.query?`	`string`	Query that should match priority name or its translation
`parameters.startAt?`	`number`	The page offset, if not specified then defaults to 0
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issuePriorities.getPriority

getPriority: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  statusColor?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	A String containing the priority id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusColor?: string; }>

issueResolutions

issueResolutions: object;

issueResolutions.getPaginatedResolutions

getPaginatedResolutions: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `query?`: `string`; `startAt?`: `number`; }	-
`parameters.maxResults?`	`number`	The maximum number of statuses to return.
`parameters.query?`	`string`	The string that status names will be matched with.
`parameters.startAt?`	`number`	The index of the first status to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issueResolutions.getResolution

getResolution: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	A String containing the resolution id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; }>

issueResolutions.getResolutions

getResolutions: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

issues

issues: object;

issues.addAttachment

addAttachment: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `attachments`: \| `AttachmentInput` \| `AttachmentInput`[]; `issueIdOrKey`: `string`; }	-
`parameters.attachments`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issues.addComment

addComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  body?: string;
  created?: string;
  id?: string;
  properties?: object[];
  renderedBody?: string;
  self?: string;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `body?`: `string`; `created?`: `string`; `expand?`: `string`; `id?`: `string`; `issueIdOrKey`: `string`; `properties?`: `object`[]; `renderedBody?`: `string`; `self?`: `string`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }	-
`parameters.author?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.author.active?`	`boolean`	-
`parameters.author.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.author.displayName?`	`string`	-
`parameters.author.emailAddress?`	`string`	-
`parameters.author.key?`	`string`	-
`parameters.author.name?`	`string`	-
`parameters.author.self?`	`string`	-
`parameters.author.timeZone?`	`string`	-
`parameters.body?`	`string`	-
`parameters.created?`	`string`	-
`parameters.expand?`	`string`	Optional flags: renderedBody (provides body rendered in HTML)
`parameters.id?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.properties?`	`object`[]	-
`parameters.renderedBody?`	`string`	-
`parameters.self?`	`string`	-
`parameters.updateAuthor?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.updateAuthor.active?`	`boolean`	-
`parameters.updateAuthor.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.updateAuthor.displayName?`	`string`	-
`parameters.updateAuthor.emailAddress?`	`string`	-
`parameters.updateAuthor.key?`	`string`	-
`parameters.updateAuthor.name?`	`string`	-
`parameters.updateAuthor.self?`	`string`	-
`parameters.updateAuthor.timeZone?`	`string`	-
`parameters.updated?`	`string`	-
`parameters.visibility?`	{ `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }	-
`parameters.visibility.type?`	`"role"` \| `"group"` \| `string` & `object`	-
`parameters.visibility.value?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; body?: string; created?: string; id?: string; properties?: object[]; renderedBody?: string; self?: string; updateAuthor?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { [key: string]: unknown; type?: "role" | "group" | string & object; value?: string; }; }>

issues.addVote

addVote: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.addWatcher

addWatcher: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `issueIdOrKey`: `string`; `userName?`: `string`; }	-
`parameters.body?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.userName?`	`string`	The name of the user to add to the watcher list. If no name is specified, the current user is added.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.addWorklog

addWorklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  comment?: string;
  created?: string;
  id?: string;
  issueId?: string;
  self?: string;
  started?: string;
  timeSpent?: string;
  timeSpentSeconds?: number;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `adjustEstimate?`: `string`; `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `comment?`: `string`; `created?`: `string`; `id?`: `string`; `issueId?`: `string`; `issueIdOrKey`: `string`; `newEstimate?`: `string`; `reduceBy?`: `string`; `self?`: `string`; `started?`: `string`; `timeSpent?`: `string`; `timeSpentSeconds?`: `number`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }	-
`parameters.adjustEstimate?`	`string`	Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, manual, auto
`parameters.author?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.author.active?`	`boolean`	-
`parameters.author.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.author.displayName?`	`string`	-
`parameters.author.emailAddress?`	`string`	-
`parameters.author.key?`	`string`	-
`parameters.author.name?`	`string`	-
`parameters.author.self?`	`string`	-
`parameters.author.timeZone?`	`string`	-
`parameters.comment?`	`string`	-
`parameters.created?`	`string`	-
`parameters.id?`	`string`	-
`parameters.issueId?`	`string`	-
`parameters.issueIdOrKey?`	`string`	A string containing the issue id or key the worklog will be added to
`parameters.newEstimate?`	`string`	Required when 'new' is selected for adjustEstimate. e.g. "2d"
`parameters.reduceBy?`	`string`	Required when 'manual' is selected for adjustEstimate. e.g. "2d"
`parameters.self?`	`string`	-
`parameters.started?`	`string`	-
`parameters.timeSpent?`	`string`	-
`parameters.timeSpentSeconds?`	`number`	-
`parameters.updateAuthor?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.updateAuthor.active?`	`boolean`	-
`parameters.updateAuthor.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.updateAuthor.displayName?`	`string`	-
`parameters.updateAuthor.emailAddress?`	`string`	-
`parameters.updateAuthor.key?`	`string`	-
`parameters.updateAuthor.name?`	`string`	-
`parameters.updateAuthor.self?`	`string`	-
`parameters.updateAuthor.timeZone?`	`string`	-
`parameters.updated?`	`string`	-
`parameters.visibility?`	{ `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }	-
`parameters.visibility.type?`	`"role"` \| `"group"` \| `string` & `object`	-
`parameters.visibility.value?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; comment?: string; created?: string; id?: string; issueId?: string; self?: string; started?: string; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { [key: string]: unknown; type?: "role" | "group" | string & object; value?: string; }; }>

issues.archiveIssue

archiveIssue: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `notifyUsers?`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.notifyUsers?`	`string`	Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.archiveIssues

archiveIssues: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `notifyUsers?`: `string`; }	-
`parameters.body?`	`string`	-
`parameters.notifyUsers?`	`string`	Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

issues.assign

assign: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `issueIdOrKey`: `string`; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.active?`	`boolean`	-
`parameters.applicationRoles?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }	-
`parameters.applicationRoles.callback?`	`Record`<`string`, `never`>	-
`parameters.applicationRoles.maxResults?`	`number`	-
`parameters.applicationRoles.pagingCallback?`	`Record`<`string`, `never`>	-
`parameters.applicationRoles.size?`	`number`	-
`parameters.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.deleted?`	`boolean`	-
`parameters.displayName?`	`string`	-
`parameters.emailAddress?`	`string`	-
`parameters.expand?`	`string`	-
`parameters.groups?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }	-
`parameters.groups.callback?`	`Record`<`string`, `never`>	-
`parameters.groups.maxResults?`	`number`	-
`parameters.groups.pagingCallback?`	`Record`<`string`, `never`>	-
`parameters.groups.size?`	`number`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.key?`	`string`	-
`parameters.lastLoginTime?`	`string`	-
`parameters.locale?`	`string`	-
`parameters.name?`	`string`	-
`parameters.self?`	`string`	-
`parameters.timeZone?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.canMoveSubTask

canMoveSubTask: (parameters, options?) => Promise<boolean>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The parent issue's key or id
`options?`	`RequestOptions`	-

Returns

Promise<boolean>

issues.createIssue

createIssue: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  key?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `fields?`: `Record`<`string`, `any`>; `historyMetadata?`: { `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }; `properties?`: `object`[]; `transition?`: { `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }; `update?`: `Record`<`string`, `object`[]>; `updateHistory?`: `boolean`; }
`parameters.fields?`	`Record`<`string`, `any`>
`parameters.historyMetadata?`	{ `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }
`parameters.historyMetadata.activityDescription?`	`string`
`parameters.historyMetadata.activityDescriptionKey?`	`string`
`parameters.historyMetadata.actor?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }
`parameters.historyMetadata.actor.avatarUrl?`	`string`
`parameters.historyMetadata.actor.displayName?`	`string`
`parameters.historyMetadata.actor.displayNameKey?`	`string`
`parameters.historyMetadata.actor.id?`	`string`
`parameters.historyMetadata.actor.type?`	`string`
`parameters.historyMetadata.actor.url?`	`string`
`parameters.historyMetadata.cause?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }
`parameters.historyMetadata.cause.avatarUrl?`	`string`
`parameters.historyMetadata.cause.displayName?`	`string`
`parameters.historyMetadata.cause.displayNameKey?`	`string`
`parameters.historyMetadata.cause.id?`	`string`
`parameters.historyMetadata.cause.type?`	`string`
`parameters.historyMetadata.cause.url?`	`string`
`parameters.historyMetadata.description?`	`string`
`parameters.historyMetadata.descriptionKey?`	`string`
`parameters.historyMetadata.emailDescription?`	`string`
`parameters.historyMetadata.emailDescriptionKey?`	`string`
`parameters.historyMetadata.extraData?`	`Record`<`string`, `string`>
`parameters.historyMetadata.generator?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }
`parameters.historyMetadata.generator.avatarUrl?`	`string`
`parameters.historyMetadata.generator.displayName?`	`string`
`parameters.historyMetadata.generator.displayNameKey?`	`string`
`parameters.historyMetadata.generator.id?`	`string`
`parameters.historyMetadata.generator.type?`	`string`
`parameters.historyMetadata.generator.url?`	`string`
`parameters.historyMetadata.type?`	`string`
`parameters.properties?`	`object`[]
`parameters.transition?`	{ `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }
`parameters.transition.description?`	`string`
`parameters.transition.fields?`	`Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>
`parameters.transition.id?`	`string`
`parameters.transition.name?`	`string`
`parameters.transition.opsbarSequence?`	`number`
`parameters.transition.to?`	{ `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }
`parameters.transition.to.description?`	`string`
`parameters.transition.to.iconUrl?`	`string`
`parameters.transition.to.id?`	`string`
`parameters.transition.to.name?`	`string`
`parameters.transition.to.self?`	`string`
`parameters.transition.to.statusCategory?`	{ `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }
`parameters.transition.to.statusCategory.colorName?`	... \| ...
`parameters.transition.to.statusCategory.id?`	... \| ...
`parameters.transition.to.statusCategory.key?`	... \| ...
`parameters.transition.to.statusCategory.name?`	... \| ...
`parameters.transition.to.statusCategory.self?`	... \| ...
`parameters.transition.to.statusColor?`	`string`
`parameters.update?`	`Record`<`string`, `object`[]>
`parameters.updateHistory?`	`boolean`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; id?: string; key?: string; self?: string; }>

issues.createIssues

createIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  errors?: object[];
  issues?: object[];
}>;

Parameters

Parameter	Type
`parameters`	{ `issueUpdates?`: `object`[]; }
`parameters.issueUpdates?`	`object`[]
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; errors?: object[]; issues?: object[]; }>

issues.createOrUpdateRemoteIssueLink

createOrUpdateRemoteIssueLink: (parameters, options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `issueIdOrKey`: `string`; `object?`: { `icon?`: { `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }; `status?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }	-
`parameters.application?`	{ `name?`: `string`; `type?`: `string`; }	-
`parameters.application.name?`	`string`	-
`parameters.application.type?`	`string`	-
`parameters.globalId?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.object?`	{ `icon?`: { `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }; `status?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }	-
`parameters.object.icon?`	{ `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }	-
`parameters.object.icon.link?`	`string`	-
`parameters.object.icon.title?`	`string`	-
`parameters.object.icon.url16x16?`	`string`	-
`parameters.object.status?`	{ `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }	-
`parameters.object.status.icon?`	{ `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }	-
`parameters.object.status.icon.link?`	... \| ...	-
`parameters.object.status.icon.title?`	... \| ...	-
`parameters.object.status.icon.url16x16?`	... \| ...	-
`parameters.object.status.resolved?`	`boolean`	-
`parameters.object.summary?`	`string`	-
`parameters.object.title?`	`string`	-
`parameters.object.url?`	`string`	-
`parameters.relationship?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; }>

issues.createReciprocalRemoteIssueLink

createReciprocalRemoteIssueLink: (parameters, options?) => Promise<{
[key: string]: unknown;
  source?: {
   [key: string]: unknown;
  };
  target?: {
   [key: string]: unknown;
  };
}>;

Parameters

Parameter	Type
`parameters`	{ `source?`: { `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `object?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }; `target?`: { `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `object?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }; }
`parameters.source?`	{ `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `object?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }
`parameters.source.application?`	{ `name?`: `string`; `type?`: `string`; }
`parameters.source.application.name?`	`string`
`parameters.source.application.type?`	`string`
`parameters.source.globalId?`	`string`
`parameters.source.object?`	{ `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }
`parameters.source.object.icon?`	{ `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }
`parameters.source.object.icon.link?`	... \| ...
`parameters.source.object.icon.title?`	... \| ...
`parameters.source.object.icon.url16x16?`	... \| ...
`parameters.source.object.status?`	{ `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }
`parameters.source.object.status.icon?`	... \| ...
`parameters.source.object.status.resolved?`	... \| ... \| ...
`parameters.source.object.summary?`	`string`
`parameters.source.object.title?`	`string`
`parameters.source.object.url?`	`string`
`parameters.source.relationship?`	`string`
`parameters.target?`	{ `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `object?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }
`parameters.target.application?`	{ `name?`: `string`; `type?`: `string`; }
`parameters.target.application.name?`	`string`
`parameters.target.application.type?`	`string`
`parameters.target.globalId?`	`string`
`parameters.target.object?`	{ `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `status?`: { `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }
`parameters.target.object.icon?`	{ `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }
`parameters.target.object.icon.link?`	... \| ...
`parameters.target.object.icon.title?`	... \| ...
`parameters.target.object.icon.url16x16?`	... \| ...
`parameters.target.object.status?`	{ `icon?`: ... \| ...; `resolved?`: ... \| ... \| ...; }
`parameters.target.object.status.icon?`	... \| ...
`parameters.target.object.status.resolved?`	... \| ... \| ...
`parameters.target.object.summary?`	`string`
`parameters.target.object.title?`	`string`
`parameters.target.object.url?`	`string`
`parameters.target.relationship?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; source?: { [key: string]: unknown; }; target?: { [key: string]: unknown; }; }>

issues.deleteComment

deleteComment: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.id`	`string`	Comment id
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.deleteIssue

deleteIssue: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `deleteSubtasks?`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.deleteSubtasks?`	`string`	A String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.deleteIssueProperty

deleteIssueProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.propertyKey?`	`string`	The key of the property to remove
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.deleteRemoteIssueLinkByGlobalId

deleteRemoteIssueLinkByGlobalId: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `globalId`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.globalId`	`string`	Global id of the remote issue link
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.deleteRemoteIssueLinkById

deleteRemoteIssueLinkById: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `linkId`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.linkId?`	`string`	Id of the remote issue link
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.deleteWorklog

deleteWorklog: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `adjustEstimate?`: `string`; `id`: `string`; `increaseBy?`: `string`; `issueIdOrKey`: `string`; `newEstimate?`: `string`; }	-
`parameters.adjustEstimate?`	`string`	Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, manual, auto
`parameters.id?`	`string`	Id of the worklog to be deleted
`parameters.increaseBy?`	`string`	Required when 'manual' is selected for adjustEstimate. e.g. "2d"
`parameters.issueIdOrKey?`	`string`	A string containing the issue id or key the worklog belongs to
`parameters.newEstimate?`	`string`	Required when 'new' is selected for adjustEstimate. e.g. "2d"
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.doTransition

doTransition: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `fields?`: `Record`<`string`, `any`>; `historyMetadata?`: { `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }; `issueIdOrKey`: `string`; `properties?`: `object`[]; `transition?`: { `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }; `update?`: `Record`<`string`, `object`[]>; }	-
`parameters.fields?`	`Record`<`string`, `any`>	-
`parameters.historyMetadata?`	{ `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }	-
`parameters.historyMetadata.activityDescription?`	`string`	-
`parameters.historyMetadata.activityDescriptionKey?`	`string`	-
`parameters.historyMetadata.actor?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.actor.avatarUrl?`	`string`	-
`parameters.historyMetadata.actor.displayName?`	`string`	-
`parameters.historyMetadata.actor.displayNameKey?`	`string`	-
`parameters.historyMetadata.actor.id?`	`string`	-
`parameters.historyMetadata.actor.type?`	`string`	-
`parameters.historyMetadata.actor.url?`	`string`	-
`parameters.historyMetadata.cause?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.cause.avatarUrl?`	`string`	-
`parameters.historyMetadata.cause.displayName?`	`string`	-
`parameters.historyMetadata.cause.displayNameKey?`	`string`	-
`parameters.historyMetadata.cause.id?`	`string`	-
`parameters.historyMetadata.cause.type?`	`string`	-
`parameters.historyMetadata.cause.url?`	`string`	-
`parameters.historyMetadata.description?`	`string`	-
`parameters.historyMetadata.descriptionKey?`	`string`	-
`parameters.historyMetadata.emailDescription?`	`string`	-
`parameters.historyMetadata.emailDescriptionKey?`	`string`	-
`parameters.historyMetadata.extraData?`	`Record`<`string`, `string`>	-
`parameters.historyMetadata.generator?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.generator.avatarUrl?`	`string`	-
`parameters.historyMetadata.generator.displayName?`	`string`	-
`parameters.historyMetadata.generator.displayNameKey?`	`string`	-
`parameters.historyMetadata.generator.id?`	`string`	-
`parameters.historyMetadata.generator.type?`	`string`	-
`parameters.historyMetadata.generator.url?`	`string`	-
`parameters.historyMetadata.type?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.properties?`	`object`[]	-
`parameters.transition?`	{ `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }	-
`parameters.transition.description?`	`string`	-
`parameters.transition.fields?`	`Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>	-
`parameters.transition.id?`	`string`	-
`parameters.transition.name?`	`string`	-
`parameters.transition.opsbarSequence?`	`number`	-
`parameters.transition.to?`	{ `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }	-
`parameters.transition.to.description?`	`string`	-
`parameters.transition.to.iconUrl?`	`string`	-
`parameters.transition.to.id?`	`string`	-
`parameters.transition.to.name?`	`string`	-
`parameters.transition.to.self?`	`string`	-
`parameters.transition.to.statusCategory?`	{ `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }	-
`parameters.transition.to.statusCategory.colorName?`	... \| ...	-
`parameters.transition.to.statusCategory.id?`	... \| ...	-
`parameters.transition.to.statusCategory.key?`	... \| ...	-
`parameters.transition.to.statusCategory.name?`	... \| ...	-
`parameters.transition.to.statusCategory.self?`	... \| ...	-
`parameters.transition.to.statusColor?`	`string`	-
`parameters.update?`	`Record`<`string`, `object`[]>	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.editIssue

editIssue: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `fields?`: `Record`<`string`, `any`>; `historyMetadata?`: { `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }; `issueIdOrKey`: `string`; `notifyUsers?`: `string`; `properties?`: `object`[]; `transition?`: { `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }; `update?`: `Record`<`string`, `object`[]>; }	-
`parameters.fields?`	`Record`<`string`, `any`>	-
`parameters.historyMetadata?`	{ `activityDescription?`: `string`; `activityDescriptionKey?`: `string`; `actor?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `cause?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `description?`: `string`; `descriptionKey?`: `string`; `emailDescription?`: `string`; `emailDescriptionKey?`: `string`; `extraData?`: `Record`<`string`, `string`>; `generator?`: { `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }; `type?`: `string`; }	-
`parameters.historyMetadata.activityDescription?`	`string`	-
`parameters.historyMetadata.activityDescriptionKey?`	`string`	-
`parameters.historyMetadata.actor?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.actor.avatarUrl?`	`string`	-
`parameters.historyMetadata.actor.displayName?`	`string`	-
`parameters.historyMetadata.actor.displayNameKey?`	`string`	-
`parameters.historyMetadata.actor.id?`	`string`	-
`parameters.historyMetadata.actor.type?`	`string`	-
`parameters.historyMetadata.actor.url?`	`string`	-
`parameters.historyMetadata.cause?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.cause.avatarUrl?`	`string`	-
`parameters.historyMetadata.cause.displayName?`	`string`	-
`parameters.historyMetadata.cause.displayNameKey?`	`string`	-
`parameters.historyMetadata.cause.id?`	`string`	-
`parameters.historyMetadata.cause.type?`	`string`	-
`parameters.historyMetadata.cause.url?`	`string`	-
`parameters.historyMetadata.description?`	`string`	-
`parameters.historyMetadata.descriptionKey?`	`string`	-
`parameters.historyMetadata.emailDescription?`	`string`	-
`parameters.historyMetadata.emailDescriptionKey?`	`string`	-
`parameters.historyMetadata.extraData?`	`Record`<`string`, `string`>	-
`parameters.historyMetadata.generator?`	{ `avatarUrl?`: `string`; `displayName?`: `string`; `displayNameKey?`: `string`; `id?`: `string`; `type?`: `string`; `url?`: `string`; }	-
`parameters.historyMetadata.generator.avatarUrl?`	`string`	-
`parameters.historyMetadata.generator.displayName?`	`string`	-
`parameters.historyMetadata.generator.displayNameKey?`	`string`	-
`parameters.historyMetadata.generator.id?`	`string`	-
`parameters.historyMetadata.generator.type?`	`string`	-
`parameters.historyMetadata.generator.url?`	`string`	-
`parameters.historyMetadata.type?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.notifyUsers?`	`string`	Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
`parameters.properties?`	`object`[]	-
`parameters.transition?`	{ `description?`: `string`; `fields?`: `Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>; `id?`: `string`; `name?`: `string`; `opsbarSequence?`: `number`; `to?`: { `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }; }	-
`parameters.transition.description?`	`string`	-
`parameters.transition.fields?`	`Record`<`string`, { `allowedValues?`: ...[]; `autoCompleteUrl?`: `string`; `defaultValue?`: `Record`<..., ...>; `fieldId?`: `string`; `hasDefaultValue?`: `boolean`; `name?`: `string`; `operations?`: ...[]; `required?`: `boolean`; `schema?`: { `custom?`: ...; `customId?`: ...; `items?`: ...; `system?`: ...; `type?`: ...; }; }>	-
`parameters.transition.id?`	`string`	-
`parameters.transition.name?`	`string`	-
`parameters.transition.opsbarSequence?`	`number`	-
`parameters.transition.to?`	{ `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `statusCategory?`: { `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }; `statusColor?`: `string`; }	-
`parameters.transition.to.description?`	`string`	-
`parameters.transition.to.iconUrl?`	`string`	-
`parameters.transition.to.id?`	`string`	-
`parameters.transition.to.name?`	`string`	-
`parameters.transition.to.self?`	`string`	-
`parameters.transition.to.statusCategory?`	{ `colorName?`: ... \| ...; `id?`: ... \| ...; `key?`: ... \| ...; `name?`: ... \| ...; `self?`: ... \| ...; }	-
`parameters.transition.to.statusCategory.colorName?`	... \| ...	-
`parameters.transition.to.statusCategory.id?`	... \| ...	-
`parameters.transition.to.statusCategory.key?`	... \| ...	-
`parameters.transition.to.statusCategory.name?`	... \| ...	-
`parameters.transition.to.statusCategory.self?`	... \| ...	-
`parameters.transition.to.statusColor?`	`string`	-
`parameters.update?`	`Record`<`string`, `object`[]>	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.estimateIssueForBoard

estimateIssueForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  fieldId?: string;
  value?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId?`: `number`; `issueIdOrKey`: `string`; `value?`: `string`; }	-
`parameters.boardId?`	`number`	The id of the board required to determine which field is used for estimation.
`parameters.issueIdOrKey?`	`string`	The Id or key of the requested issue.
`parameters.value?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; fieldId?: string; value?: Record<string, any>; }>

issues.getAgileIssue

getAgileIssue: (parameters, options?) => Promise<{
[key: string]: unknown;
  changelog?: {
   [key: string]: unknown;
     histories?: object[];
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  editmeta?: {
   [key: string]: unknown;
     fields?: Record<string, {
      [key: string]: unknown;
        allowedValues?: ... | ...;
        autoCompleteUrl?: ... | ...;
        defaultValue?: ... | ...;
        fieldId?: ... | ...;
        hasDefaultValue?: ... | ... | ...;
        name?: ... | ...;
        operations?: ... | ...;
        required?: ... | ... | ...;
        schema?: ... | ...;
     }>;
  };
  fields?: Record<string, any>;
  fieldsToInclude?: {
   [key: string]: unknown;
     included?: string[];
  };
  id?: string;
  key?: string;
  names?: Record<string, string>;
  operations?: {
   [key: string]: unknown;
     linkGroups?: LinkGroup[];
  };
  properties?: {
   [key: string]: unknown;
     properties?: Record<string, string>;
  };
  renderedFields?: Record<string, any> | null;
  schema?: Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
  }>;
  self?: string;
  transitionBeans?: object[];
  transitions?: object[];
  versionedRepresentations?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `issueIdOrKey`: `string`; `updateHistory?`: `boolean`; }	-
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.issueIdOrKey?`	`string`	The Id or key of the requested issue.
`parameters.updateHistory?`	`boolean`	A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; changelog?: { [key: string]: unknown; histories?: object[]; maxResults?: number; startAt?: number; total?: number; }; editmeta?: { [key: string]: unknown; fields?: Record<string, { [key: string]: unknown; allowedValues?: ... | ...; autoCompleteUrl?: ... | ...; defaultValue?: ... | ...; fieldId?: ... | ...; hasDefaultValue?: ... | ... | ...; name?: ... | ...; operations?: ... | ...; required?: ... | ... | ...; schema?: ... | ...; }>; }; fields?: Record<string, any>; fieldsToInclude?: { [key: string]: unknown; included?: string[]; }; id?: string; key?: string; names?: Record<string, string>; operations?: { [key: string]: unknown; linkGroups?: LinkGroup[]; }; properties?: { [key: string]: unknown; properties?: Record<string, string>; }; renderedFields?: Record<string, any> | null; schema?: Record<string, { [key: string]: unknown; custom?: string; customId?: number; items?: string; system?: string; type?: string; }>; self?: string; transitionBeans?: object[]; transitions?: object[]; versionedRepresentations?: Record<string, any>; }>

issues.getComment

getComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  body?: string;
  created?: string;
  id?: string;
  properties?: object[];
  renderedBody?: string;
  self?: string;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `id`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.expand?`	`string`	Optional flags: renderedBody (provides body rendered in HTML)
`parameters.id?`	`string`	Comment id
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

issues.getComments

getComments: (parameters, options?) => Promise<{
[key: string]: unknown;
  comments?: object[];
  maxResults?: number;
  startAt?: number;
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `issueIdOrKey`: `string`; `maxResults?`: `string`; `orderBy?`: `string`; `startAt?`: `string`; }	-
`parameters.expand?`	`string`	Optional flags: renderedBody (provides body rendered in HTML)
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.maxResults?`	`string`	How many results on the page should be included. Defaults to 50.
`parameters.orderBy?`	`string`	Ordering of the results
`parameters.startAt?`	`string`	The page offset, if not specified then defaults to 0
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; comments?: object[]; maxResults?: number; startAt?: number; total?: number; }>

issues.getCreateIssueMetaFields

getCreateIssueMetaFields: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueTypeId`: `string`; `maxResults?`: `string`; `projectIdOrKey`: `string`; `startAt?`: `string`; }	-
`parameters.issueTypeId`	`string`	Issue type id
`parameters.maxResults?`	`string`	How many results on the page should be included
`parameters.projectIdOrKey?`	`string`	Project id or key
`parameters.startAt?`	`string`	The page offset
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issues.getCreateIssueMetaProjectIssueTypes

getCreateIssueMetaProjectIssueTypes: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `maxResults?`: `string`; `projectIdOrKey`: `string`; `startAt?`: `string`; }	-
`parameters.maxResults?`	`string`	How many results on the page should be included
`parameters.projectIdOrKey?`	`string`	Project id or key
`parameters.startAt?`	`string`	The page offset
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issues.getEditIssueMeta

getEditIssueMeta: (parameters, options?) => Promise<{
[key: string]: unknown;
  fields?: Record<string, {
   [key: string]: unknown;
     allowedValues?: Record<..., ...>[];
     autoCompleteUrl?: string;
     defaultValue?: Record<string, any>;
     fieldId?: string;
     hasDefaultValue?: boolean;
     name?: string;
     operations?: string[];
     required?: boolean;
     schema?: {
      [key: string]: unknown;
        custom?: ... | ...;
        customId?: ... | ...;
        items?: ... | ...;
        system?: ... | ...;
        type?: ... | ...;
     };
  }>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; fields?: Record<string, { [key: string]: unknown; allowedValues?: Record<..., ...>[]; autoCompleteUrl?: string; defaultValue?: Record<string, any>; fieldId?: string; hasDefaultValue?: boolean; name?: string; operations?: string[]; required?: boolean; schema?: { [key: string]: unknown; custom?: ... | ...; customId?: ... | ...; items?: ... | ...; system?: ... | ...; type?: ... | ...; }; }>; }>

issues.getIssue

getIssue: (parameters, options?) => Promise<{
[key: string]: unknown;
  changelog?: {
   [key: string]: unknown;
     histories?: object[];
     maxResults?: number;
     startAt?: number;
     total?: number;
  };
  editmeta?: {
   [key: string]: unknown;
     fields?: Record<string, {
      [key: string]: unknown;
        allowedValues?: ... | ...;
        autoCompleteUrl?: ... | ...;
        defaultValue?: ... | ...;
        fieldId?: ... | ...;
        hasDefaultValue?: ... | ... | ...;
        name?: ... | ...;
        operations?: ... | ...;
        required?: ... | ... | ...;
        schema?: ... | ...;
     }>;
  };
  fields?: Record<string, any>;
  fieldsToInclude?: {
   [key: string]: unknown;
     included?: string[];
  };
  id?: string;
  key?: string;
  names?: Record<string, string>;
  operations?: {
   [key: string]: unknown;
     linkGroups?: LinkGroup[];
  };
  properties?: {
   [key: string]: unknown;
     properties?: Record<string, string>;
  };
  renderedFields?: Record<string, any> | null;
  schema?: Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
  }>;
  self?: string;
  transitionBeans?: object[];
  transitions?: object[];
  versionedRepresentations?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `fields?`: `string`; `issueIdOrKey`: `string`; `properties?`: `string`; `updateHistory?`: `string`; }	-
`parameters.expand?`	`string`	The expand param is used to include, hidden by default, parts of response. This can be used to include: renderedFields, names, schema, transitions, operations, editmeta, changelog, versionedRepresentations.
`parameters.fields?`	`string`	The list of fields to return for the issue. By default, all fields are returned.
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.properties?`	`string`	The list of properties to return for the issue. By default no properties are returned.
`parameters.updateHistory?`	`string`	The updateHistory param adds the issues retrieved by this method to the current user's issue history
`options?`	`RequestOptions`	-

Returns

issues.getIssueEstimationForBoard

getIssueEstimationForBoard: (parameters, options?) => Promise<{
[key: string]: unknown;
  fieldId?: string;
  value?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `boardId?`: `number`; `issueIdOrKey`: `string`; }	-
`parameters.boardId?`	`number`	The id of the board required to determine which field is used for estimation.
`parameters.issueIdOrKey?`	`string`	The Id or key of the requested issue.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; fieldId?: string; value?: Record<string, any>; }>

issues.getIssuePickerResource

getIssuePickerResource: (parameters?, options?) => Promise<{
[key: string]: unknown;
  sections?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `currentIssueKey?`: `string`; `currentJQL?`: `string`; `currentProjectId?`: `string`; `query?`: `string`; `showSubTaskParent?`: `string`; `showSubTasks?`: `string`; }	-
`parameters.currentIssueKey?`	`string`	The key of the issue in context of which the request is executed
`parameters.currentJQL?`	`string`	The JQL in context of which the request is executed
`parameters.currentProjectId?`	`string`	The id of the project in context of which the request is executed
`parameters.query?`	`string`	The query
`parameters.showSubTaskParent?`	`string`	If set to false and request is executed in context of a subtask, the parent issue will not be included in the auto-completion result, even if it matches the query
`parameters.showSubTasks?`	`string`	If set to false, subtasks will not be included in the list
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; sections?: object[]; }>

issues.getIssueProperty

getIssueProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.propertyKey?`	`string`	The key of the property to return
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issues.getIssuePropertyKeys

getIssuePropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

issues.getIssueWatchers

getIssueWatchers: (parameters, options?) => Promise<{
[key: string]: unknown;
  isWatching?: boolean;
  self?: string;
  watchCount?: number;
  watchers?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isWatching?: boolean; self?: string; watchCount?: number; watchers?: object[]; }>

issues.getIssueWorklog

getIssueWorklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  maxResults?: number;
  startAt?: number;
  total?: number;
  worklogs?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; maxResults?: number; startAt?: number; total?: number; worklogs?: object[]; }>

issues.getPinnedComments

getPinnedComments: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issues.getRemoteIssueLinkById

getRemoteIssueLinkById: (parameters, options?) => Promise<{
[key: string]: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `linkId`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.linkId?`	`string`	Id of the remote issue link
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; }>

issues.getRemoteIssueLinks

getRemoteIssueLinks: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `globalId?`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.globalId?`	`string`	Global id of the remote issue link
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issues.getSubTasks

getSubTasks: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The parent issue's key or id
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issues.getTransitions

getTransitions: (parameters, options?) => Promise<{
[key: string]: unknown;
  transitions?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `transitionId?`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.transitionId?`	`string`	Transition id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; transitions?: object[]; }>

issues.getVotes

getVotes: (parameters, options?) => Promise<{
[key: string]: unknown;
  hasVoted?: boolean;
  self?: string;
  voters?: object[];
  votes?: number;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; hasVoted?: boolean; self?: string; voters?: object[]; votes?: number; }>

issues.getWorklog

getWorklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  comment?: string;
  created?: string;
  id?: string;
  issueId?: string;
  self?: string;
  started?: string;
  timeSpent?: string;
  timeSpentSeconds?: number;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.id`	`string`	Worklog id
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; comment?: string; created?: string; id?: string; issueId?: string; self?: string; started?: string; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { [key: string]: unknown; type?: "role" | "group" | string & object; value?: string; }; }>

issues.moveSubTasks

moveSubTasks: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `current?`: `number`; `issueIdOrKey`: `string`; `original?`: `number`; }	-
`parameters.current?`	`number`	-
`parameters.issueIdOrKey?`	`string`	The parent issue's key or id
`parameters.original?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.notify

notify: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `htmlBody?`: `string`; `issueIdOrKey`: `string`; `restrict?`: { `groups?`: `object`[]; `permissions?`: `object`[]; }; `subject?`: `string`; `textBody?`: `string`; `to?`: { `assignee?`: `boolean`; `groups?`: `object`[]; `reporter?`: `boolean`; `users?`: `object`[]; `voters?`: `boolean`; `watchers?`: `boolean`; }; }	-
`parameters.htmlBody?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.restrict?`	{ `groups?`: `object`[]; `permissions?`: `object`[]; }	-
`parameters.restrict.groups?`	`object`[]	-
`parameters.restrict.permissions?`	`object`[]	-
`parameters.subject?`	`string`	-
`parameters.textBody?`	`string`	-
`parameters.to?`	{ `assignee?`: `boolean`; `groups?`: `object`[]; `reporter?`: `boolean`; `users?`: `object`[]; `voters?`: `boolean`; `watchers?`: `boolean`; }	-
`parameters.to.assignee?`	`boolean`	-
`parameters.to.groups?`	`object`[]	-
`parameters.to.reporter?`	`boolean`	-
`parameters.to.users?`	`object`[]	-
`parameters.to.voters?`	`boolean`	-
`parameters.to.watchers?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.rankIssues

rankIssues: (parameters, options?) => Promise<
  | {
[key: string]: unknown;
  entries?: object[];
}
| undefined>;

Parameters

Parameter	Type
`parameters`	{ `issues?`: `string`[]; `rankAfterIssue?`: `string`; `rankBeforeIssue?`: `string`; `rankCustomFieldId?`: `number`; }
`parameters.issues?`	`string`[]
`parameters.rankAfterIssue?`	`string`
`parameters.rankBeforeIssue?`	`string`
`parameters.rankCustomFieldId?`	`number`
`options?`	`RequestOptions`

Returns

Promise< | { [key: string]: unknown; entries?: object[]; } | undefined>

issues.removeVote

removeVote: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.removeWatcher

removeWatcher: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `username?`: `string`; `userName?`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.username?`	`string`	-
`parameters.userName?`	`string`	The name of the user to remove from the watcher list.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.restoreIssue

restoreIssue: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `notifyUsers?`: `string`; }	-
`parameters.issueIdOrKey`	`string`	Issue id or key
`parameters.notifyUsers?`	`string`	Send the email with notification that the issue was updated to users that watch it. Admin or project admin permissions are required to disable the notification.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.setIssueProperty

setIssueProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `issueIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.propertyKey?`	`string`	The key of the issue's property
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.setPinComment

setPinComment: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `boolean`; `id`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.body`	`boolean`	-
`parameters.id?`	`string`	Comment id
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.updateComment

updateComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  body?: string;
  created?: string;
  id?: string;
  properties?: object[];
  renderedBody?: string;
  self?: string;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `body?`: `string`; `created?`: `string`; `id?`: `string`; `properties?`: `object`[]; `renderedBody?`: `string`; `self?`: `string`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }; `expand?`: `string`; `id`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.body?`	{ `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `body?`: `string`; `created?`: `string`; `id?`: `string`; `properties?`: `object`[]; `renderedBody?`: `string`; `self?`: `string`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }	-
`parameters.body.author?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.author.active?`	`boolean`	-
`parameters.body.author.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.author.displayName?`	`string`	-
`parameters.body.author.emailAddress?`	`string`	-
`parameters.body.author.key?`	`string`	-
`parameters.body.author.name?`	`string`	-
`parameters.body.author.self?`	`string`	-
`parameters.body.author.timeZone?`	`string`	-
`parameters.body.body?`	`string`	-
`parameters.body.created?`	`string`	-
`parameters.body.id?`	`string`	-
`parameters.body.properties?`	`object`[]	-
`parameters.body.renderedBody?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.body.updateAuthor?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.updateAuthor.active?`	`boolean`	-
`parameters.body.updateAuthor.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.updateAuthor.displayName?`	`string`	-
`parameters.body.updateAuthor.emailAddress?`	`string`	-
`parameters.body.updateAuthor.key?`	`string`	-
`parameters.body.updateAuthor.name?`	`string`	-
`parameters.body.updateAuthor.self?`	`string`	-
`parameters.body.updateAuthor.timeZone?`	`string`	-
`parameters.body.updated?`	`string`	-
`parameters.body.visibility?`	{ `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }	-
`parameters.body.visibility.type?`	`"role"` \| `"group"` \| `string` & `object`	-
`parameters.body.visibility.value?`	`string`	-
`parameters.expand?`	`string`	Optional flags: renderedBody (provides body rendered in HTML)
`parameters.id?`	`string`	Comment id
`parameters.issueIdOrKey?`	`string`	Issue id or key
`options?`	`RequestOptions`	-

Returns

issues.updateRemoteIssueLink

updateRemoteIssueLink: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `application?`: { `name?`: `string`; `type?`: `string`; }; `globalId?`: `string`; `issueIdOrKey`: `string`; `linkId`: `string`; `object?`: { `icon?`: { `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }; `status?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }; `relationship?`: `string`; }	-
`parameters.application?`	{ `name?`: `string`; `type?`: `string`; }	-
`parameters.application.name?`	`string`	-
`parameters.application.type?`	`string`	-
`parameters.globalId?`	`string`	-
`parameters.issueIdOrKey?`	`string`	Issue id or key
`parameters.linkId?`	`string`	Id of the remote issue link
`parameters.object?`	{ `icon?`: { `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }; `status?`: { `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }; `summary?`: `string`; `title?`: `string`; `url?`: `string`; }	-
`parameters.object.icon?`	{ `link?`: `string`; `title?`: `string`; `url16x16?`: `string`; }	-
`parameters.object.icon.link?`	`string`	-
`parameters.object.icon.title?`	`string`	-
`parameters.object.icon.url16x16?`	`string`	-
`parameters.object.status?`	{ `icon?`: { `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }; `resolved?`: `boolean`; }	-
`parameters.object.status.icon?`	{ `link?`: ... \| ...; `title?`: ... \| ...; `url16x16?`: ... \| ...; }	-
`parameters.object.status.icon.link?`	... \| ...	-
`parameters.object.status.icon.title?`	... \| ...	-
`parameters.object.status.icon.url16x16?`	... \| ...	-
`parameters.object.status.resolved?`	`boolean`	-
`parameters.object.summary?`	`string`	-
`parameters.object.title?`	`string`	-
`parameters.object.url?`	`string`	-
`parameters.relationship?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

issues.updateWorklog

updateWorklog: (parameters, options?) => Promise<{
[key: string]: unknown;
  author?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  comment?: string;
  created?: string;
  id?: string;
  issueId?: string;
  self?: string;
  started?: string;
  timeSpent?: string;
  timeSpentSeconds?: number;
  updateAuthor?: {
   [key: string]: unknown;
     active?: boolean;
     avatarUrls?: Record<string, string>;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  updated?: string;
  visibility?: {
   [key: string]: unknown;
     type?: "role" | "group" | string & object;
     value?: string;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `adjustEstimate?`: `string`; `body?`: { `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `comment?`: `string`; `created?`: `string`; `id?`: `string`; `issueId?`: `string`; `self?`: `string`; `started?`: `string`; `timeSpent?`: `string`; `timeSpentSeconds?`: `number`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }; `id`: `string`; `issueIdOrKey`: `string`; `newEstimate?`: `string`; }	-
`parameters.adjustEstimate?`	`string`	Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are: new, leave, auto
`parameters.body?`	{ `author?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `comment?`: `string`; `created?`: `string`; `id?`: `string`; `issueId?`: `string`; `self?`: `string`; `started?`: `string`; `timeSpent?`: `string`; `timeSpentSeconds?`: `number`; `updateAuthor?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `updated?`: `string`; `visibility?`: { `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }; }	-
`parameters.body.author?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.author.active?`	`boolean`	-
`parameters.body.author.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.author.displayName?`	`string`	-
`parameters.body.author.emailAddress?`	`string`	-
`parameters.body.author.key?`	`string`	-
`parameters.body.author.name?`	`string`	-
`parameters.body.author.self?`	`string`	-
`parameters.body.author.timeZone?`	`string`	-
`parameters.body.comment?`	`string`	-
`parameters.body.created?`	`string`	-
`parameters.body.id?`	`string`	-
`parameters.body.issueId?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.body.started?`	`string`	-
`parameters.body.timeSpent?`	`string`	-
`parameters.body.timeSpentSeconds?`	`number`	-
`parameters.body.updateAuthor?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.updateAuthor.active?`	`boolean`	-
`parameters.body.updateAuthor.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.updateAuthor.displayName?`	`string`	-
`parameters.body.updateAuthor.emailAddress?`	`string`	-
`parameters.body.updateAuthor.key?`	`string`	-
`parameters.body.updateAuthor.name?`	`string`	-
`parameters.body.updateAuthor.self?`	`string`	-
`parameters.body.updateAuthor.timeZone?`	`string`	-
`parameters.body.updated?`	`string`	-
`parameters.body.visibility?`	{ `type?`: `"role"` \| `"group"` \| `string` & `object`; `value?`: `string`; }	-
`parameters.body.visibility.type?`	`"role"` \| `"group"` \| `string` & `object`	-
`parameters.body.visibility.value?`	`string`	-
`parameters.id?`	`string`	Id of the worklog to be updated
`parameters.issueIdOrKey?`	`string`	A string containing the issue id or key the worklog belongs to
`parameters.newEstimate?`	`string`	Required when 'new' is selected for adjustEstimate
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; author?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; comment?: string; created?: string; id?: string; issueId?: string; self?: string; started?: string; timeSpent?: string; timeSpentSeconds?: number; updateAuthor?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<string, string>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; updated?: string; visibility?: { [key: string]: unknown; type?: "role" | "group" | string & object; value?: string; }; }>

issueSearch

issueSearch: object;

issueSearch.getError

getError: (options?) => Promise<
  | {
[key: string]: unknown;
  errorStringI18n?: string;
}
| undefined>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise< | { [key: string]: unknown; errorStringI18n?: string; } | undefined>

issueSearch.search

search: (parameters?, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue
`parameters.jql?`	`string`	A JQL query string
`parameters.maxResults?`	`number`	The maximum number of issues to return (defaults to 50)
`parameters.startAt?`	`number`	The index of the first issue to return (0-based)
`parameters.validateQuery?`	`boolean`	Whether to validate the JQL query
`options?`	`RequestOptions`	-

Returns

issueSearch.searchUsingSearchRequest

searchUsingSearchRequest: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type
`parameters`	{ `expand?`: `string`[]; `fields?`: `string`[]; `jql?`: `string`; `maxResults?`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }
`parameters.expand?`	`string`[]
`parameters.fields?`	`string`[]
`parameters.jql?`	`string`
`parameters.maxResults?`	`number`
`parameters.startAt?`	`number`
`parameters.validateQuery?`	`boolean`
`options?`	`RequestOptions`

Returns

issueSecurityLevel

issueSecurityLevel: object;

issueSecurityLevel.getIssueSecurityLevel

getIssueSecurityLevel: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	An issue security level id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

issueSecuritySchemes

issueSecuritySchemes: object;

issueSecuritySchemes.getIssueSecurityScheme

getIssueSecurityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultSecurityLevelId?: number;
  description?: string;
  id?: number;
  levels?: object[];
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The issue security scheme id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>

issueSecuritySchemes.getIssueSecuritySchemes

getIssueSecuritySchemes: (options?) => Promise<{
[key: string]: unknown;
  issueSecuritySchemes?: object[];
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; issueSecuritySchemes?: object[]; }>

issueTypes

issueTypes: object;

issueTypes.createIssueType

createIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  avatarId?: number;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  subtask?: boolean;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `name?`: `string`; `type?`: `"standard"` \| `string` & `object` \| `"subtask"`; }
`parameters.description?`	`string`
`parameters.name?`	`string`
`parameters.type?`	`"standard"` \| `string` & `object` \| `"subtask"`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>

issueTypes.createIssueTypeAvatarFromTemporary

createIssueTypeAvatarFromTemporary: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cropperOffsetX?`: `number`; `cropperOffsetY?`: `number`; `cropperWidth?`: `number`; `id`: `string`; `needsCropping?`: `boolean`; `url?`: `string`; }	-
`parameters.cropperOffsetX?`	`number`	-
`parameters.cropperOffsetY?`	`number`	-
`parameters.cropperWidth?`	`number`	-
`parameters.id?`	`string`	The issue type id.
`parameters.needsCropping?`	`boolean`	-
`parameters.url?`	`string`	-
`options?`	`RequestOptions`	-

Returns

issueTypes.deleteIssueType

deleteIssueType: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `alternativeIssueTypeId?`: `string`; `id`: `string`; }	-
`parameters.alternativeIssueTypeId?`	`string`	The id of an issue type to which issues associated with the removed issue type will be migrated.
`parameters.id?`	`string`	The issue type id.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypes.deleteIssueTypeProperty

deleteIssueTypeProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueTypeId`: `string`; `propertyKey`: `string`; }	-
`parameters.issueTypeId`	`string`	The issue type from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypes.getAlternativeIssueTypes

getAlternativeIssueTypes: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The issue type id.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issueTypes.getIssueAllTypes

getIssueAllTypes: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

issueTypes.getIssueType

getIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  avatarId?: number;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  subtask?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	The issue type id.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>

issueTypes.getIssueTypeProperty

getIssueTypeProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueTypeId`: `string`; `propertyKey`: `string`; }	-
`parameters.issueTypeId`	`string`	The issue type from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

issueTypes.getIssueTypePropertyKeys

getIssueTypePropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueTypeId`: `string`; }	-
`parameters.issueTypeId`	`string`	The issue type from which the keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

issueTypes.getPaginatedIssueTypes

getPaginatedIssueTypes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `projectIds?`: `number`[]; `query?`: `string`; `startAt?`: `number`; `X-Requested-With?`: `string`; }	-
`parameters.maxResults?`	`number`	The maximum number of issue types to return.
`parameters.projectIds?`	`number`[]	The set of project ids to filter issue types.
`parameters.query?`	`string`	The string that issue type names will be matched with.
`parameters.startAt?`	`number`	The index of the first issue type to return.
`parameters.X-Requested-With?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

issueTypes.setIssueTypeProperty

setIssueTypeProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `issueTypeId`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.issueTypeId?`	`string`	The issue type on which the property will be set.
`parameters.propertyKey?`	`string`	The key of the issue type's property. The maximum length of the key is 255 bytes
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypes.storeTemporaryIssueTypeAvatarUsingMultiPart

storeTemporaryIssueTypeAvatarUsingMultiPart: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `avatar`: \| `AttachmentInput` \| `AttachmentInput`[]; `id`: `string`; }	-
`parameters.avatar`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.id?`	`string`	The issue type id.
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

issueTypes.updateIssueType

updateIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  avatarId?: number;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  subtask?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `avatarId?`: `number`; `description?`: `string`; `id`: `string`; `name?`: `string`; }	-
`parameters.avatarId?`	`number`	-
`parameters.description?`	`string`	-
`parameters.id?`	`string`	The issue type id.
`parameters.name?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>

issueTypeSchemes

issueTypeSchemes: object;

issueTypeSchemes.addProjectAssociationsToScheme

addProjectAssociationsToScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `idsOrKeys?`: `string`[]; `schemeId`: `string`; }	-
`parameters.idsOrKeys?`	`string`[]	-
`parameters.schemeId?`	`string`	The id of the issue type scheme whose project associations we're adding to.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypeSchemes.createIssueTypeScheme

createIssueTypeScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultIssueType?: {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  };
  description?: string;
  expand?: string;
  id?: string;
  issueTypes?: object[];
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `defaultIssueTypeId?`: `string`; `description?`: `string`; `issueTypeIds?`: `string`[]; `issueTypeIDs?`: `string`[]; `name?`: `string`; }
`parameters.defaultIssueTypeId?`	`string`
`parameters.description?`	`string`
`parameters.issueTypeIds?`	`string`[]
`parameters.issueTypeIDs?`	`string`[]
`parameters.name?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; defaultIssueType?: { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }; description?: string; expand?: string; id?: string; issueTypes?: object[]; name?: string; self?: string; }>

issueTypeSchemes.deleteIssueTypeScheme

deleteIssueTypeScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `string`; }	-
`parameters.schemeId`	`string`	The id of the issue type scheme to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypeSchemes.getAllIssueTypeSchemes

getAllIssueTypeSchemes: (options?) => Promise<{
[key: string]: unknown;
  schemes?: object[];
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; schemes?: object[]; }>

issueTypeSchemes.getAssociatedProjects

getAssociatedProjects: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `schemeId`: `string`; }	-
`parameters.expand?`	`string`	-
`parameters.schemeId?`	`string`	Id of the issue type scheme whose projects we're accessing
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

issueTypeSchemes.getIssueTypeScheme

getIssueTypeScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultIssueType?: {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  };
  description?: string;
  expand?: string;
  id?: string;
  issueTypes?: object[];
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `string`; }	-
`parameters.schemeId`	`string`	A String containing an issue type scheme's id.
`options?`	`RequestOptions`	-

Returns

issueTypeSchemes.removeAllProjectAssociations

removeAllProjectAssociations: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `string`; }	-
`parameters.schemeId`	`string`	The id of the issue type scheme whose project associations we're removing
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypeSchemes.removeProjectAssociation

removeProjectAssociation: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `projIdOrKey`: `string`; `schemeId`: `string`; }	-
`parameters.projIdOrKey`	`string`	The id or key of the project that is to be un-associated with the issue type scheme
`parameters.schemeId?`	`string`	The id of the issue type scheme whose project association we're removing
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypeSchemes.setProjectAssociationsForScheme

setProjectAssociationsForScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `idsOrKeys?`: `string`[]; `schemeId`: `string`; }	-
`parameters.idsOrKeys?`	`string`[]	-
`parameters.schemeId?`	`string`	The id of the issue type scheme whose project associations we're replacing.
`options?`	`RequestOptions`	-

Returns

Promise<void>

issueTypeSchemes.updateIssueTypeScheme

updateIssueTypeScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultIssueType?: {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  };
  description?: string;
  expand?: string;
  id?: string;
  issueTypes?: object[];
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `defaultIssueTypeId?`: `string`; `description?`: `string`; `issueTypeIds?`: `string`[]; `issueTypeIDs?`: `string`[]; `name?`: `string`; `schemeId`: `string`; }	-
`parameters.defaultIssueTypeId?`	`string`	-
`parameters.description?`	`string`	-
`parameters.issueTypeIds?`	`string`[]	-
`parameters.issueTypeIDs?`	`string`[]	-
`parameters.name?`	`string`	-
`parameters.schemeId?`	`string`	The id of the issue type scheme to update.
`options?`	`RequestOptions`	-

Returns

issueWorklogs

issueWorklogs: object;

issueWorklogs.getIdsOfWorklogsDeletedSince

getIdsOfWorklogsDeletedSince: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLastPage?: boolean;
  lastPage?: boolean;
  nextPage?: string;
  self?: string;
  since?: number;
  until?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `since?`: `number`; }	-
`parameters.since?`	`number`	A date time in unix timestamp format since when deleted worklogs will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLastPage?: boolean; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>

issueWorklogs.getIdsOfWorklogsModifiedSince

getIdsOfWorklogsModifiedSince: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLastPage?: boolean;
  lastPage?: boolean;
  nextPage?: string;
  self?: string;
  since?: number;
  until?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `since?`: `number`; }	-
`parameters.since?`	`number`	A date time in unix timestamp format since when updated worklogs will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLastPage?: boolean; lastPage?: boolean; nextPage?: string; self?: string; since?: number; until?: number; values?: object[]; }>

issueWorklogs.getWorklogsForIds

getWorklogsForIds: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `ids?`: `number`[]; }	-
`parameters.ids?`	`number`[]	List of worklog ids
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

jiraSettings

jiraSettings: object;

jiraSettings.getIssueNavigatorDefaultColumns

getIssueNavigatorDefaultColumns: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

jiraSettings.setBaseURL

setBaseURL: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `body?`: `string`; }
`parameters.body?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

jiraSettings.setIssueNavigatorDefaultColumnsForm

setIssueNavigatorDefaultColumnsForm: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `columns?`: `string`[]; }
`parameters.columns?`	`string`[]
`options?`	`RequestOptions`

Returns

Promise<void>

jql

jql: object;

jql.getAutoComplete

getAutoComplete: (options?) => Promise<{
[key: string]: unknown;
  jqlReservedWords?: string[];
  visibleFieldNames?: object[];
  visibleFunctionNames?: object[];
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; jqlReservedWords?: string[]; visibleFieldNames?: object[]; visibleFunctionNames?: object[]; }>

jql.getFieldAutoCompleteForQueryString

getFieldAutoCompleteForQueryString: (parameters?, options?) => Promise<{
[key: string]: unknown;
  results?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `fieldName?`: `string`; `fieldValue?`: `string`; `predicateName?`: `string`; `predicateValue?`: `string`; }	-
`parameters.fieldName?`	`string`	The field name for which the suggestions are generated.
`parameters.fieldValue?`	`string`	The portion of the field value that has already been provided by the user.
`parameters.predicateName?`	`string`	The predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".
`parameters.predicateValue?`	`string`	The portion of the predicate value that has already been provided by the user.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; results?: object[]; }>

licenseValidator

licenseValidator: object;

licenseValidator.validate

validate: (parameters, options?) => Promise<{
[key: string]: unknown;
  errors?: Record<string, string>;
  licenseString?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `body`: `string`; }
`parameters.body`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; errors?: Record<string, string>; licenseString?: string; }>

monitoring

monitoring: object;

monitoring.areMetricsExposed

areMetricsExposed: (options?) => Promise<boolean>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<boolean>

monitoring.getAvailableMetrics

getAvailableMetrics: (options?) => Promise<string[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<string[]>

monitoring.isAppMonitoringEnabled

isAppMonitoringEnabled: (options?) => Promise<{
[key: string]: unknown;
  enabled?: boolean;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; enabled?: boolean; }>

monitoring.isIpdMonitoringEnabled

isIpdMonitoringEnabled: (options?) => Promise<{
[key: string]: unknown;
  enabled?: boolean;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; enabled?: boolean; }>

monitoring.setAppMonitoringEnabled

setAppMonitoringEnabled: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `enabled?`: `boolean`; }
`parameters.enabled?`	`boolean`
`options?`	`RequestOptions`

Returns

Promise<void>

monitoring.setIpdMonitoringEnabled

setIpdMonitoringEnabled: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `enabled?`: `boolean`; }
`parameters.enabled?`	`boolean`
`options?`	`RequestOptions`

Returns

Promise<void>

monitoring.start

start: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

monitoring.stop

stop: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

myPreferences

myPreferences: object;

myPreferences.getPreference

getPreference: (parameters?, options?) => Promise<string>;

Parameters

Parameter	Type	Description
`parameters?`	{ `key?`: `string`; }	-
`parameters.key?`	`string`	Key of the preference to be returned.
`options?`	`RequestOptions`	-

Returns

Promise<string>

myPreferences.removePreference

removePreference: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `key?`: `string`; }	-
`parameters.key?`	`string`	Key of the preference to be removed.
`options?`	`RequestOptions`	-

Returns

Promise<void>

myPreferences.setPreference

setPreference: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `key?`: `string`; }	-
`parameters.body?`	`string`	-
`parameters.key?`	`string`	Key of the preference to be set.
`options?`	`RequestOptions`	-

Returns

Promise<void>

myself

myself: object;

myself.changeMyPassword

changeMyPassword: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `currentPassword?`: `string`; `password?`: `string`; }
`parameters.currentPassword?`	`string`
`parameters.password?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

myself.getCurrentUser

getCurrentUser: (options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; maxResults?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }>

myself.updateCurrentUser

updateCurrentUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationKeys?: string[];
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  notification?: string;
  password?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `active?`: `boolean`; `applicationKeys?`: `string`[]; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `notification?`: `string`; `password?`: `string`; `self?`: `string`; }
`parameters.active?`	`boolean`
`parameters.applicationKeys?`	`string`[]
`parameters.displayName?`	`string`
`parameters.emailAddress?`	`string`
`parameters.key?`	`string`
`parameters.name?`	`string`
`parameters.notification?`	`string`
`parameters.password?`	`string`
`parameters.self?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationKeys?: string[]; displayName?: string; emailAddress?: string; key?: string; name?: string; notification?: string; password?: string; self?: string; }>

password

password: object;

password.getPasswordPolicy

getPasswordPolicy: (parameters?, options?) => Promise<string[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `hasOldPassword?`: `boolean`; }	-
`parameters.hasOldPassword?`	`boolean`	Whether or not the user will be required to enter their current password. Use false (the default) if this is a new user or if an administrator is forcibly changing another user's password.
`options?`	`RequestOptions`	-

Returns

Promise<string[]>

password.policyCheckCreateUser

policyCheckCreateUser: (parameters, options?) => Promise<string[]>;

Parameters

Parameter	Type
`parameters`	{ `displayName?`: `string`; `emailAddress?`: `string`; `password?`: `string`; `username?`: `string`; }
`parameters.displayName?`	`string`
`parameters.emailAddress?`	`string`
`parameters.password?`	`string`
`parameters.username?`	`string`
`options?`	`RequestOptions`

Returns

Promise<string[]>

password.policyCheckUpdateUser

policyCheckUpdateUser: (parameters, options?) => Promise<string[]>;

Parameters

Parameter	Type
`parameters`	{ `newPassword?`: `string`; `oldPassword?`: `string`; `username?`: `string`; }
`parameters.newPassword?`	`string`
`parameters.oldPassword?`	`string`
`parameters.username?`	`string`
`options?`	`RequestOptions`

Returns

Promise<string[]>

permissions

permissions: object;

permissions.getAllPermissions

getAllPermissions: (options?) => Promise<{
[key: string]: unknown;
  permissions?: Record<string, {
   [key: string]: unknown;
     description?: string;
     id?: string;
     key?: string;
     name?: string;
     type?: string & object | "PROJECT" | "GLOBAL";
  }>;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; permissions?: Record<string, { [key: string]: unknown; description?: string; id?: string; key?: string; name?: string; type?: string & object | "PROJECT" | "GLOBAL"; }>; }>

permissions.getPermissions

getPermissions: (parameters?, options?) => Promise<{
[key: string]: unknown;
  permissions?: Record<string, {
   [key: string]: unknown;
     description?: string;
     id?: string;
     key?: string;
     name?: string;
     type?: string & object | "PROJECT" | "GLOBAL";
  }>;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `issueId?`: `string`; `issueKey?`: `string`; `projectId?`: `string`; `projectKey?`: `string`; }	-
`parameters.issueId?`	`string`	Id of the issue to scope returned permissions for.
`parameters.issueKey?`	`string`	Key of the issue to scope returned permissions for.
`parameters.projectId?`	`string`	Id of project to scope returned permissions for.
`parameters.projectKey?`	`string`	Key of project to scope returned permissions for.
`options?`	`RequestOptions`	-

Returns

permissionSchemes

permissionSchemes: object;

permissionSchemes.createPermissionGrant

createPermissionGrant: (parameters, options?) => Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     field?: {
      [key: string]: unknown;
        clauseNames?: ...[];
        custom?: boolean;
        id?: string;
        name?: string;
        navigable?: boolean;
        orderable?: boolean;
        schema?: {
         [key: ...]: ...;
           custom?: ...;
           customId?: ...;
           items?: ...;
           system?: ...;
           type?: ...;
        };
        searchable?: boolean;
     };
     group?: {
      [key: string]: unknown;
        name?: string;
        self?: string;
     };
     parameter?: string;
     projectRole?: {
      [key: string]: unknown;
        actors?: ...[];
        description?: string;
        id?: number;
        name?: string;
        self?: string;
     };
     type?: string;
     user?: {
      [key: string]: unknown;
        active?: boolean;
        avatarUrls?: Record<..., ...>;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        self?: string;
        timeZone?: string;
     };
  };
  id?: number;
  permission?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `holder?`: { `expand?`: `string`; `field?`: { `clauseNames?`: `string`[]; `custom?`: `boolean`; `id?`: `string`; `name?`: `string`; `navigable?`: `boolean`; `orderable?`: `boolean`; `schema?`: { `custom?`: ... \| ...; `customId?`: ... \| ...; `items?`: ... \| ...; `system?`: ... \| ...; `type?`: ... \| ...; }; `searchable?`: `boolean`; }; `group?`: { `name?`: `string`; `self?`: `string`; }; `parameter?`: `string`; `projectRole?`: { `actors?`: `object`[]; `description?`: `string`; `id?`: `number`; `name?`: `string`; `self?`: `string`; }; `type?`: `string`; `user?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; }; `id?`: `number`; `permission?`: `string`; `schemeId`: `number`; `self?`: `string`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`parameters.holder?`	{ `expand?`: `string`; `field?`: { `clauseNames?`: `string`[]; `custom?`: `boolean`; `id?`: `string`; `name?`: `string`; `navigable?`: `boolean`; `orderable?`: `boolean`; `schema?`: { `custom?`: ... \| ...; `customId?`: ... \| ...; `items?`: ... \| ...; `system?`: ... \| ...; `type?`: ... \| ...; }; `searchable?`: `boolean`; }; `group?`: { `name?`: `string`; `self?`: `string`; }; `parameter?`: `string`; `projectRole?`: { `actors?`: `object`[]; `description?`: `string`; `id?`: `number`; `name?`: `string`; `self?`: `string`; }; `type?`: `string`; `user?`: { `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; }	-
`parameters.holder.expand?`	`string`	-
`parameters.holder.field?`	{ `clauseNames?`: `string`[]; `custom?`: `boolean`; `id?`: `string`; `name?`: `string`; `navigable?`: `boolean`; `orderable?`: `boolean`; `schema?`: { `custom?`: ... \| ...; `customId?`: ... \| ...; `items?`: ... \| ...; `system?`: ... \| ...; `type?`: ... \| ...; }; `searchable?`: `boolean`; }	-
`parameters.holder.field.clauseNames?`	`string`[]	-
`parameters.holder.field.custom?`	`boolean`	-
`parameters.holder.field.id?`	`string`	-
`parameters.holder.field.name?`	`string`	-
`parameters.holder.field.navigable?`	`boolean`	-
`parameters.holder.field.orderable?`	`boolean`	-
`parameters.holder.field.schema?`	{ `custom?`: ... \| ...; `customId?`: ... \| ...; `items?`: ... \| ...; `system?`: ... \| ...; `type?`: ... \| ...; }	-
`parameters.holder.field.schema.custom?`	... \| ...	-
`parameters.holder.field.schema.customId?`	... \| ...	-
`parameters.holder.field.schema.items?`	... \| ...	-
`parameters.holder.field.schema.system?`	... \| ...	-
`parameters.holder.field.schema.type?`	... \| ...	-
`parameters.holder.field.searchable?`	`boolean`	-
`parameters.holder.group?`	{ `name?`: `string`; `self?`: `string`; }	-
`parameters.holder.group.name?`	`string`	-
`parameters.holder.group.self?`	`string`	-
`parameters.holder.parameter?`	`string`	-
`parameters.holder.projectRole?`	{ `actors?`: `object`[]; `description?`: `string`; `id?`: `number`; `name?`: `string`; `self?`: `string`; }	-
`parameters.holder.projectRole.actors?`	`object`[]	-
`parameters.holder.projectRole.description?`	`string`	-
`parameters.holder.projectRole.id?`	`number`	-
`parameters.holder.projectRole.name?`	`string`	-
`parameters.holder.projectRole.self?`	`string`	-
`parameters.holder.type?`	`string`	-
`parameters.holder.user?`	{ `active?`: `boolean`; `avatarUrls?`: `Record`<`string`, `string`>; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.holder.user.active?`	`boolean`	-
`parameters.holder.user.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.holder.user.displayName?`	`string`	-
`parameters.holder.user.emailAddress?`	`string`	-
`parameters.holder.user.key?`	`string`	-
`parameters.holder.user.name?`	`string`	-
`parameters.holder.user.self?`	`string`	-
`parameters.holder.user.timeZone?`	`string`	-
`parameters.id?`	`number`	-
`parameters.permission?`	`string`	-
`parameters.schemeId?`	`number`	The id of the permission scheme.
`parameters.self?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; holder?: { [key: string]: unknown; expand?: string; field?: { [key: string]: unknown; clauseNames?: ...[]; custom?: boolean; id?: string; name?: string; navigable?: boolean; orderable?: boolean; schema?: { [key: ...]: ...; custom?: ...; customId?: ...; items?: ...; system?: ...; type?: ...; }; searchable?: boolean; }; group?: { [key: string]: unknown; name?: string; self?: string; }; parameter?: string; projectRole?: { [key: string]: unknown; actors?: ...[]; description?: string; id?: number; name?: string; self?: string; }; type?: string; user?: { [key: string]: unknown; active?: boolean; avatarUrls?: Record<..., ...>; displayName?: string; emailAddress?: string; key?: string; name?: string; self?: string; timeZone?: string; }; }; id?: number; permission?: string; self?: string; }>

permissionSchemes.createPermissionScheme

createPermissionScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `description?`: `string`; `expand?`: `string`; `id?`: `number`; `name?`: `string`; `permissions?`: `object`[]; `self?`: `string`; }; `expand?`: `string` \| `string`[]; }	-
`parameters.body?`	{ `description?`: `string`; `expand?`: `string`; `id?`: `number`; `name?`: `string`; `permissions?`: `object`[]; `self?`: `string`; }	-
`parameters.body.description?`	`string`	-
`parameters.body.expand?`	`string`	-
`parameters.body.id?`	`number`	-
`parameters.body.name?`	`string`	-
`parameters.body.permissions?`	`object`[]	-
`parameters.body.self?`	`string`	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>

permissionSchemes.deletePermissionScheme

deletePermissionScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `number`; }	-
`parameters.schemeId`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<void>

permissionSchemes.deletePermissionSchemeEntity

deletePermissionSchemeEntity: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `permissionId`: `number`; `schemeId`: `number`; }	-
`parameters.permissionId`	`number`	The id of the permission grant.
`parameters.schemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<void>

permissionSchemes.getPermissionScheme

getPermissionScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `schemeId`: `number`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`parameters.schemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>

permissionSchemes.getPermissionSchemeGrant

getPermissionSchemeGrant: (parameters, options?) => Promise<{
[key: string]: unknown;
  holder?: {
   [key: string]: unknown;
     expand?: string;
     field?: {
      [key: string]: unknown;
        clauseNames?: ...[];
        custom?: boolean;
        id?: string;
        name?: string;
        navigable?: boolean;
        orderable?: boolean;
        schema?: {
         [key: ...]: ...;
           custom?: ...;
           customId?: ...;
           items?: ...;
           system?: ...;
           type?: ...;
        };
        searchable?: boolean;
     };
     group?: {
      [key: string]: unknown;
        name?: string;
        self?: string;
     };
     parameter?: string;
     projectRole?: {
      [key: string]: unknown;
        actors?: ...[];
        description?: string;
        id?: number;
        name?: string;
        self?: string;
     };
     type?: string;
     user?: {
      [key: string]: unknown;
        active?: boolean;
        avatarUrls?: Record<..., ...>;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        self?: string;
        timeZone?: string;
     };
  };
  id?: number;
  permission?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `permissionId`: `number`; `schemeId`: `number`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`parameters.permissionId?`	`number`	The id of the permission grant.
`parameters.schemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

permissionSchemes.getPermissionSchemeGrants

getPermissionSchemeGrants: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string;
  permissions?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `schemeId`: `number`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`parameters.schemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; expand?: string; permissions?: object[]; }>

permissionSchemes.getPermissionSchemes

getPermissionSchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  permissionSchemes?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string` \| `string`[]; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; permissionSchemes?: object[]; }>

permissionSchemes.getSchemeAttribute

getSchemeAttribute: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `attributeKey`: `string`; `permissionSchemeId`: `number`; }	-
`parameters.attributeKey`	`string`	The key of the permission scheme attribute.
`parameters.permissionSchemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: string; }>

permissionSchemes.setSchemeAttribute

setSchemeAttribute: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `key`: `string`; `permissionSchemeId`: `number`; }	-
`parameters.body?`	`string`	-
`parameters.key?`	`string`	The key of the permission scheme attribute.
`parameters.permissionSchemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<void>

permissionSchemes.updatePermissionScheme

updatePermissionScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `description?`: `string`; `expand?`: `string`; `id?`: `number`; `name?`: `string`; `permissions?`: `object`[]; `self?`: `string`; }; `expand?`: `string` \| `string`[]; `schemeId`: `number`; }	-
`parameters.body?`	{ `description?`: `string`; `expand?`: `string`; `id?`: `number`; `name?`: `string`; `permissions?`: `object`[]; `self?`: `string`; }	-
`parameters.body.description?`	`string`	-
`parameters.body.expand?`	`string`	-
`parameters.body.id?`	`number`	-
`parameters.body.name?`	`string`	-
`parameters.body.permissions?`	`object`[]	-
`parameters.body.self?`	`string`	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include full beans in the response. This parameter accepts a comma-separated list of expandable elements. Use 'permissions' to include permissions in the response.
`parameters.schemeId?`	`number`	The id of the permission scheme.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>

prioritySchemes

prioritySchemes: object;

prioritySchemes.createPriorityScheme

createPriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `defaultOptionId?`: `string`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `optionIds?`: `string`[]; }
`parameters.defaultOptionId?`	`string`
`parameters.description?`	`string`
`parameters.id?`	`number`
`parameters.name?`	`string`
`parameters.optionIds?`	`string`[]
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; defaultOptionId?: string; defaultScheme?: boolean; description?: string; id?: number; name?: string; optionIds?: string[]; projectKeys?: string[]; self?: string; }>

prioritySchemes.deletePriorityScheme

deletePriorityScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `number`; }	-
`parameters.schemeId`	`number`	Id of priority scheme to delete
`options?`	`RequestOptions`	-

Returns

Promise<void>

prioritySchemes.getPriorityScheme

getPriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `schemeId`: `number`; }	-
`parameters.schemeId`	`number`	Id of priority scheme to get
`options?`	`RequestOptions`	-

Returns

prioritySchemes.getPrioritySchemes

getPrioritySchemes: (parameters?, options?) => Promise<{
[key: string]: unknown;
  maxResults?: number;
  schemes?: object[];
  startAt?: number;
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `startAt?`: `number`; }	-
`parameters.maxResults?`	`number`	How many results on the page should be included. Defaults to 100, maximum is 1000.
`parameters.startAt?`	`number`	The page offset, if not specified then defaults to 0
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; maxResults?: number; schemes?: object[]; startAt?: number; total?: number; }>

prioritySchemes.updatePriorityScheme

updatePriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `defaultOptionId?`: `string`; `description?`: `string`; `id?`: `number`; `name?`: `string`; `optionIds?`: `string`[]; `schemeId`: `number`; }	-
`parameters.defaultOptionId?`	`string`	-
`parameters.description?`	`string`	-
`parameters.id?`	`number`	-
`parameters.name?`	`string`	-
`parameters.optionIds?`	`string`[]	-
`parameters.schemeId?`	`number`	Id of the priority scheme to update
`options?`	`RequestOptions`	-

Returns

projectCategories

projectCategories: object;

projectCategories.createProjectCategory

createProjectCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; }
`parameters.description?`	`string`
`parameters.id?`	`string`
`parameters.name?`	`string`
`parameters.self?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectCategories.getAllProjectCategories

getAllProjectCategories: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

projectCategories.getProjectCategoryById

getProjectCategoryById: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	A project category id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectCategories.removeProjectCategory

removeProjectCategory: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	Id of the project category to delete.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectCategories.updateProjectCategory

updateProjectCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  id?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `description?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; }; `id`: `number`; }	-
`parameters.body`	{ `description?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; }	-
`parameters.body.description?`	`string`	-
`parameters.body.id?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.id?`	`number`	Id of the project category to modify.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }>

projectComponents

projectComponents: object;

projectComponents.createComponent

createComponent: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  assigneeType?:   | string & object
     | "PROJECT_DEFAULT"
     | "COMPONENT_LEAD"
     | "PROJECT_LEAD"
     | "UNASSIGNED";
  deleted?: boolean;
  description?: string;
  id?: string;
  lead?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  leadUserName?: string;
  name?: string;
  project?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `archived?`: `boolean`; `assigneeType?`: \| `string` & `object` \| `"PROJECT_DEFAULT"` \| `"COMPONENT_LEAD"` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`; `deleted?`: `boolean`; `description?`: `string`; `id?`: `string`; `lead?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `leadUserName?`: `string`; `name?`: `string`; `project?`: `string`; `self?`: `string`; }
`parameters.archived?`	`boolean`
`parameters.assigneeType?`	\| `string` & `object` \| `"PROJECT_DEFAULT"` \| `"COMPONENT_LEAD"` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`
`parameters.deleted?`	`boolean`
`parameters.description?`	`string`
`parameters.id?`	`string`
`parameters.lead?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }
`parameters.lead.active?`	`boolean`
`parameters.lead.applicationRoles?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.lead.applicationRoles.callback?`	`Record`<`string`, `never`>
`parameters.lead.applicationRoles.maxResults?`	`number`
`parameters.lead.applicationRoles.pagingCallback?`	`Record`<`string`, `never`>
`parameters.lead.applicationRoles.size?`	`number`
`parameters.lead.avatarUrls?`	`Record`<`string`, `string`>
`parameters.lead.deleted?`	`boolean`
`parameters.lead.displayName?`	`string`
`parameters.lead.emailAddress?`	`string`
`parameters.lead.expand?`	`string`
`parameters.lead.groups?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.lead.groups.callback?`	`Record`<`string`, `never`>
`parameters.lead.groups.maxResults?`	`number`
`parameters.lead.groups.pagingCallback?`	`Record`<`string`, `never`>
`parameters.lead.groups.size?`	`number`
`parameters.lead.key?`	`string`
`parameters.lead.lastLoginTime?`	`string`
`parameters.lead.locale?`	`string`
`parameters.lead.name?`	`string`
`parameters.lead.self?`	`string`
`parameters.lead.timeZone?`	`string`
`parameters.leadUserName?`	`string`
`parameters.name?`	`string`
`parameters.project?`	`string`
`parameters.self?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; archived?: boolean; assigneeType?: | string & object | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"; deleted?: boolean; description?: string; id?: string; lead?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; leadUserName?: string; name?: string; project?: string; self?: string; }>

projectComponents.deleteComponent

deleteComponent: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `moveIssuesTo?`: `string`; }	-
`parameters.id`	`string`	The component to delete.
`parameters.moveIssuesTo?`	`string`	The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectComponents.getComponent

getComponent: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  assigneeType?:   | string & object
     | "PROJECT_DEFAULT"
     | "COMPONENT_LEAD"
     | "PROJECT_LEAD"
     | "UNASSIGNED";
  deleted?: boolean;
  description?: string;
  id?: string;
  lead?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  leadUserName?: string;
  name?: string;
  project?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	A String containing the component key
`options?`	`RequestOptions`	-

Returns

projectComponents.getComponentRelatedIssues

getComponentRelatedIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueCount?: number;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	A String containing the component id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; issueCount?: number; self?: string; }>

projectComponents.getPaginatedComponents

getPaginatedComponents: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: Record<string, any>[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `string`; `projectIds?`: `string`; `query?`: `string`; `startAt?`: `string`; }	-
`parameters.maxResults?`	`string`	The maximum number of components to return
`parameters.projectIds?`	`string`	The set of project ids to filter components
`parameters.query?`	`string`	The string that components names will be matched with
`parameters.startAt?`	`string`	The index of the first components to return
`options?`	`RequestOptions`	-

Returns

projectComponents.updateComponent

updateComponent: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  assigneeType?:   | string & object
     | "PROJECT_DEFAULT"
     | "COMPONENT_LEAD"
     | "PROJECT_LEAD"
     | "UNASSIGNED";
  deleted?: boolean;
  description?: string;
  id?: string;
  lead?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  leadUserName?: string;
  name?: string;
  project?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: { `archived?`: `boolean`; `assigneeType?`: \| `string` & `object` \| `"PROJECT_DEFAULT"` \| `"COMPONENT_LEAD"` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`; `deleted?`: `boolean`; `description?`: `string`; `id?`: `string`; `lead?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `leadUserName?`: `string`; `name?`: `string`; `project?`: `string`; `self?`: `string`; }; `id`: `string`; }	-
`parameters.body?`	{ `archived?`: `boolean`; `assigneeType?`: \| `string` & `object` \| `"PROJECT_DEFAULT"` \| `"COMPONENT_LEAD"` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`; `deleted?`: `boolean`; `description?`: `string`; `id?`: `string`; `lead?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `leadUserName?`: `string`; `name?`: `string`; `project?`: `string`; `self?`: `string`; }	-
`parameters.body.archived?`	`boolean`	-
`parameters.body.assigneeType?`	\| `string` & `object` \| `"PROJECT_DEFAULT"` \| `"COMPONENT_LEAD"` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`	-
`parameters.body.deleted?`	`boolean`	-
`parameters.body.description?`	`string`	-
`parameters.body.id?`	`string`	-
`parameters.body.lead?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.lead.active?`	`boolean`	-
`parameters.body.lead.applicationRoles?`	{ `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }	-
`parameters.body.lead.applicationRoles.callback?`	... \| ...	-
`parameters.body.lead.applicationRoles.maxResults?`	... \| ...	-
`parameters.body.lead.applicationRoles.pagingCallback?`	... \| ...	-
`parameters.body.lead.applicationRoles.size?`	... \| ...	-
`parameters.body.lead.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.lead.deleted?`	`boolean`	-
`parameters.body.lead.displayName?`	`string`	-
`parameters.body.lead.emailAddress?`	`string`	-
`parameters.body.lead.expand?`	`string`	-
`parameters.body.lead.groups?`	{ `callback?`: ... \| ...; `maxResults?`: ... \| ...; `pagingCallback?`: ... \| ...; `size?`: ... \| ...; }	-
`parameters.body.lead.groups.callback?`	... \| ...	-
`parameters.body.lead.groups.maxResults?`	... \| ...	-
`parameters.body.lead.groups.pagingCallback?`	... \| ...	-
`parameters.body.lead.groups.size?`	... \| ...	-
`parameters.body.lead.key?`	`string`	-
`parameters.body.lead.lastLoginTime?`	`string`	-
`parameters.body.lead.locale?`	`string`	-
`parameters.body.lead.name?`	`string`	-
`parameters.body.lead.self?`	`string`	-
`parameters.body.lead.timeZone?`	`string`	-
`parameters.body.leadUserName?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.project?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.id?`	`string`	The component to delete.
`options?`	`RequestOptions`	-

Returns

projectKeyAndNameValidation

projectKeyAndNameValidation: object;

projectKeyAndNameValidation.validateProjectKey

validateProjectKey: (parameters?, options?) => Promise<{
[key: string]: unknown;
  errorMessages?: string[];
  errors?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `key?`: `string`; }	-
`parameters.key?`	`string`	The project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, string>; }>

projectRoles

projectRoles: object;

projectRoles.addProjectRoleActorsToRole

addProjectRoleActorsToRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `group?`: `string`[]; `id`: `number`; `user?`: `string`[]; }	-
`parameters.group?`	`string`[]	-
`parameters.id?`	`number`	The role id
`parameters.user?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; }>

projectRoles.createProjectRole

createProjectRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `description?`: `string`; `name?`: `string`; }
`parameters.description?`	`string`
`parameters.name?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projectRoles.deleteProjectRole

deleteProjectRole: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `swap?`: `number`; }	-
`parameters.id`	`number`	The role id
`parameters.swap?`	`number`	If given, removes a role even if it is used in scheme by replacing the role with the given one
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectRoles.deleteProjectRoleActorsFromRole

deleteProjectRoleActorsFromRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `group?`: `string`; `id`: `number`; `user?`: `string`; }	-
`parameters.group?`	`string`	If given, removes an actor from given role
`parameters.id?`	`number`	The role id to remove the actors from
`parameters.user?`	`string`	If given, removes an actor from given role
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; }>

projectRoles.fullyUpdateProjectRole

fullyUpdateProjectRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `description?`: `string`; `id`: `number`; `name?`: `string`; }	-
`parameters.description?`	`string`	-
`parameters.id?`	`number`	The role id
`parameters.name?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projectRoles.getAllProjectRoles

getAllProjectRoles: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

projectRoles.getProjectRoleActorsForRole

getProjectRoleActorsForRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The role id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; }>

projectRoles.getProjectRolesById

getProjectRolesById: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The role id
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projectRoles.partialUpdateProjectRole

partialUpdateProjectRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `description?`: `string`; `id`: `number`; `name?`: `string`; }	-
`parameters.description?`	`string`	-
`parameters.id?`	`number`	The role id
`parameters.name?`	`string`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projects

projects: object;

projects.addActorUsers

addActorUsers: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `group?`: `string`[]; `id`: `number`; `projectIdOrKey`: `string`; `user?`: `string`[]; }	-
`parameters.group?`	`string`[]	The groups to add to the role.
`parameters.id?`	`number`	The project role id
`parameters.projectIdOrKey?`	`string`	The project id or project key
`parameters.user?`	`string`[]	The usernames to add to the role.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projects.archiveProject

archiveProject: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.assignPermissionScheme

assignPermissionScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `id?`: `number`; `projectKeyOrId`: `string`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include additional information about permission schemes in the response. This parameter accepts a comma-separated list of expandable options. Expand options include: all and field.
`parameters.id?`	`number`	-
`parameters.projectKeyOrId?`	`string`	Key or id of the project
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>

projects.assignPriorityScheme

assignPriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id?`: `number`; `projectKeyOrId`: `string`; }	-
`parameters.id?`	`number`	-
`parameters.projectKeyOrId?`	`string`	Key or id of the project
`options?`	`RequestOptions`	-

Returns

projects.createProject

createProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  key?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `assigneeType?`: `string` & `object` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`; `avatarId?`: `number`; `categoryId?`: `number`; `description?`: `string`; `issueSecurityScheme?`: `number`; `key?`: `string`; `lead?`: `string`; `name?`: `string`; `notificationScheme?`: `number`; `permissionScheme?`: `number`; `projectTemplateKey?`: `string`; `projectTypeKey?`: `string`; `url?`: `string`; `workflowSchemeId?`: `number`; }
`parameters.assigneeType?`	`string` & `object` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`
`parameters.avatarId?`	`number`
`parameters.categoryId?`	`number`
`parameters.description?`	`string`
`parameters.issueSecurityScheme?`	`number`
`parameters.key?`	`string`
`parameters.lead?`	`string`
`parameters.name?`	`string`
`parameters.notificationScheme?`	`number`
`parameters.permissionScheme?`	`number`
`parameters.projectTemplateKey?`	`string`
`parameters.projectTypeKey?`	`string`
`parameters.url?`	`string`
`parameters.workflowSchemeId?`	`number`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; id?: number; key?: string; self?: string; }>

projects.createProjectAvatarFromTemporary

createProjectAvatarFromTemporary: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cropperOffsetX?`: `number`; `cropperOffsetY?`: `number`; `cropperWidth?`: `number`; `needsCropping?`: `boolean`; `projectIdOrKey`: `string`; `url?`: `string`; }	-
`parameters.cropperOffsetX?`	`number`	-
`parameters.cropperOffsetY?`	`number`	-
`parameters.cropperWidth?`	`number`	-
`parameters.needsCropping?`	`boolean`	-
`parameters.projectIdOrKey?`	`string`	Project id or project key
`parameters.url?`	`string`	-
`options?`	`RequestOptions`	-

Returns

projects.deleteActor

deleteActor: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `group?`: `string`; `id`: `number`; `projectIdOrKey`: `string`; `user?`: `string`; }	-
`parameters.group?`	`string`	The group name to remove from the project role. Use either user or group, but not both
`parameters.id?`	`number`	The project role id
`parameters.projectIdOrKey?`	`string`	The project id or project key
`parameters.user?`	`string`	The user name of the user to remove from the project role. Use either user or group, but not both
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.deleteProject

deleteProject: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.deleteProjectAvatar

deleteProjectAvatar: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `projectIdOrKey`: `string`; }	-
`parameters.id`	`number`	Database id for avatar
`parameters.projectIdOrKey?`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.deleteProjectProperty

deleteProjectProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	The project from which the property will be removed.
`parameters.propertyKey?`	`string`	The key of the property to remove.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.getAccessibleProjectTypeByKey

getAccessibleProjectTypeByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: string;
  descriptionI18nKey?: string;
  formattedKey?: string;
  icon?: string;
  key?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectTypeKey`: `string`; }	-
`parameters.projectTypeKey`	`string`	The key of the project type
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>

projects.getAllProjectAvatars

getAllProjectAvatars: (parameters, options?) => Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>

projects.getAllProjects

getAllProjects: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `browseArchive?`: `boolean`; `expand?`: `string`; `includeArchived?`: `boolean`; `recent?`: `number`; }	-
`parameters.browseArchive?`	`boolean`	Whether to include only projects where current user can browse archive
`parameters.expand?`	`string`	Parameters to expand
`parameters.includeArchived?`	`boolean`	Whether to include archived projects in response, default: false
`parameters.recent?`	`number`	If this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20)
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

projects.getAllProjectTypes

getAllProjectTypes: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

projects.getAllStatuses

getAllStatuses: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

projects.getAssignedPermissionScheme

getAssignedPermissionScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  permissions?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `projectKeyOrId`: `string`; }	-
`parameters.expand?`	`string` \| `string`[]	Use expand to include additional information about permission schemes in the response. This parameter accepts a comma-separated list of expandable options. Expand options include: all and field.
`parameters.projectKeyOrId?`	`string`	Key or id of the project
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; permissions?: object[]; self?: string; }>

projects.getAssignedPriorityScheme

getAssignedPriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKeyOrId`: `string`; }	-
`parameters.projectKeyOrId`	`string`	Key or id of the project
`options?`	`RequestOptions`	-

Returns

projects.getProject

getProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  avatarUrls?: Record<string, string>;
  description?: string;
  id?: string;
  key?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `projectIdOrKey`: `string`; }	-
`parameters.expand?`	`string`	Parameters to expand
`parameters.projectIdOrKey?`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; archived?: boolean; avatarUrls?: Record<string, string>; description?: string; id?: string; key?: string; name?: string; self?: string; }>

projects.getProjectComponents

getProjectComponents: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

projects.getProjectIssueSecurityScheme

getProjectIssueSecurityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultSecurityLevelId?: number;
  description?: string;
  id?: number;
  levels?: object[];
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKeyOrId`: `string`; }	-
`parameters.projectKeyOrId`	`string`	The project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; defaultSecurityLevelId?: number; description?: string; id?: number; levels?: object[]; name?: string; self?: string; }>

projects.getProjectNotificationScheme

getProjectNotificationScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  expand?: string;
  id?: number;
  name?: string;
  notificationSchemeEvents?: object[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `projectKeyOrId`: `string`; }	-
`parameters.expand?`	`string`	Optional information to be expanded in the response: group, user, projectRole or field.
`parameters.projectKeyOrId?`	`string`	Key or id of the project
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; expand?: string; id?: number; name?: string; notificationSchemeEvents?: object[]; self?: string; }>

projects.getProjectProperty

getProjectProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	The project from which the property will be returned.
`parameters.propertyKey?`	`string`	The key of the property to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

projects.getProjectPropertyKeys

getProjectPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	The project from which keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

projects.getProjectRole

getProjectRole: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `projectIdOrKey`: `string`; }	-
`parameters.id`	`number`	The project role id
`parameters.projectIdOrKey?`	`string`	The project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projects.getProjectRoles

getProjectRoles: (parameters, options?) => Promise<Record<string, string>>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	The project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, string>>

projects.getProjectTypeByKey

getProjectTypeByKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  color?: string;
  descriptionI18nKey?: string;
  formattedKey?: string;
  icon?: string;
  key?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectTypeKey`: `string`; }	-
`parameters.projectTypeKey`	`string`	The key of the project type
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; color?: string; descriptionI18nKey?: string; formattedKey?: string; icon?: string; key?: string; }>

projects.getProjectVersions

getProjectVersions: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `projectIdOrKey`: `string`; }	-
`parameters.expand?`	`string`	Parameters to expand
`parameters.projectIdOrKey?`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

projects.getProjectVersionsPaginated

getProjectVersionsPaginated: (parameters, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: Record<string, any>[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `maxResults?`: `number`; `orderBy?`: `string`; `projectIdOrKey`: `string`; `startAt?`: `number`; }	-
`parameters.expand?`	`string`	Parameters to expand
`parameters.maxResults?`	`number`	How many results on the page should be included. Defaults to 50
`parameters.orderBy?`	`string`	Ordering of the results
`parameters.projectIdOrKey?`	`string`	Project id or project key
`parameters.startAt?`	`number`	The page offset, if not specified then defaults to 0
`options?`	`RequestOptions`	-

Returns

projects.getSecurityLevelsForProject

getSecurityLevelsForProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  levels?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKeyOrId`: `string`; }	-
`parameters.projectKeyOrId`	`string`	Key or id of project to list the security levels for
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; levels?: object[]; }>

projects.getWorkflowSchemeForProject

getWorkflowSchemeForProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKeyOrId`: `string`; }	-
`parameters.projectKeyOrId`	`string`	The key or id of the project
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; defaultWorkflow?: string; description?: string; draft?: boolean; id?: number; issueTypeMappings?: Record<string, string>; issueTypes?: Record<string, { [key: string]: unknown; avatarId?: number; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; subtask?: boolean; }>; lastModified?: string; lastModifiedUser?: { [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: ...]: ...; }; maxResults?: number; pagingCallback?: { [key: ...]: ...; }; size?: number; }; key?: string; lastLoginTime?: string; locale?: string; name?: string; self?: string; timeZone?: string; }; name?: string; originalDefaultWorkflow?: string; originalIssueTypeMappings?: Record<string, string>; self?: string; updateDraftIfNeeded?: boolean; }>

projects.restoreProject

restoreProject: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectIdOrKey`: `string`; }	-
`parameters.projectIdOrKey`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.searchForProjects

searchForProjects: (parameters?, options?) => Promise<{
[key: string]: unknown;
  header?: string;
  projects?: object[];
  total?: number;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `allowEmptyQuery?`: `boolean`; `maxResults?`: `number`; `query?`: `string`; }	-
`parameters.allowEmptyQuery?`	`boolean`	If true, and the query is empty, the method will return first results limited to the value of 'maxResults' or default limit of 100.
`parameters.maxResults?`	`number`	Maximum number of matches to return. Zero means a default limit of 100 and negative numbers return no results.
`parameters.query?`	`string`	A sequence of characters expected to be found in the word-prefix of project name and/or key.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; header?: string; projects?: object[]; total?: number; }>

projects.setActors

setActors: (parameters, options?) => Promise<{
[key: string]: unknown;
  actors?: object[];
  description?: string;
  id?: number;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `categorisedActors?`: `Record`<`string`, `string`[]>; `id?`: `number`; }; `id`: `number`; `projectIdOrKey`: `string`; }	-
`parameters.body`	{ `categorisedActors?`: `Record`<`string`, `string`[]>; `id?`: `number`; }	-
`parameters.body.categorisedActors?`	`Record`<`string`, `string`[]>	-
`parameters.body.id?`	`number`	-
`parameters.id?`	`number`	The project role id
`parameters.projectIdOrKey?`	`string`	The project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; actors?: object[]; description?: string; id?: number; name?: string; self?: string; }>

projects.setProjectProperty

setProjectProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `projectIdOrKey`: `string`; `propertyKey`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.projectIdOrKey?`	`string`	The project on which the property will be set.
`parameters.propertyKey?`	`string`	The key of the project's property. The maximum length of the key is 255 bytes.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.storeTemporaryProjectAvatarUsingMultiPart

storeTemporaryProjectAvatarUsingMultiPart: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `avatar`: \| `AttachmentInput` \| `AttachmentInput`[]; `projectIdOrKey`: `string`; }	-
`parameters.avatar`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.projectIdOrKey?`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

projects.unassignPriorityScheme

unassignPriorityScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultOptionId?: string;
  defaultScheme?: boolean;
  description?: string;
  id?: number;
  name?: string;
  optionIds?: string[];
  projectKeys?: string[];
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKeyOrId`: `string`; `schemeId`: `number`; }	-
`parameters.projectKeyOrId`	`string`	Key or id of the project
`parameters.schemeId?`	`number`	Object that contains an id of the scheme
`options?`	`RequestOptions`	-

Returns

projects.updateProject

updateProject: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  avatarUrls?: Record<string, string>;
  description?: string;
  id?: string;
  key?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `assigneeType?`: `string` & `object` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`; `avatarId?`: `number`; `categoryId?`: `number`; `description?`: `string`; `expand?`: `string`; `issueSecurityScheme?`: `number`; `key?`: `string`; `lead?`: `string`; `name?`: `string`; `notificationScheme?`: `number`; `permissionScheme?`: `number`; `projectIdOrKey`: `string`; `projectTemplateKey?`: `string`; `projectTypeKey?`: `string`; `url?`: `string`; }	-
`parameters.assigneeType?`	`string` & `object` \| `"PROJECT_LEAD"` \| `"UNASSIGNED"`	-
`parameters.avatarId?`	`number`	-
`parameters.categoryId?`	`number`	-
`parameters.description?`	`string`	-
`parameters.expand?`	`string`	Parameters to expand
`parameters.issueSecurityScheme?`	`number`	-
`parameters.key?`	`string`	-
`parameters.lead?`	`string`	-
`parameters.name?`	`string`	-
`parameters.notificationScheme?`	`number`	-
`parameters.permissionScheme?`	`number`	-
`parameters.projectIdOrKey?`	`string`	Project id or project key
`parameters.projectTemplateKey?`	`string`	-
`parameters.projectTypeKey?`	`string`	-
`parameters.url?`	`string`	-
`options?`	`RequestOptions`	-

Returns

projects.updateProjectAvatar

updateProjectAvatar: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `fileName?`: `string`; `id?`: `string`; `isDeletable?`: `boolean`; `isSelected?`: `boolean`; `isSystemAvatar?`: `boolean`; `owner?`: `string`; `projectIdOrKey`: `string`; `selected?`: `boolean`; `urls?`: `Record`<`string`, `string`>; }	-
`parameters.fileName?`	`string`	-
`parameters.id?`	`string`	-
`parameters.isDeletable?`	`boolean`	-
`parameters.isSelected?`	`boolean`	-
`parameters.isSystemAvatar?`	`boolean`	-
`parameters.owner?`	`string`	-
`parameters.projectIdOrKey?`	`string`	Project id or project key
`parameters.selected?`	`boolean`	-
`parameters.urls?`	`Record`<`string`, `string`>	The avatar at each size, keyed by size.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projects.updateProjectType

updateProjectType: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  avatarUrls?: Record<string, string>;
  description?: string;
  id?: string;
  key?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `newProjectTypeKey`: `string`; `projectIdOrKey`: `string`; }	-
`parameters.newProjectTypeKey`	`string`	The key of the new project type
`parameters.projectIdOrKey?`	`string`	Project id or project key
`options?`	`RequestOptions`	-

Returns

projectVersions

projectVersions: object;

projectVersions.createOrUpdateRemoteVersionLink

createOrUpdateRemoteVersionLink: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `link?`: `unknown`; `name?`: `string`; `self?`: `string`; `versionId`: `string`; }	-
`parameters.link?`	`unknown`	The link itself. Any JSON.
`parameters.name?`	`string`	-
`parameters.self?`	`string`	-
`parameters.versionId?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.createOrUpdateRemoteVersionLinkByGlobalId

createOrUpdateRemoteVersionLinkByGlobalId: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `globalId`: `string`; `link?`: `unknown`; `name?`: `string`; `self?`: `string`; `versionId`: `string`; }	-
`parameters.globalId`	`string`	The id of the remote issue link to be created or updated.
`parameters.link?`	`unknown`	The link itself. Any JSON.
`parameters.name?`	`string`	-
`parameters.self?`	`string`	-
`parameters.versionId?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.createVersion

createVersion: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  description?: string;
  expand?: string;
  id?: string;
  moveUnfixedIssuesTo?: string;
  name?: string;
  overdue?: boolean;
  project?: string;
  projectId?: number;
  released?: boolean;
  releaseDate?: Date;
  releaseDateSet?: boolean;
  self?: string;
  startDate?: Date;
  startDateSet?: boolean;
  userReleaseDate?: string;
  userStartDate?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `archived?`: `boolean`; `description?`: `string`; `expand?`: `string`; `id?`: `string`; `moveUnfixedIssuesTo?`: `string`; `name?`: `string`; `overdue?`: `boolean`; `project?`: `string`; `projectId?`: `number`; `released?`: `boolean`; `releaseDate?`: `unknown`; `releaseDateSet?`: `boolean`; `self?`: `string`; `startDate?`: `unknown`; `startDateSet?`: `boolean`; `userReleaseDate?`: `string`; `userStartDate?`: `string`; }
`parameters.archived?`	`boolean`
`parameters.description?`	`string`
`parameters.expand?`	`string`
`parameters.id?`	`string`
`parameters.moveUnfixedIssuesTo?`	`string`
`parameters.name?`	`string`
`parameters.overdue?`	`boolean`
`parameters.project?`	`string`
`parameters.projectId?`	`number`
`parameters.released?`	`boolean`
`parameters.releaseDate?`	`unknown`
`parameters.releaseDateSet?`	`boolean`
`parameters.self?`	`string`
`parameters.startDate?`	`unknown`
`parameters.startDateSet?`	`boolean`
`parameters.userReleaseDate?`	`string`
`parameters.userStartDate?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; archived?: boolean; description?: string; expand?: string; id?: string; moveUnfixedIssuesTo?: string; name?: string; overdue?: boolean; project?: string; projectId?: number; released?: boolean; releaseDate?: Date; releaseDateSet?: boolean; self?: string; startDate?: Date; startDateSet?: boolean; userReleaseDate?: string; userStartDate?: string; }>

projectVersions.deleteRemoteVersionLink

deleteRemoteVersionLink: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `globalId`: `string`; `versionId`: `string`; }	-
`parameters.globalId`	`string`	The id of the remote issue link to be deleted.
`parameters.versionId?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.deleteRemoteVersionLinksByVersionId

deleteRemoteVersionLinksByVersionId: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `versionId`: `string`; }	-
`parameters.versionId`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.deleteVersionAndSwap

deleteVersionAndSwap: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `customFieldReplacementList?`: `object`[]; `id`: `string`; `moveAffectedIssuesTo?`: `number`; `moveFixIssuesTo?`: `number`; }	-
`parameters.customFieldReplacementList?`	`object`[]	-
`parameters.id?`	`string`	The version to delete
`parameters.moveAffectedIssuesTo?`	`number`	-
`parameters.moveFixIssuesTo?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.getPaginatedVersions

getPaginatedVersions: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `projectIds?`: `number`[]; `query?`: `string`; `startAt?`: `number`; }	-
`parameters.maxResults?`	`number`	Maximum number of versions to return
`parameters.projectIds?`	`number`[]	Set of project IDs to filter versions with
`parameters.query?`	`string`	String that version names will be matched with
`parameters.startAt?`	`number`	Index of the first version to return
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

projectVersions.getRemoteVersionLink

getRemoteVersionLink: (parameters, options?) => Promise<{
[key: string]: unknown;
  link?: unknown;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `globalId`: `string`; `versionId`: `string`; }	-
`parameters.globalId`	`string`	The id of the remote issue link to be returned. If (not provided) all remote links for the issue are returned. Remote version links follow the same general rules that Issue Links do, except that they are permitted to use any arbitrary well-formed JSON data format with no restrictions imposed. It is recommended, but not required, that they follow the same format used for Remote Issue Links, as described at https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links.
`parameters.versionId?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; link?: unknown; name?: string; self?: string; }>

projectVersions.getRemoteVersionLinks

getRemoteVersionLinks: (parameters?, options?) => Promise<{
[key: string]: unknown;
  links?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `globalId?`: `string`; }	-
`parameters.globalId?`	`string`	The id of the remote issue link to be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; links?: object[]; }>

projectVersions.getRemoteVersionLinksByVersionId

getRemoteVersionLinksByVersionId: (parameters, options?) => Promise<{
[key: string]: unknown;
  links?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `versionId`: `string`; }	-
`parameters.versionId`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; links?: object[]; }>

projectVersions.getVersion

getVersion: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  description?: string;
  expand?: string;
  id?: string;
  moveUnfixedIssuesTo?: string;
  name?: string;
  overdue?: boolean;
  project?: string;
  projectId?: number;
  released?: boolean;
  releaseDate?: Date;
  releaseDateSet?: boolean;
  self?: string;
  startDate?: Date;
  startDateSet?: boolean;
  userReleaseDate?: string;
  userStartDate?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `id`: `string`; }	-
`parameters.expand?`	`string`	-
`parameters.id?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

projectVersions.getVersionRelatedIssues

getVersionRelatedIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  customFieldNames?: object[];
  issueCountWithCustomFieldsShowingVersion?: number;
  issuesAffectedCount?: number;
  issuesFixedCount?: number;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; customFieldNames?: object[]; issueCountWithCustomFieldsShowingVersion?: number; issuesAffectedCount?: number; issuesFixedCount?: number; self?: string; }>

projectVersions.getVersionUnresolvedIssues

getVersionUnresolvedIssues: (parameters, options?) => Promise<{
[key: string]: unknown;
  issuesUnresolvedCount?: number;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; }	-
`parameters.id`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; issuesUnresolvedCount?: number; self?: string; }>

projectVersions.merge

merge: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `moveIssuesTo`: `string`; }	-
`parameters.id`	`string`	The version that will be merged to version moveIssuesTo and removed
`parameters.moveIssuesTo?`	`string`	The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.
`options?`	`RequestOptions`	-

Returns

Promise<void>

projectVersions.moveVersion

moveVersion: (parameters, options?) => Promise<{
[key: string]: unknown;
  archived?: boolean;
  description?: string;
  expand?: string;
  id?: string;
  moveUnfixedIssuesTo?: string;
  name?: string;
  overdue?: boolean;
  project?: string;
  projectId?: number;
  released?: boolean;
  releaseDate?: Date;
  releaseDateSet?: boolean;
  self?: string;
  startDate?: Date;
  startDateSet?: boolean;
  userReleaseDate?: string;
  userStartDate?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `after?`: `string`; `id`: `string`; `position?`: `string` & `object` \| `"Earlier"` \| `"Later"` \| `"First"` \| `"Last"`; }	-
`parameters.after?`	`string`	-
`parameters.id?`	`string`	ID of the version.
`parameters.position?`	`string` & `object` \| `"Earlier"` \| `"Later"` \| `"First"` \| `"Last"`	-
`options?`	`RequestOptions`	-

Returns

projectVersions.updateVersion

updateVersion: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `archived?`: `boolean`; `description?`: `string`; `expand?`: `string`; `id?`: `string`; `moveUnfixedIssuesTo?`: `string`; `name?`: `string`; `overdue?`: `boolean`; `project?`: `string`; `projectId?`: `number`; `released?`: `boolean`; `releaseDate?`: `unknown`; `releaseDateSet?`: `boolean`; `self?`: `string`; `startDate?`: `unknown`; `startDateSet?`: `boolean`; `userReleaseDate?`: `string`; `userStartDate?`: `string`; }; `id`: `string`; }	-
`parameters.body`	{ `archived?`: `boolean`; `description?`: `string`; `expand?`: `string`; `id?`: `string`; `moveUnfixedIssuesTo?`: `string`; `name?`: `string`; `overdue?`: `boolean`; `project?`: `string`; `projectId?`: `number`; `released?`: `boolean`; `releaseDate?`: `unknown`; `releaseDateSet?`: `boolean`; `self?`: `string`; `startDate?`: `unknown`; `startDateSet?`: `boolean`; `userReleaseDate?`: `string`; `userStartDate?`: `string`; }	-
`parameters.body.archived?`	`boolean`	-
`parameters.body.description?`	`string`	-
`parameters.body.expand?`	`string`	-
`parameters.body.id?`	`string`	-
`parameters.body.moveUnfixedIssuesTo?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.overdue?`	`boolean`	-
`parameters.body.project?`	`string`	-
`parameters.body.projectId?`	`number`	-
`parameters.body.released?`	`boolean`	-
`parameters.body.releaseDate?`	`unknown`	-
`parameters.body.releaseDateSet?`	`boolean`	-
`parameters.body.self?`	`string`	-
`parameters.body.startDate?`	`unknown`	-
`parameters.body.startDateSet?`	`boolean`	-
`parameters.body.userReleaseDate?`	`string`	-
`parameters.body.userStartDate?`	`string`	-
`parameters.id?`	`string`	ID of the version.
`options?`	`RequestOptions`	-

Returns

Promise<void>

readOnlyMode

readOnlyMode: object;

readOnlyMode.getReadOnlyMode

getReadOnlyMode: (options?) => Promise<{
[key: string]: unknown;
  enabled?: boolean;
  endTime?: string;
  message?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; enabled?: boolean; endTime?: string; message?: string; timeZone?: string; }>

readOnlyMode.updateReadOnlyMode

updateReadOnlyMode: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `enabled?`: `boolean`; `endTime?`: `string`; `message?`: `string`; `timeZone?`: `string`; }	-
`parameters.enabled?`	`boolean`	Whether read-only mode should be enabled.
`parameters.endTime?`	`string`	The estimated end time as a local date-time (no offset). Omit to leave unchanged; send an empty string to clear it.
`parameters.message?`	`string`	The banner message shown to users while read-only mode is active. Omit to leave it unchanged; send an empty string to reset it to the default.
`parameters.timeZone?`	`string`	The time zone id the estimated end time is expressed in. Omit to leave unchanged; send an empty string to clear it.
`options?`	`RequestOptions`	-

Returns

Promise<void>

screens

screens: object;

screens.addField

addField: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: string;
  name?: string;
  showWhenEmpty?: boolean;
  type?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `fieldId?`: `string`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.fieldId?`	`string`	-
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: string; name?: string; showWhenEmpty?: boolean; type?: string; }>

screens.addFieldToDefaultScreen

addFieldToDefaultScreen: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `fieldId`: `string`; }
`parameters.fieldId`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

screens.addTab

addTab: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id?`: `number`; `name?`: `string`; `screenId`: `number`; }	-
`parameters.id?`	`number`	-
`parameters.name?`	`string`	-
`parameters.screenId?`	`number`	Id of screen
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: number; name?: string; }>

screens.deleteTab

deleteTab: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `screenId`: `number`; `tabId`: `number`; }	-
`parameters.screenId`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<void>

screens.getAllFields

getAllFields: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKey?`: `string`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.projectKey?`	`string`	The key of the project; this parameter is optional
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

screens.getAllScreens

getAllScreens: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type
`parameters?`	{ `expand?`: `string`; `maxResults?`: `string`; `search?`: `string`; `startAt?`: `string`; }
`parameters.expand?`	`string`
`parameters.maxResults?`	`string`
`parameters.search?`	`string`
`parameters.startAt?`	`string`
`options?`	`RequestOptions`

Returns

Promise<object[]>

screens.getAllTabs

getAllTabs: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `projectKey?`: `string`; `screenId`: `number`; }	-
`parameters.projectKey?`	`string`	The key of the project; this parameter is optional
`parameters.screenId?`	`number`	Id of screen
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

screens.getFieldsToAdd

getFieldsToAdd: (parameters, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `screenId`: `number`; }	-
`parameters.screenId`	`number`	Id of screen
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

screens.moveField

moveField: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `after?`: `string`; `id`: `string`; `position?`: `string` & `object` \| `"Earlier"` \| `"Later"` \| `"First"` \| `"Last"`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.after?`	`string`	-
`parameters.id?`	`string`	Id of field
`parameters.position?`	`string` & `object` \| `"Earlier"` \| `"Later"` \| `"First"` \| `"Last"`	-
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<void>

screens.moveTab

moveTab: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `pos`: `number`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.pos`	`number`	Position of tab
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<void>

screens.removeField

removeField: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.id`	`string`	Id of field
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<void>

screens.renameTab

renameTab: (parameters, options?) => Promise<{
[key: string]: unknown;
  id?: number;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id?`: `number`; `name?`: `string`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.id?`	`number`	-
`parameters.name?`	`string`	-
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; id?: number; name?: string; }>

screens.updateShowWhenEmptyIndicator

updateShowWhenEmptyIndicator: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `string`; `newValue`: `boolean`; `screenId`: `number`; `tabId`: `number`; }	-
`parameters.id`	`string`	Id of field
`parameters.newValue?`	`boolean`	New value of 'showWhenEmptyIndicator'
`parameters.screenId?`	`number`	Id of screen
`parameters.tabId?`	`number`	Id of tab
`options?`	`RequestOptions`	-

Returns

Promise<void>

searchLimits

searchLimits: object;

searchLimits.getMaxAggregationBuckets

getMaxAggregationBuckets: (options?) => Promise<number>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<number>

searchLimits.getMaxResultWindow

getMaxResultWindow: (options?) => Promise<number>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<number>

serverInfo

serverInfo: object;

serverInfo.getServerInfo

getServerInfo: (options?) => Promise<{
[key: string]: unknown;
  baseUrl: string;
  buildDate?: string;
  buildNumber?: number;
  databaseBuildNumber?: number;
  deploymentType: string;
  scmInfo?: string;
  serverTime?: string;
  serverTitle?: string;
  version: string;
  versionNumbers: number[];
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; baseUrl: string; buildDate?: string; buildNumber?: number; databaseBuildNumber?: number; deploymentType: string; scmInfo?: string; serverTime?: string; serverTitle?: string; version: string; versionNumbers: number[]; }>

session

session: object;

session.currentUser

currentUser: (options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     items?: Record<string, any>[];
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     items?: Record<string, any>[];
     size?: number;
  };
  key?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; active?: boolean; applicationRoles?: { [key: string]: unknown; items?: Record<string, any>[]; size?: number; }; avatarUrls?: Record<string, string>; deleted?: boolean; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; items?: Record<string, any>[]; size?: number; }; key?: string; locale?: string; name?: string; self?: string; timeZone?: string; }>

login: (parameters, options?) => Promise<{
[key: string]: unknown;
  loginInfo?: {
   [key: string]: unknown;
     failedLoginCount?: number;
     lastFailedLoginTime?: Date;
     loginCount?: number;
     previousLoginTime?: Date;
  };
  session?: {
   [key: string]: unknown;
     name?: string;
     value?: string;
  };
}>;

Parameters

Parameter	Type
`parameters`	{ `password?`: `string`; `username?`: `string`; }
`parameters.password?`	`string`
`parameters.username?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; loginInfo?: { [key: string]: unknown; failedLoginCount?: number; lastFailedLoginTime?: Date; loginCount?: number; previousLoginTime?: Date; }; session?: { [key: string]: unknown; name?: string; value?: string; }; }>

session.logout

logout: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

sprint

sprint: object;

sprint.createSprint

createSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  activatedDate?: string;
  autoStartStop?: boolean;
  completeDate?: string;
  endDate?: string;
  goal?: string;
  id?: number;
  incompleteIssuesDestinationId?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: string;
  state?: string;
  synced?: boolean;
}>;

Parameters

Parameter	Type
`parameters`	{ `autoStartStop?`: `boolean`; `endDate?`: `string`; `goal?`: `string`; `incompleteIssuesDestinationId?`: `number`; `name?`: `string`; `originBoardId?`: `number`; `startDate?`: `string`; `synced?`: `boolean`; `userProfileTimeZone?`: `string`; }
`parameters.autoStartStop?`	`boolean`
`parameters.endDate?`	`string`
`parameters.goal?`	`string`
`parameters.incompleteIssuesDestinationId?`	`number`
`parameters.name?`	`string`
`parameters.originBoardId?`	`number`
`parameters.startDate?`	`string`
`parameters.synced?`	`boolean`
`parameters.userProfileTimeZone?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; activatedDate?: string; autoStartStop?: boolean; completeDate?: string; endDate?: string; goal?: string; id?: number; incompleteIssuesDestinationId?: number; name?: string; originBoardId?: number; self?: string; startDate?: string; state?: string; synced?: boolean; }>

sprint.deleteSprint

deleteSprint: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `sprintId`: `number`; }	-
`parameters.sprintId`	`number`	The Id of the sprint to delete.
`options?`	`RequestOptions`	-

Returns

Promise<void>

sprint.deleteSprintProperty

deleteSprintProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `propertyKey`: `string`; `sprintId`: `number`; }	-
`parameters.propertyKey`	`string`	The key of the property to remove.
`parameters.sprintId?`	`number`	The id of the sprint from which the property will be removed.
`options?`	`RequestOptions`	-

Returns

Promise<void>

sprint.getIssuesForSprint

getIssuesForSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  expand?: string | null;
  issues?: object[];
  maxResults?: number;
  maxResultWindow?: number;
  names?: Record<string, string> | null;
  schema?:   | Record<string, {
   [key: string]: unknown;
     custom?: string;
     customId?: number;
     items?: string;
     system?: string;
     type?: string;
   }>
     | null;
  startAt?: number;
  total?: number;
  warningMessages?: string[] | null;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string` \| `string`[]; `fields?`: `string` \| `string`[]; `jql?`: `string`; `maxResults?`: `number`; `sprintId`: `number`; `startAt?`: `number`; `validateQuery?`: `boolean`; }	-
`parameters.expand?`	`string` \| `string`[]	A comma-separated list of the parameters to expand.
`parameters.fields?`	`string` \| `string`[]	The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
`parameters.jql?`	`string`	Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
`parameters.maxResults?`	`number`	The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your JIRA instance. If you exceed this limit, your results will be truncated.
`parameters.sprintId?`	`number`	The Id of the sprint that contains the requested issues.
`parameters.startAt?`	`number`	The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
`parameters.validateQuery?`	`boolean`	Specifies whether to validate the JQL query or not. Default: true.
`options?`	`RequestOptions`	-

Returns

sprint.getSprint

getSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  activatedDate?: string;
  autoStartStop?: boolean;
  completeDate?: string;
  endDate?: string;
  goal?: string;
  id?: number;
  incompleteIssuesDestinationId?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: string;
  state?: string;
  synced?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `sprintId`: `number`; }	-
`parameters.sprintId`	`number`	The Id of the requested sprint.
`options?`	`RequestOptions`	-

Returns

sprint.getSprintProperty

getSprintProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `propertyKey`: `string`; `sprintId`: `number`; }	-
`parameters.propertyKey`	`string`	The key of the property to return.
`parameters.sprintId?`	`number`	The id of the sprint from which the property will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

sprint.getSprintPropertyKeys

getSprintPropertyKeys: (parameters, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `sprintId`: `number`; }	-
`parameters.sprintId`	`number`	The id of the sprint from which property keys will be returned.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

sprint.moveIssuesToSprint

moveIssuesToSprint: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `issues?`: `string`[]; `sprintId`: `number`; }	-
`parameters.issues?`	`string`[]	-
`parameters.sprintId?`	`number`	The Id of the sprint that you want to assign issues to.
`options?`	`RequestOptions`	-

Returns

Promise<void>

sprint.partiallyUpdateSprint

partiallyUpdateSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  activatedDate?: string;
  autoStartStop?: boolean;
  completeDate?: string;
  endDate?: string;
  goal?: string;
  id?: number;
  incompleteIssuesDestinationId?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: string;
  state?: string;
  synced?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `activatedDate?`: `string`; `autoStartStop?`: `boolean`; `completeDate?`: `string`; `endDate?`: `string`; `goal?`: `string`; `id?`: `number`; `incompleteIssuesDestinationId?`: `number`; `name?`: `string`; `originBoardId?`: `number`; `self?`: `string`; `sprintId`: `number`; `startDate?`: `string`; `state?`: `string`; `synced?`: `boolean`; }	-
`parameters.activatedDate?`	`string`	-
`parameters.autoStartStop?`	`boolean`	-
`parameters.completeDate?`	`string`	-
`parameters.endDate?`	`string`	-
`parameters.goal?`	`string`	-
`parameters.id?`	`number`	-
`parameters.incompleteIssuesDestinationId?`	`number`	-
`parameters.name?`	`string`	-
`parameters.originBoardId?`	`number`	-
`parameters.self?`	`string`	-
`parameters.sprintId?`	`number`	The Id of the sprint to update.
`parameters.startDate?`	`string`	-
`parameters.state?`	`string`	-
`parameters.synced?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

sprint.setSprintProperty

setSprintProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `propertyKey`: `string`; `sprintId`: `number`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.propertyKey?`	`string`	The key of the sprint's property. The maximum length of the key is 255 bytes.
`parameters.sprintId?`	`number`	The id of the sprint on which the property will be set.
`options?`	`RequestOptions`	-

Returns

Promise<void>

sprint.swapSprint

swapSprint: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `sprintId`: `number`; `sprintToSwapWith?`: `number`; `swap?`: `number`; }	-
`parameters.sprintId`	`number`	The Id of the sprint to swap.
`parameters.sprintToSwapWith?`	`number`	-
`parameters.swap?`	`number`	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

sprint.unmapAllSprints

unmapAllSprints: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

sprint.unmapSprints

unmapSprints: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `sprintIds?`: `number`[]; }
`parameters.sprintIds?`	`number`[]
`options?`	`RequestOptions`

Returns

Promise<void>

sprint.updateSprint

updateSprint: (parameters, options?) => Promise<{
[key: string]: unknown;
  activatedDate?: string;
  autoStartStop?: boolean;
  completeDate?: string;
  endDate?: string;
  goal?: string;
  id?: number;
  incompleteIssuesDestinationId?: number;
  name?: string;
  originBoardId?: number;
  self?: string;
  startDate?: string;
  state?: string;
  synced?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `activatedDate?`: `string`; `autoStartStop?`: `boolean`; `completeDate?`: `string`; `endDate?`: `string`; `goal?`: `string`; `id?`: `number`; `incompleteIssuesDestinationId?`: `number`; `name?`: `string`; `originBoardId?`: `number`; `self?`: `string`; `sprintId`: `number`; `startDate?`: `string`; `state?`: `string`; `synced?`: `boolean`; }	-
`parameters.activatedDate?`	`string`	-
`parameters.autoStartStop?`	`boolean`	-
`parameters.completeDate?`	`string`	-
`parameters.endDate?`	`string`	-
`parameters.goal?`	`string`	-
`parameters.id?`	`number`	-
`parameters.incompleteIssuesDestinationId?`	`number`	-
`parameters.name?`	`string`	-
`parameters.originBoardId?`	`number`	-
`parameters.self?`	`string`	-
`parameters.sprintId?`	`number`	The Id of the sprint to update.
`parameters.startDate?`	`string`	-
`parameters.state?`	`string`	-
`parameters.synced?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

terminology

terminology: object;

terminology.getAllTerminologyEntries

getAllTerminologyEntries: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

terminology.getTerminologyEntry

getTerminologyEntry: (parameters, options?) => Promise<{
[key: string]: unknown;
  isDefault?: boolean;
  newName?: string;
  newNamePlural?: string;
  originalName?: string;
  originalNamePlural?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `originalName`: `string`; }	-
`parameters.originalName`	`string`	A numeric StatusCategory id or a status category key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isDefault?: boolean; newName?: string; newNamePlural?: string; originalName?: string; originalNamePlural?: string; }>

terminology.setTerminologyEntries

setTerminologyEntries: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type
`parameters`	{ `newName?`: `string`; `newNamePlural?`: `string`; `originalName?`: `string`; }
`parameters.newName?`	`string`
`parameters.newNamePlural?`	`string`
`parameters.originalName?`	`string`
`options?`	`RequestOptions`

Returns

Promise<unknown>

upgrade

upgrade: object;

upgrade.getUpgradeResult

getUpgradeResult: (options?) => Promise<{
[key: string]: unknown;
  duration?: number;
  message?: string;
  outcome?: string;
  startTime?: Date;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; duration?: number; message?: string; outcome?: string; startTime?: Date; }>

upgrade.runUpgradesNow

runUpgradesNow: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

users

users: object;

users.addUserToApplication

addUserToApplication: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `applicationKey?`: `string`; `username?`: `string`; }	-
`parameters.applicationKey?`	`string`	Application key
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.changeUserPassword

changeUserPassword: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `currentPassword?`: `string`; `key?`: `string`; `password?`: `string`; `username?`: `string`; }	-
`parameters.currentPassword?`	`string`	-
`parameters.key?`	`string`	User key
`parameters.password?`	`string`	-
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.createUser

createUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationKeys?: string[];
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  notification?: string;
  password?: string;
  self?: string;
}>;

Parameters

Parameter	Type
`parameters`	{ `active?`: `boolean`; `applicationKeys?`: `string`[]; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `notification?`: `string`; `password?`: `string`; `self?`: `string`; }
`parameters.active?`	`boolean`
`parameters.applicationKeys?`	`string`[]
`parameters.displayName?`	`string`
`parameters.emailAddress?`	`string`
`parameters.key?`	`string`
`parameters.name?`	`string`
`parameters.notification?`	`string`
`parameters.password?`	`string`
`parameters.self?`	`string`
`options?`	`RequestOptions`

Returns

users.createUserAvatarFromTemporary

createUserAvatarFromTemporary: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `cropperOffsetX?`: `number`; `cropperOffsetY?`: `number`; `cropperWidth?`: `number`; `needsCropping?`: `boolean`; `url?`: `string`; `username?`: `string`; }	-
`parameters.cropperOffsetX?`	`number`	-
`parameters.cropperOffsetY?`	`number`	-
`parameters.cropperWidth?`	`number`	-
`parameters.needsCropping?`	`boolean`	-
`parameters.url?`	`string`	-
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

users.defaultColumns

defaultColumns: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `username?`: `string`; }	-
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

users.deleteSession

deleteSession: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `username`: `string`; }	-
`parameters.username`	`string`	A String containing username.
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.deleteUserAvatar

deleteUserAvatar: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `username?`: `string`; }	-
`parameters.id`	`number`	Database id for avatar
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.deleteUserProperty

deleteUserProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `propertyKey`: `string`; `userKey?`: `string`; `username?`: `string`; }	-
`parameters.propertyKey`	`string`	The key of the user's property
`parameters.userKey?`	`string`	Key of the user whose property is to be removed
`parameters.username?`	`string`	Username of the user whose property is to be removed
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.findAssignableUsers

findAssignableUsers: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `actionDescriptorId?`: `number`; `issueKey?`: `string`; `maxResults?`: `number`; `project?`: `string`; `username?`: `string`; }	-
`parameters.actionDescriptorId?`	`number`	-
`parameters.issueKey?`	`string`	The issue key for the issue being edited we need to find assignable users for.
`parameters.maxResults?`	`number`	The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
`parameters.project?`	`string`	-
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

users.findBulkAssignableUsers

findBulkAssignableUsers: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `maxResults?`: `number`; `projectKeys?`: `string` \| `string`[]; `username?`: `string`; }	-
`parameters.maxResults?`	`number`	The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
`parameters.projectKeys?`	`string` \| `string`[]	The keys of the projects we are finding assignable users for, comma-separated
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

users.findUsers

findUsers: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeActive?`: `boolean`; `includeInactive?`: `boolean`; `maxResults?`: `number`; `startAt?`: `number`; `username?`: `string`; }	-
`parameters.includeActive?`	`boolean`	If true, then active users are included in the results (default true)
`parameters.includeInactive?`	`boolean`	If true, then inactive users are included in the results (default false)
`parameters.maxResults?`	`number`	The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
`parameters.startAt?`	`number`	The index of the first user to return (0-based). Please note that the startAt parameter will be deprecated in a future release of Jira 10.3.x
`parameters.username?`	`string`	A query string used to search username, name or e-mail address
`options?`	`RequestOptions`	-

Returns

users.findUsersForPicker

findUsersForPicker: (parameters?, options?) => Promise<{
[key: string]: unknown;
  header?: string;
  total?: number;
  users?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `exclude?`: `string`[]; `maxResults?`: `number`; `query?`: `string`; `showAvatar?`: `boolean`; }	-
`parameters.exclude?`	`string`[]	List of users to be excluded from the search results
`parameters.maxResults?`	`number`	The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
`parameters.query?`	`string`	A string used to search username, Name or e-mail address
`parameters.showAvatar?`	`boolean`	If true, then avatars are included in the results
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; header?: string; total?: number; users?: object[]; }>

users.findUsersWithBrowsePermission

findUsersWithBrowsePermission: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `issueKey?`: `string`; `maxResults?`: `number`; `projectKey?`: `string`; `username?`: `string`; }	-
`parameters.issueKey?`	`string`	The issue key for the issue being edited we need to find viewable users for.
`parameters.maxResults?`	`number`	The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.
`parameters.projectKey?`	`string`	The optional project key to search for users with if no issueKey is supplied.
`parameters.username?`	`string`	The username filter, no users returned if left blank
`options?`	`RequestOptions`	-

Returns

users.getA11yPersonalSettings

getA11yPersonalSettings: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

users.getAllUserAvatars

getAllUserAvatars: (parameters?, options?) => Promise<{
[key: string]: unknown;
  custom?: object[];
  system?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `username?`: `string`; }	-
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; custom?: object[]; system?: object[]; }>

users.getDuplicatedUsersCount

getDuplicatedUsersCount: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `flush?`: `boolean`; }	-
`parameters.flush?`	`boolean`	If set to true forces cache flush, user must be sysadmin for this parameter to have an effect.
`options?`	`RequestOptions`	-

Returns

users.getDuplicatedUsersMapping

getDuplicatedUsersMapping: (parameters?, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `flush?`: `boolean`; }	-
`parameters.flush?`	`boolean`	If set to true forces cache flush, user must be sysadmin for this parameter to have an effect.
`options?`	`RequestOptions`	-

Returns

users.getUser

getUser: (parameters?, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationRoles?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  avatarUrls?: Record<string, string>;
  deleted?: boolean;
  displayName?: string;
  emailAddress?: string;
  expand?: string;
  groups?: {
   [key: string]: unknown;
     callback?: {
      [key: string]: unknown;
     };
     maxResults?: number;
     pagingCallback?: {
      [key: string]: unknown;
     };
     size?: number;
  };
  key?: string;
  lastLoginTime?: string;
  locale?: string;
  name?: string;
  self?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeDeleted?`: `boolean`; `key?`: `string`; `username?`: `string`; }	-
`parameters.includeDeleted?`	`boolean`	Whether deleted users should be returned (flag available to users with global ADMIN rights)
`parameters.key?`	`string`	User key
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

users.getUserAnonymizationProgress

getUserAnonymizationProgress: (parameters?, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters?`	{ `taskId?`: `number`; }	-
`parameters.taskId?`	`number`	The id of a user anonymization task you wish to obtain details on.
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.getUserList

getUserList: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextCursor?: string;
  nextPage?: string;
  self?: string;
  values?: Record<string, any>[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `cursor?`: `number`; `maxResults?`: `number`; }	-
`parameters.cursor?`	`number`	The position in the stream to continue iterating over all users.
`parameters.maxResults?`	`number`	The maximum number of users to return per page (defaults to 2000).
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextCursor?: string; nextPage?: string; self?: string; values?: Record<string, any>[]; }>

users.getUserProperty

getUserProperty: (parameters, options?) => Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `propertyKey`: `string`; `userKey?`: `string`; `username?`: `string`; }	-
`parameters.propertyKey`	`string`	The key of the user's property
`parameters.userKey?`	`string`	Key of the user whose property is to be returned
`parameters.username?`	`string`	Username of the user whose property is to be returned
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>

users.getUserPropertyKeys

getUserPropertyKeys: (parameters?, options?) => Promise<{
[key: string]: unknown;
  keys?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `userKey?`: `string`; `username?`: `string`; }	-
`parameters.userKey?`	`string`	Key of the user whose properties are to be returned
`parameters.username?`	`string`	Username of the user whose properties are to be returned
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; keys?: object[]; }>

users.removeUser

removeUser: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `key?`: `string`; `username?`: `string`; }	-
`parameters.key?`	`string`	User key
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.removeUserFromApplication

removeUserFromApplication: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `applicationKey?`: `string`; `username?`: `string`; }	-
`parameters.applicationKey?`	`string`	Application key
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.resetUserColumns

resetUserColumns: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `username?`: `string`; }	-
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.scheduleUserAnonymization

scheduleUserAnonymization: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `newOwnerKey?`: `string`; `userKey?`: `string`; }
`parameters.newOwnerKey?`	`string`
`parameters.userKey?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

users.scheduleUserAnonymizationRerun

scheduleUserAnonymizationRerun: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `newOwnerKey?`: `string`; `oldUserKey?`: `string`; `oldUserName?`: `string`; `userKey?`: `string`; }
`parameters.newOwnerKey?`	`string`
`parameters.oldUserKey?`	`string`
`parameters.oldUserName?`	`string`
`parameters.userKey?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

users.setColumnsUrlEncoded

setColumnsUrlEncoded: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `columns?`: `string`[]; `username?`: `string`; }
`parameters.columns?`	`string`[]
`parameters.username?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

users.setUserProperty

setUserProperty: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `Record`<`string`, `any`>; `propertyKey`: `string`; `userKey?`: `string`; `username?`: `string`; }	-
`parameters.body`	`Record`<`string`, `any`>	-
`parameters.propertyKey?`	`string`	The key of the user's property. The maximum length of the key is 255 bytes.
`parameters.userKey?`	`string`	Key of the user whose property is to be set
`parameters.username?`	`string`	Username of the user whose property is to be set
`options?`	`RequestOptions`	-

Returns

Promise<void>

users.storeTemporaryUserAvatarUsingMultiPart

storeTemporaryUserAvatarUsingMultiPart: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `avatar`: \| `AttachmentInput` \| `AttachmentInput`[]; `username?`: `string`; }	-
`parameters.avatar`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

users.unlockAnonymization

unlockAnonymization: (options?) => Promise<void>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<void>

users.updateUser

updateUser: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  applicationKeys?: string[];
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  notification?: string;
  password?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `active?`: `boolean`; `applicationKeys?`: `string`[]; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `notification?`: `string`; `password?`: `string`; `self?`: `string`; }; `key?`: `string`; `username?`: `string`; }	-
`parameters.body`	{ `active?`: `boolean`; `applicationKeys?`: `string`[]; `displayName?`: `string`; `emailAddress?`: `string`; `key?`: `string`; `name?`: `string`; `notification?`: `string`; `password?`: `string`; `self?`: `string`; }	-
`parameters.body.active?`	`boolean`	-
`parameters.body.applicationKeys?`	`string`[]	-
`parameters.body.displayName?`	`string`	-
`parameters.body.emailAddress?`	`string`	-
`parameters.body.key?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.notification?`	`string`	-
`parameters.body.password?`	`string`	-
`parameters.body.self?`	`string`	-
`parameters.key?`	`string`	User key
`parameters.username?`	`string`	The username
`options?`	`RequestOptions`	-

Returns

users.updateUserAvatar

updateUserAvatar: (parameters, options?) => Promise<{
[key: string]: unknown;
  fileName?: string;
  id?: string;
  isDeletable?: boolean;
  isSelected?: boolean;
  isSystemAvatar?: boolean;
  owner?: string;
  selected?: boolean;
  urls?: Record<string, string>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `fileName?`: `string`; `id?`: `string`; `isDeletable?`: `boolean`; `isSelected?`: `boolean`; `isSystemAvatar?`: `boolean`; `owner?`: `string`; `selected?`: `boolean`; `urls?`: `Record`<`string`, `string`>; `username?`: `string`; }	-
`parameters.fileName?`	`string`	-
`parameters.id?`	`string`	-
`parameters.isDeletable?`	`boolean`	-
`parameters.isSelected?`	`boolean`	-
`parameters.isSystemAvatar?`	`boolean`	-
`parameters.owner?`	`string`	-
`parameters.selected?`	`boolean`	-
`parameters.urls?`	`Record`<`string`, `string`>	The avatar at each size, keyed by size.
`parameters.username?`	`string`	Username
`options?`	`RequestOptions`	-

Returns

users.validateUserAnonymization

validateUserAnonymization: (parameters?, options?) => Promise<{
[key: string]: unknown;
  affectedEntities?: Record<string, object[]>;
  businessLogicValidationFailed?: boolean;
  deleted?: boolean;
  displayName?: string;
  email?: string;
  errors?: Record<string, {
   [key: string]: unknown;
     errorMessages?: string[];
     errors?: Record<string, string>;
  }>;
  expand?: string;
  operations?: string[];
  success?: boolean;
  userKey?: string;
  userName?: string;
  warnings?: Record<string, {
   [key: string]: unknown;
     errorMessages?: string[];
     errors?: Record<string, string>;
  }>;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string`; `userKey?`: `string`; }	-
`parameters.expand?`	`string`	Parameter used to include parts of the response.
`parameters.userKey?`	`string`	The key of the user to validate anonymization for.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; affectedEntities?: Record<string, object[]>; businessLogicValidationFailed?: boolean; deleted?: boolean; displayName?: string; email?: string; errors?: Record<string, { [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, string>; }>; expand?: string; operations?: string[]; success?: boolean; userKey?: string; userName?: string; warnings?: Record<string, { [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, string>; }>; }>

users.validateUserAnonymizationRerun

validateUserAnonymizationRerun: (parameters?, options?) => Promise<{
[key: string]: unknown;
  affectedEntities?: Record<string, object[]>;
  businessLogicValidationFailed?: boolean;
  deleted?: boolean;
  displayName?: string;
  email?: string;
  errors?: Record<string, {
   [key: string]: unknown;
     errorMessages?: string[];
     errors?: Record<string, string>;
  }>;
  expand?: string;
  operations?: string[];
  success?: boolean;
  userKey?: string;
  userName?: string;
  warnings?: Record<string, {
   [key: string]: unknown;
     errorMessages?: string[];
     errors?: Record<string, string>;
  }>;
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string`; `oldUserKey?`: `string`; `oldUserName?`: `string`; `userKey?`: `string`; }	-
`parameters.expand?`	`string`	Parameter used to include parts of the response.
`parameters.oldUserKey?`	`string`	User key before anonymization, only needed when current value is anonymized. If there is no old key, e.g. because the user was already created using the new key generation strategy, provide a value equal to the current key.
`parameters.oldUserName?`	`string`	User name before anonymization, only needed when the current value is anonymized. If there is no old name, provide a value equal to the current name.
`parameters.userKey?`	`string`	The key of the user to validate anonymization for.
`options?`	`RequestOptions`	-

Returns

webhooks

webhooks: object;

webhooks.createWebhook

createWebhook: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  configuration?: Record<string, any>;
  createdDate?: number;
  events?: string[];
  id: number;
  name: string;
  scopeType?: string;
  sslVerificationRequired?: boolean;
  statistics?: {
   [key: string]: unknown;
     counts?: {
      [key: string]: unknown;
        errors?: number;
        failures?: number;
        successes?: number;
        window?: {
         [key: ...]: ...;
           duration?: ...;
           start?: ...;
        };
     };
     lastError?: Record<string, any>;
  };
  updatedDate?: number;
  url: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `configuration?`: `Record`<`string`, `any`>; `events?`: `string`[]; `excludeBody?`: `boolean`; `filters?`: `Record`<`string`, `any`>; `name`: `string`; `sslVerificationRequired?`: `boolean`; `url`: `string`; }	-
`parameters.configuration?`	`Record`<`string`, `any`>	-
`parameters.events?`	`string`[]	The events to deliver, e.g. `jira:issue_created`.
`parameters.excludeBody?`	`boolean`	Deliver the event without its body.
`parameters.filters?`	`Record`<`string`, `any`>	Narrows what is delivered, e.g. `{ "issue-related-events-section": jql }`.
`parameters.name?`	`string`	-
`parameters.sslVerificationRequired?`	`boolean`	-
`parameters.url?`	`string`	Where Jira posts the event.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; active?: boolean; configuration?: Record<string, any>; createdDate?: number; events?: string[]; id: number; name: string; scopeType?: string; sslVerificationRequired?: boolean; statistics?: { [key: string]: unknown; counts?: { [key: string]: unknown; errors?: number; failures?: number; successes?: number; window?: { [key: ...]: ...; duration?: ...; start?: ...; }; }; lastError?: Record<string, any>; }; updatedDate?: number; url: string; }>

webhooks.deleteWebhook

deleteWebhook: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

Promise<void>

webhooks.getLatestWebhookInvocation

getLatestWebhookInvocation: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

webhooks.getWebhook

getWebhook: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  configuration?: Record<string, any>;
  createdDate?: number;
  events?: string[];
  id: number;
  name: string;
  scopeType?: string;
  sslVerificationRequired?: boolean;
  statistics?: {
   [key: string]: unknown;
     counts?: {
      [key: string]: unknown;
        errors?: number;
        failures?: number;
        successes?: number;
        window?: {
         [key: ...]: ...;
           duration?: ...;
           start?: ...;
        };
     };
     lastError?: Record<string, any>;
  };
  updatedDate?: number;
  url: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

webhooks.getWebhooks

getWebhooks: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `event?`: `string`; `limit?`: `number`; `start?`: `number`; `statistics?`: `boolean`; }	-
`parameters.event?`	`string`	Only webhooks delivering this event.
`parameters.limit?`	`number`	-
`parameters.start?`	`number`	-
`parameters.statistics?`	`boolean`	Include delivery statistics with each webhook.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

webhooks.getWebhookStatistics

getWebhookStatistics: (parameters, options?) => Promise<{
[key: string]: unknown;
  counts?: {
   [key: string]: unknown;
     errors?: number;
     failures?: number;
     successes?: number;
     window?: {
      [key: string]: unknown;
        duration?: number;
        start?: number;
     };
  };
  lastError?: Record<string, any>;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; counts?: { [key: string]: unknown; errors?: number; failures?: number; successes?: number; window?: { [key: string]: unknown; duration?: number; start?: number; }; }; lastError?: Record<string, any>; }>

webhooks.getWebhookStatisticsSummary

getWebhookStatisticsSummary: (parameters, options?) => Promise<Record<string, {
[key: string]: unknown;
  counts?: {
   [key: string]: unknown;
     errors?: number;
     failures?: number;
     successes?: number;
     window?: {
      [key: string]: unknown;
        duration?: ... | ...;
        start?: ... | ...;
     };
  };
  lastError?: Record<string, any>;
}>>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

Promise<Record<string, { [key: string]: unknown; counts?: { [key: string]: unknown; errors?: number; failures?: number; successes?: number; window?: { [key: string]: unknown; duration?: ... | ...; start?: ... | ...; }; }; lastError?: Record<string, any>; }>>

webhooks.getWebhookTransitions

getWebhookTransitions: (parameters, options?) => Promise<unknown>;

Parameters

Parameter	Type	Description
`parameters`	{ `webhookId`: `number`; }	-
`parameters.webhookId`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

Promise<unknown>

webhooks.updateWebhook

updateWebhook: (parameters, options?) => Promise<{
[key: string]: unknown;
  active?: boolean;
  configuration?: Record<string, any>;
  createdDate?: number;
  events?: string[];
  id: number;
  name: string;
  scopeType?: string;
  sslVerificationRequired?: boolean;
  statistics?: {
   [key: string]: unknown;
     counts?: {
      [key: string]: unknown;
        errors?: number;
        failures?: number;
        successes?: number;
        window?: {
         [key: ...]: ...;
           duration?: ...;
           start?: ...;
        };
     };
     lastError?: Record<string, any>;
  };
  updatedDate?: number;
  url: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `configuration?`: `Record`<`string`, `any`>; `events?`: `string`[]; `excludeBody?`: `boolean`; `filters?`: `Record`<`string`, `any`>; `name`: `string`; `sslVerificationRequired?`: `boolean`; `url`: `string`; `webhookId`: `number`; }	-
`parameters.configuration?`	`Record`<`string`, `any`>	-
`parameters.events?`	`string`[]	The events to deliver, e.g. `jira:issue_created`.
`parameters.excludeBody?`	`boolean`	Deliver the event without its body.
`parameters.filters?`	`Record`<`string`, `any`>	Narrows what is delivered, e.g. `{ "issue-related-events-section": jql }`.
`parameters.name?`	`string`	-
`parameters.sslVerificationRequired?`	`boolean`	-
`parameters.url?`	`string`	Where Jira posts the event.
`parameters.webhookId?`	`number`	The id of the webhook.
`options?`	`RequestOptions`	-

Returns

websudo

websudo: object;

websudo.release

release: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type
`parameters`	{ `body?`: `string`; }
`parameters.body?`	`string`
`options?`	`RequestOptions`

Returns

Promise<void>

workflows

workflows: object;

workflows.getAllWorkflows

getAllWorkflows: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `workflowName?`: `string`; }	-
`parameters.workflowName?`	`string`	An optional String containing workflow name. If not passed then all workflows are returned
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

workflowSchemes

workflowSchemes: object;

workflowSchemes.createDraftForParent

createDraftForParent: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.createScheme

createScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type
`parameters`	{ `defaultWorkflow?`: `string`; `description?`: `string`; `draft?`: `boolean`; `id?`: `number`; `issueTypeMappings?`: `Record`<`string`, `string`>; `issueTypes?`: `Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>; `lastModified?`: `string`; `lastModifiedUser?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `name?`: `string`; `originalDefaultWorkflow?`: `string`; `originalIssueTypeMappings?`: `Record`<`string`, `string`>; `self?`: `string`; `updateDraftIfNeeded?`: `boolean`; }
`parameters.defaultWorkflow?`	`string`
`parameters.description?`	`string`
`parameters.draft?`	`boolean`
`parameters.id?`	`number`
`parameters.issueTypeMappings?`	`Record`<`string`, `string`>
`parameters.issueTypes?`	`Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>
`parameters.lastModified?`	`string`
`parameters.lastModifiedUser?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }
`parameters.lastModifiedUser.active?`	`boolean`
`parameters.lastModifiedUser.applicationRoles?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.lastModifiedUser.applicationRoles.callback?`	`Record`<`string`, `never`>
`parameters.lastModifiedUser.applicationRoles.maxResults?`	`number`
`parameters.lastModifiedUser.applicationRoles.pagingCallback?`	`Record`<`string`, `never`>
`parameters.lastModifiedUser.applicationRoles.size?`	`number`
`parameters.lastModifiedUser.avatarUrls?`	`Record`<`string`, `string`>
`parameters.lastModifiedUser.deleted?`	`boolean`
`parameters.lastModifiedUser.displayName?`	`string`
`parameters.lastModifiedUser.emailAddress?`	`string`
`parameters.lastModifiedUser.expand?`	`string`
`parameters.lastModifiedUser.groups?`	{ `callback?`: `Record`<`string`, `never`>; `maxResults?`: `number`; `pagingCallback?`: `Record`<`string`, `never`>; `size?`: `number`; }
`parameters.lastModifiedUser.groups.callback?`	`Record`<`string`, `never`>
`parameters.lastModifiedUser.groups.maxResults?`	`number`
`parameters.lastModifiedUser.groups.pagingCallback?`	`Record`<`string`, `never`>
`parameters.lastModifiedUser.groups.size?`	`number`
`parameters.lastModifiedUser.key?`	`string`
`parameters.lastModifiedUser.lastLoginTime?`	`string`
`parameters.lastModifiedUser.locale?`	`string`
`parameters.lastModifiedUser.name?`	`string`
`parameters.lastModifiedUser.self?`	`string`
`parameters.lastModifiedUser.timeZone?`	`string`
`parameters.name?`	`string`
`parameters.originalDefaultWorkflow?`	`string`
`parameters.originalIssueTypeMappings?`	`Record`<`string`, `string`>
`parameters.self?`	`string`
`parameters.updateDraftIfNeeded?`	`boolean`
`options?`	`RequestOptions`

Returns

workflowSchemes.deleteDefault

deleteDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `updateDraftIfNeeded?`: `boolean`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.updateDraftIfNeeded?`	`boolean`	When true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project).
`options?`	`RequestOptions`	-

Returns

workflowSchemes.deleteDraftById

deleteDraftById: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

Promise<void>

workflowSchemes.deleteDraftDefault

deleteDraftDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.deleteDraftIssueType

deleteDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `issueType`: `string`; }	-
`parameters.id`	`number`	The parent of the draft scheme.
`parameters.issueType?`	`string`	The issue type to remove.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.deleteDraftWorkflowMapping

deleteDraftWorkflowMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `workflowName?`: `string`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`parameters.workflowName?`	`string`	The name of the workflow to delete.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.deleteScheme

deleteScheme: (parameters, options?) => Promise<void>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the scheme.
`options?`	`RequestOptions`	-

Returns

Promise<void>

workflowSchemes.deleteWorkflowMapping

deleteWorkflowMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `updateDraftIfNeeded?`: `boolean`; `workflowName?`: `string`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.updateDraftIfNeeded?`	`boolean`	Flag to indicate if a draft should be created if necessary to delete the workflow from the scheme.
`parameters.workflowName?`	`string`	The name of the workflow to delete.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.deleteWorkflowSchemeIssueType

deleteWorkflowSchemeIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `issueType`: `string`; `updateDraftIfNeeded?`: `boolean`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.issueType?`	`string`	The issue type to remove.
`parameters.updateDraftIfNeeded?`	`boolean`	When true will create and return a draft when the workflow scheme cannot be edited (e.g. when it is being used by a project).
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getById

getById: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `returnDraftIfExists?`: `boolean`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.returnDraftIfExists?`	`boolean`	When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getDefault

getDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `returnDraftIfExists?`: `boolean`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.returnDraftIfExists?`	`boolean`	When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getDraftById

getDraftById: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getDraftDefault

getDraftDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getDraftIssueType

getDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueType?: string;
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `issueType`: `string`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`parameters.issueType?`	`string`	The issue type to query.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemes.getDraftWorkflow

getDraftWorkflow: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `workflowName?`: `string`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`parameters.workflowName?`	`string`	The workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.getWorkflow

getWorkflow: (parameters, options?) => Promise<
  | {
[key: string]: unknown;
  defaultMapping?: boolean;
  issueTypes?: string[];
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}
| object[]>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `returnDraftIfExists?`: `boolean`; `workflowName?`: `string`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.returnDraftIfExists?`	`boolean`	When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
`parameters.workflowName?`	`string`	The workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name.
`options?`	`RequestOptions`	-

Returns

Promise< | { [key: string]: unknown; defaultMapping?: boolean; issueTypes?: string[]; updateDraftIfNeeded?: boolean; workflow?: string; } | object[]>

workflowSchemes.getWorkflowSchemeIssueType

getWorkflowSchemeIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  issueType?: string;
  updateDraftIfNeeded?: boolean;
  workflow?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `issueType`: `string`; `returnDraftIfExists?`: `boolean`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.issueType?`	`string`	The issue type to query.
`parameters.returnDraftIfExists?`	`boolean`	When true indicates that a scheme's draft, if it exists, should be queried instead of the scheme itself.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; issueType?: string; updateDraftIfNeeded?: boolean; workflow?: string; }>

workflowSchemes.setDraftIssueType

setDraftIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `issueType?`: `string`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }; `id`: `number`; `issueType`: `string`; }	-
`parameters.body`	{ `issueType?`: `string`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }	-
`parameters.body.issueType?`	`string`	-
`parameters.body.updateDraftIfNeeded?`	`boolean`	-
`parameters.body.workflow?`	`string`	-
`parameters.id?`	`number`	The id of the parent scheme.
`parameters.issueType?`	`string`	The issue type being set.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.setIssueType

setIssueType: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `issueType?`: `string`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }; `id`: `number`; `issueType`: `string`; }	-
`parameters.body`	{ `issueType?`: `string`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }	-
`parameters.body.issueType?`	`string`	-
`parameters.body.updateDraftIfNeeded?`	`boolean`	-
`parameters.body.workflow?`	`string`	-
`parameters.id?`	`number`	The id of the scheme.
`parameters.issueType?`	`string`	The issue type being set.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateDefault

updateDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }	-
`parameters.id`	`number`	The id of the scheme.
`parameters.updateDraftIfNeeded?`	`boolean`	-
`parameters.workflow?`	`string`	-
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateDraft

updateDraft: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `defaultWorkflow?`: `string`; `description?`: `string`; `draft?`: `boolean`; `id?`: `number`; `issueTypeMappings?`: `Record`<`string`, `string`>; `issueTypes?`: `Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>; `lastModified?`: `string`; `lastModifiedUser?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `name?`: `string`; `originalDefaultWorkflow?`: `string`; `originalIssueTypeMappings?`: `Record`<`string`, `string`>; `self?`: `string`; `updateDraftIfNeeded?`: `boolean`; }; `id`: `number`; }	-
`parameters.body`	{ `defaultWorkflow?`: `string`; `description?`: `string`; `draft?`: `boolean`; `id?`: `number`; `issueTypeMappings?`: `Record`<`string`, `string`>; `issueTypes?`: `Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>; `lastModified?`: `string`; `lastModifiedUser?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `name?`: `string`; `originalDefaultWorkflow?`: `string`; `originalIssueTypeMappings?`: `Record`<`string`, `string`>; `self?`: `string`; `updateDraftIfNeeded?`: `boolean`; }	-
`parameters.body.defaultWorkflow?`	`string`	-
`parameters.body.description?`	`string`	-
`parameters.body.draft?`	`boolean`	-
`parameters.body.id?`	`number`	-
`parameters.body.issueTypeMappings?`	`Record`<`string`, `string`>	-
`parameters.body.issueTypes?`	`Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>	-
`parameters.body.lastModified?`	`string`	-
`parameters.body.lastModifiedUser?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.lastModifiedUser.active?`	`boolean`	-
`parameters.body.lastModifiedUser.applicationRoles?`	{ `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }	-
`parameters.body.lastModifiedUser.applicationRoles.callback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.applicationRoles.maxResults?`	`number`	-
`parameters.body.lastModifiedUser.applicationRoles.pagingCallback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.applicationRoles.size?`	`number`	-
`parameters.body.lastModifiedUser.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.lastModifiedUser.deleted?`	`boolean`	-
`parameters.body.lastModifiedUser.displayName?`	`string`	-
`parameters.body.lastModifiedUser.emailAddress?`	`string`	-
`parameters.body.lastModifiedUser.expand?`	`string`	-
`parameters.body.lastModifiedUser.groups?`	{ `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }	-
`parameters.body.lastModifiedUser.groups.callback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.groups.maxResults?`	`number`	-
`parameters.body.lastModifiedUser.groups.pagingCallback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.groups.size?`	`number`	-
`parameters.body.lastModifiedUser.key?`	`string`	-
`parameters.body.lastModifiedUser.lastLoginTime?`	`string`	-
`parameters.body.lastModifiedUser.locale?`	`string`	-
`parameters.body.lastModifiedUser.name?`	`string`	-
`parameters.body.lastModifiedUser.self?`	`string`	-
`parameters.body.lastModifiedUser.timeZone?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.originalDefaultWorkflow?`	`string`	-
`parameters.body.originalIssueTypeMappings?`	`Record`<`string`, `string`>	-
`parameters.body.self?`	`string`	-
`parameters.body.updateDraftIfNeeded?`	`boolean`	-
`parameters.id?`	`number`	The id of the parent scheme.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateDraftDefault

updateDraftDefault: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `id`: `number`; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; }	-
`parameters.id`	`number`	The id of the parent scheme.
`parameters.updateDraftIfNeeded?`	`boolean`	-
`parameters.workflow?`	`string`	-
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateDraftWorkflowMapping

updateDraftWorkflowMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `defaultMapping?`: `boolean`; `id`: `number`; `issueTypes?`: `string`[]; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; `workflowName?`: `string`; }	-
`parameters.defaultMapping?`	`boolean`	-
`parameters.id?`	`number`	The id of the parent scheme.
`parameters.issueTypes?`	`string`[]	-
`parameters.updateDraftIfNeeded?`	`boolean`	-
`parameters.workflow?`	`string`	-
`parameters.workflowName?`	`string`	The name of the workflow mapping to update.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateWorkflowMapping

updateWorkflowMapping: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `defaultMapping?`: `boolean`; `id`: `number`; `issueTypes?`: `string`[]; `updateDraftIfNeeded?`: `boolean`; `workflow?`: `string`; `workflowName?`: `string`; }	-
`parameters.defaultMapping?`	`boolean`	-
`parameters.id?`	`number`	The id of the scheme.
`parameters.issueTypes?`	`string`[]	-
`parameters.updateDraftIfNeeded?`	`boolean`	-
`parameters.workflow?`	`string`	-
`parameters.workflowName?`	`string`	The name of the workflow mapping to update.
`options?`	`RequestOptions`	-

Returns

workflowSchemes.updateWorkflowScheme

updateWorkflowScheme: (parameters, options?) => Promise<{
[key: string]: unknown;
  defaultWorkflow?: string;
  description?: string;
  draft?: boolean;
  id?: number;
  issueTypeMappings?: Record<string, string>;
  issueTypes?: Record<string, {
   [key: string]: unknown;
     avatarId?: number;
     description?: string;
     iconUrl?: string;
     id?: string;
     name?: string;
     self?: string;
     subtask?: boolean;
  }>;
  lastModified?: string;
  lastModifiedUser?: {
   [key: string]: unknown;
     active?: boolean;
     applicationRoles?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     avatarUrls?: Record<string, string>;
     deleted?: boolean;
     displayName?: string;
     emailAddress?: string;
     expand?: string;
     groups?: {
      [key: string]: unknown;
        callback?: {
         [key: ...]: ...;
        };
        maxResults?: number;
        pagingCallback?: {
         [key: ...]: ...;
        };
        size?: number;
     };
     key?: string;
     lastLoginTime?: string;
     locale?: string;
     name?: string;
     self?: string;
     timeZone?: string;
  };
  name?: string;
  originalDefaultWorkflow?: string;
  originalIssueTypeMappings?: Record<string, string>;
  self?: string;
  updateDraftIfNeeded?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body`: { `defaultWorkflow?`: `string`; `description?`: `string`; `draft?`: `boolean`; `id?`: `number`; `issueTypeMappings?`: `Record`<`string`, `string`>; `issueTypes?`: `Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>; `lastModified?`: `string`; `lastModifiedUser?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `name?`: `string`; `originalDefaultWorkflow?`: `string`; `originalIssueTypeMappings?`: `Record`<`string`, `string`>; `self?`: `string`; `updateDraftIfNeeded?`: `boolean`; }; `id`: `number`; }	-
`parameters.body`	{ `defaultWorkflow?`: `string`; `description?`: `string`; `draft?`: `boolean`; `id?`: `number`; `issueTypeMappings?`: `Record`<`string`, `string`>; `issueTypes?`: `Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>; `lastModified?`: `string`; `lastModifiedUser?`: { `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }; `name?`: `string`; `originalDefaultWorkflow?`: `string`; `originalIssueTypeMappings?`: `Record`<`string`, `string`>; `self?`: `string`; `updateDraftIfNeeded?`: `boolean`; }	-
`parameters.body.defaultWorkflow?`	`string`	-
`parameters.body.description?`	`string`	-
`parameters.body.draft?`	`boolean`	-
`parameters.body.id?`	`number`	-
`parameters.body.issueTypeMappings?`	`Record`<`string`, `string`>	-
`parameters.body.issueTypes?`	`Record`<`string`, { `avatarId?`: `number`; `description?`: `string`; `iconUrl?`: `string`; `id?`: `string`; `name?`: `string`; `self?`: `string`; `subtask?`: `boolean`; }>	-
`parameters.body.lastModified?`	`string`	-
`parameters.body.lastModifiedUser?`	{ `active?`: `boolean`; `applicationRoles?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `avatarUrls?`: `Record`<`string`, `string`>; `deleted?`: `boolean`; `displayName?`: `string`; `emailAddress?`: `string`; `expand?`: `string`; `groups?`: { `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }; `key?`: `string`; `lastLoginTime?`: `string`; `locale?`: `string`; `name?`: `string`; `self?`: `string`; `timeZone?`: `string`; }	-
`parameters.body.lastModifiedUser.active?`	`boolean`	-
`parameters.body.lastModifiedUser.applicationRoles?`	{ `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }	-
`parameters.body.lastModifiedUser.applicationRoles.callback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.applicationRoles.maxResults?`	`number`	-
`parameters.body.lastModifiedUser.applicationRoles.pagingCallback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.applicationRoles.size?`	`number`	-
`parameters.body.lastModifiedUser.avatarUrls?`	`Record`<`string`, `string`>	-
`parameters.body.lastModifiedUser.deleted?`	`boolean`	-
`parameters.body.lastModifiedUser.displayName?`	`string`	-
`parameters.body.lastModifiedUser.emailAddress?`	`string`	-
`parameters.body.lastModifiedUser.expand?`	`string`	-
`parameters.body.lastModifiedUser.groups?`	{ `callback?`: `Record`<..., ...>; `maxResults?`: `number`; `pagingCallback?`: `Record`<..., ...>; `size?`: `number`; }	-
`parameters.body.lastModifiedUser.groups.callback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.groups.maxResults?`	`number`	-
`parameters.body.lastModifiedUser.groups.pagingCallback?`	`Record`<..., ...>	-
`parameters.body.lastModifiedUser.groups.size?`	`number`	-
`parameters.body.lastModifiedUser.key?`	`string`	-
`parameters.body.lastModifiedUser.lastLoginTime?`	`string`	-
`parameters.body.lastModifiedUser.locale?`	`string`	-
`parameters.body.lastModifiedUser.name?`	`string`	-
`parameters.body.lastModifiedUser.self?`	`string`	-
`parameters.body.lastModifiedUser.timeZone?`	`string`	-
`parameters.body.name?`	`string`	-
`parameters.body.originalDefaultWorkflow?`	`string`	-
`parameters.body.originalIssueTypeMappings?`	`Record`<`string`, `string`>	-
`parameters.body.self?`	`string`	-
`parameters.body.updateDraftIfNeeded?`	`boolean`	-
`parameters.id?`	`number`	The id of the scheme.
`options?`	`RequestOptions`	-

Returns

workflowStatusCategories

workflowStatusCategories: object;

workflowStatusCategories.getStatusCategories

getStatusCategories: (parameters?, options?) => Promise<object[]>;

Parameters

Parameter	Type	Description
`parameters?`	{ `request?`: `string`; `uriInfo?`: `string`; }	-
`parameters.request?`	`string`	A Request
`parameters.uriInfo?`	`string`	A UriInfo
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

workflowStatusCategories.getStatusCategory

getStatusCategory: (parameters, options?) => Promise<{
[key: string]: unknown;
  colorName?: string;
  id?: number;
  key?: string;
  name?: string;
  self?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `idOrKey`: `string`; }	-
`parameters.idOrKey`	`string`	A numeric StatusCategory id or a status category key
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }>

workflowStatuses

workflowStatuses: object;

workflowStatuses.getPaginatedStatuses

getPaginatedStatuses: (parameters?, options?) => Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `issueTypeIds?`: `string`[]; `maxResults?`: `number`; `projectIds?`: `number`[]; `query?`: `string`; `startAt?`: `number`; }	-
`parameters.issueTypeIds?`	`string`[]	The list of issue type ids to filter statuses.
`parameters.maxResults?`	`number`	The maximum number of statuses to return.
`parameters.projectIds?`	`number`[]	The list of project ids to filter statuses.
`parameters.query?`	`string`	The string that status names will be matched with.
`parameters.startAt?`	`number`	The index of the first status to return.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>

workflowStatuses.getStatus

getStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  description?: string;
  iconUrl?: string;
  id?: string;
  name?: string;
  self?: string;
  statusCategory?: {
   [key: string]: unknown;
     colorName?: string;
     id?: number;
     key?: string;
     name?: string;
     self?: string;
  };
  statusColor?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `idOrName`: `string`; }	-
`parameters.idOrName`	`string`	A numeric Status id or a status name
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; description?: string; iconUrl?: string; id?: string; name?: string; self?: string; statusCategory?: { [key: string]: unknown; colorName?: string; id?: number; key?: string; name?: string; self?: string; }; statusColor?: string; }>

workflowStatuses.getStatuses

getStatuses: (options?) => Promise<object[]>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<object[]>

Function: createServerClient() ​

Parameters ​

Returns ​

applicationProperties ​

applicationProperties.getAdvancedSettings ​

Parameters ​

Returns ​

applicationProperties.getApplicationProperties ​

Parameters ​

Returns ​

applicationProperties.setPropertyViaRestfulTable ​

Parameters ​

Returns ​

applicationRoles ​

applicationRoles.getAll ​

Parameters ​

Returns ​

applicationRoles.getApplicationRole ​

Parameters ​

Returns ​

applicationRoles.putBulk ​

Parameters ​

Returns ​

applicationRoles.updateApplicationRole ​

Parameters ​

Returns ​

avatars ​

avatars.createAvatarFromTemporary ​

Parameters ​

Returns ​

avatars.deleteAvatar ​

Parameters ​

Returns ​

avatars.getAllSystemAvatars ​

Parameters ​

Returns ​

avatars.getAvatars ​

Parameters ​

Returns ​

avatars.storeTemporaryAvatarUsingMultiPart ​

Parameters ​

Returns ​

backlog ​

backlog.moveIssuesToBacklog ​

Parameters ​

Returns ​

board ​

board.createBoard ​

Parameters ​

Returns ​

board.deleteBoard ​

Parameters ​

Returns ​

board.deleteBoardProperty ​

Parameters ​

Returns ​

board.getAllBoards ​

Parameters ​

Returns ​

board.getAllSprints ​

Parameters ​

Returns ​

board.getAllVersions ​

Parameters ​

Returns ​

board.getBoard ​

Parameters ​

Returns ​

board.getBoardConfiguration ​

Parameters ​

Returns ​

board.getBoardProperty ​

Parameters ​

Returns ​

board.getBoardPropertyKeys ​

Parameters ​

Returns ​

board.getEpics ​

Parameters ​

Returns ​

Function: createServerClient()

Parameters

Returns

applicationProperties

applicationProperties.getAdvancedSettings

Parameters

Returns

applicationProperties.getApplicationProperties

Parameters

Returns

applicationProperties.setPropertyViaRestfulTable

Parameters

Returns

applicationRoles

applicationRoles.getAll

Parameters

Returns

applicationRoles.getApplicationRole

Parameters

Returns

applicationRoles.putBulk

Parameters

Returns

applicationRoles.updateApplicationRole

Parameters

Returns

avatars

avatars.createAvatarFromTemporary

Parameters

Returns

avatars.deleteAvatar

Parameters

Returns

avatars.getAllSystemAvatars

Parameters

Returns

avatars.getAvatars

Parameters

Returns

avatars.storeTemporaryAvatarUsingMultiPart

Parameters

Returns

backlog

backlog.moveIssuesToBacklog

Parameters

Returns

board

board.createBoard

Parameters

Returns

board.deleteBoard

Parameters

Returns

board.deleteBoardProperty

Parameters

Returns

board.getAllBoards

Parameters

Returns

board.getAllSprints

Parameters

Returns

board.getAllVersions

Parameters

Returns

board.getBoard

Parameters

Returns

board.getBoardConfiguration

Parameters

Returns

board.getBoardProperty

Parameters

Returns

board.getBoardPropertyKeys

Parameters

Returns

board.getEpics

Parameters

Returns