Function listsCategory

Returns {
    addListAccounts: (
        listId: string,
        accountIds: string[],
    ) => Promise<EmptyObject>;
    createList: (
        params: CreateListParams,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        },
    >;
    deleteList: (listId: string) => Promise<EmptyObject>;
    deleteListAccounts: (
        listId: string,
        accountIds: string[],
    ) => Promise<EmptyObject>;
    favouriteList: (
        listId: string,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        },
    >;
    getList: (
        listId: string,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        },
    >;
    getListAccounts: (
        listId: string,
        params?: PaginationParams,
    ) => Promise<PaginatedResponse<Account, true>>;
    getLists: () => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        }[],
    >;
    unfavouriteList: (
        listId: string,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        },
    >;
    updateList: (
        listId: string,
        params: UpdateListParams,
    ) => Promise<
        {
            antennas: Antenna[];
            exclusive?: boolean;
            favourite?: boolean;
            id: string;
            notify?: boolean;
            replies_policy?: "none"
            | "list"
            | "followed";
            title: string;
        },
    >;
}

• addListAccounts: (listId: string, accountIds: string[]) => Promise<EmptyObject>

  Add accounts to a list Add accounts to the given list. Note that the user must be following these accounts.

  See

  https://docs.joinmastodon.org/methods/lists/#accounts-add

• createList: (
      params: CreateListParams,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      },
  >

  Create a list Create a new list.

  See

  https://docs.joinmastodon.org/methods/lists/#create

• deleteList: (listId: string) => Promise<EmptyObject>

  Delete a list

  See

  https://docs.joinmastodon.org/methods/lists/#delete

• deleteListAccounts: (listId: string, accountIds: string[]) => Promise<EmptyObject>

  Remove accounts from list Remove accounts from the given list.

  See

  https://docs.joinmastodon.org/methods/lists/#accounts-remove

• favouriteList: (
      listId: string,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      },
  >

  Add a list to favourites

  Requires featuresFeatures.listsFavourite.

• getList: (
      listId: string,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      },
  >

  Show a single list Fetch the list with the given ID. Used for verifying the title of a list, and which replies to show within that list.

  See

  https://docs.joinmastodon.org/methods/lists/#get-one

• getListAccounts: (
      listId: string,
      params?: PaginationParams,
  ) => Promise<PaginatedResponse<Account, true>>

  View accounts in a list

  See

  https://docs.joinmastodon.org/methods/lists/#accounts

• getLists: () => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      }[],
  >

  View your lists Fetch all lists that the user owns.

  See

  https://docs.joinmastodon.org/methods/lists/#get

• unfavouriteList: (
      listId: string,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      },
  >

  Remove a list from favourites

  Requires featuresFeatures.listsFavourite.

• updateList: (
      listId: string,
      params: UpdateListParams,
  ) => Promise<
      {
          antennas: Antenna[];
          exclusive?: boolean;
          favourite?: boolean;
          id: string;
          notify?: boolean;
          replies_policy?: "none"
          | "list"
          | "followed";
          title: string;
      },
  >

  Update a list Change the title of a list, or which replies to show.

  See

  https://docs.joinmastodon.org/methods/lists/#update