komga_api_client 41.1.0 copy "komga_api_client: ^41.1.0" to clipboard
komga_api_client: ^41.1.0 copied to clipboard

Published 5 years ago Dart 3 incompatible
[incomplete package analysis]
→

Metadata

Generated dart package for interacting with the Komga API in Dart with Dio. NB This package is generated automatically using Open API codegen.

More...

Komga API Client #

Komga offers 2 APIs: REST and OPDS.

Both APIs are secured using HTTP Basic Authentication.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v37.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: Komga API Client
version: 37
description: Generated dart package for interacting with Komga's API in Dart with Dio
dependencies:
  Komga API Client:
    git: https://github.com/frameset/komga_api_client.git
      version: 'any'

Local #

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  Komga API Client:
    path: /path/to/Komga API Client

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:Komga API Client/api.dart';


var api_instance = new BookControllerApi();
var bookId = 789; // int | 

try {
    api_instance.analyze(bookId);
} catch (e) {
    print("Exception when calling BookControllerApi->analyze: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://demo.komga.org

Class Method HTTP request Description
BookControllerApi analyze post /api/v1/books/{bookId}/analyze
BookControllerApi deleteReadProgress delete /api/v1/books/{bookId}/read-progress
BookControllerApi getAllBooks get /api/v1/books
BookControllerApi getBookFile get /api/v1/books/{bookId}/file
BookControllerApi getBookFile1 get /api/v1/books/{bookId}/file/*
BookControllerApi getBookPage get /api/v1/books/{bookId}/pages/{pageNumber}
BookControllerApi getBookPageThumbnail get /api/v1/books/{bookId}/pages/{pageNumber}/thumbnail
BookControllerApi getBookPages get /api/v1/books/{bookId}/pages
BookControllerApi getBookSiblingNext get /api/v1/books/{bookId}/next
BookControllerApi getBookSiblingPrevious get /api/v1/books/{bookId}/previous
BookControllerApi getBookThumbnail get /api/v1/books/{bookId}/thumbnail
BookControllerApi getBooksOnDeck get /api/v1/books/ondeck
BookControllerApi getLatestBooks get /api/v1/books/latest
BookControllerApi getOneBook get /api/v1/books/{bookId}
BookControllerApi markReadProgress patch /api/v1/books/{bookId}/read-progress
BookControllerApi refreshMetadata post /api/v1/books/{bookId}/metadata/refresh
BookControllerApi updateMetadata patch /api/v1/books/{bookId}/metadata
ClaimControllerApi claimAdmin post /api/v1/claim
FileSystemControllerApi getDirectoryListing post /api/v1/filesystem
LibraryControllerApi addOne post /api/v1/libraries
LibraryControllerApi analyze1 post /api/v1/libraries/{libraryId}/analyze
LibraryControllerApi deleteOne delete /api/v1/libraries/{id}
LibraryControllerApi getAll get /api/v1/libraries
LibraryControllerApi getOne get /api/v1/libraries/{id}
LibraryControllerApi refreshMetadata1 post /api/v1/libraries/{libraryId}/metadata/refresh
LibraryControllerApi scan post /api/v1/libraries/{libraryId}/scan
ReferentialControllerApi getAuthors get /api/v1/authors
SeriesControllerApi analyze2 post /api/v1/series/{seriesId}/analyze
SeriesControllerApi getAllBooksBySeries get /api/v1/series/{seriesId}/books
SeriesControllerApi getAllSeries get /api/v1/series
SeriesControllerApi getLatestSeries get /api/v1/series/latest
SeriesControllerApi getNewSeries get /api/v1/series/new
SeriesControllerApi getOneSeries get /api/v1/series/{seriesId}
SeriesControllerApi getSeriesThumbnail get /api/v1/series/{seriesId}/thumbnail
SeriesControllerApi getUpdatedSeries get /api/v1/series/updated
SeriesControllerApi markAsRead post /api/v1/series/{seriesId}/read-progress
SeriesControllerApi markAsUnread delete /api/v1/series/{seriesId}/read-progress
SeriesControllerApi refreshMetadata2 post /api/v1/series/{seriesId}/metadata/refresh
SeriesControllerApi updateMetadata1 patch /api/v1/series/{seriesId}/metadata
UserControllerApi addOne1 post /api/v1/users
UserControllerApi delete delete /api/v1/users/{id}
UserControllerApi getAll1 get /api/v1/users
UserControllerApi getMe get /api/v1/users/me
UserControllerApi updatePassword patch /api/v1/users/me/password
UserControllerApi updateSharesLibraries patch /api/v1/users/{id}/shared-libraries
UserControllerApi updateUserRoles patch /api/v1/users/{id}

Documentation For Models #

  • AuthorDto
  • AuthorUpdateDto
  • BookDto
  • BookMetadataDto
  • BookMetadataUpdateDto
  • DirectoryListingDto
  • DirectoryRequestDto
  • LibraryCreationDto
  • LibraryDto
  • MediaDto
  • PageBookDto
  • PageDto
  • PageSeriesDto
  • Pageable
  • PasswordUpdateDto
  • PathDto
  • ReadProgressDto
  • ReadProgressUpdateDto
  • RolesUpdateDto
  • SeriesDto
  • SeriesMetadataDto
  • SeriesMetadataUpdateDto
  • SharedLibrariesUpdateDto
  • SharedLibraryDto
  • Sort
  • UserCreationDto
  • UserDto
  • UserWithSharedLibrariesDto

Documentation For Authorization #

basicAuth #

  • Type: HTTP basic authentication

Author #

← Metadata

1
likes
25
points
17
downloads

Publisher

unverified uploader

Weekly Downloads

Metadata

Generated dart package for interacting with the Komga API in Dart with Dio. NB This package is generated automatically using Open API codegen.

Homepage

License

MIT (license)

Dependencies

built_collection, built_value, dio, time_machine

More

Packages that depend on komga_api_client

Back