matterbridgeSettingsStopAllBridges method

Future<DynamiteResponse<MatterbridgeSettingsStopAllBridgesResponseApplicationJson, void>> matterbridgeSettingsStopAllBridges({ MatterbridgeSettingsStopAllBridgesApiVersion? apiVersion, bool? oCSAPIRequest, })

Stop all bridges.

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 "v1".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: All bridges stopped successfully
• 406: Stopping all bridges is not possible

See:

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

Implementation

Future<_i1.DynamiteResponse<MatterbridgeSettingsStopAllBridgesResponseApplicationJson, void>>
    matterbridgeSettingsStopAllBridges({
  MatterbridgeSettingsStopAllBridgesApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $matterbridgeSettingsStopAllBridges_Request(
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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