admin method
Future<DynamiteResponse<SettingsAdminResponseApplicationJson, void> >
admin({
- required SettingsAdminRequestApplicationJson $body,
- 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:
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 SettingsAdminRequestApplicationJson $body,
SettingsAdminApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $admin_Request(
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $admin_Serializer();
return _i1.ResponseConverter<SettingsAdminResponseApplicationJson, void>(_serializer).convert(_response);
}