$editBridgeOfRoom_Request method

@experimental Request $editBridgeOfRoom_Request({ required MatterbridgeEditBridgeOfRoomEnabled enabled, required String token, ContentString<BuiltList<BuiltMap<String, JsonObject>>>? parts, MatterbridgeEditBridgeOfRoomApiVersion? apiVersion, bool? oCSAPIRequest, })

Edit bridge information of one room.

Returns a DynamiteRequest backing the editBridgeOfRoom operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• enabled If the bridge should be enabled.
• parts New parts.
• apiVersion Defaults to "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Bridge edited successfully
• 406: Editing bridge is not possible

See:

• editBridgeOfRoom for a method executing this request and parsing the response.
• $editBridgeOfRoom_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $editBridgeOfRoom_Request({
  required MatterbridgeEditBridgeOfRoomEnabled enabled,
  required String token,
  ContentString<BuiltList<BuiltMap<String, JsonObject>>>? parts,
  MatterbridgeEditBridgeOfRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $enabled =
      _$jsonSerializers.serialize(enabled, specifiedType: const FullType(MatterbridgeEditBridgeOfRoomEnabled));
  _parameters['enabled'] = $enabled;

  final $token = _$jsonSerializers.serialize(token, specifiedType: const FullType(String));
  _i4.checkString(
    $token,
    'token',
    pattern: RegExp(r'^[a-z0-9]{4,30}$'),
  );
  _parameters['token'] = $token;

  final $parts = _$jsonSerializers.serialize(
    parts,
    specifiedType: const FullType(ContentString, [
      FullType(BuiltList, [
        FullType(BuiltMap, [FullType(String), FullType(JsonObject)]),
      ]),
    ]),
  );
  _parameters['parts'] = $parts;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(MatterbridgeEditBridgeOfRoomApiVersion));
  $apiVersion ??= 'v1';
  _parameters['apiVersion'] = $apiVersion;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/bridge/{token}{?enabled*,parts*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}