xbox.webapi.api.provider.people.models module

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

Bases: str, Enum

SUGGESTION = 'suggestion'
RECENT_PLAYER = 'recentplayer'
FOLLOWER = 'follower'
PREFERRED_COLOR = 'preferredcolor'
DETAIL = 'detail'
MULTIPLAYER_SUMMARY = 'multiplayersummary'
PRESENCE_DETAIL = 'presencedetail'
TITLE_PRESENCE = 'titlepresence'
TITLE_SUMMARY = 'titlesummary'
PRESENCE_TITLE_IDS = 'presencetitleids'
COMMUNITY_MANAGER_TITLES = 'communitymanagertitles'
SOCIAL_MANAGER = 'socialmanager'
BROADCAST = 'broadcast'
TOURNAMENT_SUMMARY = 'tournamentsummary'
AVATAR = 'avatar'
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.people.models.PeopleSummaryResponse(*, targetFollowingCount, targetFollowerCount, isCallerFollowingTarget, isTargetFollowingCaller, hasCallerMarkedTargetAsFavorite, hasCallerMarkedTargetAsIdentityShared, legacyFriendStatus, availablePeopleSlots=None, recentChangeCount=None, watermark=None)[source]

Bases: CamelCaseModel

Parameters:

  • targetFollowingCount (int) –

  • targetFollowerCount (int) –

  • isCallerFollowingTarget (bool) –

  • isTargetFollowingCaller (bool) –

  • hasCallerMarkedTargetAsFavorite (bool) –

  • hasCallerMarkedTargetAsIdentityShared (bool) –

  • legacyFriendStatus (str) –

  • availablePeopleSlots (int | None) –

  • recentChangeCount (int | None) –

  • watermark (str | None) –

target_following_count: int
target_follower_count: int
is_caller_following_target: bool
is_target_following_caller: bool
has_caller_marked_target_as_favorite: bool
has_caller_marked_target_as_identity_shared: bool
legacy_friend_status: str
available_people_slots: int | None
recent_change_count: int | None
watermark: 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]] = {'available_people_slots': FieldInfo(annotation=Union[int, NoneType], required=False, alias='availablePeopleSlots'), 'has_caller_marked_target_as_favorite': FieldInfo(annotation=bool, required=True, alias='hasCallerMarkedTargetAsFavorite'), 'has_caller_marked_target_as_identity_shared': FieldInfo(annotation=bool, required=True, alias='hasCallerMarkedTargetAsIdentityShared'), 'is_caller_following_target': FieldInfo(annotation=bool, required=True, alias='isCallerFollowingTarget'), 'is_target_following_caller': FieldInfo(annotation=bool, required=True, alias='isTargetFollowingCaller'), 'legacy_friend_status': FieldInfo(annotation=str, required=True, alias='legacyFriendStatus'), 'recent_change_count': FieldInfo(annotation=Union[int, NoneType], required=False, alias='recentChangeCount'), 'target_follower_count': FieldInfo(annotation=int, required=True, alias='targetFollowerCount'), 'target_following_count': FieldInfo(annotation=int, required=True, alias='targetFollowingCount'), 'watermark': FieldInfo(annotation=Union[str, NoneType], required=False, alias='watermark')}

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.people.models.Suggestion(*, Type=None, Priority, Reasons=None, TitleId=None)[source]

Bases: PascalCaseModel

Parameters:

  • Type (str | None) –

  • Priority (int) –

  • Reasons (str | None) –

  • TitleId (str | None) –

type: str | None
priority: int
reasons: str | None
title_id: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_pascal>, '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]] = {'priority': FieldInfo(annotation=int, required=True, alias='Priority'), 'reasons': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Reasons'), 'title_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='TitleId'), 'type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Type')}

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.people.models.Recommendation(*, Type, Reasons)[source]

Bases: PascalCaseModel

Parameters:
type: str
reasons: List[str]
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_pascal>, '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]] = {'reasons': FieldInfo(annotation=List[str], required=True, alias='Reasons'), 'type': FieldInfo(annotation=str, required=True, alias='Type')}

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.people.models.MultiplayerSummary(*, InMultiplayerSession, InParty)[source]

Bases: PascalCaseModel

Parameters:

  • InMultiplayerSession (int) –

  • InParty (int) –

