diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index e077d49..e290c90 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -11,7 +11,7 @@ export default defineConfig({ nav: [ { text: 'Guide', link: '/guide/getting-started' }, { - text: '0.3.0', + text: '0.4.0', items: [ { text: 'Changelog', diff --git a/docs/api/thetvdb.md b/docs/api/thetvdb.md index 49d0ced..d80660c 100644 --- a/docs/api/thetvdb.md +++ b/docs/api/thetvdb.md @@ -216,6 +216,68 @@ Returns a character base record await client.getCharacter('64140522'); ``` +## getCompanies + +Returns a paginated list of companies records + +| params | type | Required | Description | +| ------ | -------- | :------: | ------------------------------------ | +| page | `string` | Optional | The `page` of the Companies records. | + +### Supported endpoint + +| method | endpoint | +| ------------------------------- | ------------ | +| | `/companies` | + +### First 500 Companies records + +```js +await client.getCompanies(); +``` + +### Companies records for the page 94 + +```js +await client.getCompanies('94'); +``` + +## getCompaniesTypes + +This method returns a list of companies records and does not require any parameters. + +### Supported endpoint + +| method | endpoint | +| ------------------------------- | ------------------ | +| | `/companies/types` | + +### Companies types records + +```js +await client.getCompaniesTypes(); +``` + +## getCompanyById + +Returns a company record + +| params | type | Required | Description | +| ------ | -------- | :------: | ------------------------ | +| id | `string` | Yes | The `id` of the Company. | + +### Supported endpoint + +| method | endpoint | +| ------------------------------- | ---------------- | +| | `/companies/:id` | + +### Single company record + +```js +await client.getCompanyById('4'); +``` + ## getEpisode Returns an episode base or extended record diff --git a/docs/guide/supported-endpoints.md b/docs/guide/supported-endpoints.md index fd54438..3206e8c 100644 --- a/docs/guide/supported-endpoints.md +++ b/docs/guide/supported-endpoints.md @@ -23,9 +23,9 @@ List of endpoints from [TheTVDB API V4](https://thetvdb.github.io/v4-api/). | `/awards/categories/{id}` | :white_check_mark: | | `/awards/categories/{id}/extended` | :white_check_mark: | | `/characters/{id}` | :white_check_mark: | -| `/companies` | :interrobang: | -| `/companies/types` | :interrobang: | -| `/companies/{id}` | :interrobang: | +| `/companies` | :white_check_mark: | +| `/companies/types` | :white_check_mark: | +| `/companies/{id}` | :white_check_mark: | | `/content/ratings` | :white_check_mark: | | `/countries` | :white_check_mark: | | `/entities` | :interrobang: |