packages/core/src/resources/ProjectBadges.ts
import type { BaseResourceOptions } from '@gitbeaker/requester-utils';
import { ResourceBadges } from '../templates';
import type {
BadgeSchema,
CondensedBadgeSchema,
EditBadgeOptions,
} from '../templates/ResourceBadges';
import type {
GitlabAPIResponse,
PaginationRequestOptions,
PaginationTypes,
ShowExpanded,
Sudo,
} from '../infrastructure';
export interface ProjectBadgeSchema extends BadgeSchema {
kind: 'project';
}
export interface ProjectBadges<C extends boolean = false> extends ResourceBadges<C> {
add<E extends boolean = false>(
groupId: string | number,
linkUrl: string,
imageUrl: string,
options?: { name?: string } & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ProjectBadgeSchema, C, E, void>>;
all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
groupId: string | number,
options?: { name?: string } & PaginationRequestOptions<P> & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ProjectBadgeSchema[], C, E, P>>;
edit<E extends boolean = false>(
groupId: string | number,
badgeId: number,
options?: EditBadgeOptions & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ProjectBadgeSchema, C, E, void>>;
preview<E extends boolean = false>(
groupId: string | number,
linkUrl: string,
imageUrl: string,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<CondensedBadgeSchema, C, E, void>>;
remove<E extends boolean = false>(
groupId: string | number,
badgeId: number,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<void, C, E, void>>;
show<E extends boolean = false>(
groupId: string | number,
badgeId: number,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<ProjectBadgeSchema, C, E, void>>;
}
export class ProjectBadges<C extends boolean = false> extends ResourceBadges<C> {
constructor(options: BaseResourceOptions<C>) {
/* istanbul ignore next */
super('projects', options);
}
}