psnawp_api.models.search.users_result_datatypes module

psnawp_api.models.search.users_result_datatypes module#

Contains datatypes for users search result endpoint.

class Player[source]#

Bases: TypedDict

Represents a player’s public profile information.

accountId: str#
avatarUrl: str#
displayName: str#
displayNameHighlighted: list[str]#
firstName: str#
id: str#
isPsPlus: bool#
itemType: str#
lastName: str#
middleName: str | None#
onlineId: str#
onlineIdHighlighted: list[str]#
profilePicUrl: str#
relationshipState: str | None#
class PlayerHighlight[source]#

Bases: TypedDict

Highlighting metadata for player name and ID fields.

firstName: list[str]#
lastName: list[str]#
middleName: str | None#
onlineId: list[str]#
verifiedUserName: str | None#
class UserContextContainer[source]#

Bases: TypedDict

Holds the universal context search portion of the response.

universalContextSearch: UserUniversalContextSearchResponse#
class UserDomainContainer[source]#

Bases: TypedDict

Wraps the universalDomainSearch payload, which may either carry only cursors or full result lists.

universalDomainSearch: UserUniversalDomainSearchResponse#
class UserQueryFrequency[source]#

Bases: TypedDict

Debounce timing settings for search queries.

filterDebounceMs: int#
searchDebounceMs: int#
class UserRootResponse[source]#

Bases: TypedDict

Top-level wrapper for a user search GraphQL response.

data: UserContextContainer#
class UserSearchResultItem[source]#

Bases: TypedDict

An individual search result entry for a user query.

highlight: PlayerHighlight#
id: str#
result: Player#
resultOriginFlag: list[str] | None#
class UserUniversalContextSearchResponse[source]#

Bases: TypedDict

Aggregated search results across user-related domains.

queryFrequency: UserQueryFrequency#
results: list[UserUniversalDomainSearchResponse]#
class UserUniversalDomainSearchResponse[source]#

Bases: TypedDict

Search results scoped to a single user-related domain.

domain: str#
domainTitle: str#
next: str#
searchResults: list[UserSearchResultItem]#
totalResultCount: int#
zeroState: bool#
default_user_root_response() → UserRootResponse[source]#

Returns a fresh UserRootResponse dict.

  • all Literal __typename fields are set to their exact value

  • all str fields == “”

  • all int fields == 0 (for queryFrequency)

  • all bool fields == False

  • all list fields == []

  • contains two placeholder UserUniversalDomainSearchResponse entries

Contents