Justin Dalrymple 502d8180a7
Update service typing and peripheral endpoints (#1768)
* Dependency and Configuration updates
* CHANGELOG and README updates
* Added support for camel case and snake case response types in the request helper and base service
* Added support for the Dockerfile Templates API
* Added support for the Issue Note Award Emojis API
* Removed redundant Group Projects service
* Updated types for a variety of services
* Added type updates and removed protect and unprotect endpoints from the Branches API 
* Added type updates and signature endpoint to the Commits API
* Added type updates and edit support to the Deployments API
* Added type updates and a showRepository function to the Container Registry API
* Added type updates and updated the service support to include create, edit, show and remove for the Feature Flags API
* Added type updates and support for the removal of geonodes with the Geo Nodes API
* Renamed UserKeys to UserSSHKeys and added type updates for the User SSH Keys API
* Added type updates for the License Templates API and renamed the export to fix the spelling error
* Added type updates and support for the transfer projects endpoint for the Groups API
* Added type updates and removed removed events endpoint on the Projects API
* Added type updates and modified the create function to require a resource name in the Todos API
2021-05-14 10:07:11 -04:00

83 lines
2.1 KiB
TypeScript

import { BaseServiceOptions } from '@gitbeaker/requester-utils';
import { GroupSchema } from './Groups';
import { ResourceIssueBoards, IssueBoardSchema, IssueBoardListSchema } from '../templates';
import {
BaseRequestOptions,
PaginatedRequestOptions,
Sudo,
CamelizedRecord,
} from '../infrastructure';
export interface GroupIssueBoardSchema extends IssueBoardSchema {
group: Pick<GroupSchema, 'id' | 'name' | 'web_url'>;
}
export interface GroupIssueBoards<C extends boolean = false> extends ResourceIssueBoards<C> {
all(
groupId: string | number,
options?: PaginatedRequestOptions,
): Promise<CamelizedRecord<C, IssueBoardSchema>[]>;
create(
groupId: string | number,
name: string,
options?: Sudo,
): Promise<CamelizedRecord<C, GroupIssueBoardSchema>>;
createList(
groupId: string | number,
boardId: number,
labelId: number | string,
options?: Sudo,
): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
edit(
groupId: string | number,
boardId: number,
options?: BaseRequestOptions,
): Promise<CamelizedRecord<C, GroupIssueBoardSchema>>;
editList(
groupId: string | number,
boardId: number,
listId: number,
position: number,
options?: Sudo,
): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
lists(
groupId: string | number,
boardId: number,
options?: Sudo,
): Promise<CamelizedRecord<C, IssueBoardListSchema>[]>;
remove(groupId: string | number, boardId: number, options?: Sudo): Promise<void>;
removeList(
groupId: string | number,
boardId: number,
listId: number,
options?: Sudo,
): Promise<void>;
show(
groupId: string | number,
boardId: number,
options?: Sudo,
): Promise<CamelizedRecord<C, GroupIssueBoardSchema>>;
showList(
groupId: string | number,
boardId: number,
listId: number,
options?: Sudo,
): Promise<CamelizedRecord<C, IssueBoardListSchema>>;
}
export class GroupIssueBoards<C extends boolean = false> extends ResourceIssueBoards<C> {
constructor(options: BaseServiceOptions<C>) {
/* istanbul ignore next */
super('groups', options);
}
}