Skip to content

Commit 3b34e5a

Browse files
Wamy-DevWamy-Dev
committed
feat: updates to v1.0.7 to reflect latest changes
1 parent 6613433 commit 3b34e5a

Some content is hidden

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

50 files changed

+1657
-613
lines changed

‎documentation/models/CreateTorrentOkResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
| Name | Type | Required | Description |
1717
| :--------------------- | :----- | :------- | :---------- |
1818
| activeLimit | number | ❌ | |
19+
| authId | string | ❌ | |
1920
| currentActiveDownloads | number | ❌ | |
2021
| hash | string | ❌ | |
21-
| name | string | ❌ | |
2222
| queuedId | number | ❌ | |
2323
| torrentId | number | ❌ | |

‎documentation/models/CreateTorrentRequest.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
**Properties**
44

5-
| Name | Type | Required | Description |
6-
| :----- | :---------- | :------- | :------------------------------------ |
7-
| file | ArrayBuffer | ❌ | The torrent's torrent file. Optional. |
8-
| magnet | string | ❌ | The torrent's magnet link. Optional. |
5+
| Name | Type | Required | Description |
6+
| :------- | :---------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| allowZip | string | ❌ | Tells TorBox if you want to allow this torrent to be zipped or not. TorBox only zips if the torrent is 100 files or larger. |
8+
| asQueued | string | ❌ | Tells TorBox you want this torrent instantly queued. This is bypassed if user is on free plan, and will process the request as normal in this case. Optional. |
9+
| file | ArrayBuffer | ❌ | The torrent's torrent file. Optional. |
10+
| magnet | string | ❌ | The torrent's magnet link. Optional. |
11+
| name | string | ❌ | The name you want the torrent to be. Optional. |
12+
| seed | string | ❌ | Tells TorBox your preference for seeding this torrent. 1 is auto. 2 is seed. 3 is don't seed. Optional. Default is 1, or whatever the user has in their settings. Overwrites option in settings. |

‎documentation/models/GetHosterListOkResponse.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# GetHosterListOkResponse
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------ | :---------------------------- | :------- | :---------- |
7+
| data | GetHosterListOkResponseData[] | ❌ | |
8+
| detail | string | ❌ | |
9+
| error | any | ❌ | |
10+
| success | boolean | ❌ | |
11+
12+
# GetHosterListOkResponseData
13+
14+
**Properties**
15+
16+
| Name | Type | Required | Description |
17+
| :------------------ | :------- | :------- | :---------- |
18+
| dailyBandwidthLimit | number | ❌ | |
19+
| dailyBandwidthUsed | number | ❌ | |
20+
| dailyLinkLimit | number | ❌ | |
21+
| dailyLinkUsed | number | ❌ | |
22+
| domains | string[] | ❌ | |
23+
| domais | string[] | ❌ | |
24+
| domaisn | string[] | ❌ | |
25+
| icon | string | ❌ | |
26+
| limit | number | ❌ | |
27+
| name | string | ❌ | |
28+
| note | string | ❌ | |
29+
| status | boolean | ❌ | |
30+
| type | string | ❌ | |
31+
| url | string | ❌ | |

‎documentation/services/GeneralService.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A list of all methods in the `GeneralService` service. Click on the method name
2121
**Example Usage Code Snippet**
2222

2323
```typescript
24-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
24+
import { TorboxApi } from '@torbox/torbox-api';
2525

2626
(async () => {
2727
const torboxApi = new TorboxApi({
@@ -54,7 +54,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
5454
**Example Usage Code Snippet**
5555

5656
```typescript
57-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
57+
import { TorboxApi } from '@torbox/torbox-api';
5858

