Function: createServiceDeskServerClient()

function createServiceDeskServerClient(clientConfig): object;

Defined in: src/serviceDeskServer/createServiceDeskServerClient.ts:117

Parameters

Parameter	Type
`clientConfig`	\| `Client` \| `ServiceDeskServerClientConfig`

Returns

object

approvals

approvals: object;

approvals.answerApproval

answerApproval: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  approvers?: object[];
  canAnswerApproval?: boolean;
  completedDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  condition?: {
   [key: string]: unknown;
     type?: string;
     value?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  finalDecision?: "pending" | string & object | "approved" | "declined";
  id?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `approvalId`: `string`; `comment?`: `string`; `commentPublic?`: `boolean`; `decision?`: `string` & `object` \| `"approve"` \| `"decline"`; `issueIdOrKey`: `string`; }	-
`parameters.approvalId`	`string`	The id of the approval.
`parameters.comment?`	`string`	-
`parameters.commentPublic?`	`boolean`	-
`parameters.decision?`	`string` & `object` \| `"approve"` \| `"decline"`	-
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; approvers?: object[]; canAnswerApproval?: boolean; completedDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; condition?: { [key: string]: unknown; type?: string; value?: string; }; createdDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; finalDecision?: "pending" | string & object | "approved" | "declined"; id?: string; name?: string; }>

approvals.getApprovalById

getApprovalById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  approvers?: object[];
  canAnswerApproval?: boolean;
  completedDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  condition?: {
   [key: string]: unknown;
     type?: string;
     value?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  finalDecision?: "pending" | string & object | "approved" | "declined";
  id?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `approvalId`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.approvalId`	`string`	The id of the approval.
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

approvals.getApprovalCommentConfig

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

Parameters

Parameter	Type	Description
`parameters`	{ `approvalId`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.approvalId`	`string`	The id of the approval.
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

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

approvals.getApprovals

getApprovals: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }>

customerRequests

customerRequests: object;

customerRequests.addRequestParticipants

addRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; `usernames?`: `string`[]; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`parameters.usernames?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

customerRequests.createCustomerRequest

createCustomerRequest: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     jiraRest?: string;
     self?: string;
     web?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  currentStatus?: {
   [key: string]: unknown;
     status?: string;
     statusDate?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
  };
  issueId?: string;
  issueKey?: string;
  participants?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  reporter?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  requestFieldValues?: object[];
  requestType?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     description?: string;
     groupIds?: string[];
     helpText?: string;
     icon?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           iconUrls?: ...;
        };
        id?: string;
     };
     id?: string;
     name?: string;
     restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
     serviceDeskId?: string;
  };
  requestTypeId?: string;
  serviceDesk?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        portal?: string;
        self?: string;
     };
     id?: string;
     projectId?: string;
     projectKey?: string;
     projectName?: string;
  };
  serviceDeskId?: string;
  sla?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  status?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
}>;

Parameters

Parameter	Type
`parameters`	{ `raiseOnBehalfOf?`: `string`; `requestFieldValues?`: `Record`<`string`, `any`>; `requestParticipants?`: `string`[]; `requestTypeId?`: `string`; `serviceDeskId?`: `string`; }
`parameters.raiseOnBehalfOf?`	`string`
`parameters.requestFieldValues?`	`Record`<`string`, `any`>
`parameters.requestParticipants?`	`string`[]
`parameters.requestTypeId?`	`string`
`parameters.serviceDeskId?`	`string`
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; jiraRest?: string; self?: string; web?: string; }; createdDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; currentStatus?: { [key: string]: unknown; status?: string; statusDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; }; issueId?: string; issueKey?: string; participants?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }; reporter?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<..., ...>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; requestFieldValues?: object[]; requestType?: { [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; description?: string; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: ...]: ...; iconUrls?: ...; }; id?: string; }; id?: string; name?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }; requestTypeId?: string; serviceDesk?: { [key: string]: unknown; _links?: { [key: string]: unknown; portal?: string; self?: string; }; id?: string; projectId?: string; projectKey?: string; projectName?: string; }; serviceDeskId?: string; sla?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }; status?: { [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }; }>

customerRequests.createRequestComment

createRequestComment: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `body?`: `string`; `issueIdOrKey`: `string`; `public?`: `boolean`; }	-
`parameters.body?`	`string`	-
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`parameters.public?`	`boolean`	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; author?: { [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<..., ...>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; body?: string; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; public?: boolean; }>

customerRequests.getCustomerRequestByIdOrKey

getCustomerRequestByIdOrKey: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     jiraRest?: string;
     self?: string;
     web?: string;
  };
  createdDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  currentStatus?: {
   [key: string]: unknown;
     status?: string;
     statusDate?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
  };
  issueId?: string;
  issueKey?: string;
  participants?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  reporter?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  requestFieldValues?: object[];
  requestType?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     description?: string;
     groupIds?: string[];
     helpText?: string;
     icon?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           iconUrls?: ...;
        };
        id?: string;
     };
     id?: string;
     name?: string;
     restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
     serviceDeskId?: string;
  };
  requestTypeId?: string;
  serviceDesk?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        portal?: string;
        self?: string;
     };
     id?: string;
     projectId?: string;
     projectKey?: string;
     projectName?: string;
  };
  serviceDeskId?: string;
  sla?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
  status?: {
   [key: string]: unknown;
     _expands?: string[];
     _links?: {
      [key: string]: unknown;
        base?: string;
        context?: string;
        next?: string;
        prev?: string;
        self?: string;
     };
     isLastPage?: boolean;
     limit?: number;
     maxResultWindow?: number;
     size?: number;
     start?: number;
     values?: object[];
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `expand?`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.expand?`	`string`	This is a multi-value parameter indicating which properties of the customer request to expand: - `serviceDesk` - Return additional details for each service project in the response. - `requestType` - Return additional details for each request type in the response. - `participant` - Return the participant details, if any, for each customer request in the response. - `sla` - Return the SLA information on the given request. - `status` - Return the status transitions, in chronological order, for each customer request in the response.
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

