$create_Request method

  1. @experimental
Request $create_Request({
  1. required String filePath,
  2. String? templatePath,
  3. String? templateType,
  4. bool? oCSAPIRequest,
})

Create a template.

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

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

Implementation

@_i2.experimental
_i3.Request $create_Request({
  required String filePath,
  String? templatePath,
  String? templateType,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  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;

  final _path =
      _i5.UriTemplate('/ocs/v2.php/apps/files/api/v1/templates/create{?filePath*,templatePath*,templateType*}')
          .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;
}