xbox.webapi.api.provider.mediahub.models module

class xbox.webapi.api.provider.mediahub.models.ContentSegment(*, segmentId, creationType, creatorChannelId=None, creatorXuid, recordDate, durationInSeconds, offset, secondaryTitleId=None, titleId)[source]

Bases: CamelCaseModel

Parameters:

  • segmentId (int) –

  • creationType (str) –

  • creatorChannelId (str | None) –

  • creatorXuid (int) –

  • recordDate (str) –

  • durationInSeconds (int) –

  • offset (int) –

  • secondaryTitleId (int | None) –

  • titleId (int) –

segment_id: int
creation_type: str
creator_channel_id: str | None
creator_xuid: int
record_date: str
duration_in_seconds: int
offset: int
secondary_title_id: int | None
title_id: 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]] = {'creation_type': FieldInfo(annotation=str, required=True, alias='creationType'), 'creator_channel_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='creatorChannelId'), 'creator_xuid': FieldInfo(annotation=int, required=True, alias='creatorXuid'), 'duration_in_seconds': FieldInfo(annotation=int, required=True, alias='durationInSeconds'), 'offset': FieldInfo(annotation=int, required=True, alias='offset'), 'record_date': FieldInfo(annotation=str, required=True, alias='recordDate'), 'secondary_title_id': FieldInfo(annotation=Union[int, NoneType], required=False, alias='secondaryTitleId'), 'segment_id': FieldInfo(annotation=int, required=True, alias='segmentId'), 'title_id': FieldInfo(annotation=int, required=True, 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.mediahub.models.ContentLocator(*, expiration=None, fileSize=None, locatorType, uri)[source]

Bases: CamelCaseModel

Parameters:

  • expiration (str | None) –

  • fileSize (int | None) –

  • locatorType (str) –

  • uri (str) –

expiration: str | None
file_size: int | None
locator_type: str
uri: 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=Union[str, NoneType], required=False, alias='expiration'), 'file_size': FieldInfo(annotation=Union[int, NoneType], required=False, alias='fileSize'), 'locator_type': FieldInfo(annotation=str, required=True, alias='locatorType'), '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.mediahub.models.GameclipContent(*, contentId, contentLocators, contentSegments, creationType, durationInSeconds, localId, ownerXuid, sandboxId, sharedTo, titleId, titleName, uploadDate, uploadLanguage, uploadRegion, uploadTitleId, uploadDeviceType, commentCount, likeCount, shareCount, viewCount, contentState, enforcementState, sessions, tournaments)[source]

Bases: CamelCaseModel

Parameters:

  • contentId (str) –

  • contentLocators (List[ContentLocator]) –

  • contentSegments (List[ContentSegment]) –

  • creationType (str) –

  • durationInSeconds (int) –

  • localId (str) –

  • ownerXuid (int) –

  • sandboxId (str) –

  • sharedTo (List[int]) –

  • titleId (int) –

  • titleName (str) –

  • uploadDate (str) –

  • uploadLanguage (str) –

  • uploadRegion (str) –

  • uploadTitleId (int) –

  • uploadDeviceType (str) –

  • commentCount (int) –

  • likeCount (int) –

  • shareCount (int) –

  • viewCount (int) –

  • contentState (str) –

  • enforcementState (str) –

  • sessions (List[str]) –

  • tournaments (List[str]) –

content_id: str
content_locators: List[ContentLocator]
content_segments: List[ContentSegment]
creation_type: str
duration_in_seconds: int
local_id: str
owner_xuid: int
sandbox_id: str
shared_to: List[int]
title_id: int
title_name: str
upload_date: str
upload_language: str
upload_region: str
upload_title_id: int
upload_device_type: str
comment_count: int
like_count: int
share_count: int
view_count: int
content_state: str
enforcement_state: str
sessions: List[str]
tournaments: 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]] = {'comment_count': FieldInfo(annotation=int, required=True, alias='commentCount'), 'content_id': FieldInfo(annotation=str, required=True, alias='contentId'), 'content_locators': FieldInfo(annotation=List[ContentLocator], required=True, alias='contentLocators'), 'content_segments': FieldInfo(annotation=List[ContentSegment], required=True, alias='contentSegments'), 'content_state': FieldInfo(annotation=str, required=True, alias='contentState'), 'creation_type': FieldInfo(annotation=str, required=True, alias='creationType'), 'duration_in_seconds': FieldInfo(annotation=int, required=True, alias='durationInSeconds'), 'enforcement_state': FieldInfo(annotation=str, required=True, alias='enforcementState'), 'like_count': FieldInfo(annotation=int, required=True, alias='likeCount'), 'local_id': FieldInfo(annotation=str, required=True, alias='localId'), 'owner_xuid': FieldInfo(annotation=int, required=True, alias='ownerXuid'), 'sandbox_id': FieldInfo(annotation=str, required=True, alias='sandboxId'), 'sessions': FieldInfo(annotation=List[str], required=True, alias='sessions'), 'share_count': FieldInfo(annotation=int, required=True, alias='shareCount'), 'shared_to': FieldInfo(annotation=List[int], required=True, alias='sharedTo'), 'title_id': FieldInfo(annotation=int, required=True, alias='titleId'), 'title_name': FieldInfo(annotation=str, required=True, alias='titleName'), 'tournaments': FieldInfo(annotation=List[str], required=True, alias='tournaments'), 'upload_date': FieldInfo(annotation=str, required=True, alias='uploadDate'), 'upload_device_type': FieldInfo(annotation=str, required=True, alias='uploadDeviceType'), 'upload_language': FieldInfo(annotation=str, required=True, alias='uploadLanguage'), 'upload_region': FieldInfo(annotation=str, required=True, alias='uploadRegion'), 'upload_title_id': FieldInfo(annotation=int, required=True, alias='uploadTitleId'), 'view_count': FieldInfo(annotation=int, required=True, alias='viewCount')}

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.mediahub.models.MediahubGameclips(*, values)[source]

