Interface AccountRepository

familiarFollowers

relationships

search

$select

• $select(id): {
      featuredTags: {
          list(meta?): Paginator<FeaturedTag[], undefined>;
      };
      followers: {
          list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      };
      following: {
          list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      };
      identityProofs: {
          list(meta?): Paginator<IdentityProof[], undefined>;
      };
      lists: {
          list(meta?): Paginator<List[], undefined>;
      };
      note: {
          create(params, meta?): Promise<Relationship>;
      };
      statuses: {
          list(params?, meta?): Paginator<Status[], ListAccountStatusesParams>;
      };
      block(meta?): Promise<Relationship>;
      fetch(meta?): Promise<mastodon.v1.Account>;
      follow(params?, meta?): Promise<Relationship>;
      mute(params?, meta?): Promise<Relationship>;
      pin(meta?): Promise<Relationship>;
      removeFromFollowers(meta?): Promise<void>;
      unblock(meta?): Promise<Relationship>;
      unfollow(params?, meta?): Promise<Relationship>;
      unmute(meta?): Promise<Relationship>;
      unpin(meta?): Promise<Relationship>;
  }

• Parameters

  • id: string

  Returns {
      featuredTags: {
          list(meta?): Paginator<FeaturedTag[], undefined>;
      };
      followers: {
          list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      };
      following: {
          list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      };
      identityProofs: {
          list(meta?): Paginator<IdentityProof[], undefined>;
      };
      lists: {
          list(meta?): Paginator<List[], undefined>;
      };
      note: {
          create(params, meta?): Promise<Relationship>;
      };
      statuses: {
          list(params?, meta?): Paginator<Status[], ListAccountStatusesParams>;
      };
      block(meta?): Promise<Relationship>;
      fetch(meta?): Promise<mastodon.v1.Account>;
      follow(params?, meta?): Promise<Relationship>;
      mute(params?, meta?): Promise<Relationship>;
      pin(meta?): Promise<Relationship>;
      removeFromFollowers(meta?): Promise<void>;
      unblock(meta?): Promise<Relationship>;
      unfollow(params?, meta?): Promise<Relationship>;
      unmute(meta?): Promise<Relationship>;
      unpin(meta?): Promise<Relationship>;
  }

  • featuredTags: {
        list(meta?): Paginator<FeaturedTag[], undefined>;
    }

    • list:function

      • list(meta?): Paginator<FeaturedTag[], undefined>

      • Get featured tag of the account

        Parameters

        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<FeaturedTag[], undefined>

        FeaturedTags

  • followers: {
        list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
    }

    • list:function

      • list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>

      • Accounts which follow the given account, if network is not hidden by the account owner.

        Parameters

        • Optional params: DefaultPaginationParams

          Parameters
        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>

        Array of Account

        See

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

  • following: {
        list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
    }

    • list:function

      • list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>

      • Accounts which the given account is following, if network is not hidden by the account owner.

        Parameters

        • Optional params: DefaultPaginationParams

          Parameters
        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>

        Array of Account

        See

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

  • identityProofs: {
        list(meta?): Paginator<IdentityProof[], undefined>;
    }

    • list:function

      • list(meta?): Paginator<IdentityProof[], undefined>

      • Identity proofs

        Parameters

        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<IdentityProof[], undefined>

        Array of IdentityProof

        See

        https://github.com/tootsuite/mastodon/pull/10297

  • lists: {
        list(meta?): Paginator<List[], undefined>;
    }

    • list:function

      • list(meta?): Paginator<List[], undefined>

      • Fetch the list with the given ID. Used for verifying the title of a list.

        Parameters

        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<List[], undefined>

        Array of List

        See

        https://docs.joinmastodon.org/methods/timelines/lists/

  • note: {
        create(params, meta?): Promise<Relationship>;
    }

    • create:function

      • create(params, meta?): Promise<Relationship>

      • Add personal note to the account

        Parameters

        • params: CreateAccountNoteParams
        • Optional meta: HttpMetaParams<"json">

        Returns Promise<Relationship>

        Relationship

  • statuses: {
        list(params?, meta?): Paginator<Status[], ListAccountStatusesParams>;
    }

    • list:function

      • list(params?, meta?): Paginator<Status[], ListAccountStatusesParams>

      • Statuses posted to the given account.

        Parameters

        • Optional params: ListAccountStatusesParams

          Parameters
        • Optional meta: HttpMetaParams<"none">

        Returns Paginator<Status[], ListAccountStatusesParams>

        Array of Status

        See

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

  • block:function

    • block(meta?): Promise<Relationship>

    • Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline)

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<Relationship>

      Relationship

      See

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

  • fetch:function

    • fetch(meta?): Promise<mastodon.v1.Account>

    • View information about a profile.

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<mastodon.v1.Account>

      Account

      See

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

  • follow:function

    • follow(params?, meta?): Promise<Relationship>

    • Follow the given account.

      Parameters

      • Optional params: FollowAccountParams

        Parameters
      • Optional meta: HttpMetaParams<"json">

      Returns Promise<Relationship>

      Relationship

      See

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

  • mute:function

    • mute(params?, meta?): Promise<Relationship>

    • Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. due to a boost in the Home timeline).

      Parameters

      • Optional params: MuteAccountParams

        Parameter
      • Optional meta: HttpMetaParams<"json">

      Returns Promise<Relationship>

      Relationship

      See

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

  • pin:function

    • pin(meta?): Promise<Relationship>

    • Add the given account to the user's featured profiles. (Featured profiles are currently shown on the user's own public profile.)

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<Relationship>

      Relationship

      See

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

  • removeFromFollowers:function

    • removeFromFollowers(meta?): Promise<void>

    • Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<void>

      N/A

  • unblock:function

    • unblock(meta?): Promise<Relationship>

    • Unblock the given account.

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<Relationship>

      Relationship

      See

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

  • unfollow:function

    • unfollow(params?, meta?): Promise<Relationship>

    • Unfollow the given account

      Parameters

      • Optional params: FollowAccountParams
      • Optional meta: HttpMetaParams<"json">

      Returns Promise<Relationship>

      Relationship

      See

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

  • unmute:function

    • unmute(meta?): Promise<Relationship>

    • Unmute the given account.

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<Relationship>

      Relationship

      See

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

  • unpin:function

    • unpin(meta?): Promise<Relationship>

    • Remove the given account from the user's featured profiles.

      Parameters

      • Optional meta: HttpMetaParams<"none">

      Returns Promise<Relationship>

      Relationship

      See

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

create

• create(params, meta?): Promise<Token>

• 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.

  Parameters

  • params: CreateAccountParams

    Parameters
  • Optional meta: HttpMetaParams<"multipart-form">

  Returns Promise<Token>

  Token

  See

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

lookup

• lookup(params, meta?): Promise<mastodon.v1.Account>

• This method allows to quickly convert a username of a known account to an ID that can be used with the REST API, or to check if a username is available for sign-up

  Parameters

  • params: LookupAccountParams

    Parameters
  • Optional meta: HttpMetaParams<"none">

  Returns Promise<mastodon.v1.Account>

  Account

updateCredentials

• updateCredentials(params, meta?): Promise<AccountCredentials>

• Update the user's display and preferences.

  Parameters

  • params: UpdateCredentialsParams

    Parameters
  • Optional meta: HttpMetaParams<"multipart-form">

  Returns Promise<AccountCredentials>

  the user's own Account with Source

  See

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

verifyCredentials

• verifyCredentials(meta?): Promise<AccountCredentials>

• Test to make sure that the user token works.

  Parameters

  • Optional meta: HttpMetaParams<"none">

  Returns Promise<AccountCredentials>

  the user's own Account with Source

  See

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