xbox.webapi.api.provider.catalog.models module

class xbox.webapi.api.provider.catalog.models.AlternateIdType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

LEGACY_XBOX_PRODUCT_ID = 'LegacyXboxProductId'
XBOX_TITLE_ID = 'XboxTitleId'
PACKAGE_FAMILY_NAME = 'PackageFamilyName'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.catalog.models.FieldsTemplate(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

BROWSE = 'browse'
DETAILS = 'details'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.catalog.models.PlatformType(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

XBOX = 'windows.xbox'
DESKTOP = 'windows.desktop'
static _generate_next_value_(name, start, count, last_values)[source]

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the list of values assigned

class xbox.webapi.api.provider.catalog.models.Image(*, FileId=None, EISListingIdentifier=None, BackgroundColor=None, Caption=None, FileSizeInBytes, ForegroundColor=None, Height, ImagePositionInfo=None, ImagePurpose, UnscaledImageSHA256Hash=None, Uri, Width)[source]

Bases: PascalCaseModel

Parameters:

  • FileId (str | None) –

  • EISListingIdentifier (Any) –

  • BackgroundColor (str | None) –

  • Caption (str | None) –

  • FileSizeInBytes (int) –

  • ForegroundColor (str | None) –

  • Height (int) –

  • ImagePositionInfo (str | None) –

  • ImagePurpose (str) –

  • UnscaledImageSHA256Hash (str | None) –

  • Uri (str) –

  • Width (int) –

file_id: str | None
eis_listing_identifier: Any
background_color: str | None
caption: str | None
file_size_in_bytes: int
foreground_color: str | None
height: int
image_position_info: str | None
image_purpose: str
unscaled_image_sha256_hash: str | None
uri: str
width: int
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]] = {'background_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='BackgroundColor'), 'caption': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Caption'), 'eis_listing_identifier': FieldInfo(annotation=Any, required=False, alias='EISListingIdentifier', alias_priority=2), 'file_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='FileId'), 'file_size_in_bytes': FieldInfo(annotation=int, required=True, alias='FileSizeInBytes'), 'foreground_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ForegroundColor'), 'height': FieldInfo(annotation=int, required=True, alias='Height'), 'image_position_info': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ImagePositionInfo'), 'image_purpose': FieldInfo(annotation=str, required=True, alias='ImagePurpose'), 'unscaled_image_sha256_hash': FieldInfo(annotation=Union[str, NoneType], required=False, alias='UnscaledImageSHA256Hash', alias_priority=2), 'uri': FieldInfo(annotation=str, required=True, alias='Uri'), 'width': FieldInfo(annotation=int, required=True, alias='Width')}

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.catalog.models.Video(*, Uri, VideoPurpose, Height, Width, AudioEncoding, VideoEncoding, VideoPositionInfo, Caption, FileSizeInBytes, PreviewImage, SortOrder)[source]

Bases: PascalCaseModel

Parameters:

  • Uri (str) –

  • VideoPurpose (str) –

  • Height (int) –

  • Width (int) –

  • AudioEncoding (str) –

  • VideoEncoding (str) –

  • VideoPositionInfo (str) –

  • Caption (str) –

  • FileSizeInBytes (int) –

  • PreviewImage (Image) –

  • SortOrder (int) –

uri: str
video_purpose: str
height: int
width: int
audio_encoding: str
video_encoding: str
video_position_info: str
caption: str
file_size_in_bytes: int
preview_image: Image
sort_order: int
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]] = {'audio_encoding': FieldInfo(annotation=str, required=True, alias='AudioEncoding'), 'caption': FieldInfo(annotation=str, required=True, alias='Caption'), 'file_size_in_bytes': FieldInfo(annotation=int, required=True, alias='FileSizeInBytes'), 'height': FieldInfo(annotation=int, required=True, alias='Height'), 'preview_image': FieldInfo(annotation=Image, required=True, alias='PreviewImage'), 'sort_order': FieldInfo(annotation=int, required=True, alias='SortOrder'), 'uri': FieldInfo(annotation=str, required=True, alias='Uri'), 'video_encoding': FieldInfo(annotation=str, required=True, alias='VideoEncoding'), 'video_position_info': FieldInfo(annotation=str, required=True, alias='VideoPositionInfo'), 'video_purpose': FieldInfo(annotation=str, required=True, alias='VideoPurpose'), 'width': FieldInfo(annotation=int, required=True, alias='Width')}

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.catalog.models.SearchTitle(*, SearchTitleString, SearchTitleType)[source]

Bases: PascalCaseModel

Parameters:

  • SearchTitleString (str) –

  • SearchTitleType (str) –

search_title_string: str
search_title_type: 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]] = {'search_title_string': FieldInfo(annotation=str, required=True, alias='SearchTitleString'), 'search_title_type': FieldInfo(annotation=str, required=True, alias='SearchTitleType')}

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.catalog.models.ContentRating(*, RatingSystem, RatingId, RatingDescriptors, RatingDisclaimers, InteractiveElements=None)[source]

Bases: PascalCaseModel

Parameters:

  • RatingSystem (str) –

  • RatingId (str) –

  • RatingDescriptors (List[str]) –

  • RatingDisclaimers (List) –

  • InteractiveElements (List | None) –

rating_system: str
rating_id: str
rating_descriptors: List[str]
rating_disclaimers: List
interactive_elements: List | 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]] = {'interactive_elements': FieldInfo(annotation=Union[List, NoneType], required=False, alias='InteractiveElements'), 'rating_descriptors': FieldInfo(annotation=List[str], required=True, alias='RatingDescriptors'), 'rating_disclaimers': FieldInfo(annotation=List, required=True, alias='RatingDisclaimers'), 'rating_id': FieldInfo(annotation=str, required=True, alias='RatingId'), 'rating_system': FieldInfo(annotation=str, required=True, alias='RatingSystem')}

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.catalog.models.UsageData(*, AggregateTimeSpan, AverageRating, PlayCount=None, RatingCount, RentalCount=None, TrialCount=None, PurchaseCount=None)[source]

Bases: PascalCaseModel

Parameters:

  • AggregateTimeSpan (str) –

  • AverageRating (float) –

  • PlayCount (int | None) –

  • RatingCount (int) –

  • RentalCount (str | None) –

  • TrialCount (str | None) –

  • PurchaseCount (str | None) –

