requestTrial method

Future<DynamiteResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void>> requestTrial({
  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.

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:

  • 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:

  • requestTrialRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void>> requestTrial({
  required String url,
  required String name,
  required String email,
  required String language,
  required String country,
  HostedSignalingServerRequestTrialApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = requestTrialRaw(
    url: url,
    name: name,
    email: email,
    language: language,
    country: country,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}