LukeParke/Prowlarr-TS-SDK
1
0
Fork 0
mirror of https://github.com/LukeHagar/Prowlarr-TS-SDK.git synced 2025-12-06 04:21:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.596.0

Browse Source
This commit is contained in:
speakeasybot
2025-08-02 00:33:32 +00:00
parent 8dbe73c1db
commit 83420d4364
271 changed files with 4902 additions and 3553 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@@ -1,3 +1,7 @@
/examples/node_modules
.env
.env.local
.env.*.local
/models
/models/errors
/types

24
.speakeasy/gen.lock
View File

@@ -1,20 +1,20 @@
lockVersion: 2.0.0
id: dcd1d874-ad0d-475e-9c83-6083a087fb17
management:
docChecksum: 9f92220db0dc81897b8a47c86bfd4b04
docChecksum: 08b870054e997ae9ac243fa522fddc6f
docVersion: 1.0.0
speakeasyVersion: 1.551.0
generationVersion: 2.610.0
releaseVersion: 0.0.3
configChecksum: 5d811f2dd27627fd6d7483654d879abe
speakeasyVersion: 1.596.0
generationVersion: 2.672.0
releaseVersion: 0.1.0
configChecksum: 9e83bb4df63024a5d203047e222e194c
repoURL: https://github.com/LukeHagar/Prowlarr-TS-SDK.git
installationURL: https://github.com/LukeHagar/Prowlarr-TS-SDK
published: true
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.11
core: 3.21.9
constsAndDefaults: 0.1.12
core: 3.21.19
defaultEnabledRetries: 0.1.0
devContainers: 2.90.0
enumUnions: 0.1.0
@@ -23,11 +23,11 @@ features:
globalSecurityCallbacks: 0.1.0
globalServerURLs: 2.82.5
inputOutputModels: 2.82.0
mcpServer: 0.9.2
mcpServer: 0.9.3
nullables: 0.1.1
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.2.0
sdkHooks: 0.3.0
generatedFiles:
- .devcontainer/README.md
- .devcontainer/devcontainer.json
@@ -219,6 +219,10 @@ generatedFiles:
- docs/sdks/update/README.md
- docs/sdks/updatelogfile/README.md
- eslint.config.mjs
- examples/.env.template
- examples/README.md
- examples/apiInfoGetApi.example.ts
- examples/package.json
- jsr.json
- package.json
- src/core.ts
@@ -541,6 +545,8 @@ generatedFiles:
- src/models/errors/apierror.ts
- src/models/errors/httpclienterrors.ts
- src/models/errors/index.ts
- src/models/errors/prowlarrerror.ts
- src/models/errors/responsevalidationerror.ts
- src/models/errors/sdkvalidationerror.ts
- src/models/field.ts
- src/models/healthcheckresult.ts

10
.speakeasy/gen.yaml
View File

@@ -7,6 +7,7 @@ generation:
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
sdkInitStyle: constructor
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
@@ -18,15 +19,21 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.0.3
version: 0.1.0
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
author: Speakeasy
baseErrorName: ProwlarrError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: true
defaultErrorName: APIError
enableCustomCodeRegions: false
enableMCPServer: true
@@ -35,6 +42,7 @@ typescript:
envVarPrefix: PROWLARR
flattenGlobalSecurity: true
flatteningOrder: parameters-first
generateExamples: true
imports:
option: openapi
paths:

14
.speakeasy/workflow.lock
View File

@@ -1,21 +1,21 @@
speakeasyVersion: 1.551.0
speakeasyVersion: 1.596.0
sources:
Prowlarr:
sourceNamespace: prowlarr
sourceRevisionDigest: sha256:743d403888496179af82928439578f5409e151b87f00461b99ac66ea68d0ef11
sourceBlobDigest: sha256:aabc67353440edc8bb6dc6730997ba4f966c33d09cd7b7484469094ba2542305
sourceRevisionDigest: sha256:6baa456f48bba602729461f829069b37adfc8e86fd4d1e4e4d1813b05d5c051f
sourceBlobDigest: sha256:8fae16984135f79875d4bb019b70934a17031383dc741f05e804608d97228476
tags:
- latest
- speakeasy-sdk-regen-1747669317
- speakeasy-sdk-regen-1752107540
- 1.0.0
targets:
prowlarr:
source: Prowlarr
sourceNamespace: prowlarr
sourceRevisionDigest: sha256:743d403888496179af82928439578f5409e151b87f00461b99ac66ea68d0ef11
sourceBlobDigest: sha256:aabc67353440edc8bb6dc6730997ba4f966c33d09cd7b7484469094ba2542305
sourceRevisionDigest: sha256:6baa456f48bba602729461f829069b37adfc8e86fd4d1e4e4d1813b05d5c051f
sourceBlobDigest: sha256:8fae16984135f79875d4bb019b70934a17031383dc741f05e804608d97228476
codeSamplesNamespace: prowlarr-typescript-code-samples
codeSamplesRevisionDigest: sha256:34651feb6dceb5c359f1cb988e34589e1dbf72b3c5d0da7f372da0e334d98143
codeSamplesRevisionDigest: sha256:3d53161a9899cbfc0d9547bc9a8d709f513fd1aabd643f7061b955cb8b8b262e
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

27
FUNCTIONS.md
View File