aggregate_time_span: str
average_rating: float
play_count: int | None
rating_count: int
rental_count: str | None
trial_count: str | None
purchase_count: 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]] = {'aggregate_time_span': FieldInfo(annotation=str, required=True, alias='AggregateTimeSpan'), 'average_rating': FieldInfo(annotation=float, required=True, alias='AverageRating'), 'play_count': FieldInfo(annotation=Union[int, NoneType], required=False, alias='PlayCount'), 'purchase_count': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PurchaseCount'), 'rating_count': FieldInfo(annotation=int, required=True, alias='RatingCount'), 'rental_count': FieldInfo(annotation=Union[str, NoneType], required=False, alias='RentalCount'), 'trial_count': FieldInfo(annotation=Union[str, NoneType], required=False, alias='TrialCount')}

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.catalog.models.ProductProperties(*, Attributes=None, CanInstallToSDCard=None, Category=None, SubCategory=None, Categories=None, Extensions=None, IsAccessible=None, IsLineOfBusinessApp=None, IsPublishedToLegacyWindowsPhoneStore=None, IsPublishedToLegacyWindowsStore=None, IsSettingsApp=None, PackageFamilyName=None, PackageIdentityName=None, PublisherCertificateName=None, PublisherId, XboxLiveTier=None, XboxXPA=None, XboxCrossGenSetId=None, XboxConsoleGenOptimized=None, XboxConsoleGenCompatible=None, XboxLiveGoldRequired=None, OwnershipType=None, PdpBackgroundColor=None, HasAddOns=None, RevisionId, ProductGroupId=None, ProductGroupName=None)[source]

Bases: PascalCaseModel

Parameters:

  • Attributes (List | None) –

  • CanInstallToSDCard (bool | None) –

  • Category (str | None) –

  • SubCategory (str | None) –

  • Categories (List[str] | None) –

  • Extensions (Any) –

  • IsAccessible (bool | None) –

  • IsLineOfBusinessApp (bool | None) –

  • IsPublishedToLegacyWindowsPhoneStore (bool | None) –

  • IsPublishedToLegacyWindowsStore (bool | None) –

  • IsSettingsApp (bool | None) –

  • PackageFamilyName (str | None) –

  • PackageIdentityName (str | None) –

  • PublisherCertificateName (str | None) –

  • PublisherId (str) –

  • XboxLiveTier (Any) –

  • XboxXPA (Any) –

  • XboxCrossGenSetId (Any) –

  • XboxConsoleGenOptimized (Any) –

  • XboxConsoleGenCompatible (Any) –

  • XboxLiveGoldRequired (bool | None) –

  • OwnershipType (Any) –

  • PdpBackgroundColor (str | None) –

  • HasAddOns (bool | None) –

  • RevisionId (str) –

  • ProductGroupId (str | None) –

  • ProductGroupName (str | None) –

attributes: List | None
can_install_to_sd_card: bool | None
category: str | None
sub_category: str | None
categories: List[str] | None
extensions: Any
is_accessible: bool | None
is_line_of_business_app: bool | None
is_published_to_legacy_windows_phone_store: bool | None
is_published_to_legacy_windows_store: bool | None
is_settings_app: bool | None
package_family_name: str | None
package_identity_name: str | None
publisher_certificate_name: str | None
publisher_id: str
xbox_live_tier: Any
xbox_xpa: Any
xbox_cross_gen_set_id: Any
xbox_console_gen_optimized: Any
xbox_console_gen_compatible: Any
xbox_live_gold_required: bool | None
ownership_type: Any
pdp_background_color: str | None
has_add_ons: bool | None
revision_id: str
product_group_id: str | None
product_group_name: 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]] = {'attributes': FieldInfo(annotation=Union[List, NoneType], required=False, alias='Attributes'), 'can_install_to_sd_card': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='CanInstallToSDCard', alias_priority=2), 'categories': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Categories'), 'category': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Category'), 'extensions': FieldInfo(annotation=Any, required=False, alias='Extensions'), 'has_add_ons': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='HasAddOns'), 'is_accessible': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsAccessible'), 'is_line_of_business_app': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsLineOfBusinessApp'), 'is_published_to_legacy_windows_phone_store': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsPublishedToLegacyWindowsPhoneStore'), 'is_published_to_legacy_windows_store': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsPublishedToLegacyWindowsStore'), 'is_settings_app': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsSettingsApp'), 'ownership_type': FieldInfo(annotation=Any, required=False, alias='OwnershipType'), 'package_family_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PackageFamilyName'), 'package_identity_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PackageIdentityName'), 'pdp_background_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PdpBackgroundColor'), 'product_group_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductGroupId'), 'product_group_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductGroupName'), 'publisher_certificate_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PublisherCertificateName'), 'publisher_id': FieldInfo(annotation=str, required=True, alias='PublisherId'), 'revision_id': FieldInfo(annotation=str, required=True, alias='RevisionId'), 'sub_category': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SubCategory'), 'xbox_console_gen_compatible': FieldInfo(annotation=Any, required=False, alias='XboxConsoleGenCompatible'), 'xbox_console_gen_optimized': FieldInfo(annotation=Any, required=False, alias='XboxConsoleGenOptimized'), 'xbox_cross_gen_set_id': FieldInfo(annotation=Any, required=False, alias='XboxCrossGenSetId'), 'xbox_live_gold_required': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='XboxLiveGoldRequired'), 'xbox_live_tier': FieldInfo(annotation=Any, required=False, alias='XboxLiveTier'), 'xbox_xpa': FieldInfo(annotation=Any, required=False, alias='XboxXPA', alias_priority=2)}

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.catalog.models.AlternateId(*, IdType, Value)[source]

Bases: PascalCaseModel

Parameters:

  • IdType (str) –

  • Value (str) –

id_type: str
value: 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_type': FieldInfo(annotation=str, required=True, alias='IdType'), 'value': FieldInfo(annotation=str, required=True, alias='Value')}

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.catalog.models.ValidationData(*, PassedValidation, RevisionId, ValidationResultUri=None)[source]

Bases: PascalCaseModel

Parameters:

  • PassedValidation (bool) –

  • RevisionId (str) –

  • ValidationResultUri (str | None) –

