GetAvailableLocales Routes

GetAvailableLocalesRouteInterface

Bases: ClientMixin

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

@custom_define()
class GetAvailableLocalesRouteInterface(ClientMixin):
    async def get_available_locales(self, auth: Optional[AuthData] = None) -> dict[str, str]:
        """
        List of available localization cultures

        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_available_locales(auth=auth)
        return {key: value async for key, value in AllowAsyncIteration(response["Response"].items())}

get_available_locales(auth=None) async

List of available localization cultures

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, str]	The model which is returned by bungie. General endpoint information.

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

async def get_available_locales(self, auth: Optional[AuthData] = None) -> dict[str, str]:
    """
    List of available localization cultures

    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_available_locales(auth=auth)
    return {key: value async for key, value in AllowAsyncIteration(response["Response"].items())}