user

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

SyncAsync

User

The user namespace.

actions

actions: UserActions = UserActions(client)

activitypub

activitypub: UserActivitypub = UserActivitypub(client)

applications

applications: UserApplications = UserApplications(client)

avatar

avatar: UserAvatar = UserAvatar(client)

emails

emails: UserEmails = UserEmails(client)

following

following: UserFollowing = UserFollowing(client)

gpg_keys

gpg_keys: UserGpgKeys = UserGpgKeys(client)

hooks

hooks: UserHooks = UserHooks(client)

keys

keys: UserKeys = UserKeys(client)

quota

quota: UserQuota = UserQuota(client)

repos

repos: UserRepos = UserRepos(client)

settings

settings: UserSettings = UserSettings(client)

starred

starred: UserStarred = UserStarred(client)

block

block(username: str) -> None

Blocks a user from the doer.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of the user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userBlockUser

followers

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

List the authenticated user's followers.

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`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userCurrentListFollowers

get

get() -> User

Get the authenticated user.

Returns:

Type	Description
`User`	User.

Raises:

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

Operation ID: userGetCurrent

gpg_key_token

gpg_key_token() -> str

Get a Token to verify.

Returns:

Type	Description
`str`	APIString is a string response.

Raises:

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

Operation ID: getVerificationToken

gpg_key_verify

gpg_key_verify(*, armored_signature: str | None = None, key_id: str) -> GPGKey

Verify a GPG key.

Parameters:

Name	Type	Description	Default
`armored_signature`	`str \| None`		`None`
`key_id`	`str`	An Signature for a GPG key token	required

Returns:

Type	Description
`GPGKey`	GPGKey.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userVerifyGPGKey

list_blocked

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

List the authenticated user's blocked users.

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[BlockedUser]`	BlockedUserList.

Raises:

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

Operation ID: userListBlockedUsers

orgs

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

List the current user's organizations.

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[Organization]`	OrganizationListWithoutPagination - Organizations without pagination headers.

Raises:

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

Operation ID: orgListCurrentUserOrgs

stopwatches

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

Get list of all existing stopwatches.

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[StopWatch]`	StopWatchList.

Raises:

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

Operation ID: userGetStopWatches

subscriptions

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

List repositories watched by the authenticated user.

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[Repository]`	RepositoryList.

Raises:

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

Operation ID: userCurrentListSubscriptions

teams

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

List all the teams a user belongs to.

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[Team]`	TeamList.

Raises:

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

Operation ID: userListTeams

times

times(
    *, since: datetime | None = None, before: datetime | None = None, page: int | None = None, limit: int | None = None
) -> Paginated[TrackedTime]

List the current user's tracked times.

Parameters:

Name	Type	Description	Default
`since`	`datetime \| None`	Only show times updated after the given time. This is a timestamp in RFC 3339 format	`None`
`before`	`datetime \| None`	Only show times updated before the given time. This is a timestamp in RFC 3339 format	`None`
`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[TrackedTime]`	TrackedTimeList.

Raises:

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

Operation ID: userCurrentTrackedTimes

unblock

unblock(username: str) -> None

Unblocks a user from the doer.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of the user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userUnblockUser

AsyncUser

The user namespace.

actions

actions: AsyncUserActions = AsyncUserActions(client)

activitypub

activitypub: AsyncUserActivitypub = AsyncUserActivitypub(client)

applications

applications: AsyncUserApplications = AsyncUserApplications(client)

avatar

avatar: AsyncUserAvatar = AsyncUserAvatar(client)

emails

emails: AsyncUserEmails = AsyncUserEmails(client)

following

following: AsyncUserFollowing = AsyncUserFollowing(client)

gpg_keys

gpg_keys: AsyncUserGpgKeys = AsyncUserGpgKeys(client)

hooks

hooks: AsyncUserHooks = AsyncUserHooks(client)

keys

keys: AsyncUserKeys = AsyncUserKeys(client)

quota

quota: AsyncUserQuota = AsyncUserQuota(client)

repos

repos: AsyncUserRepos = AsyncUserRepos(client)

settings

settings: AsyncUserSettings = AsyncUserSettings(client)

starred

starred: AsyncUserStarred = AsyncUserStarred(client)

block

block(username: str) -> None

Blocks a user from the doer.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of the user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userBlockUser

followers

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

List the authenticated user's followers.

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`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userCurrentListFollowers

get

get() -> User

Get the authenticated user.

Returns:

Type	Description
`User`	User.

Raises:

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

Operation ID: userGetCurrent

gpg_key_token

gpg_key_token() -> str

Get a Token to verify.

Returns:

Type	Description
`str`	APIString is a string response.

Raises:

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

Operation ID: getVerificationToken

gpg_key_verify

gpg_key_verify(*, armored_signature: str | None = None, key_id: str) -> GPGKey

Verify a GPG key.

Parameters:

Name	Type	Description	Default
`armored_signature`	`str \| None`		`None`
`key_id`	`str`	An Signature for a GPG key token	required

Returns:

Type	Description
`GPGKey`	GPGKey.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userVerifyGPGKey

list_blocked

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

List the authenticated user's blocked users.

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[BlockedUser]`	BlockedUserList.

Raises:

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

Operation ID: userListBlockedUsers

orgs

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

List the current user's organizations.

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[Organization]`	OrganizationListWithoutPagination - Organizations without pagination headers.

Raises:

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

Operation ID: orgListCurrentUserOrgs

stopwatches

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

Get list of all existing stopwatches.

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[StopWatch]`	StopWatchList.

Raises:

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

Operation ID: userGetStopWatches

subscriptions

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

List repositories watched by the authenticated user.

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[Repository]`	RepositoryList.

Raises:

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

Operation ID: userCurrentListSubscriptions

teams

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

List all the teams a user belongs to.

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[Team]`	TeamList.

Raises:

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

Operation ID: userListTeams

times

times(
    *, since: datetime | None = None, before: datetime | None = None, page: int | None = None, limit: int | None = None
) -> AsyncPaginated[TrackedTime]

List the current user's tracked times.

Parameters:

Name	Type	Description	Default
`since`	`datetime \| None`	Only show times updated after the given time. This is a timestamp in RFC 3339 format	`None`
`before`	`datetime \| None`	Only show times updated before the given time. This is a timestamp in RFC 3339 format	`None`
`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[TrackedTime]`	TrackedTimeList.

Raises:

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

Operation ID: userCurrentTrackedTimes

unblock

unblock(username: str) -> None

Unblocks a user from the doer.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of the user	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userUnblockUser