passed_validation: bool
revision_id: str
validation_result_uri: 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]] = {'passed_validation': FieldInfo(annotation=bool, required=True, alias='PassedValidation'), 'revision_id': FieldInfo(annotation=str, required=True, alias='RevisionId'), 'validation_result_uri': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ValidationResultUri')}

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.catalog.models.FulfillmentData(*, ProductId, WuBundleId=None, WuCategoryId, PackageFamilyName, SkuId, Content=None, PackageFeatures=None)[source]

Bases: PascalCaseModel

Parameters:

  • ProductId (str) –

  • WuBundleId (str | None) –

  • WuCategoryId (str) –

  • PackageFamilyName (str) –

  • SkuId (str) –

  • Content (Any) –

  • PackageFeatures (Any) –

product_id: str
wu_bundle_id: str | None
wu_category_id: str
package_family_name: str
sku_id: str
content: Any
package_features: Any
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': FieldInfo(annotation=Any, required=False, alias='Content'), 'package_family_name': FieldInfo(annotation=str, required=True, alias='PackageFamilyName'), 'package_features': FieldInfo(annotation=Any, required=False, alias='PackageFeatures'), 'product_id': FieldInfo(annotation=str, required=True, alias='ProductId'), 'sku_id': FieldInfo(annotation=str, required=True, alias='SkuId'), 'wu_bundle_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='WuBundleId'), 'wu_category_id': FieldInfo(annotation=str, required=True, alias='WuCategoryId')}

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.catalog.models.HardwareProperties(*, MinimumHardware, RecommendedHardware, MinimumProcessor=None, RecommendedProcessor=None, MinimumGraphics=None, RecommendedGraphics=None)[source]

Bases: PascalCaseModel

Parameters:

  • MinimumHardware (List) –

  • RecommendedHardware (List) –

  • MinimumProcessor (Any) –

  • RecommendedProcessor (Any) –

  • MinimumGraphics (Any) –

  • RecommendedGraphics (Any) –

minimum_hardware: List
recommended_hardware: List
minimum_processor: Any
recommended_processor: Any
minimum_graphics: Any
recommended_graphics: Any
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]] = {'minimum_graphics': FieldInfo(annotation=Any, required=False, alias='MinimumGraphics'), 'minimum_hardware': FieldInfo(annotation=List, required=True, alias='MinimumHardware'), 'minimum_processor': FieldInfo(annotation=Any, required=False, alias='MinimumProcessor'), 'recommended_graphics': FieldInfo(annotation=Any, required=False, alias='RecommendedGraphics'), 'recommended_hardware': FieldInfo(annotation=List, required=True, alias='RecommendedHardware'), 'recommended_processor': FieldInfo(annotation=Any, required=False, alias='RecommendedProcessor')}

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.catalog.models.Application(*, ApplicationId, DeclarationOrder, Extensions)[source]

Bases: PascalCaseModel

Parameters:

  • ApplicationId (str) –

  • DeclarationOrder (int) –

  • Extensions (List[str]) –

application_id: str
declaration_order: int
extensions: List[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]] = {'application_id': FieldInfo(annotation=str, required=True, alias='ApplicationId'), 'declaration_order': FieldInfo(annotation=int, required=True, alias='DeclarationOrder'), 'extensions': FieldInfo(annotation=List[str], required=True, alias='Extensions')}

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.catalog.models.FrameworkDependency(*, MaxTested, MinVersion, PackageIdentity)[source]

Bases: PascalCaseModel

Parameters:

  • MaxTested (int) –

  • MinVersion (int) –

  • PackageIdentity (str) –

max_tested: int
min_version: int
package_identity: 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]] = {'max_tested': FieldInfo(annotation=int, required=True, alias='MaxTested'), 'min_version': FieldInfo(annotation=int, required=True, alias='MinVersion'), 'package_identity': FieldInfo(annotation=str, required=True, alias='PackageIdentity')}

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.catalog.models.PlatformDependency(*, MaxTested=None, MinVersion=None, PlatformName)[source]

Bases: PascalCaseModel

Parameters:

  • MaxTested (int | None) –

  • MinVersion (int | None) –

  • PlatformName (str) –

max_tested: int | None
min_version: int | None
platform_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]] = {'max_tested': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MaxTested'), 'min_version': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MinVersion'), 'platform_name': FieldInfo(annotation=str, required=True, alias='PlatformName')}

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.catalog.models.Package(*, Applications=None, Architectures, Capabilities=None, DeviceCapabilities=None, ExperienceIds=None, FrameworkDependencies=None, HardwareDependencies=None, HardwareRequirements=None, Hash=None, HashAlgorithm=None, IsStreamingApp=None, Languages=None, MaxDownloadSizeInBytes, MaxInstallSizeInBytes=None, PackageFormat, PackageFamilyName=None, MainPackageFamilyNameForDlc=None, PackageFullName=None, PackageId, ContentId, KeyId=None, PackageRank=None, PackageUri=None, PlatformDependencies=None, PlatformDependencyXmlBlob=None, ResourceId=None, Version=None, PackageDownloadUris=None, DriverDependencies=None, FulfillmentData=None)[source]

Bases: PascalCaseModel

Parameters:

  • Applications (List[Application] | None) –

  • Architectures (List[str]) –

  • Capabilities (List[str] | None) –

  • DeviceCapabilities (List[str] | None) –

  • ExperienceIds (List | None) –

  • FrameworkDependencies (List[FrameworkDependency] | None) –

  • HardwareDependencies (List | None) –

  • HardwareRequirements (List | None) –

  • Hash (str | None) –

  • HashAlgorithm (str | None) –

  • IsStreamingApp (bool | None) –

  • Languages (List[str] | None) –

  • MaxDownloadSizeInBytes (int) –

  • MaxInstallSizeInBytes (int | None) –

  • PackageFormat (str) –

  • PackageFamilyName (str | None) –

  • MainPackageFamilyNameForDlc (Any) –

  • PackageFullName (str | None) –

  • PackageId (str) –

  • ContentId (str) –

  • KeyId (str | None) –

  • PackageRank (int | None) –

  • PackageUri (str | None) –

  • PlatformDependencies (List[PlatformDependency] | None) –

  • PlatformDependencyXmlBlob (str | None) –

  • ResourceId (str | None) –

  • Version (str | None) –

  • PackageDownloadUris (Any) –

  • DriverDependencies (List | None) –

  • FulfillmentData (FulfillmentData | None) –

