Builder

Builder.

The builder, to convert most abstract classes from a payload.

EntityBuilder

EntityBuilder(
    *,
    dumps: DumpType = json_dumps,
    loads: LoadType = json_loads
)

Entity Builder.

The class that allows for converting payloads (str, sequence, mapping, etc) into their respective classes.

PARAMETER	DESCRIPTION
dumps	The dumping method to use when dumping payloads. TYPE: DumpType DEFAULT: json_dumps
loads	The loading method to use when loading payloads. TYPE: LoadType DEFAULT: json_loads

build_rest_error

build_rest_error(
    payload: types.PayloadMappingT,
) -> RestRequestError

Build Rest Request Error.

Builds a RestRequestError object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
RestRequestError	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_exception_error

build_exception_error(
    payload: types.PayloadMappingT,
) -> RestExceptionError

Build Rest Exception Error.

Builds a RestExceptionError object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
RestExceptionError	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_ready_event

build_ready_event(
    payload: types.PayloadMappingT, session: Session
) -> events.ReadyEvent

Build Ready Event.

Builds a Ready object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.ReadyEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_player_update_event

build_player_update_event(
    payload: types.PayloadMappingT, session: Session
) -> events.PlayerUpdateEvent

Build Player Update Event.

Builds a PlayerUpdateEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.PlayerUpdateEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_statistics_event

build_statistics_event(
    payload: types.PayloadMappingT, session: Session
) -> events.StatisticsEvent

Build Statistics Event.

Builds a StatisticsEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.StatisticsEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_start_event

build_track_start_event(
    payload: types.PayloadMappingT, session: Session
) -> events.TrackStartEvent

Build Track Start Event.

Builds a TrackStartEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.TrackStartEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_end_event

build_track_end_event(
    payload: types.PayloadMappingT, session: Session
) -> events.TrackEndEvent

Build Track End Event.

Builds a TrackEndEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.TrackEndEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_exception

build_track_exception(
    payload: types.PayloadMappingT,
) -> events.TrackException

Build Track Exception.

Builds a TrackException object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
events.TrackException	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_exception_event

build_track_exception_event(
    payload: types.PayloadMappingT, session: Session
) -> events.TrackExceptionEvent

Build Track Exception Event.

Builds a TrackExceptionEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.TrackExceptionEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_stuck_event

build_track_stuck_event(
    payload: types.PayloadMappingT, session: Session
) -> events.TrackStuckEvent

Build Track Stuck Event.

Builds a TrackStuckEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.TrackStuckEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_websocket_closed_event

build_websocket_closed_event(
    payload: types.PayloadMappingT, session: Session
) -> events.WebsocketClosedEvent

Build Websocket Closed Event.

Builds a WebsocketClosedEvent object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT
session	The session attached to this event. TYPE: Session

RETURNS	DESCRIPTION
events.WebsocketClosedEvent	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_info

build_info(payload: types.PayloadMappingT) -> info_.Info

Build Information.

Builds a Information object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
info_.Info	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_info_version

build_info_version(
    payload: types.PayloadMappingT,
) -> info_.Version

Build Version Information.

Builds a Version object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
info_.Version	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_info_git

build_info_git(payload: types.PayloadMappingT) -> info_.Git

Build Git Information.

Builds a Git object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
info_.Info	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_info_plugin

build_info_plugin(
    payload: types.PayloadMappingT,
) -> info_.Plugin

Build Plugin Information.

Builds a Plugin object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
info_.Plugin	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_player

build_player(
    payload: types.PayloadMappingT,
) -> player_.Player

Build Player.

Builds a Player object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
player_.Player	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_player_state

build_player_state(
    payload: types.PayloadMappingT,
) -> player_.State

Build Player State.

Builds a State object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
player_.State	The State object.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_player_voice

build_player_voice(
    payload: types.PayloadMappingT,
) -> player_.Voice

Build Player Voice.

Builds a Voice object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
player_.Voice	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_playlist

build_playlist(
    payload: types.PayloadMappingT,
) -> playlist_.Playlist

Build Playlist.

Builds a Playlist object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
playlist_.Playlist	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_playlist_info

build_playlist_info(
    payload: types.PayloadMappingT,
) -> playlist_.PlaylistInfo

Build Playlist Info.

Builds a PlaylistInfo object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
playlist_.PlaylistInfo	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_routeplanner_status

build_routeplanner_status(
    payload: types.PayloadMappingT,
) -> routeplanner_.RoutePlannerStatus

Build Route Planner Status.

Builds a RoutePlannerStatus object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
routeplanner_.RoutePlannerStatus	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_routeplanner_details

build_routeplanner_details(
    payload: types.PayloadMappingT,
) -> routeplanner_.RoutePlannerDetails

Build Route Planner Details.

Builds a RoutePlannerDetails object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
routeplanner_.RoutePlannerDetails	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_routeplanner_ipblock

build_routeplanner_ipblock(
    payload: types.PayloadMappingT,
) -> routeplanner_.IPBlock

Build Route Planner IP Block.

Builds a IPBlock object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
routeplanner_.IPBlock	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_routeplanner_failing_address

build_routeplanner_failing_address(
    payload: types.PayloadMappingT,
) -> routeplanner_.FailingAddress

Build Route Planner Details.

Builds a RoutePlannerDetails object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
routeplanner_.RoutePlannerDetails	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_session

build_session(
    payload: types.PayloadMappingT,
) -> session_.Session

Build Session.

Builds a Session object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
session_.Session	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_statistics

build_statistics(
    payload: types.PayloadMappingT,
) -> statistics_.Statistics

Build Statistics.

Builds a Statistics object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
statistics_.Statistics	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_statistics_memory

build_statistics_memory(
    payload: types.PayloadMappingT,
) -> statistics_.Memory

Build Memory Statistics.

Builds a Memory object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
statistics_.Memory	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_statistics_cpu

build_statistics_cpu(
    payload: types.PayloadMappingT,
) -> statistics_.Cpu

Build Cpu Statistics.

Builds a Cpu object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
statistics_.Cpu	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_statistics_frame_statistics

build_statistics_frame_statistics(
    payload: types.PayloadMappingT,
) -> statistics_.FrameStatistics

Build Frame Statistics.

Builds a Statistics object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
statistics_.FrameStatistics	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track

build_track(payload: types.PayloadMappingT) -> track_.Track

Build Track.

Builds a Track object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
track_.Track	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.

build_track_info

build_track_info(
    payload: types.PayloadMappingT,
) -> track_.TrackInfo

Build Track Information.

Builds a TrackInformation object, from a payload.

PARAMETER	DESCRIPTION
payload	The payload you provide. TYPE: types.PayloadMappingT

RETURNS	DESCRIPTION
track_.TrackInfo	The object from the payload.

RAISES	DESCRIPTION
TypeError	Raised when the payload could not be turned into a mapping.
KeyError	Raised when a value was not found in the payload.