docs: add new APIs

falsepopsky · Nov 7, 2023 · 815ba40 · 815ba40
1 parent ee55cb4
commit 815ba40
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 2 deletions.
diff --git 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 <Badge type="warning" text="endpoint" />
+
+| method                          | endpoint         |
+| ------------------------------- | ---------------- |
+| <Badge type="tip" text="GET" /> | `/sources/types` |
+
+### List of source types records <Badge type="tip" text="example" />
+
+```js
+await cient.getSourceTypes();
+```
+
 ## getUpdates
 
 Returns updated entities.

diff --git 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 <Badge type="warning" text="endpoint" />
+
+- <Badge type="tip" text="GET" /> `/series`
+
+### Get series <Badge type="tip" text="example" />
+
+```js
+await client.getSeriesByPage();
+```
+
+### Get series from a specific page <Badge type="tip" text="example" />
+
+```js
+await client.getSeriesByPage('7');
+```
diff --git 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:   |