applications: List[Application] | None
architectures: List[str]
capabilities: List[str] | None
device_capabilities: List[str] | None
experience_ids: List | None
framework_dependencies: List[FrameworkDependency] | None
hardware_dependencies: List | None
hardware_requirements: List | None
hash: str | None
hash_algorithm: str | None
is_streaming_app: bool | None
languages: List[str] | None
max_download_size_in_bytes: int
max_install_size_in_bytes: int | None
package_format: str
package_family_name: str | None
main_package_family_name_for_dlc: Any
package_full_name: str | None
package_id: str
content_id: str
key_id: str | None
package_rank: int | None
package_uri: str | None
platform_dependencies: List[PlatformDependency] | None
platform_dependency_xml_blob: str | None
resource_id: str | None
version: str | None
package_download_uris: Any
driver_dependencies: List | None
fulfillment_data: FulfillmentData | 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]] = {'applications': FieldInfo(annotation=Union[List[Application], NoneType], required=False, alias='Applications'), 'architectures': FieldInfo(annotation=List[str], required=True, alias='Architectures'), 'capabilities': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Capabilities'), 'content_id': FieldInfo(annotation=str, required=True, alias='ContentId'), 'device_capabilities': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='DeviceCapabilities'), 'driver_dependencies': FieldInfo(annotation=Union[List, NoneType], required=False, alias='DriverDependencies'), 'experience_ids': FieldInfo(annotation=Union[List, NoneType], required=False, alias='ExperienceIds'), 'framework_dependencies': FieldInfo(annotation=Union[List[FrameworkDependency], NoneType], required=False, alias='FrameworkDependencies'), 'fulfillment_data': FieldInfo(annotation=Union[FulfillmentData, NoneType], required=False, alias='FulfillmentData'), 'hardware_dependencies': FieldInfo(annotation=Union[List, NoneType], required=False, alias='HardwareDependencies'), 'hardware_requirements': FieldInfo(annotation=Union[List, NoneType], required=False, alias='HardwareRequirements'), 'hash': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Hash'), 'hash_algorithm': FieldInfo(annotation=Union[str, NoneType], required=False, alias='HashAlgorithm'), 'is_streaming_app': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsStreamingApp'), 'key_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='KeyId'), 'languages': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Languages'), 'main_package_family_name_for_dlc': FieldInfo(annotation=Any, required=False, alias='MainPackageFamilyNameForDlc'), 'max_download_size_in_bytes': FieldInfo(annotation=int, required=True, alias='MaxDownloadSizeInBytes'), 'max_install_size_in_bytes': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MaxInstallSizeInBytes'), 'package_download_uris': FieldInfo(annotation=Any, required=False, alias='PackageDownloadUris'), 'package_family_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PackageFamilyName'), 'package_format': FieldInfo(annotation=str, required=True, alias='PackageFormat'), 'package_full_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PackageFullName'), 'package_id': FieldInfo(annotation=str, required=True, alias='PackageId'), 'package_rank': FieldInfo(annotation=Union[int, NoneType], required=False, alias='PackageRank'), 'package_uri': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PackageUri'), 'platform_dependencies': FieldInfo(annotation=Union[List[PlatformDependency], NoneType], required=False, alias='PlatformDependencies'), 'platform_dependency_xml_blob': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PlatformDependencyXmlBlob'), 'resource_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ResourceId'), 'version': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Version')}

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.catalog.models.LegalText(*, AdditionalLicenseTerms, Copyright, CopyrightUri, PrivacyPolicy, PrivacyPolicyUri, Tou, TouUri)[source]

Bases: PascalCaseModel

Parameters:

  • AdditionalLicenseTerms (str) –

  • Copyright (str) –

  • CopyrightUri (str) –

  • PrivacyPolicy (str) –

  • PrivacyPolicyUri (str) –

  • Tou (str) –

  • TouUri (str) –

additional_license_terms: str
copyright: str
copyright_uri: str
privacy_policy: str
privacy_policy_uri: str
tou: str
tou_uri: 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]] = {'additional_license_terms': FieldInfo(annotation=str, required=True, alias='AdditionalLicenseTerms'), 'copyright': FieldInfo(annotation=str, required=True, alias='Copyright'), 'copyright_uri': FieldInfo(annotation=str, required=True, alias='CopyrightUri'), 'privacy_policy': FieldInfo(annotation=str, required=True, alias='PrivacyPolicy'), 'privacy_policy_uri': FieldInfo(annotation=str, required=True, alias='PrivacyPolicyUri'), 'tou': FieldInfo(annotation=str, required=True, alias='Tou'), 'tou_uri': FieldInfo(annotation=str, required=True, alias='TouUri')}

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.catalog.models.SkuLocalizedProperty(*, Contributors=None, Features=None, MinimumNotes=None, RecommendedNotes=None, ReleaseNotes=None, DisplayPlatformProperties=None, SkuDescription, SkuTitle, SkuButtonTitle=None, DeliveryDateOverlay=None, SkuDisplayRank=None, TextResources=None, Images=None, LegalText=None, Language, Markets)[source]

Bases: PascalCaseModel

Parameters:

  • Contributors (List | None) –

  • Features (List | None) –

  • MinimumNotes (str | None) –

  • RecommendedNotes (str | None) –

  • ReleaseNotes (str | None) –

  • DisplayPlatformProperties (Any) –

  • SkuDescription (str) –

  • SkuTitle (str) –

  • SkuButtonTitle (str | None) –

  • DeliveryDateOverlay (Any) –

  • SkuDisplayRank (List | None) –

  • TextResources (Any) –

  • Images (List | None) –

  • LegalText (LegalText | None) –

  • Language (str) –

  • Markets (List[str]) –