@@ -21,7 +21,6 @@ specific category of applications.
```typescript
import { ProwlarrCore } from "prowlarr/core.js";
import { apiInfoGetApi } from "prowlarr/funcs/apiInfoGetApi.js";
import { SDKValidationError } from "prowlarr/models/errors/sdkvalidationerror.js";
// Use `ProwlarrCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
@@ -33,28 +32,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await apiInfoGetApi(prowlarr);
switch (true) {
case res.ok:
// The success case will be handled outside of the switch block
break;
case res.error instanceof SDKValidationError:
// Pretty-print validation errors.
return console.log(res.error.pretty());
case res.error instanceof Error:
return console.log(res.error);
default:
// TypeScript's type checking will fail on the following line if the above
// cases were not exhaustive.
res.error satisfies never;
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("apiInfoGetApi failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

80
README.md
View File

@@ -169,7 +169,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}
@@ -203,7 +202,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}
@@ -628,7 +626,6 @@ async function run() {
},
});
// Handle the result
console.log(result);
}
@@ -659,7 +656,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}
@@ -671,15 +667,20 @@ run();
<!-- Start Error Handling [errors] -->
## Error Handling
If the request fails due to, for example 4XX or 5XX status codes, it will throw a `APIError`.
[`ProwlarrError`](./src/models/errors/prowlarrerror.ts) is the base class for all HTTP error responses. It has the following properties:
| Error Type | Status Code | Content Type |
| --------------- | ----------- | ------------ |
| errors.APIError | 4XX, 5XX | \*/\* |
| Property | Type | Description |
| ------------------- | ---------- | ------------------------------------------------------ |
| `error.message` | `string` | Error message |
| `error.statusCode` | `number` | HTTP response status code eg `404` |
| `error.headers` | `Headers` | HTTP response headers |
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
| `error.rawResponse` | `Response` | Raw HTTP response |
### Example
```typescript
import { Prowlarr } from "prowlarr";
import { SDKValidationError } from "prowlarr/models/errors";
import * as errors from "prowlarr/models/errors";
const prowlarr = new Prowlarr({
security: {
@@ -688,34 +689,16 @@ const prowlarr = new Prowlarr({
});
async function run() {
let result;
try {
result = await prowlarr.apiInfo.getApi();
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError):
{
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
apierror.js;
// Server returned an error status code or an unknown content type
case (err instanceof APIError): {
console.error(err.statusCode);
console.error(err.rawResponse.body);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
} catch (error) {
if (error instanceof errors.ProwlarrError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
}
}
}
@@ -724,17 +707,26 @@ run();
```
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
### Error Classes
**Primary error:**
* [`ProwlarrError`](./src/models/errors/prowlarrerror.ts): The base class for HTTP error responses.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
<details><summary>Less common errors (6)</summary>
| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
<br />
**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
**Inherit from [`ProwlarrError`](./src/models/errors/prowlarrerror.ts)**:
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
</details>
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
@@ -765,7 +757,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}
@@ -789,7 +780,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}

12
RELEASES.md
View File

@@ -16,4 +16,14 @@ Based on:
### Generated
- [typescript v0.0.3] .
### Releases
- [NPM v0.0.3] https://www.npmjs.com/package/prowlarr/v/0.0.3 - .
- [NPM v0.0.3] https://www.npmjs.com/package/prowlarr/v/0.0.3 - .
## 2025-08-02 00:32:14
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.596.0 (2.672.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.1.0] .
### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/prowlarr/v/0.1.0 - .

1
USAGE.md
View File

@@ -11,7 +11,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}

2
docs/models/apiinforesource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApiInfoResource } from "prowlarr";
import { ApiInfoResource } from "prowlarr/models";
let value: ApiInfoResource = {};
```

2
docs/models/applicationbulkresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApplicationBulkResource } from "prowlarr";
import { ApplicationBulkResource } from "prowlarr/models";
let value: ApplicationBulkResource = {};
```

2
docs/models/applicationresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApplicationResource } from "prowlarr";
import { ApplicationResource } from "prowlarr/models";
let value: ApplicationResource = {};
```

2
docs/models/applicationsynclevel.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApplicationSyncLevel } from "prowlarr";
import { ApplicationSyncLevel } from "prowlarr/models";
let value: ApplicationSyncLevel = "addOnly";
```

2
docs/models/applytags.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ApplyTags } from "prowlarr";
import { ApplyTags } from "prowlarr/models";
let value: ApplyTags = "replace";
```

2
docs/models/appprofileresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AppProfileResource } from "prowlarr";
import { AppProfileResource } from "prowlarr/models";
let value: AppProfileResource = {};
```

2
docs/models/authenticationrequiredtype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AuthenticationRequiredType } from "prowlarr";
import { AuthenticationRequiredType } from "prowlarr/models";
let value: AuthenticationRequiredType = "enabled";
```

2
docs/models/authenticationtype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { AuthenticationType } from "prowlarr";
import { AuthenticationType } from "prowlarr/models";
let value: AuthenticationType = "none";
```

2
docs/models/backupresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { BackupResource } from "prowlarr";
import { BackupResource } from "prowlarr/models";
let value: BackupResource = {};
```

2
docs/models/backuptype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { BackupType } from "prowlarr";
import { BackupType } from "prowlarr/models";
let value: BackupType = "update";
```

2
docs/models/booksearchparam.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { BookSearchParam } from "prowlarr";
import { BookSearchParam } from "prowlarr/models";
let value: BookSearchParam = "q";
```

2
docs/models/certificatevalidationtype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CertificateValidationType } from "prowlarr";
import { CertificateValidationType } from "prowlarr/models";
let value: CertificateValidationType = "enabled";
```

2
docs/models/command.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Command } from "prowlarr";
import { Command } from "prowlarr/models";
let value: Command = {};
```

2
docs/models/commandinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandInput } from "prowlarr";
import { CommandInput } from "prowlarr/models";
let value: CommandInput = {};
```