in_multiplayer_session: int
in_party: int
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_pascal>, '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]] = {'in_multiplayer_session': FieldInfo(annotation=int, required=True, alias='InMultiplayerSession'), 'in_party': FieldInfo(annotation=int, required=True, alias='InParty')}

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.people.models.RecentPlayer(*, titles, text=None)[source]

Bases: CamelCaseModel

Parameters:
titles: List[str]
text: 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]] = {'text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='text'), 'titles': FieldInfo(annotation=List[str], required=True, alias='titles')}

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.people.models.Follower(*, text=None, followedDateTime=None)[source]

Bases: CamelCaseModel

Parameters:

  • text (str | None) –

  • followedDateTime (datetime | None) –

text: str | None
followed_date_time: datetime | 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]] = {'followed_date_time': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='followedDateTime'), 'text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='text')}

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.people.models.PreferredColor(*, primaryColor=None, secondaryColor=None, tertiaryColor=None)[source]

Bases: CamelCaseModel

Parameters:

  • primaryColor (str | None) –

  • secondaryColor (str | None) –

  • tertiaryColor (str | None) –

primary_color: str | None
secondary_color: str | None
tertiary_color: 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]] = {'primary_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='primaryColor'), 'secondary_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='secondaryColor'), 'tertiary_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='tertiaryColor')}

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.people.models.PresenceDetail(*, IsBroadcasting, Device, PresenceText, State, TitleId, TitleType=None, IsPrimary, IsGame, RichPresenceText=None)[source]

Bases: PascalCaseModel

Parameters:

  • IsBroadcasting (bool) –

  • Device (str) –

  • PresenceText (str) –

  • State (str) –

  • TitleId (str) –

  • TitleType (str | None) –

  • IsPrimary (bool) –

  • IsGame (bool) –

  • RichPresenceText (str | None) –

is_broadcasting: bool
device: str
presence_text: str
state: str
title_id: str
title_type: str | None
is_primary: bool
is_game: bool
rich_presence_text: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_pascal>, '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': FieldInfo(annotation=str, required=True, alias='Device'), 'is_broadcasting': FieldInfo(annotation=bool, required=True, alias='IsBroadcasting'), 'is_game': FieldInfo(annotation=bool, required=True, alias='IsGame'), 'is_primary': FieldInfo(annotation=bool, required=True, alias='IsPrimary'), 'presence_text': FieldInfo(annotation=str, required=True, alias='PresenceText'), 'rich_presence_text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='RichPresenceText'), 'state': FieldInfo(annotation=str, required=True, alias='State'), 'title_id': FieldInfo(annotation=str, required=True, alias='TitleId'), 'title_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='TitleType')}

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.people.models.TitlePresence(*, IsCurrentlyPlaying, PresenceText=None, TitleName=None, TitleId=None)[source]

Bases: PascalCaseModel

Parameters:

  • IsCurrentlyPlaying (bool) –

  • PresenceText (str | None) –

  • TitleName (str | None) –

  • TitleId (str | None) –

is_currently_playing: bool
presence_text: str | None
title_name: str | None
title_id: str | None
model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_pascal>, '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]] = {'is_currently_playing': FieldInfo(annotation=bool, required=True, alias='IsCurrentlyPlaying'), 'presence_text': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PresenceText'), 'title_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='TitleId'), 'title_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='TitleName')}

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.people.models.Detail(*, accountTier, bio=None, isVerified, location=None, tenure=None, watermarks, blocked, mute, followerCount, followingCount, hasGamePass)[source]

Bases: CamelCaseModel

Parameters:

  • accountTier (str) –

  • bio (str | None) –

  • isVerified (bool) –

  • location (str | None) –

  • tenure (str | None) –

  • watermarks (List[str]) –

  • blocked (bool) –

  • mute (bool) –

  • followerCount (int) –

  • followingCount (int) –

  • hasGamePass (bool) –