contributors: List | None
features: List | None
minimum_notes: str | None
recommended_notes: str | None
release_notes: str | None
display_platform_properties: Any
sku_description: str
sku_title: str
sku_button_title: str | None
delivery_date_overlay: Any
sku_display_rank: List | None
text_resources: Any
images: List | None
legal_text: LegalText | None
language: str
markets: List[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]] = {'contributors': FieldInfo(annotation=Union[List, NoneType], required=False, alias='Contributors'), 'delivery_date_overlay': FieldInfo(annotation=Any, required=False, alias='DeliveryDateOverlay'), 'display_platform_properties': FieldInfo(annotation=Any, required=False, alias='DisplayPlatformProperties'), 'features': FieldInfo(annotation=Union[List, NoneType], required=False, alias='Features'), 'images': FieldInfo(annotation=Union[List, NoneType], required=False, alias='Images'), 'language': FieldInfo(annotation=str, required=True, alias='Language'), 'legal_text': FieldInfo(annotation=Union[LegalText, NoneType], required=False, alias='LegalText'), 'markets': FieldInfo(annotation=List[str], required=True, alias='Markets'), 'minimum_notes': FieldInfo(annotation=Union[str, NoneType], required=False, alias='MinimumNotes'), 'recommended_notes': FieldInfo(annotation=Union[str, NoneType], required=False, alias='RecommendedNotes'), 'release_notes': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ReleaseNotes'), 'sku_button_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SkuButtonTitle'), 'sku_description': FieldInfo(annotation=str, required=True, alias='SkuDescription'), 'sku_display_rank': FieldInfo(annotation=Union[List, NoneType], required=False, alias='SkuDisplayRank'), 'sku_title': FieldInfo(annotation=str, required=True, alias='SkuTitle'), 'text_resources': FieldInfo(annotation=Any, required=False, alias='TextResources')}

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.catalog.models.SkuMarketProperty(*, FirstAvailableDate=None, SupportedLanguages=None, PackageIds=None, PIFilter=None, Markets)[source]

Bases: PascalCaseModel

Parameters:
first_available_date: datetime | str | None
supported_languages: List[str] | None
package_ids: Any
pi_filter: Any
markets: List[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]] = {'first_available_date': FieldInfo(annotation=Union[datetime, str, NoneType], required=False, alias='FirstAvailableDate'), 'markets': FieldInfo(annotation=List[str], required=True, alias='Markets'), 'package_ids': FieldInfo(annotation=Any, required=False, alias='PackageIds'), 'pi_filter': FieldInfo(annotation=Any, required=False, alias='PIFilter', alias_priority=2), 'supported_languages': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='SupportedLanguages')}

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.catalog.models.SkuProperties(*, EarlyAdopterEnrollmentUrl=None, FulfillmentData=None, FulfillmentType=None, FulfillmentPluginId=None, HasThirdPartyIAPs=None, LastUpdateDate=None, HardwareProperties=None, HardwareRequirements=None, HardwareWarningList=None, InstallationTerms, Packages=None, VersionString=None, VisibleToB2BServiceIds, XboxXPA=None, BundledSkus=None, IsRepurchasable, SkuDisplayRank, DisplayPhysicalStoreInventory=None, AdditionalIdentifiers, IsTrial, IsPreOrder, IsBundle)[source]

Bases: PascalCaseModel

Parameters:

  • EarlyAdopterEnrollmentUrl (Any) –

  • FulfillmentData (FulfillmentData | None) –

  • FulfillmentType (str | None) –

  • FulfillmentPluginId (Any) –

  • HasThirdPartyIAPs (bool | None) –

  • LastUpdateDate (datetime | None) –

  • HardwareProperties (HardwareProperties | None) –

  • HardwareRequirements (List | None) –

  • HardwareWarningList (List | None) –

  • InstallationTerms (str) –

  • Packages (List[Package] | None) –

  • VersionString (str | None) –

  • VisibleToB2BServiceIds (List) –

  • XboxXPA (bool | None) –

  • BundledSkus (List | None) –

  • IsRepurchasable (bool) –

  • SkuDisplayRank (int) –

  • DisplayPhysicalStoreInventory (Any) –

  • AdditionalIdentifiers (List) –

  • IsTrial (bool) –

  • IsPreOrder (bool) –

  • IsBundle (bool) –

early_adopter_enrollment_url: Any
fulfillment_data: FulfillmentData | None
fulfillment_type: str | None
fulfillment_plugin_id: Any
has_third_party_iaps: bool | None
last_update_date: datetime | None
hardware_properties: HardwareProperties | None
hardware_requirements: List | None
hardware_warning_list: List | None
installation_terms: str
packages: List[Package] | None
version_string: str | None
visible_to_b2b_service_ids: List
xbox_xpa: bool | None
bundled_skus: List | None
is_repurchasable: bool
sku_display_rank: int
display_physical_store_inventory: Any
additional_identifiers: List
is_trial: bool
is_pre_order: bool
is_bundle: bool
validator()[source]
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]] = {'additional_identifiers': FieldInfo(annotation=List, required=True, alias='AdditionalIdentifiers'), 'bundled_skus': FieldInfo(annotation=Union[List, NoneType], required=False, alias='BundledSkus'), 'display_physical_store_inventory': FieldInfo(annotation=Any, required=False, alias='DisplayPhysicalStoreInventory'), 'early_adopter_enrollment_url': FieldInfo(annotation=Any, required=False, alias='EarlyAdopterEnrollmentUrl'), 'fulfillment_data': FieldInfo(annotation=Union[FulfillmentData, NoneType], required=False, alias='FulfillmentData'), 'fulfillment_plugin_id': FieldInfo(annotation=Any, required=False, alias='FulfillmentPluginId'), 'fulfillment_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='FulfillmentType'), 'hardware_properties': FieldInfo(annotation=Union[HardwareProperties, NoneType], required=False, alias='HardwareProperties'), 'hardware_requirements': FieldInfo(annotation=Union[List, NoneType], required=False, alias='HardwareRequirements'), 'hardware_warning_list': FieldInfo(annotation=Union[List, NoneType], required=False, alias='HardwareWarningList'), 'has_third_party_iaps': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='HasThirdPartyIAPs', alias_priority=2), 'installation_terms': FieldInfo(annotation=str, required=True, alias='InstallationTerms'), 'is_bundle': FieldInfo(annotation=bool, required=True, alias='IsBundle'), 'is_pre_order': FieldInfo(annotation=bool, required=True, alias='IsPreOrder'), 'is_repurchasable': FieldInfo(annotation=bool, required=True, alias='IsRepurchasable'), 'is_trial': FieldInfo(annotation=bool, required=True, alias='IsTrial'), 'last_update_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='LastUpdateDate'), 'packages': FieldInfo(annotation=Union[List[Package], NoneType], required=False, alias='Packages'), 'sku_display_rank': FieldInfo(annotation=int, required=True, alias='SkuDisplayRank'), 'version_string': FieldInfo(annotation=Union[str, NoneType], required=False, alias='VersionString'), 'visible_to_b2b_service_ids': FieldInfo(annotation=List, required=True, alias='VisibleToB2BServiceIds', alias_priority=2), 'xbox_xpa': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='XboxXPA', alias_priority=2)}

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.catalog.models.Sku(*, LastModifiedDate, LocalizedProperties, MarketProperties, ProductId, Properties, SkuASchema, SkuBSchema, SkuId, SkuType, RecurrencePolicy=None, SubscriptionPolicyId=None)[source]

Bases: PascalCaseModel