2
docs/models/commandpriority.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandPriority } from "prowlarr";
import { CommandPriority } from "prowlarr/models";
let value: CommandPriority = "high";
```

2
docs/models/commandresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandResource } from "prowlarr";
import { CommandResource } from "prowlarr/models";
let value: CommandResource = {};
```

2
docs/models/commandresourceinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandResourceInput } from "prowlarr";
import { CommandResourceInput } from "prowlarr/models";
let value: CommandResourceInput = {};
```

2
docs/models/commandstatus.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandStatus } from "prowlarr";
import { CommandStatus } from "prowlarr/models";
let value: CommandStatus = "orphaned";
```

2
docs/models/commandtrigger.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CommandTrigger } from "prowlarr";
import { CommandTrigger } from "prowlarr/models";
let value: CommandTrigger = "unspecified";
```

2
docs/models/customfilterresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { CustomFilterResource } from "prowlarr";
import { CustomFilterResource } from "prowlarr/models";
let value: CustomFilterResource = {};
```

2
docs/models/databasetype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DatabaseType } from "prowlarr";
import { DatabaseType } from "prowlarr/models";
let value: DatabaseType = "sqLite";
```

2
docs/models/developmentconfigresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DevelopmentConfigResource } from "prowlarr";
import { DevelopmentConfigResource } from "prowlarr/models";
let value: DevelopmentConfigResource = {};
```

2
docs/models/downloadclientbulkresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DownloadClientBulkResource } from "prowlarr";
import { DownloadClientBulkResource } from "prowlarr/models";
let value: DownloadClientBulkResource = {};
```

2
docs/models/downloadclientcategory.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DownloadClientCategory } from "prowlarr";
import { DownloadClientCategory } from "prowlarr/models";
let value: DownloadClientCategory = {};
```

2
docs/models/downloadclientconfigresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DownloadClientConfigResource } from "prowlarr";
import { DownloadClientConfigResource } from "prowlarr/models";
let value: DownloadClientConfigResource = {};
```

2
docs/models/downloadclientresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DownloadClientResource } from "prowlarr";
import { DownloadClientResource } from "prowlarr/models";
let value: DownloadClientResource = {};
```

2
docs/models/downloadprotocol.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { DownloadProtocol } from "prowlarr";
import { DownloadProtocol } from "prowlarr/models";
let value: DownloadProtocol = "torrent";
```

2
docs/models/field.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Field } from "prowlarr";
import { Field } from "prowlarr/models";
let value: Field = {};
```

2
docs/models/healthcheckresult.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HealthCheckResult } from "prowlarr";
import { HealthCheckResult } from "prowlarr/models";
let value: HealthCheckResult = "warning";
```

2
docs/models/healthresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HealthResource } from "prowlarr";
import { HealthResource } from "prowlarr/models";
let value: HealthResource = {};
```

2
docs/models/historyeventtype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HistoryEventType } from "prowlarr";
import { HistoryEventType } from "prowlarr/models";
let value: HistoryEventType = "indexerRss";
```

2
docs/models/historyresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HistoryResource } from "prowlarr";
import { HistoryResource } from "prowlarr/models";
let value: HistoryResource = {};
```

2
docs/models/historyresourcepagingresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HistoryResourcePagingResource } from "prowlarr";
import { HistoryResourcePagingResource } from "prowlarr/models";
let value: HistoryResourcePagingResource = {};
```

2
docs/models/hostconfigresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HostConfigResource } from "prowlarr";
import { HostConfigResource } from "prowlarr/models";
let value: HostConfigResource = {};
```

2
docs/models/hoststatistics.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { HostStatistics } from "prowlarr";
import { HostStatistics } from "prowlarr/models";
let value: HostStatistics = {};
```

2
docs/models/indexerbulkresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerBulkResource } from "prowlarr";
import { IndexerBulkResource } from "prowlarr/models";
let value: IndexerBulkResource = {};
```

2
docs/models/indexercapabilityresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerCapabilityResource } from "prowlarr";
import { IndexerCapabilityResource } from "prowlarr/models";
let value: IndexerCapabilityResource = {};
```

2
docs/models/indexercapabilityresourceinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerCapabilityResourceInput } from "prowlarr";
import { IndexerCapabilityResourceInput } from "prowlarr/models";
let value: IndexerCapabilityResourceInput = {};
```

2
docs/models/indexercategory.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerCategory } from "prowlarr";
import { IndexerCategory } from "prowlarr/models";
let value: IndexerCategory = {};
```

2
docs/models/indexercategoryinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerCategoryInput } from "prowlarr";
import { IndexerCategoryInput } from "prowlarr/models";
let value: IndexerCategoryInput = {};
```

2
docs/models/indexerprivacy.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerPrivacy } from "prowlarr";
import { IndexerPrivacy } from "prowlarr/models";
let value: IndexerPrivacy = "public";
```

2
docs/models/indexerproxyresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerProxyResource } from "prowlarr";
import { IndexerProxyResource } from "prowlarr/models";
let value: IndexerProxyResource = {};
```

2
docs/models/indexerresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerResource } from "prowlarr";
import { IndexerResource } from "prowlarr/models";
let value: IndexerResource = {};
```

2
docs/models/indexerresourceinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerResourceInput } from "prowlarr";
import { IndexerResourceInput } from "prowlarr/models";
let value: IndexerResourceInput = {};
```

2
docs/models/indexerstatistics.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerStatistics } from "prowlarr";
import { IndexerStatistics } from "prowlarr/models";
let value: IndexerStatistics = {};
```

2
docs/models/indexerstatsresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerStatsResource } from "prowlarr";
import { IndexerStatsResource } from "prowlarr/models";
let value: IndexerStatsResource = {};
```