account_tier: str
bio: str | None
is_verified: bool
location: str | None
tenure: str | None
watermarks: List[str]
blocked: bool
mute: bool
follower_count: int
following_count: int
has_game_pass: 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]] = {'account_tier': FieldInfo(annotation=str, required=True, alias='accountTier'), 'bio': FieldInfo(annotation=Union[str, NoneType], required=False, alias='bio'), 'blocked': FieldInfo(annotation=bool, required=True, alias='blocked'), 'follower_count': FieldInfo(annotation=int, required=True, alias='followerCount'), 'following_count': FieldInfo(annotation=int, required=True, alias='followingCount'), 'has_game_pass': FieldInfo(annotation=bool, required=True, alias='hasGamePass'), 'is_verified': FieldInfo(annotation=bool, required=True, alias='isVerified'), 'location': FieldInfo(annotation=Union[str, NoneType], required=False, alias='location'), 'mute': FieldInfo(annotation=bool, required=True, alias='mute'), 'tenure': FieldInfo(annotation=Union[str, NoneType], required=False, alias='tenure'), 'watermarks': FieldInfo(annotation=List[str], required=True, alias='watermarks')}

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.people.models.SocialManager(*, titleIds, pages)[source]

Bases: CamelCaseModel

Parameters:
title_ids: List[str]
pages: List[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]] = {'pages': FieldInfo(annotation=List[str], required=True, alias='pages'), 'title_ids': FieldInfo(annotation=List[str], required=True, alias='titleIds')}

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.people.models.Avatar(*, updateTimeOffset=None, spritesheetMetadata=None)[source]

Bases: CamelCaseModel

Parameters:

  • updateTimeOffset (datetime | None) –

  • spritesheetMetadata (Any | None) –

update_time_offset: datetime | None
spritesheet_metadata: Any | 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]] = {'spritesheet_metadata': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='spritesheetMetadata'), 'update_time_offset': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='updateTimeOffset')}

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.people.models.LinkedAccount(*, networkName, displayName=None, showOnProfile, isFamilyFriendly, deeplink=None)[source]

Bases: CamelCaseModel

Parameters:

  • networkName (str) –

  • displayName (str | None) –

  • showOnProfile (bool) –

  • isFamilyFriendly (bool) –

  • deeplink (str | None) –