Parameters:
last_modified_date: datetime
localized_properties: List[SkuLocalizedProperty]
market_properties: List[SkuMarketProperty]
product_id: str
properties: SkuProperties
sku_a_schema: str
sku_b_schema: str
sku_id: str
sku_type: str
recurrence_policy: Any
subscription_policy_id: Any
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]] = {'last_modified_date': FieldInfo(annotation=datetime, required=True, alias='LastModifiedDate'), 'localized_properties': FieldInfo(annotation=List[SkuLocalizedProperty], required=True, alias='LocalizedProperties'), 'market_properties': FieldInfo(annotation=List[SkuMarketProperty], required=True, alias='MarketProperties'), 'product_id': FieldInfo(annotation=str, required=True, alias='ProductId'), 'properties': FieldInfo(annotation=SkuProperties, required=True, alias='Properties'), 'recurrence_policy': FieldInfo(annotation=Any, required=False, alias='RecurrencePolicy'), 'sku_a_schema': FieldInfo(annotation=str, required=True, alias='SkuASchema'), 'sku_b_schema': FieldInfo(annotation=str, required=True, alias='SkuBSchema'), 'sku_id': FieldInfo(annotation=str, required=True, alias='SkuId'), 'sku_type': FieldInfo(annotation=str, required=True, alias='SkuType'), 'subscription_policy_id': FieldInfo(annotation=Any, required=False, alias='SubscriptionPolicyId')}

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.catalog.models.AllowedPlatform(*, MaxVersion=None, MinVersion=None, PlatformName)[source]

Bases: PascalCaseModel

Parameters:

  • MaxVersion (int | None) –

  • MinVersion (int | None) –

  • PlatformName (str) –

max_version: int | None
min_version: int | None
platform_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]] = {'max_version': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MaxVersion'), 'min_version': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MinVersion'), 'platform_name': FieldInfo(annotation=str, required=True, alias='PlatformName')}

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.catalog.models.ClientConditions(*, AllowedPlatforms)[source]

Bases: PascalCaseModel

Parameters:

AllowedPlatforms (List[AllowedPlatform]) –

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

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.catalog.models.Conditions(*, ClientConditions, EndDate, ResourceSetIds, StartDate)[source]

Bases: PascalCaseModel

Parameters:
client_conditions: ClientConditions
end_date: datetime
resource_set_ids: List[str]
start_date: datetime
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]] = {'client_conditions': FieldInfo(annotation=ClientConditions, required=True, alias='ClientConditions'), 'end_date': FieldInfo(annotation=datetime, required=True, alias='EndDate'), 'resource_set_ids': FieldInfo(annotation=List[str], required=True, alias='ResourceSetIds'), 'start_date': FieldInfo(annotation=datetime, 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.catalog.models.PIFilter(*, ExclusionProperties, InclusionProperties)[source]

Bases: PascalCaseModel

Parameters:

  • ExclusionProperties (List) –

  • InclusionProperties (List) –

exclusion_properties: List
inclusion_properties: List
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]] = {'exclusion_properties': FieldInfo(annotation=List, required=True, alias='ExclusionProperties'), 'inclusion_properties': FieldInfo(annotation=List, required=True, alias='InclusionProperties')}

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.catalog.models.Price(*, CurrencyCode, IsPIRequired, ListPrice, MSRP, TaxType, WholesaleCurrencyCode)[source]

Bases: PascalCaseModel

Parameters:

  • CurrencyCode (str) –

  • IsPIRequired (bool) –

  • ListPrice (float) –

  • MSRP (float) –

  • TaxType (str) –

  • WholesaleCurrencyCode (str) –

currency_code: str
is_pi_required: bool
list_price: float
msrp: float
tax_type: str
wholesale_currency_code: 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]] = {'currency_code': FieldInfo(annotation=str, required=True, alias='CurrencyCode'), 'is_pi_required': FieldInfo(annotation=bool, required=True, alias='IsPIRequired', alias_priority=2), 'list_price': FieldInfo(annotation=float, required=True, alias='ListPrice'), 'msrp': FieldInfo(annotation=float, required=True, alias='MSRP', alias_priority=2), 'tax_type': FieldInfo(annotation=str, required=True, alias='TaxType'), 'wholesale_currency_code': FieldInfo(annotation=str, required=True, alias='WholesaleCurrencyCode')}

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.catalog.models.OrderManagementData(*, GrantedEntitlementKeys=None, PIFilter=None, Price)[source]

Bases: PascalCaseModel

Parameters:

  • GrantedEntitlementKeys (List | None) –

  • PIFilter (PIFilter | None) –

  • Price (Price) –

granted_entitlement_keys: List | None
pi_filter: PIFilter | None
price: Price
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]] = {'granted_entitlement_keys': FieldInfo(annotation=Union[List, NoneType], required=False, alias='GrantedEntitlementKeys'), 'pi_filter': FieldInfo(annotation=Union[PIFilter, NoneType], required=False, alias='PIFilter', alias_priority=2), 'price': FieldInfo(annotation=Price, required=True, alias='Price')}

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.catalog.models.AvailabilityProperties(*, OriginalReleaseDate=None)[source]

Bases: PascalCaseModel

Parameters:

OriginalReleaseDate (datetime | None) –

original_release_date: datetime | 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]] = {'original_release_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='OriginalReleaseDate')}

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.catalog.models.SatisfyingEntitlementKey(*, EntitlementKeys, LicensingKeyIds)[source]

Bases: PascalCaseModel

Parameters:
entitlement_keys: List[str]
licensing_key_ids: List[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]] = {'entitlement_keys': FieldInfo(annotation=List[str], required=True, alias='EntitlementKeys'), 'licensing_key_ids': FieldInfo(annotation=List[str], required=True, alias='LicensingKeyIds')}

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.catalog.models.LicensingData(*, SatisfyingEntitlementKeys)[source]

Bases: PascalCaseModel

Parameters:

SatisfyingEntitlementKeys (List[SatisfyingEntitlementKey]) –

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

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.catalog.models.Availability(*, Actions, AvailabilityASchema=None, AvailabilityBSchema=None, AvailabilityId=None, Conditions=None, LastModifiedDate=None, Markets=None, OrderManagementData=None, Properties=None, SkuId=None, DisplayRank=None, RemediationRequired=None, LicensingData=None)[source]

Bases: PascalCaseModel