customerRequests.getCustomerRequestStatus

getCustomerRequestStatus: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerRequests.getMyCustomerRequests

getMyCustomerRequests: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `expand?`: `string`; `limit?`: `number`; `requestOwnership?`: `string`; `requestStatus?`: `string`; `requestTypeId?`: `string`; `searchTerm?`: `string`; `serviceDeskId?`: `string`; `start?`: `number`; }	-
`parameters.expand?`	`string`	This is a multi-value parameter indicating which properties of the customer request to expand: - `serviceDesk` - Return additional details for each service project in the response. - `requestType` - Return additional details for each request type in the response. - `participant` - Return the participant details, if any, for each customer request in the response. - `sla` - Return the SLA information on the given request. - `status` - Return the status transitions, in chronological order, for each customer request in the response.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.requestOwnership?`	`string`	Filters results to customer requests where the user is the creator and/or participant: - `OWNED_REQUESTS` - Only return customer requests where the user is the creator. - `PARTICIPATED_REQUESTS` - Only return customer requests where the user is a participant. - `ALL_REQUESTS` - Return customer requests where the user is the creator or a participant.
`parameters.requestStatus?`	`string`	Filters results to customer requests that are resolved, unresolved, or either of the two: - `CLOSED_REQUESTS` - Only return customer requests that are resolved. - `OPEN_REQUESTS` - Only return customer requests that are unresolved. - `ALL_REQUESTS` - Returns customer requests that are either resolved or unresolved.
`parameters.requestTypeId?`	`string`	Filters results to customer requests of a specific request type. You must also specify the `serviceDeskID` for the service desk that the request type belongs to.
`parameters.searchTerm?`	`string`	Filters results to customer requests where the issue summary matches the `searchTerm`. You can use wildcards in the `searchTerm`.
`parameters.serviceDeskId?`	`string`	Filters results to customer requests from a specific service project.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerRequests.getRequestCommentById

getRequestCommentById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  author?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        avatarUrls?: Record<..., ...>;
        jiraRest?: string;
        self?: string;
     };
     active?: boolean;
     displayName?: string;
     emailAddress?: string;
     key?: string;
     name?: string;
     timeZone?: string;
  };
  body?: string;
  created?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  id?: string;
  public?: boolean;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `commentId`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.commentId`	`string`	ID of the comment to retrieve.
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

