authenticated_user module

Authenticated user module.

class UpdateUserParams

Bases: TypedDict

Parameters for updating a user.

username : NotRequired[str]

The new username of the user.

name : NotRequired[str | None]

The new name of the user.

bio : NotRequired[str | None]

The new biography of the user.

urls : NotRequired[list[str] | None]

The new URLs associated with the user.

company : NotRequired[str | None]

The new company of the user.

location : NotRequired[str | None]

The new location of the user.

class AuthenticatedUser(api)

Bases: Resource

Initializes the Resource with an API instance.

• Parameters: api (API) – An instance of the API class.

get()

Get the authenticated user.

• Returns: The user object.
• Return type: UserWithDetails

async async_get()

Get authenticated user.

• Returns: The user object.
• Return type: UserWithDetails

models(pagination_options=None)

List models of the authenticated user.

• Parameters: pagination_options (Optional [PaginationOptions ]) – Optional settings to control pagination behavior.
• Returns: Paginated response containing models : and navigation metadata.
• Return type: PaginatedResponse[Model]

async async_models(pagination_options=None)

List models of the authenticated user.

• Parameters: pagination_options (Optional [PaginationOptions ]) – Optional settings to control pagination behavior.
• Returns: Paginated response containing models : and navigation metadata.
• Return type: PaginatedResponse[Model]

update(params)

Update the authenticated user.

• Parameters: params (UpdateUserParams) – The fields to update.
• Returns: The updated user object.
• Return type: UserWithDetails

async async_update(params)

Update the authenticated user.

• Parameters: params (UpdateUserParams) – The fields to update.
• Returns: The updated user object.
• Return type: UserWithDetails