jdalrymple/gitbeaker

View on GitHub
packages/core/src/resources/ResourceGroups.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type {
  GitlabAPIResponse,
  PaginationRequestOptions,
  PaginationTypes,
  ShowExpanded,
  Sudo,
} from '../infrastructure';
import type { JobSchema } from './Jobs';

export interface ResourceGroupSchema extends Record<string, unknown> {
  id: number;
  key: string;
  process_mode: string;
  created_at: string;
  updated_at: string;
}

export class ResourceGroups<C extends boolean = false> extends BaseResource<C> {
  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    projectId: string | number,
    options?: Sudo & ShowExpanded<E> & PaginationRequestOptions<P>,
  ): Promise<GitlabAPIResponse<ResourceGroupSchema[], C, E, P>> {
    return RequestHelper.get<ResourceGroupSchema[]>()(
      this,
      endpoint`projects/${projectId}/resource_groups`,
      options,
    );
  }

  edit<E extends boolean = false>(
    projectId: string | number,
    key: string,
    options?: { processMode?: string } & Sudo & ShowExpanded<E>,
  ) {
    return RequestHelper.put<ResourceGroupSchema>()(
      this,
      endpoint`projects/${projectId}/resource_groups/${key}`,
      options,
    );
  }

  show<E extends boolean = false>(
    projectId: string | number,
    key: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ResourceGroupSchema, C, E, void>> {
    return RequestHelper.get<ResourceGroupSchema>()(
      this,
      endpoint`projects/${projectId}/resource_groups/${key}`,
      options,
    );
  }

  allUpcomingJobs<E extends boolean = false>(
    projectId: string | number,
    key: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<JobSchema[], C, E, void>> {
    return RequestHelper.get<JobSchema[]>()(
      this,
      endpoint`projects/${projectId}/resource_groups/${key}/upcoming_jobs`,
      options,
    );
  }
}