$deleteFolder_Request method

@experimental Request $deleteFolder_Request({ required int folderId, })

Returns a DynamiteRequest backing the deleteFolder operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Status codes:

• 200

See:

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

Implementation

@_i2.experimental
_i3.Request $deleteFolder_Request({required int folderId}) {
  final _parameters = <String, Object?>{};
  final $folderId = _$jsonSerializers.serialize(folderId, specifiedType: const FullType(int));
  _parameters['folderId'] = $folderId;

  final _path = _i4.UriTemplate('/index.php/apps/news/api/v1-3/folders/{folderId}').expand(_parameters);
  final _uri = Uri.parse('$baseURL$_path');
  final _request = _i3.Request('delete', _uri);
// coverage:ignore-start
  final authentication = authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  return _request;
}