path method

Future<DynamiteResponse<TemplatePathResponseApplicationJson, void>> path({
  1. String? templatePath,
  2. int? copySystemTemplates,
  3. 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 to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Template directory initialized successfully
  • 403: Initializing the template directory is not allowed

See:

Implementation

Future<DynamiteResponse<TemplatePathResponseApplicationJson, void>> path({
  String? templatePath,
  int? copySystemTemplates,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = pathRaw(
    templatePath: templatePath,
    copySystemTemplates: copySystemTemplates,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}