Catalog models

pythonxbox.api.provider.catalog.models.AlternateIdType

Bases: StrEnum

LEGACY_XBOX_PRODUCT_ID = 'LegacyXboxProductId' class-attribute instance-attribute

XBOX_TITLE_ID = 'XboxTitleId' class-attribute instance-attribute

PACKAGE_FAMILY_NAME = 'PackageFamilyName' class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.FieldsTemplate

Bases: StrEnum

BROWSE = 'browse' class-attribute instance-attribute

DETAILS = 'details' class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.PlatformType

Bases: StrEnum

XBOX = 'windows.xbox' class-attribute instance-attribute

DESKTOP = 'windows.desktop' class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.Image

Bases: PascalCaseModel

file_id = None class-attribute instance-attribute

eis_listing_identifier = Field(None, alias='EISListingIdentifier') class-attribute instance-attribute

background_color = None class-attribute instance-attribute

caption = None class-attribute instance-attribute

file_size_in_bytes instance-attribute

foreground_color = None class-attribute instance-attribute

height instance-attribute

image_position_info = None class-attribute instance-attribute

image_purpose instance-attribute

unscaled_image_sha256_hash = Field(None, alias='UnscaledImageSHA256Hash') class-attribute instance-attribute

uri instance-attribute

width instance-attribute

pythonxbox.api.provider.catalog.models.Video

Bases: PascalCaseModel

uri instance-attribute

video_purpose instance-attribute

height instance-attribute

width instance-attribute

audio_encoding instance-attribute

video_encoding instance-attribute

video_position_info instance-attribute

caption instance-attribute

file_size_in_bytes instance-attribute

preview_image instance-attribute

sort_order instance-attribute

pythonxbox.api.provider.catalog.models.SearchTitle

Bases: PascalCaseModel

search_title_string instance-attribute

search_title_type instance-attribute

pythonxbox.api.provider.catalog.models.ContentRating

Bases: PascalCaseModel

rating_system instance-attribute

rating_id instance-attribute

rating_descriptors instance-attribute

rating_disclaimers instance-attribute

interactive_elements = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.UsageData

Bases: PascalCaseModel

aggregate_time_span instance-attribute

average_rating instance-attribute

play_count = None class-attribute instance-attribute

rating_count instance-attribute

rental_count = None class-attribute instance-attribute

trial_count = None class-attribute instance-attribute

purchase_count = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.ProductProperties

Bases: PascalCaseModel

attributes = None class-attribute instance-attribute

can_install_to_sd_card = Field(None, alias='CanInstallToSDCard') class-attribute instance-attribute

category = None class-attribute instance-attribute

sub_category = None class-attribute instance-attribute

categories = None class-attribute instance-attribute

extensions = None class-attribute instance-attribute

is_accessible = None class-attribute instance-attribute

is_line_of_business_app = None class-attribute instance-attribute

is_published_to_legacy_windows_phone_store = None class-attribute instance-attribute

is_published_to_legacy_windows_store = None class-attribute instance-attribute

is_settings_app = None class-attribute instance-attribute

package_family_name = None class-attribute instance-attribute

package_identity_name = None class-attribute instance-attribute

publisher_certificate_name = None class-attribute instance-attribute

publisher_id instance-attribute

xbox_live_tier = None class-attribute instance-attribute

xbox_xpa = Field(None, alias='XboxXPA') class-attribute instance-attribute

xbox_cross_gen_set_id = None class-attribute instance-attribute

xbox_console_gen_optimized = None class-attribute instance-attribute

xbox_console_gen_compatible = None class-attribute instance-attribute

xbox_live_gold_required = None class-attribute instance-attribute

ownership_type = None class-attribute instance-attribute

pdp_background_color = None class-attribute instance-attribute

has_add_ons = None class-attribute instance-attribute

revision_id instance-attribute

product_group_id = None class-attribute instance-attribute

product_group_name = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.AlternateId

Bases: PascalCaseModel

id_type instance-attribute

