@gitbeaker/core 34.4.0 → 34.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.es.js +3365 -0
- package/dist/index.es.js.map +1 -0
- package/dist/index.js +3473 -0
- package/dist/index.js.map +1 -0
- package/dist/map.json +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/infrastructure/RequestHelper.d.ts +55 -0
- package/dist/types/infrastructure/Utils.d.ts +7 -0
- package/dist/types/infrastructure/index.d.ts +2 -0
- package/dist/types/resources/ApplicationSettings.d.ts +69 -0
- package/dist/types/resources/Branches.d.ts +20 -0
- package/dist/types/resources/BroadcastMessages.d.ts +21 -0
- package/dist/types/resources/CommitDiscussions.d.ts +17 -0
- package/dist/types/resources/Commits.d.ts +132 -0
- package/dist/types/resources/ContainerRegistry.d.ts +37 -0
- package/dist/types/resources/DeployKeys.d.ts +19 -0
- package/dist/types/resources/Deployments.d.ts +44 -0
- package/dist/types/resources/DockerfileTemplates.d.ts +5 -0
- package/dist/types/resources/Environments.d.ts +22 -0
- package/dist/types/resources/EpicDiscussions.d.ts +17 -0
- package/dist/types/resources/EpicIssues.d.ts +12 -0
- package/dist/types/resources/EpicNotes.d.ts +18 -0
- package/dist/types/resources/Epics.d.ts +47 -0
- package/dist/types/resources/Events.d.ts +29 -0
- package/dist/types/resources/FeatureFlags.d.ts +33 -0
- package/dist/types/resources/FreezePeriods.d.ts +17 -0
- package/dist/types/resources/GeoNodes.d.ts +143 -0
- package/dist/types/resources/GitLabCIYMLTemplates.d.ts +5 -0
- package/dist/types/resources/GitignoreTemplates.d.ts +5 -0
- package/dist/types/resources/Gitlab.d.ts +202 -0
- package/dist/types/resources/GroupAccessRequests.d.ts +15 -0
- package/dist/types/resources/GroupBadges.d.ts +18 -0
- package/dist/types/resources/GroupCustomAttributes.d.ts +13 -0
- package/dist/types/resources/GroupDeployTokens.d.ts +14 -0
- package/dist/types/resources/GroupIssueBoards.d.ts +23 -0
- package/dist/types/resources/GroupLabels.d.ts +15 -0
- package/dist/types/resources/GroupMembers.d.ts +14 -0
- package/dist/types/resources/GroupMilestones.d.ts +17 -0
- package/dist/types/resources/GroupRunners.d.ts +6 -0
- package/dist/types/resources/GroupVariables.d.ts +14 -0
- package/dist/types/resources/Groups.d.ts +67 -0
- package/dist/types/resources/IssueAwardEmojis.d.ts +13 -0
- package/dist/types/resources/IssueDiscussions.d.ts +17 -0
- package/dist/types/resources/IssueNoteAwardEmojis.d.ts +13 -0
- package/dist/types/resources/IssueNotes.d.ts +22 -0
- package/dist/types/resources/Issues.d.ts +109 -0
- package/dist/types/resources/IssuesStatistics.d.ts +17 -0
- package/dist/types/resources/Jobs.d.ts +84 -0
- package/dist/types/resources/Keys.d.ts +14 -0
- package/dist/types/resources/Labels.d.ts +15 -0
- package/dist/types/resources/License.d.ts +28 -0
- package/dist/types/resources/LicenseTemplates.d.ts +23 -0
- package/dist/types/resources/Lint.d.ts +10 -0
- package/dist/types/resources/Markdown.d.ts +11 -0
- package/dist/types/resources/MergeRequestApprovals.d.ts +98 -0
- package/dist/types/resources/MergeRequestAwardEmojis.d.ts +13 -0
- package/dist/types/resources/MergeRequestDiscussions.d.ts +19 -0
- package/dist/types/resources/MergeRequestNotes.d.ts +22 -0
- package/dist/types/resources/MergeRequests.d.ts +191 -0
- package/dist/types/resources/Namespaces.d.ts +22 -0
- package/dist/types/resources/NotificationSettings.d.ts +21 -0
- package/dist/types/resources/PackageRegistry.d.ts +14 -0
- package/dist/types/resources/Packages.d.ts +30 -0
- package/dist/types/resources/PagesDomains.d.ts +21 -0
- package/dist/types/resources/PipelineScheduleVariables.d.ts +10 -0
- package/dist/types/resources/PipelineSchedules.d.ts +29 -0
- package/dist/types/resources/Pipelines.d.ts +40 -0
- package/dist/types/resources/ProjectAccessRequests.d.ts +15 -0
- package/dist/types/resources/ProjectBadges.d.ts +18 -0
- package/dist/types/resources/ProjectCustomAttributes.d.ts +13 -0
- package/dist/types/resources/ProjectDeployTokens.d.ts +14 -0
- package/dist/types/resources/ProjectHooks.d.ts +29 -0
- package/dist/types/resources/ProjectImportExport.d.ts +54 -0
- package/dist/types/resources/ProjectIssueBoards.d.ts +23 -0
- package/dist/types/resources/ProjectMembers.d.ts +14 -0
- package/dist/types/resources/ProjectMilestones.d.ts +17 -0
- package/dist/types/resources/ProjectSnippetAwardEmojis.d.ts +13 -0
- package/dist/types/resources/ProjectSnippetDiscussions.d.ts +17 -0
- package/dist/types/resources/ProjectSnippetNotes.d.ts +18 -0
- package/dist/types/resources/ProjectSnippets.d.ts +29 -0
- package/dist/types/resources/ProjectVariables.d.ts +14 -0
- package/dist/types/resources/Projects.d.ts +161 -0
- package/dist/types/resources/ProtectedBranches.d.ts +24 -0
- package/dist/types/resources/ProtectedTags.d.ts +16 -0
- package/dist/types/resources/PushRules.d.ts +24 -0
- package/dist/types/resources/ReleaseLinks.d.ts +24 -0
- package/dist/types/resources/Releases.d.ts +48 -0
- package/dist/types/resources/Repositories.d.ts +37 -0
- package/dist/types/resources/RepositoryFiles.d.ts +31 -0
- package/dist/types/resources/RepositorySubmodules.d.ts +20 -0
- package/dist/types/resources/Runners.d.ts +38 -0
- package/dist/types/resources/Search.d.ts +26 -0
- package/dist/types/resources/Services.d.ts +29 -0
- package/dist/types/resources/SidekiqMetrics.d.ts +37 -0
- package/dist/types/resources/Snippets.d.ts +42 -0
- package/dist/types/resources/SystemHooks.d.ts +18 -0
- package/dist/types/resources/Tags.d.ts +18 -0
- package/dist/types/resources/Todos.d.ts +48 -0
- package/dist/types/resources/Triggers.d.ts +22 -0
- package/dist/types/resources/UserCustomAttributes.d.ts +13 -0
- package/dist/types/resources/UserEmails.d.ts +19 -0
- package/dist/types/resources/UserGPGKeys.d.ts +21 -0
- package/dist/types/resources/UserImpersonationTokens.d.ts +23 -0
- package/dist/types/resources/UserSSHKeys.d.ts +22 -0
- package/dist/types/resources/Users.d.ts +57 -0
- package/dist/types/resources/Version.d.ts +9 -0
- package/dist/types/resources/VulnerabilityFindings.d.ts +69 -0
- package/dist/types/resources/Wikis.d.ts +15 -0
- package/dist/types/resources/index.d.ts +98 -0
- package/dist/types/resources/types.d.ts +68 -0
- package/dist/types/templates/ResourceAccessRequests.d.ts +20 -0
- package/dist/types/templates/ResourceAwardEmojis.d.ts +21 -0
- package/dist/types/templates/ResourceBadges.d.ts +20 -0
- package/dist/types/templates/ResourceCustomAttributes.d.ts +13 -0
- package/dist/types/templates/ResourceDeployTokens.d.ts +20 -0
- package/dist/types/templates/ResourceDiscussions.d.ts +45 -0
- package/dist/types/templates/ResourceIssueBoards.d.ts +31 -0
- package/dist/types/templates/ResourceLabels.d.ts +25 -0
- package/dist/types/templates/ResourceMembers.d.ts +30 -0
- package/dist/types/templates/ResourceMilestones.d.ts +27 -0
- package/dist/types/templates/ResourceNoteAwardEmojis.d.ts +11 -0
- package/dist/types/templates/ResourceNotes.d.ts +20 -0
- package/dist/types/templates/ResourceTemplates.d.ts +11 -0
- package/dist/types/templates/ResourceVariables.d.ts +18 -0
- package/dist/types/templates/index.d.ts +14 -0
- package/dist/types/templates/types.d.ts +13 -0
- package/dist/types/types.d.ts +3 -0
- package/package.json +3 -3
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceMembers } from '../templates';
|
|
3
|
+
import { MemberSchema, AccessLevel, IncludeInherited } from '../templates/types';
|
|
4
|
+
import { BaseRequestOptions, PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
|
|
5
|
+
export interface GroupMembers<C extends boolean = false> extends ResourceMembers<C> {
|
|
6
|
+
add(groupId: string | number, userId: number, accessLevel: AccessLevel, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MemberSchema>>;
|
|
7
|
+
all(groupId: string | number, options?: IncludeInherited & PaginatedRequestOptions): Promise<CamelizedRecord<C, MemberSchema>[]>;
|
|
8
|
+
edit(groupId: string | number, userId: number, accessLevel: AccessLevel, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MemberSchema>>;
|
|
9
|
+
show(groupId: string | number, userId: number, options?: IncludeInherited & Sudo): Promise<CamelizedRecord<C, MemberSchema>>;
|
|
10
|
+
remove(groupId: string | number, userId: number, options?: Sudo): Promise<void>;
|
|
11
|
+
}
|
|
12
|
+
export declare class GroupMembers<C extends boolean = false> extends ResourceMembers<C> {
|
|
13
|
+
constructor(options: BaseResourceOptions<C>);
|
|
14
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceMilestones } from '../templates';
|
|
3
|
+
import { MilestoneSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, BaseRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
import { IssueSchema } from './Issues';
|
|
6
|
+
import { MergeRequestSchema } from './MergeRequests';
|
|
7
|
+
export interface GroupMilestones<C extends boolean = false> extends ResourceMilestones<C> {
|
|
8
|
+
all(groupId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>[]>;
|
|
9
|
+
create(groupId: string | number, title: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>>;
|
|
10
|
+
edit(groupId: string | number, milestoneId: number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>>;
|
|
11
|
+
issues(groupId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, IssueSchema>[]>;
|
|
12
|
+
mergeRequests(groupId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, MergeRequestSchema>[]>;
|
|
13
|
+
show(groupId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, MilestoneSchema>>;
|
|
14
|
+
}
|
|
15
|
+
export declare class GroupMilestones<C extends boolean = false> extends ResourceMilestones<C> {
|
|
16
|
+
constructor(options: BaseResourceOptions<C>);
|
|
17
|
+
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { PaginatedRequestOptions, ShowExpanded } from '../infrastructure';
|
|
3
|
+
import { RunnerSchema } from './Runners';
|
|
4
|
+
export declare class GroupRunners<C extends boolean = false> extends BaseResource<C> {
|
|
5
|
+
all(groupId: string | number, options?: PaginatedRequestOptions & ShowExpanded): Promise<import("../infrastructure").CamelizedRecord<C, RunnerSchema>[] | import("../infrastructure").CamelizedRecord<C, RunnerSchema>[] | import("../infrastructure").PaginationResponse<import("../infrastructure").CamelizedRecord<C, RunnerSchema>[]>>;
|
|
6
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceVariables } from '../templates';
|
|
3
|
+
import { VariableSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, BaseRequestOptions, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
export interface GroupVariables<C extends boolean = false> extends ResourceVariables<C> {
|
|
6
|
+
all(groupId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, VariableSchema>[]>;
|
|
7
|
+
create(groupId: string | number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, VariableSchema>>;
|
|
8
|
+
edit(groupId: string | number, key: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, VariableSchema>>;
|
|
9
|
+
show(groupId: string | number, key: string, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, VariableSchema>>;
|
|
10
|
+
remove(groupId: string | number, key: string, options?: PaginatedRequestOptions): Promise<void>;
|
|
11
|
+
}
|
|
12
|
+
export declare class GroupVariables<C extends boolean = false> extends ResourceVariables<C> {
|
|
13
|
+
constructor(options: BaseResourceOptions<C>);
|
|
14
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { BaseRequestOptions, PaginatedRequestOptions, ShowExpanded, Sudo } from '../infrastructure';
|
|
3
|
+
import { ProjectSchema } from './Projects';
|
|
4
|
+
export interface GroupSchema extends Record<string, unknown> {
|
|
5
|
+
id: number;
|
|
6
|
+
name: string;
|
|
7
|
+
path: string;
|
|
8
|
+
full_name: string;
|
|
9
|
+
full_path: string;
|
|
10
|
+
parent_id: number;
|
|
11
|
+
visibility: string;
|
|
12
|
+
avatar_url: string;
|
|
13
|
+
web_url: string;
|
|
14
|
+
description: string;
|
|
15
|
+
share_with_group_lock: boolean;
|
|
16
|
+
require_two_factor_authentication: boolean;
|
|
17
|
+
two_factor_grace_period: number;
|
|
18
|
+
project_creation_level: string;
|
|
19
|
+
auto_devops_enabled: boolean;
|
|
20
|
+
subgroup_creation_level: string;
|
|
21
|
+
emails_disabled: boolean;
|
|
22
|
+
mentions_disabled: boolean;
|
|
23
|
+
lfs_enabled: boolean;
|
|
24
|
+
default_branch_protection: number;
|
|
25
|
+
request_access_enabled: boolean;
|
|
26
|
+
file_template_project_id: number;
|
|
27
|
+
created_at: string;
|
|
28
|
+
}
|
|
29
|
+
export declare type GroupDetailSchema = {
|
|
30
|
+
id: number;
|
|
31
|
+
name: string;
|
|
32
|
+
path: string;
|
|
33
|
+
full_name: string;
|
|
34
|
+
full_path: string;
|
|
35
|
+
parent_id: number;
|
|
36
|
+
visibility: string;
|
|
37
|
+
avatar_url: string;
|
|
38
|
+
web_url: string;
|
|
39
|
+
description: string;
|
|
40
|
+
request_access_enabled: boolean;
|
|
41
|
+
file_template_project_id: number;
|
|
42
|
+
runners_token: string;
|
|
43
|
+
shared_with_groups: {
|
|
44
|
+
group_id: number;
|
|
45
|
+
group_name: string;
|
|
46
|
+
group_full_path: string;
|
|
47
|
+
group_access_level: number;
|
|
48
|
+
expires_at: string;
|
|
49
|
+
}[];
|
|
50
|
+
created_at: string;
|
|
51
|
+
};
|
|
52
|
+
export declare class Groups<C extends boolean = false> extends BaseResource<C> {
|
|
53
|
+
all(options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, GroupSchema>[]>;
|
|
54
|
+
create(name: string, path: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, GroupSchema>>;
|
|
55
|
+
createLDAPLink(groupId: string | number, cn: string, groupAccess: number, provider: string, options?: Sudo & ShowExpanded): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>> | import("../infrastructure").ExpandedResponse<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>>;
|
|
56
|
+
edit(groupId: string | number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, GroupSchema>>;
|
|
57
|
+
projects(groupId: string | number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, ProjectSchema>[]>;
|
|
58
|
+
remove(groupId: string | number, options?: Sudo & ShowExpanded): Promise<void>;
|
|
59
|
+
removeLDAPLink(groupId: string | number, cn: string, { provider, ...options }?: Sudo & ShowExpanded & {
|
|
60
|
+
provider?: string;
|
|
61
|
+
}): Promise<void>;
|
|
62
|
+
search(nameOrPath: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
63
|
+
show(groupId: string | number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, GroupDetailSchema>>;
|
|
64
|
+
subgroups(groupId: string | number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
65
|
+
syncLDAP(groupId: string | number, options?: Sudo & ShowExpanded): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>> | import("../infrastructure").ExpandedResponse<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>>;
|
|
66
|
+
transferProject(groupId: string | number, projectId: string | number, options?: BaseRequestOptions & ShowExpanded): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>> | import("../infrastructure").ExpandedResponse<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>>;
|
|
67
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceAwardEmojis } from '../templates';
|
|
3
|
+
import { AwardEmojiSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
export interface IssueAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
|
|
6
|
+
all(projectId: string | number, issueIId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, AwardEmojiSchema>[]>;
|
|
7
|
+
award(projectId: string | number, issueIId: number, name: string, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
8
|
+
remove(projectId: string | number, issueIId: number, awardId: number, options?: Sudo): Promise<void>;
|
|
9
|
+
show(projectId: string | number, issueIId: number, awardId: number, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
10
|
+
}
|
|
11
|
+
export declare class IssueAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
|
|
12
|
+
constructor(options: BaseResourceOptions<C>);
|
|
13
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceDiscussions } from '../templates';
|
|
3
|
+
import { DiscussionSchema } from '../templates/types';
|
|
4
|
+
import { BaseRequestOptions, PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
export interface IssueDiscussions<C extends boolean = false> extends ResourceDiscussions<C> {
|
|
6
|
+
addNote(projectId: string | number, issueIId: number, discussionId: number, noteId: number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>>;
|
|
7
|
+
all(projectId: string | number, issueIId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>[]>;
|
|
8
|
+
create(projectId: string | number, issueIId: number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>>;
|
|
9
|
+
editNote(projectId: string | number, issueIId: number, discussionId: number, noteId: number, options: BaseRequestOptions & {
|
|
10
|
+
body: string;
|
|
11
|
+
}): Promise<CamelizedRecord<C, DiscussionSchema>>;
|
|
12
|
+
removeNote(projectId: string | number, issueIId: number, discussionId: number, noteId: number, options?: Sudo): Promise<void>;
|
|
13
|
+
show(projectId: string | number, issueIId: number, discussionId: number, options?: Sudo): Promise<CamelizedRecord<C, DiscussionSchema>>;
|
|
14
|
+
}
|
|
15
|
+
export declare class IssueDiscussions<C extends boolean = false> extends ResourceDiscussions<C> {
|
|
16
|
+
constructor(options: BaseResourceOptions<C>);
|
|
17
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceNoteAwardEmojis } from '../templates';
|
|
3
|
+
import { AwardEmojiSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
|
|
5
|
+
export interface IssueNoteAwardEmojis<C extends boolean = false> extends ResourceNoteAwardEmojis<C> {
|
|
6
|
+
all(projectId: string | number, issueIId: number, noteId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, AwardEmojiSchema>[]>;
|
|
7
|
+
award(projectId: string | number, issueIId: number, noteId: number, name: string, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
8
|
+
remove(projectId: string | number, issueIId: number, noteId: number, awardId: number, options?: Sudo): Promise<void>;
|
|
9
|
+
show(projectId: string | number, issueIId: number, noteId: number, awardId: number, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
10
|
+
}
|
|
11
|
+
export declare class IssueNoteAwardEmojis<C extends boolean = false> extends ResourceNoteAwardEmojis<C> {
|
|
12
|
+
constructor(options: BaseResourceOptions<C>);
|
|
13
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceNotes } from '../templates';
|
|
3
|
+
import { NoteSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, BaseRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
export interface IssueNoteSchema extends NoteSchema {
|
|
6
|
+
attachment?: string;
|
|
7
|
+
system: boolean;
|
|
8
|
+
noteable_id: number;
|
|
9
|
+
noteable_type: string;
|
|
10
|
+
noteable_iid: number;
|
|
11
|
+
resolvable: boolean;
|
|
12
|
+
}
|
|
13
|
+
export interface IssueNotes<C extends boolean = false> extends ResourceNotes<C> {
|
|
14
|
+
all(projectId: string | number, issueIId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, IssueNoteSchema>[]>;
|
|
15
|
+
create(projectId: string | number, issueIId: number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, IssueNoteSchema>>;
|
|
16
|
+
edit(projectId: string | number, issueIId: number, noteId: number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, IssueNoteSchema>>;
|
|
17
|
+
remove(projectId: string | number, issueIId: number, noteId: number, options?: Sudo): Promise<void>;
|
|
18
|
+
show(projectId: string | number, issueIId: number, noteId: number, options?: Sudo): Promise<CamelizedRecord<C, IssueNoteSchema>>;
|
|
19
|
+
}
|
|
20
|
+
export declare class IssueNotes<C extends boolean = false> extends ResourceNotes<C> {
|
|
21
|
+
constructor(options: BaseResourceOptions<C>);
|
|
22
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { UserSchema } from './Users';
|
|
3
|
+
import { MergeRequestSchema } from './MergeRequests';
|
|
4
|
+
import { MilestoneSchema } from '../templates/types';
|
|
5
|
+
import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
|
|
6
|
+
export interface TimeStatsSchema extends Record<string, unknown> {
|
|
7
|
+
time_estimate: number;
|
|
8
|
+
total_time_spent: number;
|
|
9
|
+
human_time_estimate: string;
|
|
10
|
+
human_total_time_spent: string;
|
|
11
|
+
}
|
|
12
|
+
export interface IssueLinkSchema extends Record<string, unknown> {
|
|
13
|
+
id: number;
|
|
14
|
+
iid: number;
|
|
15
|
+
project_id: number;
|
|
16
|
+
issue_link_id: number;
|
|
17
|
+
state: string;
|
|
18
|
+
description: string;
|
|
19
|
+
weight?: number;
|
|
20
|
+
author: Omit<UserSchema, 'created_at'>;
|
|
21
|
+
milestone: MilestoneSchema;
|
|
22
|
+
assignees?: Omit<UserSchema, 'created_at'>[];
|
|
23
|
+
title: string;
|
|
24
|
+
labels?: string[];
|
|
25
|
+
user_notes_count: number;
|
|
26
|
+
due_date: string;
|
|
27
|
+
web_url: string;
|
|
28
|
+
confidential: boolean;
|
|
29
|
+
updated_at: string;
|
|
30
|
+
link_type: 'relates_to' | 'blocks' | 'is_blocked_by';
|
|
31
|
+
link_created_at: string;
|
|
32
|
+
link_updated_at: string;
|
|
33
|
+
}
|
|
34
|
+
export interface IssueSchema extends Record<string, unknown> {
|
|
35
|
+
state: string;
|
|
36
|
+
description: string;
|
|
37
|
+
weight?: number;
|
|
38
|
+
health_status?: string;
|
|
39
|
+
author: Omit<UserSchema, 'created_at'>;
|
|
40
|
+
milestone: MilestoneSchema;
|
|
41
|
+
project_id: number;
|
|
42
|
+
assignees?: Omit<UserSchema, 'created_at'>[];
|
|
43
|
+
updated_at: string;
|
|
44
|
+
closed_at?: string;
|
|
45
|
+
closed_by?: string;
|
|
46
|
+
id: number;
|
|
47
|
+
title: string;
|
|
48
|
+
created_at: string;
|
|
49
|
+
moved_to_id?: string;
|
|
50
|
+
iid: number;
|
|
51
|
+
labels?: string[];
|
|
52
|
+
upvotes: number;
|
|
53
|
+
downvotes: number;
|
|
54
|
+
merge_requests_count: number;
|
|
55
|
+
user_notes_count: number;
|
|
56
|
+
due_date: string;
|
|
57
|
+
web_url: string;
|
|
58
|
+
references: {
|
|
59
|
+
short: string;
|
|
60
|
+
relative: string;
|
|
61
|
+
full: string;
|
|
62
|
+
};
|
|
63
|
+
time_stats: TimeStatsSchema;
|
|
64
|
+
has_tasks: boolean;
|
|
65
|
+
task_status: string;
|
|
66
|
+
confidential: boolean;
|
|
67
|
+
discussion_locked: boolean;
|
|
68
|
+
_links: {
|
|
69
|
+
self: string;
|
|
70
|
+
notes: string;
|
|
71
|
+
award_emoji: string;
|
|
72
|
+
project: string;
|
|
73
|
+
};
|
|
74
|
+
task_completion_status: {
|
|
75
|
+
count: number;
|
|
76
|
+
completed_count: number;
|
|
77
|
+
};
|
|
78
|
+
subscribed: boolean;
|
|
79
|
+
epic?: {
|
|
80
|
+
id: number;
|
|
81
|
+
iid: number;
|
|
82
|
+
title: string;
|
|
83
|
+
url: string;
|
|
84
|
+
group_id: number;
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
export declare class Issues<C extends boolean = false> extends BaseResource<C> {
|
|
88
|
+
addSpentTime(projectId: string | number, issueIid: number, duration: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
|
|
89
|
+
addTimeEstimate(projectId: string | number, issueIid: number, duration: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
|
|
90
|
+
all({ projectId, groupId, ...options }?: {
|
|
91
|
+
projectId?: string | number;
|
|
92
|
+
groupId?: string | number;
|
|
93
|
+
} & PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, Omit<IssueSchema, "epic">>[]>;
|
|
94
|
+
create(projectId: string | number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>>;
|
|
95
|
+
closedBy(projectId: string | number, issueIid: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>[]>;
|
|
96
|
+
edit(projectId: string | number, issueIid: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>>;
|
|
97
|
+
link(projectId: string | number, issueIId: number, targetProjectId: string | number, targetIssueIId: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, IssueLinkSchema>>;
|
|
98
|
+
links(projectId: string | number, issueIid: number): Promise<import("../infrastructure").CamelizedRecord<C, IssueLinkSchema>[]>;
|
|
99
|
+
participants(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Omit<UserSchema, "created_at">>>;
|
|
100
|
+
relatedMergeRequests(projectId: string | number, issueIid: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
|
|
101
|
+
removeLink(projectId: string | number, issueIid: number, issueLinkId: string | number, options?: BaseRequestOptions): Promise<void>;
|
|
102
|
+
remove(projectId: string | number, issueIid: number, options?: Sudo): Promise<void>;
|
|
103
|
+
resetSpentTime(projectId: string | number, issueIid: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
|
|
104
|
+
resetTimeEstimate(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
|
|
105
|
+
show(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>>;
|
|
106
|
+
subscribe(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>>;
|
|
107
|
+
timeStats(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
|
|
108
|
+
unsubscribe(projectId: string | number, issueIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>>;
|
|
109
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { BaseRequestOptions } from '../infrastructure';
|
|
3
|
+
export interface StatisticsSchema extends Record<string, unknown> {
|
|
4
|
+
statistics: {
|
|
5
|
+
counts: {
|
|
6
|
+
all: number;
|
|
7
|
+
closed: number;
|
|
8
|
+
opened: number;
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
export declare class IssuesStatistics<C extends boolean = false> extends BaseResource<C> {
|
|
13
|
+
all({ projectId, groupId, ...options }?: {
|
|
14
|
+
projectId?: string | number;
|
|
15
|
+
groupId?: string | number;
|
|
16
|
+
} & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, StatisticsSchema>>;
|
|
17
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
3
|
+
import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
|
|
4
|
+
import { CommitSchema } from './Commits';
|
|
5
|
+
import { RunnerSchema } from './Runners';
|
|
6
|
+
import { UserSchema } from './Users';
|
|
7
|
+
import { PipelineSchema } from './Pipelines';
|
|
8
|
+
export declare type JobScope = 'created' | 'pending' | 'running' | 'failed' | 'success' | 'canceled' | 'skipped' | 'manual';
|
|
9
|
+
export interface ArtifactSchema extends Record<string, unknown> {
|
|
10
|
+
file_type: string;
|
|
11
|
+
size: number;
|
|
12
|
+
filename: string;
|
|
13
|
+
file_format?: string;
|
|
14
|
+
}
|
|
15
|
+
export interface JobSchema extends Record<string, unknown> {
|
|
16
|
+
id: number;
|
|
17
|
+
status: string;
|
|
18
|
+
stage: string;
|
|
19
|
+
name: string;
|
|
20
|
+
ref: string;
|
|
21
|
+
tag: boolean;
|
|
22
|
+
coverage?: string;
|
|
23
|
+
allow_failure: boolean;
|
|
24
|
+
created_at: Date;
|
|
25
|
+
started_at?: Date;
|
|
26
|
+
finished_at?: Date;
|
|
27
|
+
duration?: number;
|
|
28
|
+
user: UserSchema;
|
|
29
|
+
commit: CommitSchema;
|
|
30
|
+
pipeline: PipelineSchema;
|
|
31
|
+
web_url: string;
|
|
32
|
+
artifacts: ArtifactSchema[];
|
|
33
|
+
runner: RunnerSchema;
|
|
34
|
+
artifacts_expire_at?: Date;
|
|
35
|
+
tag_list?: string[];
|
|
36
|
+
}
|
|
37
|
+
export interface BridgeSchema extends Record<string, unknown> {
|
|
38
|
+
commit: Pick<CommitSchema, 'id' | 'short_id' | 'author_name' | 'author_email' | 'message' | 'title' | 'created_at'>;
|
|
39
|
+
coverage?: string;
|
|
40
|
+
allow_failure: boolean;
|
|
41
|
+
created_at: string;
|
|
42
|
+
started_at: string;
|
|
43
|
+
finished_at: string;
|
|
44
|
+
duration: number;
|
|
45
|
+
queued_duration: number;
|
|
46
|
+
id: number;
|
|
47
|
+
name: string;
|
|
48
|
+
pipeline: Omit<PipelineSchema & {
|
|
49
|
+
project_id: number;
|
|
50
|
+
}, 'user'>;
|
|
51
|
+
ref: string;
|
|
52
|
+
stage: string;
|
|
53
|
+
status: string;
|
|
54
|
+
tag: boolean;
|
|
55
|
+
web_url: string;
|
|
56
|
+
user: UserSchema;
|
|
57
|
+
downstream_pipeline: Omit<PipelineSchema, 'user'>;
|
|
58
|
+
}
|
|
59
|
+
export declare class Jobs<C extends boolean = false> extends BaseResource<C> {
|
|
60
|
+
all(projectId: string | number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>[]>;
|
|
61
|
+
cancel(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>>;
|
|
62
|
+
downloadSingleArtifactFile(projectId: string | number, jobId: number, artifactPath: string, { stream, ...options }?: {
|
|
63
|
+
stream?: boolean;
|
|
64
|
+
} & BaseRequestOptions): NodeJS.ReadableStream | Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
65
|
+
downloadSingleArtifactFileFromRef(projectId: string | number, ref: string, artifactPath: string, jobName: string, { stream, ...options }?: {
|
|
66
|
+
stream?: boolean;
|
|
67
|
+
} & BaseRequestOptions): NodeJS.ReadableStream | Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
68
|
+
downloadLatestArtifactFile(projectId: string | number, ref: string, jobName: string, { stream, ...options }?: {
|
|
69
|
+
stream?: boolean;
|
|
70
|
+
} & BaseRequestOptions): NodeJS.ReadableStream | Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
71
|
+
downloadTraceFile(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
72
|
+
erase(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>>;
|
|
73
|
+
eraseArtifacts(projectId: string | number, jobId: number, options?: Sudo): Promise<void>;
|
|
74
|
+
keepArtifacts(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
75
|
+
play(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>>;
|
|
76
|
+
retry(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>>;
|
|
77
|
+
show(projectId: string | number, jobId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>>;
|
|
78
|
+
showPipelineJobs(projectId: string | number, pipelineId: number, options?: {
|
|
79
|
+
scope?: JobScope;
|
|
80
|
+
} & Sudo): Promise<import("../infrastructure").CamelizedRecord<C, JobSchema>[]>;
|
|
81
|
+
showPipelineBridges(projectId: string | number, pipelineId: number, options?: {
|
|
82
|
+
scope?: JobScope;
|
|
83
|
+
} & Sudo): Promise<import("../infrastructure").CamelizedRecord<C, BridgeSchema>>;
|
|
84
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { UserExtendedSchema } from './Users';
|
|
3
|
+
import { Sudo } from '../infrastructure';
|
|
4
|
+
export interface KeySchema extends Record<string, unknown> {
|
|
5
|
+
id: number;
|
|
6
|
+
title: string;
|
|
7
|
+
key: string;
|
|
8
|
+
created_at: string;
|
|
9
|
+
expires_at: string;
|
|
10
|
+
user: UserExtendedSchema;
|
|
11
|
+
}
|
|
12
|
+
export declare class Keys<C extends boolean = false> extends BaseResource<C> {
|
|
13
|
+
show(keyId: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, KeySchema>>;
|
|
14
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { BaseRequestOptions, PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
|
|
3
|
+
import { ResourceLabels } from '../templates';
|
|
4
|
+
import { LabelSchema } from '../templates/types';
|
|
5
|
+
export interface Labels<C extends boolean = false> extends ResourceLabels<C> {
|
|
6
|
+
all(projectId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, LabelSchema>[]>;
|
|
7
|
+
create(projectId: string | number, labelName: string, color: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, LabelSchema>>;
|
|
8
|
+
edit(projectId: string | number, labelId: number | string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, LabelSchema>>;
|
|
9
|
+
remove(projectId: string | number, labelId: number | string, options?: Sudo): Promise<void>;
|
|
10
|
+
subscribe(projectId: string | number, labelId: number | string, options?: Sudo): Promise<CamelizedRecord<C, LabelSchema>>;
|
|
11
|
+
unsubscribe(projectId: string | number, labelId: number | string, options?: Sudo): Promise<CamelizedRecord<C, LabelSchema>>;
|
|
12
|
+
}
|
|
13
|
+
export declare class Labels<C extends boolean = false> extends ResourceLabels<C> {
|
|
14
|
+
constructor(options: BaseResourceOptions<C>);
|
|
15
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { Sudo } from '../infrastructure';
|
|
3
|
+
export interface LicenseSchema extends Record<string, unknown> {
|
|
4
|
+
id: number;
|
|
5
|
+
plan: string;
|
|
6
|
+
created_at: string;
|
|
7
|
+
starts_at: string;
|
|
8
|
+
expires_at: string;
|
|
9
|
+
historical_max: number;
|
|
10
|
+
maximum_user_count: number;
|
|
11
|
+
expired: boolean;
|
|
12
|
+
overage: number;
|
|
13
|
+
user_limit: number;
|
|
14
|
+
active_users: number;
|
|
15
|
+
licensee: {
|
|
16
|
+
Name: string;
|
|
17
|
+
};
|
|
18
|
+
add_ons: {
|
|
19
|
+
GitLab_FileLocks: number;
|
|
20
|
+
GitLab_Auditor_User: number;
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
export declare class License<C extends boolean = false> extends BaseResource<C> {
|
|
24
|
+
add(license: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, LicenseSchema>>;
|
|
25
|
+
all(options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, LicenseSchema>[]>;
|
|
26
|
+
show(options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, LicenseSchema>>;
|
|
27
|
+
remove(licenceId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, LicenseSchema>>;
|
|
28
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceTemplates } from '../templates';
|
|
3
|
+
import { PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
4
|
+
export interface LicenseTemplateSchema extends Record<string, unknown> {
|
|
5
|
+
key: string;
|
|
6
|
+
name: string;
|
|
7
|
+
nickname?: string;
|
|
8
|
+
featured: boolean;
|
|
9
|
+
html_url: string;
|
|
10
|
+
source_url: string;
|
|
11
|
+
description: string;
|
|
12
|
+
conditions?: string[];
|
|
13
|
+
permissions?: string[];
|
|
14
|
+
limitations?: string[];
|
|
15
|
+
content: string;
|
|
16
|
+
}
|
|
17
|
+
export interface LicenseTemplates<C extends boolean = false> extends ResourceTemplates<C> {
|
|
18
|
+
all(options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, LicenseTemplateSchema>[]>;
|
|
19
|
+
show(key: string | number, options?: Sudo): Promise<CamelizedRecord<C, LicenseTemplateSchema>>;
|
|
20
|
+
}
|
|
21
|
+
export declare class LicenseTemplates<C extends boolean = false> extends ResourceTemplates<C> {
|
|
22
|
+
constructor(options: BaseResourceOptions<C>);
|
|
23
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { Sudo } from '../infrastructure';
|
|
3
|
+
export interface LintSchema extends Record<string, unknown> {
|
|
4
|
+
status: string;
|
|
5
|
+
errors?: string[];
|
|
6
|
+
warnings?: string[];
|
|
7
|
+
}
|
|
8
|
+
export declare class Lint<C extends boolean = false> extends BaseResource<C> {
|
|
9
|
+
lint(content: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, LintSchema>>;
|
|
10
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { Sudo } from '../infrastructure';
|
|
3
|
+
export interface MarkdownSchema extends Record<string, unknown> {
|
|
4
|
+
html: string;
|
|
5
|
+
}
|
|
6
|
+
export declare class Markdown<C extends boolean = false> extends BaseResource<C> {
|
|
7
|
+
render(text: string, options?: {
|
|
8
|
+
gfm?: string;
|
|
9
|
+
project?: string | number;
|
|
10
|
+
} & Sudo): Promise<import("../infrastructure").CamelizedRecord<C, MarkdownSchema>>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { BaseResource } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { BaseRequestOptions, Sudo } from '../infrastructure';
|
|
3
|
+
import { UserSchema } from './Users';
|
|
4
|
+
import { GroupSchema } from './Groups';
|
|
5
|
+
import { ProtectedBranchSchema } from './ProtectedBranches';
|
|
6
|
+
export interface ProjectLevelMergeRequestApprovalSchema extends Record<string, unknown> {
|
|
7
|
+
approvals_before_merge: number;
|
|
8
|
+
reset_approvals_on_push: boolean;
|
|
9
|
+
disable_overriding_approvers_per_merge_request: boolean;
|
|
10
|
+
merge_requests_author_approval: boolean;
|
|
11
|
+
merge_requests_disable_committers_approval: boolean;
|
|
12
|
+
require_password_to_approve: boolean;
|
|
13
|
+
}
|
|
14
|
+
export interface ApprovedByEntity {
|
|
15
|
+
user: Pick<UserSchema, 'name' | 'username' | 'id' | 'state' | 'avatar_url' | 'web_url'>;
|
|
16
|
+
}
|
|
17
|
+
export interface MergeRequestLevelMergeRequestApprovalSchema extends Record<string, unknown> {
|
|
18
|
+
id: number;
|
|
19
|
+
iid: number;
|
|
20
|
+
project_id: number;
|
|
21
|
+
title: string;
|
|
22
|
+
description: string;
|
|
23
|
+
state: string;
|
|
24
|
+
created_at: string;
|
|
25
|
+
updated_at: string;
|
|
26
|
+
merge_status: string;
|
|
27
|
+
approvals_required: number;
|
|
28
|
+
approvals_left: number;
|
|
29
|
+
approved_by?: ApprovedByEntity[];
|
|
30
|
+
}
|
|
31
|
+
export declare type ApprovalRulesRequestOptions = {
|
|
32
|
+
userIds?: number[];
|
|
33
|
+
groupIds?: number[];
|
|
34
|
+
protectedBranchIds?: number[];
|
|
35
|
+
};
|
|
36
|
+
export interface ApprovalRuleSchema extends Record<string, unknown> {
|
|
37
|
+
id: number;
|
|
38
|
+
name: string;
|
|
39
|
+
rule_type: string;
|
|
40
|
+
eligible_approvers?: Pick<UserSchema, 'name' | 'username' | 'id' | 'state' | 'avatar_url' | 'web_url'>[];
|
|
41
|
+
approvals_required: number;
|
|
42
|
+
users?: Pick<UserSchema, 'name' | 'username' | 'id' | 'state' | 'avatar_url' | 'web_url'>[];
|
|
43
|
+
groups?: GroupSchema[];
|
|
44
|
+
contains_hidden_groups: boolean;
|
|
45
|
+
overridden: boolean;
|
|
46
|
+
}
|
|
47
|
+
export interface ProjectLevelApprovalRuleSchema extends ApprovalRuleSchema {
|
|
48
|
+
protected_branches?: ProtectedBranchSchema[];
|
|
49
|
+
}
|
|
50
|
+
export interface MergeRequestLevelApprovalRuleSchema extends ApprovalRuleSchema {
|
|
51
|
+
source_rule?: string;
|
|
52
|
+
}
|
|
53
|
+
export declare class MergeRequestApprovals<C extends boolean = false> extends BaseResource<C> {
|
|
54
|
+
configuration(projectId: string | number, options?: {
|
|
55
|
+
mergerequestIid?: undefined;
|
|
56
|
+
} & BaseRequestOptions): Promise<ProjectLevelMergeRequestApprovalSchema>;
|
|
57
|
+
configuration(projectId: string | number, options: {
|
|
58
|
+
mergerequestIid: number;
|
|
59
|
+
} & BaseRequestOptions): Promise<MergeRequestLevelMergeRequestApprovalSchema>;
|
|
60
|
+
editConfiguration(projectId: string | number, options?: {
|
|
61
|
+
mergerequestIid?: undefined;
|
|
62
|
+
} & BaseRequestOptions): Promise<ProjectLevelMergeRequestApprovalSchema>;
|
|
63
|
+
editConfiguration(projectId: string | number, options: {
|
|
64
|
+
mergerequestIid: number;
|
|
65
|
+
} & BaseRequestOptions): Promise<MergeRequestLevelMergeRequestApprovalSchema>;
|
|
66
|
+
approvalRule(projectId: string | number, approvalRuleId: number, options: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
67
|
+
approvalRules(projectId: string | number, options?: {
|
|
68
|
+
mergerequestIid?: undefined;
|
|
69
|
+
} & BaseRequestOptions): Promise<ProjectLevelApprovalRuleSchema[]>;
|
|
70
|
+
approvalRules(projectId: string | number, options: {
|
|
71
|
+
mergerequestIid: number;
|
|
72
|
+
} & BaseRequestOptions): Promise<MergeRequestLevelApprovalRuleSchema[]>;
|
|
73
|
+
addApprovalRule(projectId: string | number, name: string, approvalsRequired: number, options?: {
|
|
74
|
+
mergerequestIid?: undefined;
|
|
75
|
+
} & ApprovalRulesRequestOptions & BaseRequestOptions): Promise<ProjectLevelApprovalRuleSchema>;
|
|
76
|
+
addApprovalRule(projectId: string | number, name: string, approvalsRequired: number, options: {
|
|
77
|
+
mergerequestIid: number;
|
|
78
|
+
} & ApprovalRulesRequestOptions & BaseRequestOptions): Promise<MergeRequestLevelApprovalRuleSchema>;
|
|
79
|
+
approvalState(projectId: string | number, mergerequestIid: number, options?: {
|
|
80
|
+
sha?: string;
|
|
81
|
+
} & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
|
|
82
|
+
editApprovalRule(projectId: string | number, approvalRuleId: number, name: string, approvalsRequired: number, options?: {
|
|
83
|
+
mergerequestIid?: undefined;
|
|
84
|
+
} & ApprovalRulesRequestOptions & BaseRequestOptions): Promise<ProjectLevelApprovalRuleSchema>;
|
|
85
|
+
editApprovalRule(projectId: string | number, approvalRuleId: number, name: string, approvalsRequired: number, options: {
|
|
86
|
+
mergerequestIid: number;
|
|
87
|
+
} & ApprovalRulesRequestOptions & BaseRequestOptions): Promise<MergeRequestLevelApprovalRuleSchema>;
|
|
88
|
+
removeApprovalRule(projectId: string | number, approvalRuleId: number, options?: {
|
|
89
|
+
mergerequestIid?: undefined;
|
|
90
|
+
} & Sudo): Promise<void>;
|
|
91
|
+
removeApprovalRule(projectId: string | number, approvalRuleId: number, options: {
|
|
92
|
+
mergerequestIid: number;
|
|
93
|
+
} & Sudo): Promise<void>;
|
|
94
|
+
approve(projectId: string | number, mergerequestIid: number, options?: {
|
|
95
|
+
sha?: string;
|
|
96
|
+
} & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestLevelMergeRequestApprovalSchema>>;
|
|
97
|
+
unapprove(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<void>;
|
|
98
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BaseResourceOptions } from '@gitbeaker/requester-utils';
|
|
2
|
+
import { ResourceAwardEmojis } from '../templates';
|
|
3
|
+
import { AwardEmojiSchema } from '../templates/types';
|
|
4
|
+
import { PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
|
|
5
|
+
export interface MergeRequestAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
|
|
6
|
+
all(projectId: string | number, mergerequestIId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, AwardEmojiSchema>[]>;
|
|
7
|
+
award(projectId: string | number, mergerequestIId: number, name: string, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
8
|
+
remove(projectId: string | number, mergerequestIId: number, awardId: number, options?: Sudo): Promise<void>;
|
|
9
|
+
show(projectId: string | number, mergerequestIId: number, awardId: number, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
|
|
10
|
+
}
|
|
11
|
+
export declare class MergeRequestAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
|
|
12
|
+
constructor(options: BaseResourceOptions<C>);
|
|
13
|
+
}
|