Settings Routes

SettingsRouteInterface

Bases: ClientMixin

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

@custom_define()
class SettingsRouteInterface(ClientMixin):
    async def get_common_settings(self, auth: Optional[AuthData] = None) -> CoreSettingsConfiguration:
        """
        Get the common settings used by the Bungie.Net environment.

        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_common_settings(auth=auth)
        return await CoreSettingsConfiguration.from_dict(data=response, client=self._client, auth=auth)

get_common_settings(auth=None) async

Get the common settings used by the Bungie.Net environment.

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

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

async def get_common_settings(self, auth: Optional[AuthData] = None) -> CoreSettingsConfiguration:
    """
    Get the common settings used by the Bungie.Net environment.

    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_common_settings(auth=auth)
    return await CoreSettingsConfiguration.from_dict(data=response, client=self._client, auth=auth)