customerRequests.getRequestComments

getRequestComments: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `internal?`: `string`; `issueIdOrKey`: `string`; `limit?`: `number`; `public?`: `string`; `start?`: `number`; }	-
`parameters.internal?`	`string`	Specifies whether to return internal comments or not. Default: true.
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.public?`	`string`	Specifies whether to return public comments or not. Default: true.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerRequests.getRequestParticipants

getRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerRequests.getSlaInformation

getSlaInformation: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerRequests.getSlaInformationById

getSlaInformationById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  completedCycles?: object[];
  id?: string;
  name?: string;
  ongoingCycle?: {
   [key: string]: unknown;
     breached?: boolean;
     breachTime?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     elapsedTime?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     goalDuration?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     paused?: boolean;
     remainingTime?: {
      [key: string]: unknown;
        friendly?: string;
        millis?: number;
     };
     startTime?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     withinCalendarHours?: boolean;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `slaMetricId`: `string`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.slaMetricId?`	`string`	The id of the SLA metric.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; completedCycles?: object[]; id?: string; name?: string; ongoingCycle?: { [key: string]: unknown; breached?: boolean; breachTime?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; elapsedTime?: { [key: string]: unknown; friendly?: string; millis?: number; }; goalDuration?: { [key: string]: unknown; friendly?: string; millis?: number; }; paused?: boolean; remainingTime?: { [key: string]: unknown; friendly?: string; millis?: number; }; startTime?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; withinCalendarHours?: boolean; }; }>

customerRequests.removeRequestParticipants

removeRequestParticipants: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; `usernames?`: `string`[]; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`parameters.usernames?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

customers

customers: object;

customers.addCustomers

addCustomers: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, any>;
     jiraRest?: string;
     self?: string;
  };
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `serviceDeskId`: `string`; `usernames?`: `string`[]; }	-
`parameters.serviceDeskId`	`string`	The ID of the service project.
`parameters.usernames?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, any>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }>

customers.createCustomer

createCustomer: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, any>;
     jiraRest?: string;
     self?: string;
  };
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Parameters

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

Returns

customerTransitions

customerTransitions: object;

customerTransitions.getCustomerTransitions

getCustomerTransitions: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `issueIdOrKey`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.issueIdOrKey`	`string`	The id or key of the customer request.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

customerTransitions.performCustomerTransition

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

Parameters

Parameter	Type	Description
`parameters`	{ `additionalComment?`: { `body?`: `string`; }; `id?`: `string`; `issueIdOrKey`: `string`; }	-
`parameters.additionalComment?`	{ `body?`: `string`; }	-
`parameters.additionalComment.body?`	`string`	-
`parameters.id?`	`string`	-
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`options?`	`RequestOptions`	-

Returns

Promise<void>

info

info: object;

info.getInfo

getInfo: (options?) => Promise<{
[key: string]: unknown;
  buildChangeSet?: string;
  buildDate?: {
   [key: string]: unknown;
     epochMillis?: number;
     friendly?: string;
     iso8601?: string;
     jira?: string;
  };
  get_links?: {
   [key: string]: unknown;
     self?: string;
  };
  isLicensedForUse?: boolean;
  platformVersion?: string;
  version?: string;
}>;

Parameters

Parameter	Type
`options?`	`RequestOptions`

Returns

Promise<{ [key: string]: unknown; buildChangeSet?: string; buildDate?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; get_links?: { [key: string]: unknown; self?: string; }; isLicensedForUse?: boolean; platformVersion?: string; version?: string; }>

organizations

organizations: object;

organizations.addUsersToOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; `usernames?`: `string`[]; }	-
`parameters.organizationId`	`string`	The ID of the organization.
`parameters.usernames?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

