Auth

genjishimada_sdk.auth

Authentication models for email-based users.

AuthUserPublic

Bases: Struct

Public-facing user info for registration responses.

Attributes:

Name	Type	Description
id	int	User ID.
email	str	User's email address.
username	str	Display name.
email_verified	bool	Whether email is verified.

email: str instance-attribute

email_verified: bool instance-attribute

id: int instance-attribute

username: str instance-attribute

AuthUserResponse

Bases: Struct

Response after successful authentication.

Attributes:

Name	Type	Description
id	int	User ID (9-15 digits for email users, 17-19 for Discord).
email	str	User's email address.
username	str	Display name.
email_verified	bool	Whether email is verified.
coins	int	Current coin balance.
is_mod	bool	Whether user has moderator/admin permissions.

coins: int = 0 class-attribute instance-attribute

email: str instance-attribute

email_verified: bool instance-attribute

id: int instance-attribute

is_mod: bool = False class-attribute instance-attribute

username: str instance-attribute

AuthUserVerify

Bases: Struct

User info returned from verification and password reset flows.

Attributes:

Name	Type	Description
id	int	User ID.
email	str	User's email address.
username	str	Display name.
email_verified	bool	Whether email is verified.
is_mod	bool	Whether user has moderator/admin permissions.

email: str instance-attribute

email_verified: bool instance-attribute

id: int instance-attribute

is_mod: bool = False class-attribute instance-attribute

username: str instance-attribute

CreateRememberTokenResponse

Bases: Struct

Response for creating remember token.

token: str instance-attribute

DestroyUserSessionsResponse

Bases: Struct

Response for destroying all user sessions.

destroyed_count: int instance-attribute

EmailAuthStatus

Bases: Struct

Email verification status for a user.

Attributes:

Name	Type	Description
email_verified	bool	Whether the user's email is verified.
email	str	The user's email address (partially masked).

email: str instance-attribute

email_verified: bool instance-attribute

EmailLoginRequest

Bases: Struct

Payload for email-based login.

Attributes:

Name	Type	Description
email	str	User's email address.
password	str	Plaintext password to verify.

email: str instance-attribute

password: str instance-attribute

EmailRegisterRequest

Bases: Struct

Payload for registering a new email-based user.

Attributes:

Name	Type	Description
email	str	User's email address.
password	str	Plaintext password (will be hashed server-side).
username	str	Display name (stored in global_name/nickname).

email: str instance-attribute

password: str instance-attribute

username: str instance-attribute

EmailVerifyRequest

Bases: Struct

Payload for email verification.

Attributes:

Name	Type	Description
token	str	The verification token from the email link.

token: str instance-attribute

LoginResponse

Bases: Struct

Response for user login.

user: AuthUserResponse instance-attribute

PasswordResetConfirmRequest

Bases: Struct

Payload for completing password reset.

Attributes:

Name	Type	Description
token	str	The reset token from the email link.
password	str	New plaintext password.

password: str instance-attribute

token: str instance-attribute

PasswordResetConfirmResponse

Bases: Struct

Response for password reset confirmation.

message: str instance-attribute

user: AuthUserVerify instance-attribute

PasswordResetEmailEvent

Bases: Struct

Payload for password reset email events.

email: str instance-attribute

token: str instance-attribute

username: str instance-attribute

PasswordResetRequest

Bases: Struct

Payload for initiating password reset.

Attributes:

Name	Type	Description
email	str	User's email address.

email: str instance-attribute

PasswordResetRequestResponse

Bases: Struct

Response for password reset request.

message: str instance-attribute

RegisterResponse

Bases: Struct

Response for user registration.

user: AuthUserPublic instance-attribute

verification_email_sent: bool instance-attribute

ResendVerificationResponse

Bases: Struct

Response for resend verification.

message: str instance-attribute

RevokeRememberTokensResponse

Bases: Struct

Response for revoking remember tokens.

revoked_count: int instance-attribute

SessionDestroyResponse

Bases: Struct

Response for session destroy.

deleted: bool instance-attribute

SessionGcResponse

Bases: Struct

Response for session garbage collection.

deleted_count: int instance-attribute

SessionInfo

Bases: Struct

Information about an active session.

Attributes:

Name	Type	Description
id	str	Session ID.
last_activity	str | None	Last activity timestamp (ISO format).
ip_address	str | None	Client IP address.
user_agent	str | None	Client user agent string.

id: str instance-attribute

ip_address: str | None instance-attribute

last_activity: str | None instance-attribute

user_agent: str | None instance-attribute

SessionReadResponse

Bases: Struct

Response from reading a session.

Attributes:

Name	Type	Description
payload	str | None	Base64-encoded session data (null if not found).
is_mod	bool	Whether the authenticated user has moderator permissions.

is_mod: bool = False class-attribute instance-attribute

payload: str | None instance-attribute

SessionWriteRequest

Bases: Struct

Payload for writing session data.

Attributes:

Name	Type	Description
payload	str	Base64-encoded session data.
user_id	int | None	Optional authenticated user ID.

payload: str instance-attribute

user_id: int | None = None class-attribute instance-attribute

SessionWriteResponse

Bases: Struct

Response for session write.

success: bool instance-attribute

UserSessionsResponse

Bases: Struct

Response for user sessions list.

sessions: list[SessionInfo] instance-attribute

ValidateRememberTokenResponse

Bases: Struct

Response for validating remember token.

user_id: int | None instance-attribute

valid: bool instance-attribute

VerificationEmailEvent

Bases: Struct

Payload for verification email events.

email: str instance-attribute

token: str instance-attribute

username: str instance-attribute

VerifyEmailResponse

Bases: Struct

Response for email verification.

message: str instance-attribute

user: AuthUserVerify instance-attribute

__all__ = ('AuthUserPublic', 'AuthUserResponse', 'AuthUserVerify', 'CreateRememberTokenResponse', 'DestroyUserSessionsResponse', 'EmailAuthStatus', 'EmailLoginRequest', 'EmailRegisterRequest', 'EmailVerifyRequest', 'LoginResponse', 'PasswordResetConfirmRequest', 'PasswordResetConfirmResponse', 'PasswordResetEmailEvent', 'PasswordResetRequest', 'PasswordResetRequestResponse', 'RegisterResponse', 'ResendVerificationResponse', 'RevokeRememberTokensResponse', 'SessionDestroyResponse', 'SessionGcResponse', 'SessionInfo', 'SessionReadResponse', 'SessionWriteRequest', 'SessionWriteResponse', 'UserSessionsResponse', 'ValidateRememberTokenResponse', 'VerificationEmailEvent', 'VerifyEmailResponse') module-attribute