xbox.webapi.api.provider.screenshots.models module
- class xbox.webapi.api.provider.screenshots.models.Thumbnail(*, uri, fileSize, thumbnailType)[source]
Bases:
CamelCaseModel
- 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]] = {'file_size': FieldInfo(annotation=int, required=True, alias='fileSize'), 'thumbnail_type': FieldInfo(annotation=str, required=True, alias='thumbnailType'), 'uri': FieldInfo(annotation=str, required=True, alias='uri')}
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.screenshots.models.ScreenshotUri(*, uri, fileSize, uriType, expiration)[source]
Bases:
CamelCaseModel
- 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]] = {'expiration': FieldInfo(annotation=datetime, required=True, alias='expiration'), 'file_size': FieldInfo(annotation=int, required=True, alias='fileSize'), 'uri': FieldInfo(annotation=str, required=True, alias='uri'), 'uri_type': FieldInfo(annotation=str, required=True, alias='uriType')}
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.screenshots.models.Screenshot(*, screenshotId, resolutionHeight, resolutionWidth, state, datePublished, dateTaken, lastModified, userCaption, type, scid, titleId, rating, ratingCount, views, titleData, systemProperties, savedByUser, achievementId, greatestMomentId=None, thumbnails, screenshotUris, xuid, screenshotName, titleName, screenshotLocale, screenshotContentAttributes, deviceType)[source]
Bases:
CamelCaseModel
- Parameters:
screenshotId (str) –
resolutionHeight (int) –
resolutionWidth (int) –
state (str) –
datePublished (datetime) –
dateTaken (datetime) –
lastModified (datetime) –
userCaption (str) –
type (str) –
scid (str) –
titleId (int) –
rating (float) –
ratingCount (int) –
views (int) –
titleData (str) –
systemProperties (str) –
savedByUser (bool) –
achievementId (str) –
greatestMomentId (Any) –
screenshotUris (List[ScreenshotUri]) –
xuid (str) –
screenshotName (str) –
titleName (str) –
screenshotLocale (str) –
screenshotContentAttributes (str) –
deviceType (str) –
- screenshot_uris: List[ScreenshotUri]
- 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]] = {'achievement_id': FieldInfo(annotation=str, required=True, alias='achievementId'), 'date_published': FieldInfo(annotation=datetime, required=True, alias='datePublished'), 'date_taken': FieldInfo(annotation=datetime, required=True, alias='dateTaken'), 'device_type': FieldInfo(annotation=str, required=True, alias='deviceType'), 'greatest_moment_id': FieldInfo(annotation=Any, required=False, alias='greatestMomentId'), 'last_modified': FieldInfo(annotation=datetime, required=True, alias='lastModified'), 'rating': FieldInfo(annotation=float, required=True, alias='rating'), 'rating_count': FieldInfo(annotation=int, required=True, alias='ratingCount'), 'resolution_height': FieldInfo(annotation=int, required=True, alias='resolutionHeight'), 'resolution_width': FieldInfo(annotation=int, required=True, alias='resolutionWidth'), 'saved_by_user': FieldInfo(annotation=bool, required=True, alias='savedByUser'), 'scid': FieldInfo(annotation=str, required=True, alias='scid'), 'screenshot_content_attributes': FieldInfo(annotation=str, required=True, alias='screenshotContentAttributes'), 'screenshot_id': FieldInfo(annotation=str, required=True, alias='screenshotId'), 'screenshot_locale': FieldInfo(annotation=str, required=True, alias='screenshotLocale'), 'screenshot_name': FieldInfo(annotation=str, required=True, alias='screenshotName'), 'screenshot_uris': FieldInfo(annotation=List[ScreenshotUri], required=True, alias='screenshotUris'), 'state': FieldInfo(annotation=str, required=True, alias='state'), 'system_properties': FieldInfo(annotation=str, required=True, alias='systemProperties'), 'thumbnails': FieldInfo(annotation=List[Thumbnail], required=True, alias='thumbnails'), 'title_data': FieldInfo(annotation=str, required=True, alias='titleData'), 'title_id': FieldInfo(annotation=int, required=True, alias='titleId'), 'title_name': FieldInfo(annotation=str, required=True, alias='titleName'), 'type': FieldInfo(annotation=str, required=True, alias='type'), 'user_caption': FieldInfo(annotation=str, required=True, alias='userCaption'), 'views': FieldInfo(annotation=int, required=True, alias='views'), '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.screenshots.models.PagingInfo(*, continuationToken=None)[source]
Bases:
CamelCaseModel
- Parameters:
continuationToken (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]] = {'continuation_token': FieldInfo(annotation=Union[str, NoneType], required=False, alias='continuationToken')}
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.screenshots.models.ScreenshotResponse(*, screenshots, pagingInfo)[source]
Bases:
CamelCaseModel
- Parameters:
screenshots (List[Screenshot]) –
pagingInfo (PagingInfo) –
- screenshots: List[Screenshot]
- paging_info: PagingInfo
- 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]] = {'paging_info': FieldInfo(annotation=PagingInfo, required=True, alias='pagingInfo'), 'screenshots': FieldInfo(annotation=List[Screenshot], required=True, alias='screenshots')}
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.