path method
Future<DynamiteResponse<TemplatePathResponseApplicationJson, void> >
path({
- String? templatePath,
- TemplatePathCopySystemTemplates? copySystemTemplates,
- bool? oCSAPIRequest,
Initialize the template directory.
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:
templatePath
Path of the template directory. Defaults to""
.copySystemTemplates
Whether to copy the system templates to the template directory. Defaults to0
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Template directory initialized successfully
- 403: Initializing the template directory is not allowed
See:
- $path_Request for the request send by this method.
- $path_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<TemplatePathResponseApplicationJson, void>> path({
String? templatePath,
TemplatePathCopySystemTemplates? copySystemTemplates,
bool? oCSAPIRequest,
}) async {
final _request = $path_Request(
templatePath: templatePath,
copySystemTemplates: copySystemTemplates,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $path_Serializer();
final _rawResponse =
await _i1.ResponseConverter<TemplatePathResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}