xbox.webapi.api.provider.cqs.models module

class xbox.webapi.api.provider.cqs.models.Image(*, Purpose, ResizeUri, ForeColor)[source]

Bases: PascalCaseModel

Parameters:

  • Purpose (str) –

  • ResizeUri (str) –

  • ForeColor (str) –

purpose: str
resize_uri: str
fore_color: 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]] = {'fore_color': FieldInfo(annotation=str, required=True, alias='ForeColor'), 'purpose': FieldInfo(annotation=str, required=True, alias='Purpose'), 'resize_uri': FieldInfo(annotation=str, required=True, alias='ResizeUri')}

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.cqs.models.ListChannel(*, Id, ChannelId, CallSign, ChannelNumber, StartDate, EndDate, Images, IsHd=None)[source]

Bases: PascalCaseModel

Parameters:

  • Id (str) –

  • ChannelId (str) –

  • CallSign (str) –

  • ChannelNumber (str) –

  • StartDate (str) –

  • EndDate (str) –

  • Images (List[Image]) –

  • IsHd (bool | None) –

id: str
channel_id: str
call_sign: str
channel_number: str
start_date: str
end_date: str
images: List[Image]
is_HD: bool | 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]] = {'call_sign': FieldInfo(annotation=str, required=True, alias='CallSign'), 'channel_id': FieldInfo(annotation=str, required=True, alias='ChannelId'), 'channel_number': FieldInfo(annotation=str, required=True, alias='ChannelNumber'), 'end_date': FieldInfo(annotation=str, required=True, alias='EndDate'), 'id': FieldInfo(annotation=str, required=True, alias='Id'), 'images': FieldInfo(annotation=List[Image], required=True, alias='Images'), 'is_HD': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsHd'), 'start_date': FieldInfo(annotation=str, required=True, alias='StartDate')}

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.cqs.models.CqsChannelListResponse(*, Channels)[source]

Bases: PascalCaseModel

Parameters:

Channels (List[ListChannel]) –

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

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.cqs.models.Genre(*, Name)[source]

Bases: PascalCaseModel

Parameters:

Name (str) –

name: 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]] = {'name': FieldInfo(annotation=str, required=True, alias='Name')}

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.cqs.models.ParentSeries(*, Id, Name)[source]

Bases: PascalCaseModel

Parameters:
id: str
name: 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]] = {'id': FieldInfo(annotation=str, required=True, alias='Id'), 'name': FieldInfo(annotation=str, required=True, alias='Name')}

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.cqs.models.Program(*, Id, MediaItemType, StartDate, EndDate, Name, IsRepeat, ParentalControl=None, Genres, CategoryId, Description=None, ParentSeries=None, Images=None)[source]

Bases: PascalCaseModel

Parameters:
id: str
media_item_type: str
start_date: str
end_date: str
name: str
is_repeat: bool
parental_control: Dict[str, Any] | None
genres: List[Genre]
category_id: int
description: str | None
parent_series: ParentSeries | None
images: List[Image] | 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]] = {'category_id': FieldInfo(annotation=int, required=True, alias='CategoryId'), 'description': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Description'), 'end_date': FieldInfo(annotation=str, required=True, alias='EndDate'), 'genres': FieldInfo(annotation=List[Genre], required=True, alias='Genres'), 'id': FieldInfo(annotation=str, required=True, alias='Id'), 'images': FieldInfo(annotation=Union[List[Image], NoneType], required=False, alias='Images'), 'is_repeat': FieldInfo(annotation=bool, required=True, alias='IsRepeat'), 'media_item_type': FieldInfo(annotation=str, required=True, alias='MediaItemType'), 'name': FieldInfo(annotation=str, required=True, alias='Name'), 'parent_series': FieldInfo(annotation=Union[ParentSeries, NoneType], required=False, alias='ParentSeries'), 'parental_control': FieldInfo(annotation=Union[Dict[str, Any], NoneType], required=False, alias='ParentalControl'), 'start_date': FieldInfo(annotation=str, required=True, alias='StartDate')}

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.cqs.models.ScheduleChannel(*, Id, Name, Images, Programs)[source]

Bases: PascalCaseModel

Parameters:
id: str
name: str
images: List[Image]
programs: List[Program]
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]] = {'id': FieldInfo(annotation=str, required=True, alias='Id'), 'images': FieldInfo(annotation=List[Image], required=True, alias='Images'), 'name': FieldInfo(annotation=str, required=True, alias='Name'), 'programs': FieldInfo(annotation=List[Program], required=True, alias='Programs')}

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.cqs.models.CqsScheduleResponse(*, Channels)[source]

Bases: PascalCaseModel

Parameters:

Channels (List[ScheduleChannel]) –

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

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

This replaces Model.__fields__ from Pydantic V1.