settings

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

SyncAsync

UserSettings

The user.settings namespace.

get

get() -> UserSettings

Get current user's account settings.

Returns:

Type	Description
`UserSettings`	UserSettings.

Raises:

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

Operation ID: getUserSettings

update

update(
    *,
    description: str | None = None,
    diff_view_style: str | None = None,
    enable_repo_unit_hints: bool | None = None,
    full_name: str | None = None,
    hide_activity: bool | None = None,
    hide_email: bool | None = None,
    hide_pronouns: bool | None = None,
    language: str | None = None,
    location: str | None = None,
    pronouns: str | None = None,
    theme: str | None = None,
    website: str | None = None,
) -> UserSettings

Update settings in current user's account.

Parameters:

Name	Type	Description	Default
`description`	`str \| None`		`None`
`diff_view_style`	`str \| None`		`None`
`enable_repo_unit_hints`	`bool \| None`		`None`
`full_name`	`str \| None`		`None`
`hide_activity`	`bool \| None`		`None`
`hide_email`	`bool \| None`	Privacy	`None`
`hide_pronouns`	`bool \| None`		`None`
`language`	`str \| None`		`None`
`location`	`str \| None`		`None`
`pronouns`	`str \| None`		`None`
`theme`	`str \| None`		`None`
`website`	`str \| None`		`None`

Returns:

Type	Description
`UserSettings`	UserSettings.

Raises:

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

Operation ID: updateUserSettings

AsyncUserSettings

The user.settings namespace.

get

get() -> UserSettings

Get current user's account settings.

Returns:

Type	Description
`UserSettings`	UserSettings.

Raises:

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

Operation ID: getUserSettings

update

update(
    *,
    description: str | None = None,
    diff_view_style: str | None = None,
    enable_repo_unit_hints: bool | None = None,
    full_name: str | None = None,
    hide_activity: bool | None = None,
    hide_email: bool | None = None,
    hide_pronouns: bool | None = None,
    language: str | None = None,
    location: str | None = None,
    pronouns: str | None = None,
    theme: str | None = None,
    website: str | None = None,
) -> UserSettings

Update settings in current user's account.

Parameters:

Name	Type	Description	Default
`description`	`str \| None`		`None`
`diff_view_style`	`str \| None`		`None`
`enable_repo_unit_hints`	`bool \| None`		`None`
`full_name`	`str \| None`		`None`
`hide_activity`	`bool \| None`		`None`
`hide_email`	`bool \| None`	Privacy	`None`
`hide_pronouns`	`bool \| None`		`None`
`language`	`str \| None`		`None`
`location`	`str \| None`		`None`
`pronouns`	`str \| None`		`None`
`theme`	`str \| None`		`None`
`website`	`str \| None`		`None`

Returns:

Type	Description
`UserSettings`	UserSettings.

Raises:

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

Operation ID: updateUserSettings