setOutOfOffice method

Future<DynamiteResponse<OutOfOfficeSetOutOfOfficeResponseApplicationJson, void>> setOutOfOffice({ required String firstDay, required String lastDay, required String status, required String message, required String userId, bool? oCSAPIRequest, })

Set out-of-office absence.

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:

• firstDay First day of the absence in format YYYY-MM-DD.
• lastDay Last day of the absence in format YYYY-MM-DD.
• status Short text that is set as user status during the absence.
• message Longer multiline message that is shown to others during the absence.
• userId
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Absence data
• 400: When the first day is not before the last day
• 401: When the user is not logged in

See:

• $setOutOfOffice_Request for the request send by this method.
• $setOutOfOffice_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<OutOfOfficeSetOutOfOfficeResponseApplicationJson, void>> setOutOfOffice({
  required String firstDay,
  required String lastDay,
  required String status,
  required String message,
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final _request = $setOutOfOffice_Request(
    firstDay: firstDay,
    lastDay: lastDay,
    status: status,
    message: message,
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setOutOfOffice_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<OutOfOfficeSetOutOfOfficeResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}