2
docs/models/indexerstatusresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { IndexerStatusResource } from "prowlarr";
import { IndexerStatusResource } from "prowlarr/models";
let value: IndexerStatusResource = {};
```

2
docs/models/localizationoption.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { LocalizationOption } from "prowlarr";
import { LocalizationOption } from "prowlarr/models";
let value: LocalizationOption = {};
```

2
docs/models/logfileresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { LogFileResource } from "prowlarr";
import { LogFileResource } from "prowlarr/models";
let value: LogFileResource = {};
```

2
docs/models/logresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { LogResource } from "prowlarr";
import { LogResource } from "prowlarr/models";
let value: LogResource = {};
```

2
docs/models/logresourcepagingresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { LogResourcePagingResource } from "prowlarr";
import { LogResourcePagingResource } from "prowlarr/models";
let value: LogResourcePagingResource = {};
```

2
docs/models/moviesearchparam.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { MovieSearchParam } from "prowlarr";
import { MovieSearchParam } from "prowlarr/models";
let value: MovieSearchParam = "tmdbId";
```

2
docs/models/musicsearchparam.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { MusicSearchParam } from "prowlarr";
import { MusicSearchParam } from "prowlarr/models";
let value: MusicSearchParam = "album";
```

2
docs/models/notificationresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { NotificationResource } from "prowlarr";
import { NotificationResource } from "prowlarr/models";
let value: NotificationResource = {};
```

2
docs/models/pingresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { PingResource } from "prowlarr";
import { PingResource } from "prowlarr/models";
let value: PingResource = {};
```

2
docs/models/privacylevel.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { PrivacyLevel } from "prowlarr";
import { PrivacyLevel } from "prowlarr/models";
let value: PrivacyLevel = "apiKey";
```

2
docs/models/providermessage.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ProviderMessage } from "prowlarr";
import { ProviderMessage } from "prowlarr/models";
let value: ProviderMessage = {};
```

2
docs/models/providermessagetype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ProviderMessageType } from "prowlarr";
import { ProviderMessageType } from "prowlarr/models";
let value: ProviderMessageType = "warning";
```

2
docs/models/proxytype.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ProxyType } from "prowlarr";
import { ProxyType } from "prowlarr/models";
let value: ProxyType = "http";
```

2
docs/models/releaseresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ReleaseResource } from "prowlarr";
import { ReleaseResource } from "prowlarr/models";
let value: ReleaseResource = {};
```

2
docs/models/releaseresourceinput.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { ReleaseResourceInput } from "prowlarr";
import { ReleaseResourceInput } from "prowlarr/models";
let value: ReleaseResourceInput = {};
```

2
docs/models/runtimemode.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { RuntimeMode } from "prowlarr";
import { RuntimeMode } from "prowlarr/models";
let value: RuntimeMode = "console";
```

2
docs/models/searchparam.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { SearchParam } from "prowlarr";
import { SearchParam } from "prowlarr/models";
let value: SearchParam = "q";
```

2
docs/models/security.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { Security } from "prowlarr";
import { Security } from "prowlarr/models";
let value: Security = {};
```

2
docs/models/selectoption.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { SelectOption } from "prowlarr";
import { SelectOption } from "prowlarr/models";
let value: SelectOption = {};
```

2
docs/models/sortdirection.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { SortDirection } from "prowlarr";
import { SortDirection } from "prowlarr/models";
let value: SortDirection = "default";
```

2
docs/models/systemresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { SystemResource } from "prowlarr";
import { SystemResource } from "prowlarr/models";
let value: SystemResource = {};
```

2
docs/models/tagdetailsresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { TagDetailsResource } from "prowlarr";
import { TagDetailsResource } from "prowlarr/models";
let value: TagDetailsResource = {};
```

2
docs/models/tagresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { TagResource } from "prowlarr";
import { TagResource } from "prowlarr/models";
let value: TagResource = {};
```

2
docs/models/taskresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { TaskResource } from "prowlarr";
import { TaskResource } from "prowlarr/models";
let value: TaskResource = {};
```

2
docs/models/tvsearchparam.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { TvSearchParam } from "prowlarr";
import { TvSearchParam } from "prowlarr/models";
let value: TvSearchParam = "tvMazeId";
```

2
docs/models/uiconfigresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { UiConfigResource } from "prowlarr";
import { UiConfigResource } from "prowlarr/models";
let value: UiConfigResource = {};
```

2
docs/models/updatechanges.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { UpdateChanges } from "prowlarr";
import { UpdateChanges } from "prowlarr/models";
let value: UpdateChanges = {};
```

2
docs/models/updatemechanism.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { UpdateMechanism } from "prowlarr";
import { UpdateMechanism } from "prowlarr/models";
let value: UpdateMechanism = "script";
```