5959
(async () => {
6060
const torboxApi = new TorboxApi({

‎documentation/services/IntegrationsService.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A list of all methods in the `IntegrationsService` service. Click on the method
3030
**Example Usage Code Snippet**
3131

3232
```typescript
33-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
33+
import { TorboxApi } from '@torbox/torbox-api';
3434

3535
(async () => {
3636
const torboxApi = new TorboxApi({
@@ -60,7 +60,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
6060
**Example Usage Code Snippet**
6161

6262
```typescript
63-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
63+
import { TorboxApi } from '@torbox/torbox-api';
6464

6565
(async () => {
6666
const torboxApi = new TorboxApi({
@@ -92,7 +92,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
9292
**Example Usage Code Snippet**
9393

9494
```typescript
95-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
95+
import { TorboxApi } from '@torbox/torbox-api';
9696

9797
(async () => {
9898
const torboxApi = new TorboxApi({
@@ -124,7 +124,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
124124
**Example Usage Code Snippet**
125125

126126
```typescript
127-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
127+
import { TorboxApi } from '@torbox/torbox-api';
128128

129129
(async () => {
130130
const torboxApi = new TorboxApi({
@@ -156,7 +156,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
156156
**Example Usage Code Snippet**
157157

158158
```typescript
159-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
159+
import { TorboxApi } from '@torbox/torbox-api';
160160

161161
(async () => {
162162
const torboxApi = new TorboxApi({
@@ -191,7 +191,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
191191
**Example Usage Code Snippet**
192192

193193
```typescript
194-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
194+
import { TorboxApi } from '@torbox/torbox-api';
195195

196196
(async () => {
197197
const torboxApi = new TorboxApi({
@@ -225,7 +225,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
225225
**Example Usage Code Snippet**
226226

227227
```typescript
228-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
228+
import { TorboxApi } from '@torbox/torbox-api';
229229

230230
(async () => {
231231
const torboxApi = new TorboxApi({
@@ -259,7 +259,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
259259
**Example Usage Code Snippet**
260260

261261
```typescript
262-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
262+
import { TorboxApi } from '@torbox/torbox-api';
263263

264264
(async () => {
265265
const torboxApi = new TorboxApi({

‎documentation/services/NotificationsService.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ A list of all methods in the `NotificationsService` service. Click on the method
3131
**Example Usage Code Snippet**
3232

3333
```typescript
34-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
34+
import { TorboxApi } from '@torbox/torbox-api';
3535

3636
(async () => {
3737
const torboxApi = new TorboxApi({
@@ -66,7 +66,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
6666
**Example Usage Code Snippet**
6767

6868
```typescript
69-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
69+
import { TorboxApi } from '@torbox/torbox-api';
7070

7171
(async () => {
7272
const torboxApi = new TorboxApi({
@@ -95,7 +95,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
9595
**Example Usage Code Snippet**
9696

9797
```typescript
98-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
98+
import { TorboxApi } from '@torbox/torbox-api';
9999

100100
(async () => {
101101
const torboxApi = new TorboxApi({
@@ -125,7 +125,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
125125
**Example Usage Code Snippet**
126126

127127
```typescript
128-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
128+
import { TorboxApi } from '@torbox/torbox-api';
129129

130130
(async () => {
131131
const torboxApi = new TorboxApi({
@@ -154,7 +154,7 @@ import { TorboxApi } from '@torbox/@torbox/torbox-api';
154154
**Example Usage Code Snippet**
155155

156156
```typescript
157-
import { TorboxApi } from '@torbox/@torbox/torbox-api';
157+
import { TorboxApi } from '@torbox/torbox-api';
158158

159159
(async () => {
160160
const torboxApi = new TorboxApi({

‎documentation/services/QueuedService.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# QueuedService
2+
3+
A list of all methods in the `QueuedService` service. Click on the method name to view detailed information about that method.
4+
5+
| Methods | Description |
6+
| :------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| [getQueuedDownloads](#getqueueddownloads) | ### Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header. |
8+
| [controlQueuedDownloads](#controlqueueddownloads) | ### Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - **Delete** `deletes the queued download from your account` - **Start** `starts a queued download, cannot be used with the "all" parameter` ### Authorization Requires an API key using the Authorization Bearer Header. |
9+
10+
## getQueuedDownloads
11+
12+
### Overview Retrieves all of a user's queued downloads by type. If you want to get all 3 types, "torrent", "usenet" and "webdl" then you will need to run this request 3 times, each with the different type. ### Authorization Requires an API key using the Authorization Bearer Header.
13+
14+
- HTTP Method: `GET`
15+
- Endpoint: `/{api_version}/api/queued/getqueued`
16+
17+
**Parameters**
18+
19+
| Name | Type | Required | Description |
20+
| :---------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| apiVersion | string | ✅ | |
22+
| bypassCache | string | ❌ | Allows you to bypass the cached data, and always get fresh information. Useful if constantly querying for fresh download stats. Otherwise, we request that you save our database a few calls. |
23+
| id | string | ❌ | Determines the queued download requested, will return an object rather than list. Optional. |
24+
| offset | string | ❌ | Determines the offset of items to get from the database. Default is 0. Optional. |
25+
| limit | string | ❌ | Determines the number of items to recieve per request. Default is 1000. Optional. |
26+
| type | string | ❌ | The type of the queued download you want to retrieve. Can be "torrent", "usenet" or "webdl". Optional. Default is "torrent". |
27+
28+
**Example Usage Code Snippet**
29+
30+
```typescript
31+
import { TorboxApi } from '@torbox/torbox-api';
32+
33+
(async () => {
34+
const torboxApi = new TorboxApi({
35+
token: 'YOUR_TOKEN',
36+
});
37+
38+
const { data } = await torboxApi.queued.getQueuedDownloads('api_version', {
39+
bypassCache: 'boolean',
40+
id: 'integer',
41+
offset: 'integer',
42+
limit: 'integer',
43+
type: 'string',
44+
});
45+
46+
console.log(data);
47+
})();
48+
```
49+
50+
## controlQueuedDownloads
51+
52+
### Overview Controls a queued torrent. By sending the queued torrent's ID and the type of operation you want to perform, it will perform that action on the queued torrent. Operations are either: - **Delete** `deletes the queued download from your account` - **Start** `starts a queued download, cannot be used with the "all" parameter` ### Authorization Requires an API key using the Authorization Bearer Header.
53+
54+
- HTTP Method: `POST`
55+
- Endpoint: `/{api_version}/api/queued/controlqueued`
56+
57+
**Parameters**
58+
59+
| Name | Type | Required | Description |
60+
| :--------- | :----- | :------- | :---------------- |
61+
| body | any | ❌ | The request body. |
62+
| apiVersion | string | ✅ | |
63+
64+
**Example Usage Code Snippet**
65+
66+
```typescript
67+
import { TorboxApi } from '@torbox/torbox-api';
68+
69+
(async () => {
70+
const torboxApi = new TorboxApi({
71+
token: 'YOUR_TOKEN',
72+
});
73+
74+
const input = {};
75+
76+
const { data } = await torboxApi.queued.controlQueuedDownloads('api_version');
77+
78+
console.log(data);
79+
})();
80+
```

0 commit comments

Comments
 (0)