admin method
Future<DynamiteResponse<SettingsAdminResponseApplicationJson, void> >
admin({
- required int batchSetting,
- required String soundNotification,
- required String soundTalk,
- SettingsAdminApiVersion? apiVersion,
- bool? oCSAPIRequest,
Update default notification settings for new users.
This endpoint requires admin access.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
batchSetting
How often E-mails about missed notifications should be sent (hourly: 1; every three hours: 2; daily: 3; weekly: 4).soundNotification
Enable sound for notifications ('yes' or 'no').soundTalk
Enable sound for Talk notifications ('yes' or 'no').apiVersion
Defaults to"v2"
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Admin settings updated
See:
- $admin_Request for the request send by this method.
- $admin_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<SettingsAdminResponseApplicationJson, void>> admin({
required int batchSetting,
required String soundNotification,
required String soundTalk,
SettingsAdminApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $admin_Request(
batchSetting: batchSetting,
soundNotification: soundNotification,
soundTalk: soundTalk,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $admin_Serializer();
final _rawResponse =
await _i1.ResponseConverter<SettingsAdminResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}