network_name: str
display_name: str | None
show_on_profile: bool
is_family_friendly: 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]] = {'deeplink': FieldInfo(annotation=Union[str, NoneType], required=False, alias='deeplink'), 'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='displayName'), 'is_family_friendly': FieldInfo(annotation=bool, required=True, alias='isFamilyFriendly'), 'network_name': FieldInfo(annotation=str, required=True, alias='networkName'), 'show_on_profile': FieldInfo(annotation=bool, required=True, alias='showOnProfile')}

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.people.models.Person(*, xuid, isFavorite, isFollowingCaller, isFollowedByCaller, isIdentityShared, addedDateTimeUtc=None, displayName=None, realName, displayPicRaw, showUserAsAvatar, gamertag, gamerScore, modernGamertag, modernGamertagSuffix, uniqueModernGamertag, xboxOneRep, presenceState, presenceText, presenceDevices=None, isBroadcasting, isCloaked=None, isQuarantined, isXbox360Gamerpic, lastSeenDateTimeUtc=None, suggestion=None, recommendation=None, search=None, titleHistory=None, multiplayerSummary=None, recentPlayer=None, follower=None, preferredColor=None, presenceDetails=None, titlePresence=None, titleSummaries=None, presenceTitleIds=None, detail=None, communityManagerTitles=None, socialManager=None, broadcast=None, tournamentSummary=None, avatar=None, linkedAccounts=None, colorTheme, preferredFlag, preferredPlatforms)[source]

Bases: CamelCaseModel

Parameters:

  • xuid (str) –

  • isFavorite (bool) –

  • isFollowingCaller (bool) –

  • isFollowedByCaller (bool) –

  • isIdentityShared (bool) –

  • addedDateTimeUtc (datetime | None) –

  • displayName (str | None) –

  • realName (str) –

  • displayPicRaw (str) –

  • showUserAsAvatar (str) –

  • gamertag (str) –

  • gamerScore (str) –

  • modernGamertag (str) –

  • modernGamertagSuffix (str) –

  • uniqueModernGamertag (str) –

  • xboxOneRep (str) –

  • presenceState (str) –

  • presenceText (str) –

  • presenceDevices (Any | None) –

  • isBroadcasting (bool) –

  • isCloaked (bool | None) –

  • isQuarantined (bool) –

  • isXbox360Gamerpic (bool) –

  • lastSeenDateTimeUtc (datetime | None) –

  • suggestion (Suggestion | None) –

  • recommendation (Recommendation | None) –

  • search (Any | None) –

  • titleHistory (Any | None) –

  • multiplayerSummary (MultiplayerSummary | None) –

  • recentPlayer (RecentPlayer | None) –

  • follower (Follower | None) –

  • preferredColor (PreferredColor | None) –

  • presenceDetails (List[PresenceDetail] | None) –

  • titlePresence (TitlePresence | None) –

  • titleSummaries (Any | None) –

  • presenceTitleIds (List[str] | None) –

  • detail (Detail | None) –

  • communityManagerTitles (Any | None) –

  • socialManager (SocialManager | None) –

  • broadcast (List[Any] | None) –

  • tournamentSummary (Any | None) –

  • avatar (Avatar | None) –

  • linkedAccounts (List[LinkedAccount] | None) –

  • colorTheme (str) –

  • preferredFlag (str) –

  • preferredPlatforms (List[Any]) –

xuid: str
is_favorite: bool
is_following_caller: bool
is_followed_by_caller: bool
is_identity_shared: bool
added_date_time_utc: datetime | None
display_name: str | None
real_name: str
display_pic_raw: str
show_user_as_avatar: str
gamertag: str
gamer_score: str
modern_gamertag: str
modern_gamertag_suffix: str
unique_modern_gamertag: str
xbox_one_rep: str
presence_state: str
presence_text: str
presence_devices: Any | None
is_broadcasting: bool
is_cloaked: bool | None
is_quarantined: bool
is_xbox_360_gamerpic: bool
last_seen_date_time_utc: datetime | None
suggestion: Suggestion | None
recommendation: Recommendation | None
search: Any | None
titleHistory: Any | None
multiplayer_summary: MultiplayerSummary | None
recent_player: RecentPlayer | None
follower: Follower | None
preferred_color: PreferredColor | None
presence_details: List[PresenceDetail] | None
title_presence: TitlePresence | None
title_summaries: Any | None
presence_title_ids: List[str] | None
detail: Detail | None
community_manager_titles: Any | None
social_manager: SocialManager | None
broadcast: List[Any] | None
tournament_summary: Any | None
avatar: Avatar | None
linked_accounts: List[LinkedAccount] | None
color_theme: str
preferred_flag: str
preferred_platforms: List[Any]
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]] = {'added_date_time_utc': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='addedDateTimeUtc'), 'avatar': FieldInfo(annotation=Union[Avatar, NoneType], required=False, alias='avatar'), 'broadcast': FieldInfo(annotation=Union[List[Any], NoneType], required=False, alias='broadcast'), 'color_theme': FieldInfo(annotation=str, required=True, alias='colorTheme'), 'community_manager_titles': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='communityManagerTitles'), 'detail': FieldInfo(annotation=Union[Detail, NoneType], required=False, alias='detail'), 'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='displayName'), 'display_pic_raw': FieldInfo(annotation=str, required=True, alias='displayPicRaw'), 'follower': FieldInfo(annotation=Union[Follower, NoneType], required=False, alias='follower'), 'gamer_score': FieldInfo(annotation=str, required=True, alias='gamerScore'), 'gamertag': FieldInfo(annotation=str, required=True, alias='gamertag'), 'is_broadcasting': FieldInfo(annotation=bool, required=True, alias='isBroadcasting'), 'is_cloaked': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='isCloaked'), 'is_favorite': FieldInfo(annotation=bool, required=True, alias='isFavorite'), 'is_followed_by_caller': FieldInfo(annotation=bool, required=True, alias='isFollowedByCaller'), 'is_following_caller': FieldInfo(annotation=bool, required=True, alias='isFollowingCaller'), 'is_identity_shared': FieldInfo(annotation=bool, required=True, alias='isIdentityShared'), 'is_quarantined': FieldInfo(annotation=bool, required=True, alias='isQuarantined'), 'is_xbox_360_gamerpic': FieldInfo(annotation=bool, required=True, alias='isXbox360Gamerpic'), 'last_seen_date_time_utc': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='lastSeenDateTimeUtc'), 'linked_accounts': FieldInfo(annotation=Union[List[LinkedAccount], NoneType], required=False, alias='linkedAccounts'), 'modern_gamertag': FieldInfo(annotation=str, required=True, alias='modernGamertag'), 'modern_gamertag_suffix': FieldInfo(annotation=str, required=True, alias='modernGamertagSuffix'), 'multiplayer_summary': FieldInfo(annotation=Union[MultiplayerSummary, NoneType], required=False, alias='multiplayerSummary'), 'preferred_color': FieldInfo(annotation=Union[PreferredColor, NoneType], required=False, alias='preferredColor'), 'preferred_flag': FieldInfo(annotation=str, required=True, alias='preferredFlag'), 'preferred_platforms': FieldInfo(annotation=List[Any], required=True, alias='preferredPlatforms'), 'presence_details': FieldInfo(annotation=Union[List[PresenceDetail], NoneType], required=False, alias='presenceDetails'), 'presence_devices': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='presenceDevices'), 'presence_state': FieldInfo(annotation=str, required=True, alias='presenceState'), 'presence_text': FieldInfo(annotation=str, required=True, alias='presenceText'), 'presence_title_ids': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='presenceTitleIds'), 'real_name': FieldInfo(annotation=str, required=True, alias='realName'), 'recent_player': FieldInfo(annotation=Union[RecentPlayer, NoneType], required=False, alias='recentPlayer'), 'recommendation': FieldInfo(annotation=Union[Recommendation, NoneType], required=False, alias='recommendation'), 'search': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='search'), 'show_user_as_avatar': FieldInfo(annotation=str, required=True, alias='showUserAsAvatar'), 'social_manager': FieldInfo(annotation=Union[SocialManager, NoneType], required=False, alias='socialManager'), 'suggestion': FieldInfo(annotation=Union[Suggestion, NoneType], required=False, alias='suggestion'), 'titleHistory': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='titleHistory'), 'title_presence': FieldInfo(annotation=Union[TitlePresence, NoneType], required=False, alias='titlePresence'), 'title_summaries': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='titleSummaries'), 'tournament_summary': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='tournamentSummary'), 'unique_modern_gamertag': FieldInfo(annotation=str, required=True, alias='uniqueModernGamertag'), 'xbox_one_rep': FieldInfo(annotation=str, required=True, alias='xboxOneRep'), 'xuid': FieldInfo(annotation=str, required=True, alias='xuid')}

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.people.models.RecommendationSummary(*, friendOfFriend, facebookFriend, phoneContact, follower, VIP, steamFriend, promoteSuggestions)[source]

