users module

User module.

class UsersSortBy(StrEnum)

Bases: StrEnum

Enumeration of possible sorting options for querying users.

CREATED_AT = 'created_at'

class UserPaginationOptions

Bases: PaginationOptions

Pagination options for querying users.

sort_by : NotRequired[UsersSortBy]

The sorting criteria.

sort_direction : NotRequired[SortDirection]

The sorting direction.

cursor : NotRequired[str]

page_size : NotRequired[int]

class UsersResource(api)

Bases: Resource

Initializes the Resource with an API instance.

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

get(username)

Fetch a user by their username.

• Parameters: username (str) – The username of the user.
• Returns: The user object.
• Return type: UserWithDetails

async async_get(username)

Fetch a user by their username.

• Parameters: username (str) – The username of the user.
• Returns: The user object.
• Return type: UserWithDetails

list(pagination_options=None)

List users.

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

async async_list(pagination_options=None)

List users.

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

search(q, pagination_options=None)

Search users.

• Parameters:
  • q (str) – The search query.
  • pagination_options (Optional [PaginationOptions ]) – Optional settings to control pagination behavior.
• Returns: Paginated response containing users : and navigation metadata.
• Return type: PaginatedResponse[UserWithDetails]

async async_search(q, pagination_options=None)

Search Users.

• Parameters:
  • q (str) – The search query.
  • pagination_options (Optional [PaginationOptions ]) – Optional settings to control pagintation behavior.
• Returns: Paginated response containing users : and navigation metadata.
• Return type: PaginatedResponse[UserWithDetails]