mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
78 lines
4.9 KiB
Markdown
78 lines
4.9 KiB
Markdown
# Update
|
|
(*update*)
|
|
|
|
## Overview
|
|
|
|
### Available Operations
|
|
|
|
* [getApiV1Update](#getapiv1update)
|
|
|
|
## getApiV1Update
|
|
|
|
### Example Usage
|
|
|
|
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/update" method="get" path="/api/v1/update" -->
|
|
```typescript
|
|
import { Prowlarr } from "prowlarr";
|
|
|
|
const prowlarr = new Prowlarr({
|
|
security: {
|
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
|
},
|
|
});
|
|
|
|
async function run() {
|
|
const result = await prowlarr.update.getApiV1Update();
|
|
|
|
console.log(result);
|
|
}
|
|
|
|
run();
|
|
```
|
|
|
|
### Standalone function
|
|
|
|
The standalone function version of this method:
|
|
|
|
```typescript
|
|
import { ProwlarrCore } from "prowlarr/core.js";
|
|
import { updateGetApiV1Update } from "prowlarr/funcs/updateGetApiV1Update.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 updateGetApiV1Update(prowlarr);
|
|
if (res.ok) {
|
|
const { value: result } = res;
|
|
console.log(result);
|
|
} else {
|
|
console.log("updateGetApiV1Update failed:", res.error);
|
|
}
|
|
}
|
|
|
|
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.UpdateResource[]](../../models/.md)\>**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| --------------- | --------------- | --------------- |
|
|
| errors.APIError | 4XX, 5XX | \*/\* | |