pl-api
    Preparing search index...

    Function experimentalCategory

    • Routes that are not part of any stable release

      Parameters

      Returns {
          admin: {
              groups: {
                  deleteGroup: (
                      groupId: string,
                  ) => Promise<
                      {
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          created_at: string;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string
                              | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          id: string;
                          locked: boolean;
                          members_count: number;
                          membership_required: boolean;
                          note: string;
                          owner: { id: string }
                          | null;
                          relationship:
                              | {
                                  id: string;
                                  member: boolean;
                                  requested: boolean;
                                  role?: OWNER
                                  | ADMIN
                                  | MODERATOR
                                  | USER;
                              }
                              | null;
                          statuses_visibility: string;
                          uri: string;
                          url: string;
                      },
                  >;
                  getGroup: (
                      groupId: string,
                  ) => Promise<
                      {
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          created_at: string;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string
                              | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          id: string;
                          locked: boolean;
                          members_count: number;
                          membership_required: boolean;
                          note: string;
                          owner: { id: string }
                          | null;
                          relationship:
                              | {
                                  id: string;
                                  member: boolean;
                                  requested: boolean;
                                  role?: OWNER
                                  | ADMIN
                                  | MODERATOR
                                  | USER;
                              }
                              | null;
                          statuses_visibility: string;
                          uri: string;
                          url: string;
                      },
                  >;
                  getGroups: (
                      params?: AdminGetGroupsParams,
                  ) => Promise<
                      {
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          created_at: string;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string
                              | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          id: string;
                          locked: boolean;
                          members_count: number;
                          membership_required: boolean;
                          note: string;
                          owner: { id: string }
                          | null;
                          relationship:
                              | {
                                  id: string;
                                  member: boolean;
                                  requested: boolean;
                                  role?: OWNER
                                  | ADMIN
                                  | MODERATOR
                                  | USER;
                              }
                              | null;
                          statuses_visibility: string;
                          uri: string;
                          url: string;
                      }[],
                  >;
                  suspendGroup: (
                      groupId: string,
                  ) => Promise<
                      {
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          created_at: string;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string
                              | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          id: string;
                          locked: boolean;
                          members_count: number;
                          membership_required: boolean;
                          note: string;
                          owner: { id: string }
                          | null;
                          relationship:
                              | {
                                  id: string;
                                  member: boolean;
                                  requested: boolean;
                                  role?: OWNER
                                  | ADMIN
                                  | MODERATOR
                                  | USER;
                              }
                              | null;
                          statuses_visibility: string;
                          uri: string;
                          url: string;
                      },
                  >;
                  unsuspendGroup: (
                      groupId: string,
                  ) => Promise<
                      {
                          avatar: string;
                          avatar_default: boolean;
                          avatar_description: string;
                          avatar_static: string;
                          created_at: string;
                          display_name: string;
                          domain: string;
                          emojis: {
                              category: string
                              | null;
                              shortcode: string;
                              static_url: string;
                              url: string;
                              visible_in_picker: boolean;
                          }[];
                          header: string;
                          header_default: boolean;
                          header_description: string;
                          header_static: string;
                          id: string;
                          locked: boolean;
                          members_count: number;
                          membership_required: boolean;
                          note: string;
                          owner: { id: string }
                          | null;
                          relationship:
                              | {
                                  id: string;
                                  member: boolean;
                                  requested: boolean;
                                  role?: OWNER
                                  | ADMIN
                                  | MODERATOR
                                  | USER;
                              }
                              | null;
                          statuses_visibility: string;
                          uri: string;
                          url: string;
                      },
                  >;
              };
          };
          groups: {
              acceptGroupMembershipRequest: (
                  groupId: string,
                  accountId: string,
              ) => Promise<EmptyObject>;
              blockGroupUsers: (
                  groupId: string,
                  accountIds: string[],
              ) => Promise<EmptyObject>;
              createGroup: (
                  params: CreateGroupParams,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
              deleteGroup: (groupId: string) => Promise<EmptyObject>;
              deleteGroupStatus: (groupId: string, statusId: string) => Promise<Status>;
              demoteGroupUsers: (
                  groupId: string,
                  accountIds: string[],
                  role: "owner" | "admin" | "moderator" | "user",
              ) => 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;
                      id: string;
                      role: GroupRoles;
                  }[],
              >;
              getGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
              getGroupBlocks: (
                  groupId: string,
                  params?: GetGroupBlocksParams,
              ) => Promise<PaginatedResponse<Account, true>>;
              getGroupMembershipRequests: (
                  groupId: string,
                  params?: GetGroupMembershipRequestsParams,
              ) => Promise<PaginatedResponse<Account, true>>;
              getGroupMemberships: (
                  groupId: string,
                  role?: "owner" | "admin" | "moderator" | "user",
                  params?: GetGroupMembershipsParams,
              ) => 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: 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;
                          id: string;
                          role: GroupRoles;
                      },
                      true,
                  >,
              >;
              getGroupRelationships: (
                  groupIds: string[],
              ) => Promise<
                  {
                      id: string;
                      member: boolean;
                      requested: boolean;
                      role?: OWNER
                      | ADMIN
                      | MODERATOR
                      | USER;
                  }[],
              >;
              getGroups: () => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  }[],
              >;
              joinGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      id: string;
                      member: boolean;
                      requested: boolean;
                      role?: OWNER
                      | ADMIN
                      | MODERATOR
                      | USER;
                  },
              >;
              kickGroupUsers: (
                  groupId: string,
                  accountIds: string[],
              ) => Promise<EmptyObject>;
              leaveGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      id: string;
                      member: boolean;
                      requested: boolean;
                      role?: OWNER
                      | ADMIN
                      | MODERATOR
                      | USER;
                  },
              >;
              promoteGroupUsers: (
                  groupId: string,
                  accountIds: string[],
                  role: "owner" | "admin" | "moderator" | "user",
              ) => 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;
                      id: string;
                      role: GroupRoles;
                  }[],
              >;
              rejectGroupMembershipRequest: (
                  groupId: string,
                  accountId: string,
              ) => Promise<EmptyObject>;
              unblockGroupUsers: (
                  groupId: string,
                  accountIds: string[],
              ) => Promise<EmptyObject>;
              updateGroup: (
                  groupId: string,
                  params: UpdateGroupParams,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
          };
      }

      • admin: {
            groups: {
                deleteGroup: (
                    groupId: string,
                ) => Promise<
                    {
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        created_at: string;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string
                            | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        id: string;
                        locked: boolean;
                        members_count: number;
                        membership_required: boolean;
                        note: string;
                        owner: { id: string }
                        | null;
                        relationship:
                            | {
                                id: string;
                                member: boolean;
                                requested: boolean;
                                role?: OWNER
                                | ADMIN
                                | MODERATOR
                                | USER;
                            }
                            | null;
                        statuses_visibility: string;
                        uri: string;
                        url: string;
                    },
                >;
                getGroup: (
                    groupId: string,
                ) => Promise<
                    {
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        created_at: string;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string
                            | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        id: string;
                        locked: boolean;
                        members_count: number;
                        membership_required: boolean;
                        note: string;
                        owner: { id: string }
                        | null;
                        relationship:
                            | {
                                id: string;
                                member: boolean;
                                requested: boolean;
                                role?: OWNER
                                | ADMIN
                                | MODERATOR
                                | USER;
                            }
                            | null;
                        statuses_visibility: string;
                        uri: string;
                        url: string;
                    },
                >;
                getGroups: (
                    params?: AdminGetGroupsParams,
                ) => Promise<
                    {
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        created_at: string;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string
                            | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        id: string;
                        locked: boolean;
                        members_count: number;
                        membership_required: boolean;
                        note: string;
                        owner: { id: string }
                        | null;
                        relationship:
                            | {
                                id: string;
                                member: boolean;
                                requested: boolean;
                                role?: OWNER
                                | ADMIN
                                | MODERATOR
                                | USER;
                            }
                            | null;
                        statuses_visibility: string;
                        uri: string;
                        url: string;
                    }[],
                >;
                suspendGroup: (
                    groupId: string,
                ) => Promise<
                    {
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        created_at: string;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string
                            | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        id: string;
                        locked: boolean;
                        members_count: number;
                        membership_required: boolean;
                        note: string;
                        owner: { id: string }
                        | null;
                        relationship:
                            | {
                                id: string;
                                member: boolean;
                                requested: boolean;
                                role?: OWNER
                                | ADMIN
                                | MODERATOR
                                | USER;
                            }
                            | null;
                        statuses_visibility: string;
                        uri: string;
                        url: string;
                    },
                >;
                unsuspendGroup: (
                    groupId: string,
                ) => Promise<
                    {
                        avatar: string;
                        avatar_default: boolean;
                        avatar_description: string;
                        avatar_static: string;
                        created_at: string;
                        display_name: string;
                        domain: string;
                        emojis: {
                            category: string
                            | null;
                            shortcode: string;
                            static_url: string;
                            url: string;
                            visible_in_picker: boolean;
                        }[];
                        header: string;
                        header_default: boolean;
                        header_description: string;
                        header_static: string;
                        id: string;
                        locked: boolean;
                        members_count: number;
                        membership_required: boolean;
                        note: string;
                        owner: { id: string }
                        | null;
                        relationship:
                            | {
                                id: string;
                                member: boolean;
                                requested: boolean;
                                role?: OWNER
                                | ADMIN
                                | MODERATOR
                                | USER;
                            }
                            | null;
                        statuses_visibility: string;
                        uri: string;
                        url: string;
                    },
                >;
            };
        }
        • groups: {
              deleteGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
              getGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
              getGroups: (
                  params?: AdminGetGroupsParams,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  }[],
              >;
              suspendGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
              unsuspendGroup: (
                  groupId: string,
              ) => Promise<
                  {
                      avatar: string;
                      avatar_default: boolean;
                      avatar_description: string;
                      avatar_static: string;
                      created_at: string;
                      display_name: string;
                      domain: string;
                      emojis: {
                          category: string
                          | null;
                          shortcode: string;
                          static_url: string;
                          url: string;
                          visible_in_picker: boolean;
                      }[];
                      header: string;
                      header_default: boolean;
                      header_description: string;
                      header_static: string;
                      id: string;
                      locked: boolean;
                      members_count: number;
                      membership_required: boolean;
                      note: string;
                      owner: { id: string }
                      | null;
                      relationship:
                          | {
                              id: string;
                              member: boolean;
                              requested: boolean;
                              role?: OWNER
                              | ADMIN
                              | MODERATOR
                              | USER;
                          }
                          | null;
                      statuses_visibility: string;
                      uri: string;
                      url: string;
                  },
              >;
          }
          • deleteGroup: (
                groupId: string,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >

            deletes an already-suspended group

          • getGroup: (
                groupId: string,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >

            return basic group information

          • getGroups: (
                params?: AdminGetGroupsParams,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                }[],
            >

            list groups known to the instance. Mimics the interface of /api/v1/admin/accounts

          • suspendGroup: (
                groupId: string,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >

            suspends a group

          • unsuspendGroup: (
                groupId: string,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >

            lift a suspension

      • groups: {
            acceptGroupMembershipRequest: (
                groupId: string,
                accountId: string,
            ) => Promise<EmptyObject>;
            blockGroupUsers: (
                groupId: string,
                accountIds: string[],
            ) => Promise<EmptyObject>;
            createGroup: (
                params: CreateGroupParams,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >;
            deleteGroup: (groupId: string) => Promise<EmptyObject>;
            deleteGroupStatus: (groupId: string, statusId: string) => Promise<Status>;
            demoteGroupUsers: (
                groupId: string,
                accountIds: string[],
                role: "owner" | "admin" | "moderator" | "user",
            ) => 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;
                    id: string;
                    role: GroupRoles;
                }[],
            >;
            getGroup: (
                groupId: string,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >;
            getGroupBlocks: (
                groupId: string,
                params?: GetGroupBlocksParams,
            ) => Promise<PaginatedResponse<Account, true>>;
            getGroupMembershipRequests: (
                groupId: string,
                params?: GetGroupMembershipRequestsParams,
            ) => Promise<PaginatedResponse<Account, true>>;
            getGroupMemberships: (
                groupId: string,
                role?: "owner" | "admin" | "moderator" | "user",
                params?: GetGroupMembershipsParams,
            ) => 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: 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;
                        id: string;
                        role: GroupRoles;
                    },
                    true,
                >,
            >;
            getGroupRelationships: (
                groupIds: string[],
            ) => Promise<
                {
                    id: string;
                    member: boolean;
                    requested: boolean;
                    role?: OWNER
                    | ADMIN
                    | MODERATOR
                    | USER;
                }[],
            >;
            getGroups: () => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                }[],
            >;
            joinGroup: (
                groupId: string,
            ) => Promise<
                {
                    id: string;
                    member: boolean;
                    requested: boolean;
                    role?: OWNER
                    | ADMIN
                    | MODERATOR
                    | USER;
                },
            >;
            kickGroupUsers: (
                groupId: string,
                accountIds: string[],
            ) => Promise<EmptyObject>;
            leaveGroup: (
                groupId: string,
            ) => Promise<
                {
                    id: string;
                    member: boolean;
                    requested: boolean;
                    role?: OWNER
                    | ADMIN
                    | MODERATOR
                    | USER;
                },
            >;
            promoteGroupUsers: (
                groupId: string,
                accountIds: string[],
                role: "owner" | "admin" | "moderator" | "user",
            ) => 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;
                    id: string;
                    role: GroupRoles;
                }[],
            >;
            rejectGroupMembershipRequest: (
                groupId: string,
                accountId: string,
            ) => Promise<EmptyObject>;
            unblockGroupUsers: (
                groupId: string,
                accountIds: string[],
            ) => Promise<EmptyObject>;
            updateGroup: (
                groupId: string,
                params: UpdateGroupParams,
            ) => Promise<
                {
                    avatar: string;
                    avatar_default: boolean;
                    avatar_description: string;
                    avatar_static: string;
                    created_at: string;
                    display_name: string;
                    domain: string;
                    emojis: {
                        category: string
                        | null;
                        shortcode: string;
                        static_url: string;
                        url: string;
                        visible_in_picker: boolean;
                    }[];
                    header: string;
                    header_default: boolean;
                    header_description: string;
                    header_static: string;
                    id: string;
                    locked: boolean;
                    members_count: number;
                    membership_required: boolean;
                    note: string;
                    owner: { id: string }
                    | null;
                    relationship:
                        | {
                            id: string;
                            member: boolean;
                            requested: boolean;
                            role?: OWNER
                            | ADMIN
                            | MODERATOR
                            | USER;
                        }
                        | null;
                    statuses_visibility: string;
                    uri: string;
                    url: string;
                },
            >;
        }
        • acceptGroupMembershipRequest: (groupId: string, accountId: string) => Promise<EmptyObject>

          accept a pending request to become a group member

        • blockGroupUsers: (groupId: string, accountIds: string[]) => Promise<EmptyObject>

          block one or more users. If they were in the group, they are also kicked of it

        • createGroup: (
              params: CreateGroupParams,
          ) => Promise<
              {
                  avatar: string;
                  avatar_default: boolean;
                  avatar_description: string;
                  avatar_static: string;
                  created_at: string;
                  display_name: string;
                  domain: string;
                  emojis: {
                      category: string
                      | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  header: string;
                  header_default: boolean;
                  header_description: string;
                  header_static: string;
                  id: string;
                  locked: boolean;
                  members_count: number;
                  membership_required: boolean;
                  note: string;
                  owner: { id: string }
                  | null;
                  relationship:
                      | {
                          id: string;
                          member: boolean;
                          requested: boolean;
                          role?: OWNER
                          | ADMIN
                          | MODERATOR
                          | USER;
                      }
                      | null;
                  statuses_visibility: string;
                  uri: string;
                  url: string;
              },
          >

          create a group with the given attributes (display_name, note, avatar and header). Sets the user who made the request as group administrator

        • deleteGroup: (groupId: string) => Promise<EmptyObject>

          irreversibly deletes the group

        • deleteGroupStatus: (groupId: string, statusId: string) => Promise<Status>

          delete a group post (actually marks it as revoked if it is a local post)

        • demoteGroupUsers: (
              groupId: string,
              accountIds: string[],
              role: "owner" | "admin" | "moderator" | "user",
          ) => 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;
                  id: string;
                  role: GroupRoles;
              }[],
          >

          demote one or more accounts to role new_role. Returns an error unless every of the target account has a strictly lower role than the user (you cannot demote someone with the same role as you), or if any target account already has a role lower than new_role. Valid roles are admin, moderator and user.

        • getGroup: (
              groupId: string,
          ) => Promise<
              {
                  avatar: string;
                  avatar_default: boolean;
                  avatar_description: string;
                  avatar_static: string;
                  created_at: string;
                  display_name: string;
                  domain: string;
                  emojis: {
                      category: string
                      | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  header: string;
                  header_default: boolean;
                  header_description: string;
                  header_static: string;
                  id: string;
                  locked: boolean;
                  members_count: number;
                  membership_required: boolean;
                  note: string;
                  owner: { id: string }
                  | null;
                  relationship:
                      | {
                          id: string;
                          member: boolean;
                          requested: boolean;
                          role?: OWNER
                          | ADMIN
                          | MODERATOR
                          | USER;
                      }
                      | null;
                  statuses_visibility: string;
                  uri: string;
                  url: string;
              },
          >

          returns the Group entity describing a given group

        • getGroupBlocks: (
              groupId: string,
              params?: GetGroupBlocksParams,
          ) => Promise<PaginatedResponse<Account, true>>

          list accounts blocked from interacting with the group

        • getGroupMembershipRequests: (
              groupId: string,
              params?: GetGroupMembershipRequestsParams,
          ) => Promise<PaginatedResponse<Account, true>>

          returns an array of Account entities representing pending requests to join a group

        • getGroupMemberships: (
              groupId: string,
              role?: "owner" | "admin" | "moderator" | "user",
              params?: GetGroupMembershipsParams,
          ) => 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: 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;
                      id: string;
                      role: GroupRoles;
                  },
                  true,
              >,
          >

          Has an optional role attribute that can be used to filter by role (valid roles are "admin", "moderator", "user").

        • getGroupRelationships: (
              groupIds: string[],
          ) => Promise<
              {
                  id: string;
                  member: boolean;
                  requested: boolean;
                  role?: OWNER
                  | ADMIN
                  | MODERATOR
                  | USER;
              }[],
          >
        • getGroups: () => Promise<
              {
                  avatar: string;
                  avatar_default: boolean;
                  avatar_description: string;
                  avatar_static: string;
                  created_at: string;
                  display_name: string;
                  domain: string;
                  emojis: {
                      category: string
                      | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  header: string;
                  header_default: boolean;
                  header_description: string;
                  header_static: string;
                  id: string;
                  locked: boolean;
                  members_count: number;
                  membership_required: boolean;
                  note: string;
                  owner: { id: string }
                  | null;
                  relationship:
                      | {
                          id: string;
                          member: boolean;
                          requested: boolean;
                          role?: OWNER
                          | ADMIN
                          | MODERATOR
                          | USER;
                      }
                      | null;
                  statuses_visibility: string;
                  uri: string;
                  url: string;
              }[],
          >

          returns an array of Group entities the current user is a member of

        • joinGroup: (
              groupId: string,
          ) => Promise<
              {
                  id: string;
                  member: boolean;
                  requested: boolean;
                  role?: OWNER
                  | ADMIN
                  | MODERATOR
                  | USER;
              },
          >

          joins (or request to join) a given group

        • kickGroupUsers: (groupId: string, accountIds: string[]) => Promise<EmptyObject>

          kick one or more group members

        • leaveGroup: (
              groupId: string,
          ) => Promise<
              {
                  id: string;
                  member: boolean;
                  requested: boolean;
                  role?: OWNER
                  | ADMIN
                  | MODERATOR
                  | USER;
              },
          >

          leaves a given group

        • promoteGroupUsers: (
              groupId: string,
              accountIds: string[],
              role: "owner" | "admin" | "moderator" | "user",
          ) => 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;
                  id: string;
                  role: GroupRoles;
              }[],
          >

          promote one or more accounts to role new_role. An error is returned if any of those accounts has a higher role than new_role already, or if the role is higher than the issuing user's. Valid roles are admin, and moderator and user.

        • rejectGroupMembershipRequest: (groupId: string, accountId: string) => Promise<EmptyObject>

          reject a pending request to become a group member

        • unblockGroupUsers: (groupId: string, accountIds: string[]) => Promise<EmptyObject>

          block one or more users. If they were in the group, they are also kicked of it

        • updateGroup: (
              groupId: string,
              params: UpdateGroupParams,
          ) => Promise<
              {
                  avatar: string;
                  avatar_default: boolean;
                  avatar_description: string;
                  avatar_static: string;
                  created_at: string;
                  display_name: string;
                  domain: string;
                  emojis: {
                      category: string
                      | null;
                      shortcode: string;
                      static_url: string;
                      url: string;
                      visible_in_picker: boolean;
                  }[];
                  header: string;
                  header_default: boolean;
                  header_description: string;
                  header_static: string;
                  id: string;
                  locked: boolean;
                  members_count: number;
                  membership_required: boolean;
                  note: string;
                  owner: { id: string }
                  | null;
                  relationship:
                      | {
                          id: string;
                          member: boolean;
                          requested: boolean;
                          role?: OWNER
                          | ADMIN
                          | MODERATOR
                          | USER;
                      }
                      | null;
                  statuses_visibility: string;
                  uri: string;
                  url: string;
              },
          >

          update group attributes (display_name, note, avatar and header)