Class BacklogApiClient

Index

Constructors

Methods

addCategory addCustomField addGroup addIssue addIssueComment addIssueType addIssuecommentNotification addListItemForListTypeCustomField addProject addProjectAdministrator addProjectGroup addProjectTeam addProjectUser addPullRequest addPullRequestComment addRecentlyViewedIssue addRecentlyViewedWiki addStar addStatus addTeam addUser addVersionMilestone addWatching addWebhook addWikiPage attachFileToWiki countIssue countIssueComment countNotification countUserReceivedStars countWatching countWikiPage deleteCategory deleteCustomField deleteGroup deleteIssue deleteIssueAttachment deleteIssueComment deleteIssueType deleteListItemForListTypeCustomField deleteProject deleteProjectAdministrator deleteProjectGroup deleteProjectTeam deleteProjectUser deletePullRequestAttachments deleteStatus deleteTeam deleteUser deleteVersion deleteWatching deleteWebhook deleteWikiPage downloadPullRequestAttachment getActivity getCategoryList getCustomFieldList getFile getGitRepository getGroup getGroupIcon getIssue getIssueAttachment getIssueComment getIssueCommentList getIssueList getIssueParticipantList getIssueTypeList getLicence getListOfGitRepositories getListOfGroups getListOfIssueAttachments getListOfIssueCommentNotifications getListOfIssueLinkedSharedFiles getListOfProjectAdministrators getListOfPullRequestAttachment getListOfRecentlyViewedIssues getListOfRecentlyViewedProjects getListOfRecentlyViewedWikis getListOfSharedFiles getListOfSharedFilesOnWiki getListOfTeams getListOfWebhooks getListOfWikiAttachments getNotification getNumberOfPullRequestComments getNumberOfPullRequests getOwnUser getPriorityList getProject getProjectDiskUsage getProjectGroupList getProjectIcon getProjectList getProjectRecentUpdates getProjectTeamList getProjectUserList getPullRequest getPullRequestComment getPullRequestList getRateLimit getReceivedStarList getRecentUpdates getResolutionList getSpace getSpaceDiskUsage getSpaceLogo getSpaceNotification getStatusList getStatusListOfProject getTeam getTeamIcon getUser getUserIcon getUserList getUserRecentUpdates getVersionMilestoneList getWatching getWatchingList getWebhook getWikiPage getWikiPageAttachment getWikiPageHistory getWikiPageList getWikiPageStar getWikiPageTagList linkSharedFilesToIssue linkSharedFilesToWiki markWatchingAsRead postAttachmentFile readNotification removeLinkToSharedFileFromIssue removeLinkToSharedFileFromWiki removeWikiAttachment resetUnreadNotificationCount updateCategory updateCustomField updateGroup updateIssue updateIssueComment updateIssueType updateListItemForListTypeCustomField updateOrderOfStatus updateProject updatePullRequest updatePullRequestCommentInformation updateSpaceNotification updateStatus updateTeam updateUser updateVersionMilestone updateWatching updateWebhook updateWikiPage

Constructors

constructor

new BacklogApiClient(options): BacklogApiClient
Parameters
- options: {
  config: contracts.BacklogConfig;
  }
  - config: contracts.BacklogConfig
Returns BacklogApiClient
- Defined in src/BacklogApiClient.ts:358

Methods

addCategory

addCategory(params, context?): Promise<BacklogResponse<Category>>
Parameters
- params: AddCategoryParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Category>>
- Defined in src/BacklogApiClient.ts:735

addCustomField

addCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:791

addGroup

addGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:523

addIssue

addIssue(params, context?): Promise<BacklogResponse<Issue>>
Parameters
- params: AddIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue>>
- Defined in src/BacklogApiClient.ts:903

addIssueComment

addIssueComment(params, context?): Promise<BacklogResponse<IssueComment>>
Parameters
- params: AddIssueCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment>>
- Defined in src/BacklogApiClient.ts:938

addIssueType

addIssueType(params, context?): Promise<BacklogResponse<IssueTypeDetailed>>
Parameters
- params: AddIssueTypeParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueTypeDetailed>>
- Defined in src/BacklogApiClient.ts:707

addIssuecommentNotification

addIssuecommentNotification(params, context?): Promise<BacklogResponse<IssueComment>>
Parameters
- params: AddIssuecommentNotificationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment>>
- Defined in src/BacklogApiClient.ts:980

