python-xbox 0.1.0__py3-none-any.whl

pythonxbox/api/provider/achievements/__init__.py

@@ -0,0 +1,164 @@
+"""
+Achievements
+
+Get Xbox 360 and Xbox One Achievement data
+"""
+
+from pythonxbox.api.provider.achievements.models import (
+    Achievement360ProgressResponse,
+    Achievement360Response,
+    AchievementResponse,
+    RecentProgressResponse,
+)
+from pythonxbox.api.provider.ratelimitedprovider import RateLimitedProvider
+
+
+class AchievementsProvider(RateLimitedProvider):
+    ACHIEVEMENTS_URL = "https://achievements.xboxlive.com"
+    HEADERS_GAME_360_PROGRESS = {"x-xbl-contract-version": "1"}
+    HEADERS_GAME_PROGRESS = {"x-xbl-contract-version": "2"}
+
+    RATE_LIMITS = {"burst": 100, "sustain": 300}
+
+    async def get_achievements_detail_item(
+        self, xuid: str, service_config_id: str, achievement_id: str, **kwargs
+    ) -> AchievementResponse:
+        """
+        Get achievement detail for specific item
+
+        Args:
+            xuid (str): Xbox User Id
+            service_config_id (str): Service Config Id
+            achievement_id (str): Achievement Id
+
+        Returns:
+            :class:`AchievementResponse`: Achievement Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/achievements/{service_config_id}/{achievement_id}"
+        resp = await self.client.session.get(
+            url,
+            headers=self.HEADERS_GAME_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return AchievementResponse(**resp.json())
+
+    async def get_achievements_xbox360_all(
+        self, xuid: str, title_id: str, **kwargs
+    ) -> Achievement360Response:
+        """
+        Get all achievements for specific X360 title Id
+
+        Args:
+            xuid (str): Xbox User Id
+            title_id (str): Xbox 360 Title Id
+
+        Returns:
+            :class:`Achievement360Response`: Achievement 360 Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/titleachievements?"
+        params = {"titleId": title_id}
+        resp = await self.client.session.get(
+            url,
+            params=params,
+            headers=self.HEADERS_GAME_360_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return Achievement360Response(**resp.json())
+
+    async def get_achievements_xbox360_earned(
+        self, xuid: str, title_id: str, **kwargs
+    ) -> Achievement360Response:
+        """
+        Get earned achievements for specific X360 title id
+
+        Args:
+            xuid (str): Xbox User Id
+            title_id (str): Xbox 360 Title Id
+
+        Returns:
+            :class:`Achievement360Response`: Achievement 360 Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/achievements?"
+        params = {"titleId": title_id}
+        resp = await self.client.session.get(
+            url,
+            params=params,
+            headers=self.HEADERS_GAME_360_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return Achievement360Response(**resp.json())
+
+    async def get_achievements_xbox360_recent_progress_and_info(
+        self, xuid: str, **kwargs
+    ) -> Achievement360ProgressResponse:
+        """
+        Get recent achievement progress and information
+
+        Args:
+            xuid (str): Xbox User Id
+
+        Returns:
+            :class:`Achievement360Response`: Achievement 360 Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/history/titles"
+        resp = await self.client.session.get(
+            url,
+            headers=self.HEADERS_GAME_360_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return Achievement360ProgressResponse(**resp.json())
+
+    async def get_achievements_xboxone_gameprogress(
+        self, xuid: str, title_id: str, **kwargs
+    ) -> AchievementResponse:
+        """
+        Get gameprogress for Xbox One title
+
+        Args:
+            xuid (str): Xbox User Id
+            title_id (str): Xbox One Title Id
+
+        Returns:
+            :class:`AchievementResponse`: Achievement Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/achievements?"
+        params = {"titleId": title_id}
+        resp = await self.client.session.get(
+            url,
+            params=params,
+            headers=self.HEADERS_GAME_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return AchievementResponse(**resp.json())
+
+    async def get_achievements_xboxone_recent_progress_and_info(
+        self, xuid: str, **kwargs
+    ) -> RecentProgressResponse:
+        """
+        Get recent achievement progress and information
+
+        Args:
+            xuid (str): Xbox User Id
+
+        Returns:
+            :class:`RecentProgressResponse`: Recent Progress Response
+        """
+        url = f"{self.ACHIEVEMENTS_URL}/users/xuid({xuid})/history/titles"
+        resp = await self.client.session.get(
+            url,
+            headers=self.HEADERS_GAME_PROGRESS,
+            rate_limits=self.rate_limit_read,
+            **kwargs,
+        )
+        resp.raise_for_status()
+        return RecentProgressResponse(**resp.json())

pythonxbox/api/provider/achievements/models.py

@@ -0,0 +1,133 @@
+from datetime import datetime, time
+from typing import Any
+
+from pydantic import BaseModel
+
+from pythonxbox.common.models import CamelCaseModel
+
+
+class PagingInfo(CamelCaseModel):
+    continuation_token: str | None = None
+    total_records: int
+
+
+class Achievement360(CamelCaseModel):
+    id: int
+    title_id: int
+    name: str
+    sequence: int
+    flags: int
+    unlocked_online: bool
+    unlocked: bool
+    is_secret: bool
+    platform: int
+    gamerscore: int
+    image_id: int
+    description: str
+    locked_description: str
+    type: int
+    is_revoked: bool
+    time_unlocked: datetime
+
+
+class Title360(CamelCaseModel):
+    last_played: datetime
+    current_achievements: int
+    current_gamerscore: int
+    sequence: int
+    title_id: int
+    title_type: int
+    platforms: list[int]
+    name: str
+    total_achievements: int
+    total_gamerscore: int
+
+
+class Achievement360Response(CamelCaseModel):
+    achievements: list[Achievement360]
+    paging_info: PagingInfo
+    version: datetime
+
+
+class Achievement360ProgressResponse(CamelCaseModel):
+    titles: list[Title360]
+    paging_info: PagingInfo
+    version: datetime
+
+
+class TitleAssociation(BaseModel):
+    name: str
+    id: int
+
+
+class Requirement(CamelCaseModel):
+    id: str
+    current: str | None = None
+    target: str
+    operation_type: str
+    value_type: str
+    rule_participation_type: str
+
+
+class Progression(CamelCaseModel):
+    requirements: list[Requirement]
+    time_unlocked: datetime
+
+
+class MediaAsset(BaseModel):
+    name: str
+    type: str
+    url: str
+
+
+class Reward(CamelCaseModel):
+    name: Any = None
+    description: Any = None
+    value: str
+    type: str
+    media_asset: Any = None
+    value_type: str
+
+
+class Achievement(CamelCaseModel):
+    id: str
+    service_config_id: str
+    name: str
+    title_associations: list[TitleAssociation]
+    progress_state: str
+    progression: Progression
+    media_assets: list[MediaAsset]
+    platforms: list[str]
+    is_secret: bool
+    description: str
+    locked_description: str
+    product_id: str
+    achievement_type: str
+    participation_type: str
+    time_window: Any = None
+    rewards: list[Reward]
+    estimated_time: time
+    deeplink: Any = None
+    is_revoked: bool
+
+
+class AchievementResponse(CamelCaseModel):
+    achievements: list[Achievement]
+    paging_info: PagingInfo
+
+
+class Title(CamelCaseModel):
+    last_unlock: datetime
+    title_id: int
+    service_config_id: str
+    title_type: str
+    platform: str
+    name: str
+    earned_achievements: int
+    current_gamerscore: int
+    max_gamerscore: int
+
+
+class RecentProgressResponse(CamelCaseModel):
+    titles: list[Title]
+    paging_info: PagingInfo

pythonxbox/api/provider/baseprovider.py

@@ -0,0 +1,22 @@
+"""
+BaseProvider
+
+Subclassed by every *real* provider
+"""
+
+from typing import TYPE_CHECKING
+
+
+if TYPE_CHECKING:
+    from pythonxbox.api.client import XboxLiveClient
+
+
+class BaseProvider:
+    def __init__(self, client: "XboxLiveClient") -> None:
+        """
+        Initialize an the BaseProvider
+
+        Args:
+            client (:class:`XboxLiveClient`): Instance of XboxLiveClient
+        """
+        self.client = client

pythonxbox/api/provider/catalog/__init__.py

@@ -0,0 +1,86 @@
+"""
+Store Catalog - Lookup Product Information
+"""
+
+from pythonxbox.api.provider.baseprovider import BaseProvider
+from pythonxbox.api.provider.catalog.models import (
+    AlternateIdType,
+    CatalogResponse,
+    CatalogSearchResponse,
+    FieldsTemplate,
+    PlatformType,
+)
+
+
+class CatalogProvider(BaseProvider):
+    CATALOG_URL = "https://displaycatalog.mp.microsoft.com"
+    SEPERATOR = ","
+
+    async def get_products(
+        self,
+        big_ids: list[str],
+        fields: FieldsTemplate = FieldsTemplate.DETAILS,
+        **kwargs,
+    ) -> CatalogResponse:
+        """Lookup product by Big IDs."""
+        ids = self.SEPERATOR.join(big_ids)
+        params = {
+            "actionFilter": "Browse",
+            "bigIds": ids,
+            "fieldsTemplate": fields.value,
+            "languages": self.client.language.locale,
+            "market": self.client.language.short_id,
+        }
+        url = f"{self.CATALOG_URL}/v7.0/products"
+        resp = await self.client.session.get(
+            url, params=params, include_auth=False, **kwargs
+        )
+        resp.raise_for_status()
+        return CatalogResponse(**resp.json())
+
+    async def get_product_from_alternate_id(
+        self,
+        id: str,
+        id_type: AlternateIdType,
+        fields: FieldsTemplate = FieldsTemplate.DETAILS,
+        top: int = 25,
+        **kwargs,
+    ) -> CatalogResponse:
+        """Lookup product by Alternate ID."""
+        params = {
+            "top": top,
+            "alternateId": id_type.value,
+            "fieldsTemplate": fields.value,
+            "languages": self.client.language.locale,
+            "market": self.client.language.short_id,
+            "value": id,
+        }
+        url = f"{self.CATALOG_URL}/v7.0/products/lookup"
+        resp = await self.client.session.get(
+            url, params=params, include_auth=False, **kwargs
+        )
+        resp.raise_for_status()
+        return CatalogResponse(**resp.json())
+
+    async def product_search(
+        self,
+        query: str,
+        platform: PlatformType = PlatformType.XBOX,
+        top: int = 5,
+        **kwargs,
+    ) -> CatalogSearchResponse:
+        """Search for products by name."""
+        params = {
+            "languages": self.client.language.locale,
+            "market": self.client.language.short_id,
+            "platformdependencyname": platform.value,
+            "productFamilyNames": "Games,Apps",
+            "query": query,
+            "topProducts": top,
+        }
+        url = f"{self.CATALOG_URL}/v7.0/productFamilies/autosuggest"
+        resp = await self.client.session.get(
+            url, params=params, include_auth=False, **kwargs
+        )
+        resp.raise_for_status()
+        return CatalogSearchResponse(**resp.json())

pythonxbox/api/provider/catalog/const.py

@@ -0,0 +1,15 @@
+"""Web API Constants."""
+
+from pythonxbox.api.provider.catalog.models import AlternateIdType
+
+HOME_APP_IDS = {
+    AlternateIdType.LEGACY_XBOX_PRODUCT_ID: "7b3ca835-5ef5-4d96-bc84-c1d8b5084236",
+    AlternateIdType.XBOX_TITLE_ID: "750323071",
+}
+
+SYSTEM_PFN_ID_MAP = {
+    "Microsoft.Xbox.LiveTV_8wekyb3d8bbwe": {
+        AlternateIdType.LEGACY_XBOX_PRODUCT_ID: "71e7df12-89e0-4dc7-a5ff-a182fc2df94f",
+        AlternateIdType.XBOX_TITLE_ID: "371594669",
+    },
+}