packages/core/src/resources/UserCustomAttributes.ts
import type { BaseResourceOptions } from '@gitbeaker/requester-utils';
import { ResourceCustomAttributes } from '../templates';
import type { CustomAttributeSchema } from '../templates/ResourceCustomAttributes';
import type {
GitlabAPIResponse,
PaginationRequestOptions,
PaginationTypes,
ShowExpanded,
Sudo,
} from '../infrastructure';
export interface UserCustomAttributes<C extends boolean = false>
extends ResourceCustomAttributes<C> {
all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
userId: string | number,
options?: PaginationRequestOptions<P> & Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<CustomAttributeSchema[], C, E, P>>;
remove<E extends boolean = false>(
userId: string | number,
customAttributeId: string,
options?: Sudo,
): Promise<GitlabAPIResponse<void, C, E, void>>;
set<E extends boolean = false>(
userId: string | number,
customAttributeId: string,
value: string,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<CustomAttributeSchema, C, E, void>>;
show<E extends boolean = false>(
userId: string | number,
customAttributeId: string,
options?: Sudo & ShowExpanded<E>,
): Promise<GitlabAPIResponse<CustomAttributeSchema, C, E, void>>;
}
export class UserCustomAttributes<C extends boolean = false> extends ResourceCustomAttributes<C> {
constructor(options: BaseResourceOptions<C>) {
/* istanbul ignore next */
super('users', options);
}
}