Skip to content

following

Accessed as client.user.following; the async client mirrors it.

UserFollowing

The user.following namespace.

add 

add(username: str) -> None

Follow a user.

Parameters:

Name Type Description Default
username str

username of user to follow

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentPutFollow

get 

get(username: str) -> None

Check whether a user is followed by the authenticated user.

Parameters:

Name Type Description Default
username str

username of followed user

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentCheckFollowing

list 

list(*, page: int | None = None, limit: int | None = None) -> Paginated[User]

List the users that the authenticated user is following.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

 None
limit int | None

Page size; the instance caps it server-side.

 None

Returns:

Type Description
Paginated[User]

UserList.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userCurrentListFollowing

remove 

remove(username: str) -> None

Unfollow a user.

Parameters:

Name Type Description Default
username str

username of user to unfollow

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentDeleteFollow

AsyncUserFollowing

The user.following namespace.

add 

add(username: str) -> None

Follow a user.

Parameters:

Name Type Description Default
username str

username of user to follow

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentPutFollow

get 

get(username: str) -> None

Check whether a user is followed by the authenticated user.

Parameters:

Name Type Description Default
username str

username of followed user

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentCheckFollowing

list 

list(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[User]

List the users that the authenticated user is following.

Parameters:

Name Type Description Default
page int | None

1-based page to start iteration at.

 None
limit int | None

Page size; the instance caps it server-side.

 None

Returns:

Type Description
AsyncPaginated[User]

UserList.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: userCurrentListFollowing

remove 

remove(username: str) -> None

Unfollow a user.

Parameters:

Name Type Description Default
username str

username of user to unfollow

 required

Returns:

Type Description
None

No content.

Raises:

Type Description
UnauthorizedError
  1. APIUnauthorizedError is a unauthorized error response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.

Operation ID: userCurrentDeleteFollow