Function settingsCategory

Returns {
    addAccountAlias: (alias: string) => Promise<{ status: "success" }>;
    authorizeIceshrimp: () => Promise<string>;
    changeEmail: (email: string, password: string) => Promise<EmptyObject>;
    changePassword: (
        current_password: string,
        new_password: string,
    ) => Promise<EmptyObject>;
    createAccount: (
        params: CreateAccountParams,
    ) => Promise<
        | {
            access_token: string;
            created_at?: number;
            expires_in?: number;
            id?: string;
            me?: string;
            refresh_token?: string;
            scope: string;
            token_type: string;
        }
        | { identifier: string; message: string },
    >;
    createBackup: () => Promise<
        {
            content_type: string;
            file_size: number;
            id: string;
            inserted_at: string;
            processed: boolean;
            url: string;
        },
    >;
    deleteAccount: (password: string) => Promise<EmptyObject>;
    deleteAccountAlias: (alias: string) => Promise<{ status: "success" }>;
    deleteAccountWithoutPassword: () => Promise<EmptyObject>;
    deleteAvatar: () => Promise<CredentialAccount>;
    deleteHeader: () => Promise<CredentialAccount>;
    deleteOauthToken: (oauthTokenId: string) => Promise<EmptyObject>;
    disableAccount: (password: string) => Promise<EmptyObject>;
    exportBlocks: () => Promise<string>;
    exportFollowers: () => Promise<string>;
    exportFollows: () => Promise<string>;
    exportLists: () => Promise<string>;
    exportMutes: () => Promise<string>;
    getAccountAliases: () => Promise<{ aliases: string[] }>;
    getAvailableFrontends: () => Promise<string[]>;
    getBackups: () => Promise<
        {
            content_type: string;
            file_size: number;
            id: string;
            inserted_at: string;
            processed: boolean;
            url: string;
        }[],
    >;
    getInteractionPolicies: () => Promise<
        {
            direct: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            private: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            public: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            unlisted: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
        },
    >;
    getOauthTokens: () => Promise<
        PaginatedResponse<
            {
                app_name: string;
                app_website: string;
                created_at: string
                | null;
                id: string;
                is_current: boolean | null;
                last_used: string | null;
                scopes: string[];
                valid_until: string | null;
            },
            true,
        >,
    >;
    getPreferences: () => Promise<Record<string, any>>;
    importBlocks: (
        list: string | File,
        mode?: "merge" | "overwrite",
    ) => Promise<any>;
    importFollowers: (list: string | File, actorId: string) => Promise<any>;
    importFollows: (
        list: string | File,
        mode?: "merge" | "overwrite",
    ) => Promise<any>;
    importMutes: (
        list: string | File,
        mode?: "merge" | "overwrite",
    ) => Promise<any>;
    mfa: {
        confirmMfaSetup: (
            method: "totp",
            code: string,
            password: string,
        ) => Promise<EmptyObject>;
        disableMfa: (method: "totp", password: string) => Promise<EmptyObject>;
        getMfaBackupCodes: () => Promise<{ codes: string[] }>;
        getMfaSettings: () => Promise<
            { settings: { enabled: boolean; totp: boolean } },
        >;
        getMfaSetup: (
            method: "totp",
        ) => Promise<{ key: string; provisioning_uri: string }>;
    };
    moveAccount: (
        target_account: string,
        password: string,
    ) => Promise<EmptyObject>;
    resetPassword: (email?: string, nickname?: string) => Promise<EmptyObject>;
    setPreferredFrontend: (
        frontendName: string,
    ) => Promise<{ frontend_name: string }>;
    updateCredentials: (
        params: UpdateCredentialsParams,
    ) => Promise<CredentialAccount>;
    updateInteractionPolicies: (
        params: UpdateInteractionPoliciesParams,
    ) => Promise<
        {
            direct: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            private: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            public: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
            unlisted: {
                can_favourite: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reblog: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
                can_reply: {
                    automatic_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                    manual_approval: (
                        | "following"
                        | "me"
                        | "public"
                        | "followers"
                        | "mutuals"
                        | "mentioned"
                        | "author"
                    )[];
                };
            };
        },
    >;
    updateNotificationSettings: (
        params: UpdateNotificationSettingsParams,
    ) => Promise<{ status: string }>;
    verifyCredentials: () => Promise<CredentialAccount>;
}

