heartbeat method
Future<DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void> >
heartbeat({
- required HeartbeatHeartbeatRequestApplicationJson $body,
- bool? oCSAPIRequest,
Keep the status alive.
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:
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Status successfully updated
- 400: Invalid status to update
- 500
- 204: User has no status to keep alive
See:
- $heartbeat_Request for the request send by this method.
- $heartbeat_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void>> heartbeat({
required HeartbeatHeartbeatRequestApplicationJson $body,
bool? oCSAPIRequest,
}) async {
final _request = $heartbeat_Request(
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $heartbeat_Serializer();
return _i1.ResponseConverter<HeartbeatHeartbeatResponseApplicationJson, void>(_serializer).convert(_response);
}