@gitbeaker/rest 39.17.0 → 39.19.0

package/README.md

@@ -74,17 +74,19 @@
 - [Features](#features)
 - [Usage](#usage)
 - [API Client](#api-client)
+  - [Expanded Payloads](#expanded-payloads)
   - [Pagination](#pagination)
+  - [Rate Limits](#rate-limits)
   - [Error Handling](#error-handling)
 - [Examples](#examples)
 - [Testing](../../docs/TESTING.md)
-- [FAQ](../../FAQ.md)
+- [FAQ](../../docs/FAQ.md)
 - [Contributors](#contributors)
 - [Changelog](./CHANGELOG.md)
 
 ## Features
 
-- **Complete** - All features of Gitlab's exposed APIs are covered up to version [16.0](https://docs.gitlab.com/16.0/ee/api/api_resources.html).
+- **Complete** - All features of Gitlab's exposed APIs are covered up to version [16.0](https://docs.gitlab.com/16.0/ee/api/api_resources.html). See [here](./packages/core/README.md#supported-apis) for the full list.
 - **Universal** - Works in all modern browsers, [Node.js](https://nodejs.org/), and [Deno](https://deno.land/).
 - **Tested** - All libraries have > 80% test coverage.
 - **Typed** - All libraries have extensive TypeScript declarations.
@@ -154,9 +156,37 @@ Available instantiating options:
 | `queryTimeout`       | Yes      | `300000`                                                                                                                                | Query Timeout in ms                                                                                                |
 | `profileToken`       | Yes      | N/A                                                                                                                                     | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
 | `profileMode`        | Yes      | `execution`                                                                                                                             | [Requests Profiles Token](https://docs.gitlab.com/ee/administration/monitoring/performance/request_profiling.html) |
+| `rateLimits`         | No       | [DEFAULT_RATE_LIMITS](#rate-limits)                                                                                                     | Global and endpoint specific adjustable rate limits                                                                |
 
 > \*One of these options must be supplied.
 
+### Expanded Payloads
+
+For simplicity, only the response body is returned from the API methods. However, seeing additional response fields, such as the status, headers, etc., may be helpful. For this purpose, an additional optional parameter, `showExpanded` can be passed for most API methods.
+
+For methods that return non-paginated results, the payload has this structure:
+
+```ts
+type ResponseBodyTypes =
+  | Record<string, unknown>
+  | Record<string, unknown>[]
+  | ReadableStream
+  | Blob
+  | string
+  | string[]
+  | number
+  | void
+  | null;
+
+interface FormattedResponse<T extends ResponseBodyTypes = ResponseBodyTypes> {
+  body: T;
+  headers: Record<string, string>;
+  status: number;
+}
+```
+
+For methods that return paginated results, the payload also includes paginated information outlined in the [Pagination documentation](#pagination)
+
 ### Pagination
 
 Available pagination options:
@@ -239,6 +269,72 @@ const { data } = await api.Projects.all({
 });
 ```
 
+### Rate Limits
+
+Rate limits are completely customizable, and are used to limit the request rate between consecutive API requests within the library. By default, all non-specified endpoints use a 3000 rps rate limit, while some endpoints have much smaller rates as dictated by the [Gitlab Docs](https://docs.gitlab.com/ee/security/rate_limits.html). See below for the default values:
+
+```js
+const DEFAULT_RATE_LIMITS = Object.freeze({
+  // Default rate limit
+  '**': 3000,
+
+  // Import/Export
+  'projects/import': 6,
+  'projects/*/export': 6,
+  'projects/*/download': 1,
+  'groups/import': 6,
+  'groups/*/export': 6,
+  'groups/*/download': 1,
+
+  // Note creation
+  'projects/*/issues/*/notes': {
+    method: 'post',
+    limit: 300,
+  },
+  'projects/*/snippets/*/notes': {
+    method: 'post',
+    limit: 300,
+  },
+  'projects/*/merge_requests/*/notes': {
+    method: 'post',
+    limit: 300,
+  },
+  'groups/*/epics/*/notes': {
+    method: 'post',
+    limit: 300,
+  },
+
+  // Repositories - get file archive
+  'projects/*/repository/archive*': 5,
+
+  // Project Jobs
+  'projects/*/jobs': 600,
+
+  // Member deletion
+  'projects/*/members': 60,
+  'groups/*/members': 60,
+});
+```
+
+Rate limits can be overridden when instantiating a API wrapper. For ease of use, these limits are configured using glob patterns, and can be formatted in two ways.
+
+1. The glob for the endpoint with the corresponding rate per second
+2. The glob for the endpoint, with an object specifying the specific method for the endpoint and the corresponding rate limit
+
+```js
+const api = new Gitlab({
+  token: 'token',
+  rateLimits: {
+    '**': 30,
+    'projects/import/*': 40,
+    'projects/*/issues/*/notes': {
+      method: 'post',
+      limit: 300,
+    },
+  },
+});
+```
+
 ### Error Handling
 
 Request errors are returned back within a plain Error instance, using the cause to hold the original response and a text description of the error pulled from the response's error or message fields if JSON, or its plain text value:
@@ -410,6 +506,7 @@ projectsAPI.create({
       <td align="center" valign="top" width="3.84%"><a href="https://github.com/demedos"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/16702156?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Alessandro Diez"/></td>
       <td align="center" valign="top" width="3.84%"><a href="https://github.com/artlist-scottambrose"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/124692101?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="artlist-scottambrose"/></td>
       <td align="center" valign="top" width="3.84%"><a href="https://github.com/mercutiodesign"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/1114120?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Martin Dreher"/></td>
+      <td align="center" valign="top" width="3.84%"><a href="https://github.com/glensc"><img src="https://images.weserv.nl/?url=https://avatars.githubusercontent.com/u/199095?v=4&h=25&w=25&fit=cover&mask=circle&maxage=7d" alt="Elan Ruusamäe"/></td>
     </tr>
 </p>
 

package/dist/index.d.mts

@@ -11,6 +11,7 @@ declare const ApplicationStatistics: typeof Resources.ApplicationStatistics;
 declare const AuditEvents: typeof Resources.AuditEvents;
 declare const Avatar: typeof Resources.Avatar;
 declare const BroadcastMessages: typeof Resources.BroadcastMessages;
+declare const CodeSuggestions: typeof Resources.CodeSuggestions;
 declare const Composer: typeof Resources.Composer;
 declare const Conan: typeof Resources.Conan;
 declare const DashboardAnnotations: typeof Resources.DashboardAnnotations;
@@ -22,6 +23,7 @@ declare const DockerfileTemplates: typeof Resources.DockerfileTemplates;
 declare const Events: typeof Resources.Events;
 declare const Experiments: typeof Resources.Experiments;
 declare const GeoNodes: typeof Resources.GeoNodes;
+declare const GeoSites: typeof Resources.GeoSites;
 declare const GitignoreTemplates: typeof Resources.GitignoreTemplates;
 declare const GitLabCIYMLTemplates: typeof Resources.GitLabCIYMLTemplates;
 declare const Import: typeof Resources.Import;
@@ -42,6 +44,7 @@ declare const PersonalAccessTokens: typeof Resources.PersonalAccessTokens;
 declare const PyPI: typeof Resources.PyPI;
 declare const RubyGems: typeof Resources.RubyGems;
 declare const Search: typeof Resources.Search;
+declare const SearchAdmin: typeof Resources.SearchAdmin;
 declare const ServiceData: typeof Resources.ServiceData;
 declare const SidekiqMetrics: typeof Resources.SidekiqMetrics;
 declare const SidekiqQueues: typeof Resources.SidekiqQueues;
@@ -154,6 +157,7 @@ declare const GroupActivityAnalytics: typeof Resources.GroupActivityAnalytics;
 declare const GroupBadges: typeof Resources.GroupBadges;
 declare const GroupCustomAttributes: typeof Resources.GroupCustomAttributes;
 declare const GroupDORA4Metrics: typeof Resources.GroupDORA4Metrics;
+declare const GroupEpicBoards: typeof Resources.GroupEpicBoards;
 declare const GroupHooks: typeof Resources.GroupHooks;
 declare const GroupImportExports: typeof Resources.GroupImportExports;
 declare const GroupInvitations: typeof Resources.GroupInvitations;
@@ -171,6 +175,7 @@ declare const GroupReleases: typeof Resources.GroupReleases;
 declare const GroupRepositoryStorageMoves: typeof Resources.GroupRepositoryStorageMoves;
 declare const Groups: typeof Resources.Groups;
 declare const GroupSAMLIdentities: typeof Resources.GroupSAMLIdentities;
+declare const GroupSAMLLinks: typeof Resources.GroupSAMLLinks;
 declare const GroupSCIMIdentities: typeof Resources.GroupSCIMIdentities;
 declare const GroupVariables: typeof Resources.GroupVariables;
 declare const GroupWikis: typeof Resources.GroupWikis;
@@ -183,4 +188,4 @@ declare const Users: typeof Resources.Users;
 declare const UserSSHKeys: typeof Resources.UserSSHKeys;
 declare const Gitlab: typeof Resources.Gitlab;
 
-export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };
+export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CodeSuggestions, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GeoSites, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupEpicBoards, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSAMLLinks, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SearchAdmin, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };

package/dist/index.d.ts

@@ -11,6 +11,7 @@ declare const ApplicationStatistics: typeof Resources.ApplicationStatistics;
 declare const AuditEvents: typeof Resources.AuditEvents;
 declare const Avatar: typeof Resources.Avatar;
 declare const BroadcastMessages: typeof Resources.BroadcastMessages;
+declare const CodeSuggestions: typeof Resources.CodeSuggestions;
 declare const Composer: typeof Resources.Composer;
 declare const Conan: typeof Resources.Conan;
 declare const DashboardAnnotations: typeof Resources.DashboardAnnotations;
@@ -22,6 +23,7 @@ declare const DockerfileTemplates: typeof Resources.DockerfileTemplates;
 declare const Events: typeof Resources.Events;
 declare const Experiments: typeof Resources.Experiments;
 declare const GeoNodes: typeof Resources.GeoNodes;
+declare const GeoSites: typeof Resources.GeoSites;
 declare const GitignoreTemplates: typeof Resources.GitignoreTemplates;
 declare const GitLabCIYMLTemplates: typeof Resources.GitLabCIYMLTemplates;
 declare const Import: typeof Resources.Import;
@@ -42,6 +44,7 @@ declare const PersonalAccessTokens: typeof Resources.PersonalAccessTokens;
 declare const PyPI: typeof Resources.PyPI;
 declare const RubyGems: typeof Resources.RubyGems;
 declare const Search: typeof Resources.Search;
+declare const SearchAdmin: typeof Resources.SearchAdmin;
 declare const ServiceData: typeof Resources.ServiceData;
 declare const SidekiqMetrics: typeof Resources.SidekiqMetrics;
 declare const SidekiqQueues: typeof Resources.SidekiqQueues;
@@ -154,6 +157,7 @@ declare const GroupActivityAnalytics: typeof Resources.GroupActivityAnalytics;
 declare const GroupBadges: typeof Resources.GroupBadges;
 declare const GroupCustomAttributes: typeof Resources.GroupCustomAttributes;
 declare const GroupDORA4Metrics: typeof Resources.GroupDORA4Metrics;
+declare const GroupEpicBoards: typeof Resources.GroupEpicBoards;
 declare const GroupHooks: typeof Resources.GroupHooks;
 declare const GroupImportExports: typeof Resources.GroupImportExports;
 declare const GroupInvitations: typeof Resources.GroupInvitations;
@@ -171,6 +175,7 @@ declare const GroupReleases: typeof Resources.GroupReleases;
 declare const GroupRepositoryStorageMoves: typeof Resources.GroupRepositoryStorageMoves;
 declare const Groups: typeof Resources.Groups;
 declare const GroupSAMLIdentities: typeof Resources.GroupSAMLIdentities;
+declare const GroupSAMLLinks: typeof Resources.GroupSAMLLinks;
 declare const GroupSCIMIdentities: typeof Resources.GroupSCIMIdentities;
 declare const GroupVariables: typeof Resources.GroupVariables;
 declare const GroupWikis: typeof Resources.GroupWikis;
@@ -183,4 +188,4 @@ declare const Users: typeof Resources.Users;
 declare const UserSSHKeys: typeof Resources.UserSSHKeys;
 declare const Gitlab: typeof Resources.Gitlab;
 
-export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };
+export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CodeSuggestions, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GeoSites, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupEpicBoards, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSAMLLinks, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SearchAdmin, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };

package/dist/index.js

@@ -88,7 +88,8 @@ function getConditionalMode(endpoint) {
 async function defaultRequestHandler(endpoint, options) {
   const retryCodes = [429, 502];
   const maxRetries = 10;
-  const { prefixUrl, asStream, searchParams, ...opts } = options || {};
+  const { prefixUrl, asStream, searchParams, rateLimiters, method, ...opts } = options || {};
+  const endpointRateLimit = requesterUtils.getMatchingRateLimiter(endpoint, rateLimiters, method);
   let baseUrl;
   if (prefixUrl)
     baseUrl = prefixUrl.endsWith("/") ? prefixUrl : `${prefixUrl}/`;
@@ -96,7 +97,8 @@ async function defaultRequestHandler(endpoint, options) {
   url.search = searchParams || "";
   const mode = getConditionalMode(endpoint);
   for (let i = 0; i < maxRetries; i += 1) {
-    const request = new Request(url, { ...opts, mode });
+    const request = new Request(url, { ...opts, method, mode });
+    await endpointRateLimit();
     const response = await fetch(request).catch((e) => {
       if (e.name === "TimeoutError" || e.name === "AbortError") {
         throw new Error("Query timeout was reached");
@@ -129,6 +131,7 @@ var {
   AuditEvents,
   Avatar,
   BroadcastMessages,
+  CodeSuggestions,
   Composer,
   Conan,
   DashboardAnnotations,
@@ -140,6 +143,7 @@ var {
   Events,
   Experiments,
   GeoNodes,
+  GeoSites,
   GitignoreTemplates,
   GitLabCIYMLTemplates,
   Import,
@@ -160,6 +164,7 @@ var {
   PyPI,
   RubyGems,
   Search,
+  SearchAdmin,
   ServiceData,
   SidekiqMetrics,
   SidekiqQueues,
@@ -272,6 +277,7 @@ var {
   GroupBadges,
   GroupCustomAttributes,
   GroupDORA4Metrics,
+  GroupEpicBoards,
   GroupHooks,
   GroupImportExports,
   GroupInvitations,
@@ -289,6 +295,7 @@ var {
   GroupRepositoryStorageMoves,
   Groups,
   GroupSAMLIdentities,
+  GroupSAMLLinks,
   GroupSCIMIdentities,
   GroupVariables,
   GroupWikis,
@@ -313,6 +320,7 @@ exports.AuditEvents = AuditEvents;
 exports.Avatar = Avatar;
 exports.Branches = Branches;
 exports.BroadcastMessages = BroadcastMessages;
+exports.CodeSuggestions = CodeSuggestions;
 exports.CommitDiscussions = CommitDiscussions;
 exports.Commits = Commits;
 exports.Composer = Composer;
@@ -342,6 +350,7 @@ exports.FeatureFlagUserLists = FeatureFlagUserLists;
 exports.FeatureFlags = FeatureFlags;
 exports.FreezePeriods = FreezePeriods;
 exports.GeoNodes = GeoNodes;
+exports.GeoSites = GeoSites;
 exports.GitLabCIYMLTemplates = GitLabCIYMLTemplates;
 exports.GitignoreTemplates = GitignoreTemplates;
 exports.Gitlab = Gitlab;
@@ -353,6 +362,7 @@ exports.GroupActivityAnalytics = GroupActivityAnalytics;
 exports.GroupBadges = GroupBadges;
 exports.GroupCustomAttributes = GroupCustomAttributes;
 exports.GroupDORA4Metrics = GroupDORA4Metrics;
+exports.GroupEpicBoards = GroupEpicBoards;
 exports.GroupHooks = GroupHooks;
 exports.GroupImportExports = GroupImportExports;
 exports.GroupInvitations = GroupInvitations;
@@ -369,6 +379,7 @@ exports.GroupRelationExports = GroupRelationExports;
 exports.GroupReleases = GroupReleases;
 exports.GroupRepositoryStorageMoves = GroupRepositoryStorageMoves;
 exports.GroupSAMLIdentities = GroupSAMLIdentities;
+exports.GroupSAMLLinks = GroupSAMLLinks;
 exports.GroupSCIMIdentities = GroupSCIMIdentities;
 exports.GroupVariables = GroupVariables;
 exports.GroupWikis = GroupWikis;
@@ -465,6 +476,7 @@ exports.ResourceGroups = ResourceGroups;
 exports.RubyGems = RubyGems;
 exports.Runners = Runners;
 exports.Search = Search;
+exports.SearchAdmin = SearchAdmin;
 exports.SecureFiles = SecureFiles;
 exports.ServiceData = ServiceData;
 exports.SidekiqMetrics = SidekiqMetrics;

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import * as Resources from '@gitbeaker/core';
-import { createRequesterFn, presetResourceArguments } from '@gitbeaker/requester-utils';
+import { createRequesterFn, presetResourceArguments, getMatchingRateLimiter } from '@gitbeaker/requester-utils';
 
 // src/index.ts
 async function defaultOptionsHandler(resourceOptions, requestOptions) {
@@ -66,7 +66,8 @@ function getConditionalMode(endpoint) {
 async function defaultRequestHandler(endpoint, options) {
   const retryCodes = [429, 502];
   const maxRetries = 10;
-  const { prefixUrl, asStream, searchParams, ...opts } = options || {};
+  const { prefixUrl, asStream, searchParams, rateLimiters, method, ...opts } = options || {};
+  const endpointRateLimit = getMatchingRateLimiter(endpoint, rateLimiters, method);
   let baseUrl;
   if (prefixUrl)
     baseUrl = prefixUrl.endsWith("/") ? prefixUrl : `${prefixUrl}/`;
@@ -74,7 +75,8 @@ async function defaultRequestHandler(endpoint, options) {
   url.search = searchParams || "";
   const mode = getConditionalMode(endpoint);
   for (let i = 0; i < maxRetries; i += 1) {
-    const request = new Request(url, { ...opts, mode });
+    const request = new Request(url, { ...opts, method, mode });
+    await endpointRateLimit();
     const response = await fetch(request).catch((e) => {
       if (e.name === "TimeoutError" || e.name === "AbortError") {
         throw new Error("Query timeout was reached");
@@ -107,6 +109,7 @@ var {
   AuditEvents,
   Avatar,
   BroadcastMessages,
+  CodeSuggestions,
   Composer,
   Conan,
   DashboardAnnotations,
@@ -118,6 +121,7 @@ var {
   Events,
   Experiments,
   GeoNodes,
+  GeoSites,
   GitignoreTemplates,
   GitLabCIYMLTemplates,
   Import,
@@ -138,6 +142,7 @@ var {
   PyPI,
   RubyGems,
   Search,
+  SearchAdmin,
   ServiceData,
   SidekiqMetrics,
   SidekiqQueues,
@@ -250,6 +255,7 @@ var {
   GroupBadges,
   GroupCustomAttributes,
   GroupDORA4Metrics,
+  GroupEpicBoards,
   GroupHooks,
   GroupImportExports,
   GroupInvitations,
@@ -267,6 +273,7 @@ var {
   GroupRepositoryStorageMoves,
   Groups,
   GroupSAMLIdentities,
+  GroupSAMLLinks,
   GroupSCIMIdentities,
   GroupVariables,
   GroupWikis,
@@ -280,4 +287,4 @@ var {
   Gitlab
 } = API;
 
-export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };
+export { Agents, AlertManagement, ApplicationAppearance, ApplicationPlanLimits, ApplicationSettings, ApplicationStatistics, Applications, AuditEvents, Avatar, Branches, BroadcastMessages, CodeSuggestions, CommitDiscussions, Commits, Composer, Conan, ContainerRegistry, DashboardAnnotations, Debian, DependencyProxy, DeployKeys, DeployTokens, Deployments, DockerfileTemplates, Environments, EpicAwardEmojis, EpicDiscussions, EpicIssues, EpicLabelEvents, EpicLinks, EpicNotes, Epics, ErrorTrackingClientKeys, ErrorTrackingSettings, Events, Experiments, ExternalStatusChecks, FeatureFlagUserLists, FeatureFlags, FreezePeriods, GeoNodes, GeoSites, GitLabCIYMLTemplates, GitignoreTemplates, Gitlab, GitlabPages, GoProxy, GroupAccessRequests, GroupAccessTokens, GroupActivityAnalytics, GroupBadges, GroupCustomAttributes, GroupDORA4Metrics, GroupEpicBoards, GroupHooks, GroupImportExports, GroupInvitations, GroupIssueBoards, GroupIterations, GroupLDAPLinks, GroupLabels, GroupMemberRoles, GroupMembers, GroupMilestones, GroupProtectedEnvironments, GroupPushRules, GroupRelationExports, GroupReleases, GroupRepositoryStorageMoves, GroupSAMLIdentities, GroupSAMLLinks, GroupSCIMIdentities, GroupVariables, GroupWikis, Groups, Helm, Import, InstanceLevelCICDVariables, Integrations, IssueAwardEmojis, IssueDiscussions, IssueIterationEvents, IssueLabelEvents, IssueLinks, IssueMilestoneEvents, IssueNoteAwardEmojis, IssueNotes, IssueStateEvents, IssueWeightEvents, Issues, IssuesStatistics, JobArtifacts, Jobs, Keys, License, LicenseTemplates, LinkedEpics, Lint, Markdown, Maven, MergeRequestApprovals, MergeRequestAwardEmojis, MergeRequestContextCommits, MergeRequestDiscussions, MergeRequestDraftNotes, MergeRequestLabelEvents, MergeRequestMilestoneEvents, MergeRequestNoteAwardEmojis, MergeRequestNotes, MergeRequests, MergeTrains, Metadata, Migrations, NPM, Namespaces, NotificationSettings, NuGet, PackageRegistry, Packages, PagesDomains, PersonalAccessTokens, PipelineScheduleVariables, PipelineSchedules, PipelineTriggerTokens, Pipelines, ProductAnalytics, ProjectAccessRequests, ProjectAccessTokens, ProjectAliases, ProjectBadges, ProjectCustomAttributes, ProjectDORA4Metrics, ProjectHooks, ProjectImportExports, ProjectInvitations, ProjectIssueBoards, ProjectIterations, ProjectLabels, ProjectMembers, ProjectMilestones, ProjectProtectedEnvironments, ProjectPushRules, ProjectRelationsExport, ProjectReleases, ProjectRemoteMirrors, ProjectRepositoryStorageMoves, ProjectSnippetAwardEmojis, ProjectSnippetDiscussions, ProjectSnippetNotes, ProjectSnippets, ProjectStatistics, ProjectTemplates, ProjectVariables, ProjectVulnerabilities, ProjectWikis, Projects, ProtectedBranches, ProtectedTags, PyPI, ReleaseLinks, Repositories, RepositoryFiles, RepositorySubmodules, ResourceGroups, RubyGems, Runners, Search, SearchAdmin, SecureFiles, ServiceData, SidekiqMetrics, SidekiqQueues, SnippetRepositoryStorageMoves, Snippets, Suggestions, SystemHooks, Tags, TodoLists, Topics, UserCustomAttributes, UserEmails, UserGPGKeys, UserImpersonationTokens, UserSSHKeys, UserStarredMetricsDashboard, Users };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gitbeaker/rest",
-  "version": "39.17.0",
+  "version": "39.19.0",
   "description": "Cross Platform implementation of the GitLab API",
   "license": "MIT",
   "engines": {
@@ -40,7 +40,7 @@
     "test:types": "tsc",
     "test:e2e:browser": "playwright test",
     "test:e2e": "yarn test:e2e:browser",
-    "test:integration:nodejs": "jest --maxWorkers=50% test/integration/nodejs",
+    "test:integration:nodejs": "jest --maxWorkers=50% test/integration/nodejs/resources/Issues.ts",
     "test:integration": "yarn test:integration:nodejs",
     "test:unit": "jest --maxWorkers=50% test/unit",
     "format:docs": "prettier '**/(*.json|.yml|.js|.md)' --ignore-path ../../.prettierignore",
@@ -56,8 +56,8 @@
     "release": "auto shipit"
   },
   "dependencies": {
-    "@gitbeaker/core": "^39.17.0",
-    "@gitbeaker/requester-utils": "^39.17.0"
+    "@gitbeaker/core": "^39.19.0",
+    "@gitbeaker/requester-utils": "^39.19.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.35.1",
@@ -65,5 +65,5 @@
     "tsup": "^7.1.0",
     "typescript": "^5.1.6"
   },
-  "gitHead": "604085015c962cdcbe542b96d717d64d2051ca3c"
+  "gitHead": "b6ac7ead7ee50ced0f99f66ea0c212d2afcba3c2"
 }