Users

genjishimada_sdk.users

CommunityLeaderboardResponse

Bases: Struct

Entry in the community leaderboard.

Attributes:

Name	Type	Description
user_id	int	Identifier of the user.
nickname	str | None	Display nickname for the leaderboard (may be None).
xp_amount	int	Total XP accumulated.
raw_tier	int	Raw tier value.
normalized_tier	int	Normalized tier value.
prestige_level	int	Prestige level achieved.
tier_name	str	Name of the tier.
wr_count	int	Number of world records.
map_count	int	Number of maps created.
playtest_count	int	Number of playtests performed.
discord_tag	str	Discord tag for the user.
skill_rank	str	Skill rank label.
total_results	int	Total results in a paginated query.

discord_tag: str instance-attribute

map_count: int instance-attribute

nickname: str | None instance-attribute

normalized_tier: int instance-attribute

playtest_count: int instance-attribute

prestige_level: int instance-attribute

raw_tier: int instance-attribute

skill_rank: str instance-attribute

tier_name: str instance-attribute

total_results: int instance-attribute

user_id: int instance-attribute

wr_count: int instance-attribute

xp_amount: int instance-attribute

Creator

Bases: Struct

Minimal creator details.

Attributes:

Name	Type	Description
id	int	Creator user identifier.
is_primary	bool	Whether the creator is the primary author.

id: int instance-attribute

is_primary: bool instance-attribute

CreatorFull

Bases: Creator

Creator details including display name.

name: str instance-attribute

NOTIFICATION_TYPES = Literal['NONE', 'DM_ON_VERIFICATION', 'DM_ON_SKILL_ROLE_UPDATE', 'DM_ON_LOOTBOX_GAIN', 'DM_ON_RECORDS_REMOVAL', 'DM_ON_PLAYTEST_ALERTS', 'PING_ON_XP_GAIN', 'PING_ON_MASTERY', 'PING_ON_COMMUNITY_RANK_UPDATE'] module-attribute

Notification

Bases: IntFlag

Notification bitmask flags for user preferences.

DM_ON_LOOTBOX_GAIN = enum.auto() class-attribute instance-attribute

DM_ON_PLAYTEST_ALERTS = enum.auto() class-attribute instance-attribute

DM_ON_RECORDS_REMOVAL = enum.auto() class-attribute instance-attribute

DM_ON_SKILL_ROLE_UPDATE = enum.auto() class-attribute instance-attribute

DM_ON_VERIFICATION = enum.auto() class-attribute instance-attribute

NONE = 0 class-attribute instance-attribute

PING_ON_COMMUNITY_RANK_UPDATE = enum.auto() class-attribute instance-attribute

PING_ON_MASTERY = enum.auto() class-attribute instance-attribute

PING_ON_XP_GAIN = enum.auto() class-attribute instance-attribute

OverwatchUsernameItem

Bases: Struct

Represents a single Overwatch username entry.

Attributes:

Name	Type	Description
username	str	Overwatch username.
is_primary	bool	Whether this username is the primary one.

is_primary: bool = False class-attribute instance-attribute

username: str instance-attribute

OverwatchUsernamesResponse

Bases: Struct

Response containing mapped Overwatch usernames for a user.

Attributes:

Name	Type	Description
user_id	int	Identifier for the user.
primary	str | None	Primary username.
secondary	str | None	Secondary username.
tertiary	str | None	Tertiary username.

primary: str | None instance-attribute

secondary: str | None instance-attribute

tertiary: str | None instance-attribute

user_id: int instance-attribute

OverwatchUsernamesUpdateRequest

Bases: Struct

Payload for updating Overwatch usernames.

Attributes:

Name	Type	Description
usernames	list[OverwatchUsernameItem]	Collection of Overwatch usernames with primary marker.

__post_init__() -> None

Post-initialization processing to enforce primary username constraints.

usernames: list[OverwatchUsernameItem] instance-attribute

RankDetailResponse

Bases: Struct

Detailed rank breakdown for a user.

Attributes:

Name	Type	Description
difficulty	DifficultyTop	Difficulty tier represented.
completions	int	Number of completions.
gold	int	Number of gold medals.
silver	int	Number of silver medals.
bronze	int	Number of bronze medals.
rank_met	bool	Whether the rank criteria are met.
gold_rank_met	bool	Whether gold rank criteria are met.
silver_rank_met	bool	Whether silver rank criteria are met.
bronze_rank_met	bool	Whether bronze rank criteria are met.

bronze: int instance-attribute

bronze_rank_met: bool instance-attribute

completions: int instance-attribute

difficulty: DifficultyTop instance-attribute

gold: int instance-attribute

gold_rank_met: bool instance-attribute

rank_met: bool instance-attribute

silver: int instance-attribute

silver_rank_met: bool instance-attribute

SettingsUpdateRequest

Bases: Struct

Update payload for user settings.

Attributes:

Name	Type	Description
notifications	list[NOTIFICATION_TYPES]	List of notification preference names to enable.

__post_init__() -> None

Post-initialization processing to validate notification names.

notifications: list[NOTIFICATION_TYPES] instance-attribute

to_bitmask() -> int

Convert the list of notification names to a bitmask.

UserCreateRequest

Bases: Struct

Payload for creating a user profile.

Attributes:

Name	Type	Description
id	int	Discord user identifier.
global_name	str	Global display name.
nickname	str	Server nickname.

global_name: str instance-attribute

id: int instance-attribute

nickname: str instance-attribute

UserResponse

Bases: Struct

User profile response.

Attributes:

Name	Type	Description
id	int	Discord user identifier.
global_name	str | None	Global display name (may be None for users without a global name).
nickname	str | None	Server nickname (may be None for users without a server nickname).
overwatch_usernames	list[str] | None	Linked Overwatch usernames.
coalesced_name	str | None	Combined display name for presentation.
coins	int	Current coin balance.

coalesced_name: str | None = None class-attribute instance-attribute

coins: int = 0 class-attribute instance-attribute

global_name: str | None instance-attribute

id: int instance-attribute

nickname: str | None instance-attribute

overwatch_usernames: list[str] | None instance-attribute

UserUpdateRequest

Bases: Struct

Payload for updating a user profile.

Attributes:

Name	Type	Description
global_name	str | UnsetType	Updated global display name.
nickname	str | UnsetType	Updated nickname.

global_name: str | UnsetType = UNSET class-attribute instance-attribute

nickname: str | UnsetType = UNSET class-attribute instance-attribute

__all__ = ('NOTIFICATION_TYPES', 'CommunityLeaderboardResponse', 'Creator', 'CreatorFull', 'Notification', 'OverwatchUsernameItem', 'OverwatchUsernamesResponse', 'OverwatchUsernamesUpdateRequest', 'RankDetailResponse', 'SettingsUpdateRequest', 'UserCreateRequest', 'UserResponse', 'UserUpdateRequest') module-attribute