notifications_get_categories¶
List Notification Categories
Functions
- async pydelfini.delfini_core.api.general.notifications_get_categories.asyncio(*, client)[source]¶
List Notification Categories
The categories a user can switch notifications off for, in the order the settings page should show them.
Served rather than duplicated in the client because plugins can register categories of their own, so the list is not known until the server has loaded its plugins. default_enabled is what a user gets before they touch anything; a category shipping false is opt-in.
The preferences themselves are not here – they live in the user’s metadata and are read and written through /user/{user_name}.
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[NotificationsGetCategoriesResponse200]
- Parameters:
client (AuthenticatedClient)
- Return type:
- async pydelfini.delfini_core.api.general.notifications_get_categories.asyncio_detailed(*, client)[source]¶
List Notification Categories
The categories a user can switch notifications off for, in the order the settings page should show them.
Served rather than duplicated in the client because plugins can register categories of their own, so the list is not known until the server has loaded its plugins. default_enabled is what a user gets before they touch anything; a category shipping false is opt-in.
The preferences themselves are not here – they live in the user’s metadata and are read and written through /user/{user_name}.
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[NotificationsGetCategoriesResponse200, ServerError]]
- Parameters:
client (AuthenticatedClient)
- Return type:
Response[NotificationsGetCategoriesResponse200 | ServerError]
- pydelfini.delfini_core.api.general.notifications_get_categories.sync(*, client)[source]¶
List Notification Categories
The categories a user can switch notifications off for, in the order the settings page should show them.
Served rather than duplicated in the client because plugins can register categories of their own, so the list is not known until the server has loaded its plugins. default_enabled is what a user gets before they touch anything; a category shipping false is opt-in.
The preferences themselves are not here – they live in the user’s metadata and are read and written through /user/{user_name}.
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[NotificationsGetCategoriesResponse200]
- Parameters:
client (AuthenticatedClient)
- Return type:
- pydelfini.delfini_core.api.general.notifications_get_categories.sync_detailed(*, client)[source]¶
List Notification Categories
The categories a user can switch notifications off for, in the order the settings page should show them.
Served rather than duplicated in the client because plugins can register categories of their own, so the list is not known until the server has loaded its plugins. default_enabled is what a user gets before they touch anything; a category shipping false is opt-in.
The preferences themselves are not here – they live in the user’s metadata and are read and written through /user/{user_name}.
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[NotificationsGetCategoriesResponse200, ServerError]]
- Parameters:
client (AuthenticatedClient)
- Return type:
Response[NotificationsGetCategoriesResponse200 | ServerError]