• addAccountAlias: (alias: string) => Promise<{ status: "success" }>

  Add alias to the current account

  Requires featuresFeatures.manageAccountAliases.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#add-alias-to-the-current-account

• authorizeIceshrimp: () => Promise<string>

• changeEmail: (email: string, password: string) => Promise<EmptyObject>

  Requires featuresFeatures.changeEmail.

• changePassword: (current_password: string, new_password: string) => Promise<EmptyObject>

  Change account password

  Requires featuresFeatures.changePassword.

  See

  • https://docs.gotosocial.org/en/latest/api/swagger
  • https://codeberg.org/silverpill/mitra/src/commit/f15c19527191d82bc3643f984deca43d1527525d/docs/openapi.yaml
  • https://git.pleroma.social/pleroma/pleroma/-/blob/develop/lib/pleroma/web/api_spec/operations/twitter_util_operation.ex?ref_type=heads#L68

• createAccount: (
      params: CreateAccountParams,
  ) => Promise<
      | {
          access_token: string;
          created_at?: number;
          expires_in?: number;
          id?: string;
          me?: string;
          refresh_token?: string;
          scope: string;
          token_type: string;
      }
      | { identifier: string; message: string },
  >

  Register an account Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.

  Requires featuresFeatures.accountCreation

  See

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

• createBackup: () => Promise<
      {
          content_type: string;
          file_size: number;
          id: string;
          inserted_at: string;
          processed: boolean;
          url: string;
      },
  >

  Create a user backup archive

  Requires featuresFeatures.accountBackups.

• deleteAccount: (password: string) => Promise<EmptyObject>

  Requires featuresFeatures.deleteAccount.

• deleteAccountAlias: (alias: string) => Promise<{ status: "success" }>

  Delete alias from the current account

  Requires featuresFeatures.manageAccountAliases.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#delete-alias-from-the-current-account

• deleteAccountWithoutPassword: () => Promise<EmptyObject>

  Requires featuresFeatures.deleteAccountWithoutPassword.

• deleteAvatar: () => Promise<CredentialAccount>

  Delete profile avatar Deletes the avatar associated with the user’s profile.

  See

  https://docs.joinmastodon.org/methods/profile/#delete-profile-avatar

• deleteHeader: () => Promise<CredentialAccount>

  Delete profile header Deletes the header image associated with the user’s profile.

  See

  https://docs.joinmastodon.org/methods/profile/#delete-profile-header

• deleteOauthToken: (oauthTokenId: string) => Promise<EmptyObject>

  Revoke a user session by its ID

  Requires featuresFeatures.sessions.

  See

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

• disableAccount: (password: string) => Promise<EmptyObject>

  Disable an account

  Requires featuresFeatures.disableAccount.

• exportBlocks: () => Promise<string>

  Export blocks to CSV file

  Requires featuresFeatures.exportBlocks.

• exportFollowers: () => Promise<string>

  Export followers to CSV file

  Requires featuresFeatures.exportFollowers.

• exportFollows: () => Promise<string>

  Export follows to CSV file

  Requires featuresFeatures.exportFollows.

• exportLists: () => Promise<string>

  Export lists to CSV file

  Requires featuresFeatures.exportLists.

• exportMutes: () => Promise<string>

  Export mutes to CSV file

  Requires featuresFeatures.exportMutes.

• getAccountAliases: () => Promise<{ aliases: string[] }>

  Get aliases of the current account

  Requires featuresFeatures.manageAccountAliases.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#get-aliases-of-the-current-account

• getAvailableFrontends: () => Promise<string[]>

  List frontend setting profiles

  Requires featuresFeatures.preferredFrontends.

• getBackups: () => Promise<
      {
          content_type: string;
          file_size: number;
          id: string;
          inserted_at: string;
          processed: boolean;
          url: string;
      }[],
  >

  List user backups

  Requires featuresFeatures.accountBackups.

• getInteractionPolicies: () => Promise<
      {
          direct: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          private: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          public: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          unlisted: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
      },
  >

  Get default interaction policies for new statuses created by you.

  Requires featuresFeatures.interactionRequests.

  See

  https://docs.gotosocial.org/en/latest/api/swagger/

