bigbuffet-rw/packages/pl-api/lib/params/lists.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

29 lines
666 B
TypeScript

import type { PaginationParams } from './common';
/**
* @category Request params
*/
interface CreateListParams {
/** String. The title of the list to be created. */
title: string;
/** String. One of followed, list, or none. Defaults to list. */
replies_policy?: 'followed' | 'list' | 'none';
/** Boolean. Whether members of this list need to get removed from the “Home” feed */
exclusive?: boolean;
}
/**
* @category Request params
*/
type UpdateListParams = CreateListParams;
/**
* @category Request params
*/
type GetListAccountsParams = PaginationParams;
export type {
CreateListParams,
UpdateListParams,
GetListAccountsParams,
};