@organizedbookclub/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @organizedbookclub/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthApi | authControllerGetAccessToken | POST /auth/token | Gets an access token, using the client credentials flow. Accepts credentials either in the request body (per OAuth2 §4.4.2) or via the Authorization: Basic header (per §2.3.1). AuthApi | authControllerGetJwks | GET /auth/.well-known/jwks.json | Returns the public JWKS document used by other services to verify tokens issued by OWS, per RFC 7517. BooksApi | booksControllerCreateBookFromDto | POST /api/books | Creates a book from the given Dto object. BooksApi | booksControllerCreateBookFromUrl | POST /api/books/createFromUrl | Creates a book from the given valid URL. EventsApi | eventsControllerCreate | POST /api/events | Creates an event from the Dto object. EventsApi | eventsControllerCreateFromUrl | POST /api/events/createFromUrl | Creates an event from the book URL and Dto object. EventsApi | eventsControllerFindOne | GET /api/events/{id} | Gets the event document with the given ID from the database. EventsApi | eventsControllerRemove | DELETE /api/events/{id} | Deletes the event document from the DB. EventsApi | eventsControllerUpdate | PATCH /api/events/{id} | Updates the event with the given ID and Dto in the database. EventsApi | eventsV2ControllerFind | GET /api/v2/events | Gets a paginated slice of event documents matching the filter, with optional projection and sort. GoodreadsApi | goodreadsControllerGetQuotes | GET /api/goodreads/quotes | Searches quotes from Goodreads. GoodreadsApi | goodreadsControllerSearchAndGetBook | GET /api/goodreads/book | Searches for, and gets the details of a single book. GoodreadsApi | goodreadsControllerSearchBooks | GET /api/goodreads/search | Endpoint for searching books from Goodreads. HealthApi | healthControllerGetHealth | GET /api/health | Health endpoint. MigrationsApi | migrationsControllerMigrateAllEvents | GET /api/migrations/all | Migrates all events from older schema to newer one. MigrationsApi | migrationsControllerMigrateEvent | POST /api/migrations | Migrates a single event doc from older schema to newer one. MigrationsApi | migrationsControllerUpdateBooks | GET /api/migrations/updateBooks | Updates all the book documents. OpenLibraryApi | openLibraryControllerSearchAndGetBook | GET /api/openlibrary/book | Searches for, and gets the details of a single book. OpenLibraryApi | openLibraryControllerSearchBooks | GET /api/openlibrary/search | Endpoint for searching books from Open Library. StorygraphApi | storygraphControllerSearchAndGetBook | GET /api/storygraph/book | Searches for, and gets the details of a single book. StorygraphApi | storygraphControllerSearchBooks | GET /api/storygraph/search | Endpoint for searching books from Storygraph. UsersApi | usersControllerCreate | POST /api/users | Creates a user from the given Dto object. UsersApi | usersControllerFindAll | GET /api/users | Gets all user documents from the database. UsersApi | usersControllerFindOneByUserId | GET /api/users/{userid} | Gets a user from the user Id. UsersApi | usersControllerRemove | DELETE /api/users/{id} | Deletes a user with the given Id. UsersApi | usersControllerUpdate | PATCH /api/users/{id} | Updates a user with the given Id.

Documentation For Models

• AccessTokenDto
• AuthorDto
• BookDocument
• BookDto
• ClientCredentialsDto
• CreateBookDto
• CreateEventDto
• CreateUserDto
• DateRange
• EventDocument
• EventDto
• GoodreadsBookDto
• JwksDto
• JwksKeyDto
• OpenLibraryBookDto
• PaginatedEventsDto
• Participant
• ParticipantDto
• ProfileDto
• QuestionAnswerDto
• StorygraphBookDto
• UpdateEventDto
• UpdateUserDto
• UserDocument

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication (JWT)