Parameters:
actions: List[str]
availability_a_schema: str | None
availability_b_schema: str | None
availability_id: str | None
conditions: Conditions | None
last_modified_date: datetime | None
markets: List[str] | None
order_management_data: OrderManagementData | None
properties: AvailabilityProperties | None
sku_id: str | None
display_rank: int | None
remediation_required: bool | None
licensing_data: LicensingData | 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]] = {'actions': FieldInfo(annotation=List[str], required=True, alias='Actions'), 'availability_a_schema': FieldInfo(annotation=Union[str, NoneType], required=False, alias='AvailabilityASchema'), 'availability_b_schema': FieldInfo(annotation=Union[str, NoneType], required=False, alias='AvailabilityBSchema'), 'availability_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='AvailabilityId'), 'conditions': FieldInfo(annotation=Union[Conditions, NoneType], required=False, alias='Conditions'), 'display_rank': FieldInfo(annotation=Union[int, NoneType], required=False, alias='DisplayRank'), 'last_modified_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='LastModifiedDate'), 'licensing_data': FieldInfo(annotation=Union[LicensingData, NoneType], required=False, alias='LicensingData'), 'markets': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Markets'), 'order_management_data': FieldInfo(annotation=Union[OrderManagementData, NoneType], required=False, alias='OrderManagementData'), 'properties': FieldInfo(annotation=Union[AvailabilityProperties, NoneType], required=False, alias='Properties'), 'remediation_required': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='RemediationRequired'), 'sku_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SkuId')}

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.catalog.models.DisplaySkuAvailability(*, Sku=None, Availabilities)[source]

Bases: PascalCaseModel

Parameters:
sku: Sku | None
availabilities: List[Availability]
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]] = {'availabilities': FieldInfo(annotation=List[Availability], required=True, alias='Availabilities'), 'sku': FieldInfo(annotation=Union[Sku, NoneType], required=False, alias='Sku')}

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.catalog.models.LocalizedProperty(*, DeveloperName=None, DisplayPlatformProperties=None, PublisherName=None, PublisherWebsiteUri=None, SupportUri=None, EligibilityProperties=None, Franchises=None, Images, Videos=None, ProductDescription=None, ProductTitle, ShortTitle=None, SortTitle=None, FriendlyTitle=None, ShortDescription=None, SearchTitles=None, VoiceTitle=None, RenderGroupDetails=None, ProductDisplayRanks=None, InteractiveModelConfig=None, Interactive3DEnabled=None, Language=None, Markets=None)[source]

Bases: PascalCaseModel

Parameters:

  • DeveloperName (str | None) –

  • DisplayPlatformProperties (Any | None) –

  • PublisherName (str | None) –

  • PublisherWebsiteUri (str | None) –

  • SupportUri (str | None) –

  • EligibilityProperties (Any | None) –

  • Franchises (List | None) –

  • Images (List[Image]) –

  • Videos (List[Video] | None) –

  • ProductDescription (str | None) –

  • ProductTitle (str) –

  • ShortTitle (str | None) –

  • SortTitle (str | None) –

  • FriendlyTitle (str | None) –

  • ShortDescription (str | None) –

  • SearchTitles (List[SearchTitle] | None) –

  • VoiceTitle (str | None) –

  • RenderGroupDetails (Any | None) –

  • ProductDisplayRanks (List | None) –

  • InteractiveModelConfig (Any | None) –

  • Interactive3DEnabled (bool | None) –

  • Language (str | None) –

  • Markets (List[str] | None) –

developer_name: str | None
display_platform_properties: Any | None
publisher_name: str | None
publisher_website_uri: str | None
support_uri: str | None
eligibility_properties: Any | None
franchises: List | None
images: List[Image]
videos: List[Video] | None
product_description: str | None
product_title: str
short_title: str | None
sort_title: str | None
friendly_title: str | None
short_description: str | None
search_titles: List[SearchTitle] | None
voice_title: str | None
render_group_details: Any | None
product_display_ranks: List | None
interactive_model_config: Any | None
interactive_3d_enabled: bool | None
language: str | None
markets: List[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]] = {'developer_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='DeveloperName'), 'display_platform_properties': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='DisplayPlatformProperties'), 'eligibility_properties': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='EligibilityProperties'), 'franchises': FieldInfo(annotation=Union[List, NoneType], required=False, alias='Franchises'), 'friendly_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='FriendlyTitle'), 'images': FieldInfo(annotation=List[Image], required=True, alias='Images'), 'interactive_3d_enabled': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='Interactive3DEnabled', alias_priority=2), 'interactive_model_config': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='InteractiveModelConfig'), 'language': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Language'), 'markets': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Markets'), 'product_description': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductDescription'), 'product_display_ranks': FieldInfo(annotation=Union[List, NoneType], required=False, alias='ProductDisplayRanks'), 'product_title': FieldInfo(annotation=str, required=True, alias='ProductTitle'), 'publisher_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PublisherName'), 'publisher_website_uri': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PublisherWebsiteUri'), 'render_group_details': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='RenderGroupDetails'), 'search_titles': FieldInfo(annotation=Union[List[SearchTitle], NoneType], required=False, alias='SearchTitles'), 'short_description': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ShortDescription'), 'short_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ShortTitle'), 'sort_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SortTitle'), 'support_uri': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SupportUri'), 'videos': FieldInfo(annotation=Union[List[Video], NoneType], required=False, alias='Videos'), 'voice_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='VoiceTitle')}

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.catalog.models.MarketProperty(*, OriginalReleaseDate=None, OriginalReleaseFriendlyName=None, MinimumUserAge=None, ContentRatings=None, RelatedProducts=None, UsageData, BundleConfig=None, Markets=None)[source]

Bases: PascalCaseModel

Parameters:

  • OriginalReleaseDate (datetime | None) –

  • OriginalReleaseFriendlyName (str | None) –

  • MinimumUserAge (int | None) –

  • ContentRatings (List[ContentRating] | None) –

  • RelatedProducts (List | None) –

  • UsageData (List[UsageData]) –

  • BundleConfig (Any | None) –

  • Markets (List[str] | None) –