value instance-attribute

pythonxbox.api.provider.catalog.models.ValidationData

Bases: PascalCaseModel

passed_validation instance-attribute

revision_id instance-attribute

validation_result_uri = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.FulfillmentData

Bases: PascalCaseModel

product_id instance-attribute

wu_bundle_id = None class-attribute instance-attribute

wu_category_id instance-attribute

package_family_name instance-attribute

sku_id instance-attribute

content = None class-attribute instance-attribute

package_features = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.HardwareProperties

Bases: PascalCaseModel

minimum_hardware instance-attribute

recommended_hardware instance-attribute

minimum_processor = None class-attribute instance-attribute

recommended_processor = None class-attribute instance-attribute

minimum_graphics = None class-attribute instance-attribute

recommended_graphics = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.Application

Bases: PascalCaseModel

application_id instance-attribute

declaration_order instance-attribute

extensions instance-attribute

pythonxbox.api.provider.catalog.models.FrameworkDependency

Bases: PascalCaseModel

max_tested instance-attribute

min_version instance-attribute

package_identity instance-attribute

pythonxbox.api.provider.catalog.models.PlatformDependency

Bases: PascalCaseModel

max_tested = None class-attribute instance-attribute

min_version = None class-attribute instance-attribute

platform_name instance-attribute

pythonxbox.api.provider.catalog.models.Package

Bases: PascalCaseModel

applications = None class-attribute instance-attribute

architectures instance-attribute

capabilities = None class-attribute instance-attribute

device_capabilities = None class-attribute instance-attribute

experience_ids = None class-attribute instance-attribute

framework_dependencies = None class-attribute instance-attribute

hardware_dependencies = None class-attribute instance-attribute

hardware_requirements = None class-attribute instance-attribute

hash = None class-attribute instance-attribute

hash_algorithm = None class-attribute instance-attribute

is_streaming_app = None class-attribute instance-attribute

languages = None class-attribute instance-attribute

max_download_size_in_bytes instance-attribute

max_install_size_in_bytes = None class-attribute instance-attribute

package_format instance-attribute

package_family_name = None class-attribute instance-attribute

main_package_family_name_for_dlc = None class-attribute instance-attribute

package_full_name = None class-attribute instance-attribute

package_id instance-attribute

content_id instance-attribute

key_id = None class-attribute instance-attribute

package_rank = None class-attribute instance-attribute

package_uri = None class-attribute instance-attribute

platform_dependencies = None class-attribute instance-attribute

platform_dependency_xml_blob = None class-attribute instance-attribute

resource_id = None class-attribute instance-attribute

version = None class-attribute instance-attribute

package_download_uris = None class-attribute instance-attribute

driver_dependencies = None class-attribute instance-attribute

fulfillment_data = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.LegalText

Bases: PascalCaseModel

additional_license_terms instance-attribute

copyright instance-attribute

copyright_uri instance-attribute

privacy_policy instance-attribute

privacy_policy_uri instance-attribute

tou instance-attribute

tou_uri instance-attribute

pythonxbox.api.provider.catalog.models.SkuLocalizedProperty

Bases: PascalCaseModel

contributors = None class-attribute instance-attribute

features = None class-attribute instance-attribute

minimum_notes = None class-attribute instance-attribute

recommended_notes = None class-attribute instance-attribute

release_notes = None class-attribute instance-attribute

display_platform_properties = None class-attribute instance-attribute

sku_description instance-attribute

sku_title instance-attribute

sku_button_title = None class-attribute instance-attribute

delivery_date_overlay = None class-attribute instance-attribute

sku_display_rank = None class-attribute instance-attribute

text_resources = None class-attribute instance-attribute

images = None class-attribute instance-attribute

legal_text = None class-attribute instance-attribute

language instance-attribute

markets instance-attribute

pythonxbox.api.provider.catalog.models.SkuMarketProperty

Bases: PascalCaseModel

first_available_date = None class-attribute instance-attribute

supported_languages = None class-attribute instance-attribute

