admin method

Future<DynamiteResponse<SettingsAdminResponseApplicationJson, void>> admin({
  1. required int batchSetting,
  2. required String soundNotification,
  3. required String soundTalk,
  4. SettingsAdminApiVersion? apiVersion,
  5. 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 to true.

Status codes:

  • 200: Admin settings updated

See:

Implementation

Future<DynamiteResponse<SettingsAdminResponseApplicationJson, void>> admin({
  required int batchSetting,
  required String soundNotification,
  required String soundTalk,
  SettingsAdminApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = adminRaw(
    batchSetting: batchSetting,
    soundNotification: soundNotification,
    soundTalk: soundTalk,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}