$path_Request method

  1. @experimental
Request $path_Request({
  1. String? templatePath,
  2. TemplatePathCopySystemTemplates? copySystemTemplates,
  3. bool? oCSAPIRequest,
})

Initialize the template directory.

Returns a DynamiteRequest backing the path operation. 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:

  • path for a method executing this request and parsing the response.
  • $path_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $path_Request({
  String? templatePath,
  TemplatePathCopySystemTemplates? copySystemTemplates,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var $templatePath = _$jsonSerializers.serialize(templatePath, specifiedType: const FullType(String));
  $templatePath ??= '';
  _parameters['templatePath'] = $templatePath;

  var $copySystemTemplates = _$jsonSerializers.serialize(
    copySystemTemplates,
    specifiedType: const FullType(TemplatePathCopySystemTemplates),
  );
  $copySystemTemplates ??= 0;
  _parameters['copySystemTemplates'] = $copySystemTemplates;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/templates/path{?templatePath*,copySystemTemplates*}')
      .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}