$setsipSettings_Request method

@experimental Request $setsipSettings_Request({ BuiltList<String>? sipGroups, String? dialInInfo, String? sharedSecret, SettingsSetsipSettingsApiVersion? apiVersion, bool? oCSAPIRequest, })

Update SIP bridge settings.

This endpoint requires admin access.

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

Parameters:

• sipGroups New SIP groups. Defaults to [].
• dialInInfo New dial info. Defaults to "".
• sharedSecret New shared secret. Defaults to "".
• apiVersion Defaults to "v1".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Successfully set new SIP settings

See:

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

Implementation

@_i2.experimental
_i3.Request $setsipSettings_Request({
  BuiltList<String>? sipGroups,
  String? dialInInfo,
  String? sharedSecret,
  SettingsSetsipSettingsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var $sipGroups =
      _$jsonSerializers.serialize(sipGroups, specifiedType: const FullType(BuiltList, [FullType(String)]));
  $sipGroups ??= const [];
  _parameters['sipGroups%5B%5D'] = $sipGroups;

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

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

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

  final _path = _i5.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/sip{?sipGroups%5B%5D*,dialInInfo*,sharedSecret*}',
  ).expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _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;
}