addListItemForListTypeCustomField

addListItemForListTypeCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:812

addProject

addProject(params, context?): Promise<BacklogResponse<Project>>
Parameters
- params: AddProjectParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Project>>
- Defined in src/BacklogApiClient.ts:588

addProjectAdministrator

addProjectAdministrator(params, context?): Promise<BacklogResponse<User>>
Parameters
- params: AddProjectAdministratorParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:651

addProjectGroup

addProjectGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:1338

addProjectTeam

addProjectTeam(params, context?): Promise<BacklogResponse<Team>>
Parameters
- params: AddProjectTeamParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Team>>
- Defined in src/BacklogApiClient.ts:1414

addProjectUser

addProjectUser(params, context?): Promise<BacklogResponse<User>>
Parameters
- params: AddProjectUserParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:630

addPullRequest

addPullRequest(params, context?): Promise<BacklogResponse<PullRequest>>
Parameters
- params: AddPullRequestParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequest>>
- Defined in src/BacklogApiClient.ts:1210

addPullRequestComment

addPullRequestComment(params, context?): Promise<BacklogResponse<PullRequestComment>>
Parameters
- params: AddPullRequestCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestComment>>
- Defined in src/BacklogApiClient.ts:1238

addRecentlyViewedIssue

addRecentlyViewedIssue(params, context?): Promise<BacklogResponse<Issue>>
Parameters
- params: AddRecentlyViewedIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue>>
- Defined in src/BacklogApiClient.ts:486

addRecentlyViewedWiki

addRecentlyViewedWiki(params, context?): Promise<BacklogResponse<RecentlyViewedWiki>>
Parameters
- params: AddRecentlyViewedWikiParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<RecentlyViewedWiki>>
- Defined in src/BacklogApiClient.ts:507

addStar

addStar(params, context?): Promise<BacklogResponse<BacklogResponseNoContent>>
Parameters
- params: AddStarParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseNoContent>>
- Defined in src/BacklogApiClient.ts:1148

addStatus

addStatus(params, context?): Promise<BacklogResponse<ProjectStatus>>
Parameters
- params: AddStatusParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectStatus>>
- Defined in src/BacklogApiClient.ts:672

addTeam