• getOauthTokens: () => Promise<
      PaginatedResponse<
          {
              app_name: string;
              app_website: string;
              created_at: string
              | null;
              id: string;
              is_current: boolean | null;
              last_used: string | null;
              scopes: string[];
              valid_until: string | null;
          },
          true,
      >,
  >

  Retrieve a list of active sessions for the user

  Requires featuresFeatures.sessions.

  See

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

• getPreferences: () => Promise<Record<string, any>>

  View user preferences Preferences defined by the user in their account settings.

  See

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

• importBlocks: (list: string | File, mode?: "merge" | "overwrite") => Promise<any>

  Imports your blocks.

  Requires featuresFeatures.importBlocks. overwrite mode requires featuresFeatures.importOverwrite.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apipleromablocks_import

• importFollowers: (list: string | File, actorId: string) => Promise<any>

  Move followers from remote alias. (experimental?)

  Requires featuresFeatures.importFollowers.

• importFollows: (list: string | File, mode?: "merge" | "overwrite") => Promise<any>

  Imports your follows, for example from a Mastodon CSV file.

  Requires featuresFeatures.importFollows. overwrite mode requires featuresFeatures.importOverwrite.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apipleromafollow_import

• importMutes: (list: string | File, mode?: "merge" | "overwrite") => Promise<any>

  Imports your mutes.

  Requires featuresFeatures.importMutes. overwrite mode requires featuresFeatures.importOverwrite.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apipleromamutes_import

• mfa: {
      confirmMfaSetup: (
          method: "totp",
          code: string,
          password: string,
      ) => Promise<EmptyObject>;
      disableMfa: (method: "totp", password: string) => Promise<EmptyObject>;
      getMfaBackupCodes: () => Promise<{ codes: string[] }>;
      getMfaSettings: () => Promise<
          { settings: { enabled: boolean; totp: boolean } },
      >;
      getMfaSetup: (
          method: "totp",
      ) => Promise<{ key: string; provisioning_uri: string }>;
  }

  • confirmMfaSetup: (method: "totp", code: string, password: string) => Promise<EmptyObject>

    Requires featuresFeatures.manageMfa.

  • disableMfa: (method: "totp", password: string) => Promise<EmptyObject>

    Requires featuresFeatures.manageMfa.

  • getMfaBackupCodes: () => Promise<{ codes: string[] }>

    Requires featuresFeatures.manageMfa.

  • getMfaSettings: () => Promise<{ settings: { enabled: boolean; totp: boolean } }>

    Requires featuresFeatures.manageMfa.

  • getMfaSetup: (method: "totp") => Promise<{ key: string; provisioning_uri: string }>

    Requires featuresFeatures.manageMfa.

• moveAccount: (target_account: string, password: string) => Promise<EmptyObject>

  Requires featuresFeatures.accountMoving.

• resetPassword: (email?: string, nickname?: string) => Promise<EmptyObject>

  Request password reset e-mail

  Requires featuresFeatures.resetPassword.

• setPreferredFrontend: (frontendName: string) => Promise<{ frontend_name: string }>

  Update preferred frontend setting

  Store preferred frontend in cookies

  Requires featuresFeatures.preferredFrontends.

• updateCredentials: (params: UpdateCredentialsParams) => Promise<CredentialAccount>

  Update account credentials Update the user’s display and preferences.

  See

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

• updateInteractionPolicies: (
      params: UpdateInteractionPoliciesParams,
  ) => Promise<
      {
          direct: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          private: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          public: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
          unlisted: {
              can_favourite: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reblog: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
              can_reply: {
                  automatic_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
                  manual_approval: (
                      | "following"
                      | "me"
                      | "public"
                      | "followers"
                      | "mutuals"
                      | "mentioned"
                      | "author"
                  )[];
              };
          };
      },
  >

  Update default interaction policies per visibility level for new statuses created by you.

  Requires featuresFeatures.interactionRequests.

  See

  https://docs.gotosocial.org/en/latest/api/swagger/

• updateNotificationSettings: (params: UpdateNotificationSettingsParams) => Promise<{ status: string }>

  Updates user notification settings

  Requires featuresFeatures.muteStrangers.

  See

  https://docs.pleroma.social/backend/development/API/pleroma_api/#apipleromanotification_settings

• verifyCredentials: () => Promise<CredentialAccount>

  Verify account credentials Test to make sure that the user token works.

  See

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