2
docs/models/updateresource.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { UpdateResource } from "prowlarr";
import { UpdateResource } from "prowlarr/models";
let value: UpdateResource = {};
```

2
docs/models/useragentstatistics.md
View File

@@ -3,7 +3,7 @@
## Example Usage
```typescript
import { UserAgentStatistics } from "prowlarr";
import { UserAgentStatistics } from "prowlarr/models";
let value: UserAgentStatistics = {};
```

15
docs/sdks/apiinfo/README.md
View File

@@ -11,6 +11,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api" method="get" path="/api" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -23,7 +24,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.apiInfo.getApi();
// Handle the result
console.log(result);
}
@@ -48,15 +48,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await apiInfoGetApi(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("apiInfoGetApi failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

155
docs/sdks/application/README.md
View File

@@ -21,6 +21,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/applications/{id}" method="get" path="/api/v1/applications/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -35,7 +36,6 @@ async function run() {
id: 282902,
});
// Handle the result
console.log(result);
}
@@ -62,15 +62,12 @@ async function run() {
const res = await applicationGetApiV1ApplicationsId(prowlarr, {
id: 282902,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationGetApiV1ApplicationsId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -99,6 +96,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/applications/{id}" method="put" path="/api/v1/applications/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -113,7 +111,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -140,15 +137,12 @@ async function run() {
const res = await applicationPutApiV1ApplicationsId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationPutApiV1ApplicationsId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -177,6 +171,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/applications/{id}" method="delete" path="/api/v1/applications/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -217,14 +212,12 @@ async function run() {
const res = await applicationDeleteApiV1ApplicationsId(prowlarr, {
id: 915442,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("applicationDeleteApiV1ApplicationsId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -253,6 +246,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/applications" method="get" path="/api/v1/applications" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -265,7 +259,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.application.getApiV1Applications();
// Handle the result
console.log(result);
}
@@ -290,15 +283,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationGetApiV1Applications(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationGetApiV1Applications failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -326,6 +316,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/applications" method="post" path="/api/v1/applications" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -338,7 +329,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.application.postApiV1Applications({});
// Handle the result
console.log(result);
}
@@ -363,15 +353,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationPostApiV1Applications(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationPostApiV1Applications failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -400,6 +387,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/applications/bulk" method="put" path="/api/v1/applications/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -412,7 +400,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.application.putApiV1ApplicationsBulk();
// Handle the result
console.log(result);
}
@@ -437,15 +424,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationPutApiV1ApplicationsBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationPutApiV1ApplicationsBulk failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -474,6 +458,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/applications/bulk" method="delete" path="/api/v1/applications/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -510,14 +495,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationDeleteApiV1ApplicationsBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("applicationDeleteApiV1ApplicationsBulk failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -546,6 +529,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/applications/schema" method="get" path="/api/v1/applications/schema" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -558,7 +542,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.application.getApiV1ApplicationsSchema();
// Handle the result
console.log(result);
}
@@ -583,15 +566,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationGetApiV1ApplicationsSchema(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("applicationGetApiV1ApplicationsSchema failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -619,6 +599,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/applications/test" method="post" path="/api/v1/applications/test" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -655,14 +636,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationPostApiV1ApplicationsTest(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("applicationPostApiV1ApplicationsTest failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -691,6 +670,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/applications/testall" method="post" path="/api/v1/applications/testall" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -727,14 +707,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await applicationPostApiV1ApplicationsTestall(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("applicationPostApiV1ApplicationsTestall failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -762,6 +740,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/applications/action/{name}" method="post" path="/api/v1/applications/action/{name}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -802,14 +781,12 @@ async function run() {
const res = await applicationPostApiV1ApplicationsActionName(prowlarr, {
name: "<value>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("applicationPostApiV1ApplicationsActionName failed:", res.error);
}
const { value: result } = res;
}
run();

88
docs/sdks/appprofile/README.md
View File

@@ -16,6 +16,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/appprofile" method="post" path="/api/v1/appprofile" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -28,7 +29,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.appProfile.postApiV1Appprofile();
// Handle the result
console.log(result);
}
@@ -53,15 +53,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await appProfilePostApiV1Appprofile(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("appProfilePostApiV1Appprofile failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -90,6 +87,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/appprofile" method="get" path="/api/v1/appprofile" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -102,7 +100,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.appProfile.getApiV1Appprofile();
// Handle the result
console.log(result);
}
@@ -127,15 +124,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await appProfileGetApiV1Appprofile(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("appProfileGetApiV1Appprofile failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -163,6 +157,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/appprofile/{id}" method="delete" path="/api/v1/appprofile/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -203,14 +198,12 @@ async function run() {
const res = await appProfileDeleteApiV1AppprofileId(prowlarr, {
id: 344853,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("appProfileDeleteApiV1AppprofileId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -239,6 +232,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/appprofile/{id}" method="put" path="/api/v1/appprofile/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -253,7 +247,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -280,15 +273,12 @@ async function run() {
const res = await appProfilePutApiV1AppprofileId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("appProfilePutApiV1AppprofileId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -317,6 +307,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/appprofile/{id}" method="get" path="/api/v1/appprofile/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -331,7 +322,6 @@ async function run() {
id: 92439,
});
// Handle the result
console.log(result);
}
@@ -358,15 +348,12 @@ async function run() {
const res = await appProfileGetApiV1AppprofileId(prowlarr, {
id: 92439,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("appProfileGetApiV1AppprofileId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -395,6 +382,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/appprofile/schema" method="get" path="/api/v1/appprofile/schema" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -407,7 +395,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.appProfile.getApiV1AppprofileSchema();
// Handle the result
console.log(result);
}
@@ -432,15 +419,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await appProfileGetApiV1AppprofileSchema(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("appProfileGetApiV1AppprofileSchema failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

13
docs/sdks/authentication/README.md
View File

@@ -11,6 +11,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/logout" method="get" path="/logout" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -47,14 +48,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await authenticationGetLogout(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("authenticationGetLogout failed:", res.error);
}
const { value: result } = res;
}
run();

54
docs/sdks/backup/README.md
View File

@@ -14,6 +14,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/system/backup" method="get" path="/api/v1/system/backup" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -26,7 +27,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.backup.getApiV1SystemBackup();
// Handle the result
console.log(result);
}
@@ -51,15 +51,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await backupGetApiV1SystemBackup(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("backupGetApiV1SystemBackup failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -87,6 +84,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/system/backup/{id}" method="delete" path="/api/v1/system/backup/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -127,14 +125,12 @@ async function run() {
const res = await backupDeleteApiV1SystemBackupId(prowlarr, {
id: 305836,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("backupDeleteApiV1SystemBackupId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -163,6 +159,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/system/backup/restore/{id}" method="post" path="/api/v1/system/backup/restore/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -203,14 +200,12 @@ async function run() {
const res = await backupPostApiV1SystemBackupRestoreId(prowlarr, {
id: 246520,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("backupPostApiV1SystemBackupRestoreId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -239,6 +234,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/system/backup/restore/upload" method="post" path="/api/v1/system/backup/restore/upload" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -275,14 +271,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await backupPostApiV1SystemBackupRestoreUpload(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("backupPostApiV1SystemBackupRestoreUpload failed:", res.error);
}
const { value: result } = res;
}
run();

58
docs/sdks/command/README.md
View File

@@ -14,6 +14,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/command/{id}" method="get" path="/api/v1/command/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -28,7 +29,6 @@ async function run() {
id: 274829,
});
// Handle the result
console.log(result);
}
@@ -55,15 +55,12 @@ async function run() {
const res = await commandGetApiV1CommandId(prowlarr, {
id: 274829,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("commandGetApiV1CommandId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -92,6 +89,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/command/{id}" method="delete" path="/api/v1/command/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -132,14 +130,12 @@ async function run() {
const res = await commandDeleteApiV1CommandId(prowlarr, {
id: 932632,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("commandDeleteApiV1CommandId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -168,6 +164,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/command" method="post" path="/api/v1/command" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -180,7 +177,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.command.postApiV1Command();
// Handle the result
console.log(result);
}
@@ -205,15 +201,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await commandPostApiV1Command(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("commandPostApiV1Command failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -242,6 +235,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/command" method="get" path="/api/v1/command" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -254,7 +248,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.command.getApiV1Command();
// Handle the result
console.log(result);
}
@@ -279,15 +272,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await commandGetApiV1Command(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("commandGetApiV1Command failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

73
docs/sdks/customfilter/README.md
View File

@@ -15,6 +15,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/customfilter/{id}" method="get" path="/api/v1/customfilter/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -29,7 +30,6 @@ async function run() {
id: 367030,
});
// Handle the result
console.log(result);
}
@@ -56,15 +56,12 @@ async function run() {
const res = await customFilterGetApiV1CustomfilterId(prowlarr, {
id: 367030,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("customFilterGetApiV1CustomfilterId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -93,6 +90,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/customfilter/{id}" method="put" path="/api/v1/customfilter/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -107,7 +105,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -134,15 +131,12 @@ async function run() {
const res = await customFilterPutApiV1CustomfilterId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("customFilterPutApiV1CustomfilterId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -171,6 +165,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/customfilter/{id}" method="delete" path="/api/v1/customfilter/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -211,14 +206,12 @@ async function run() {
const res = await customFilterDeleteApiV1CustomfilterId(prowlarr, {
id: 400472,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("customFilterDeleteApiV1CustomfilterId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -247,6 +240,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/customfilter" method="get" path="/api/v1/customfilter" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -259,7 +253,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.customFilter.getApiV1Customfilter();
// Handle the result
console.log(result);
}
@@ -284,15 +277,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await customFilterGetApiV1Customfilter(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("customFilterGetApiV1Customfilter failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -320,6 +310,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/customfilter" method="post" path="/api/v1/customfilter" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -332,7 +323,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.customFilter.postApiV1Customfilter();
// Handle the result
console.log(result);
}
@@ -357,15 +347,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await customFilterPostApiV1Customfilter(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("customFilterPostApiV1Customfilter failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

45
docs/sdks/developmentconfig/README.md
View File

@@ -13,6 +13,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/config/development/{id}" method="put" path="/api/v1/config/development/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -27,7 +28,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -54,15 +54,12 @@ async function run() {
const res = await developmentConfigPutApiV1ConfigDevelopmentId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("developmentConfigPutApiV1ConfigDevelopmentId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -91,6 +88,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/development/{id}" method="get" path="/api/v1/config/development/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -105,7 +103,6 @@ async function run() {
id: 820899,
});
// Handle the result
console.log(result);
}
@@ -132,15 +129,12 @@ async function run() {
const res = await developmentConfigGetApiV1ConfigDevelopmentId(prowlarr, {
id: 820899,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("developmentConfigGetApiV1ConfigDevelopmentId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -169,6 +163,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/development" method="get" path="/api/v1/config/development" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -181,7 +176,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.developmentConfig.getApiV1ConfigDevelopment();
// Handle the result
console.log(result);
}
@@ -206,15 +200,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await developmentConfigGetApiV1ConfigDevelopment(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("developmentConfigGetApiV1ConfigDevelopment failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

155
docs/sdks/downloadclient/README.md
View File

@@ -21,6 +21,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/downloadclient/{id}" method="get" path="/api/v1/downloadclient/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -35,7 +36,6 @@ async function run() {
id: 335668,
});
// Handle the result
console.log(result);
}
@@ -62,15 +62,12 @@ async function run() {
const res = await downloadClientGetApiV1DownloadclientId(prowlarr, {
id: 335668,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientGetApiV1DownloadclientId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -99,6 +96,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/downloadclient/{id}" method="put" path="/api/v1/downloadclient/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -113,7 +111,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -140,15 +137,12 @@ async function run() {
const res = await downloadClientPutApiV1DownloadclientId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientPutApiV1DownloadclientId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -177,6 +171,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/downloadclient/{id}" method="delete" path="/api/v1/downloadclient/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -217,14 +212,12 @@ async function run() {
const res = await downloadClientDeleteApiV1DownloadclientId(prowlarr, {
id: 670627,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("downloadClientDeleteApiV1DownloadclientId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -253,6 +246,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/downloadclient" method="get" path="/api/v1/downloadclient" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -265,7 +259,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.downloadClient.getApiV1Downloadclient();
// Handle the result
console.log(result);
}
@@ -290,15 +283,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientGetApiV1Downloadclient(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientGetApiV1Downloadclient failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -326,6 +316,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/downloadclient" method="post" path="/api/v1/downloadclient" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -338,7 +329,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.downloadClient.postApiV1Downloadclient({});
// Handle the result
console.log(result);
}
@@ -363,15 +353,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientPostApiV1Downloadclient(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientPostApiV1Downloadclient failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -400,6 +387,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/downloadclient/bulk" method="put" path="/api/v1/downloadclient/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -412,7 +400,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.downloadClient.putApiV1DownloadclientBulk();
// Handle the result
console.log(result);
}
@@ -437,15 +424,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientPutApiV1DownloadclientBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientPutApiV1DownloadclientBulk failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -474,6 +458,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/downloadclient/bulk" method="delete" path="/api/v1/downloadclient/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -510,14 +495,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientDeleteApiV1DownloadclientBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("downloadClientDeleteApiV1DownloadclientBulk failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -546,6 +529,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/downloadclient/schema" method="get" path="/api/v1/downloadclient/schema" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -558,7 +542,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.downloadClient.getApiV1DownloadclientSchema();
// Handle the result
console.log(result);
}
@@ -583,15 +566,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientGetApiV1DownloadclientSchema(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientGetApiV1DownloadclientSchema failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -619,6 +599,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/downloadclient/test" method="post" path="/api/v1/downloadclient/test" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -655,14 +636,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientPostApiV1DownloadclientTest(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("downloadClientPostApiV1DownloadclientTest failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -691,6 +670,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/downloadclient/testall" method="post" path="/api/v1/downloadclient/testall" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -727,14 +707,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientPostApiV1DownloadclientTestall(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("downloadClientPostApiV1DownloadclientTestall failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -762,6 +740,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/downloadclient/action/{name}" method="post" path="/api/v1/downloadclient/action/{name}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -802,14 +781,12 @@ async function run() {
const res = await downloadClientPostApiV1DownloadclientActionName(prowlarr, {
name: "<value>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("downloadClientPostApiV1DownloadclientActionName failed:", res.error);
}
const { value: result } = res;
}
run();

45
docs/sdks/downloadclientconfig/README.md
View File

@@ -13,6 +13,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/downloadclient/{id}" method="get" path="/api/v1/config/downloadclient/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -27,7 +28,6 @@ async function run() {
id: 300484,
});
// Handle the result
console.log(result);
}
@@ -54,15 +54,12 @@ async function run() {
const res = await downloadClientConfigGetApiV1ConfigDownloadclientId(prowlarr, {
id: 300484,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientConfigGetApiV1ConfigDownloadclientId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -91,6 +88,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/config/downloadclient/{id}" method="put" path="/api/v1/config/downloadclient/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -105,7 +103,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -132,15 +129,12 @@ async function run() {
const res = await downloadClientConfigPutApiV1ConfigDownloadclientId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientConfigPutApiV1ConfigDownloadclientId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -169,6 +163,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/downloadclient" method="get" path="/api/v1/config/downloadclient" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -181,7 +176,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.downloadClientConfig.getApiV1ConfigDownloadclient();
// Handle the result
console.log(result);
}
@@ -206,15 +200,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await downloadClientConfigGetApiV1ConfigDownloadclient(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("downloadClientConfigGetApiV1ConfigDownloadclient failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

26
docs/sdks/filesystem/README.md
View File

@@ -12,6 +12,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/filesystem" method="get" path="/api/v1/filesystem" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -48,14 +49,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await fileSystemGetApiV1Filesystem(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("fileSystemGetApiV1Filesystem failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -84,6 +83,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/filesystem/type" method="get" path="/api/v1/filesystem/type" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -120,14 +120,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await fileSystemGetApiV1FilesystemType(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("fileSystemGetApiV1FilesystemType failed:", res.error);
}
const { value: result } = res;
}
run();

15
docs/sdks/health/README.md
View File

@@ -11,6 +11,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/health" method="get" path="/api/v1/health" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -23,7 +24,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.health.getApiV1Health();
// Handle the result
console.log(result);
}
@@ -48,15 +48,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await healthGetApiV1Health(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("healthGetApiV1Health failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

45
docs/sdks/history/README.md
View File

@@ -13,6 +13,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/history" method="get" path="/api/v1/history" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -25,7 +26,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.history.getApiV1History({});
// Handle the result
console.log(result);
}
@@ -50,15 +50,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await historyGetApiV1History(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("historyGetApiV1History failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -87,6 +84,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/history/since" method="get" path="/api/v1/history/since" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -99,7 +97,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.history.getApiV1HistorySince({});
// Handle the result
console.log(result);
}
@@ -124,15 +121,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await historyGetApiV1HistorySince(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("historyGetApiV1HistorySince failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -161,6 +155,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/history/indexer" method="get" path="/api/v1/history/indexer" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -173,7 +168,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.history.getApiV1HistoryIndexer({});
// Handle the result
console.log(result);
}
@@ -198,15 +192,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await historyGetApiV1HistoryIndexer(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("historyGetApiV1HistoryIndexer failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

45
docs/sdks/hostconfig/README.md
View File

@@ -13,6 +13,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/host/{id}" method="get" path="/api/v1/config/host/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -27,7 +28,6 @@ async function run() {
id: 316887,
});
// Handle the result
console.log(result);
}
@@ -54,15 +54,12 @@ async function run() {
const res = await hostConfigGetApiV1ConfigHostId(prowlarr, {
id: 316887,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("hostConfigGetApiV1ConfigHostId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -91,6 +88,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/config/host/{id}" method="put" path="/api/v1/config/host/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -105,7 +103,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -132,15 +129,12 @@ async function run() {
const res = await hostConfigPutApiV1ConfigHostId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("hostConfigPutApiV1ConfigHostId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -169,6 +163,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/config/host" method="get" path="/api/v1/config/host" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -181,7 +176,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.hostConfig.getApiV1ConfigHost();
// Handle the result
console.log(result);
}
@@ -206,15 +200,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await hostConfigGetApiV1ConfigHost(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("hostConfigGetApiV1ConfigHost failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

155
docs/sdks/indexer/README.md
View File

@@ -21,6 +21,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/indexer/{id}" method="get" path="/api/v1/indexer/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -35,7 +36,6 @@ async function run() {
id: 596285,
});
// Handle the result
console.log(result);
}
@@ -62,15 +62,12 @@ async function run() {
const res = await indexerGetApiV1IndexerId(prowlarr, {
id: 596285,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerGetApiV1IndexerId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -99,6 +96,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/indexer/{id}" method="put" path="/api/v1/indexer/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -113,7 +111,6 @@ async function run() {
id: "<id>",
});
// Handle the result
console.log(result);
}
@@ -140,15 +137,12 @@ async function run() {
const res = await indexerPutApiV1IndexerId(prowlarr, {
id: "<id>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerPutApiV1IndexerId failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -177,6 +171,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/indexer/{id}" method="delete" path="/api/v1/indexer/{id}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -217,14 +212,12 @@ async function run() {
const res = await indexerDeleteApiV1IndexerId(prowlarr, {
id: 158662,
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("indexerDeleteApiV1IndexerId failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -253,6 +246,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/indexer" method="get" path="/api/v1/indexer" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -265,7 +259,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.indexer.getApiV1Indexer();
// Handle the result
console.log(result);
}
@@ -290,15 +283,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerGetApiV1Indexer(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerGetApiV1Indexer failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -326,6 +316,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/indexer" method="post" path="/api/v1/indexer" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -338,7 +329,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.indexer.postApiV1Indexer({});
// Handle the result
console.log(result);
}
@@ -363,15 +353,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerPostApiV1Indexer(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerPostApiV1Indexer failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -400,6 +387,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="put_/api/v1/indexer/bulk" method="put" path="/api/v1/indexer/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -412,7 +400,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.indexer.putApiV1IndexerBulk();
// Handle the result
console.log(result);
}
@@ -437,15 +424,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerPutApiV1IndexerBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerPutApiV1IndexerBulk failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -474,6 +458,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="delete_/api/v1/indexer/bulk" method="delete" path="/api/v1/indexer/bulk" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -510,14 +495,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerDeleteApiV1IndexerBulk(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("indexerDeleteApiV1IndexerBulk failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -546,6 +529,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/indexer/schema" method="get" path="/api/v1/indexer/schema" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -558,7 +542,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.indexer.getApiV1IndexerSchema();
// Handle the result
console.log(result);
}
@@ -583,15 +566,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerGetApiV1IndexerSchema(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerGetApiV1IndexerSchema failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
@@ -619,6 +599,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/indexer/test" method="post" path="/api/v1/indexer/test" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -655,14 +636,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerPostApiV1IndexerTest(prowlarr, {});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("indexerPostApiV1IndexerTest failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -691,6 +670,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/indexer/testall" method="post" path="/api/v1/indexer/testall" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -727,14 +707,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerPostApiV1IndexerTestall(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("indexerPostApiV1IndexerTestall failed:", res.error);
}
const { value: result } = res;
}
run();
@@ -762,6 +740,7 @@ run();
### Example Usage
<!-- UsageSnippet language="typescript" operationID="post_/api/v1/indexer/action/{name}" method="post" path="/api/v1/indexer/action/{name}" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -802,14 +781,12 @@ async function run() {
const res = await indexerPostApiV1IndexerActionName(prowlarr, {
name: "<value>",
});
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
} else {
console.log("indexerPostApiV1IndexerActionName failed:", res.error);
}
const { value: result } = res;
}
run();

15
docs/sdks/indexerdefaultcategories/README.md
View File

@@ -11,6 +11,7 @@
### Example Usage
<!-- UsageSnippet language="typescript" operationID="get_/api/v1/indexer/categories" method="get" path="/api/v1/indexer/categories" -->
```typescript
import { Prowlarr } from "prowlarr";
@@ -23,7 +24,6 @@ const prowlarr = new Prowlarr({
async function run() {
const result = await prowlarr.indexerDefaultCategories.getApiV1IndexerCategories();
// Handle the result
console.log(result);
}
@@ -48,15 +48,12 @@ const prowlarr = new ProwlarrCore({
async function run() {
const res = await indexerDefaultCategoriesGetApiV1IndexerCategories(prowlarr);
if (!res.ok) {
throw res.error;
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("indexerDefaultCategoriesGetApiV1IndexerCategories failed:", res.error);
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();

Some files were not shown because too many files have changed in this diff Show More