addTeam(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:1372

addUser

addUser(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:426

addVersionMilestone

addVersionMilestone(params, context?): Promise<BacklogResponse<Version>>
Parameters
- params: AddVersionMilestoneParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Version>>
- Defined in src/BacklogApiClient.ts:763

addWatching

addWatching(params, context?): Promise<BacklogResponse<WatchingItemIssue>>
Parameters
- params: AddWatchingParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemIssue>>
- Defined in src/BacklogApiClient.ts:1301

addWebhook

addWebhook(params, context?): Promise<BacklogResponse<Webhook>>
Parameters
- params: AddWebhookParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Webhook>>
- Defined in src/BacklogApiClient.ts:861

addWikiPage

addWikiPage(params, context?): Promise<BacklogResponse<Wiki>>
Parameters
- params: AddWikiPageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Wiki>>
- Defined in src/BacklogApiClient.ts:1057

attachFileToWiki

attachFileToWiki(params, context?): Promise<BacklogResponse<WikiAttachmentFile[]>>
Parameters
- params: AttachFileToWikiParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiAttachmentFile[]>>
- Defined in src/BacklogApiClient.ts:1092

countIssue

countIssue(params?, context?): Promise<BacklogResponse<IssueCount>>
Parameters
- Optionalparams: GetIssueListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueCount>>
- Defined in src/BacklogApiClient.ts:896

countIssueComment

countIssueComment(params, context?): Promise<BacklogResponse<IssueCommentCount>>
Parameters
- params: CountIssueCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueCommentCount>>
- Defined in src/BacklogApiClient.ts:945

countNotification

countNotification(params?, context?): Promise<BacklogResponse<NotificationCount>>
Parameters
- Optionalparams: CountNotificationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<NotificationCount>>
- Defined in src/BacklogApiClient.ts:1162

countUserReceivedStars

countUserReceivedStars(params, context?): Promise<BacklogResponse<StarCount>>
Parameters
- params: CountUserReceivedStarsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<StarCount>>
- Defined in src/BacklogApiClient.ts:472

countWatching

countWatching(params, context?): Promise<BacklogResponse<WatchingItemCount>>
Parameters
- params: CountWatchingParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemCount>>
- Defined in src/BacklogApiClient.ts:1287

countWikiPage

countWikiPage(params, context?): Promise<BacklogResponse<WikiCount>>
Parameters
- params: CountWikiPageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiCount>>
- Defined in src/BacklogApiClient.ts:1043

deleteCategory

deleteCategory(params, context?): Promise<BacklogResponse<Category>>
Parameters
- params: DeleteCategoryParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Category>>
- Defined in src/BacklogApiClient.ts:749

deleteCustomField

deleteCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:805

deleteGroup

deleteGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:547

deleteIssue

deleteIssue(params, context?): Promise<BacklogResponse<Issue>>
Parameters
- params: DeleteIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue>>
- Defined in src/BacklogApiClient.ts:924

deleteIssueAttachment

deleteIssueAttachment(params, context?): Promise<BacklogResponse<IssueAttachmentFile>>
Parameters
- params: DeleteIssueAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueAttachmentFile>>
- Defined in src/BacklogApiClient.ts:1001

deleteIssueComment

deleteIssueComment(params, context?): Promise<BacklogResponse<IssueComment>>
Parameters
- params: DeleteIssueCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment>>
- Defined in src/BacklogApiClient.ts:959

deleteIssueType

deleteIssueType(params, context?): Promise<BacklogResponse<IssueTypeDetailed>>
Parameters
- params: DeleteIssueTypeParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueTypeDetailed>>
- Defined in src/BacklogApiClient.ts:721

deleteListItemForListTypeCustomField

deleteListItemForListTypeCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:826

deleteProject

deleteProject(params, context?): Promise<BacklogResponse<Project>>
Parameters
- params: DeleteProjectParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Project>>
- Defined in src/BacklogApiClient.ts:609

deleteProjectAdministrator

deleteProjectAdministrator(params, context?): Promise<BacklogResponse<User>>
Parameters
- params: DeleteProjectAdministratorParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:665

deleteProjectGroup

deleteProjectGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:1346

deleteProjectTeam

deleteProjectTeam(params, context?): Promise<BacklogResponse<Team>>
Parameters
- params: DeleteProjectTeamParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Team>>
- Defined in src/BacklogApiClient.ts:1421

deleteProjectUser

deleteProjectUser(params, context?): Promise<BacklogResponse<User>>
Parameters
- params: DeleteProjectUserParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:644

deletePullRequestAttachments

deletePullRequestAttachments(params, context?): Promise<BacklogResponse<PullRequestAttachmentFile>>
Parameters
- params: DeletePullRequestAttachmentsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestAttachmentFile>>
- Defined in src/BacklogApiClient.ts:1273

deleteStatus

deleteStatus(params, context?): Promise<BacklogResponse<ProjectStatus>>
Parameters
- params: DeleteStatusParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectStatus>>
- Defined in src/BacklogApiClient.ts:686

deleteTeam

deleteTeam(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:1393

deleteUser

deleteUser(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:440

deleteVersion

deleteVersion(params, context?): Promise<BacklogResponse<Version>>
Parameters
- params: DeleteVersionParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Version>>
- Defined in src/BacklogApiClient.ts:777

deleteWatching

deleteWatching(params, context?): Promise<BacklogResponse<WatchingItemIssue>>
Parameters
- params: DeleteWatchingParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemIssue>>
- Defined in src/BacklogApiClient.ts:1315

deleteWebhook

deleteWebhook(params, context?): Promise<BacklogResponse<Webhook>>
Parameters
- params: DeleteWebhookParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Webhook>>
- Defined in src/BacklogApiClient.ts:882

deleteWikiPage

deleteWikiPage(params, context?): Promise<BacklogResponse<Wiki>>
Parameters
- params: DeleteWikiPageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Wiki>>
- Defined in src/BacklogApiClient.ts:1078

downloadPullRequestAttachment

downloadPullRequestAttachment(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: DownloadPullRequestAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:1266

getActivity

getActivity(params, context?): Promise<BacklogResponse<Activity>>
Parameters
- params: GetActivityParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Activity>>
- Defined in src/BacklogApiClient.ts:376

getCategoryList

getCategoryList(params, context?): Promise<BacklogResponse<Category[]>>
Parameters
- params: GetCategoryListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Category[]>>
- Defined in src/BacklogApiClient.ts:728

getCustomFieldList

getCustomFieldList(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:784

getFile

getFile(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetFileParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:840

getGitRepository

getGitRepository(params, context?): Promise<BacklogResponse<Repository>>
Parameters
- params: GetGitRepositoryParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Repository>>
- Defined in src/BacklogApiClient.ts:1189

getGroup

getGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:531

getGroupIcon

getGroupIcon(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:1354

getIssue

getIssue(params, context?): Promise<BacklogResponse<Issue>>
Parameters
- params: GetIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue>>
- Defined in src/BacklogApiClient.ts:910

getIssueAttachment

getIssueAttachment(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetIssueAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:994

getIssueComment

getIssueComment(params, context?): Promise<BacklogResponse<IssueComment>>
Parameters
- params: GetIssueCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment>>
- Defined in src/BacklogApiClient.ts:952

getIssueCommentList

getIssueCommentList(params, context?): Promise<BacklogResponse<IssueComment[]>>
Parameters
- params: GetIssueCommentListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment[]>>
- Defined in src/BacklogApiClient.ts:931

getIssueList

getIssueList(params?, context?): Promise<BacklogResponse<Issue[]>>
Parameters
- Optionalparams: GetIssueListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue[]>>
- Defined in src/BacklogApiClient.ts:889

getIssueParticipantList

getIssueParticipantList(params, context?): Promise<BacklogResponse<User[]>>
Parameters
- params: GetIssueParticipantListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User[]>>
- Defined in src/BacklogApiClient.ts:1008

getIssueTypeList

getIssueTypeList(params, context?): Promise<BacklogResponse<IssueTypeDetailed[]>>
Parameters
- params: GetIssueTypeListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueTypeDetailed[]>>
- Defined in src/BacklogApiClient.ts:700

getLicence

getLicence(context?): Promise<BacklogResponse<Licence>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Licence>>
- Defined in src/BacklogApiClient.ts:1361

getListOfGitRepositories

getListOfGitRepositories(params, context?): Promise<BacklogResponse<Repository[]>>
Parameters
- params: GetListOfGitRepositoriesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Repository[]>>
- Defined in src/BacklogApiClient.ts:1182

getListOfGroups

getListOfGroups(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:515

getListOfIssueAttachments

getListOfIssueAttachments(params, context?): Promise<BacklogResponse<IssueAttachmentFile[]>>
Parameters
- params: GetListOfIssueAttachmentsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueAttachmentFile[]>>
- Defined in src/BacklogApiClient.ts:987

getListOfIssueCommentNotifications

getListOfIssueCommentNotifications(params, context?): Promise<BacklogResponse<ActivityNotification[]>>
Parameters
- params: GetListOfIssueCommentNotificationsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ActivityNotification[]>>
- Defined in src/BacklogApiClient.ts:973

getListOfIssueLinkedSharedFiles

getListOfIssueLinkedSharedFiles(params, context?): Promise<BacklogResponse<SharedFile[]>>
Parameters
- params: GetListOfIssueLinkedSharedFilesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile[]>>
- Defined in src/BacklogApiClient.ts:1015

getListOfProjectAdministrators

getListOfProjectAdministrators(params, context?): Promise<BacklogResponse<User[]>>
Parameters
- params: GetListOfProjectAdministratorsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User[]>>
- Defined in src/BacklogApiClient.ts:658

getListOfPullRequestAttachment

getListOfPullRequestAttachment(params, context?): Promise<BacklogResponse<PullRequestAttachmentFile[]>>
Parameters
- params: GetListOfPullRequestAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestAttachmentFile[]>>
- Defined in src/BacklogApiClient.ts:1259

getListOfRecentlyViewedIssues

getListOfRecentlyViewedIssues(params?, context?): Promise<BacklogResponse<RecentlyViewedIssue[]>>
Parameters
- Optionalparams: GetListOfRecentlyViewedIssuesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<RecentlyViewedIssue[]>>
- Defined in src/BacklogApiClient.ts:479

getListOfRecentlyViewedProjects

getListOfRecentlyViewedProjects(params?, context?): Promise<BacklogResponse<RecentlyViewedProject[]>>
Parameters
- Optionalparams: GetListOfRecentlyViewedProjectsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<RecentlyViewedProject[]>>
- Defined in src/BacklogApiClient.ts:493

getListOfRecentlyViewedWikis

getListOfRecentlyViewedWikis(params?, context?): Promise<BacklogResponse<RecentlyViewedWiki[]>>
Parameters
- Optionalparams: GetListOfRecentlyViewedWikisParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<RecentlyViewedWiki[]>>
- Defined in src/BacklogApiClient.ts:500

getListOfSharedFiles

getListOfSharedFiles(params, context?): Promise<BacklogResponse<SharedFile[]>>
Parameters
- params: GetListOfSharedFilesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile[]>>
- Defined in src/BacklogApiClient.ts:833

getListOfSharedFilesOnWiki

getListOfSharedFilesOnWiki(params, context?): Promise<BacklogResponse<SharedFile[]>>
Parameters
- params: GetListOfSharedFilesOnWikiParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile[]>>
- Defined in src/BacklogApiClient.ts:1113

getListOfTeams

getListOfTeams(params?, context?): Promise<BacklogResponse<Team[]>>
Parameters
- Optionalparams: GetListOfTeamsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Team[]>>
- Defined in src/BacklogApiClient.ts:1365

getListOfWebhooks

getListOfWebhooks(params, context?): Promise<BacklogResponse<Webhook[]>>
Parameters
- params: GetListOfWebhooksParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Webhook[]>>
- Defined in src/BacklogApiClient.ts:854

getListOfWikiAttachments

getListOfWikiAttachments(params, context?): Promise<BacklogResponse<WikiAttachmentFile[]>>
Parameters
- params: GetListOfWikiAttachmentsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiAttachmentFile[]>>
- Defined in src/BacklogApiClient.ts:1085

getNotification

getNotification(params?, context?): Promise<BacklogResponse<UserNotification[]>>
Parameters
- Optionalparams: GetNotificationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<UserNotification[]>>
- Defined in src/BacklogApiClient.ts:1155

getNumberOfPullRequestComments

getNumberOfPullRequestComments(params, context?): Promise<BacklogResponse<PullRequestCommentCount>>
Parameters
- params: GetNumberOfPullRequestCommentsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestCommentCount>>
- Defined in src/BacklogApiClient.ts:1245

getNumberOfPullRequests

getNumberOfPullRequests(params, context?): Promise<BacklogResponse<PullRequestCount>>
Parameters
- params: GetNumberOfPullRequestsParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestCount>>
- Defined in src/BacklogApiClient.ts:1203

getOwnUser

getOwnUser(context?): Promise<BacklogResponse<User>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:447

getPriorityList

getPriorityList(context?): Promise<BacklogResponse<Priority[]>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Priority[]>>
- Defined in src/BacklogApiClient.ts:569

getProject

getProject(params, context?): Promise<BacklogResponse<Project>>
Parameters
- params: GetProjectParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Project>>
- Defined in src/BacklogApiClient.ts:595

getProjectDiskUsage

getProjectDiskUsage(params, context?): Promise<BacklogResponse<SpaceDiskUsageDetail>>
Parameters
- params: GetProjectDiskUsageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SpaceDiskUsageDetail>>
- Defined in src/BacklogApiClient.ts:847

getProjectGroupList

getProjectGroupList(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:1330

getProjectIcon

getProjectIcon(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetProjectIconParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:616

getProjectList

getProjectList(params?, context?): Promise<BacklogResponse<Project[]>>
Parameters
- Optionalparams: GetProjectListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Project[]>>
- Defined in src/BacklogApiClient.ts:581

getProjectRecentUpdates

getProjectRecentUpdates(params, context?): Promise<BacklogResponse<ProjectActivity[]>>
Parameters
- params: GetProjectRecentUpdatesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectActivity[]>>
- Defined in src/BacklogApiClient.ts:623

getProjectTeamList

getProjectTeamList(params, context?): Promise<BacklogResponse<Team[]>>
Parameters
- params: GetProjectTeamListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Team[]>>
- Defined in src/BacklogApiClient.ts:1407

getProjectUserList

getProjectUserList(params, context?): Promise<BacklogResponse<User[]>>
Parameters
- params: GetProjectUserListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User[]>>
- Defined in src/BacklogApiClient.ts:637

getPullRequest

getPullRequest(params, context?): Promise<BacklogResponse<PullRequest>>
Parameters
- params: GetPullRequestParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequest>>
- Defined in src/BacklogApiClient.ts:1217

getPullRequestComment

getPullRequestComment(params, context?): Promise<BacklogResponse<PullRequestComment>>
Parameters
- params: GetPullRequestCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestComment>>
- Defined in src/BacklogApiClient.ts:1231

getPullRequestList

getPullRequestList(params, context?): Promise<BacklogResponse<PullRequest>>
Parameters
- params: GetPullRequestListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequest>>
- Defined in src/BacklogApiClient.ts:1196

getRateLimit

getRateLimit(context?): Promise<BacklogResponse<RateLimit>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<RateLimit>>
- Defined in src/BacklogApiClient.ts:1428

getReceivedStarList

getReceivedStarList(params, context?): Promise<BacklogResponse<Star[]>>
Parameters
- params: GetReceivedStarListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Star[]>>
- Defined in src/BacklogApiClient.ts:465

getRecentUpdates

getRecentUpdates(params?, context?): Promise<BacklogResponse<SpaceActivity[]>>
Parameters
- Optionalparams: GetRecentUpdatesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SpaceActivity[]>>
- Defined in src/BacklogApiClient.ts:369

getResolutionList

getResolutionList(context?): Promise<BacklogResponse<Resolution[]>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Resolution[]>>
- Defined in src/BacklogApiClient.ts:575

getSpace

getSpace(context?): Promise<BacklogResponse<Space>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Space>>
- Defined in src/BacklogApiClient.ts:365

getSpaceDiskUsage

getSpaceDiskUsage(context?): Promise<BacklogResponse<SpaceDiskUsage>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SpaceDiskUsage>>
- Defined in src/BacklogApiClient.ts:402

getSpaceLogo

getSpaceLogo(context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:383

getSpaceNotification

getSpaceNotification(context?): Promise<BacklogResponse<SpaceNotification>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SpaceNotification>>
- Defined in src/BacklogApiClient.ts:389

getStatusList

getStatusList(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:555

getStatusListOfProject

getStatusListOfProject(params, context?): Promise<BacklogResponse<ProjectStatus[]>>
Parameters
- params: GetStatusListOfProjectParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectStatus[]>>
- Defined in src/BacklogApiClient.ts:562

getTeam

getTeam(params, context?): Promise<BacklogResponse<Team>>
Parameters
- params: GetTeamParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Team>>
- Defined in src/BacklogApiClient.ts:1379

getTeamIcon

getTeamIcon(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetTeamIconParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:1400

getUser

getUser(params, context?): Promise<BacklogResponse<User>>
Parameters
- params: GetUserParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User>>
- Defined in src/BacklogApiClient.ts:419

getUserIcon

getUserIcon(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetUserIconParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:451

getUserList

getUserList(context?): Promise<BacklogResponse<User[]>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<User[]>>
- Defined in src/BacklogApiClient.ts:415

getUserRecentUpdates

getUserRecentUpdates(params, context?): Promise<BacklogResponse<UserActivity[]>>
Parameters
- params: GetUserRecentUpdatesParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<UserActivity[]>>
- Defined in src/BacklogApiClient.ts:458

getVersionMilestoneList

getVersionMilestoneList(params, context?): Promise<BacklogResponse<Version[]>>
Parameters
- params: GetVersionMilestoneListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Version[]>>
- Defined in src/BacklogApiClient.ts:756

getWatching

getWatching(params, context?): Promise<BacklogResponse<WatchingItemIssue>>
Parameters
- params: GetWatchingParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemIssue>>
- Defined in src/BacklogApiClient.ts:1294

getWatchingList

getWatchingList(params, context?): Promise<BacklogResponse<WatchingItemIssue[]>>
Parameters
- params: GetWatchingListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemIssue[]>>
- Defined in src/BacklogApiClient.ts:1280

getWebhook

getWebhook(params, context?): Promise<BacklogResponse<Webhook>>
Parameters
- params: GetWebhookParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Webhook>>
- Defined in src/BacklogApiClient.ts:868

getWikiPage

getWikiPage(params, context?): Promise<BacklogResponse<Wiki>>
Parameters
- params: GetWikiPageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Wiki>>
- Defined in src/BacklogApiClient.ts:1064

getWikiPageAttachment

getWikiPageAttachment(params, context?): Promise<BacklogResponse<BacklogResponseFile>>
Parameters
- params: GetWikiPageAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseFile>>
- Defined in src/BacklogApiClient.ts:1099

getWikiPageHistory

getWikiPageHistory(params, context?): Promise<BacklogResponse<WikiHistory[]>>
Parameters
- params: GetWikiPageHistoryParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiHistory[]>>
- Defined in src/BacklogApiClient.ts:1134

getWikiPageList

getWikiPageList(params, context?): Promise<BacklogResponse<Wiki[]>>
Parameters
- params: GetWikiPageListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Wiki[]>>
- Defined in src/BacklogApiClient.ts:1036

getWikiPageStar

getWikiPageStar(params, context?): Promise<BacklogResponse<Star[]>>
Parameters
- params: GetWikiPageStarParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Star[]>>
- Defined in src/BacklogApiClient.ts:1141

getWikiPageTagList

getWikiPageTagList(params, context?): Promise<BacklogResponse<WikiTag[]>>
Parameters
- params: GetWikiPageTagListParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiTag[]>>
- Defined in src/BacklogApiClient.ts:1050

linkSharedFilesToIssue

linkSharedFilesToIssue(params, context?): Promise<BacklogResponse<SharedFile[]>>
Parameters
- params: LinkSharedFilesToIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile[]>>
- Defined in src/BacklogApiClient.ts:1022

linkSharedFilesToWiki

linkSharedFilesToWiki(params, context?): Promise<BacklogResponse<SharedFile[]>>
Parameters
- params: LinkSharedFilesToWikiParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile[]>>
- Defined in src/BacklogApiClient.ts:1120

markWatchingAsRead

markWatchingAsRead(params, context?): Promise<BacklogResponse<BacklogResponseNoContent>>
Parameters
- params: MarkWatchingAsReadParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseNoContent>>
- Defined in src/BacklogApiClient.ts:1322

postAttachmentFile

postAttachmentFile(params, context?): Promise<BacklogResponse<AttachmentFile>>
Parameters
- params: PostAttachmentFileParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<AttachmentFile>>
- Defined in src/BacklogApiClient.ts:408

readNotification

readNotification(params, context?): Promise<BacklogResponse<BacklogResponseNoContent>>
Parameters
- params: ReadNotificationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<BacklogResponseNoContent>>
- Defined in src/BacklogApiClient.ts:1175

removeLinkToSharedFileFromIssue

removeLinkToSharedFileFromIssue(params, context?): Promise<BacklogResponse<SharedFile>>
Parameters
- params: RemoveLinkToSharedFileFromIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile>>
- Defined in src/BacklogApiClient.ts:1029

removeLinkToSharedFileFromWiki

removeLinkToSharedFileFromWiki(params, context?): Promise<BacklogResponse<SharedFile>>
Parameters
- params: RemoveLinkToSharedFileFromWikiParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SharedFile>>
- Defined in src/BacklogApiClient.ts:1127

removeWikiAttachment

removeWikiAttachment(params, context?): Promise<BacklogResponse<WikiAttachmentFile>>
Parameters
- params: RemoveWikiAttachmentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WikiAttachmentFile>>
- Defined in src/BacklogApiClient.ts:1106

resetUnreadNotificationCount

resetUnreadNotificationCount(context?): Promise<BacklogResponse<NotificationUnreadCount>>
Parameters
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<NotificationUnreadCount>>
- Defined in src/BacklogApiClient.ts:1169

updateCategory

updateCategory(params, context?): Promise<BacklogResponse<Category>>
Parameters
- params: UpdateCategoryParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Category>>
- Defined in src/BacklogApiClient.ts:742

updateCustomField

updateCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:798

updateGroup

updateGroup(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
Deprecated
- Defined in src/BacklogApiClient.ts:539

updateIssue

updateIssue(params, context?): Promise<BacklogResponse<Issue>>
Parameters
- params: UpdateIssueParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Issue>>
- Defined in src/BacklogApiClient.ts:917

updateIssueComment

updateIssueComment(params, context?): Promise<BacklogResponse<IssueComment>>
Parameters
- params: UpdateIssueCommentParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueComment>>
- Defined in src/BacklogApiClient.ts:966

updateIssueType

updateIssueType(params, context?): Promise<BacklogResponse<IssueTypeDetailed>>
Parameters
- params: UpdateIssueTypeParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<IssueTypeDetailed>>
- Defined in src/BacklogApiClient.ts:714

updateListItemForListTypeCustomField

updateListItemForListTypeCustomField(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:819

updateOrderOfStatus

updateOrderOfStatus(params, context?): Promise<BacklogResponse<ProjectStatus[]>>
Parameters
- params: UpdateOrderOfStatusParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectStatus[]>>
- Defined in src/BacklogApiClient.ts:693

updateProject

updateProject(params, context?): Promise<BacklogResponse<Project>>
Parameters
- params: UpdateProjectParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Project>>
- Defined in src/BacklogApiClient.ts:602

updatePullRequest

updatePullRequest(params, context?): Promise<BacklogResponse<PullRequest>>
Parameters
- params: UpdatePullRequestParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequest>>
- Defined in src/BacklogApiClient.ts:1224

updatePullRequestCommentInformation

updatePullRequestCommentInformation(params, context?): Promise<BacklogResponse<PullRequestComment>>
Parameters
- params: UpdatePullRequestCommentInformationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<PullRequestComment>>
- Defined in src/BacklogApiClient.ts:1252

updateSpaceNotification

updateSpaceNotification(params, context?): Promise<BacklogResponse<SpaceNotification>>
Parameters
- params: UpdateSpaceNotificationParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<SpaceNotification>>
- Defined in src/BacklogApiClient.ts:395

updateStatus

updateStatus(params, context?): Promise<BacklogResponse<ProjectStatus>>
Parameters
- params: UpdateStatusParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<ProjectStatus>>
- Defined in src/BacklogApiClient.ts:679

updateTeam

updateTeam(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:1386

updateUser

updateUser(params, context?): Promise<BacklogResponse<EmptyObject>>
Parameters
- params: EmptyObject
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<EmptyObject>>
- Defined in src/BacklogApiClient.ts:433

updateVersionMilestone

updateVersionMilestone(params, context?): Promise<BacklogResponse<Version>>
Parameters
- params: UpdateVersionMilestoneParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Version>>
- Defined in src/BacklogApiClient.ts:770

updateWatching

updateWatching(params, context?): Promise<BacklogResponse<WatchingItemIssue>>
Parameters
- params: UpdateWatchingParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<WatchingItemIssue>>
- Defined in src/BacklogApiClient.ts:1308

updateWebhook

updateWebhook(params, context?): Promise<BacklogResponse<Webhook>>
Parameters
- params: UpdateWebhookParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Webhook>>
- Defined in src/BacklogApiClient.ts:875

updateWikiPage

updateWikiPage(params, context?): Promise<BacklogResponse<Wiki>>
Parameters
- params: UpdateWikiPageParams
- Optionalcontext: BacklogApiContext
Returns Promise<BacklogResponse<Wiki>>
- Defined in src/BacklogApiClient.ts:1071

Class BacklogApiClient

Index

Constructors

Methods

Constructors

constructor

Parameters

config: contracts.BacklogConfig

Returns BacklogApiClient

Methods

addCategory

Parameters

Returns Promise<BacklogResponse<Category>>

addCustomField

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

addGroup

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

Deprecated

addIssue

Parameters

Returns Promise<BacklogResponse<Issue>>

addIssueComment

Parameters

Returns Promise<BacklogResponse<IssueComment>>

addIssueType

Parameters

Returns Promise<BacklogResponse<IssueTypeDetailed>>

addIssuecommentNotification

Parameters

Returns Promise<BacklogResponse<IssueComment>>

addListItemForListTypeCustomField

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

addProject

Parameters

Returns Promise<BacklogResponse<Project>>

addProjectAdministrator

Parameters

Returns Promise<BacklogResponse<User>>

addProjectGroup

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

Deprecated

addProjectTeam

Parameters

Returns Promise<BacklogResponse<Team>>

addProjectUser

Parameters

Returns Promise<BacklogResponse<User>>

addPullRequest

Parameters

Returns Promise<BacklogResponse<PullRequest>>

addPullRequestComment

Parameters

Returns Promise<BacklogResponse<PullRequestComment>>

addRecentlyViewedIssue

Parameters

Returns Promise<BacklogResponse<Issue>>

addRecentlyViewedWiki

Parameters

Returns Promise<BacklogResponse<RecentlyViewedWiki>>

addStar

Parameters

Returns Promise<BacklogResponse<BacklogResponseNoContent>>

addStatus

Parameters

Returns Promise<BacklogResponse<ProjectStatus>>

addTeam

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

addUser

Parameters

Returns Promise<BacklogResponse<EmptyObject>>

addVersionMilestone

Parameters

Returns Promise<BacklogResponse<Version>>

addWatching

Parameters