Skip to content

Commit f270e94

Browse files
Wamy-DevWamy-Dev
committed
feat: brings in generated sdk
1 parent baaed9c commit f270e94

File tree

139 files changed

+11288
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

139 files changed

+11288
-1
lines changed

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+149-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,149 @@
1-
# torbox-sdk-js
1+
# TorboxApi TypeScript SDK 1.0.0
2+
3+
Welcome to the TorboxApi SDK documentation. This guide will help you get started with integrating and using the TorboxApi SDK in your project.
4+
5+
## Versions
6+
7+
- API version: `1.0.0`
8+
- SDK version: `1.0.0`
9+
10+
## About the API
11+
12+
### Full documentation for TorBox Current API Base: `https://api.torbox.app` Current API Version: `v1` You can find more API docs here: [http://api.torbox.app/docs](http://api.torbox.app/docs) (they aren't as great as these, but is in a format most people would be familiar to). ### General Information - You can rely on both `success` booleans or status codes to determine if a call was a success. Status code `200` always means a success. `403` means authentication error. `500` means something went wrong on TorBox's end. `400` means the user did something wrong, or an input wasn't correct, or expected. - There will always be a user-friendly message in `detail` for a reason why a call was a failure, or a success message. You may forward these directly to users. - The `/usenet` and the `/webdl` API endpoints are nearly the same as the `/torrents` API endpoints apart from some different named inputs and outputs. - All outputs are JSON unless otherwise specified. Check out the examples to be sure. ### Rate Limits - Unless stated below, all endpoints are rate limited to **5/sec** per IP, no edge rate limiting. - `POST` /torrents/createtorrent is rate limited to **50/hour** per IP and **10/min** at edge. - `POST` /usenet/createusenetdownload is rate limited to **25/hour** per IP and **10/min** at edge. - `POST` /webdl/createwebdownload is rate limited to **25/hour** per IP and **10/min** at edge. - If you have a specific application, please contact us with your IP and reason to get unlimited requests. ### Standard Response `json { success : boolean, // whether a response is successful or not error : string, // an error code if there was an error, or null if success detail : string, // a user-friendly message data : any // usually an object/dict, but can be anything, check the examples } ` ### Errors Table Errors codes are part of the standard response type. If the code ends in ERROR , the error is the server's fault else that error is something that the client caused. | **Error Code** | Error Meaning | | --- | --- | | DATABASE*ERROR | Could not access internal database/memory store information. | | UNKNOWN_ERROR | The reason for the error is unknown. Usually there will be error data attached in the data key. In these cases please report the request to [contact@torbox.app](https://mailto:contact@torbox.app). | | NO_AUTH | There are no provided credentials. | | BAD_TOKEN | The provided token is invalid. | | AUTH_ERROR | There was an error verifying the given authentication. | | INVALID_OPTION | The provided option is invalid. | | REDIRECT_ERROR | The server tried redirecting, but it faulted. | | OAUTH_VERIFICATION_ERROR | The server tried verifying your OAuth token, but it was not accepted by the provider. | | ENDPOINT_NOT_FOUND | If you have hit an endpoint that doesn't exist. | | ITEM_NOT_FOUND | The item you queried cannot be found. | | PLAN_RESTRICTED_FEATURE | This feature is restricted to users of higher plans. The user is recommended to upgrade their plan to use this endpoint. | | DUPLICATE_ITEM | This item already exists. | | BOZO_RSS_FEED | This RSS feed is invalid or not a well-formed XML. | | SELLIX_ERROR | There was an error with the Sellix API. Usually in the case of payments. | | TOO_MUCH_DATA | Client sent too much data to the API. Please keep requests under 100MB in size. | | DOWNLOAD_TOO_LARGE | This download is oversized for the user's plan. The user is recommended to upgrade their plan to download this file. <br> <br>Free Plan Limit: **10737418240** bytes <br>Essential Plan Limit: **214748364800** bytes <br>Standard Plan Limit: **214748364800** bytes <br>Pro Plan Limit: **536870912000** bytes | | MISSING_REQUIRED_OPTION | The API is missing required information to process the request. | | TOO_MANY_OPTIONS | Client sent too many options. Usually this has to do with the API requiring only 1 option but the client sent more than the required. | | BOZO_TORRENT | The torrent sent is not a valid torrent. | | NO_SERVERS_AVAILABLE_ERROR | There are no download servers available to handle this request. This should never happen. If you receieve this error, please contact us at [contact@torbox.app](https://mailto:contact@torbox.app). | | MONTHLY_LIMIT | User has hit the maximum monthly limit. It is recommended user upgrade their account to be able to download more. | | COOLDOWN_LIMIT | User is on download cooldown. It is recommended user upgrade their account to be able to bypass this restriction. | | ACTIVE_LIMIT | User has hit their max active download limit. It is recommended user upgrade their account or purchase addons to bypass this restriction. | | DOWNLOAD_SERVER_ERROR | There was an error interacting with the download on the download server. It is recommdned to simply wait some time before trying again. | | BOZO_NZB | The NZB sent is not a valid NZB file. | | SEARCH_ERROR | There was an error searching using the TorBox Search API. | | INVALID_DEVICE | The client is sending requests from the incorrect device. | | DIFF_ISSUE | The request parameters sent does not allow for this request to complete. | | LINK_OFFLINE | The link given is inaccessible or has no online files. | | VENDOR_DISABLED | This vendor account has been disabled. Please contact support. | | BOZO_REGEX | The regex you entered is bad. | ### Translation to Real-Debrid API Useful for if you want to add TorBox to an app where Real-Debrid is already existing. These are the API routes that are nearly the same with Real-Debrid API routes. You will have to change things such as parameters and check outputs as they both are not the same. You can find docs to Real-Debrid's API [here](https://api.real-debrid.com/). | Real-Debrid API Routes | TorBox API Routes | | --- | --- | | `GET` /torrents | `GET` /torrents/mylist | | `GET` /torrents/info/{id} | `GET` /torrents/mylist?id={id} | | `GET` /torrents/instantAvailability/{hash} | `GET` /torrents/checkcached | | `PUT` /torrents/addTorrent | `POST` /torrents/createtorrent | | `POST` /torrents/addMagnet | `POST` /torrents/createtorrent | | `POST` /torrents/selectFiles/{id} | **None**, \_not needed. Torrents will download all files. This will not be changed.* | | `DELETE` /torrents/delete/{id} | `POST` /torrents/controltorrent | | `POST` /unrestrict/link | `GET` /torrents/requestdl | ### Dates All dates returned from the API are normalized to UTC time. All dates are in the format: `%Y-%m-%dT%H:%M:%SZ` Example: `2024-10-21T20:47:03Z` = The 21st of October, 2024 at 8:47:03 PM UTC. This makes it easy for users and integrations to parse these dates and change them to the user's time zone for better UX. For more information on these formats, you can take a look at this [cheat sheet](https://strftime.org/).
13+
14+
## Table of Contents
15+
16+
- [Setup & Configuration](#setup--configuration)
17+
- [Supported Language Versions](#supported-language-versions)
18+
- [Installation](#installation)
19+
- [Authentication](#authentication)
20+
- [Access Token Authentication](#access-token-authentication)
21+
- [Setting a Custom Timeout](#setting-a-custom-timeout)
22+
- [Sample Usage](#sample-usage)
23+
- [Services](#services)
24+
- [Models](#models)
25+
- [License](#license)
26+
27+
# Setup & Configuration
28+
29+
## Supported Language Versions
30+
31+
This SDK is compatible with the following versions: `TypeScript >= 4.8.4`
32+
33+
## Installation
34+
35+
To get started with the SDK, we recommend installing using `npm`:
36+
37+
```bash
38+
npm install torbox-api
39+
```
40+
41+
## Authentication
42+
43+
### Access Token Authentication
44+
45+
The TorboxApi API uses an Access Token for authentication.
46+
47+
This token must be provided to authenticate your requests to the API.
48+
49+
#### Setting the Access Token
50+
51+
When you initialize the SDK, you can set the access token as follows:
52+
53+
```ts
54+
const sdk = new TorboxApi({ token: 'YOUR_TOKEN' });
55+
```
56+
57+
If you need to set or update the access token after initializing the SDK, you can use:
58+
59+
```ts
60+
const sdk = new TorboxApi();
61+
sdk.token = 'YOUR_TOKEN';
62+
```
63+
64+
## Setting a Custom Timeout
65+
66+
You can set a custom timeout for the SDK's HTTP requests as follows:
67+
68+
```ts
69+
const torboxApi = new TorboxApi({ timeout: 10000 });
70+
```
71+
72+
# Sample Usage
73+
74+
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
75+
76+
```ts
77+
import { TorboxApi } from 'torbox-api';
78+
79+
(async () => {
80+
const torboxApi = new TorboxApi({
81+
token: 'YOUR_TOKEN',
82+
});
83+
84+
const { data } = await torboxApi.general.getUpStatus();
85+
86+
console.log(data);
87+
})();
88+
```
89+
90+
## Services
91+
92+
The SDK provides various services to interact with the API.
93+
94+
<details>
95+
<summary>Below is a list of all available services with links to their detailed documentation:</summary>
96+
97+
| Name |
98+
| :------------------------------------------------------------------------------- |
99+
| [TorrentsService](documentation/services/TorrentsService.md) |
100+
| [UsenetService](documentation/services/UsenetService.md) |
101+
| [WebDownloadsDebridService](documentation/services/WebDownloadsDebridService.md) |
102+
| [GeneralService](documentation/services/GeneralService.md) |
103+
| [NotificationsService](documentation/services/NotificationsService.md) |
104+
| [UserService](documentation/services/UserService.md) |
105+
| [RssFeedsService](documentation/services/RssFeedsService.md) |
106+
| [IntegrationsService](documentation/services/IntegrationsService.md) |
107+
108+
</details>
109+
110+
## Models
111+
112+
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
113+
114+
<details>
115+
<summary>Below is a list of all available models with links to their detailed documentation:</summary>
116+
117+
| Name | Description |
118+
| :------------------------------------------------------------------------------------------------------- | :---------- |
119+
| [CreateTorrentRequest](documentation/models/CreateTorrentRequest.md) | |
120+
| [CreateTorrentOkResponse](documentation/models/CreateTorrentOkResponse.md) | |
121+
| [ControlTorrentOkResponse](documentation/models/ControlTorrentOkResponse.md) | |
122+
| [ControlQueuedTorrentOkResponse](documentation/models/ControlQueuedTorrentOkResponse.md) | |
123+
| [RequestDownloadLinkOkResponse](documentation/models/RequestDownloadLinkOkResponse.md) | |
124+
| [GetTorrentListOkResponse](documentation/models/GetTorrentListOkResponse.md) | |
125+
| [GetTorrentCachedAvailabilityOkResponse](documentation/models/GetTorrentCachedAvailabilityOkResponse.md) | |
126+
| [SearchAllTorrentsFromScraperOkResponse](documentation/models/SearchAllTorrentsFromScraperOkResponse.md) | |
127+
| [ExportTorrentDataOkResponse](documentation/models/ExportTorrentDataOkResponse.md) | |
128+
| [GetTorrentInfoOkResponse](documentation/models/GetTorrentInfoOkResponse.md) | |
129+
| [CreateUsenetDownloadRequest](documentation/models/CreateUsenetDownloadRequest.md) | |
130+
| [CreateUsenetDownloadOkResponse](documentation/models/CreateUsenetDownloadOkResponse.md) | |
131+
| [GetUsenetListOkResponse](documentation/models/GetUsenetListOkResponse.md) | |
132+
| [CreateWebDownloadRequest](documentation/models/CreateWebDownloadRequest.md) | |
133+
| [CreateWebDownloadOkResponse](documentation/models/CreateWebDownloadOkResponse.md) | |
134+
| [GetWebDownloadListOkResponse](documentation/models/GetWebDownloadListOkResponse.md) | |
135+
| [GetUpStatusOkResponse](documentation/models/GetUpStatusOkResponse.md) | |
136+
| [GetStatsOkResponse](documentation/models/GetStatsOkResponse.md) | |
137+
| [GetNotificationFeedOkResponse](documentation/models/GetNotificationFeedOkResponse.md) | |
138+
| [GetUserDataOkResponse](documentation/models/GetUserDataOkResponse.md) | |
139+
| [AddReferralToAccountOkResponse](documentation/models/AddReferralToAccountOkResponse.md) | |
140+
| [GetAllJobsOkResponse](documentation/models/GetAllJobsOkResponse.md) | |
141+
| [GetAllJobsByHashOkResponse](documentation/models/GetAllJobsByHashOkResponse.md) | |
142+
143+
</details>
144+
145+
## License
146+
147+
This SDK is licensed under the MIT License.
148+
149+
See the [LICENSE](LICENSE) file for more details.

‎documentation/models/AddReferralToAccountOkResponse.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AddReferralToAccountOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :------ | :------- | :---------- |
7+
| data | any | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |

‎documentation/models/ControlQueuedTorrentOkResponse.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ControlQueuedTorrentOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :------ | :------- | :---------- |
7+
| data | any | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |

‎documentation/models/ControlTorrentOkResponse.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ControlTorrentOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :------ | :------- | :---------- |
7+
| data | any | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |

‎documentation/models/CreateTorrentOkResponse.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# CreateTorrentOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :-------------------------- | :------- | :---------- |
7+
| data | CreateTorrentOkResponseData | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |
10+
11+
# CreateTorrentOkResponseData
12+
13+
**Properties**
14+
15+
| Name | Type | Required | Description |
16+
| :--------------------- | :----- | :------- | :---------- |
17+
| activeLimit | number | ❌ | |
18+
| currentActiveDownloads | number | ❌ | |
19+
| hash | string | ❌ | |
20+
| name | string | ❌ | |
21+
| queuedId | number | ❌ | |
22+
| torrentId | number | ❌ | |

‎documentation/models/CreateTorrentRequest.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreateTorrentRequest
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :----- | :---------- | :------- | :------------------------------------ |
7+
| file | ArrayBuffer | ❌ | The torrent's torrent file. Optional. |
8+
| magnet | string | ❌ | The torrent's magnet link. Optional. |

‎documentation/models/CreateUsenetDownloadOkResponse.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CreateUsenetDownloadOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :--------------------------------- | :------- | :---------- |
7+
| data | CreateUsenetDownloadOkResponseData | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |
10+
11+
# CreateUsenetDownloadOkResponseData
12+
13+
**Properties**
14+
15+
| Name | Type | Required | Description |
16+
| :--------------- | :----- | :------- | :---------- |
17+
| authId | string | ❌ | |
18+
| hash | string | ❌ | |
19+
| usenetdownloadId | string | ❌ | |

‎documentation/models/CreateUsenetDownloadRequest.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# CreateUsenetDownloadRequest
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :--- | :---------- | :------- | :-------------------------------------------------------------------- |
7+
| file | ArrayBuffer | ❌ | An NZB File. Optional. |
8+
| link | string | ❌ | An accessible link to an NZB file. Cannot be a redirection. Optional. |

‎documentation/models/CreateWebDownloadOkResponse.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CreateWebDownloadOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :------------------------------ | :------- | :---------- |
7+
| data | CreateWebDownloadOkResponseData | ❌ | |
8+
| detail | string | ❌ | |
9+
| success | boolean | ❌ | |
10+
11+
# CreateWebDownloadOkResponseData
12+
13+
**Properties**
14+
15+
| Name | Type | Required | Description |
16+
| :------------ | :----- | :------- | :---------- |
17+
| authId | string | ❌ | |
18+
| hash | string | ❌ | |
19+
| webdownloadId | string | ❌ | |

‎documentation/models/CreateWebDownloadRequest.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# CreateWebDownloadRequest
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :--- | :----- | :------- | :----------------------------------------------------------------------- |
7+
| link | string | ❌ | An accessible link to any file on the internet. Cannot be a redirection. |

‎documentation/models/ExportTorrentDataOkResponse.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ExportTorrentDataOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :----- | :----- | :------- | :---------- |
7+
| data | string | ❌ | |
8+
| detail | string | ❌ | |

0 commit comments

Comments
 (0)