requestTrialRaw method

  1. @experimental
DynamiteRawResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void> requestTrialRaw({
  1. required String url,
  2. required String name,
  3. required String email,
  4. required String language,
  5. required String country,
  6. HostedSignalingServerRequestTrialApiVersion? apiVersion,
  7. bool? oCSAPIRequest,
})

Request a trial account.

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:

  • url Server URL.
  • name Display name of the user.
  • email Email of the user.
  • language Language of the user.
  • country Country of the user.
  • apiVersion Defaults to v1.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Trial requested successfully
  • 400: Requesting trial is not possible
  • 500

See:

  • requestTrial for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void> requestTrialRaw({
  required String url,
  required String name,
  required String email,
  required String language,
  required String country,
  HostedSignalingServerRequestTrialApiVersion? 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
  final $url = _$jsonSerializers.serialize(url, specifiedType: const FullType(String));
  _parameters['url'] = $url;

  final $name = _$jsonSerializers.serialize(name, specifiedType: const FullType(String));
  _parameters['name'] = $name;

  final $email = _$jsonSerializers.serialize(email, specifiedType: const FullType(String));
  _parameters['email'] = $email;

  final $language = _$jsonSerializers.serialize(language, specifiedType: const FullType(String));
  _parameters['language'] = $language;

  final $country = _$jsonSerializers.serialize(country, specifiedType: const FullType(String));
  _parameters['country'] = $country;

  var $apiVersion = _$jsonSerializers.serialize(
    apiVersion,
    specifiedType: const FullType(HostedSignalingServerRequestTrialApiVersion),
  );
  $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}/hostedsignalingserver/requesttrial{?url*,name*,email*,language*,country*}',
  ).expand(_parameters);
  return _i1.DynamiteRawResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(HostedSignalingServerRequestTrialResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}