xbox.webapi.api.provider.lists.models module

class xbox.webapi.api.provider.lists.models.Item(*, ItemId, ContentType, Title=None, DeviceType, Provider=None, ProviderId=None)[source]

Bases: PascalCaseModel

Parameters:

  • ItemId (str) –

  • ContentType (str) –

  • Title (str | None) –

  • DeviceType (str) –

  • Provider (str | None) –

  • ProviderId (str | None) –

item_id: str
content_type: str
title: str | None
device_type: str
provider: str | None
provider_id: 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]] = {'content_type': FieldInfo(annotation=str, required=True, alias='ContentType'), 'device_type': FieldInfo(annotation=str, required=True, alias='DeviceType'), 'item_id': FieldInfo(annotation=str, required=True, alias='ItemId'), 'provider': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Provider'), 'provider_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProviderId'), 'title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Title')}

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.lists.models.ListItem(*, DateAdded, DateModified, Index, KValue, Item)[source]

Bases: PascalCaseModel

Parameters:

  • DateAdded (str) –

  • DateModified (str) –

  • Index (int) –

  • KValue (int) –

  • Item (Item) –

date_added: str
date_modified: str
index: int
k_value: int
item: Item
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]] = {'date_added': FieldInfo(annotation=str, required=True, alias='DateAdded'), 'date_modified': FieldInfo(annotation=str, required=True, alias='DateModified'), 'index': FieldInfo(annotation=int, required=True, alias='Index'), 'item': FieldInfo(annotation=Item, required=True, alias='Item'), 'k_value': FieldInfo(annotation=int, required=True, alias='KValue')}

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.lists.models.ListMetadata(*, ListTitle, ListVersion, ListCount, AllowDuplicates, MaxListSize, AccessSetting)[source]

Bases: PascalCaseModel

Parameters:

  • ListTitle (str) –

  • ListVersion (int) –

  • ListCount (int) –

  • AllowDuplicates (bool) –

  • MaxListSize (int) –

  • AccessSetting (str) –

list_title: str
list_version: int
list_count: int
allow_duplicates: bool
max_list_size: int
access_setting: str
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]] = {'access_setting': FieldInfo(annotation=str, required=True, alias='AccessSetting'), 'allow_duplicates': FieldInfo(annotation=bool, required=True, alias='AllowDuplicates'), 'list_count': FieldInfo(annotation=int, required=True, alias='ListCount'), 'list_title': FieldInfo(annotation=str, required=True, alias='ListTitle'), 'list_version': FieldInfo(annotation=int, required=True, alias='ListVersion'), 'max_list_size': FieldInfo(annotation=int, required=True, alias='MaxListSize')}

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.lists.models.ListsResponse(*, ImpressionId, ListItems, ListMetadata)[source]

Bases: PascalCaseModel

Parameters:
impression_id: str
list_items: List[ListItem]
list_metadata: ListMetadata
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]] = {'impression_id': FieldInfo(annotation=str, required=True, alias='ImpressionId'), 'list_items': FieldInfo(annotation=List[ListItem], required=True, alias='ListItems'), 'list_metadata': FieldInfo(annotation=ListMetadata, required=True, alias='ListMetadata')}

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

This replaces Model.__fields__ from Pydantic V1.