Skip to content

Commit

Permalink
Merge pull request #45 from falsepopsky/dev
Browse files Browse the repository at this point in the history
 feat: support entities endpoint
  • Loading branch information
falsepopsky authored Oct 22, 2023
2 parents 665635a + d2751c5 commit 5a90183
Show file tree
Hide file tree
Showing 9 changed files with 364 additions and 288 deletions.
5 changes: 5 additions & 0 deletions .changeset/gentle-hotels-melt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@untidy/thetvdb': minor
---

feat: support `entities` endpoint
16 changes: 16 additions & 0 deletions docs/api/thetvdb-extended.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@ This method returns a list of country records and does not require any parameter
await client.getCountries();
```

## getEntities

This method returns a list of active entity types records and does not require any parameters.

### Supported endpoint <Badge type="warning" text="endpoint" />

| method | endpoint |
| ------------------------------- | ----------- |
| <Badge type="tip" text="GET" /> | `/entities` |

### List of active entity types records<Badge type="tip" text="example" />

```js
await client.getEntities();
```

## getGenres

This method returns a list of genre records and does not require any parameters.
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/supported-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ List of endpoints from [TheTVDB API V4](https://thetvdb.github.io/v4-api/).
| `/companies/{id}` | :white_check_mark: |
| `/content/ratings` | :white_check_mark: |
| `/countries` | :white_check_mark: |
| `/entities` | :interrobang: |
| `/entities` | :white_check_mark: |
| `/episodes` | :interrobang: |
| `/episodes/{id}` | :white_check_mark: |
| `/episodes/{id}/extended` | :white_check_mark: |
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,26 +39,26 @@
},
"devDependencies": {
"@changesets/cli": "^2.26.2",
"@swc/core": "^1.3.93",
"@swc/core": "^1.3.94",
"@swc/jest": "^0.2.29",
"@types/jest": "^29.5.6",
"@types/node": "^20.8.7",
"@typescript-eslint/eslint-plugin": "^6.8.0",
"@typescript-eslint/parser": "^6.8.0",
"dotenv": "^16.3.1",
"eslint": "^8.51.0",
"eslint": "^8.52.0",
"eslint-config-prettier": "^9.0.0",
"eslint-import-resolver-typescript": "^3.6.1",
"eslint-plugin-import": "^2.28.1",
"eslint-plugin-jest": "^27.4.2",
"eslint-plugin-jest": "^27.4.3",
"eslint-plugin-n": "^16.2.0",
"eslint-plugin-promise": "^6.1.1",
"jest": "^29.7.0",
"msw": "^1.3.2",
"prettier": "^3.0.3",
"tsx": "^3.14.0",
"typescript": "^5.2.2",
"vitepress": "1.0.0-rc.22"
"vitepress": "1.0.0-rc.23"
},
"engines": {
"node": ">=18",
Expand Down
Loading

0 comments on commit 5a90183

Please sign in to comment.