Constructors
constructor
- new Api(rootUrl: string, privateToken: string): Api
-
Parameters
-
rootUrl: string
-
privateToken: string
Returns Api
Properties
Private privateToken
privateToken: any
Private rootUrl
rootUrl: any
Methods
addMember
-
Parameters
-
-
id: number
-
userId: number
-
Returns Promise<Member>
createIssue
- createIssue(projectId: number, title: string, description: string): Promise<Issue>
-
Parameters
-
projectId: number
-
title: string
-
description: string
Returns Promise<Issue>
createLabel
- createLabel(projectId: number, name: string, description?: undefined | string, color?: undefined | string): Promise<Label>
-
Parameters
-
projectId: number
-
name: string
-
Optional description: undefined | string
-
Optional color: undefined | string
Returns Promise<Label>
createMilestone
- createMilestone(projectId: number, title: string): Promise<void>
-
Parameters
-
projectId: number
-
title: string
Returns Promise<void>
createNote
- createNote(projectId: number, scope: Scope, iid: number, body: string): Promise<void>
-
Parameters
-
projectId: number
-
-
iid: number
-
body: string
Returns Promise<void>
deleteLabel
- deleteLabel(projectId: number, name: string): Promise<void>
-
Parameters
-
projectId: number
-
name: string
Returns Promise<void>
deleteMember
- deleteMember(scope: MembershipScope, id: number, userId: number): Promise<void>
-
Parameters
-
-
id: number
-
userId: number
Returns Promise<void>
editLabel
- editLabel(projectId: number, name: string, newValues: Partial<Label>): Promise<Label>
-
Parameters
-
projectId: number
-
name: string
-
Returns Promise<Label>
editMember
-
Parameters
-
-
id: number
-
userId: number
-
Returns Promise<Member>
getBranchesForProject
- getBranchesForProject(projectId: number): Promise<Branch[]>
-
Parameters
Returns Promise<Branch[]>
getFile
- getFile(projectId: number, filePath: string, commitish: string): Promise<any>
-
Parameters
-
projectId: number
-
filePath: string
-
commitish: string
Returns Promise<any>
getFileList
- getFileList(projectId: number): Promise<TreeFile[]>
-
Parameters
Returns Promise<TreeFile[]>
getIssues
-
Parameters
Returns Promise<Issue[]>
getLabels
- getLabels(projectId: number): Promise<Label[]>
-
Parameters
Returns Promise<Label[]>
getMembers
-
Parameters
Returns Promise<Member[]>
getMergeRequestApproval
-
Parameters
-
projectId: number
-
mergeRequestIid: number
getMergeRequestDiscussions
- getMergeRequestDiscussions(projectId: number, mergeRequestIid: number): Promise<Discussion[]>
-
Parameters
-
projectId: number
-
mergeRequestIid: number
getMergeRequests
-
Parameters
getMilestonesForProject
- getMilestonesForProject(projectId: number): Promise<Milestone[]>
-
Parameters
Returns Promise<Milestone[]>
getProjectsForGroup
- getProjectsForGroup(groupId: number): Promise<Project[]>
-
Parameters
Returns Promise<Project[]>
getSubGroupsForGroup
- getSubGroupsForGroup(groupId: number): Promise<Group[]>
-
Parameters
Returns Promise<Group[]>
getTags
- getTags(projectId: number): Promise<Tag[]>
-
Parameters
Returns Promise<Tag[]>
makeGitLabAPIRequest
-
Parameters
Returns Promise<any>
protectBranch
- protectBranch(projectId: number, branch: string): Promise<Branch>
-
Parameters
-
projectId: number
-
branch: string
Returns Promise<Branch>
setAssigneeForIssue
- setAssigneeForIssue(issue: Issue, userId: number): Promise<Issue>
-
Parameters
Returns Promise<Issue>
setMilestoneForIssue
- setMilestoneForIssue(issue: Issue, milestoneId: number): Promise<Issue>
-
Parameters
Returns Promise<Issue>
GitLab API