package_ids = None class-attribute instance-attribute

pi_filter = Field(None, alias='PIFilter') class-attribute instance-attribute

markets instance-attribute

pythonxbox.api.provider.catalog.models.SkuProperties

Bases: PascalCaseModel

early_adopter_enrollment_url = None class-attribute instance-attribute

fulfillment_data = None class-attribute instance-attribute

fulfillment_type = None class-attribute instance-attribute

fulfillment_plugin_id = None class-attribute instance-attribute

has_third_party_iaps = Field(None, alias='HasThirdPartyIAPs') class-attribute instance-attribute

last_update_date = None class-attribute instance-attribute

hardware_properties = None class-attribute instance-attribute

hardware_requirements = None class-attribute instance-attribute

hardware_warning_list = None class-attribute instance-attribute

installation_terms instance-attribute

packages = None class-attribute instance-attribute

version_string = None class-attribute instance-attribute

visible_to_b2b_service_ids = Field(alias='VisibleToB2BServiceIds') class-attribute instance-attribute

xbox_xpa = Field(None, alias='XboxXPA') class-attribute instance-attribute

bundled_skus = None class-attribute instance-attribute

is_repurchasable instance-attribute

sku_display_rank instance-attribute

display_physical_store_inventory = None class-attribute instance-attribute

additional_identifiers instance-attribute

is_trial instance-attribute

is_pre_order instance-attribute

is_bundle instance-attribute

validator(x)

Source code in src/pythonxbox/api/provider/catalog/models.py

@field_validator("last_update_date", mode="before", check_fields=True)
def validator(x: "SkuProperties") -> "SkuProperties":
    return x or None

pythonxbox.api.provider.catalog.models.Sku

Bases: PascalCaseModel

last_modified_date instance-attribute

localized_properties instance-attribute

market_properties instance-attribute

product_id instance-attribute

properties instance-attribute

sku_a_schema instance-attribute

sku_b_schema instance-attribute

sku_id instance-attribute

sku_type instance-attribute

recurrence_policy = None class-attribute instance-attribute

subscription_policy_id = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.AllowedPlatform

Bases: PascalCaseModel

max_version = None class-attribute instance-attribute

min_version = None class-attribute instance-attribute

platform_name instance-attribute

pythonxbox.api.provider.catalog.models.ClientConditions

Bases: PascalCaseModel

allowed_platforms instance-attribute

pythonxbox.api.provider.catalog.models.Conditions

Bases: PascalCaseModel

client_conditions instance-attribute

end_date instance-attribute

resource_set_ids instance-attribute

start_date instance-attribute

pythonxbox.api.provider.catalog.models.PIFilter

Bases: PascalCaseModel

exclusion_properties instance-attribute

inclusion_properties instance-attribute

pythonxbox.api.provider.catalog.models.Price

Bases: PascalCaseModel

currency_code instance-attribute

is_pi_required = Field(alias='IsPIRequired') class-attribute instance-attribute

list_price instance-attribute

msrp = Field(alias='MSRP') class-attribute instance-attribute

tax_type instance-attribute

wholesale_currency_code instance-attribute

pythonxbox.api.provider.catalog.models.OrderManagementData

Bases: PascalCaseModel

granted_entitlement_keys = None class-attribute instance-attribute

pi_filter = Field(None, alias='PIFilter') class-attribute instance-attribute

price instance-attribute

pythonxbox.api.provider.catalog.models.AvailabilityProperties

Bases: PascalCaseModel

original_release_date = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.SatisfyingEntitlementKey

Bases: PascalCaseModel

entitlement_keys instance-attribute

licensing_key_ids instance-attribute

pythonxbox.api.provider.catalog.models.LicensingData

Bases: PascalCaseModel

satisfying_entitlement_keys instance-attribute

pythonxbox.api.provider.catalog.models.Availability

Bases: PascalCaseModel

actions instance-attribute

availability_a_schema = None class-attribute instance-attribute

availability_b_schema = None class-attribute instance-attribute

