requestTrial method
Future<DynamiteResponse<HostedSignalingServerRequestTrialResponseApplicationJson, void> >
requestTrial({})
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 totrue
.
Status codes:
- 200: Trial requested successfully
- 400: Requesting trial is not possible
- 500
See:
- $requestTrial_Request for the request send by this method.
- $requestTrial_Serializer for a converter to parse the
Response
from an executed request.
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 _request = $requestTrial_Request(
url: url,
name: name,
email: email,
language: language,
country: country,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $requestTrial_Serializer();
final _rawResponse =
await _i1.ResponseConverter<HostedSignalingServerRequestTrialResponseApplicationJson, void>(_serializer)
.convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}