docs: add companies

falsepopsky · Oct 20, 2023 · e2536a0 · e2536a0
1 parent 6e8850e
commit e2536a0
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 4 deletions.
diff --git 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
@@ -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 <Badge type="warning" text="endpoint" />
+
+| method                          | endpoint     |
+| ------------------------------- | ------------ |
+| <Badge type="tip" text="GET" /> | `/companies` |
+
+### First 500 Companies records <Badge type="tip" text="example" />
+
+```js
+await client.getCompanies();
+```
+
+### Companies records for the page 94 <Badge type="tip" text="example" />
+
+```js
+await client.getCompanies('94');
+```
+
+## getCompaniesTypes
+
+This method returns a list of companies records and does not require any parameters.
+
+### Supported endpoint <Badge type="warning" text="endpoint" />
+
+| method                          | endpoint           |
+| ------------------------------- | ------------------ |
+| <Badge type="tip" text="GET" /> | `/companies/types` |
+
+### Companies types records <Badge type="tip" text="example" />
+
+```js
+await client.getCompaniesTypes();
+```
+
+## getCompanyById
+
+Returns a company record
+
+| params | type     | Required | Description              |
+| ------ | -------- | :------: | ------------------------ |
+| id     | `string` |   Yes    | The `id` of the Company. |
+
+### Supported endpoint <Badge type="warning" text="endpoint" />
+
+| method                          | endpoint         |
+| ------------------------------- | ---------------- |
+| <Badge type="tip" text="GET" /> | `/companies/:id` |
+
+### Single company record <Badge type="tip" text="example" />
+
+```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
@@ -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:    |