Bases: CamelCaseModel

Parameters:

  • friendOfFriend (int) –

  • facebookFriend (int) –

  • phoneContact (int) –

  • follower (int) –

  • VIP (int) –

  • steamFriend (int) –

  • promoteSuggestions (bool) –

friend_of_friend: int
facebook_friend: int
phone_contact: int
follower: int
VIP: int
steam_friend: int
promote_suggestions: 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]] = {'VIP': FieldInfo(annotation=int, required=True, alias='VIP'), 'facebook_friend': FieldInfo(annotation=int, required=True, alias='facebookFriend'), 'follower': FieldInfo(annotation=int, required=True, alias='follower'), 'friend_of_friend': FieldInfo(annotation=int, required=True, alias='friendOfFriend'), 'phone_contact': FieldInfo(annotation=int, required=True, alias='phoneContact'), 'promote_suggestions': FieldInfo(annotation=bool, required=True, alias='promoteSuggestions'), 'steam_friend': FieldInfo(annotation=int, required=True, alias='steamFriend')}

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.people.models.FriendFinderState(*, facebookOptInStatus, facebookTokenStatus, phoneOptInStatus, phoneTokenStatus, steamOptInStatus, steamTokenStatus, discordOptInStatus, discordTokenStatus, instagramOptInStatus, instagramTokenStatus, mixerOptInStatus, mixerTokenStatus, redditOptInStatus, redditTokenStatus, twitchOptInStatus, twitchTokenStatus, twitterOptInStatus, twitterTokenStatus, youTubeOptInStatus, youTubeTokenStatus)[source]

Bases: CamelCaseModel