availability_id = None class-attribute instance-attribute

conditions = None class-attribute instance-attribute

last_modified_date = None class-attribute instance-attribute

markets = None class-attribute instance-attribute

order_management_data = None class-attribute instance-attribute

properties = None class-attribute instance-attribute

sku_id = None class-attribute instance-attribute

display_rank = None class-attribute instance-attribute

remediation_required = None class-attribute instance-attribute

licensing_data = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.DisplaySkuAvailability

Bases: PascalCaseModel

sku = None class-attribute instance-attribute

availabilities instance-attribute

pythonxbox.api.provider.catalog.models.LocalizedProperty

Bases: PascalCaseModel

developer_name = None class-attribute instance-attribute

display_platform_properties = None class-attribute instance-attribute

publisher_name = None class-attribute instance-attribute

publisher_website_uri = None class-attribute instance-attribute

support_uri = None class-attribute instance-attribute

eligibility_properties = None class-attribute instance-attribute

franchises = None class-attribute instance-attribute

images instance-attribute

videos = None class-attribute instance-attribute

product_description = None class-attribute instance-attribute

product_title instance-attribute

short_title = None class-attribute instance-attribute

sort_title = None class-attribute instance-attribute

friendly_title = None class-attribute instance-attribute

short_description = None class-attribute instance-attribute

search_titles = None class-attribute instance-attribute

voice_title = None class-attribute instance-attribute

render_group_details = None class-attribute instance-attribute

product_display_ranks = None class-attribute instance-attribute

interactive_model_config = None class-attribute instance-attribute

interactive_3d_enabled = Field(None, alias='Interactive3DEnabled') class-attribute instance-attribute

language = None class-attribute instance-attribute

markets = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.MarketProperty

Bases: PascalCaseModel

original_release_date = None class-attribute instance-attribute

original_release_friendly_name = None class-attribute instance-attribute

minimum_user_age = None class-attribute instance-attribute

content_ratings = None class-attribute instance-attribute

related_products = None class-attribute instance-attribute

usage_data instance-attribute

bundle_config = None class-attribute instance-attribute

markets = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.Product

Bases: PascalCaseModel

last_modified_date = None class-attribute instance-attribute

localized_properties instance-attribute

market_properties instance-attribute

product_a_schema = None class-attribute instance-attribute

product_b_schema = None class-attribute instance-attribute

product_id instance-attribute

properties = None class-attribute instance-attribute

alternate_ids = None class-attribute instance-attribute

domain_data_version = None class-attribute instance-attribute

ingestion_source = None class-attribute instance-attribute

is_microsoft_product = None class-attribute instance-attribute

preferred_sku_id = None class-attribute instance-attribute

product_type = None class-attribute instance-attribute

validation_data = None class-attribute instance-attribute

merchandizing_tags = None class-attribute instance-attribute

part_d = None class-attribute instance-attribute

product_family instance-attribute

schema_version = None class-attribute instance-attribute

product_kind instance-attribute

display_sku_availabilities instance-attribute

pythonxbox.api.provider.catalog.models.CatalogResponse

Bases: PascalCaseModel

big_ids = None class-attribute instance-attribute

has_more_pages = None class-attribute instance-attribute

products instance-attribute

total_result_count = None class-attribute instance-attribute

pythonxbox.api.provider.catalog.models.SearchProduct

Bases: PascalCaseModel

background_color = None class-attribute instance-attribute

height = None class-attribute instance-attribute

image_type = None class-attribute instance-attribute

width = None class-attribute instance-attribute

platform_properties instance-attribute

icon = None class-attribute instance-attribute

product_id instance-attribute

type instance-attribute

title instance-attribute

pythonxbox.api.provider.catalog.models.CatalogSearchResult

Bases: PascalCaseModel

product_family_name instance-attribute

products instance-attribute

pythonxbox.api.provider.catalog.models.CatalogSearchResponse

Bases: PascalCaseModel

results instance-attribute

total_result_count instance-attribute