organizations.cleanUpOrganizations

cleanUpOrganizations: (parameters, options?) => Promise<number>;

Parameters

Parameter	Type	Description
`parameters`	{ `deleteDetachedOrganizations?`: `string`; `deleteOrganizationsWithInactiveUsers?`: `string`; }	-
`parameters.deleteDetachedOrganizations?`	`string`	If true, in addition, delete organizations that are not attached to any projects.
`parameters.deleteOrganizationsWithInactiveUsers?`	`string`	If true, in addition, delete organizations that have no active users.
`options?`	`RequestOptions`	-

Returns

Promise<number>

organizations.createOrganization

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

Parameters

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

Returns

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

organizations.deleteOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; }	-
`parameters.organizationId`	`string`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

Promise<void>

organizations.getOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; }	-
`parameters.organizationId`	`string`	The ID of the organization.
`options?`	`RequestOptions`	-

Returns

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

organizations.getOrganizations

getOrganizations: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `limit?`: `number`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

organizations.getUsersInOrganization

getUsersInOrganization: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `organizationId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.organizationId?`	`string`	The ID of the organization.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

organizations.previewCleanUpOrganizations

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

Parameters

Parameter	Type	Description
`parameters?`	{ `deleteDetachedOrganizations?`: `string`; `deleteOrganizationsWithInactiveUsers?`: `string`; }	-
`parameters.deleteDetachedOrganizations?`	`string`	If true, in addition, preview the deletion of organizations that are not attached to any projects. Default is false.
`parameters.deleteOrganizationsWithInactiveUsers?`	`string`	If true, in addition, preview the deletion of organizations that have no active users. Default is false.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

organizations.removeUsersFromOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId`: `string`; `usernames?`: `string`[]; }	-
`parameters.organizationId`	`string`	The ID of the organization.
`parameters.usernames?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<void>

portals

portals: object;

portals.getPortal

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

Parameters

Parameter	Type	Description
`parameters`	{ `portalId`: `string`; }	-
`parameters.portalId`	`string`	The id of the portal.
`options?`	`RequestOptions`	-

Returns

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

portals.getPortalByProjectKey

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

Parameters

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

Returns

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

portals.getPortals

getPortals: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `limit?`: `number`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

queues

queues: object;

queues.createQueue

createQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  fields?: string[];
  id?: string;
  issueCount?: number;
  jql?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `fields?`: `string`[]; `jql?`: `string`; `name?`: `string`; `serviceDeskId`: `string`; }	-
`parameters.fields?`	`string`[]	-
`parameters.jql?`	`string`	-
`parameters.name?`	`string`	-
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; fields?: string[]; id?: string; issueCount?: number; jql?: string; name?: string; }>

queues.deleteQueue

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

Parameters

Parameter	Type	Description
`parameters`	{ `queueId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.queueId`	`string`	The id of the queue.
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`options?`	`RequestOptions`	-

Returns

Promise<void>

queues.getIssuesInQueue

getIssuesInQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `queueId`: `string`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.queueId?`	`string`	The id of the queue.
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

queues.getQueue

getQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  fields?: string[];
  id?: string;
  issueCount?: number;
  jql?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeCount?`: `string`; `queueId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.includeCount?`	`string`	Specifies whether to include the issue count of queue in the response. Valid values: true/false. Default: false.
`parameters.queueId?`	`string`	The id of the queue.
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`options?`	`RequestOptions`	-

Returns

queues.getQueues

getQueues: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `includeCount?`: `string`; `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.includeCount?`	`string`	Specifies whether to include the issue count of each queue in the response. Valid values: true/false. Default: false.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

queues.reorderQueues

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: `number`[]; `serviceDeskId`: `string`; }	-
`parameters.body`	`number`[]	-
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`options?`	`RequestOptions`	-

Returns

Promise<object[]>

queues.updateQueue

updateQueue: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  fields?: string[];
  id?: string;
  issueCount?: number;
  jql?: string;
  name?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `fields?`: `string`[]; `jql?`: `string`; `name?`: `string`; `queueId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.fields?`	`string`[]	-
