bigbuffet-rw/packages/pl-api/lib/params/groups.ts
marcin mikołajczak 7b183e5c60 pl-api: Update docs
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
2024-10-29 22:44:28 +01:00

44 lines
812 B
TypeScript

import type { PaginationParams } from './common';
/**
* @category Request params
*/
interface CreateGroupParams {
display_name: string;
note?: string;
avatar?: File;
header?: File;
}
/**
* @category Request params
*/
interface UpdateGroupParams {
display_name?: string;
note?: string;
avatar?: File | '';
header?: File | '';
}
/**
* @category Request params
*/
type GetGroupMembershipsParams = Omit<PaginationParams, 'min_id'>;
/**
* @category Request params
*/
type GetGroupMembershipRequestsParams = Omit<PaginationParams, 'min_id'>;
/**
* @category Request params
*/
type GetGroupBlocksParams = Omit<PaginationParams, 'min_id'>;
export type {
CreateGroupParams,
UpdateGroupParams,
GetGroupMembershipsParams,
GetGroupMembershipRequestsParams,
GetGroupBlocksParams,
};