pl-api
    Preparing search index...

    Function myAccountCategory

    • Parameters

      • client: PlApiBaseClient & {
            accounts: {
                biteAccount: (accountId: string) => Promise<EmptyObject>;
                createScrobble: (
                    params: CreateScrobbleParams,
                ) => Promise<
                    {
                        account: {
                            __meta: { pleroma?: any; source?: any };
                            accepts_chat_messages: boolean | null;
                            acct: string;
                            ap_id: string | null;
                            avatar: string;
                            avatar_default: boolean;
                            avatar_description: string;
                            avatar_static: string;
                            background_image: string | null;
                            birthday?: string;
                            bot: boolean;
                            created_at: string;
                            custom_css: string;
                            deactivated?: boolean;
                            discoverable: boolean;
                            display_name: string;
                            domain: string;
                            emojis: {
                                category: (...) | (...);
                                shortcode: string;
                                static_url: string;
                                url: string;
                                visible_in_picker: boolean;
                            }[];
                            enable_rss: boolean;
                            favicon?: string;
                            fields: { name: string; value: string; verified_at: (...)
                            | (...) }[];
                            followers_count: number;
                            following_count: number;
                            fqn: string;
                            group: boolean;
                            header: string;
                            header_default: boolean;
                            header_description: string;
                            header_static: string;
                            hide_collections?: boolean;
                            hide_favorites: boolean;
                            hide_followers?: boolean;
                            hide_followers_count?: boolean;
                            hide_follows?: boolean;
                            hide_follows_count?: boolean;
                            id: string;
                            identity_proofs: { name: string; value: string; verified_at: string }[];
                            indexable: boolean | null;
                            is_admin?: boolean;
                            is_cat: boolean;
                            is_moderator?: boolean;
                            is_suggested?: boolean;
                            last_status_at: string | null;
                            limited?: boolean;
                            local?: boolean;
                            location?: string;
                            locked: boolean;
                            memorial: boolean | null;
                            mention_policy: "none" | "only_known" | "only_contacts";
                            moved:
                                | {
                                    __meta: { pleroma?: ...; source?: ... };
                                    accepts_chat_messages: (...) | (...) | (...);
                                    acct: string;
                                    ap_id: (...) | (...);
                                    avatar: string;
                                    avatar_default: boolean;
                                    avatar_description: string;
                                    avatar_static: string;
                                    background_image: (...) | (...);
                                    birthday?: (...) | (...);
                                    bot: boolean;
                                    created_at: string;
                                    custom_css: string;
                                    deactivated?: (...) | (...) | (...);
                                    discoverable: boolean;
                                    display_name: string;
                                    domain: string;
                                    emojis: (...)[];
                                    enable_rss: boolean;
                                    favicon?: (...) | (...);
                                    fields: (...)[];
                                    followers_count: number;
                                    following_count: number;
                                    fqn: string;
                                    group: boolean;
                                    header: string;
                                    header_default: boolean;
                                    header_description: string;
                                    header_static: string;
                                    hide_collections?: (...) | (...) | (...);
                                    hide_favorites: boolean;
                                    hide_followers?: (...) | (...) | (...);
                                    hide_followers_count?: (...) | (...) | (...);
                                    hide_follows?: (...) | (...) | (...);
                                    hide_follows_count?: (...) | (...) | (...);
                                    id: string;
                                    identity_proofs: (...)[];
                                    indexable: (...) | (...) | (...);
                                    is_admin?: (...) | (...) | (...);
                                    is_cat: boolean;
                                    is_moderator?: (...) | (...) | (...);
                                    is_suggested?: (...) | (...) | (...);
                                    last_status_at: (...) | (...);
                                    limited?: (...) | (...) | (...);
                                    local?: (...) | (...) | (...);
                                    location?: (...) | (...);
                                    locked: boolean;
                                    memorial: (...) | (...) | (...);
                                    mention_policy: (...) | (...) | (...);
                                    noindex: (...) | (...) | (...);
                                    note: string;
                                    payment_options: (...)[];
                                    permit_followback?: (...) | (...) | (...);
                                    pronouns: (...)[];
                                    relationship?: (...) | (...);
                                    roles: (...)[];
                                    speak_as_cat: boolean;
                                    statuses_count: number;
                                    subscribers_count: number;
                                    suspended?: (...) | (...) | (...);
                                    url: string;
                                    username: string;
                                    verified?: (...) | (...) | (...);
                                }
                                | null;
                            noindex: boolean
                            | null;
                            note: string;
                            payment_options: (
                                | { href: ...; name: ...; object_id: ...; type: ... }
                                | {
                                    amount_min: ...;
                                    chain_id: ...;
                                    object_id: ...;
                                    price: ...;
                                    type: ...;
                                }
                            )[];
                            permit_followback?: boolean;
                            pronouns: string[];
                            relationship?: {
                                blocked_by: boolean;
                                blocking: boolean;
                                domain_blocking: boolean;
                                endorsed: boolean;
                                followed_by: boolean;
                                following: boolean;
                                id: string;
                                languages: (...)
                                | (...);
                                muting: boolean;
                                muting_notifications: boolean;
                                note: string;
                                notifying: boolean;
                                requested: boolean;
                                showing_reblogs: boolean;
                            };
                            roles: {
                                color: string;
                                highlighted: boolean;
                                id: string;
                                name: string;
                                permissions: string;
                            }[];
                            speak_as_cat: boolean;
                            statuses_count: number;
                            subscribers_count: number;
                            suspended?: boolean;
                            url: string;
                            username: string;
                            verified?: boolean;
                        } & WithMoved;
                        album: string;
                        artist: string;
                        created_at: string;
                        external_link: string
                        | null;
                        id: string;
                        length: number | null;
                        title: string;
                    },
                >;
                followAccount: (
                    accountId: string,
                    params?: FollowAccountParams,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
                getAccount: (
                    accountId: string,
                    params?: WithMutedParam,
                ) => Promise<Account>;
                getAccountAntennas: (accountId: string) => Promise<Antenna[]>;
                getAccountCircles: (accountId: string) => Promise<Antenna[]>;
                getAccountEndorsements: (
                    accountId: string,
                    params?: GetAccountEndorsementsParams,
                ) => Promise<PaginatedResponse<Account, true>>;
                getAccountExcludeAntennas: (
                    accountId: string,
                ) => Promise<{ id: string; title: string }[]>;
                getAccountFavourites: (
                    accountId: string,
                    params?: PaginationParams,
                ) => Promise<PaginatedResponse<Status, true>>;
                getAccountFeaturedTags: (
                    accountId: string,
                ) => Promise<
                    {
                        id: string;
                        last_status_at: number
                        | null;
                        name: string;
                        statuses_count: number;
                        url?: string;
                    }[],
                >;
                getAccountFollowers: (
                    accountId: string,
                    params?: GetAccountFollowersParams,
                ) => Promise<PaginatedResponse<Account, true>>;
                getAccountFollowing: (
                    accountId: string,
                    params?: GetAccountFollowingParams,
                ) => Promise<PaginatedResponse<Account, true>>;
                getAccountLists: (
                    accountId: string,
                ) => Promise<
                    {
                        antennas: Antenna[];
                        exclusive?: boolean;
                        favourite?: boolean;
                        id: string;
                        notify?: boolean;
                        replies_policy?: "none"
                        | "list"
                        | "followed";
                        title: string;
                    }[],
                >;
                getAccounts: (accountId: string[]) => Promise<Account[]>;
                getAccountStatuses: (
                    accountId: string,
                    params?: GetAccountStatusesParams,
                ) => Promise<PaginatedResponse<Status, true>>;
                getAccountSubscribers: (
                    accountId: string,
                    params?: GetAccountSubscribersParams,
                ) => Promise<PaginatedResponse<Account, true>>;
                getBirthdays: (day: number, month: number) => Promise<Account[]>;
                getFamiliarFollowers: (
                    accountIds: string[],
                ) => Promise<{ accounts: Account[]; id: string }[]>;
                getRelationships: (
                    accountIds: string[],
                    params?: GetRelationshipsParams,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    }[],
                >;
                getScrobbles: (
                    accountId: string,
                    params?: PaginationParams,
                ) => Promise<
                    PaginatedResponse<
                        {
                            account: {
                                __meta: { pleroma?: any; source?: any };
                                accepts_chat_messages: boolean | null;
                                acct: string;
                                ap_id: string | null;
                                avatar: string;
                                avatar_default: boolean;
                                avatar_description: string;
                                avatar_static: string;
                                background_image: string | null;
                                birthday?: string;
                                bot: boolean;
                                created_at: string;
                                custom_css: string;
                                deactivated?: boolean;
                                discoverable: boolean;
                                display_name: string;
                                domain: string;
                                emojis: {
                                    category: ...;
                                    shortcode: ...;
                                    static_url: ...;
                                    url: ...;
                                    visible_in_picker: ...;
                                }[];
                                enable_rss: boolean;
                                favicon?: string;
                                fields: { name: ...; value: ...; verified_at: ... }[];
                                followers_count: number;
                                following_count: number;
                                fqn: string;
                                group: boolean;
                                header: string;
                                header_default: boolean;
                                header_description: string;
                                header_static: string;
                                hide_collections?: boolean;
                                hide_favorites: boolean;
                                hide_followers?: boolean;
                                hide_followers_count?: boolean;
                                hide_follows?: boolean;
                                hide_follows_count?: boolean;
                                id: string;
                                identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                                indexable: boolean | null;
                                is_admin?: boolean;
                                is_cat: boolean;
                                is_moderator?: boolean;
                                is_suggested?: boolean;
                                last_status_at: string | null;
                                limited?: boolean;
                                local?: boolean;
                                location?: string;
                                locked: boolean;
                                memorial: boolean | null;
                                mention_policy: "none" | "only_known" | "only_contacts";
                                moved:
                                    | {
                                        __meta: ...;
                                        accepts_chat_messages: ...;
                                        acct: ...;
                                        ap_id: ...;
                                        avatar: ...;
                                        avatar_default: ...;
                                        avatar_description: ...;
                                        avatar_static: ...;
                                        background_image: ...;
                                        birthday?: ...;
                                        bot: ...;
                                        created_at: ...;
                                        custom_css: ...;
                                        deactivated?: ...;
                                        discoverable: ...;
                                        display_name: ...;
                                        domain: ...;
                                        emojis: ...;
                                        enable_rss: ...;
                                        favicon?: ...;
                                        fields: ...;
                                        followers_count: ...;
                                        following_count: ...;
                                        fqn: ...;
                                        group: ...;
                                        header: ...;
                                        header_default: ...;
                                        header_description: ...;
                                        header_static: ...;
                                        hide_collections?: ...;
                                        hide_favorites: ...;
                                        hide_followers?: ...;
                                        hide_followers_count?: ...;
                                        hide_follows?: ...;
                                        hide_follows_count?: ...;
                                        id: ...;
                                        identity_proofs: ...;
                                        indexable: ...;
                                        is_admin?: ...;
                                        is_cat: ...;
                                        is_moderator?: ...;
                                        is_suggested?: ...;
                                        last_status_at: ...;
                                        limited?: ...;
                                        local?: ...;
                                        location?: ...;
                                        locked: ...;
                                        memorial: ...;
                                        mention_policy: ...;
                                        noindex: ...;
                                        note: ...;
                                        payment_options: ...;
                                        permit_followback?: ...;
                                        pronouns: ...;
                                        relationship?: ...;
                                        roles: ...;
                                        speak_as_cat: ...;
                                        statuses_count: ...;
                                        subscribers_count: ...;
                                        suspended?: ...;
                                        url: ...;
                                        username: ...;
                                        verified?: ...;
                                    }
                                    | null;
                                noindex: boolean
                                | null;
                                note: string;
                                payment_options: ((...) | (...))[];
                                permit_followback?: boolean;
                                pronouns: string[];
                                relationship?: {
                                    blocked_by: ...;
                                    blocking: ...;
                                    domain_blocking: ...;
                                    endorsed: ...;
                                    followed_by: ...;
                                    following: ...;
                                    id: ...;
                                    languages: ...;
                                    muting: ...;
                                    muting_notifications: ...;
                                    note: ...;
                                    notifying: ...;
                                    requested: ...;
                                    showing_reblogs: ...;
                                };
                                roles: {
                                    color: ...;
                                    highlighted: ...;
                                    id: ...;
                                    name: ...;
                                    permissions: ...;
                                }[];
                                speak_as_cat: boolean;
                                statuses_count: number;
                                subscribers_count: number;
                                suspended?: boolean;
                                url: string;
                                username: string;
                                verified?: boolean;
                            } & WithMoved;
                            album: string;
                            artist: string;
                            created_at: string;
                            external_link: string
                            | null;
                            id: string;
                            length: number | null;
                            title: string;
                        },
                        true,
                    >,
                >;
                loadActivities: (accountId: string) => Promise<EmptyObject>;
                lookupAccount: (acct: string, meta?: RequestMeta) => Promise<Account>;
                pinAccount: (
                    accountId: string,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
                remoteInteraction: (
                    ap_id: string,
                    profile: string,
                ) => Promise<{ url: string }>;
                removeAccountFromFollowers: (
                    accountId: string,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
                reportAccount: (
                    accountId: string,
                    params: ReportAccountParams,
                ) => Promise<
                    {
                        action_taken?: boolean;
                        action_taken_at: string
                        | null;
                        category?: string;
                        comment?: string;
                        created_at?: string;
                        forwarded?: boolean;
                        id: string;
                        rule_ids: string | null;
                        status_ids: string | null;
                        target_account: Account | null;
                    },
                >;
                searchAccounts: (
                    q: string,
                    params?: SearchAccountParams,
                    meta?: RequestMeta,
                ) => Promise<Account[]>;
                unfollowAccount: (
                    accountId: string,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
                unpinAccount: (
                    accountId: string,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
                updateAccountNote: (
                    accountId: string,
                    comment: string,
                ) => Promise<
                    {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: string[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    },
                >;
            };
        }

      Returns {
          acceptFollowRequest: (
              accountId: string,
          ) => Promise<
              {
                  blocked_by: boolean;
                  blocking: boolean;
                  domain_blocking: boolean;
                  endorsed: boolean;
                  followed_by: boolean;
                  following: boolean;
                  id: string;
                  languages: string[]
                  | null;
                  muting: boolean;
                  muting_notifications: boolean;
                  note: string;
                  notifying: boolean;
                  requested: boolean;
                  showing_reblogs: boolean;
              },
          >;
          addBookmarkToFolder: (
              statusId: string,
              folderId: string,
          ) => Promise<EmptyObject>;
          createBookmarkFolder: (
              params: CreateBookmarkFolderParams,
          ) => Promise<
              {
                  emoji: string
                  | null;
                  emoji_url: string | null;
                  id: string;
                  name: string;
              },
          >;
          deleteBookmarkFolder: (
              bookmarkFolderId: string,
          ) => Promise<
              {
                  emoji: string
                  | null;
                  emoji_url: string | null;
                  id: string;
                  name: string;
              },
          >;
          dismissSuggestions: (accountId: string) => Promise<EmptyObject>;
          featureTag: (
              name: string,
          ) => Promise<
              {
                  id: string;
                  last_status_at: number
                  | null;
                  name: string;
                  statuses_count: number;
                  url?: string;
              },
          >;
          followTag: (
              tagId: string,
          ) => Promise<
              {
                  following?: boolean;
                  history: { accounts: number; day: number; uses: number }[]
                  | null;
                  name: string;
                  total: number | null;
                  url: string;
              },
          >;
          getBookmarkFolders: () => Promise<
              {
                  emoji: string
                  | null;
                  emoji_url: string | null;
                  id: string;
                  name: string;
              }[],
          >;
          getBookmarks: (
              params?: GetBookmarksParams,
          ) => Promise<PaginatedResponse<Status, true>>;
          getEndorsements: (
              params?: GetEndorsementsParams,
          ) => Promise<PaginatedResponse<Account, true>>;
          getFavourites: (
              params?: PaginationParams,
          ) => Promise<PaginatedResponse<Status, true>>;
          getFeaturedTags: () => Promise<
              {
                  id: string;
                  last_status_at: number
                  | null;
                  name: string;
                  statuses_count: number;
                  url?: string;
              }[],
          >;
          getFeaturedTagsSuggestions: () => Promise<
              {
                  following?: boolean;
                  history: { accounts: number; day: number; uses: number }[]
                  | null;
                  name: string;
                  total: number | null;
                  url: string;
              }[],
          >;
          getFollowedTags: (
              params?: PaginationParams,
          ) => Promise<
              PaginatedResponse<
                  {
                      following?: boolean;
                      history: { accounts: number; day: number; uses: number }[]
                      | null;
                      name: string;
                      total: number | null;
                      url: string;
                  },
                  true,
              >,
          >;
          getFollowRequests: (
              params?: GetFollowRequestsParams,
          ) => Promise<PaginatedResponse<Account, true>>;
          getOutgoingFollowRequests: (
              params?: GetFollowRequestsParams,
          ) => Promise<PaginatedResponse<Account, true>>;
          getSuggestions: (
              limit?: number,
          ) => Promise<
              {
                  account: {
                      __meta: { pleroma?: any; source?: any };
                      accepts_chat_messages: boolean | null;
                      acct: string;
                      ap_id: string | null;
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      background_image: string | null;
                      birthday?: string;
                      bot: boolean;
                      created_at: string;
                      custom_css: string;
                      deactivated?: boolean;
                      discoverable: boolean;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      enable_rss: boolean;
                      favicon?: string;
                      fields: { name: string; value: string; verified_at: string
                      | null }[];
                      followers_count: number;
                      following_count: number;
                      fqn: string;
                      group: boolean;
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      hide_collections?: boolean;
                      hide_favorites: boolean;
                      hide_followers?: boolean;
                      hide_followers_count?: boolean;
                      hide_follows?: boolean;
                      hide_follows_count?: boolean;
                      id: string;
                      identity_proofs: { name: string; value: string; verified_at: string }[];
                      indexable: boolean | null;
                      is_admin?: boolean;
                      is_cat: boolean;
                      is_moderator?: boolean;
                      is_suggested?: boolean;
                      last_status_at: string | null;
                      limited?: boolean;
                      local?: boolean;
                      location?: string;
                      locked: boolean;
                      memorial: boolean | null;
                      mention_policy: "none" | "only_known" | "only_contacts";
                      moved:
                          | {
                              __meta: { pleroma?: any; source?: any };
                              accepts_chat_messages: boolean | null;
                              acct: string;
                              ap_id: string | null;
                              avatar: string;
                              avatar_default: boolean;
                              avatar_description: string;
                              avatar_static: string;
                              background_image: string | null;
                              birthday?: string;
                              bot: boolean;
                              created_at: string;
                              custom_css: string;
                              deactivated?: boolean;
                              discoverable: boolean;
                              display_name: string;
                              domain: string;
                              emojis: {
                                  category: ...;
                                  shortcode: ...;
                                  static_url: ...;
                                  url: ...;
                                  visible_in_picker: ...;
                              }[];
                              enable_rss: boolean;
                              favicon?: string;
                              fields: { name: ...; value: ...; verified_at: ... }[];
                              followers_count: number;
                              following_count: number;
                              fqn: string;
                              group: boolean;
                              header: string;
                              header_default: boolean;
                              header_description: string;
                              header_static: string;
                              hide_collections?: boolean;
                              hide_favorites: boolean;
                              hide_followers?: boolean;
                              hide_followers_count?: boolean;
                              hide_follows?: boolean;
                              hide_follows_count?: boolean;
                              id: string;
                              identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                              indexable: boolean | null;
                              is_admin?: boolean;
                              is_cat: boolean;
                              is_moderator?: boolean;
                              is_suggested?: boolean;
                              last_status_at: string | null;
                              limited?: boolean;
                              local?: boolean;
                              location?: string;
                              locked: boolean;
                              memorial: boolean | null;
                              mention_policy: "none" | "only_known" | "only_contacts";
                              noindex: boolean | null;
                              note: string;
                              payment_options: ((...) | (...))[];
                              permit_followback?: boolean;
                              pronouns: string[];
                              relationship?: {
                                  blocked_by: ...;
                                  blocking: ...;
                                  domain_blocking: ...;
                                  endorsed: ...;
                                  followed_by: ...;
                                  following: ...;
                                  id: ...;
                                  languages: ...;
                                  muting: ...;
                                  muting_notifications: ...;
                                  note: ...;
                                  notifying: ...;
                                  requested: ...;
                                  showing_reblogs: ...;
                              };
                              roles: {
                                  color: ...;
                                  highlighted: ...;
                                  id: ...;
                                  name: ...;
                                  permissions: ...;
                              }[];
                              speak_as_cat: boolean;
                              statuses_count: number;
                              subscribers_count: number;
                              suspended?: boolean;
                              url: string;
                              username: string;
                              verified?: boolean;
                          }
                          | null;
                      noindex: boolean
                      | null;
                      note: string;
                      payment_options: (
                          | {
                              href: (...)
                              | (...);
                              name: (...) | (...);
                              object_id: (...) | (...);
                              type: "link";
                          }
                          | {
                              amount_min: (...)
                              | (...);
                              chain_id: (...) | (...);
                              object_id: (...) | (...);
                              price: (...) | (...);
                              type: "monero-subscription";
                          }
                      )[];
                      permit_followback?: boolean;
                      pronouns: string[];
                      relationship?: {
                          blocked_by: boolean;
                          blocking: boolean;
                          domain_blocking: boolean;
                          endorsed: boolean;
                          followed_by: boolean;
                          following: boolean;
                          id: string;
                          languages: (...)[]
                          | null;
                          muting: boolean;
                          muting_notifications: boolean;
                          note: string;
                          notifying: boolean;
                          requested: boolean;
                          showing_reblogs: boolean;
                      };
                      roles: {
                          color: string;
                          highlighted: boolean;
                          id: string;
                          name: string;
                          permissions: string;
                      }[];
                      speak_as_cat: boolean;
                      statuses_count: number;
                      subscribers_count: number;
                      suspended?: boolean;
                      url: string;
                      username: string;
                      verified?: boolean;
                  } & WithMoved;
                  source: string
                  | null;
                  sources: string[];
              }[],
          >;
          getTag: (
              tagId: string,
          ) => Promise<
              {
                  following?: boolean;
                  history: { accounts: number; day: number; uses: number }[]
                  | null;
                  name: string;
                  total: number | null;
                  url: string;
              },
          >;
          rejectFollowRequest: (
              accountId: string,
          ) => Promise<
              {
                  blocked_by: boolean;
                  blocking: boolean;
                  domain_blocking: boolean;
                  endorsed: boolean;
                  followed_by: boolean;
                  following: boolean;
                  id: string;
                  languages: string[]
                  | null;
                  muting: boolean;
                  muting_notifications: boolean;
                  note: string;
                  notifying: boolean;
                  requested: boolean;
                  showing_reblogs: boolean;
              },
          >;
          removeBookmarkFromFolder: (
              statusId: string,
              folderId: string,
          ) => Promise<EmptyObject>;
          unfeatureTag: (featuredTagId: string) => Promise<EmptyObject>;
          unfollowTag: (
              tagId: string,
          ) => Promise<
              {
                  following?: boolean;
                  history: { accounts: number; day: number; uses: number }[]
                  | null;
                  name: string;
                  total: number | null;
                  url: string;
              },
          >;
          updateBookmarkFolder: (
              bookmarkFolderId: string,
              params: UpdateBookmarkFolderParams,
          ) => Promise<
              {
                  emoji: string
                  | null;
                  emoji_url: string | null;
                  id: string;
                  name: string;
              },
          >;
      }

      • acceptFollowRequest: (
            accountId: string,
        ) => Promise<
            {
                blocked_by: boolean;
                blocking: boolean;
                domain_blocking: boolean;
                endorsed: boolean;
                followed_by: boolean;
                following: boolean;
                id: string;
                languages: string[]
                | null;
                muting: boolean;
                muting_notifications: boolean;
                note: string;
                notifying: boolean;
                requested: boolean;
                showing_reblogs: boolean;
            },
        >

        Accept follow request

        https://docs.joinmastodon.org/methods/follow_requests/#accept

      • addBookmarkToFolder: (statusId: string, folderId: string) => Promise<EmptyObject>

        Requires featuresFeatures.bookmarkFoldersMultiple.

      • createBookmarkFolder: (
            params: CreateBookmarkFolderParams,
        ) => Promise<
            {
                emoji: string
                | null;
                emoji_url: string | null;
                id: string;
                name: string;
            },
        >

        Creates a bookmark folder

        Requires featuresFeatures.bookmarkFolders. Specifying folder emoji requires featuresFeatures.bookmarkFolderEmojis.

        https://docs.pleroma.social/backend/development/API/pleroma_api/#post-apiv1pleromabookmark_folders

      • deleteBookmarkFolder: (
            bookmarkFolderId: string,
        ) => Promise<
            {
                emoji: string
                | null;
                emoji_url: string | null;
                id: string;
                name: string;
            },
        >

        Deletes a bookmark folder

        Requires featuresFeatures.bookmarkFolders.

        https://docs.pleroma.social/backend/development/API/pleroma_api/#delete-apiv1pleromabookmark_foldersid

      • dismissSuggestions: (accountId: string) => Promise<EmptyObject>

        Remove a suggestion Remove an account from follow suggestions.

        Requires featuresFeatures.suggestionsDismiss.

        https://docs.joinmastodon.org/methods/suggestions/#remove

      • featureTag: (
            name: string,
        ) => Promise<
            {
                id: string;
                last_status_at: number
                | null;
                name: string;
                statuses_count: number;
                url?: string;
            },
        >

        Feature a tag Promote a hashtag on your profile.

        Requires featuresFeatures.featuredTags.

        https://docs.joinmastodon.org/methods/featured_tags/#feature

      • followTag: (
            tagId: string,
        ) => Promise<
            {
                following?: boolean;
                history: { accounts: number; day: number; uses: number }[]
                | null;
                name: string;
                total: number | null;
                url: string;
            },
        >

        Follow a hashtag Follow a hashtag. Posts containing a followed hashtag will be inserted into your home timeline.

        https://docs.joinmastodon.org/methods/tags/#follow

      • getBookmarkFolders: () => Promise<
            {
                emoji: string
                | null;
                emoji_url: string | null;
                id: string;
                name: string;
            }[],
        >

        Gets user bookmark folders

        Requires featuresFeatures.bookmarkFolders.

        https://docs.pleroma.social/backend/development/API/pleroma_api/#get-apiv1pleromabookmark_folders

      • getBookmarks: (params?: GetBookmarksParams) => Promise<PaginatedResponse<Status, true>>

        View bookmarked statuses Statuses the user has bookmarked.

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

      • getEndorsements: (params?: GetEndorsementsParams) => Promise<PaginatedResponse<Account, true>>

        View currently featured profiles Accounts that the user is currently featuring on their profile.

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

      • getFavourites: (params?: PaginationParams) => Promise<PaginatedResponse<Status, true>>

        View favourited statuses Statuses the user has favourited.

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

      • getFeaturedTags: () => Promise<
            {
                id: string;
                last_status_at: number
                | null;
                name: string;
                statuses_count: number;
                url?: string;
            }[],
        >

        View your featured tags List all hashtags featured on your profile.

        Requires featuresFeatures.featuredTags.

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

      • getFeaturedTagsSuggestions: () => Promise<
            {
                following?: boolean;
                history: { accounts: number; day: number; uses: number }[]
                | null;
                name: string;
                total: number | null;
                url: string;
            }[],
        >

        View suggested tags to feature Shows up to 10 recently-used tags.

        Requires featuresFeatures.featuredTags.

        https://docs.joinmastodon.org/methods/featured_tags/#suggestions

      • getFollowedTags: (
            params?: PaginationParams,
        ) => Promise<
            PaginatedResponse<
                {
                    following?: boolean;
                    history: { accounts: number; day: number; uses: number }[]
                    | null;
                    name: string;
                    total: number | null;
                    url: string;
                },
                true,
            >,
        >

        View all followed tags List your followed hashtags.

        Requires featuresFeatures.followHashtags.

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

      • getFollowRequests: (params?: GetFollowRequestsParams) => Promise<PaginatedResponse<Account, true>>

        View pending follow requests

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

      • getOutgoingFollowRequests: (params?: GetFollowRequestsParams) => Promise<PaginatedResponse<Account, true>>

        View outgoing follow requests

        Requires featuresFeatures.outgoingFollowRequests.

      • getSuggestions: (
            limit?: number,
        ) => Promise<
            {
                account: {
                    __meta: { pleroma?: any; source?: any };
                    accepts_chat_messages: boolean | null;
                    acct: string;
                    ap_id: string | null;
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    background_image: string | null;
                    birthday?: string;
                    bot: boolean;
                    created_at: string;
                    custom_css: string;
                    deactivated?: boolean;
                    discoverable: boolean;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    enable_rss: boolean;
                    favicon?: string;
                    fields: { name: string; value: string; verified_at: string
                    | null }[];
                    followers_count: number;
                    following_count: number;
                    fqn: string;
                    group: boolean;
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    hide_collections?: boolean;
                    hide_favorites: boolean;
                    hide_followers?: boolean;
                    hide_followers_count?: boolean;
                    hide_follows?: boolean;
                    hide_follows_count?: boolean;
                    id: string;
                    identity_proofs: { name: string; value: string; verified_at: string }[];
                    indexable: boolean | null;
                    is_admin?: boolean;
                    is_cat: boolean;
                    is_moderator?: boolean;
                    is_suggested?: boolean;
                    last_status_at: string | null;
                    limited?: boolean;
                    local?: boolean;
                    location?: string;
                    locked: boolean;
                    memorial: boolean | null;
                    mention_policy: "none" | "only_known" | "only_contacts";
                    moved:
                        | {
                            __meta: { pleroma?: any; source?: any };
                            accepts_chat_messages: boolean | null;
                            acct: string;
                            ap_id: string | null;
                            avatar: string;
                            avatar_default: boolean;
                            avatar_description: string;
                            avatar_static: string;
                            background_image: string | null;
                            birthday?: string;
                            bot: boolean;
                            created_at: string;
                            custom_css: string;
                            deactivated?: boolean;
                            discoverable: boolean;
                            display_name: string;
                            domain: string;
                            emojis: {
                                category: ...;
                                shortcode: ...;
                                static_url: ...;
                                url: ...;
                                visible_in_picker: ...;
                            }[];
                            enable_rss: boolean;
                            favicon?: string;
                            fields: { name: ...; value: ...; verified_at: ... }[];
                            followers_count: number;
                            following_count: number;
                            fqn: string;
                            group: boolean;
                            header: string;
                            header_default: boolean;
                            header_description: string;
                            header_static: string;
                            hide_collections?: boolean;
                            hide_favorites: boolean;
                            hide_followers?: boolean;
                            hide_followers_count?: boolean;
                            hide_follows?: boolean;
                            hide_follows_count?: boolean;
                            id: string;
                            identity_proofs: { name: ...; value: ...; verified_at: ... }[];
                            indexable: boolean | null;
                            is_admin?: boolean;
                            is_cat: boolean;
                            is_moderator?: boolean;
                            is_suggested?: boolean;
                            last_status_at: string | null;
                            limited?: boolean;
                            local?: boolean;
                            location?: string;
                            locked: boolean;
                            memorial: boolean | null;
                            mention_policy: "none" | "only_known" | "only_contacts";
                            noindex: boolean | null;
                            note: string;
                            payment_options: ((...) | (...))[];
                            permit_followback?: boolean;
                            pronouns: string[];
                            relationship?: {
                                blocked_by: ...;
                                blocking: ...;
                                domain_blocking: ...;
                                endorsed: ...;
                                followed_by: ...;
                                following: ...;
                                id: ...;
                                languages: ...;
                                muting: ...;
                                muting_notifications: ...;
                                note: ...;
                                notifying: ...;
                                requested: ...;
                                showing_reblogs: ...;
                            };
                            roles: {
                                color: ...;
                                highlighted: ...;
                                id: ...;
                                name: ...;
                                permissions: ...;
                            }[];
                            speak_as_cat: boolean;
                            statuses_count: number;
                            subscribers_count: number;
                            suspended?: boolean;
                            url: string;
                            username: string;
                            verified?: boolean;
                        }
                        | null;
                    noindex: boolean
                    | null;
                    note: string;
                    payment_options: (
                        | {
                            href: (...)
                            | (...);
                            name: (...) | (...);
                            object_id: (...) | (...);
                            type: "link";
                        }
                        | {
                            amount_min: (...)
                            | (...);
                            chain_id: (...) | (...);
                            object_id: (...) | (...);
                            price: (...) | (...);
                            type: "monero-subscription";
                        }
                    )[];
                    permit_followback?: boolean;
                    pronouns: string[];
                    relationship?: {
                        blocked_by: boolean;
                        blocking: boolean;
                        domain_blocking: boolean;
                        endorsed: boolean;
                        followed_by: boolean;
                        following: boolean;
                        id: string;
                        languages: (...)[]
                        | null;
                        muting: boolean;
                        muting_notifications: boolean;
                        note: string;
                        notifying: boolean;
                        requested: boolean;
                        showing_reblogs: boolean;
                    };
                    roles: {
                        color: string;
                        highlighted: boolean;
                        id: string;
                        name: string;
                        permissions: string;
                    }[];
                    speak_as_cat: boolean;
                    statuses_count: number;
                    subscribers_count: number;
                    suspended?: boolean;
                    url: string;
                    username: string;
                    verified?: boolean;
                } & WithMoved;
                source: string
                | null;
                sources: string[];
            }[],
        >

        View follow suggestions Accounts that are promoted by staff, or that the user has had past positive interactions with, but is not yet following.

        Requires featuresFeatures.suggestions.

        https://docs.joinmastodon.org/methods/suggestions/#v2

      • getTag: (
            tagId: string,
        ) => Promise<
            {
                following?: boolean;
                history: { accounts: number; day: number; uses: number }[]
                | null;
                name: string;
                total: number | null;
                url: string;
            },
        >

        View information about a single tag Show a hashtag and its associated information

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

      • rejectFollowRequest: (
            accountId: string,
        ) => Promise<
            {
                blocked_by: boolean;
                blocking: boolean;
                domain_blocking: boolean;
                endorsed: boolean;
                followed_by: boolean;
                following: boolean;
                id: string;
                languages: string[]
                | null;
                muting: boolean;
                muting_notifications: boolean;
                note: string;
                notifying: boolean;
                requested: boolean;
                showing_reblogs: boolean;
            },
        >

        Reject follow request

        https://docs.joinmastodon.org/methods/follow_requests/#reject

      • removeBookmarkFromFolder: (statusId: string, folderId: string) => Promise<EmptyObject>

        Requires featuresFeatures.bookmarkFoldersMultiple.

      • unfeatureTag: (featuredTagId: string) => Promise<EmptyObject>

        Unfeature a tag Stop promoting a hashtag on your profile.

        Requires featuresFeatures.featuredTags.

        https://docs.joinmastodon.org/methods/featured_tags/#unfeature

      • unfollowTag: (
            tagId: string,
        ) => Promise<
            {
                following?: boolean;
                history: { accounts: number; day: number; uses: number }[]
                | null;
                name: string;
                total: number | null;
                url: string;
            },
        >

        Unfollow a hashtag Unfollow a hashtag. Posts containing this hashtag will no longer be inserted into your home timeline.

        https://docs.joinmastodon.org/methods/tags/#unfollow

      • updateBookmarkFolder: (
            bookmarkFolderId: string,
            params: UpdateBookmarkFolderParams,
        ) => Promise<
            {
                emoji: string
                | null;
                emoji_url: string | null;
                id: string;
                name: string;
            },
        >

        Updates a bookmark folder

        Requires featuresFeatures.bookmarkFolders. Specifying folder emoji requires featuresFeatures.bookmarkFolderEmojis.

        https://docs.pleroma.social/backend/development/API/pleroma_api/#patch-apiv1pleromabookmark_foldersid

    Settings

    Member Visibility