xbox.webapi.api.provider.profile.models module

class xbox.webapi.api.provider.profile.models.ProfileSettings(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: str, Enum

Profile settings, used as parameter for Profile API

GAME_DISPLAY_NAME = 'GameDisplayName'

APP_DISPLAY_NAME = 'AppDisplayName'

APP_DISPLAYPIC_RAW = 'AppDisplayPicRaw'

GAME_DISPLAYPIC_RAW = 'GameDisplayPicRaw'

PUBLIC_GAMERPIC = 'PublicGamerpic'

SHOW_USER_AS_AVATAR = 'ShowUserAsAvatar'

GAMERSCORE = 'Gamerscore'

GAMERTAG = 'Gamertag'

MODERN_GAMERTAG = 'ModernGamertag'

MODERN_GAMERTAG_SUFFIX = 'ModernGamertagSuffix'

UNIQUE_MODERN_GAMERTAG = 'UniqueModernGamertag'

ACCOUNT_TIER = 'AccountTier'

TENURE_LEVEL = 'TenureLevel'

XBOX_ONE_REP = 'XboxOneRep'

PREFERRED_COLOR = 'PreferredColor'

LOCATION = 'Location'

BIOGRAPHY = 'Bio'

WATERMARKS = 'Watermarks'

REAL_NAME = 'RealName'

REAL_NAME_OVERRIDE = 'RealNameOverride'

IS_QUARANTINED = 'IsQuarantined'

static _generate_next_value_(name, start, count, last_values)

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.profile.models.Setting(*, id, value)

Bases: CamelCaseModel

Parameters:

• id (str) –

• value (str) –

id: str

value: str

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]] = {'id': FieldInfo(annotation=str, required=True, alias='id'), 'value': FieldInfo(annotation=str, required=True, alias='value')}

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.profile.models.ProfileUser(*, id, hostId, settings, isSponsoredUser)

Bases: CamelCaseModel

Parameters:

• id (str) –

• hostId (str) –

• settings (List[Setting]) –

• isSponsoredUser (bool) –

id: str

host_id: str

settings: List[Setting]

is_sponsored_user: bool

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]] = {'host_id': FieldInfo(annotation=str, required=True, alias='hostId'), 'id': FieldInfo(annotation=str, required=True, alias='id'), 'is_sponsored_user': FieldInfo(annotation=bool, required=True, alias='isSponsoredUser'), 'settings': FieldInfo(annotation=List[Setting], required=True, alias='settings')}

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.profile.models.ProfileResponse(*, profileUsers)

Bases: CamelCaseModel

Parameters:

profileUsers (List[ProfileUser]) –

profile_users: List[ProfileUser]

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]] = {'profile_users': FieldInfo(annotation=List[ProfileUser], required=True, alias='profileUsers')}

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

This replaces Model.__fields__ from Pydantic V1.