From 815ba408c5bcd52d4cd30b71738e7a888a4dc478 Mon Sep 17 00:00:00 2001 From: falsepopsky Date: Tue, 7 Nov 2023 18:37:13 -0300 Subject: [PATCH] docs: add new APIs --- docs/api/thetvdb-extended.md | 16 ++++++++++++++++ docs/api/thetvdb.md | 24 ++++++++++++++++++++++++ docs/guide/supported-endpoints.md | 4 ++-- 3 files changed, 42 insertions(+), 2 deletions(-) diff --git a/docs/api/thetvdb-extended.md b/docs/api/thetvdb-extended.md index 67b671f..e0a41c1 100644 --- a/docs/api/thetvdb-extended.md +++ b/docs/api/thetvdb-extended.md @@ -178,6 +178,22 @@ This method returns a list of language records and does not require any paramete await cient.getLanguages(); ``` +## getSourceTypes + +This method returns a list of source types records and does not require any parameters. + +### Supported endpoint + +| method | endpoint | +| ------------------------------- | ---------------- | +| | `/sources/types` | + +### List of source types records + +```js +await cient.getSourceTypes(); +``` + ## getUpdates Returns updated entities. diff --git a/docs/api/thetvdb.md b/docs/api/thetvdb.md index fab7d86..a2118d6 100644 --- a/docs/api/thetvdb.md +++ b/docs/api/thetvdb.md @@ -758,3 +758,27 @@ await client.getSerie({ id: '78878', extended: true, meta: 'translations', short ```js await client.getSerie({ id: '78878', extended: true, meta: 'episodes', short: true }); ``` + +## getSeriesByPage + +Returns a list of series records + +| params | type | Required | Description | +| ------ | -------- | :------: | ------------------------------- | +| page | `string` | Optional | Get series for a specific page. | + +### Supports the following endpoints + +- `/series` + +### Get series + +```js +await client.getSeriesByPage(); +``` + +### Get series from a specific page + +```js +await client.getSeriesByPage('7'); +``` diff --git a/docs/guide/supported-endpoints.md b/docs/guide/supported-endpoints.md index d394ebe..7fad850 100644 --- a/docs/guide/supported-endpoints.md +++ b/docs/guide/supported-endpoints.md @@ -62,7 +62,7 @@ List of endpoints from [TheTVDB API V4](https://thetvdb.github.io/v4-api/). | `/seasons/{id}/extended` | :white_check_mark: | | `/seasons/types` | :white_check_mark: | | `/seasons/{id}/translations/{language}` | :white_check_mark: | -| `/series` | :soon: | +| `/series` | :white_check_mark: | | `/series/{id}` | :white_check_mark: | | `/series/{id}/artworks` | :soon: | | `/series/{id}/nextAired` | :soon: | @@ -73,7 +73,7 @@ List of endpoints from [TheTVDB API V4](https://thetvdb.github.io/v4-api/). | `/series/slug/{slug}` | :soon: | | `/series/{id}/translations/{language}` | :soon: | | `/series/statuses` | :soon: | -| `/sources/types` | :soon: | +| `/sources/types` | :white_check_mark: | | `/updates` | :white_check_mark: | | `/user` | :no_entry_sign: | | `/user/{id}` | :no_entry_sign: |