UserSettingService#
- class UserSettingService[source]#
Methods
Update preferences for notifications.
Update preferences for notifications.
Get ui preferences.
Update ui preferences.
- get_all_notification_settings(*, token=Nothing, extra_parameters=None)[source]#
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.extra_parameters (
Optional
[Mapping
[str
,Union
[str
,bool
,int
,float
]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
- Returns:
The preferences for the user as described by the token.
- Return type:
- patch_notification_setting(json_body, *, token=Nothing, extra_parameters=None)[source]#
Update preferences for notifications.
- Parameters:
json_body (
Union
[dict
,list
,PatchNotificationSettingUserSettingData
]) – The body of the request. SeePatchNotificationSettingUserSettingData
for information about the possible fields. You can provide this data as aPatchNotificationSettingUserSettingData
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.extra_parameters (
Optional
[Mapping
[str
,Union
[str
,bool
,int
,float
]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
- Returns:
Nothing.
- Return type:
None
- get_ui_preference(*, name=Nothing, token=Nothing, extra_parameters=None)[source]#
Get ui preferences.
- Parameters:
name (
Union
[Just
[str
],_Nothing
[str
]]) – The preference name 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.extra_parameters (
Optional
[Mapping
[str
,Union
[str
,bool
,int
,float
]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
- Returns:
The preferences for the user as described by the token.
- Return type:
PresentPreference | NonPresentPreference | Mapping[str, Any]
- patch_ui_preference(json_body, *, token=Nothing, extra_parameters=None)[source]#
Update ui preferences.
- Parameters:
json_body (
Union
[dict
,list
,PatchUiPreferenceUserSettingData
]) – The body of the request. SeePatchUiPreferenceUserSettingData
for information about the possible fields. You can provide this data as aPatchUiPreferenceUserSettingData
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.extra_parameters (
Optional
[Mapping
[str
,Union
[str
,bool
,int
,float
]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.
- Returns:
Nothing.
- Return type:
None