xbox.webapi.api.provider.gameclips.models module

class xbox.webapi.api.provider.gameclips.models.Thumbnail(*, uri, fileSize, thumbnailType)[source]

Bases: CamelCaseModel

Parameters:

  • uri (str) –

  • fileSize (int) –

  • thumbnailType (str) –

uri: str
file_size: int
thumbnail_type: 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]] = {'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.gameclips.models.GameClipUri(*, uri, fileSize, uriType, expiration)[source]

Bases: CamelCaseModel

Parameters:

  • uri (str) –

  • fileSize (int) –

  • uriType (str) –

  • expiration (str) –

uri: str
file_size: int
uri_type: str
expiration: 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]] = {'expiration': FieldInfo(annotation=str, 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.gameclips.models.GameClip(*, gameClipId, state, datePublished, dateRecorded, lastModified, userCaption, type, durationInSeconds, scid, titleId, rating, ratingCount, views, titleData, systemProperties, savedByUser, achievementId, greatestMomentId, thumbnails, gameClipUris, xuid, clipName, titleName, gameClipLocale, clipContentAttributes, deviceType, commentCount, likeCount, shareCount, partialViews)[source]

Bases: CamelCaseModel

Parameters:

  • gameClipId (str) –

  • state (str) –

  • datePublished (str) –

  • dateRecorded (str) –

  • lastModified (str) –

  • userCaption (str) –

  • type (str) –

  • durationInSeconds (int) –

  • scid (str) –

  • titleId (int) –

  • rating (float) –

  • ratingCount (int) –

  • views (int) –

  • titleData (str) –

  • systemProperties (str) –

  • savedByUser (bool) –

  • achievementId (str) –

  • greatestMomentId (str) –

  • thumbnails (List[Thumbnail]) –

  • gameClipUris (List[GameClipUri]) –

  • xuid (str) –

  • clipName (str) –

  • titleName (str) –

  • gameClipLocale (str) –

  • clipContentAttributes (str) –

  • deviceType (str) –

  • commentCount (int) –

  • likeCount (int) –

  • shareCount (int) –

  • partialViews (int) –

game_clip_id: str
state: str
date_published: str
date_recorded: str
last_modified: str
user_caption: str
type: str
duration_in_seconds: int
scid: str
title_id: int
rating: float
rating_count: int
views: int
title_data: str
system_properties: str
saved_by_user: bool
achievement_id: str
greatest_moment_id: str
thumbnails: List[Thumbnail]
game_clip_uris: List[GameClipUri]
xuid: str
clip_name: str
title_name: str
game_clip_locale: str
clip_content_attributes: str
device_type: str
comment_count: int
like_count: int
share_count: int
partial_views: int
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'), 'clip_content_attributes': FieldInfo(annotation=str, required=True, alias='clipContentAttributes'), 'clip_name': FieldInfo(annotation=str, required=True, alias='clipName'), 'comment_count': FieldInfo(annotation=int, required=True, alias='commentCount'), 'date_published': FieldInfo(annotation=str, required=True, alias='datePublished'), 'date_recorded': FieldInfo(annotation=str, required=True, alias='dateRecorded'), 'device_type': FieldInfo(annotation=str, required=True, alias='deviceType'), 'duration_in_seconds': FieldInfo(annotation=int, required=True, alias='durationInSeconds'), 'game_clip_id': FieldInfo(annotation=str, required=True, alias='gameClipId'), 'game_clip_locale': FieldInfo(annotation=str, required=True, alias='gameClipLocale'), 'game_clip_uris': FieldInfo(annotation=List[GameClipUri], required=True, alias='gameClipUris'), 'greatest_moment_id': FieldInfo(annotation=str, required=True, alias='greatestMomentId'), 'last_modified': FieldInfo(annotation=str, required=True, alias='lastModified'), 'like_count': FieldInfo(annotation=int, required=True, alias='likeCount'), 'partial_views': FieldInfo(annotation=int, required=True, alias='partialViews'), 'rating': FieldInfo(annotation=float, required=True, alias='rating'), 'rating_count': FieldInfo(annotation=int, required=True, alias='ratingCount'), 'saved_by_user': FieldInfo(annotation=bool, required=True, alias='savedByUser'), 'scid': FieldInfo(annotation=str, required=True, alias='scid'), 'share_count': FieldInfo(annotation=int, required=True, alias='shareCount'), '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.gameclips.models.PagingInfo(*, continuationToken=None)[source]

Bases: CamelCaseModel

Parameters:

continuationToken (str | None) –

continuation_token: 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.gameclips.models.GameclipsResponse(*, gameClips, pagingInfo)[source]

Bases: CamelCaseModel

Parameters:
game_clips: List[GameClip]
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]] = {'game_clips': FieldInfo(annotation=List[GameClip], required=True, alias='gameClips'), 'paging_info': FieldInfo(annotation=PagingInfo, required=True, alias='pagingInfo')}

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

This replaces Model.__fields__ from Pydantic V1.