setsipSettingsRaw method

  1. @experimental
DynamiteRawResponse<SettingsSetsipSettingsResponseApplicationJson, void> setsipSettingsRaw({
  1. BuiltList<String>? sipGroups,
  2. String? dialInInfo,
  3. String? sharedSecret,
  4. SettingsSetsipSettingsApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Update SIP bridge settings.

This endpoint requires admin access.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. 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 an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<SettingsSetsipSettingsResponseApplicationJson, void> setsipSettingsRaw({
  BuiltList<String>? sipGroups,
  String? dialInInfo,
  String? sharedSecret,
  SettingsSetsipSettingsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  var $sipGroups =
      _$jsonSerializers.serialize(sipGroups, specifiedType: const FullType(BuiltList, [FullType(String)]));
  $sipGroups ??= [];
  _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;

  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const _i2.HeaderEncoder().convert($oCSAPIRequest);

  final _path = _i3.UriTemplate(
    '/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/sip{?sipGroups%5B%5D*,dialInInfo*,sharedSecret*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<SettingsSetsipSettingsResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(SettingsSetsipSettingsResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}