@gitbeaker/core 35.8.0 → 36.0.0-rc.2

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.
Files changed (132) hide show
  1. package/README.md +179 -25
  2. package/dist/index.d.ts +7128 -0
  3. package/dist/index.js +6909 -3167
  4. package/dist/index.mjs +6825 -0
  5. package/dist/map.json +7553 -1
  6. package/package.json +52 -49
  7. package/LICENSE.md +0 -22
  8. package/dist/index.es.js +0 -3141
  9. package/dist/index.es.js.map +0 -1
  10. package/dist/index.js.map +0 -1
  11. package/dist/types/index.d.ts +0 -4
  12. package/dist/types/infrastructure/RequestHelper.d.ts +0 -55
  13. package/dist/types/infrastructure/Utils.d.ts +0 -13
  14. package/dist/types/infrastructure/index.d.ts +0 -2
  15. package/dist/types/resources/ApplicationSettings.d.ts +0 -69
  16. package/dist/types/resources/Branches.d.ts +0 -20
  17. package/dist/types/resources/BroadcastMessages.d.ts +0 -21
  18. package/dist/types/resources/CommitDiscussions.d.ts +0 -17
  19. package/dist/types/resources/Commits.d.ts +0 -132
  20. package/dist/types/resources/ContainerRegistry.d.ts +0 -37
  21. package/dist/types/resources/DeployKeys.d.ts +0 -19
  22. package/dist/types/resources/Deployments.d.ts +0 -44
  23. package/dist/types/resources/DockerfileTemplates.d.ts +0 -5
  24. package/dist/types/resources/Environments.d.ts +0 -22
  25. package/dist/types/resources/EpicDiscussions.d.ts +0 -17
  26. package/dist/types/resources/EpicIssues.d.ts +0 -12
  27. package/dist/types/resources/EpicNotes.d.ts +0 -18
  28. package/dist/types/resources/Epics.d.ts +0 -47
  29. package/dist/types/resources/Events.d.ts +0 -29
  30. package/dist/types/resources/FeatureFlags.d.ts +0 -33
  31. package/dist/types/resources/FreezePeriods.d.ts +0 -17
  32. package/dist/types/resources/GeoNodes.d.ts +0 -143
  33. package/dist/types/resources/GitLabCIYMLTemplates.d.ts +0 -5
  34. package/dist/types/resources/GitignoreTemplates.d.ts +0 -5
  35. package/dist/types/resources/Gitlab.d.ts +0 -202
  36. package/dist/types/resources/GroupAccessRequests.d.ts +0 -15
  37. package/dist/types/resources/GroupBadges.d.ts +0 -18
  38. package/dist/types/resources/GroupCustomAttributes.d.ts +0 -13
  39. package/dist/types/resources/GroupDeployTokens.d.ts +0 -14
  40. package/dist/types/resources/GroupIssueBoards.d.ts +0 -23
  41. package/dist/types/resources/GroupLabels.d.ts +0 -15
  42. package/dist/types/resources/GroupMembers.d.ts +0 -14
  43. package/dist/types/resources/GroupMilestones.d.ts +0 -17
  44. package/dist/types/resources/GroupRunners.d.ts +0 -6
  45. package/dist/types/resources/GroupVariables.d.ts +0 -14
  46. package/dist/types/resources/Groups.d.ts +0 -67
  47. package/dist/types/resources/IssueAwardEmojis.d.ts +0 -13
  48. package/dist/types/resources/IssueDiscussions.d.ts +0 -17
  49. package/dist/types/resources/IssueNoteAwardEmojis.d.ts +0 -13
  50. package/dist/types/resources/IssueNotes.d.ts +0 -22
  51. package/dist/types/resources/Issues.d.ts +0 -111
  52. package/dist/types/resources/IssuesStatistics.d.ts +0 -17
  53. package/dist/types/resources/Jobs.d.ts +0 -84
  54. package/dist/types/resources/Keys.d.ts +0 -14
  55. package/dist/types/resources/Labels.d.ts +0 -15
  56. package/dist/types/resources/License.d.ts +0 -28
  57. package/dist/types/resources/LicenseTemplates.d.ts +0 -23
  58. package/dist/types/resources/Lint.d.ts +0 -15
  59. package/dist/types/resources/Markdown.d.ts +0 -11
  60. package/dist/types/resources/MergeRequestApprovals.d.ts +0 -98
  61. package/dist/types/resources/MergeRequestAwardEmojis.d.ts +0 -13
  62. package/dist/types/resources/MergeRequestDiscussions.d.ts +0 -20
  63. package/dist/types/resources/MergeRequestNotes.d.ts +0 -22
  64. package/dist/types/resources/MergeRequests.d.ts +0 -192
  65. package/dist/types/resources/Namespaces.d.ts +0 -22
  66. package/dist/types/resources/NotificationSettings.d.ts +0 -21
  67. package/dist/types/resources/PackageRegistry.d.ts +0 -14
  68. package/dist/types/resources/Packages.d.ts +0 -30
  69. package/dist/types/resources/PagesDomains.d.ts +0 -21
  70. package/dist/types/resources/PipelineScheduleVariables.d.ts +0 -10
  71. package/dist/types/resources/PipelineSchedules.d.ts +0 -29
  72. package/dist/types/resources/Pipelines.d.ts +0 -40
  73. package/dist/types/resources/ProjectAccessRequests.d.ts +0 -15
  74. package/dist/types/resources/ProjectBadges.d.ts +0 -18
  75. package/dist/types/resources/ProjectCustomAttributes.d.ts +0 -13
  76. package/dist/types/resources/ProjectDeployTokens.d.ts +0 -14
  77. package/dist/types/resources/ProjectHooks.d.ts +0 -29
  78. package/dist/types/resources/ProjectImportExport.d.ts +0 -54
  79. package/dist/types/resources/ProjectIssueBoards.d.ts +0 -23
  80. package/dist/types/resources/ProjectMembers.d.ts +0 -14
  81. package/dist/types/resources/ProjectMilestones.d.ts +0 -17
  82. package/dist/types/resources/ProjectSnippetAwardEmojis.d.ts +0 -13
  83. package/dist/types/resources/ProjectSnippetDiscussions.d.ts +0 -17
  84. package/dist/types/resources/ProjectSnippetNotes.d.ts +0 -18
  85. package/dist/types/resources/ProjectSnippets.d.ts +0 -29
  86. package/dist/types/resources/ProjectVariables.d.ts +0 -14
  87. package/dist/types/resources/Projects.d.ts +0 -161
  88. package/dist/types/resources/ProtectedBranches.d.ts +0 -24
  89. package/dist/types/resources/ProtectedTags.d.ts +0 -16
  90. package/dist/types/resources/PushRules.d.ts +0 -24
  91. package/dist/types/resources/ReleaseLinks.d.ts +0 -24
  92. package/dist/types/resources/Releases.d.ts +0 -48
  93. package/dist/types/resources/Repositories.d.ts +0 -37
  94. package/dist/types/resources/RepositoryFiles.d.ts +0 -31
  95. package/dist/types/resources/RepositorySubmodules.d.ts +0 -20
  96. package/dist/types/resources/Runners.d.ts +0 -38
  97. package/dist/types/resources/Search.d.ts +0 -26
  98. package/dist/types/resources/Services.d.ts +0 -29
  99. package/dist/types/resources/SidekiqMetrics.d.ts +0 -37
  100. package/dist/types/resources/Snippets.d.ts +0 -42
  101. package/dist/types/resources/SystemHooks.d.ts +0 -18
  102. package/dist/types/resources/Tags.d.ts +0 -18
  103. package/dist/types/resources/Todos.d.ts +0 -48
  104. package/dist/types/resources/Triggers.d.ts +0 -22
  105. package/dist/types/resources/UserCustomAttributes.d.ts +0 -13
  106. package/dist/types/resources/UserEmails.d.ts +0 -19
  107. package/dist/types/resources/UserGPGKeys.d.ts +0 -21
  108. package/dist/types/resources/UserImpersonationTokens.d.ts +0 -23
  109. package/dist/types/resources/UserSSHKeys.d.ts +0 -22
  110. package/dist/types/resources/Users.d.ts +0 -57
  111. package/dist/types/resources/Version.d.ts +0 -9
  112. package/dist/types/resources/VulnerabilityFindings.d.ts +0 -69
  113. package/dist/types/resources/Wikis.d.ts +0 -15
  114. package/dist/types/resources/index.d.ts +0 -98
  115. package/dist/types/resources/types.d.ts +0 -68
  116. package/dist/types/templates/ResourceAccessRequests.d.ts +0 -20
  117. package/dist/types/templates/ResourceAwardEmojis.d.ts +0 -21
  118. package/dist/types/templates/ResourceBadges.d.ts +0 -20
  119. package/dist/types/templates/ResourceCustomAttributes.d.ts +0 -13
  120. package/dist/types/templates/ResourceDeployTokens.d.ts +0 -20
  121. package/dist/types/templates/ResourceDiscussions.d.ts +0 -48
  122. package/dist/types/templates/ResourceIssueBoards.d.ts +0 -31
  123. package/dist/types/templates/ResourceLabels.d.ts +0 -25
  124. package/dist/types/templates/ResourceMembers.d.ts +0 -30
  125. package/dist/types/templates/ResourceMilestones.d.ts +0 -27
  126. package/dist/types/templates/ResourceNoteAwardEmojis.d.ts +0 -11
  127. package/dist/types/templates/ResourceNotes.d.ts +0 -20
  128. package/dist/types/templates/ResourceTemplates.d.ts +0 -11
  129. package/dist/types/templates/ResourceVariables.d.ts +0 -18
  130. package/dist/types/templates/index.d.ts +0 -14
  131. package/dist/types/templates/types.d.ts +0 -13
  132. package/dist/types/types.d.ts +0 -3