Parameters:

  • facebookOptInStatus (str) –

  • facebookTokenStatus (str) –

  • phoneOptInStatus (str) –

  • phoneTokenStatus (str) –

  • steamOptInStatus (str) –

  • steamTokenStatus (str) –

  • discordOptInStatus (str) –

  • discordTokenStatus (str) –

  • instagramOptInStatus (str) –

  • instagramTokenStatus (str) –

  • mixerOptInStatus (str) –

  • mixerTokenStatus (str) –

  • redditOptInStatus (str) –

  • redditTokenStatus (str) –

  • twitchOptInStatus (str) –

  • twitchTokenStatus (str) –

  • twitterOptInStatus (str) –

  • twitterTokenStatus (str) –

  • youTubeOptInStatus (str) –

  • youTubeTokenStatus (str) –

facebook_opt_in_status: str
facebook_token_status: str
phone_opt_in_status: str
phone_token_status: str
steam_opt_in_status: str
steam_token_status: str
discord_opt_in_status: str
discord_token_status: str
instagram_opt_in_status: str
instagram_token_status: str
mixer_opt_in_status: str
mixer_token_status: str
reddit_opt_in_status: str
reddit_token_status: str
twitch_opt_in_status: str
twitch_token_status: str
twitter_opt_in_status: str
twitter_token_status: str
you_tube_opt_in_status: str
you_tube_token_status: 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]] = {'discord_opt_in_status': FieldInfo(annotation=str, required=True, alias='discordOptInStatus'), 'discord_token_status': FieldInfo(annotation=str, required=True, alias='discordTokenStatus'), 'facebook_opt_in_status': FieldInfo(annotation=str, required=True, alias='facebookOptInStatus'), 'facebook_token_status': FieldInfo(annotation=str, required=True, alias='facebookTokenStatus'), 'instagram_opt_in_status': FieldInfo(annotation=str, required=True, alias='instagramOptInStatus'), 'instagram_token_status': FieldInfo(annotation=str, required=True, alias='instagramTokenStatus'), 'mixer_opt_in_status': FieldInfo(annotation=str, required=True, alias='mixerOptInStatus'), 'mixer_token_status': FieldInfo(annotation=str, required=True, alias='mixerTokenStatus'), 'phone_opt_in_status': FieldInfo(annotation=str, required=True, alias='phoneOptInStatus'), 'phone_token_status': FieldInfo(annotation=str, required=True, alias='phoneTokenStatus'), 'reddit_opt_in_status': FieldInfo(annotation=str, required=True, alias='redditOptInStatus'), 'reddit_token_status': FieldInfo(annotation=str, required=True, alias='redditTokenStatus'), 'steam_opt_in_status': FieldInfo(annotation=str, required=True, alias='steamOptInStatus'), 'steam_token_status': FieldInfo(annotation=str, required=True, alias='steamTokenStatus'), 'twitch_opt_in_status': FieldInfo(annotation=str, required=True, alias='twitchOptInStatus'), 'twitch_token_status': FieldInfo(annotation=str, required=True, alias='twitchTokenStatus'), 'twitter_opt_in_status': FieldInfo(annotation=str, required=True, alias='twitterOptInStatus'), 'twitter_token_status': FieldInfo(annotation=str, required=True, alias='twitterTokenStatus'), 'you_tube_opt_in_status': FieldInfo(annotation=str, required=True, alias='youTubeOptInStatus'), 'you_tube_token_status': FieldInfo(annotation=str, required=True, alias='youTubeTokenStatus')}

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.people.models.PeopleResponse(*, people, recommendationSummary=None, friendFinderState=None, accountLinkDetails=None)[source]

Bases: CamelCaseModel

Parameters:
people: List[Person]
recommendation_summary: RecommendationSummary | None
friend_finder_state: FriendFinderState | 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]] = {'account_link_details': FieldInfo(annotation=Union[List[LinkedAccount], NoneType], required=False, alias='accountLinkDetails'), 'friend_finder_state': FieldInfo(annotation=Union[FriendFinderState, NoneType], required=False, alias='friendFinderState'), 'people': FieldInfo(annotation=List[Person], required=True, alias='people'), 'recommendation_summary': FieldInfo(annotation=Union[RecommendationSummary, NoneType], required=False, alias='recommendationSummary')}

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

This replaces Model.__fields__ from Pydantic V1.