UserSettingService

class UserSettingService

Methods

get_all_notification_settings	Update preferences for notifications.
patch_notification_setting	Update preferences for notifications.
get_ui_preference	Get ui preferences.
patch_ui_preference	Update ui preferences.

get_all_notification_settings(*, token=Nothing)

Update preferences for notifications.

Parameters:

token (Union[Just[str], _Nothing[str]]) – The token with which you want to get the preferences, if not given the preferences are retrieved for the currently logged in user.

Returns:

The preferences for the user as described by the token.

Return type:

NotificationSetting

patch_notification_setting(json_body, *, token=Nothing)

Update preferences for notifications.

Parameters:

• json_body (PatchNotificationSettingUserSettingData) – The body of the request. See PatchNotificationSettingUserSettingData for information about the possible fields. You can provide this data as a PatchNotificationSettingUserSettingData or as a dictionary.

• token (Union[Just[str], _Nothing[str]]) – The token with which you want to update the preferences, if not given the preferences are updated for the currently logged in user.

Returns:

Nothing.

Return type:

None

get_ui_preference(*, name, token=Nothing)

Get ui preferences.

Parameters:

• name (str) – The name of the preference you want to get.

• token (Union[Just[str], _Nothing[str]]) – The token with which you want to get the preferences, if not given the preferences are retrieved for the currently logged in user.

Returns:

The preferences for the user as described by the token.

Return type:

PresentPreference | NonPresentPreference

patch_ui_preference(json_body, *, token=Nothing)

Update ui preferences.

Parameters:

• json_body (PatchUiPreferenceUserSettingData) – The body of the request. See PatchUiPreferenceUserSettingData for information about the possible fields. You can provide this data as a PatchUiPreferenceUserSettingData or as a dictionary.

• token (Union[Just[str], _Nothing[str]]) – The token with which you want to update the preferences, if not given the preferences are updated for the currently logged in user.

Returns:

Nothing.

Return type:

None