lunasea/lib/api/sonarr/controllers/wanted.dart

part of sonarr_commands;

/// Facilitates, encapsulates, and manages individual calls related to wanted/missing episodes within Sonarr.
///
/// [SonarrControllerWanted] internally handles routing the HTTP client to the API calls.
class SonarrControllerWanted {
  final Dio _client;

  /// Create a series command handler using an initialized [Dio] client.
  SonarrControllerWanted(this._client);

  /// Handler for [wanted/missing](https://github.com/Sonarr/Sonarr/wiki/Wanted-Missing#get).
  ///
  /// Returns a list of missing episode (episodes without files).
  ///
  /// Optional Parameters:
  /// - `sortDir`: Sorting direction of the results
  /// - `sortKey`: The key used for sorting the results
  /// - `page`: Page of results to fetch
  /// - `pageSize`: Size of the page to fetch
  Future<SonarrMissing> getMissing({
    SonarrSortDirection? sortDir,
    SonarrWantedMissingSortKey? sortKey,
    int? page,
    int? pageSize,
    bool? includeSeries,
    bool? includeImages,
  }) async =>
      _commandGetMissing(
        _client,
        sortDirection: sortDir,
        sortKey: sortKey,
        page: page,
        pageSize: pageSize,
        includeSeries: includeSeries,
        includeImages: includeImages,
      );
}