`parameters.jql?`	`string`	-
`parameters.name?`	`string`	-
`parameters.queueId?`	`string`	The id of the queue.
`parameters.serviceDeskId?`	`string`	The ID of the service project.
`options?`	`RequestOptions`	-

Returns

queueSettings

queueSettings: object;

queueSettings.getQueueSettingsOnProject

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

Parameters

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

Returns

Promise<void>

queueSettings.setShouldQueuesIncludeCountGlobally

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

Parameters

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

Returns

Promise<void>

queueSettings.setShouldQueuesIncludeCountOnProject

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

Parameters

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

Returns

Promise<void>

queueSettings.setShouldQueuesUseCountCacheGlobally

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

Parameters

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

Returns

Promise<void>

queueSettings.setShouldQueuesUseCountCacheOnProject

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

Parameters

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

Returns

Promise<void>

requestAttachments

requestAttachments: object;

requestAttachments.attachTemporaryFile

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

Parameters

Parameter	Type	Description
`parameters`	{ `body`: \| `AttachmentInput` \| `AttachmentInput`[]; `serviceDeskId`: `string`; }	-
`parameters.body`	\| `AttachmentInput` \| `AttachmentInput`[]	-
`parameters.serviceDeskId?`	`string`	The ID of the service desk.
`options?`	`RequestOptions`	-

Returns

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

requestAttachments.createAttachment

createAttachment: (parameters, options?) => Promise<{
[key: string]: unknown;
  attachments?: object[];
  comment?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        self?: string;
     };
     author?: {
      [key: string]: unknown;
        _links?: {
         [key: ...]: ...;
           avatarUrls?: ...;
           jiraRest?: ...;
           self?: ...;
        };
        active?: boolean;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        timeZone?: string;
     };
     body?: string;
     created?: {
      [key: string]: unknown;
        epochMillis?: number;
        friendly?: string;
        iso8601?: string;
        jira?: string;
     };
     id?: string;
     public?: boolean;
  };
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `additionalComment?`: { `body?`: `string`; }; `issueIdOrKey`: `string`; `public?`: `boolean`; `temporaryAttachmentIds?`: `string`[]; }	-
`parameters.additionalComment?`	{ `body?`: `string`; }	-
`parameters.additionalComment.body?`	`string`	-
`parameters.issueIdOrKey?`	`string`	The id or key of the customer request.
`parameters.public?`	`boolean`	-
`parameters.temporaryAttachmentIds?`	`string`[]	-
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; attachments?: object[]; comment?: { [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; author?: { [key: string]: unknown; _links?: { [key: ...]: ...; avatarUrls?: ...; jiraRest?: ...; self?: ...; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }; body?: string; created?: { [key: string]: unknown; epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; }; id?: string; public?: boolean; }; }>

requestTypePermissions

requestTypePermissions: object;

requestTypePermissions.getPermissionsByRequestTypeId

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

Parameters

Parameter	Type	Description
`parameters`	{ `requestTypeId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.requestTypeId`	`string`	The id of the request type.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

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

requestTypePermissions.upsertRequestTypePermission

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

Parameters

Parameter	Type	Description
`parameters`	{ `allowlist?`: `object`[]; `requestTypeId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.allowlist?`	`object`[]	-
`parameters.requestTypeId?`	`string`	The id of the request type.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

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

requestTypes

requestTypes: object;

requestTypes.createRequestType

createRequestType: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  description?: string;
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<..., ...>;
     };
     id?: string;
  };
  id?: string;
  name?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `description?`: `string`; `helpText?`: `string`; `issueTypeId?`: `string`; `name?`: `string`; `serviceDeskId`: `string`; }	-
`parameters.description?`	`string`	-
`parameters.helpText?`	`string`	-
`parameters.issueTypeId?`	`string`	-
`parameters.name?`	`string`	-
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; self?: string; }; description?: string; groupIds?: string[]; helpText?: string; icon?: { [key: string]: unknown; _links?: { [key: string]: unknown; iconUrls?: Record<..., ...>; }; id?: string; }; id?: string; name?: string; restrictionStatus?: string & object | "OPEN" | "RESTRICTED"; serviceDeskId?: string; }>

