mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
160 lines
10 KiB
Markdown
160 lines
10 KiB
Markdown
# Task
|
|
(*task*)
|
|
|
|
## Overview
|
|
|
|
### Available Operations
|
|
|
|
* [getApiV1SystemTask](#getapiv1systemtask)
|
|
* [getApiV1SystemTaskId](#getapiv1systemtaskid)
|
|
|
|
## getApiV1SystemTask
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Prowlarr } from "prowlarr";
|
|
|
|
const prowlarr = new Prowlarr({
|
|
security: {
|
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
|
},
|
|
});
|
|
|
|
async function run() {
|
|
const result = await prowlarr.task.getApiV1SystemTask();
|
|
|
|
// Handle the result
|
|
console.log(result);
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Standalone function
|
|
|
|
The standalone function version of this method:
|
|
|
|
```typescript
|
|
import { ProwlarrCore } from "prowlarr/core.js";
|
|
import { taskGetApiV1SystemTask } from "prowlarr/funcs/taskGetApiV1SystemTask.js";
|
|
|
|
// Use `ProwlarrCore` for best tree-shaking performance.
|
|
// You can create one instance of it to use across an application.
|
|
const prowlarr = new ProwlarrCore({
|
|
security: {
|
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
|
},
|
|
});
|
|
|
|
async function run() {
|
|
const res = await taskGetApiV1SystemTask(prowlarr);
|
|
|
|
if (!res.ok) {
|
|
throw res.error;
|
|
}
|
|
|
|
const { value: result } = res;
|
|
|
|
// Handle the result
|
|
console.log(result);
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
|
|
### Response
|
|
|
|
**Promise\<[models.TaskResource[]](../../models/.md)\>**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| --------------- | --------------- | --------------- |
|
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
|
|
## getApiV1SystemTaskId
|
|
|
|
### Example Usage
|
|
|
|
```typescript
|
|
import { Prowlarr } from "prowlarr";
|
|
|
|
const prowlarr = new Prowlarr({
|
|
security: {
|
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
|
},
|
|
});
|
|
|
|
async function run() {
|
|
const result = await prowlarr.task.getApiV1SystemTaskId({
|
|
id: 459582,
|
|
});
|
|
|
|
// Handle the result
|
|
console.log(result);
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Standalone function
|
|
|
|
The standalone function version of this method:
|
|
|
|
```typescript
|
|
import { ProwlarrCore } from "prowlarr/core.js";
|
|
import { taskGetApiV1SystemTaskId } from "prowlarr/funcs/taskGetApiV1SystemTaskId.js";
|
|
|
|
// Use `ProwlarrCore` for best tree-shaking performance.
|
|
// You can create one instance of it to use across an application.
|
|
const prowlarr = new ProwlarrCore({
|
|
security: {
|
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
|
},
|
|
});
|
|
|
|
async function run() {
|
|
const res = await taskGetApiV1SystemTaskId(prowlarr, {
|
|
id: 459582,
|
|
});
|
|
|
|
if (!res.ok) {
|
|
throw res.error;
|
|
}
|
|
|
|
const { value: result } = res;
|
|
|
|
// Handle the result
|
|
console.log(result);
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `request` | [operations.GetApiV1SystemTaskIdRequest](../../models/operations/getapiv1systemtaskidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
|
|
### Response
|
|
|
|
**Promise\<[models.TaskResource](../../models/taskresource.md)\>**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| --------------- | --------------- | --------------- |
|
|
| errors.APIError | 4XX, 5XX | \*/\* | |