publicShareAuthCreateRoom method

Future<DynamiteResponse<PublicShareAuthCreateRoomResponseApplicationJson, void>> publicShareAuthCreateRoom({ required PublicShareAuthCreateRoomRequestApplicationJson $body, PublicShareAuthCreateRoomApiVersion? apiVersion, bool? oCSAPIRequest, })

Creates a new room for video verification (requesting the password of a share).

The new room is a public room associated with a "share:password" object with the ID of the share token. Unlike normal rooms in which the owner is the user that created the room these are special rooms always created by a guest or user on behalf of a registered user, the sharer, who will be the owner of the room. The share must have "send password by Talk" enabled; an error is returned otherwise.

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:

• apiVersion Defaults to "v1".
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 201: Room created successfully
• 404: Share not found

See:

• $publicShareAuthCreateRoom_Request for the request send by this method.
• $publicShareAuthCreateRoom_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<PublicShareAuthCreateRoomResponseApplicationJson, void>> publicShareAuthCreateRoom({
  required PublicShareAuthCreateRoomRequestApplicationJson $body,
  PublicShareAuthCreateRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $publicShareAuthCreateRoom_Request(
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $publicShareAuthCreateRoom_Serializer();
  return _i1.ResponseConverter<PublicShareAuthCreateRoomResponseApplicationJson, void>(_serializer)
      .convert(_response);
}