jdalrymple/gitbeaker

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

Summary

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

export interface ProjectAliasSchema extends Record<string, unknown> {
  id: number;
  project_id: string | number;
  name: string;
}

export class ProjectAliases<C extends boolean = false> extends BaseResource<C> {
  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    options?: Sudo & ShowExpanded<E> & PaginationRequestOptions<P>,
  ): Promise<GitlabAPIResponse<ProjectAliasSchema[], C, E, P>> {
    return RequestHelper.get<ProjectAliasSchema[]>()(this, 'project_aliases', options);
  }

  create<E extends boolean = false>(
    projectId: string | number,
    name: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectAliasSchema, C, E, void>> {
    return RequestHelper.post<ProjectAliasSchema>()(this, 'project_aliases', {
      name,
      projectId,
      ...options,
    });
  }

  edit<E extends boolean = false>(
    name: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<ProjectAliasSchema, C, E, void>> {
    return RequestHelper.post<ProjectAliasSchema>()(this, `project_aliases/${name}`, options);
  }

  remove<E extends boolean = false>(
    name: string,
    options?: Sudo & ShowExpanded<E>,
  ): Promise<GitlabAPIResponse<void, C, E, void>> {
    return RequestHelper.del()(this, `project_aliases/${name}`, options);
  }
}