requestTypes.deleteRequestType

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

Parameters

Parameter	Type	Description
`parameters`	{ `requestTypeId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.requestTypeId`	`string`	The id of the request type.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<void>

requestTypes.getRequestTypeById

getRequestTypeById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  description?: string;
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<..., ...>;
     };
     id?: string;
  };
  id?: string;
  name?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `requestTypeId`: `string`; `restrictionStatus?`: `string`; `serviceDeskId`: `string`; }	-
`parameters.requestTypeId`	`string`	The id of the request type.
`parameters.restrictionStatus?`	`string`	Filter request type by restriction status. It can be OPEN, RESTRICTED or both separated by a comma.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

requestTypes.getRequestTypeFields

getRequestTypeFields: (parameters, options?) => Promise<{
[key: string]: unknown;
  canAddRequestParticipants?: boolean;
  canRaiseOnBehalfOf?: boolean;
  requestTypeFields?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `requestTypeId`: `string`; `serviceDeskId`: `string`; }	-
`parameters.requestTypeId`	`string`	The id of the request type.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; canAddRequestParticipants?: boolean; canRaiseOnBehalfOf?: boolean; requestTypeFields?: object[]; }>

requestTypes.getRequestTypeGroups

getRequestTypeGroups: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

requestTypes.getRequestTypes

getRequestTypes: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `groupId?`: `string`; `limit?`: `number`; `restrictionStatus?`: `string`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.groupId?`	`string`	Filter results where the group ID of the request type matches `groupId`
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.restrictionStatus?`	`string`	Filter request type by restriction status. It can be OPEN, RESTRICTED or both separated by a comma.
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

requestTypes.updateRequestType

updateRequestType: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     self?: string;
  };
  description?: string;
  groupIds?: string[];
  helpText?: string;
  icon?: {
   [key: string]: unknown;
     _links?: {
      [key: string]: unknown;
        iconUrls?: Record<..., ...>;
     };
     id?: string;
  };
  id?: string;
  name?: string;
  restrictionStatus?: string & object | "OPEN" | "RESTRICTED";
  serviceDeskId?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `description?`: `string`; `helpText?`: `string`; `name?`: `string`; `requestTypeId?`: `number`; `serviceDeskId`: `string`; }	-
`parameters.description?`	`string`	-
`parameters.helpText?`	`string`	-
`parameters.name?`	`string`	-
`parameters.requestTypeId?`	`number`	-
`parameters.serviceDeskId?`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

serviceDeskOrganizations

serviceDeskOrganizations: object;

serviceDeskOrganizations.addOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId?`: `number`; `serviceDeskId`: `string`; }	-
`parameters.organizationId?`	`number`	-
`parameters.serviceDeskId?`	`string`	The ID of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<void>

serviceDeskOrganizations.getServiceDeskOrganizations

getServiceDeskOrganizations: (parameters, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `limit?`: `number`; `serviceDeskId`: `string`; `start?`: `number`; }	-
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.serviceDeskId?`	`string`	The ID of the service desk.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Returns

serviceDeskOrganizations.removeOrganization

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

Parameters

Parameter	Type	Description
`parameters`	{ `organizationId?`: `number`; `serviceDeskId`: `string`; }	-
`parameters.organizationId?`	`number`	-
`parameters.serviceDeskId?`	`string`	The ID of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<void>

serviceDesks

serviceDesks: object;

serviceDesks.getServiceDeskById

getServiceDeskById: (parameters, options?) => Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     portal?: string;
     self?: string;
  };
  id?: string;
  projectId?: string;
  projectKey?: string;
  projectName?: string;
}>;

Parameters

Parameter	Type	Description
`parameters`	{ `serviceDeskId`: `string`; }	-
`parameters.serviceDeskId`	`string`	The id of the service desk.
`options?`	`RequestOptions`	-

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; portal?: string; self?: string; }; id?: string; projectId?: string; projectKey?: string; projectName?: string; }>

