UserSystemOverrides Routes

UserSystemOverridesRouteInterface

Bases: ClientMixin

Source code in src/bungio/api/bungie/user_system_overrides.py

@custom_define()
class UserSystemOverridesRouteInterface(ClientMixin):
    async def get_user_system_overrides(self, auth: Optional[AuthData] = None) -> dict[str, CoreSystem]:
        """
        Get the user-specific system overrides that should be respected alongside common systems.

        Args:
            auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

        Returns:
            The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
        """

        response = await self._client.http.get_user_system_overrides(auth=auth)
        return {
            key: await CoreSystem.from_dict(data=value, client=self._client, auth=auth)
            async for key, value in AllowAsyncIteration(response["Response"].items())
        }

get_user_system_overrides(auth=None) async

Get the user-specific system overrides that should be respected alongside common systems.

Parameters:

Name	Type	Description	Default
auth	Optional[AuthData]	Authentication information. Required when users with a private profile are queried, or when Bungie feels like it	None

Returns:

Type	Description
dict[str, CoreSystem]	The model which is returned by bungie. General endpoint information.

Source code in src/bungio/api/bungie/user_system_overrides.py

async def get_user_system_overrides(self, auth: Optional[AuthData] = None) -> dict[str, CoreSystem]:
    """
    Get the user-specific system overrides that should be respected alongside common systems.

    Args:
        auth: Authentication information. Required when users with a private profile are queried, or when Bungie feels like it

    Returns:
        The model which is returned by bungie. [General endpoint information.](https://bungie-net.github.io/multi/index.html)
    """

    response = await self._client.http.get_user_system_overrides(auth=auth)
    return {
        key: await CoreSystem.from_dict(data=value, client=self._client, auth=auth)
        async for key, value in AllowAsyncIteration(response["Response"].items())
    }