@@ -1,192 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { UserSchema } from './Users';
3
- import { PipelineSchema } from './Pipelines';
4
- import { IssueSchema, TimeStatsSchema } from './Issues';
5
- import { CommitSchema, CommitDiffSchema } from './Commits';
6
- import { MilestoneSchema } from '../templates/types';
7
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
8
- export interface AcceptMergeRequestOptions {
9
- mergeCommitMessage?: string;
10
- squashCommitMessage?: string;
11
- squash?: boolean;
12
- shouldRemoveSourceBranch?: boolean;
13
- mergeWhenPipelineSucceeds?: boolean;
14
- sha?: string;
15
- }
16
- export interface ShowMergeRequestOptions {
17
- renderHtml?: boolean;
18
- includeDivergedCommitsCount?: true;
19
- includeRebaseInProgress?: boolean;
20
- }
21
- export interface CreateMergeRequestOptions {
22
- assigneeId?: number;
23
- description?: string;
24
- targetProjectId?: number;
25
- labels?: string | Array<string>;
26
- milestoneId?: number;
27
- removeSourceBranch?: boolean;
28
- allowCollaboration?: boolean;
29
- allowMaintainerToPush?: boolean;
30
- squash?: boolean;
31
- }
32
- export interface UpdateMergeRequestOptions {
33
- targetBranch?: number;
34
- title?: string;
35
- assigneeId?: number;
36
- reviewerId?: number;
37
- milestoneId?: number;
38
- labels?: string | Array<string>;
39
- description?: string;
40
- stateEvent?: string;
41
- removeSourceBranch?: boolean;
42
- squash?: boolean;
43
- discussionLocked?: boolean;
44
- allowCollaboration?: boolean;
45
- allowMaintainerToPush?: boolean;
46
- }
47
- export interface AllMergeRequestsOptions {
48
- state?: 'opened' | 'closed' | 'locked' | 'merged';
49
- orderBy?: 'created_at' | 'updated_at';
50
- sort?: 'asc' | 'desc';
51
- milestone?: 'None' | string;
52
- view?: string;
53
- labels?: string | Array<string>;
54
- withLabelsDetails?: boolean;
55
- withMergeStatusRecheck?: boolean;
56
- createdAfter?: string;
57
- createdBefore?: string;
58
- updatedBefore?: string;
59
- updatedAfter?: string;
60
- scope?: 'created_by_me' | 'assigned_to_me' | 'all';
61
- authorId?: number;
62
- authorUsername?: string;
63
- assigneeId?: number;
64
- assigneeUsername?: string;
65
- approverIds?: Array<number>;
66
- approvedByIds?: Array<number>;
67
- reviewerId?: number;
68
- reviewerUsername?: string;
69
- myReactionEmoji?: string;
70
- sourceBranch?: string;
71
- targetBranch?: string;
72
- in?: string;
73
- wip?: string;
74
- iids?: number[];
75
- mergeCommitMessage?: string;
76
- squashCommitMessage?: string;
77
- squash?: boolean;
78
- shouldRemoveSourceBranch?: boolean;
79
- mergeWhenPipelineSucceeds?: boolean;
80
- sha?: string;
81
- search?: string;
82
- not?: {
83
- labels?: string | Array<string>;
84
- milestone?: string;
85
- authorId?: number;
86
- authorUsername?: string;
87
- assigneeId?: number;
88
- assigneeUsername?: string;
89
- reviewerId?: number;
90
- reviewerUsername?: string;
91
- myReactionEmoji?: string;
92
- };
93
- environment?: string;
94
- deployedBefore?: string;
95
- deployedAfter?: string;
96
- }
97
- export interface ReferenceSchema {
98
- short: string;
99
- relative: string;
100
- full: string;
101
- }
102
- export interface TaskCompletionStatusSchema {
103
- count: number;
104
- completed_count: number;
105
- }
106
- export interface RebaseSchema extends Record<string, unknown> {
107
- rebase_in_progress?: boolean;
108
- merge_error?: string;
109
- }
110
- export interface DiffSchema extends Record<string, unknown> {
111
- id: number;
112
- head_commit_sha: string;
113
- base_commit_sha: string;
114
- start_commit_sha: string;
115
- created_at: string;
116
- merge_request_id: number;
117
- state: string;
118
- real_size: string;
119
- commits?: CommitSchema[];
120
- diffs?: CommitDiffSchema[];
121
- }
122
- export interface MergeRequestSchema extends Record<string, unknown> {
123
- id: number;
124
- iid: number;
125
- project_id: number;
126
- title: string;
127
- description: string;
128
- state: string;
129
- merged_by: Omit<UserSchema, 'created_at'>;
130
- merged_at: string;
131
- closed_by?: string;
132
- closed_at?: string;
133
- created_at: string;
134
- updated_at: string;
135
- target_branch: string;
136
- source_branch: string;
137
- upvotes: number;
138
- downvotes: number;
139
- author: Omit<UserSchema, 'created_at'>;
140
- assignee: Omit<UserSchema, 'created_at'>;
141
- assignees?: Omit<UserSchema, 'created_at'>[];
142
- reviewers?: Omit<UserSchema, 'created_at'>[];
143
- source_project_id: number;
144
- target_project_id: number;
145
- labels?: string[];
146
- work_in_progress: boolean;
147
- milestone: MilestoneSchema;
148
- merge_when_pipeline_succeeds: boolean;
149
- merge_status: string;
150
- sha: string;
151
- merge_commit_sha?: string;
152
- squash_commit_sha?: string;
153
- user_notes_count: number;
154
- discussion_locked?: string;
155
- should_remove_source_branch: boolean;
156
- force_remove_source_branch: boolean;
157
- web_url: string;
158
- references: ReferenceSchema;
159
- time_stats: TimeStatsSchema;
160
- squash: boolean;
161
- task_completion_status: TaskCompletionStatusSchema;
162
- has_conflicts: boolean;
163
- blocking_discussions_resolved: boolean;
164
- changes?: CommitDiffSchema[];
165
- }
166
- export declare class MergeRequests<C extends boolean = false> extends BaseResource<C> {
167
- accept(projectId: string | number, mergerequestIid: number, options?: AcceptMergeRequestOptions & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
168
- addSpentTime(projectId: string | number, mergerequestIid: number, duration: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
169
- addTimeEstimate(projectId: string | number, mergerequestIid: number, duration: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
170
- all({ projectId, groupId, ...options }?: {
171
- projectId?: string | number;
172
- groupId?: string | number;
173
- } & AllMergeRequestsOptions & PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>[]>;
174
- cancelOnPipelineSucess(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
175
- changes(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
176
- closesIssues(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, IssueSchema>[]>;
177
- commits(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, CommitSchema>[]>;
178
- create(projectId: string | number, sourceBranch: string, targetBranch: string, title: string, options?: CreateMergeRequestOptions & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
179
- edit(projectId: string | number, mergerequestIid: number, options?: UpdateMergeRequestOptions & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
180
- participants(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Omit<UserSchema, "created_at">>[]>;
181
- pipelines(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Pick<PipelineSchema, "id" | "sha" | "ref" | "status">>[]>;
182
- rebase(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, RebaseSchema>>;
183
- remove(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<void>;
184
- resetSpentTime(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
185
- resetTimeEstimate(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
186
- show(projectId: string | number, mergerequestIid: number, options?: ShowMergeRequestOptions & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
187
- subscribe(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
188
- timeStats(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, TimeStatsSchema>>;
189
- version(projectId: string | number, mergerequestIid: number, versionId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, DiffSchema>>;
190
- versions(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, DiffSchema>[]>;
191
- unsubscribe(projectId: string | number, mergerequestIid: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, MergeRequestSchema>>;
192
- }
@@ -1,22 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { PaginatedRequestOptions, Sudo } from '../infrastructure';
3
- export interface NamespaceSchema extends Record<string, unknown> {
4
- id: number;
5
- name: string;
6
- path: string;
7
- kind: string;
8
- full_path: string;
9
- parent_id?: number;
10
- avatar_url: string;
11
- web_url: string;
12
- billable_members_count: number;
13
- plan: string;
14
- trial_ends_on?: string;
15
- trial: boolean;
16
- }
17
- export declare class Namespaces<C extends boolean = false> extends BaseResource<C> {
18
- all(options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, NamespaceSchema>[]>;
19
- show(namespaceId: string | number, options?: {
20
- search?: string;
21
- } & Sudo): Promise<import("../infrastructure").CamelizedRecord<C, NamespaceSchema>>;
22
- }
@@ -1,21 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { BaseRequestOptions, PaginatedRequestOptions } from '../infrastructure';
3
- export declare type NotificationSettingLevel = 'disabled' | 'participating' | 'watch' | 'global' | 'mention' | 'custom';
4
- export interface NotificationSettingSchema extends Record<string, unknown> {
5
- level: NotificationSettingLevel;
6
- notification_email: string;
7
- }
8
- export declare class NotificationSettings<C extends boolean = false> extends BaseResource<C> {
9
- all({ projectId, groupId, ...options }?: ({
10
- projectId?: string | number;
11
- } | {
12
- groupId?: string | number;
13
- }) & PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, NotificationSettingSchema>[]>;
14
- edit({ projectId, groupId, ...options }?: {
15
- level?: NotificationSettingLevel;
16
- } & ({
17
- projectId?: string | number;
18
- } | {
19
- groupId?: string | number;
20
- }) & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, NotificationSettingSchema>>;
21
- }
@@ -1,14 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { Sudo } from '../infrastructure';
3
- export declare class PackageRegistry<C extends boolean = false> extends BaseResource<C> {
4
- publish(projectId: string | number, packageName: string, packageVersion: string, filename: string, content: string, { contentType, ...options }?: {
5
- contentType?: string;
6
- } & {
7
- status?: 'default' | 'hidden';
8
- }): Promise<import("../infrastructure").CamelizedRecord<C, {
9
- message: string;
10
- }>>;
11
- download(projectId: string | number, packageName: string, packageVersion: string, filename: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, {
12
- message: string;
13
- }>>;
14
- }
@@ -1,30 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { PipelineSchema } from './Pipelines';
3
- import { PaginatedRequestOptions, Sudo } from '../infrastructure';
4
- export interface PackageSchema extends Record<string, unknown> {
5
- id: number;
6
- name: string;
7
- version: string;
8
- package_type: string;
9
- created_at: string;
10
- }
11
- export interface PackageFileSchema extends Record<string, unknown> {
12
- id: number;
13
- package_id: number;
14
- created_at: string;
15
- file_name: string;
16
- size: number;
17
- file_md5: string;
18
- file_sha1: string;
19
- pipelines?: PipelineSchema[];
20
- }
21
- export declare class Packages<C extends boolean = false> extends BaseResource<C> {
22
- all({ projectId, groupId, ...options }?: {
23
- projectId?: string | number;
24
- groupId?: string | number;
25
- } & PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PackageSchema>[]>;
26
- remove(projectId: string | number, packageId: number, options?: Sudo): Promise<void>;
27
- removeFile(projectId: string | number, packageId: number, projectFileId: number, options?: Sudo): Promise<void>;
28
- show(projectId: string | number, packageId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PackageSchema>>;
29
- showFiles(projectId: string | number, packageId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PackageFileSchema>[]>;
30
- }
@@ -1,21 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
3
- export interface PagesDomainSchema extends Record<string, unknown> {
4
- domain: string;
5
- url: string;
6
- project_id: number;
7
- auto_ssl_enabled: boolean;
8
- certificate: {
9
- expired: boolean;
10
- expiration: string;
11
- };
12
- }
13
- export declare class PagesDomains<C extends boolean = false> extends BaseResource<C> {
14
- all({ projectId, ...options }?: {
15
- projectId?: string | number;
16
- } & PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PagesDomainSchema>[]>;
17
- create(projectId: string | number, domain: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PagesDomainSchema>>;
18
- edit(projectId: string | number, domain: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PagesDomainSchema>>;
19
- show(projectId: string | number, domain: string, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PagesDomainSchema>>;
20
- remove(projectId: string | number, domain: string, options?: Sudo): Promise<void>;
21
- }
@@ -1,10 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { PipelineVariableSchema } from './Pipelines';
3
- import { BaseRequestOptions, PaginatedRequestOptions } from '../infrastructure';
4
- export declare class PipelineScheduleVariables<C extends boolean = false> extends BaseResource<C> {
5
- all(projectId: string | number, pipelineScheduleId: number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>[]>;
6
- create(projectId: string | number, pipelineScheduleId: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>>;
7
- edit(projectId: string | number, pipelineScheduleId: number, keyId: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>>;
8
- show(projectId: string | number, pipelineScheduleId: number, keyId: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>>;
9
- remove(projectId: string | number, pipelineScheduleId: number, keyId: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>>;
10
- }
@@ -1,29 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { UserSchema } from './Users';
3
- import { PipelineSchema, PipelineVariableSchema } from './Pipelines';
4
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
5
- export interface PipelineScheduleSchema extends Record<string, unknown> {
6
- id: number;
7
- description: string;
8
- ref: string;
9
- cron: string;
10
- cron_timezone: string;
11
- next_run_at: string;
12
- active: boolean;
13
- created_at: string;
14
- updated_at: string;
15
- owner: Pick<UserSchema, 'name' | 'username' | 'id' | 'state' | 'avatar_url' | 'web_url'>;
16
- }
17
- export interface PipelineScheduleExtendedSchema extends PipelineScheduleSchema {
18
- last_pipeline: Pick<PipelineSchema, 'id' | 'sha' | 'ref' | 'status'>;
19
- }
20
- export declare class PipelineSchedules<C extends boolean = false> extends BaseResource<C> {
21
- all(projectId: string | number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleSchema>[]>;
22
- create(projectId: string | number, description: string, ref: string, cron: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleSchema & {
23
- variables?: PipelineVariableSchema[] | undefined;
24
- }>>;
25
- edit(projectId: string | number, scheduleId: number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleExtendedSchema>>;
26
- remove(projectId: string | number, scheduleId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleExtendedSchema>>;
27
- show(projectId: string | number, scheduleId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleExtendedSchema>>;
28
- takeOwnership(projectId: string | number, scheduleId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineScheduleExtendedSchema>>;
29
- }
@@ -1,40 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { UserSchema } from './Users';
3
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
4
- export declare type PipelineStatus = 'created' | 'waiting_for_resource' | 'preparing' | 'pending' | 'running' | 'failed' | 'success' | 'canceled' | 'skipped' | 'manual' | 'scheduled';
5
- export interface PipelineSchema extends Record<string, unknown> {
6
- id: number;
7
- status: PipelineStatus;
8
- ref: string;
9
- sha: string;
10
- web_url: string;
11
- created_at: string;
12
- updated_at: string;
13
- user: Pick<UserSchema, 'name' | 'avatar_url'>;
14
- }
15
- export interface PipelineExtendedSchema extends PipelineSchema {
16
- project_id: number;
17
- before_sha: string;
18
- tag: boolean;
19
- yaml_errors?: string;
20
- user: Pick<UserSchema, 'name' | 'username' | 'id' | 'state' | 'avatar_url' | 'web_url'>;
21
- started_at?: string;
22
- finished_at: string;
23
- committed_at?: string;
24
- duration?: string;
25
- coverage?: string;
26
- }
27
- export interface PipelineVariableSchema extends Record<string, unknown> {
28
- key: string;
29
- variable_type?: string;
30
- value: string;
31
- }
32
- export declare class Pipelines<C extends boolean = false> extends BaseResource<C> {
33
- all(projectId: string | number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineSchema>[]>;
34
- create(projectId: string | number, ref: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineSchema>>;
35
- delete(projectId: string | number, pipelineId: number, options?: Sudo): Promise<void>;
36
- show(projectId: string | number, pipelineId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineSchema>>;
37
- retry(projectId: string | number, pipelineId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineExtendedSchema>>;
38
- cancel(projectId: string | number, pipelineId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, PipelineExtendedSchema>>;
39
- allVariables(projectId: string | number, pipelineId: number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, PipelineVariableSchema>[]>;
40
- }
@@ -1,15 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ResourceAccessRequests } from '../templates';
3
- import { AccessRequestSchema, AccessLevel } from '../templates/types';
4
- import { Sudo, CamelizedRecord } from '../infrastructure';
5
- export interface ProjectAccessRequests<C extends boolean = false> extends ResourceAccessRequests<C> {
6
- all(projectId: string | number): Promise<CamelizedRecord<C, AccessRequestSchema>[]>;
7
- request(projectId: string | number): Promise<CamelizedRecord<C, AccessRequestSchema>>;
8
- approve(projectId: string | number, userId: number, options?: {
9
- accessLevel?: AccessLevel;
10
- } & Sudo): Promise<CamelizedRecord<C, AccessRequestSchema>>;
11
- deny(projectId: string | number, userId: number): Promise<void>;
12
- }
13
- export declare class ProjectAccessRequests<C extends boolean = false> extends ResourceAccessRequests<C> {
14
- constructor(options: BaseResourceOptions<C>);
15
- }
@@ -1,18 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ResourceBadges } from '../templates';
3
- import { BadgeSchema } from '../templates/types';
4
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
5
- export interface ProjectBadgeSchema extends BadgeSchema {
6
- kind: 'project';
7
- }
8
- export interface ProjectBadges<C extends boolean = false> extends ResourceBadges<C> {
9
- add(productId: string | number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, ProjectBadgeSchema>>;
10
- all(productId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, ProjectBadgeSchema>[]>;
11
- edit(productId: string | number, badgeId: number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, ProjectBadgeSchema>>;
12
- preview(productId: string | number, linkUrl: string, imageUrl: string, options?: Sudo): Promise<CamelizedRecord<C, Omit<ProjectBadgeSchema, 'id' | 'name' | 'kind'>>>;
13
- remove(productId: string | number, badgeId: number, options?: Sudo): Promise<void>;
14
- show(productId: string | number, badgeId: number, options?: Sudo): Promise<CamelizedRecord<C, ProjectBadgeSchema>>;
15
- }
16
- export declare class ProjectBadges<C extends boolean = false> extends ResourceBadges<C> {
17
- constructor(options: BaseResourceOptions<C>);
18
- }
@@ -1,13 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ResourceCustomAttributes } from '../templates';
3
- import { CustomAttributeSchema } from '../templates/types';
4
- import { PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
5
- export interface ProjectCustomAttributes<C extends boolean = false> extends ResourceCustomAttributes<C> {
6
- all(projectId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, CustomAttributeSchema>[]>;
7
- set(projectId: string | number, customAttributeId: number, value: string, options?: Sudo): Promise<CamelizedRecord<C, CustomAttributeSchema>>;
8
- remove(projectId: string | number, customAttributeId: number, options?: Sudo): Promise<void>;
9
- show(projectId: string | number, customAttributeId: number, options?: Sudo): Promise<CamelizedRecord<C, CustomAttributeSchema>>;
10
- }
11
- export declare class ProjectCustomAttributes<C extends boolean> extends ResourceCustomAttributes<C> {
12
- constructor(options: BaseResourceOptions<C>);
13
- }
@@ -1,14 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ResourceDeployTokens } from '../templates';
3
- import { DeployTokenScope, DeployTokenSchema } from '../templates/types';
4
- import { BaseRequestOptions, PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
5
- export interface ProjectDeployTokens<C extends boolean = false> extends ResourceDeployTokens<C> {
6
- add(projectId: string | number, tokenName: string, tokenScopes: DeployTokenScope[], options?: BaseRequestOptions): Promise<CamelizedRecord<C, DeployTokenSchema>>;
7
- all(options?: {
8
- projectId?: string | number;
9
- } & PaginatedRequestOptions): Promise<CamelizedRecord<C, DeployTokenSchema>[]>;
10
- remove(projectId: string | number, tokenId: number, options?: Sudo): Promise<void>;
11
- }
12
- export declare class ProjectDeployTokens<C extends boolean = false> extends ResourceDeployTokens<C> {
13
- constructor(options: BaseResourceOptions<C>);
14
- }
@@ -1,29 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo } from '../infrastructure';
3
- export interface ProjectHookSchema extends Record<string, unknown> {
4
- id: number;
5
- url: string;
6
- project_id: number;
7
- push_events: boolean;
8
- push_events_branch_filter: string;
9
- issues_events: boolean;
10
- confidential_issues_events: boolean;
11
- merge_requests_events: boolean;
12
- tag_push_events: boolean;
13
- note_events: boolean;
14
- confidential_note_events: boolean;
15
- job_events: boolean;
16
- pipeline_events: boolean;
17
- wiki_page_events: boolean;
18
- deployment_events: boolean;
19
- releases_events: boolean;
20
- enable_ssl_verification: boolean;
21
- created_at: string;
22
- }
23
- export declare class ProjectHooks<C extends boolean = false> extends BaseResource<C> {
24
- all(projectId: string | number, options?: PaginatedRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, ProjectHookSchema>[]>;
25
- show(projectId: string | number, hookId: number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, ProjectHookSchema>>;
26
- add(projectId: string | number, url: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, ProjectHookSchema>>;
27
- edit(projectId: string | number, hookId: number, url: string, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, ProjectHookSchema>>;
28
- remove(projectId: string | number, hookId: number, options?: Sudo): Promise<void>;
29
- }
@@ -1,54 +0,0 @@
1
- import { BaseResource } from '@gitbeaker/requester-utils';
2
- import { Sudo, BaseRequestOptions } from '../infrastructure';
3
- export interface ExportStatusSchema extends Record<string, unknown> {
4
- id: number;
5
- description: string;
6
- name: string;
7
- name_with_namespace: string;
8
- path: string;
9
- path_with_namespace: string;
10
- created_at: string;
11
- export_status: string;
12
- _links: {
13
- api_url: string;
14
- web_url: string;
15
- };
16
- }
17
- export interface FailedRelationSchema {
18
- id: number;
19
- created_at: string;
20
- exception_class: string;
21
- exception_message: string;
22
- source: string;
23
- relation_name: string;
24
- }
25
- export interface ImportStatusSchema extends Record<string, unknown> {
26
- id: number;
27
- description: string;
28
- name: string;
29
- name_with_namespace: string;
30
- path: string;
31
- path_with_namespace: string;
32
- created_at: string;
33
- import_status: string;
34
- correlation_id: string;
35
- failed_relations?: FailedRelationSchema[];
36
- }
37
- export interface UploadMetadata {
38
- filename?: string;
39
- contentType?: string;
40
- }
41
- export declare const defaultMetadata: {
42
- filename: string;
43
- };
44
- export declare class ProjectImportExport<C extends boolean = false> extends BaseResource<C> {
45
- download(projectId: string | number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, Record<string, unknown>>>;
46
- exportStatus(projectId: string | number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, ExportStatusSchema>>;
47
- import(content: string, path: string, { metadata, ...options }?: {
48
- metadata?: UploadMetadata;
49
- } & BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, ImportStatusSchema>>;
50
- importStatus(projectId: string | number, options?: Sudo): Promise<import("../infrastructure").CamelizedRecord<C, ImportStatusSchema>>;
51
- schedule(projectId: string | number, options?: BaseRequestOptions): Promise<import("../infrastructure").CamelizedRecord<C, {
52
- message: string;
53
- }>>;
54
- }
@@ -1,23 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ProjectSchema } from './Projects';
3
- import { ResourceIssueBoards } from '../templates';
4
- import { IssueBoardSchema, IssueBoardListSchema } from '../templates/types';
5
- import { BaseRequestOptions, PaginatedRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
6
- export interface ProjectIssueBoardSchema extends IssueBoardSchema {
7
- project: Pick<ProjectSchema, 'id' | 'name' | 'name_with_namespace' | 'path' | 'path_with_namespace' | 'http_url_to_repo' | 'web_url'>;
8
- }
9
- export interface ProjectIssueBoards<C extends boolean = false> extends ResourceIssueBoards<C> {
10
- all(groupId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, ProjectIssueBoardSchema>[]>;
11
- create(groupId: string | number, name: string, options?: Sudo): Promise<CamelizedRecord<C, ProjectIssueBoardSchema>>;
12
- createList(groupId: string | number, boardId: number, labelId: number | string, options?: Sudo): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
13
- edit(groupId: string | number, boardId: number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, ProjectIssueBoardSchema>>;
14
- editList(groupId: string | number, boardId: number, listId: number, position: number, options?: Sudo): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
15
- lists(groupId: string | number, boardId: number, options?: Sudo): Promise<CamelizedRecord<C, IssueBoardListSchema>[]>;
16
- remove(groupId: string | number, boardId: number, options?: Sudo): Promise<void>;
17
- removeList(groupId: string | number, boardId: number, listId: number, options?: Sudo): Promise<void>;
18
- show(groupId: string | number, boardId: number, options?: Sudo): Promise<CamelizedRecord<C, ProjectIssueBoardSchema>>;
19
- showList(groupId: string | number, boardId: number, listId: number, options?: Sudo): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
20
- }
21
- export declare class ProjectIssueBoards<C extends boolean = false> extends ResourceIssueBoards<C> {
22
- constructor(options: BaseResourceOptions<C>);
23
- }
@@ -1,14 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { ResourceMembers } from '../templates';
3
- import { MemberSchema, IncludeInherited, AccessLevel } from '../templates/types';
4
- import { BaseRequestOptions, PaginatedRequestOptions, CamelizedRecord, Sudo } from '../infrastructure';
5
- export interface ProjectMembers<C extends boolean = false> extends ResourceMembers<C> {
6
- add(projectId: string | number, userId: number, accessLevel: AccessLevel, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MemberSchema>>;
7
- all(projectId: string | number, options?: IncludeInherited & PaginatedRequestOptions): Promise<CamelizedRecord<C, MemberSchema>[]>;
8
- edit(projectId: string | number, userId: number, accessLevel: AccessLevel, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MemberSchema>>;
9
- show(projectId: string | number, userId: number, options?: IncludeInherited & Sudo): Promise<CamelizedRecord<C, MemberSchema>>;
10
- remove(projectId: string | number, userId: number, options?: Sudo): Promise<void>;
11
- }
12
- export declare class ProjectMembers<C extends boolean = false> extends ResourceMembers<C> {
13
- constructor(options: BaseResourceOptions<C>);
14
- }
@@ -1,17 +0,0 @@
1
- import { BaseResourceOptions } from '@gitbeaker/requester-utils';
2
- import { IssueSchema } from './Issues';
3
- import { MergeRequestSchema } from './MergeRequests';
4
- import { ResourceMilestones } from '../templates';
5
- import { MilestoneSchema } from '../templates/types';
6
- import { PaginatedRequestOptions, BaseRequestOptions, Sudo, CamelizedRecord } from '../infrastructure';
7
- export interface ProjectMilestones<C extends boolean = false> extends ResourceMilestones<C> {
8
- all(projectId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>[]>;
9
- create(projectId: string | number, title: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>>;
10
- edit(projectId: string | number, milestoneId: number, options?: BaseRequestOptions): Promise<CamelizedRecord<C, MilestoneSchema>>;
11
- issues(projectId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, IssueSchema>[]>;
12
- mergeRequests(projectId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, MergeRequestSchema>[]>;
13
- show(projectId: string | number, milestoneId: number, options?: Sudo): Promise<CamelizedRecord<C, MilestoneSchema>>;
14
- }
15
- export declare class ProjectMilestones<C extends boolean = false> extends ResourceMilestones<C> {
16
- constructor(options: BaseResourceOptions<C>);
17
- }
@@ -1,13 +0,0 @@
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 ProjectSnippetAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
6
- all(projectId: string | number, snippetIId: number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, AwardEmojiSchema>[]>;
7
- award(projectId: string | number, snippetIId: number, name: string, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
8
- remove(projectId: string | number, snippetIId: number, awardId: number, options?: Sudo): Promise<void>;
9
- show(projectId: string | number, snippetIId: number, awardId: number, options?: Sudo): Promise<CamelizedRecord<C, AwardEmojiSchema>>;
10
- }
11
- export declare class ProjectSnippetAwardEmojis<C extends boolean = false> extends ResourceAwardEmojis<C> {
12
- constructor(options: BaseResourceOptions<C>);
13
- }
@@ -1,17 +0,0 @@
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 ProjectSnippetDiscussions<C extends boolean = false> extends ResourceDiscussions<C> {
6
- addNote(projectId: string | number, snippetId: string | number, discussionId: string | number, noteId: number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>>;
7
- all(projectId: string | number, issueId: string | number, options?: PaginatedRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>[]>;
8
- create(projectId: string | number, snippetId: string | number, body: string, options?: BaseRequestOptions): Promise<CamelizedRecord<C, DiscussionSchema>>;
9
- editNote(projectId: string | number, snippetId: string | number, discussionId: string | number, noteId: number, options: BaseRequestOptions & {
10
- body: string;
11
- }): Promise<CamelizedRecord<C, DiscussionSchema>>;
12
- removeNote(projectId: string | number, snippetId: string | number, discussionId: string | number, noteId: number, options?: Sudo): Promise<void>;
13
- show(projectId: string | number, snippetId: string | number, discussionId: string | number, options?: Sudo): Promise<CamelizedRecord<C, DiscussionSchema>>;
14
- }
15
- export declare class ProjectSnippetDiscussions<C extends boolean = false> extends ResourceDiscussions<C> {
16
- constructor(options: BaseResourceOptions<C>);
17
- }