Bases: CamelCaseModel

Parameters:

values (List[GameclipContent]) –

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

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.mediahub.models.ScreenshotContent(*, contentId, captureDate, contentLocators, localId, ownerXuid, resolutionHeight, resolutionWidth, dateUploaded, sandboxId, sharedTo, titleId, titleName, uploadLanguage, uploadRegion, uploadTitleId, uploadDeviceType, commentCount, likeCount, shareCount, viewCount, contentState, enforcementState, sessions, tournaments)[source]

Bases: CamelCaseModel

Parameters:

  • contentId (str) –

  • captureDate (str) –

  • contentLocators (List[ContentLocator]) –

  • localId (str) –

  • ownerXuid (int) –

  • resolutionHeight (int) –

  • resolutionWidth (int) –

  • dateUploaded (str) –

  • sandboxId (str) –

  • sharedTo (List[int]) –

  • titleId (int) –

  • titleName (str) –

  • uploadLanguage (str) –

  • uploadRegion (str) –

  • uploadTitleId (int) –

  • uploadDeviceType (str) –

  • commentCount (int) –

  • likeCount (int) –

  • shareCount (int) –

  • viewCount (int) –

  • contentState (str) –

  • enforcementState (str) –

  • sessions (List[str]) –

  • tournaments (List[str]) –

content_id: str
capture_date: str
content_locators: List[ContentLocator]
local_id: str
owner_xuid: int
resolution_height: int
resolution_width: int
date_uploaded: str
sandbox_id: str
shared_to: List[int]
title_id: int
title_name: str
upload_language: str
upload_region: str
upload_title_id: int
upload_device_type: str
comment_count: int
like_count: int
share_count: int
view_count: int
content_state: str
enforcement_state: str
sessions: List[str]
tournaments: 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]] = {'capture_date': FieldInfo(annotation=str, required=True, alias='captureDate'), 'comment_count': FieldInfo(annotation=int, required=True, alias='commentCount'), 'content_id': FieldInfo(annotation=str, required=True, alias='contentId'), 'content_locators': FieldInfo(annotation=List[ContentLocator], required=True, alias='contentLocators'), 'content_state': FieldInfo(annotation=str, required=True, alias='contentState'), 'date_uploaded': FieldInfo(annotation=str, required=True, alias='dateUploaded'), 'enforcement_state': FieldInfo(annotation=str, required=True, alias='enforcementState'), 'like_count': FieldInfo(annotation=int, required=True, alias='likeCount'), 'local_id': FieldInfo(annotation=str, required=True, alias='localId'), 'owner_xuid': FieldInfo(annotation=int, required=True, alias='ownerXuid'), 'resolution_height': FieldInfo(annotation=int, required=True, alias='resolutionHeight'), 'resolution_width': FieldInfo(annotation=int, required=True, alias='resolutionWidth'), 'sandbox_id': FieldInfo(annotation=str, required=True, alias='sandboxId'), 'sessions': FieldInfo(annotation=List[str], required=True, alias='sessions'), 'share_count': FieldInfo(annotation=int, required=True, alias='shareCount'), 'shared_to': FieldInfo(annotation=List[int], required=True, alias='sharedTo'), 'title_id': FieldInfo(annotation=int, required=True, alias='titleId'), 'title_name': FieldInfo(annotation=str, required=True, alias='titleName'), 'tournaments': FieldInfo(annotation=List[str], required=True, alias='tournaments'), 'upload_device_type': FieldInfo(annotation=str, required=True, alias='uploadDeviceType'), 'upload_language': FieldInfo(annotation=str, required=True, alias='uploadLanguage'), 'upload_region': FieldInfo(annotation=str, required=True, alias='uploadRegion'), 'upload_title_id': FieldInfo(annotation=int, required=True, alias='uploadTitleId'), 'view_count': FieldInfo(annotation=int, required=True, alias='viewCount')}

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.mediahub.models.MediahubScreenshots(*, values)[source]

Bases: CamelCaseModel

Parameters:

values (List[ScreenshotContent]) –

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

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

This replaces Model.__fields__ from Pydantic V1.