xbox.webapi.api.provider.userstats.models module

class xbox.webapi.api.provider.userstats.models.GeneralStatsField

Bases: object

MINUTES_PLAYED = 'MinutesPlayed'

class xbox.webapi.api.provider.userstats.models.GroupProperties(*, Ordinal=None, SortOrder=None, DisplayName=None, DisplayFormat=None, DisplaySemantic=None)

Bases: PascalCaseModel

Parameters:

• Ordinal (str | None) –

• SortOrder (str | None) –

• DisplayName (str | None) –

• DisplayFormat (str | None) –

• DisplaySemantic (str | None) –

ordinal: str | None

sort_order: str | None

display_name: str | None

display_format: str | None

display_semantic: 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]] = {'display_format': FieldInfo(annotation=Union[str, NoneType], required=False, alias='DisplayFormat'), 'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='DisplayName'), 'display_semantic': FieldInfo(annotation=Union[str, NoneType], required=False, alias='DisplaySemantic'), 'ordinal': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Ordinal'), 'sort_order': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SortOrder')}

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.userstats.models.Properties(*, DisplayName=None)

Bases: PascalCaseModel

Parameters:

DisplayName (str | None) –

display_name: 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]] = {'display_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='DisplayName')}

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.userstats.models.Stat(*, groupproperties=None, xuid, scid, name, type, value, properties)

Bases: LowerCaseModel

Parameters:

• groupproperties (GroupProperties | None) –

• xuid (str) –

• scid (str) –

• name (str) –

• type (str) –

• value (str) –

• properties (Properties) –

group_properties: GroupProperties | None

xuid: str

scid: str

name: str

type: str

value: str

properties: Properties

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_lower>, '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]] = {'group_properties': FieldInfo(annotation=Union[GroupProperties, NoneType], required=False, alias='groupproperties'), 'name': FieldInfo(annotation=str, required=True, alias='name'), 'properties': FieldInfo(annotation=Properties, required=True, alias='properties'), 'scid': FieldInfo(annotation=str, required=True, alias='scid'), 'type': FieldInfo(annotation=str, required=True, alias='type'), 'value': FieldInfo(annotation=str, required=True, alias='value'), '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.userstats.models.StatListsCollectionItem(*, arrangebyfield, arrangebyfieldid, stats)

Bases: LowerCaseModel

Parameters:

• arrangebyfield (str) –

• arrangebyfieldid (str) –

• stats (List[Stat]) –

arrange_by_field: str

arrange_by_field_id: str

stats: List[Stat]

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_lower>, '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]] = {'arrange_by_field': FieldInfo(annotation=str, required=True, alias='arrangebyfield'), 'arrange_by_field_id': FieldInfo(annotation=str, required=True, alias='arrangebyfieldid'), 'stats': FieldInfo(annotation=List[Stat], required=True, alias='stats')}

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.userstats.models.Group(*, name, titleid=None, statlistscollection)

Bases: LowerCaseModel

Parameters:

• name (str) –

• titleid (str | None) –

• statlistscollection (List[StatListsCollectionItem]) –

name: str

title_id: str | None

statlistscollection: List[StatListsCollectionItem]

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_lower>, '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]] = {'name': FieldInfo(annotation=str, required=True, alias='name'), 'statlistscollection': FieldInfo(annotation=List[StatListsCollectionItem], required=True, alias='statlistscollection'), 'title_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='titleid')}

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.userstats.models.UserStatsResponse(*, groups=None, statlistscollection)

Bases: LowerCaseModel

Parameters:

• groups (List[Group] | None) –

• statlistscollection (List[StatListsCollectionItem]) –

groups: List[Group] | None

statlistscollection: List[StatListsCollectionItem]

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_lower>, '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]] = {'groups': FieldInfo(annotation=Union[List[Group], NoneType], required=False, alias='groups'), 'statlistscollection': FieldInfo(annotation=List[StatListsCollectionItem], required=True, alias='statlistscollection')}

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

This replaces Model.__fields__ from Pydantic V1.