create method
Create a file for direct editing.
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:
path
Path of the file.editorId
ID of the editor.creatorId
ID of the creator.templateId
ID of the template.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: URL for direct editing returned
- 403: Opening file is not allowed
- 500
See:
- $create_Request for the request send by this method.
- $create_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<DirectEditingCreateResponseApplicationJson, void>> create({
required String path,
required String editorId,
required String creatorId,
String? templateId,
bool? oCSAPIRequest,
}) async {
final _request = $create_Request(
path: path,
editorId: editorId,
creatorId: creatorId,
templateId: templateId,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $create_Serializer();
final _rawResponse =
await _i1.ResponseConverter<DirectEditingCreateResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}