serviceDesks.getServiceDesks

getServiceDesks: (parameters?, options?) => Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Parameters

Parameter	Type	Description
`parameters?`	{ `includeArchived?`: `string`; `limit?`: `number`; `start?`: `number`; }	-
`parameters.includeArchived?`	`string`	The option to include archived service project. False by default.
`parameters.limit?`	`number`	The maximum number of items to return per page. Default: 50.
`parameters.start?`	`number`	The starting index of the returned objects. Base index: 0.
`options?`	`RequestOptions`	-

Function: createServiceDeskServerClient() ​

Parameters ​

Returns ​

approvals ​

approvals.answerApproval ​

Parameters ​

Returns ​

approvals.getApprovalById ​

Parameters ​

Returns ​

approvals.getApprovalCommentConfig ​

Parameters ​

Returns ​

approvals.getApprovals ​

Parameters ​

Returns ​

customerRequests ​

customerRequests.addRequestParticipants ​

Parameters ​

Returns ​

customerRequests.createCustomerRequest ​

Parameters ​

Returns ​

customerRequests.createRequestComment ​

Parameters ​

Returns ​

customerRequests.getCustomerRequestByIdOrKey ​

Parameters ​

Returns ​

customerRequests.getCustomerRequestStatus ​

Parameters ​

Returns ​

customerRequests.getMyCustomerRequests ​

Parameters ​

Returns ​

customerRequests.getRequestCommentById ​

Parameters ​

Returns ​

customerRequests.getRequestComments ​

Parameters ​

Returns ​

customerRequests.getRequestParticipants ​

Parameters ​

Returns ​

customerRequests.getSlaInformation ​

Parameters ​

Returns ​

customerRequests.getSlaInformationById ​

Parameters ​

Returns ​

customerRequests.removeRequestParticipants ​

Parameters ​

Returns ​

customers ​

customers.addCustomers ​

Parameters ​

Returns ​

customers.createCustomer ​

Parameters ​

Returns ​

customerTransitions ​

customerTransitions.getCustomerTransitions ​

Parameters ​

Returns ​

customerTransitions.performCustomerTransition ​

Parameters ​

Returns ​

info ​

info.getInfo ​

Parameters ​

Returns ​

organizations ​

organizations.addUsersToOrganization ​

Parameters ​

Returns ​

organizations.cleanUpOrganizations ​

Parameters ​

Returns ​

organizations.createOrganization ​

Parameters ​

Function: createServiceDeskServerClient()

Parameters

Returns

approvals

approvals.answerApproval

Parameters

Returns

approvals.getApprovalById

Parameters

Returns

approvals.getApprovalCommentConfig

Parameters

Returns

approvals.getApprovals

Parameters

Returns

customerRequests

customerRequests.addRequestParticipants

Parameters

Returns

customerRequests.createCustomerRequest

Parameters

Returns

customerRequests.createRequestComment

Parameters

Returns

customerRequests.getCustomerRequestByIdOrKey

Parameters

Returns

customerRequests.getCustomerRequestStatus

Parameters

Returns

customerRequests.getMyCustomerRequests

Parameters

Returns

customerRequests.getRequestCommentById

Parameters

Returns

customerRequests.getRequestComments

Parameters

Returns

customerRequests.getRequestParticipants

Parameters

Returns

customerRequests.getSlaInformation

Parameters

Returns

customerRequests.getSlaInformationById

Parameters

Returns

customerRequests.removeRequestParticipants

Parameters

Returns

customers

customers.addCustomers

Parameters

Returns

customers.createCustomer

Parameters

Returns

customerTransitions

customerTransitions.getCustomerTransitions

Parameters

Returns

customerTransitions.performCustomerTransition

Parameters

Returns

info

info.getInfo

Parameters

Returns

organizations

organizations.addUsersToOrganization

Parameters

Returns

organizations.cleanUpOrganizations

Parameters

Returns

organizations.createOrganization

Parameters