createRaw method

  1. @experimental
DynamiteRawResponse<TemplateCreateResponseApplicationJson, void> createRaw({
  1. required String filePath,
  2. String? templatePath,
  3. String? templateType,
  4. bool? oCSAPIRequest,
})

Create a template.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • filePath Path of the file.
  • templatePath Name of the template. Defaults to ''.
  • templateType Type of the template. Defaults to user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Template created successfully
  • 403: Creating template is not allowed

See:

Implementation

@experimental
DynamiteRawResponse<TemplateCreateResponseApplicationJson, void> createRaw({
  required String filePath,
  String? templatePath,
  String? templateType,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{
    'Accept': 'application/json',
  };

// coverage:ignore-start
  final authentication = _rootClient.authentications.firstWhereOrNull(
    (auth) => switch (auth) {
      DynamiteHttpBearerAuthentication() || DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $filePath = jsonSerializers.serialize(filePath, specifiedType: const FullType(String));
  _parameters['filePath'] = $filePath;

  var $templatePath = jsonSerializers.serialize(templatePath, specifiedType: const FullType(String));
  $templatePath ??= '';
  _parameters['templatePath'] = $templatePath;

  var $templateType = jsonSerializers.serialize(templateType, specifiedType: const FullType(String));
  $templateType ??= 'user';
  _parameters['templateType'] = $templateType;

  var $oCSAPIRequest = jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _headers['OCS-APIRequest'] = const dynamite_utils.HeaderEncoder().convert($oCSAPIRequest);

  final _path = UriTemplate('/ocs/v2.php/apps/files/api/v1/templates/create{?filePath*,templatePath*,templateType*}')
      .expand(_parameters);
  return DynamiteRawResponse<TemplateCreateResponseApplicationJson, void>(
    response: _rootClient.executeRequest(
      'post',
      _path,
      _headers,
      null,
      const {200},
    ),
    bodyType: const FullType(TemplateCreateResponseApplicationJson),
    headersType: null,
    serializers: jsonSerializers,
  );
}