xbox.webapi.api.provider.usersearch.models module

class xbox.webapi.api.provider.usersearch.models.UserDetail(*, id, gamertag, displayPicUri, score)[source]

Bases: CamelCaseModel

Parameters:

  • id (str) –

  • gamertag (str) –

  • displayPicUri (str) –

  • score (float) –

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

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.usersearch.models.UserResult(*, text, result)[source]

Bases: CamelCaseModel

Parameters:
text: str
result: UserDetail
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]] = {'result': FieldInfo(annotation=UserDetail, required=True, alias='result'), 'text': FieldInfo(annotation=str, required=True, 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.usersearch.models.UserSearchResponse(*, results)[source]

Bases: CamelCaseModel

Parameters:

results (List[UserResult]) –

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

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

This replaces Model.__fields__ from Pydantic V1.