original_release_date: datetime | None
original_release_friendly_name: str | None
minimum_user_age: int | None
content_ratings: List[ContentRating] | None
related_products: List | None
usage_data: List[UsageData]
bundle_config: Any | None
markets: List[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]] = {'bundle_config': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='BundleConfig'), 'content_ratings': FieldInfo(annotation=Union[List[ContentRating], NoneType], required=False, alias='ContentRatings'), 'markets': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='Markets'), 'minimum_user_age': FieldInfo(annotation=Union[int, NoneType], required=False, alias='MinimumUserAge'), 'original_release_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='OriginalReleaseDate'), 'original_release_friendly_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='OriginalReleaseFriendlyName'), 'related_products': FieldInfo(annotation=Union[List, NoneType], required=False, alias='RelatedProducts'), 'usage_data': FieldInfo(annotation=List[UsageData], required=True, alias='UsageData')}

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.catalog.models.Product(*, LastModifiedDate=None, LocalizedProperties, MarketProperties, ProductASchema=None, ProductBSchema=None, ProductId, Properties=None, AlternateIds=None, DomainDataVersion=None, IngestionSource=None, IsMicrosoftProduct=None, PreferredSkuId=None, ProductType=None, ValidationData=None, MerchandizingTags=None, PartD=None, ProductFamily, SchemaVersion=None, ProductKind, DisplaySkuAvailabilities)[source]

Bases: PascalCaseModel

Parameters:
last_modified_date: datetime | None
localized_properties: List[LocalizedProperty]
market_properties: List[MarketProperty]
product_a_schema: str | None
product_b_schema: str | None
product_id: str
properties: ProductProperties | None
alternate_ids: List[AlternateId] | None
domain_data_version: Any | None
ingestion_source: str | None
is_microsoft_product: bool | None
preferred_sku_id: str | None
product_type: str | None
validation_data: ValidationData | None
merchandizing_tags: List | None
part_d: str | None
product_family: str
schema_version: str | None
product_kind: str
display_sku_availabilities: List[DisplaySkuAvailability]
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]] = {'alternate_ids': FieldInfo(annotation=Union[List[AlternateId], NoneType], required=False, alias='AlternateIds'), 'display_sku_availabilities': FieldInfo(annotation=List[DisplaySkuAvailability], required=True, alias='DisplaySkuAvailabilities'), 'domain_data_version': FieldInfo(annotation=Union[Any, NoneType], required=False, alias='DomainDataVersion'), 'ingestion_source': FieldInfo(annotation=Union[str, NoneType], required=False, alias='IngestionSource'), 'is_microsoft_product': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='IsMicrosoftProduct'), 'last_modified_date': FieldInfo(annotation=Union[datetime, NoneType], required=False, alias='LastModifiedDate'), 'localized_properties': FieldInfo(annotation=List[LocalizedProperty], required=True, alias='LocalizedProperties'), 'market_properties': FieldInfo(annotation=List[MarketProperty], required=True, alias='MarketProperties'), 'merchandizing_tags': FieldInfo(annotation=Union[List, NoneType], required=False, alias='MerchandizingTags'), 'part_d': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PartD'), 'preferred_sku_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='PreferredSkuId'), 'product_a_schema': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductASchema'), 'product_b_schema': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductBSchema'), 'product_family': FieldInfo(annotation=str, required=True, alias='ProductFamily'), 'product_id': FieldInfo(annotation=str, required=True, alias='ProductId'), 'product_kind': FieldInfo(annotation=str, required=True, alias='ProductKind'), 'product_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ProductType'), 'properties': FieldInfo(annotation=Union[ProductProperties, NoneType], required=False, alias='Properties'), 'schema_version': FieldInfo(annotation=Union[str, NoneType], required=False, alias='SchemaVersion'), 'validation_data': FieldInfo(annotation=Union[ValidationData, NoneType], required=False, alias='ValidationData')}

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.catalog.models.CatalogResponse(*, BigIds=None, HasMorePages=None, Products, TotalResultCount=None)[source]

Bases: PascalCaseModel

Parameters:

  • BigIds (List[str] | None) –

  • HasMorePages (bool | None) –

  • Products (List[Product]) –

  • TotalResultCount (int | None) –

big_ids: List[str] | None
has_more_pages: bool | None
products: List[Product]
total_result_count: int | 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]] = {'big_ids': FieldInfo(annotation=Union[List[str], NoneType], required=False, alias='BigIds'), 'has_more_pages': FieldInfo(annotation=Union[bool, NoneType], required=False, alias='HasMorePages'), 'products': FieldInfo(annotation=List[Product], required=True, alias='Products'), 'total_result_count': FieldInfo(annotation=Union[int, NoneType], required=False, alias='TotalResultCount')}

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.catalog.models.SearchProduct(*, BackgroundColor=None, Height=None, ImageType=None, Width=None, PlatformProperties, Icon=None, ProductId, Type, Title)[source]

Bases: PascalCaseModel

Parameters:

  • BackgroundColor (str | None) –

  • Height (int | None) –

  • ImageType (str | None) –

  • Width (int | None) –

  • PlatformProperties (List) –

  • Icon (str | None) –

  • ProductId (str) –

  • Type (str) –

  • Title (str) –

background_color: str | None
height: int | None
image_type: str | None
width: int | None
platform_properties: List
icon: str | None
product_id: str
type: str
title: 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]] = {'background_color': FieldInfo(annotation=Union[str, NoneType], required=False, alias='BackgroundColor'), 'height': FieldInfo(annotation=Union[int, NoneType], required=False, alias='Height'), 'icon': FieldInfo(annotation=Union[str, NoneType], required=False, alias='Icon'), 'image_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='ImageType'), 'platform_properties': FieldInfo(annotation=List, required=True, alias='PlatformProperties'), 'product_id': FieldInfo(annotation=str, required=True, alias='ProductId'), 'title': FieldInfo(annotation=str, required=True, alias='Title'), 'type': FieldInfo(annotation=str, required=True, alias='Type'), 'width': FieldInfo(annotation=Union[int, NoneType], required=False, alias='Width')}

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.catalog.models.CatalogSearchResult(*, ProductFamilyName, Products)[source]

Bases: PascalCaseModel

Parameters:
product_family_name: str
products: List[SearchProduct]
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]] = {'product_family_name': FieldInfo(annotation=str, required=True, alias='ProductFamilyName'), 'products': FieldInfo(annotation=List[SearchProduct], required=True, alias='Products')}

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.catalog.models.CatalogSearchResponse(*, Results, TotalResultCount)[source]

Bases: PascalCaseModel

Parameters:
results: List[CatalogSearchResult]
total_result_count: int
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]] = {'results': FieldInfo(annotation=List[CatalogSearchResult], required=True, alias='Results'), 'total_result_count': FieldInfo(annotation=int, required=True, alias='TotalResultCount')}

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

This replaces Model.__fields__ from Pydantic V1.