xbox.webapi.api.provider.smartglass.models module

class xbox.webapi.api.provider.smartglass.models.ConsoleType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

XboxOne = 'XboxOne'
XboxOneS = 'XboxOneS'
XboxOneSDigital = 'XboxOneSDigital'
XboxOneX = 'XboxOneX'
XboxSeriesS = 'XboxSeriesS'
XboxSeriesX = 'XboxSeriesX'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.PowerState(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Unknown = 'Unknown'
On = 'On'
Off = 'Off'
ConnectedStandby = 'ConnectedStandby'
SystemUpdate = 'SystemUpdate'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.PlaybackState(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Unknown = 'Unknown'
Playing = 'Playing'
Paused = 'Paused'
Stopped = 'Stopped'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.ErrorCode(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

OK = 'OK'
CurrentConsoleNotFound = 'CurrentConsoleNotFound'
RemoteManagementDisabled = 'RemoteManagementDisabled'
XboxDataNotFound = 'XboxDataNotFound'
XboxNotPaired = 'XboxNotPaired'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.OpStatus(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Paused = 'Paused'
OffConsoleError = 'OffConsoleError'
Pending = 'Pending'
TimedOut = 'TimedOut'
Error = 'Error'
Succeeded = 'Succeeded'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.SmartglassApiStatus(*, errorCode, errorMessage=None)[source]

Bases: CamelCaseModel

Parameters:

  • errorCode (str) –

  • errorMessage (str | None) –

error_code: str
error_message: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'error_code': FieldInfo(annotation=str, required=True, alias='errorCode'), 'error_message': FieldInfo(annotation=Union[str, NoneType], required=False, alias='errorMessage')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.StorageDevice(*, storageDeviceId, storageDeviceName, isDefault, totalSpaceBytes, freeSpaceBytes)[source]

Bases: CamelCaseModel

Parameters:

  • storageDeviceId (str) –

  • storageDeviceName (str) –

  • isDefault (bool) –

  • totalSpaceBytes (float) –

  • freeSpaceBytes (float) –

storage_device_id: str
storage_device_name: str
is_default: bool
total_space_bytes: float
free_space_bytes: float
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'free_space_bytes': FieldInfo(annotation=float, required=True, alias='freeSpaceBytes'), 'is_default': FieldInfo(annotation=bool, required=True, alias='isDefault'), 'storage_device_id': FieldInfo(annotation=str, required=True, alias='storageDeviceId'), 'storage_device_name': FieldInfo(annotation=str, required=True, alias='storageDeviceName'), 'total_space_bytes': FieldInfo(annotation=float, required=True, alias='totalSpaceBytes')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.SmartglassConsole(*, id, name, consoleType, powerState, consoleStreamingEnabled, digitalAssistantRemoteControlEnabled, remoteManagementEnabled, storageDevices=None)[source]

Bases: CamelCaseModel

Parameters:
id: str
name: str
console_type: ConsoleType
power_state: PowerState
console_streaming_enabled: bool
digital_assistant_remote_control_enabled: bool
remote_management_enabled: bool
storage_devices: List[StorageDevice] | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'console_streaming_enabled': FieldInfo(annotation=bool, required=True, alias='consoleStreamingEnabled'), 'console_type': FieldInfo(annotation=ConsoleType, required=True, alias='consoleType'), 'digital_assistant_remote_control_enabled': FieldInfo(annotation=bool, required=True, alias='digitalAssistantRemoteControlEnabled'), 'id': FieldInfo(annotation=str, required=True, alias='id'), 'name': FieldInfo(annotation=str, required=True, alias='name'), 'power_state': FieldInfo(annotation=PowerState, required=True, alias='powerState'), 'remote_management_enabled': FieldInfo(annotation=bool, required=True, alias='remoteManagementEnabled'), 'storage_devices': FieldInfo(annotation=Union[List[StorageDevice], NoneType], required=False, alias='storageDevices')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.SmartglassConsoleList(*, agentUserId=None, result, status)[source]

Bases: CamelCaseModel

Parameters:
agent_user_id: str | None
result: List[SmartglassConsole]
status: SmartglassApiStatus
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'agent_user_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='agentUserId'), 'result': FieldInfo(annotation=List[SmartglassConsole], required=True, alias='result'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.SmartglassConsoleStatus(*, powerState, consoleStreamingEnabled, digitalAssistantRemoteControlEnabled, remoteManagementEnabled, focusAppAumid, isTvConfigured, loginState=None, playbackState, storageDevices=None, status)[source]

Bases: CamelCaseModel

Parameters:
console_streaming_enabled: bool
digital_assistant_remote_control_enabled: bool
remote_management_enabled: bool
focus_app_aumid: str
is_tv_configured: bool
login_state: str | None
playback_state: PlaybackState
power_state: PowerState
storage_devices: List[StorageDevice] | None
status: SmartglassApiStatus
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'console_streaming_enabled': FieldInfo(annotation=bool, required=True, alias='consoleStreamingEnabled'), 'digital_assistant_remote_control_enabled': FieldInfo(annotation=bool, required=True, alias='digitalAssistantRemoteControlEnabled'), 'focus_app_aumid': FieldInfo(annotation=str, required=True, alias='focusAppAumid'), 'is_tv_configured': FieldInfo(annotation=bool, required=True, alias='isTvConfigured'), 'login_state': FieldInfo(annotation=Union[str, NoneType], required=False, alias='loginState'), 'playback_state': FieldInfo(annotation=PlaybackState, required=True, alias='playbackState'), 'power_state': FieldInfo(annotation=PowerState, required=True, alias='powerState'), 'remote_management_enabled': FieldInfo(annotation=bool, required=True, alias='remoteManagementEnabled'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status'), 'storage_devices': FieldInfo(annotation=Union[List[StorageDevice], NoneType], required=False, alias='storageDevices')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.InstalledPackage(*, oneStoreProductId=None, titleId, aumid=None, lastActiveTime=None, isGame, name=None, contentType, instanceId, storageDeviceId, uniqueId, legacyProductId=None, version, sizeInBytes, installTime, updateTime=None, parentId=None)[source]

Bases: CamelCaseModel

Parameters:

  • oneStoreProductId (str | None) –

  • titleId (int) –

  • aumid (str | None) –

  • lastActiveTime (datetime | None) –

  • isGame (bool) –

  • name (str | None) –

  • contentType (str) –

  • instanceId (str) –

  • storageDeviceId (str) –

  • uniqueId (str) –

  • legacyProductId (str | None) –

  • version (int) –

  • sizeInBytes (int) –

  • installTime (datetime) –

  • updateTime (datetime | None) –

  • parentId (str | None) –

one_store_product_id: str | None
title_id: int
aumid: str | None
last_active_time: datetime | None
is_game: bool
name: str | None
content_type: str
instance_id: str
storage_device_id: str
unique_id: str
legacy_product_id: str | None
version: int
size_in_bytes: int
install_time: datetime
update_time: datetime | None
parent_id: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'aumid': FieldInfo(annotation=Union[str, NoneType], required=False, alias='aumid'), 'content_type': FieldInfo(annotation=str, required=True, alias='contentType'), 'install_time': FieldInfo(annotation=datetime, required=True, alias='installTime'), 'instance_id': FieldInfo(annotation=str, required=True, alias='instanceId'), 'is_game': FieldInfo(annotation=bool, required=True, alias='isGame'), 'last_active_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='lastActiveTime'), 'legacy_product_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='legacyProductId'), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='name'), 'one_store_product_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='oneStoreProductId'), 'parent_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='parentId'), 'size_in_bytes': FieldInfo(annotation=int, required=True, alias='sizeInBytes'), 'storage_device_id': FieldInfo(annotation=str, required=True, alias='storageDeviceId'), 'title_id': FieldInfo(annotation=int, required=True, alias='titleId'), 'unique_id': FieldInfo(annotation=str, required=True, alias='uniqueId'), 'update_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='updateTime'), 'version': FieldInfo(annotation=int, required=True, alias='version')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.InstalledPackagesList(*, result, status, agentUserId=None)[source]

Bases: CamelCaseModel

Parameters:
result: List[InstalledPackage]
status: SmartglassApiStatus
agent_user_id: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'agent_user_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='agentUserId'), 'result': FieldInfo(annotation=List[InstalledPackage], required=True, alias='result'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.StorageDevicesList(*, deviceId, result, status)[source]

Bases: CamelCaseModel

Parameters:
device_id: str
result: List[StorageDevice]
status: SmartglassApiStatus
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'device_id': FieldInfo(annotation=str, required=True, alias='deviceId'), 'result': FieldInfo(annotation=List[StorageDevice], required=True, alias='result'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.OpStatusNode(*, operationStatus, opId, originatingSessionId, command, succeeded, consoleStatusCode=None, xccsErrorCode=None, hResult=None, message=None)[source]

Bases: CamelCaseModel

Parameters:

  • operationStatus (OpStatus) –

  • opId (str) –

  • originatingSessionId (str) –

  • command (str) –

  • succeeded (bool) –

  • consoleStatusCode (int | None) –

  • xccsErrorCode (ErrorCode | None) –

  • hResult (int | None) –

  • message (str | None) –

operation_status: OpStatus
op_id: str
originating_session_id: str
command: str
succeeded: bool
console_status_code: int | None
xccs_error_code: ErrorCode | None
h_result: int | None
message: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'command': FieldInfo(annotation=str, required=True, alias='command'), 'console_status_code': FieldInfo(annotation=Union[int, NoneType], required=False, alias='consoleStatusCode'), 'h_result': FieldInfo(annotation=Union[int, NoneType], required=False, alias='hResult'), 'message': FieldInfo(annotation=Union[str, NoneType], required=False, alias='message'), 'op_id': FieldInfo(annotation=str, required=True, alias='opId'), 'operation_status': FieldInfo(annotation=OpStatus, required=True, alias='operationStatus'), 'originating_session_id': FieldInfo(annotation=str, required=True, alias='originatingSessionId'), 'succeeded': FieldInfo(annotation=bool, required=True, alias='succeeded'), 'xccs_error_code': FieldInfo(annotation=Union[ErrorCode, NoneType], required=False, alias='xccsErrorCode')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.OperationStatusResponse(*, opStatusList, status)[source]

Bases: CamelCaseModel

Parameters:
op_status_list: List[OpStatusNode]
status: SmartglassApiStatus
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'op_status_list': FieldInfo(annotation=List[OpStatusNode], required=True, alias='opStatusList'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.CommandDestination(*, id, name, powerState, remoteManagementEnabled, consoleStreamingEnabled, consoleType, wirelessWarning=None, outOfHomeWarning=None)[source]

Bases: CamelCaseModel

Parameters:

  • id (str) –

  • name (str) –

  • powerState (PowerState) –

  • remoteManagementEnabled (bool) –

  • consoleStreamingEnabled (bool) –

  • consoleType (ConsoleType) –

  • wirelessWarning (str | None) –

  • outOfHomeWarning (str | None) –

id: str
name: str
power_state: PowerState
remote_management_enabled: bool
console_streaming_enabled: bool
console_type: ConsoleType
wireless_warning: str | None
out_of_home_warning: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'console_streaming_enabled': FieldInfo(annotation=bool, required=True, alias='consoleStreamingEnabled'), 'console_type': FieldInfo(annotation=ConsoleType, required=True, alias='consoleType'), 'id': FieldInfo(annotation=str, required=True, alias='id'), 'name': FieldInfo(annotation=str, required=True, alias='name'), 'out_of_home_warning': FieldInfo(annotation=Union[str, NoneType], required=False, alias='outOfHomeWarning'), 'power_state': FieldInfo(annotation=PowerState, required=True, alias='powerState'), 'remote_management_enabled': FieldInfo(annotation=bool, required=True, alias='remoteManagementEnabled'), 'wireless_warning': FieldInfo(annotation=Union[str, NoneType], required=False, alias='wirelessWarning')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.CommandResponse(*, result=None, uiText=None, destination, userInfo=None, opId, status)[source]

Bases: CamelCaseModel

Parameters:
result: str | None
ui_text: str | None
destination: CommandDestination
user_info: str | None
op_id: str
status: SmartglassApiStatus
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'destination': FieldInfo(annotation=CommandDestination, required=True, alias='destination'), 'op_id': FieldInfo(annotation=str, required=True, alias='opId'), 'result': FieldInfo(annotation=Union[str, NoneType], required=False, alias='result'), 'status': FieldInfo(annotation=SmartglassApiStatus, required=True, alias='status'), 'ui_text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='uiText'), 'user_info': FieldInfo(annotation=Union[str, NoneType], required=False, alias='userInfo')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class xbox.webapi.api.provider.smartglass.models.VolumeDirection(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Up = 'Up'
Down = 'Down'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.InputKeyType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Guide = 'Guide'
Menu = 'Menu'
View = 'View'
A = 'A'
B = 'B'
X = 'X'
Y = 'Y'
Up = 'Up'
Down = 'Down'
Left = 'Left'
Right = 'Right'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.smartglass.models.GuideTab(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

Guide = 'Guide'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned