mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 12:47:46 +00:00
initial generation
This commit is contained in:
Luke Hagar
30
.devcontainer/README.md
Normal file
30
.devcontainer/README.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
|
||||||
|
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
||||||
|
|
||||||
|
# Dev Containers Quick Start
|
||||||
|
|
||||||
|
The default location for usage snippets is the `samples` directory.
|
||||||
|
|
||||||
|
## Running a Usage Sample
|
||||||
|
|
||||||
|
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
|
||||||
|
|
||||||
|
```
|
||||||
|
ts-node root.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
## Generating Additional Usage Samples
|
||||||
|
|
||||||
|
The speakeasy CLI allows you to generate more usage snippets. Here's how:
|
||||||
|
|
||||||
|
- To generate a sample for a specific operation by providing an operation ID, use:
|
||||||
|
|
||||||
|
```
|
||||||
|
speakeasy generate usage -s https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json -l typescript -i {INPUT_OPERATION_ID} -o ./samples
|
||||||
|
```
|
||||||
|
|
||||||
|
- To generate samples for an entire namespace (like a tag or group name), use:
|
||||||
|
|
||||||
|
```
|
||||||
|
speakeasy generate usage -s https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json -l typescript -n {INPUT_TAG_NAME} -o ./samples
|
||||||
|
```
|
||||||
45
.devcontainer/devcontainer.json
Normal file
45
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
||||||
|
// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
|
||||||
|
{
|
||||||
|
"name": "TypeScript",
|
||||||
|
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
|
||||||
|
// Features to add to the dev container. More info: https://containers.dev/features.
|
||||||
|
// "features": {},
|
||||||
|
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||||
|
// "forwardPorts": [],
|
||||||
|
// Use 'postCreateCommand' to run commands after the container is created.
|
||||||
|
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
|
||||||
|
"customizations": {
|
||||||
|
"vscode": {
|
||||||
|
"extensions": [
|
||||||
|
"ms-vscode.vscode-typescript-tslint-plugin",
|
||||||
|
"esbenp.prettier-vscode",
|
||||||
|
"github.vscode-pull-request-github"
|
||||||
|
],
|
||||||
|
"settings": {
|
||||||
|
"files.eol": "\n",
|
||||||
|
"editor.formatOnSave": true,
|
||||||
|
"typescript.tsc.autoDetect": "on",
|
||||||
|
"typescript.updateImportsOnFileMove.enabled": "always",
|
||||||
|
"typescript.preferences.importModuleSpecifier": "relative",
|
||||||
|
"[typescript]": {
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.organizeImports": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"[typescriptreact]": {
|
||||||
|
"editor.codeActionsOnSave": {
|
||||||
|
"source.organizeImports": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"codespaces": {
|
||||||
|
"openFiles": [
|
||||||
|
".devcontainer/README.md"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
|
||||||
|
// "remoteUser": "root"
|
||||||
|
}
|
||||||
30
.devcontainer/setup.sh
Normal file
30
.devcontainer/setup.sh
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Install the speakeasy CLI
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
|
||||||
|
|
||||||
|
# Setup samples directory
|
||||||
|
rmdir samples || true
|
||||||
|
mkdir samples
|
||||||
|
|
||||||
|
npm install
|
||||||
|
npm install -g ts-node
|
||||||
|
npm link
|
||||||
|
npm link prowlarr
|
||||||
|
TS_CONFIG_CONTENT=$(cat <<EOL
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {
|
||||||
|
"openapi": ["../src/index"],
|
||||||
|
"openapi/*": ["../src/*"]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"include": ["./**/*.ts"]
|
||||||
|
}
|
||||||
|
EOL
|
||||||
|
)
|
||||||
|
echo "$TS_CONFIG_CONTENT" > samples/tsconfig.json
|
||||||
|
|
||||||
|
# Generate starter usage sample with speakeasy
|
||||||
|
speakeasy generate usage -s https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json -l typescript -o samples/root.ts
|
||||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
# This allows generated code to be indexed correctly
|
||||||
|
*.ts linguist-generated=false
|
||||||
29
.github/workflows/sdk_generation.yaml
vendored
Normal file
29
.github/workflows/sdk_generation.yaml
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
name: Generate
|
||||||
|
permissions:
|
||||||
|
checks: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
statuses: write
|
||||||
|
id-token: write
|
||||||
|
"on":
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
force:
|
||||||
|
description: Force generation of SDKs
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
set_version:
|
||||||
|
description: optionally set a specific SDK version
|
||||||
|
type: string
|
||||||
|
schedule:
|
||||||
|
- cron: 0 0 * * *
|
||||||
|
jobs:
|
||||||
|
generate:
|
||||||
|
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
|
||||||
|
with:
|
||||||
|
force: ${{ github.event.inputs.force }}
|
||||||
|
mode: pr
|
||||||
|
set_version: ${{ github.event.inputs.set_version }}
|
||||||
|
secrets:
|
||||||
|
github_access_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
|
||||||
26
.gitignore
vendored
Normal file
26
.gitignore
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
/models
|
||||||
|
/models/errors
|
||||||
|
/types
|
||||||
|
/node_modules
|
||||||
|
/lib
|
||||||
|
/sdk
|
||||||
|
/funcs
|
||||||
|
/react-query
|
||||||
|
/mcp-server
|
||||||
|
/hooks
|
||||||
|
/index.*
|
||||||
|
/core.*
|
||||||
|
/bin
|
||||||
|
/cjs
|
||||||
|
/esm
|
||||||
|
/dist
|
||||||
|
/.tsbuildinfo
|
||||||
|
/.eslintcache
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
|
/__tests__
|
||||||
|
.DS_Store
|
||||||
|
**/.speakeasy/temp/
|
||||||
|
**/.speakeasy/logs/
|
||||||
|
.DS_Store
|
||||||
|
/.speakeasy/reports
|
||||||
15
.npmignore
Normal file
15
.npmignore
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
**/*
|
||||||
|
!/FUNCTIONS.md
|
||||||
|
!/RUNTIMES.md
|
||||||
|
!/REACT_QUERY.md
|
||||||
|
!/**/*.ts
|
||||||
|
!/**/*.js
|
||||||
|
!/**/*.mjs
|
||||||
|
!/**/*.json
|
||||||
|
!/**/*.map
|
||||||
|
|
||||||
|
/eslint.config.mjs
|
||||||
|
/cjs
|
||||||
|
/.tshy
|
||||||
|
/.tshy-*
|
||||||
|
/__tests__
|
||||||
1403
.speakeasy/gen.lock
Normal file
1403
.speakeasy/gen.lock
Normal file
File diff suppressed because it is too large
Load Diff
55
.speakeasy/gen.yaml
Normal file
55
.speakeasy/gen.yaml
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
configVersion: 2.0.0
|
||||||
|
generation:
|
||||||
|
devContainers:
|
||||||
|
enabled: true
|
||||||
|
schemaPath: https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json
|
||||||
|
sdkClassName: Prowlarr
|
||||||
|
maintainOpenAPIOrder: true
|
||||||
|
usageSnippets:
|
||||||
|
optionalPropertyRendering: withExample
|
||||||
|
useClassNamesForArrayFields: true
|
||||||
|
fixes:
|
||||||
|
nameResolutionDec2023: true
|
||||||
|
nameResolutionFeb2025: true
|
||||||
|
parameterOrderingFeb2024: true
|
||||||
|
requestResponseComponentNamesFeb2024: true
|
||||||
|
securityFeb2025: true
|
||||||
|
sharedErrorComponentsApr2025: false
|
||||||
|
auth:
|
||||||
|
oAuth2ClientCredentialsEnabled: true
|
||||||
|
oAuth2PasswordEnabled: true
|
||||||
|
typescript:
|
||||||
|
version: 0.0.1
|
||||||
|
additionalDependencies:
|
||||||
|
dependencies: {}
|
||||||
|
devDependencies: {}
|
||||||
|
peerDependencies: {}
|
||||||
|
additionalPackageJSON: {}
|
||||||
|
author: Speakeasy
|
||||||
|
clientServerStatusCodesAsErrors: true
|
||||||
|
defaultErrorName: APIError
|
||||||
|
enableCustomCodeRegions: false
|
||||||
|
enableMCPServer: true
|
||||||
|
enableReactQuery: false
|
||||||
|
enumFormat: union
|
||||||
|
envVarPrefix: PROWLARR
|
||||||
|
flattenGlobalSecurity: true
|
||||||
|
flatteningOrder: parameters-first
|
||||||
|
imports:
|
||||||
|
option: openapi
|
||||||
|
paths:
|
||||||
|
callbacks: models/callbacks
|
||||||
|
errors: models/errors
|
||||||
|
operations: models/operations
|
||||||
|
shared: models
|
||||||
|
webhooks: models/webhooks
|
||||||
|
inputModelSuffix: input
|
||||||
|
jsonpath: rfc9535
|
||||||
|
maxMethodParams: 0
|
||||||
|
methodArguments: require-security-and-request
|
||||||
|
moduleFormat: dual
|
||||||
|
outputModelSuffix: output
|
||||||
|
packageName: prowlarr
|
||||||
|
responseFormat: flat
|
||||||
|
templateVersion: v2
|
||||||
|
useIndexModules: true
|
||||||
15
.speakeasy/speakeasy-modifications-overlay.yaml
Normal file
15
.speakeasy/speakeasy-modifications-overlay.yaml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
overlay: 1.0.0
|
||||||
|
x-speakeasy-jsonpath: rfc9535
|
||||||
|
info:
|
||||||
|
title: Speakeasy Modifications
|
||||||
|
version: 0.0.1
|
||||||
|
x-speakeasy-metadata:
|
||||||
|
type: speakeasy-modifications
|
||||||
|
before: ""
|
||||||
|
after: ""
|
||||||
|
actions:
|
||||||
|
- target: $["paths"]["/"]["get"]["parameters"]
|
||||||
|
remove: true
|
||||||
|
x-speakeasy-metadata:
|
||||||
|
created_at: 1747432805089
|
||||||
|
type: user-edit
|
||||||
28
.speakeasy/workflow.lock
Normal file
28
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
speakeasyVersion: 1.546.1
|
||||||
|
sources: {}
|
||||||
|
targets:
|
||||||
|
prowlarr:
|
||||||
|
source: Prowlarr
|
||||||
|
codeSamplesNamespace: prowlarr-typescript-code-samples
|
||||||
|
codeSamplesRevisionDigest: sha256:7afc8f22dd3763349bcacd94c8ea523e1f5414b3feaa39a6c30c85fd7e687643
|
||||||
|
workflow:
|
||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
Prowlarr:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json
|
||||||
|
overlays:
|
||||||
|
- location: .speakeasy/speakeasy-modifications-overlay.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/prowlarr
|
||||||
|
targets:
|
||||||
|
prowlarr:
|
||||||
|
target: typescript
|
||||||
|
source: Prowlarr
|
||||||
|
codeSamples:
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/prowlarr-typescript-code-samples
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: Typescript (SDK)
|
||||||
|
blocking: false
|
||||||
20
.speakeasy/workflow.yaml
Normal file
20
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
workflowVersion: 1.0.0
|
||||||
|
speakeasyVersion: latest
|
||||||
|
sources:
|
||||||
|
Prowlarr:
|
||||||
|
inputs:
|
||||||
|
- location: https://raw.githubusercontent.com/Prowlarr/Prowlarr/develop/src/Prowlarr.Api.V1/openapi.json
|
||||||
|
overlays:
|
||||||
|
- location: .speakeasy/speakeasy-modifications-overlay.yaml
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/prowlarr
|
||||||
|
targets:
|
||||||
|
prowlarr:
|
||||||
|
target: typescript
|
||||||
|
source: Prowlarr
|
||||||
|
codeSamples:
|
||||||
|
registry:
|
||||||
|
location: registry.speakeasyapi.dev/lukehagar/lukehagar/prowlarr-typescript-code-samples
|
||||||
|
labelOverride:
|
||||||
|
fixedValue: Typescript (SDK)
|
||||||
|
blocking: false
|
||||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Contributing to This Repository
|
||||||
|
|
||||||
|
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||||
|
|
||||||
|
## How to Report Issues
|
||||||
|
|
||||||
|
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||||
|
|
||||||
|
- A clear and descriptive title
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Expected and actual behavior
|
||||||
|
- Any relevant logs, screenshots, or error messages
|
||||||
|
- Information about your environment (e.g., operating system, software versions)
|
||||||
|
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||||
|
|
||||||
|
## Issue Triage and Upstream Fixes
|
||||||
|
|
||||||
|
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||||
|
|
||||||
|
Thank you for your understanding and cooperation!
|
||||||
|
|
||||||
|
The Maintainers
|
||||||
106
FUNCTIONS.md
Normal file
106
FUNCTIONS.md
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
# Standalone Functions
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This section is useful if you are using a bundler and targetting browsers and
|
||||||
|
> runtimes where the size of an application affects performance and load times.
|
||||||
|
|
||||||
|
Every method in this SDK is also available as a standalone function. This
|
||||||
|
alternative API is suitable when targetting the browser or serverless runtimes
|
||||||
|
and using a bundler to build your application since all unused functionality
|
||||||
|
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
||||||
|
encoding helpers and response handlers. The result is dramatically smaller
|
||||||
|
impact on the application's final bundle size which grows very slowly as you use
|
||||||
|
more and more functionality from this SDK.
|
||||||
|
|
||||||
|
Calling methods through the main SDK class remains a valid and generally more
|
||||||
|
more ergonomic option. Standalone functions represent an optimisation for a
|
||||||
|
specific category of applications.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```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.
|
||||||
|
const prowlarr = new ProwlarrCore({
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
const { value: result } = res;
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Result types
|
||||||
|
|
||||||
|
Standalone functions differ from SDK methods in that they return a
|
||||||
|
`Result<Value, Error>` type to capture _known errors_ and document them using
|
||||||
|
the type system. By avoiding throwing errors, application code maintains clear
|
||||||
|
control flow and error-handling become part of the regular flow of application
|
||||||
|
code.
|
||||||
|
|
||||||
|
> We use the term "known errors" because standalone functions, and JavaScript
|
||||||
|
> code in general, can still throw unexpected errors such as `TypeError`s,
|
||||||
|
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
||||||
|
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
||||||
|
> of benefit from capturing most errors and turning them into values.
|
||||||
|
|
||||||
|
The second reason for this style of programming is because these functions will
|
||||||
|
typically be used in front-end applications where exception throwing is
|
||||||
|
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
||||||
|
and libraries tend to promote this style of programming so that components
|
||||||
|
render useful content under all states (loading, success, error and so on).
|
||||||
|
|
||||||
|
The general pattern when calling standalone functions looks like this:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Core } from "<sdk-package-name>";
|
||||||
|
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
||||||
|
|
||||||
|
const client = new Core();
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await fetchSomething(client, { id: "123" });
|
||||||
|
if (!result.ok) {
|
||||||
|
// You can throw the error or handle it. It's your choice now.
|
||||||
|
throw result.error;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(result.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
```
|
||||||
|
|
||||||
|
Notably, `result.error` above will have an explicit type compared to a try-catch
|
||||||
|
variation where the error in the catch block can only be of type `unknown` (or
|
||||||
|
`any` depending on your TypeScript settings).
|
||||||
873
README.md
873
README.md
@@ -1,2 +1,875 @@
|
|||||||
# Prowlarr-TS-SDK
|
# Prowlarr-TS-SDK
|
||||||
# Prowlarr-TS-SDK
|
# Prowlarr-TS-SDK
|
||||||
|
|
||||||
|
<!-- Start Summary [summary] -->
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Prowlarr: Prowlarr API docs
|
||||||
|
<!-- End Summary [summary] -->
|
||||||
|
|
||||||
|
<!-- Start Table of Contents [toc] -->
|
||||||
|
## Table of Contents
|
||||||
|
<!-- $toc-max-depth=2 -->
|
||||||
|
* [Prowlarr-TS-SDK](#prowlarr-ts-sdk)
|
||||||
|
* [Prowlarr-TS-SDK](#prowlarr-ts-sdk-1)
|
||||||
|
* [SDK Installation](#sdk-installation)
|
||||||
|
* [Requirements](#requirements)
|
||||||
|
* [SDK Example Usage](#sdk-example-usage)
|
||||||
|
* [Authentication](#authentication)
|
||||||
|
* [Available Resources and Operations](#available-resources-and-operations)
|
||||||
|
* [Standalone functions](#standalone-functions)
|
||||||
|
* [Retries](#retries)
|
||||||
|
* [Error Handling](#error-handling)
|
||||||
|
* [Server Selection](#server-selection)
|
||||||
|
* [Custom HTTP Client](#custom-http-client)
|
||||||
|
* [Debugging](#debugging)
|
||||||
|
|
||||||
|
<!-- End Table of Contents [toc] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Installation [installation] -->
|
||||||
|
## SDK Installation
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
|
||||||
|
|
||||||
|
|
||||||
|
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
||||||
|
|
||||||
|
### NPM
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm add <UNSET>
|
||||||
|
```
|
||||||
|
|
||||||
|
### PNPM
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm add <UNSET>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Bun
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun add <UNSET>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Yarn
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn add <UNSET> zod
|
||||||
|
|
||||||
|
# Note that Yarn does not install peer dependencies automatically. You will need
|
||||||
|
# to install zod as shown above.
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This package is published with CommonJS and ES Modules (ESM) support.
|
||||||
|
|
||||||
|
|
||||||
|
### Model Context Protocol (MCP) Server
|
||||||
|
|
||||||
|
This SDK is also an installable MCP server where the various SDK methods are
|
||||||
|
exposed as tools that can be invoked by AI applications.
|
||||||
|
|
||||||
|
> Node.js v20 or greater is required to run the MCP server from npm.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Claude installation steps</summary>
|
||||||
|
|
||||||
|
Add the following server definition to your `claude_desktop_config.json` file:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"Prowlarr": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y", "--package", "prowlarr",
|
||||||
|
"--",
|
||||||
|
"mcp", "start",
|
||||||
|
"--x-api-key", "...",
|
||||||
|
"--apikey", "..."
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Cursor installation steps</summary>
|
||||||
|
|
||||||
|
Create a `.cursor/mcp.json` file in your project root with the following content:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"Prowlarr": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": [
|
||||||
|
"-y", "--package", "prowlarr",
|
||||||
|
"--",
|
||||||
|
"mcp", "start",
|
||||||
|
"--x-api-key", "...",
|
||||||
|
"--apikey", "..."
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -L -o mcp-server \
|
||||||
|
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
|
||||||
|
chmod +x mcp-server
|
||||||
|
```
|
||||||
|
|
||||||
|
If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
|
||||||
|
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"Todos": {
|
||||||
|
"command": "./DOWNLOAD/PATH/mcp-server",
|
||||||
|
"args": [
|
||||||
|
"start"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
For a full list of server arguments, run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npx -y --package prowlarr -- mcp start --help
|
||||||
|
```
|
||||||
|
<!-- End SDK Installation [installation] -->
|
||||||
|
|
||||||
|
<!-- Start Requirements [requirements] -->
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||||
|
<!-- End Requirements [requirements] -->
|
||||||
|
|
||||||
|
<!-- Start SDK Example Usage [usage] -->
|
||||||
|
## SDK Example Usage
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
|
|
||||||
|
<!-- Start Authentication [security] -->
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
### Per-Client Security Schemes
|
||||||
|
|
||||||
|
This SDK supports the following security schemes globally:
|
||||||
|
|
||||||
|
| Name | Type | Scheme | Environment Variable |
|
||||||
|
| --------- | ------ | ------- | -------------------- |
|
||||||
|
| `xApiKey` | apiKey | API key | `PROWLARR_X_API_KEY` |
|
||||||
|
| `apikey` | apiKey | API key | `PROWLARR_APIKEY` |
|
||||||
|
|
||||||
|
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Authentication [security] -->
|
||||||
|
|
||||||
|
<!-- Start Available Resources and Operations [operations] -->
|
||||||
|
## Available Resources and Operations
|
||||||
|
|
||||||
|
<details open>
|
||||||
|
<summary>Available methods</summary>
|
||||||
|
|
||||||
|
### [apiInfo](docs/sdks/apiinfo/README.md)
|
||||||
|
|
||||||
|
* [getApi](docs/sdks/apiinfo/README.md#getapi)
|
||||||
|
|
||||||
|
### [application](docs/sdks/application/README.md)
|
||||||
|
|
||||||
|
* [getApiV1ApplicationsId](docs/sdks/application/README.md#getapiv1applicationsid)
|
||||||
|
* [putApiV1ApplicationsId](docs/sdks/application/README.md#putapiv1applicationsid)
|
||||||
|
* [deleteApiV1ApplicationsId](docs/sdks/application/README.md#deleteapiv1applicationsid)
|
||||||
|
* [getApiV1Applications](docs/sdks/application/README.md#getapiv1applications)
|
||||||
|
* [postApiV1Applications](docs/sdks/application/README.md#postapiv1applications)
|
||||||
|
* [putApiV1ApplicationsBulk](docs/sdks/application/README.md#putapiv1applicationsbulk)
|
||||||
|
* [deleteApiV1ApplicationsBulk](docs/sdks/application/README.md#deleteapiv1applicationsbulk)
|
||||||
|
* [getApiV1ApplicationsSchema](docs/sdks/application/README.md#getapiv1applicationsschema)
|
||||||
|
* [postApiV1ApplicationsTest](docs/sdks/application/README.md#postapiv1applicationstest)
|
||||||
|
* [postApiV1ApplicationsTestall](docs/sdks/application/README.md#postapiv1applicationstestall)
|
||||||
|
* [postApiV1ApplicationsActionName](docs/sdks/application/README.md#postapiv1applicationsactionname)
|
||||||
|
|
||||||
|
### [appProfile](docs/sdks/appprofile/README.md)
|
||||||
|
|
||||||
|
* [postApiV1Appprofile](docs/sdks/appprofile/README.md#postapiv1appprofile)
|
||||||
|
* [getApiV1Appprofile](docs/sdks/appprofile/README.md#getapiv1appprofile)
|
||||||
|
* [deleteApiV1AppprofileId](docs/sdks/appprofile/README.md#deleteapiv1appprofileid)
|
||||||
|
* [putApiV1AppprofileId](docs/sdks/appprofile/README.md#putapiv1appprofileid)
|
||||||
|
* [getApiV1AppprofileId](docs/sdks/appprofile/README.md#getapiv1appprofileid)
|
||||||
|
* [getApiV1AppprofileSchema](docs/sdks/appprofile/README.md#getapiv1appprofileschema)
|
||||||
|
|
||||||
|
### [authentication](docs/sdks/authentication/README.md)
|
||||||
|
|
||||||
|
* [getLogout](docs/sdks/authentication/README.md#getlogout)
|
||||||
|
|
||||||
|
### [backup](docs/sdks/backup/README.md)
|
||||||
|
|
||||||
|
* [getApiV1SystemBackup](docs/sdks/backup/README.md#getapiv1systembackup)
|
||||||
|
* [deleteApiV1SystemBackupId](docs/sdks/backup/README.md#deleteapiv1systembackupid)
|
||||||
|
* [postApiV1SystemBackupRestoreId](docs/sdks/backup/README.md#postapiv1systembackuprestoreid)
|
||||||
|
* [postApiV1SystemBackupRestoreUpload](docs/sdks/backup/README.md#postapiv1systembackuprestoreupload)
|
||||||
|
|
||||||
|
### [command](docs/sdks/command/README.md)
|
||||||
|
|
||||||
|
* [getApiV1CommandId](docs/sdks/command/README.md#getapiv1commandid)
|
||||||
|
* [deleteApiV1CommandId](docs/sdks/command/README.md#deleteapiv1commandid)
|
||||||
|
* [postApiV1Command](docs/sdks/command/README.md#postapiv1command)
|
||||||
|
* [getApiV1Command](docs/sdks/command/README.md#getapiv1command)
|
||||||
|
|
||||||
|
### [customFilter](docs/sdks/customfilter/README.md)
|
||||||
|
|
||||||
|
* [getApiV1CustomfilterId](docs/sdks/customfilter/README.md#getapiv1customfilterid)
|
||||||
|
* [putApiV1CustomfilterId](docs/sdks/customfilter/README.md#putapiv1customfilterid)
|
||||||
|
* [deleteApiV1CustomfilterId](docs/sdks/customfilter/README.md#deleteapiv1customfilterid)
|
||||||
|
* [getApiV1Customfilter](docs/sdks/customfilter/README.md#getapiv1customfilter)
|
||||||
|
* [postApiV1Customfilter](docs/sdks/customfilter/README.md#postapiv1customfilter)
|
||||||
|
|
||||||
|
### [developmentConfig](docs/sdks/developmentconfig/README.md)
|
||||||
|
|
||||||
|
* [putApiV1ConfigDevelopmentId](docs/sdks/developmentconfig/README.md#putapiv1configdevelopmentid)
|
||||||
|
* [getApiV1ConfigDevelopmentId](docs/sdks/developmentconfig/README.md#getapiv1configdevelopmentid)
|
||||||
|
* [getApiV1ConfigDevelopment](docs/sdks/developmentconfig/README.md#getapiv1configdevelopment)
|
||||||
|
|
||||||
|
### [downloadClient](docs/sdks/downloadclient/README.md)
|
||||||
|
|
||||||
|
* [getApiV1DownloadclientId](docs/sdks/downloadclient/README.md#getapiv1downloadclientid)
|
||||||
|
* [putApiV1DownloadclientId](docs/sdks/downloadclient/README.md#putapiv1downloadclientid)
|
||||||
|
* [deleteApiV1DownloadclientId](docs/sdks/downloadclient/README.md#deleteapiv1downloadclientid)
|
||||||
|
* [getApiV1Downloadclient](docs/sdks/downloadclient/README.md#getapiv1downloadclient)
|
||||||
|
* [postApiV1Downloadclient](docs/sdks/downloadclient/README.md#postapiv1downloadclient)
|
||||||
|
* [putApiV1DownloadclientBulk](docs/sdks/downloadclient/README.md#putapiv1downloadclientbulk)
|
||||||
|
* [deleteApiV1DownloadclientBulk](docs/sdks/downloadclient/README.md#deleteapiv1downloadclientbulk)
|
||||||
|
* [getApiV1DownloadclientSchema](docs/sdks/downloadclient/README.md#getapiv1downloadclientschema)
|
||||||
|
* [postApiV1DownloadclientTest](docs/sdks/downloadclient/README.md#postapiv1downloadclienttest)
|
||||||
|
* [postApiV1DownloadclientTestall](docs/sdks/downloadclient/README.md#postapiv1downloadclienttestall)
|
||||||
|
* [postApiV1DownloadclientActionName](docs/sdks/downloadclient/README.md#postapiv1downloadclientactionname)
|
||||||
|
|
||||||
|
### [downloadClientConfig](docs/sdks/downloadclientconfig/README.md)
|
||||||
|
|
||||||
|
* [getApiV1ConfigDownloadclientId](docs/sdks/downloadclientconfig/README.md#getapiv1configdownloadclientid)
|
||||||
|
* [putApiV1ConfigDownloadclientId](docs/sdks/downloadclientconfig/README.md#putapiv1configdownloadclientid)
|
||||||
|
* [getApiV1ConfigDownloadclient](docs/sdks/downloadclientconfig/README.md#getapiv1configdownloadclient)
|
||||||
|
|
||||||
|
### [fileSystem](docs/sdks/filesystem/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Filesystem](docs/sdks/filesystem/README.md#getapiv1filesystem)
|
||||||
|
* [getApiV1FilesystemType](docs/sdks/filesystem/README.md#getapiv1filesystemtype)
|
||||||
|
|
||||||
|
### [health](docs/sdks/health/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Health](docs/sdks/health/README.md#getapiv1health)
|
||||||
|
|
||||||
|
### [history](docs/sdks/history/README.md)
|
||||||
|
|
||||||
|
* [getApiV1History](docs/sdks/history/README.md#getapiv1history)
|
||||||
|
* [getApiV1HistorySince](docs/sdks/history/README.md#getapiv1historysince)
|
||||||
|
* [getApiV1HistoryIndexer](docs/sdks/history/README.md#getapiv1historyindexer)
|
||||||
|
|
||||||
|
### [hostConfig](docs/sdks/hostconfig/README.md)
|
||||||
|
|
||||||
|
* [getApiV1ConfigHostId](docs/sdks/hostconfig/README.md#getapiv1confighostid)
|
||||||
|
* [putApiV1ConfigHostId](docs/sdks/hostconfig/README.md#putapiv1confighostid)
|
||||||
|
* [getApiV1ConfigHost](docs/sdks/hostconfig/README.md#getapiv1confighost)
|
||||||
|
|
||||||
|
### [indexer](docs/sdks/indexer/README.md)
|
||||||
|
|
||||||
|
* [getApiV1IndexerId](docs/sdks/indexer/README.md#getapiv1indexerid)
|
||||||
|
* [putApiV1IndexerId](docs/sdks/indexer/README.md#putapiv1indexerid)
|
||||||
|
* [deleteApiV1IndexerId](docs/sdks/indexer/README.md#deleteapiv1indexerid)
|
||||||
|
* [getApiV1Indexer](docs/sdks/indexer/README.md#getapiv1indexer)
|
||||||
|
* [postApiV1Indexer](docs/sdks/indexer/README.md#postapiv1indexer)
|
||||||
|
* [putApiV1IndexerBulk](docs/sdks/indexer/README.md#putapiv1indexerbulk)
|
||||||
|
* [deleteApiV1IndexerBulk](docs/sdks/indexer/README.md#deleteapiv1indexerbulk)
|
||||||
|
* [getApiV1IndexerSchema](docs/sdks/indexer/README.md#getapiv1indexerschema)
|
||||||
|
* [postApiV1IndexerTest](docs/sdks/indexer/README.md#postapiv1indexertest)
|
||||||
|
* [postApiV1IndexerTestall](docs/sdks/indexer/README.md#postapiv1indexertestall)
|
||||||
|
* [postApiV1IndexerActionName](docs/sdks/indexer/README.md#postapiv1indexeractionname)
|
||||||
|
|
||||||
|
### [indexerDefaultCategories](docs/sdks/indexerdefaultcategories/README.md)
|
||||||
|
|
||||||
|
* [getApiV1IndexerCategories](docs/sdks/indexerdefaultcategories/README.md#getapiv1indexercategories)
|
||||||
|
|
||||||
|
### [indexerProxy](docs/sdks/indexerproxy/README.md)
|
||||||
|
|
||||||
|
* [getApiV1IndexerproxyId](docs/sdks/indexerproxy/README.md#getapiv1indexerproxyid)
|
||||||
|
* [putApiV1IndexerproxyId](docs/sdks/indexerproxy/README.md#putapiv1indexerproxyid)
|
||||||
|
* [deleteApiV1IndexerproxyId](docs/sdks/indexerproxy/README.md#deleteapiv1indexerproxyid)
|
||||||
|
* [getApiV1Indexerproxy](docs/sdks/indexerproxy/README.md#getapiv1indexerproxy)
|
||||||
|
* [postApiV1Indexerproxy](docs/sdks/indexerproxy/README.md#postapiv1indexerproxy)
|
||||||
|
* [getApiV1IndexerproxySchema](docs/sdks/indexerproxy/README.md#getapiv1indexerproxyschema)
|
||||||
|
* [postApiV1IndexerproxyTest](docs/sdks/indexerproxy/README.md#postapiv1indexerproxytest)
|
||||||
|
* [postApiV1IndexerproxyTestall](docs/sdks/indexerproxy/README.md#postapiv1indexerproxytestall)
|
||||||
|
* [postApiV1IndexerproxyActionName](docs/sdks/indexerproxy/README.md#postapiv1indexerproxyactionname)
|
||||||
|
|
||||||
|
### [indexerStats](docs/sdks/indexerstats/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Indexerstats](docs/sdks/indexerstats/README.md#getapiv1indexerstats)
|
||||||
|
|
||||||
|
### [indexerStatus](docs/sdks/indexerstatus/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Indexerstatus](docs/sdks/indexerstatus/README.md#getapiv1indexerstatus)
|
||||||
|
|
||||||
|
### [localization](docs/sdks/localization/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Localization](docs/sdks/localization/README.md#getapiv1localization)
|
||||||
|
* [getApiV1LocalizationOptions](docs/sdks/localization/README.md#getapiv1localizationoptions)
|
||||||
|
|
||||||
|
### [log](docs/sdks/log/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Log](docs/sdks/log/README.md#getapiv1log)
|
||||||
|
|
||||||
|
### [logFile](docs/sdks/logfile/README.md)
|
||||||
|
|
||||||
|
* [getApiV1LogFile](docs/sdks/logfile/README.md#getapiv1logfile)
|
||||||
|
* [getApiV1LogFileFilename](docs/sdks/logfile/README.md#getapiv1logfilefilename)
|
||||||
|
|
||||||
|
### [newznab](docs/sdks/newznab/README.md)
|
||||||
|
|
||||||
|
* [getApiV1IndexerIdNewznab](docs/sdks/newznab/README.md#getapiv1indexeridnewznab)
|
||||||
|
* [getIdApi](docs/sdks/newznab/README.md#getidapi)
|
||||||
|
* [getApiV1IndexerIdDownload](docs/sdks/newznab/README.md#getapiv1indexeriddownload)
|
||||||
|
* [getIdDownload](docs/sdks/newznab/README.md#getiddownload)
|
||||||
|
|
||||||
|
### [notification](docs/sdks/notification/README.md)
|
||||||
|
|
||||||
|
* [getApiV1NotificationId](docs/sdks/notification/README.md#getapiv1notificationid)
|
||||||
|
* [putApiV1NotificationId](docs/sdks/notification/README.md#putapiv1notificationid)
|
||||||
|
* [deleteApiV1NotificationId](docs/sdks/notification/README.md#deleteapiv1notificationid)
|
||||||
|
* [getApiV1Notification](docs/sdks/notification/README.md#getapiv1notification)
|
||||||
|
* [postApiV1Notification](docs/sdks/notification/README.md#postapiv1notification)
|
||||||
|
* [getApiV1NotificationSchema](docs/sdks/notification/README.md#getapiv1notificationschema)
|
||||||
|
* [postApiV1NotificationTest](docs/sdks/notification/README.md#postapiv1notificationtest)
|
||||||
|
* [postApiV1NotificationTestall](docs/sdks/notification/README.md#postapiv1notificationtestall)
|
||||||
|
* [postApiV1NotificationActionName](docs/sdks/notification/README.md#postapiv1notificationactionname)
|
||||||
|
|
||||||
|
### [ping](docs/sdks/ping/README.md)
|
||||||
|
|
||||||
|
* [getPing](docs/sdks/ping/README.md#getping)
|
||||||
|
* [headPing](docs/sdks/ping/README.md#headping)
|
||||||
|
|
||||||
|
|
||||||
|
### [search](docs/sdks/search/README.md)
|
||||||
|
|
||||||
|
* [postApiV1Search](docs/sdks/search/README.md#postapiv1search)
|
||||||
|
* [getApiV1Search](docs/sdks/search/README.md#getapiv1search)
|
||||||
|
* [postApiV1SearchBulk](docs/sdks/search/README.md#postapiv1searchbulk)
|
||||||
|
|
||||||
|
### [staticResource](docs/sdks/staticresource/README.md)
|
||||||
|
|
||||||
|
* [getLogin](docs/sdks/staticresource/README.md#getlogin)
|
||||||
|
* [getContentPath](docs/sdks/staticresource/README.md#getcontentpath)
|
||||||
|
* [get](docs/sdks/staticresource/README.md#get)
|
||||||
|
* [getPath](docs/sdks/staticresource/README.md#getpath)
|
||||||
|
|
||||||
|
### [system](docs/sdks/system/README.md)
|
||||||
|
|
||||||
|
* [getApiV1SystemStatus](docs/sdks/system/README.md#getapiv1systemstatus)
|
||||||
|
* [getApiV1SystemRoutes](docs/sdks/system/README.md#getapiv1systemroutes)
|
||||||
|
* [getApiV1SystemRoutesDuplicate](docs/sdks/system/README.md#getapiv1systemroutesduplicate)
|
||||||
|
* [postApiV1SystemShutdown](docs/sdks/system/README.md#postapiv1systemshutdown)
|
||||||
|
* [postApiV1SystemRestart](docs/sdks/system/README.md#postapiv1systemrestart)
|
||||||
|
|
||||||
|
### [tag](docs/sdks/tag/README.md)
|
||||||
|
|
||||||
|
* [getApiV1TagId](docs/sdks/tag/README.md#getapiv1tagid)
|
||||||
|
* [putApiV1TagId](docs/sdks/tag/README.md#putapiv1tagid)
|
||||||
|
* [deleteApiV1TagId](docs/sdks/tag/README.md#deleteapiv1tagid)
|
||||||
|
* [getApiV1Tag](docs/sdks/tag/README.md#getapiv1tag)
|
||||||
|
* [postApiV1Tag](docs/sdks/tag/README.md#postapiv1tag)
|
||||||
|
|
||||||
|
### [tagDetails](docs/sdks/tagdetails/README.md)
|
||||||
|
|
||||||
|
* [getApiV1TagDetailId](docs/sdks/tagdetails/README.md#getapiv1tagdetailid)
|
||||||
|
* [getApiV1TagDetail](docs/sdks/tagdetails/README.md#getapiv1tagdetail)
|
||||||
|
|
||||||
|
### [task](docs/sdks/task/README.md)
|
||||||
|
|
||||||
|
* [getApiV1SystemTask](docs/sdks/task/README.md#getapiv1systemtask)
|
||||||
|
* [getApiV1SystemTaskId](docs/sdks/task/README.md#getapiv1systemtaskid)
|
||||||
|
|
||||||
|
### [uiConfig](docs/sdks/uiconfig/README.md)
|
||||||
|
|
||||||
|
* [putApiV1ConfigUiId](docs/sdks/uiconfig/README.md#putapiv1configuiid)
|
||||||
|
* [getApiV1ConfigUiId](docs/sdks/uiconfig/README.md#getapiv1configuiid)
|
||||||
|
* [getApiV1ConfigUi](docs/sdks/uiconfig/README.md#getapiv1configui)
|
||||||
|
|
||||||
|
### [update](docs/sdks/update/README.md)
|
||||||
|
|
||||||
|
* [getApiV1Update](docs/sdks/update/README.md#getapiv1update)
|
||||||
|
|
||||||
|
### [updateLogFile](docs/sdks/updatelogfile/README.md)
|
||||||
|
|
||||||
|
* [getApiV1LogFileUpdate](docs/sdks/updatelogfile/README.md#getapiv1logfileupdate)
|
||||||
|
* [getApiV1LogFileUpdateFilename](docs/sdks/updatelogfile/README.md#getapiv1logfileupdatefilename)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
<!-- End Available Resources and Operations [operations] -->
|
||||||
|
|
||||||
|
<!-- Start Standalone functions [standalone-funcs] -->
|
||||||
|
## Standalone functions
|
||||||
|
|
||||||
|
All the methods listed above are available as standalone functions. These
|
||||||
|
functions are ideal for use in applications running in the browser, serverless
|
||||||
|
runtimes or other environments where application bundle size is a primary
|
||||||
|
concern. When using a bundler to build your application, all unused
|
||||||
|
functionality will be either excluded from the final bundle or tree-shaken away.
|
||||||
|
|
||||||
|
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||||
|
|
||||||
|
<details>
|
||||||
|
|
||||||
|
<summary>Available standalone functions</summary>
|
||||||
|
|
||||||
|
- [`apiInfoGetApi`](docs/sdks/apiinfo/README.md#getapi)
|
||||||
|
- [`applicationDeleteApiV1ApplicationsBulk`](docs/sdks/application/README.md#deleteapiv1applicationsbulk)
|
||||||
|
- [`applicationDeleteApiV1ApplicationsId`](docs/sdks/application/README.md#deleteapiv1applicationsid)
|
||||||
|
- [`applicationGetApiV1Applications`](docs/sdks/application/README.md#getapiv1applications)
|
||||||
|
- [`applicationGetApiV1ApplicationsId`](docs/sdks/application/README.md#getapiv1applicationsid)
|
||||||
|
- [`applicationGetApiV1ApplicationsSchema`](docs/sdks/application/README.md#getapiv1applicationsschema)
|
||||||
|
- [`applicationPostApiV1Applications`](docs/sdks/application/README.md#postapiv1applications)
|
||||||
|
- [`applicationPostApiV1ApplicationsActionName`](docs/sdks/application/README.md#postapiv1applicationsactionname)
|
||||||
|
- [`applicationPostApiV1ApplicationsTest`](docs/sdks/application/README.md#postapiv1applicationstest)
|
||||||
|
- [`applicationPostApiV1ApplicationsTestall`](docs/sdks/application/README.md#postapiv1applicationstestall)
|
||||||
|
- [`applicationPutApiV1ApplicationsBulk`](docs/sdks/application/README.md#putapiv1applicationsbulk)
|
||||||
|
- [`applicationPutApiV1ApplicationsId`](docs/sdks/application/README.md#putapiv1applicationsid)
|
||||||
|
- [`appProfileDeleteApiV1AppprofileId`](docs/sdks/appprofile/README.md#deleteapiv1appprofileid)
|
||||||
|
- [`appProfileGetApiV1Appprofile`](docs/sdks/appprofile/README.md#getapiv1appprofile)
|
||||||
|
- [`appProfileGetApiV1AppprofileId`](docs/sdks/appprofile/README.md#getapiv1appprofileid)
|
||||||
|
- [`appProfileGetApiV1AppprofileSchema`](docs/sdks/appprofile/README.md#getapiv1appprofileschema)
|
||||||
|
- [`appProfilePostApiV1Appprofile`](docs/sdks/appprofile/README.md#postapiv1appprofile)
|
||||||
|
- [`appProfilePutApiV1AppprofileId`](docs/sdks/appprofile/README.md#putapiv1appprofileid)
|
||||||
|
- [`authenticationGetLogout`](docs/sdks/authentication/README.md#getlogout)
|
||||||
|
- [`backupDeleteApiV1SystemBackupId`](docs/sdks/backup/README.md#deleteapiv1systembackupid)
|
||||||
|
- [`backupGetApiV1SystemBackup`](docs/sdks/backup/README.md#getapiv1systembackup)
|
||||||
|
- [`backupPostApiV1SystemBackupRestoreId`](docs/sdks/backup/README.md#postapiv1systembackuprestoreid)
|
||||||
|
- [`backupPostApiV1SystemBackupRestoreUpload`](docs/sdks/backup/README.md#postapiv1systembackuprestoreupload)
|
||||||
|
- [`commandDeleteApiV1CommandId`](docs/sdks/command/README.md#deleteapiv1commandid)
|
||||||
|
- [`commandGetApiV1Command`](docs/sdks/command/README.md#getapiv1command)
|
||||||
|
- [`commandGetApiV1CommandId`](docs/sdks/command/README.md#getapiv1commandid)
|
||||||
|
- [`commandPostApiV1Command`](docs/sdks/command/README.md#postapiv1command)
|
||||||
|
- [`customFilterDeleteApiV1CustomfilterId`](docs/sdks/customfilter/README.md#deleteapiv1customfilterid)
|
||||||
|
- [`customFilterGetApiV1Customfilter`](docs/sdks/customfilter/README.md#getapiv1customfilter)
|
||||||
|
- [`customFilterGetApiV1CustomfilterId`](docs/sdks/customfilter/README.md#getapiv1customfilterid)
|
||||||
|
- [`customFilterPostApiV1Customfilter`](docs/sdks/customfilter/README.md#postapiv1customfilter)
|
||||||
|
- [`customFilterPutApiV1CustomfilterId`](docs/sdks/customfilter/README.md#putapiv1customfilterid)
|
||||||
|
- [`developmentConfigGetApiV1ConfigDevelopment`](docs/sdks/developmentconfig/README.md#getapiv1configdevelopment)
|
||||||
|
- [`developmentConfigGetApiV1ConfigDevelopmentId`](docs/sdks/developmentconfig/README.md#getapiv1configdevelopmentid)
|
||||||
|
- [`developmentConfigPutApiV1ConfigDevelopmentId`](docs/sdks/developmentconfig/README.md#putapiv1configdevelopmentid)
|
||||||
|
- [`downloadClientConfigGetApiV1ConfigDownloadclient`](docs/sdks/downloadclientconfig/README.md#getapiv1configdownloadclient)
|
||||||
|
- [`downloadClientConfigGetApiV1ConfigDownloadclientId`](docs/sdks/downloadclientconfig/README.md#getapiv1configdownloadclientid)
|
||||||
|
- [`downloadClientConfigPutApiV1ConfigDownloadclientId`](docs/sdks/downloadclientconfig/README.md#putapiv1configdownloadclientid)
|
||||||
|
- [`downloadClientDeleteApiV1DownloadclientBulk`](docs/sdks/downloadclient/README.md#deleteapiv1downloadclientbulk)
|
||||||
|
- [`downloadClientDeleteApiV1DownloadclientId`](docs/sdks/downloadclient/README.md#deleteapiv1downloadclientid)
|
||||||
|
- [`downloadClientGetApiV1Downloadclient`](docs/sdks/downloadclient/README.md#getapiv1downloadclient)
|
||||||
|
- [`downloadClientGetApiV1DownloadclientId`](docs/sdks/downloadclient/README.md#getapiv1downloadclientid)
|
||||||
|
- [`downloadClientGetApiV1DownloadclientSchema`](docs/sdks/downloadclient/README.md#getapiv1downloadclientschema)
|
||||||
|
- [`downloadClientPostApiV1Downloadclient`](docs/sdks/downloadclient/README.md#postapiv1downloadclient)
|
||||||
|
- [`downloadClientPostApiV1DownloadclientActionName`](docs/sdks/downloadclient/README.md#postapiv1downloadclientactionname)
|
||||||
|
- [`downloadClientPostApiV1DownloadclientTest`](docs/sdks/downloadclient/README.md#postapiv1downloadclienttest)
|
||||||
|
- [`downloadClientPostApiV1DownloadclientTestall`](docs/sdks/downloadclient/README.md#postapiv1downloadclienttestall)
|
||||||
|
- [`downloadClientPutApiV1DownloadclientBulk`](docs/sdks/downloadclient/README.md#putapiv1downloadclientbulk)
|
||||||
|
- [`downloadClientPutApiV1DownloadclientId`](docs/sdks/downloadclient/README.md#putapiv1downloadclientid)
|
||||||
|
- [`fileSystemGetApiV1Filesystem`](docs/sdks/filesystem/README.md#getapiv1filesystem)
|
||||||
|
- [`fileSystemGetApiV1FilesystemType`](docs/sdks/filesystem/README.md#getapiv1filesystemtype)
|
||||||
|
- [`healthGetApiV1Health`](docs/sdks/health/README.md#getapiv1health)
|
||||||
|
- [`historyGetApiV1History`](docs/sdks/history/README.md#getapiv1history)
|
||||||
|
- [`historyGetApiV1HistoryIndexer`](docs/sdks/history/README.md#getapiv1historyindexer)
|
||||||
|
- [`historyGetApiV1HistorySince`](docs/sdks/history/README.md#getapiv1historysince)
|
||||||
|
- [`hostConfigGetApiV1ConfigHost`](docs/sdks/hostconfig/README.md#getapiv1confighost)
|
||||||
|
- [`hostConfigGetApiV1ConfigHostId`](docs/sdks/hostconfig/README.md#getapiv1confighostid)
|
||||||
|
- [`hostConfigPutApiV1ConfigHostId`](docs/sdks/hostconfig/README.md#putapiv1confighostid)
|
||||||
|
- [`indexerDefaultCategoriesGetApiV1IndexerCategories`](docs/sdks/indexerdefaultcategories/README.md#getapiv1indexercategories)
|
||||||
|
- [`indexerDeleteApiV1IndexerBulk`](docs/sdks/indexer/README.md#deleteapiv1indexerbulk)
|
||||||
|
- [`indexerDeleteApiV1IndexerId`](docs/sdks/indexer/README.md#deleteapiv1indexerid)
|
||||||
|
- [`indexerGetApiV1Indexer`](docs/sdks/indexer/README.md#getapiv1indexer)
|
||||||
|
- [`indexerGetApiV1IndexerId`](docs/sdks/indexer/README.md#getapiv1indexerid)
|
||||||
|
- [`indexerGetApiV1IndexerSchema`](docs/sdks/indexer/README.md#getapiv1indexerschema)
|
||||||
|
- [`indexerPostApiV1Indexer`](docs/sdks/indexer/README.md#postapiv1indexer)
|
||||||
|
- [`indexerPostApiV1IndexerActionName`](docs/sdks/indexer/README.md#postapiv1indexeractionname)
|
||||||
|
- [`indexerPostApiV1IndexerTest`](docs/sdks/indexer/README.md#postapiv1indexertest)
|
||||||
|
- [`indexerPostApiV1IndexerTestall`](docs/sdks/indexer/README.md#postapiv1indexertestall)
|
||||||
|
- [`indexerProxyDeleteApiV1IndexerproxyId`](docs/sdks/indexerproxy/README.md#deleteapiv1indexerproxyid)
|
||||||
|
- [`indexerProxyGetApiV1Indexerproxy`](docs/sdks/indexerproxy/README.md#getapiv1indexerproxy)
|
||||||
|
- [`indexerProxyGetApiV1IndexerproxyId`](docs/sdks/indexerproxy/README.md#getapiv1indexerproxyid)
|
||||||
|
- [`indexerProxyGetApiV1IndexerproxySchema`](docs/sdks/indexerproxy/README.md#getapiv1indexerproxyschema)
|
||||||
|
- [`indexerProxyPostApiV1Indexerproxy`](docs/sdks/indexerproxy/README.md#postapiv1indexerproxy)
|
||||||
|
- [`indexerProxyPostApiV1IndexerproxyActionName`](docs/sdks/indexerproxy/README.md#postapiv1indexerproxyactionname)
|
||||||
|
- [`indexerProxyPostApiV1IndexerproxyTest`](docs/sdks/indexerproxy/README.md#postapiv1indexerproxytest)
|
||||||
|
- [`indexerProxyPostApiV1IndexerproxyTestall`](docs/sdks/indexerproxy/README.md#postapiv1indexerproxytestall)
|
||||||
|
- [`indexerProxyPutApiV1IndexerproxyId`](docs/sdks/indexerproxy/README.md#putapiv1indexerproxyid)
|
||||||
|
- [`indexerPutApiV1IndexerBulk`](docs/sdks/indexer/README.md#putapiv1indexerbulk)
|
||||||
|
- [`indexerPutApiV1IndexerId`](docs/sdks/indexer/README.md#putapiv1indexerid)
|
||||||
|
- [`indexerStatsGetApiV1Indexerstats`](docs/sdks/indexerstats/README.md#getapiv1indexerstats)
|
||||||
|
- [`indexerStatusGetApiV1Indexerstatus`](docs/sdks/indexerstatus/README.md#getapiv1indexerstatus)
|
||||||
|
- [`localizationGetApiV1Localization`](docs/sdks/localization/README.md#getapiv1localization)
|
||||||
|
- [`localizationGetApiV1LocalizationOptions`](docs/sdks/localization/README.md#getapiv1localizationoptions)
|
||||||
|
- [`logFileGetApiV1LogFile`](docs/sdks/logfile/README.md#getapiv1logfile)
|
||||||
|
- [`logFileGetApiV1LogFileFilename`](docs/sdks/logfile/README.md#getapiv1logfilefilename)
|
||||||
|
- [`logGetApiV1Log`](docs/sdks/log/README.md#getapiv1log)
|
||||||
|
- [`newznabGetApiV1IndexerIdDownload`](docs/sdks/newznab/README.md#getapiv1indexeriddownload)
|
||||||
|
- [`newznabGetApiV1IndexerIdNewznab`](docs/sdks/newznab/README.md#getapiv1indexeridnewznab)
|
||||||
|
- [`newznabGetIdApi`](docs/sdks/newznab/README.md#getidapi)
|
||||||
|
- [`newznabGetIdDownload`](docs/sdks/newznab/README.md#getiddownload)
|
||||||
|
- [`notificationDeleteApiV1NotificationId`](docs/sdks/notification/README.md#deleteapiv1notificationid)
|
||||||
|
- [`notificationGetApiV1Notification`](docs/sdks/notification/README.md#getapiv1notification)
|
||||||
|
- [`notificationGetApiV1NotificationId`](docs/sdks/notification/README.md#getapiv1notificationid)
|
||||||
|
- [`notificationGetApiV1NotificationSchema`](docs/sdks/notification/README.md#getapiv1notificationschema)
|
||||||
|
- [`notificationPostApiV1Notification`](docs/sdks/notification/README.md#postapiv1notification)
|
||||||
|
- [`notificationPostApiV1NotificationActionName`](docs/sdks/notification/README.md#postapiv1notificationactionname)
|
||||||
|
- [`notificationPostApiV1NotificationTest`](docs/sdks/notification/README.md#postapiv1notificationtest)
|
||||||
|
- [`notificationPostApiV1NotificationTestall`](docs/sdks/notification/README.md#postapiv1notificationtestall)
|
||||||
|
- [`notificationPutApiV1NotificationId`](docs/sdks/notification/README.md#putapiv1notificationid)
|
||||||
|
- [`pingGetPing`](docs/sdks/ping/README.md#getping)
|
||||||
|
- [`pingHeadPing`](docs/sdks/ping/README.md#headping)
|
||||||
|
- [`searchGetApiV1Search`](docs/sdks/search/README.md#getapiv1search)
|
||||||
|
- [`searchPostApiV1Search`](docs/sdks/search/README.md#postapiv1search)
|
||||||
|
- [`searchPostApiV1SearchBulk`](docs/sdks/search/README.md#postapiv1searchbulk)
|
||||||
|
- [`staticResourceGet`](docs/sdks/staticresource/README.md#get)
|
||||||
|
- [`staticResourceGetContentPath`](docs/sdks/staticresource/README.md#getcontentpath)
|
||||||
|
- [`staticResourceGetLogin`](docs/sdks/staticresource/README.md#getlogin)
|
||||||
|
- [`staticResourceGetPath`](docs/sdks/staticresource/README.md#getpath)
|
||||||
|
- [`systemGetApiV1SystemRoutes`](docs/sdks/system/README.md#getapiv1systemroutes)
|
||||||
|
- [`systemGetApiV1SystemRoutesDuplicate`](docs/sdks/system/README.md#getapiv1systemroutesduplicate)
|
||||||
|
- [`systemGetApiV1SystemStatus`](docs/sdks/system/README.md#getapiv1systemstatus)
|
||||||
|
- [`systemPostApiV1SystemRestart`](docs/sdks/system/README.md#postapiv1systemrestart)
|
||||||
|
- [`systemPostApiV1SystemShutdown`](docs/sdks/system/README.md#postapiv1systemshutdown)
|
||||||
|
- [`tagDeleteApiV1TagId`](docs/sdks/tag/README.md#deleteapiv1tagid)
|
||||||
|
- [`tagDetailsGetApiV1TagDetail`](docs/sdks/tagdetails/README.md#getapiv1tagdetail)
|
||||||
|
- [`tagDetailsGetApiV1TagDetailId`](docs/sdks/tagdetails/README.md#getapiv1tagdetailid)
|
||||||
|
- [`tagGetApiV1Tag`](docs/sdks/tag/README.md#getapiv1tag)
|
||||||
|
- [`tagGetApiV1TagId`](docs/sdks/tag/README.md#getapiv1tagid)
|
||||||
|
- [`tagPostApiV1Tag`](docs/sdks/tag/README.md#postapiv1tag)
|
||||||
|
- [`tagPutApiV1TagId`](docs/sdks/tag/README.md#putapiv1tagid)
|
||||||
|
- [`taskGetApiV1SystemTask`](docs/sdks/task/README.md#getapiv1systemtask)
|
||||||
|
- [`taskGetApiV1SystemTaskId`](docs/sdks/task/README.md#getapiv1systemtaskid)
|
||||||
|
- [`uiConfigGetApiV1ConfigUi`](docs/sdks/uiconfig/README.md#getapiv1configui)
|
||||||
|
- [`uiConfigGetApiV1ConfigUiId`](docs/sdks/uiconfig/README.md#getapiv1configuiid)
|
||||||
|
- [`uiConfigPutApiV1ConfigUiId`](docs/sdks/uiconfig/README.md#putapiv1configuiid)
|
||||||
|
- [`updateGetApiV1Update`](docs/sdks/update/README.md#getapiv1update)
|
||||||
|
- [`updateLogFileGetApiV1LogFileUpdate`](docs/sdks/updatelogfile/README.md#getapiv1logfileupdate)
|
||||||
|
- [`updateLogFileGetApiV1LogFileUpdateFilename`](docs/sdks/updatelogfile/README.md#getapiv1logfileupdatefilename)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
<!-- End Standalone functions [standalone-funcs] -->
|
||||||
|
|
||||||
|
<!-- Start Retries [retries] -->
|
||||||
|
## Retries
|
||||||
|
|
||||||
|
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
||||||
|
|
||||||
|
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi({
|
||||||
|
retries: {
|
||||||
|
strategy: "backoff",
|
||||||
|
backoff: {
|
||||||
|
initialInterval: 1,
|
||||||
|
maxInterval: 50,
|
||||||
|
exponent: 1.1,
|
||||||
|
maxElapsedTime: 100,
|
||||||
|
},
|
||||||
|
retryConnectionErrors: false,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
retryConfig: {
|
||||||
|
strategy: "backoff",
|
||||||
|
backoff: {
|
||||||
|
initialInterval: 1,
|
||||||
|
maxInterval: 50,
|
||||||
|
exponent: 1.1,
|
||||||
|
maxElapsedTime: 100,
|
||||||
|
},
|
||||||
|
retryConnectionErrors: false,
|
||||||
|
},
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Retries [retries] -->
|
||||||
|
|
||||||
|
<!-- Start Error Handling [errors] -->
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
If the request fails due to, for example 4XX or 5XX status codes, it will throw a `APIError`.
|
||||||
|
|
||||||
|
| Error Type | Status Code | Content Type |
|
||||||
|
| --------------- | ----------- | ------------ |
|
||||||
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
import { SDKValidationError } from "prowlarr/models/errors";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
let result;
|
||||||
|
try {
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
| 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 |
|
||||||
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
|
<!-- Start Server Selection [server] -->
|
||||||
|
## Server Selection
|
||||||
|
|
||||||
|
### Server Variables
|
||||||
|
|
||||||
|
The default server `{protocol}://{hostpath}` contains variables and is set to `http://localhost:9696` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||||
|
|
||||||
|
| Variable | Parameter | Supported Values | Default | Description |
|
||||||
|
| ---------- | --------------------------------- | -------------------------- | ------------------ | ----------- |
|
||||||
|
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"http"` | |
|
||||||
|
| `hostpath` | `hostpath: string` | string | `"localhost:9696"` | |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
protocol: "https",
|
||||||
|
hostpath: "<value>",
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Override Server URL Per-Client
|
||||||
|
|
||||||
|
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const prowlarr = new Prowlarr({
|
||||||
|
serverURL: "http://localhost:9696",
|
||||||
|
security: {
|
||||||
|
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
async function run() {
|
||||||
|
const result = await prowlarr.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End Server Selection [server] -->
|
||||||
|
|
||||||
|
<!-- Start Custom HTTP Client [http-client] -->
|
||||||
|
## Custom HTTP Client
|
||||||
|
|
||||||
|
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
||||||
|
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
||||||
|
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
||||||
|
around the request lifecycle that can be used to modify the request or handle
|
||||||
|
errors and response.
|
||||||
|
|
||||||
|
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
||||||
|
used to integrate a third-party HTTP client or when writing tests to mock out
|
||||||
|
the HTTP client and feed in fixtures.
|
||||||
|
|
||||||
|
The following example shows how to use the `"beforeRequest"` hook to to add a
|
||||||
|
custom header and a timeout to requests and how to use the `"requestError"` hook
|
||||||
|
to log errors:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
import { HTTPClient } from "prowlarr/lib/http";
|
||||||
|
|
||||||
|
const httpClient = new HTTPClient({
|
||||||
|
// fetcher takes a function that has the same signature as native `fetch`.
|
||||||
|
fetcher: (request) => {
|
||||||
|
return fetch(request);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
httpClient.addHook("beforeRequest", (request) => {
|
||||||
|
const nextRequest = new Request(request, {
|
||||||
|
signal: request.signal || AbortSignal.timeout(5000)
|
||||||
|
});
|
||||||
|
|
||||||
|
nextRequest.headers.set("x-custom-header", "custom value");
|
||||||
|
|
||||||
|
return nextRequest;
|
||||||
|
});
|
||||||
|
|
||||||
|
httpClient.addHook("requestError", (error, request) => {
|
||||||
|
console.group("Request Error");
|
||||||
|
console.log("Reason:", `${error}`);
|
||||||
|
console.log("Endpoint:", `${request.method} ${request.url}`);
|
||||||
|
console.groupEnd();
|
||||||
|
});
|
||||||
|
|
||||||
|
const sdk = new Prowlarr({ httpClient });
|
||||||
|
```
|
||||||
|
<!-- End Custom HTTP Client [http-client] -->
|
||||||
|
|
||||||
|
<!-- Start Debugging [debug] -->
|
||||||
|
## Debugging
|
||||||
|
|
||||||
|
You can setup your SDK to emit debug logs for SDK requests and responses.
|
||||||
|
|
||||||
|
You can pass a logger that matches `console`'s interface as an SDK option.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Prowlarr } from "prowlarr";
|
||||||
|
|
||||||
|
const sdk = new Prowlarr({ debugLogger: console });
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also enable a default debug logger by setting an environment variable `PROWLARR_DEBUG` to true.
|
||||||
|
<!-- End Debugging [debug] -->
|
||||||
|
|
||||||
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||||
|
|||||||
48
RUNTIMES.md
Normal file
48
RUNTIMES.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# Supported JavaScript runtimes
|
||||||
|
|
||||||
|
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
||||||
|
|
||||||
|
* [Web Fetch API][web-fetch]
|
||||||
|
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||||
|
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||||
|
|
||||||
|
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||||
|
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||||
|
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||||
|
|
||||||
|
Runtime environments that are explicitly supported are:
|
||||||
|
|
||||||
|
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||||
|
- Node.js active and maintenance LTS releases
|
||||||
|
- Currently, this is v18 and v20
|
||||||
|
- Bun v1 and above
|
||||||
|
- Deno v1.39
|
||||||
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||||
|
|
||||||
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||||
|
|
||||||
|
## Recommended TypeScript compiler options
|
||||||
|
|
||||||
|
The following `tsconfig.json` options are recommended for projects using this
|
||||||
|
SDK in order to get static type support for features like async iterables,
|
||||||
|
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
||||||
|
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
||||||
|
so on):
|
||||||
|
|
||||||
|
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
||||||
|
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
||||||
|
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
||||||
|
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "es2020", // or higher
|
||||||
|
"lib": ["es2020", "dom", "dom.iterable"],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
While `target` can be set to older ECMAScript versions, it may result in extra,
|
||||||
|
unnecessary compatibility code being generated if you are not targeting old
|
||||||
|
runtimes.
|
||||||
21
USAGE.md
Normal file
21
USAGE.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!-- Start SDK Example Usage [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.apiInfo.getApi();
|
||||||
|
|
||||||
|
// Handle the result
|
||||||
|
console.log(result);
|
||||||
|
}
|
||||||
|
|
||||||
|
run();
|
||||||
|
|
||||||
|
```
|
||||||
|
<!-- End SDK Example Usage [usage] -->
|
||||||
24
docs/lib/utils/retryconfig.md
Normal file
24
docs/lib/utils/retryconfig.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# RetryConfig
|
||||||
|
|
||||||
|
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
||||||
|
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
||||||
|
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
||||||
|
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
||||||
|
|
||||||
|
## BackoffStrategy
|
||||||
|
|
||||||
|
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
||||||
|
|
||||||
|
### Fields
|
||||||
|
|
||||||
|
| Name | Type | Description | Example |
|
||||||
|
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
||||||
|
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
||||||
|
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
||||||
|
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
||||||
|
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
|
||||||
16
docs/models/apiinforesource.md
Normal file
16
docs/models/apiinforesource.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# ApiInfoResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApiInfoResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: ApiInfoResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `current` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `deprecated` | *string*[] | :heavy_minus_sign: | N/A |
|
||||||
18
docs/models/applicationbulkresource.md
Normal file
18
docs/models/applicationbulkresource.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# ApplicationBulkResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplicationBulkResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: ApplicationBulkResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `ids` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `applyTags` | [models.ApplyTags](../models/applytags.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `syncLevel` | [models.ApplicationSyncLevel](../models/applicationsynclevel.md) | :heavy_minus_sign: | N/A |
|
||||||
26
docs/models/applicationresource.md
Normal file
26
docs/models/applicationresource.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# ApplicationResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplicationResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: ApplicationResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.ApplicationResource](../models/applicationresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `syncLevel` | [models.ApplicationSyncLevel](../models/applicationsynclevel.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `testCommand` | *string* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/applicationsynclevel.md
Normal file
15
docs/models/applicationsynclevel.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# ApplicationSyncLevel
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplicationSyncLevel } from "prowlarr";
|
||||||
|
|
||||||
|
let value: ApplicationSyncLevel = "addOnly";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"disabled" | "addOnly" | "fullSync"
|
||||||
|
```
|
||||||
15
docs/models/applytags.md
Normal file
15
docs/models/applytags.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# ApplyTags
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ApplyTags } from "prowlarr";
|
||||||
|
|
||||||
|
let value: ApplyTags = "replace";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"add" | "remove" | "replace"
|
||||||
|
```
|
||||||
20
docs/models/appprofileresource.md
Normal file
20
docs/models/appprofileresource.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# AppProfileResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AppProfileResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: AppProfileResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enableRss` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enableAutomaticSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enableInteractiveSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `minimumSeeders` | *number* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/authenticationrequiredtype.md
Normal file
15
docs/models/authenticationrequiredtype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# AuthenticationRequiredType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AuthenticationRequiredType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: AuthenticationRequiredType = "enabled";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"enabled" | "disabledForLocalAddresses"
|
||||||
|
```
|
||||||
15
docs/models/authenticationtype.md
Normal file
15
docs/models/authenticationtype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# AuthenticationType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AuthenticationType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: AuthenticationType = "none";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"none" | "basic" | "forms" | "external"
|
||||||
|
```
|
||||||
20
docs/models/backupresource.md
Normal file
20
docs/models/backupresource.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# BackupResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { BackupResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: BackupResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `path` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | [models.BackupType](../models/backuptype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `time` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/backuptype.md
Normal file
15
docs/models/backuptype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# BackupType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { BackupType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: BackupType = "update";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"scheduled" | "manual" | "update"
|
||||||
|
```
|
||||||
15
docs/models/booksearchparam.md
Normal file
15
docs/models/booksearchparam.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# BookSearchParam
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { BookSearchParam } from "prowlarr";
|
||||||
|
|
||||||
|
let value: BookSearchParam = "q";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"q" | "title" | "author" | "publisher" | "genre" | "year"
|
||||||
|
```
|
||||||
15
docs/models/certificatevalidationtype.md
Normal file
15
docs/models/certificatevalidationtype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# CertificateValidationType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CertificateValidationType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CertificateValidationType = "enabled";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"enabled" | "disabledForLocalAddresses" | "disabled"
|
||||||
|
```
|
||||||
26
docs/models/command.md
Normal file
26
docs/models/command.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# Command
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Command } from "prowlarr";
|
||||||
|
|
||||||
|
let value: Command = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `sendUpdatesToClient` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateScheduledTask` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `completionMessage` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `requiresDiskAccess` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `isExclusive` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `isTypeExclusive` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastExecutionTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastStartTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `trigger` | [models.CommandTrigger](../models/commandtrigger.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `suppressMessages` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `clientUserAgent` | *string* | :heavy_minus_sign: | N/A |
|
||||||
20
docs/models/commandinput.md
Normal file
20
docs/models/commandinput.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# CommandInput
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandInput } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandInput = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `sendUpdatesToClient` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastExecutionTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastStartTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `trigger` | [models.CommandTrigger](../models/commandtrigger.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `suppressMessages` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `clientUserAgent` | *string* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/commandpriority.md
Normal file
15
docs/models/commandpriority.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# CommandPriority
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandPriority } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandPriority = "high";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"normal" | "high" | "low"
|
||||||
|
```
|
||||||
32
docs/models/commandresource.md
Normal file
32
docs/models/commandresource.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# CommandResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `commandName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `body` | [models.Command](../models/command.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | [models.CommandPriority](../models/commandpriority.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `status` | [models.CommandStatus](../models/commandstatus.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `queued` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `started` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `ended` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `duration` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `exception` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `trigger` | [models.CommandTrigger](../models/commandtrigger.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `clientUserAgent` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `stateChangeTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `sendUpdatesToClient` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateScheduledTask` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastExecutionTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
32
docs/models/commandresourceinput.md
Normal file
32
docs/models/commandresourceinput.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# CommandResourceInput
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandResourceInput } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandResourceInput = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `commandName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `body` | [models.CommandInput](../models/commandinput.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | [models.CommandPriority](../models/commandpriority.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `status` | [models.CommandStatus](../models/commandstatus.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `queued` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `started` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `ended` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `duration` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `exception` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `trigger` | [models.CommandTrigger](../models/commandtrigger.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `clientUserAgent` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `stateChangeTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `sendUpdatesToClient` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateScheduledTask` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastExecutionTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/commandstatus.md
Normal file
15
docs/models/commandstatus.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# CommandStatus
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandStatus } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandStatus = "orphaned";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"queued" | "started" | "completed" | "failed" | "aborted" | "cancelled" | "orphaned"
|
||||||
|
```
|
||||||
15
docs/models/commandtrigger.md
Normal file
15
docs/models/commandtrigger.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# CommandTrigger
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CommandTrigger } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CommandTrigger = "unspecified";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"unspecified" | "manual" | "scheduled"
|
||||||
|
```
|
||||||
18
docs/models/customfilterresource.md
Normal file
18
docs/models/customfilterresource.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# CustomFilterResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { CustomFilterResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: CustomFilterResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `label` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `filters` | Record<string, *any*>[] | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/databasetype.md
Normal file
15
docs/models/databasetype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# DatabaseType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DatabaseType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DatabaseType = "sqLite";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"sqLite" | "postgreSQL"
|
||||||
|
```
|
||||||
20
docs/models/developmentconfigresource.md
Normal file
20
docs/models/developmentconfigresource.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# DevelopmentConfigResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DevelopmentConfigResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DevelopmentConfigResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------- | -------------------- | -------------------- | -------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `consoleLogLevel` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logSql` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logIndexerResponse` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logRotate` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `filterSentryEvents` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/downloadclientbulkresource.md
Normal file
19
docs/models/downloadclientbulkresource.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# DownloadClientBulkResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DownloadClientBulkResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DownloadClientBulkResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||||
|
| `ids` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `applyTags` | [models.ApplyTags](../models/applytags.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `enable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
||||||
16
docs/models/downloadclientcategory.md
Normal file
16
docs/models/downloadclientcategory.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# DownloadClientCategory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DownloadClientCategory } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DownloadClientCategory = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `clientCategory` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `categories` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/downloadclientconfigresource.md
Normal file
15
docs/models/downloadclientconfigresource.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# DownloadClientConfigResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DownloadClientConfigResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DownloadClientConfigResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
29
docs/models/downloadclientresource.md
Normal file
29
docs/models/downloadclientresource.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# DownloadClientResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DownloadClientResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DownloadClientResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.DownloadClientResource](../models/downloadclientresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `enable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `protocol` | [models.DownloadProtocol](../models/downloadprotocol.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `categories` | [models.DownloadClientCategory](../models/downloadclientcategory.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsCategories` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/downloadprotocol.md
Normal file
15
docs/models/downloadprotocol.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# DownloadProtocol
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DownloadProtocol } from "prowlarr";
|
||||||
|
|
||||||
|
let value: DownloadProtocol = "torrent";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"unknown" | "usenet" | "torrent"
|
||||||
|
```
|
||||||
31
docs/models/field.md
Normal file
31
docs/models/field.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Field
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Field } from "prowlarr";
|
||||||
|
|
||||||
|
let value: Field = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `order` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `label` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `unit` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `helpText` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `helpTextWarning` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `helpLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `value` | *any* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `advanced` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `selectOptions` | [models.SelectOption](../models/selectoption.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `selectOptionsProviderAction` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `section` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `hidden` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `privacy` | [models.PrivacyLevel](../models/privacylevel.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `placeholder` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `isFloat` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/healthcheckresult.md
Normal file
15
docs/models/healthcheckresult.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# HealthCheckResult
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HealthCheckResult } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HealthCheckResult = "warning";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"ok" | "notice" | "warning" | "error"
|
||||||
|
```
|
||||||
19
docs/models/healthresource.md
Normal file
19
docs/models/healthresource.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# HealthResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HealthResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HealthResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `source` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `type` | [models.HealthCheckResult](../models/healthcheckresult.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `wikiUrl` | *string* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/historyeventtype.md
Normal file
15
docs/models/historyeventtype.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# HistoryEventType
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HistoryEventType } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HistoryEventType = "indexerRss";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"unknown" | "releaseGrabbed" | "indexerQuery" | "indexerRss" | "indexerAuth" | "indexerInfo"
|
||||||
|
```
|
||||||
21
docs/models/historyresource.md
Normal file
21
docs/models/historyresource.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# HistoryResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HistoryResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HistoryResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `date` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `downloadId` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `successful` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `eventType` | [models.HistoryEventType](../models/historyeventtype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `data` | Record<string, *string*> | :heavy_minus_sign: | N/A |
|
||||||
20
docs/models/historyresourcepagingresource.md
Normal file
20
docs/models/historyresourcepagingresource.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# HistoryResourcePagingResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HistoryResourcePagingResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HistoryResourcePagingResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `page` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `pageSize` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortKey` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortDirection` | [models.SortDirection](../models/sortdirection.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `totalRecords` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `records` | [models.HistoryResource](../models/historyresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
53
docs/models/hostconfigresource.md
Normal file
53
docs/models/hostconfigresource.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# HostConfigResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HostConfigResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HostConfigResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `bindAddress` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `port` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sslPort` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enableSsl` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `launchBrowser` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `authenticationMethod` | [models.AuthenticationType](../models/authenticationtype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `authenticationRequired` | [models.AuthenticationRequiredType](../models/authenticationrequiredtype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `analyticsEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `username` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `password` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `passwordConfirmation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logLevel` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logSizeLimit` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `consoleLogLevel` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `branch` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `apiKey` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sslCertPath` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sslCertPassword` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `urlBase` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `instanceName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `applicationUrl` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateAutomatically` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateMechanism` | [models.UpdateMechanism](../models/updatemechanism.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `updateScriptPath` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyEnabled` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyType` | [models.ProxyType](../models/proxytype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyHostname` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyPort` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyUsername` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyPassword` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyBypassFilter` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `proxyBypassLocalAddresses` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `certificateValidation` | [models.CertificateValidationType](../models/certificatevalidationtype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `backupFolder` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `backupInterval` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `backupRetention` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `historyCleanupDays` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `trustCgnatIpAddresses` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/hoststatistics.md
Normal file
17
docs/models/hoststatistics.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# HostStatistics
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { HostStatistics } from "prowlarr";
|
||||||
|
|
||||||
|
let value: HostStatistics = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `host` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfGrabs` | *number* | :heavy_minus_sign: | N/A |
|
||||||
25
docs/models/indexerbulkresource.md
Normal file
25
docs/models/indexerbulkresource.md
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
# IndexerBulkResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerBulkResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerBulkResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
|
||||||
|
| `ids` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `applyTags` | [models.ApplyTags](../models/applytags.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `enable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `appProfileId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `minimumSeeders` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `seedRatio` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `seedTime` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `packSeedTime` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `preferMagnetUrl` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
24
docs/models/indexercapabilityresource.md
Normal file
24
docs/models/indexercapabilityresource.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# IndexerCapabilityResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerCapabilityResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerCapabilityResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `limitsMax` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `limitsDefault` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `categories` | [models.IndexerCategory](../models/indexercategory.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRawSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `searchParams` | [models.SearchParam](../models/searchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `tvSearchParams` | [models.TvSearchParam](../models/tvsearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `movieSearchParams` | [models.MovieSearchParam](../models/moviesearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `musicSearchParams` | [models.MusicSearchParam](../models/musicsearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `bookSearchParams` | [models.BookSearchParam](../models/booksearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
24
docs/models/indexercapabilityresourceinput.md
Normal file
24
docs/models/indexercapabilityresourceinput.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# IndexerCapabilityResourceInput
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerCapabilityResourceInput } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerCapabilityResourceInput = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `limitsMax` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `limitsDefault` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `categories` | [models.IndexerCategoryInput](../models/indexercategoryinput.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRawSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `searchParams` | [models.SearchParam](../models/searchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `tvSearchParams` | [models.TvSearchParam](../models/tvsearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `movieSearchParams` | [models.MovieSearchParam](../models/moviesearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `musicSearchParams` | [models.MusicSearchParam](../models/musicsearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `bookSearchParams` | [models.BookSearchParam](../models/booksearchparam.md)[] | :heavy_minus_sign: | N/A |
|
||||||
18
docs/models/indexercategory.md
Normal file
18
docs/models/indexercategory.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# IndexerCategory
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerCategory } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerCategory = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `subCategories` | [models.IndexerCategory](../models/indexercategory.md)[] | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/indexercategoryinput.md
Normal file
17
docs/models/indexercategoryinput.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# IndexerCategoryInput
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerCategoryInput } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerCategoryInput = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/indexerprivacy.md
Normal file
15
docs/models/indexerprivacy.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# IndexerPrivacy
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerPrivacy } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerPrivacy = "public";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"public" | "semiPrivate" | "private"
|
||||||
|
```
|
||||||
29
docs/models/indexerproxyresource.md
Normal file
29
docs/models/indexerproxyresource.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# IndexerProxyResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerProxyResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerProxyResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.IndexerProxyResource](../models/indexerproxyresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `link` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `onHealthIssue` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsOnHealthIssue` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `includeHealthWarnings` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `testCommand` | *string* | :heavy_minus_sign: | N/A |
|
||||||
45
docs/models/indexerresource.md
Normal file
45
docs/models/indexerresource.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# IndexerResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.IndexerResource](../models/indexerresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerUrls` | *string*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `legacyUrls` | *string*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `definitionName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `language` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `encoding` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `redirect` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRss` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRedirect` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsPagination` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `appProfileId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `protocol` | [models.DownloadProtocol](../models/downloadprotocol.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `privacy` | [models.IndexerPrivacy](../models/indexerprivacy.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `capabilities` | [models.IndexerCapabilityResource](../models/indexercapabilityresource.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `downloadClientId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `added` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `status` | [models.IndexerStatusResource](../models/indexerstatusresource.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
45
docs/models/indexerresourceinput.md
Normal file
45
docs/models/indexerresourceinput.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# IndexerResourceInput
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerResourceInput } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerResourceInput = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.IndexerResourceInput](../models/indexerresourceinput.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerUrls` | *string*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `legacyUrls` | *string*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `definitionName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `language` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `encoding` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `enable` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `redirect` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRss` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsSearch` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsRedirect` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsPagination` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `appProfileId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `protocol` | [models.DownloadProtocol](../models/downloadprotocol.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `privacy` | [models.IndexerPrivacy](../models/indexerprivacy.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `capabilities` | [models.IndexerCapabilityResourceInput](../models/indexercapabilityresourceinput.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `priority` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `downloadClientId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `added` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `status` | [models.IndexerStatusResource](../models/indexerstatusresource.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
26
docs/models/indexerstatistics.md
Normal file
26
docs/models/indexerstatistics.md
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
# IndexerStatistics
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerStatistics } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerStatistics = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||||
|
| `indexerId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `averageResponseTime` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `averageGrabResponseTime` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfGrabs` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfRssQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfAuthQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfFailedQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfFailedGrabs` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfFailedRssQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `numberOfFailedAuthQueries` | *number* | :heavy_minus_sign: | N/A |
|
||||||
18
docs/models/indexerstatsresource.md
Normal file
18
docs/models/indexerstatsresource.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# IndexerStatsResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerStatsResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerStatsResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexers` | [models.IndexerStatistics](../models/indexerstatistics.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `userAgents` | [models.UserAgentStatistics](../models/useragentstatistics.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `hosts` | [models.HostStatistics](../models/hoststatistics.md)[] | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/indexerstatusresource.md
Normal file
19
docs/models/indexerstatusresource.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# IndexerStatusResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { IndexerStatusResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: IndexerStatusResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `disabledTill` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `mostRecentFailure` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `initialFailure` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
16
docs/models/localizationoption.md
Normal file
16
docs/models/localizationoption.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# LocalizationOption
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { LocalizationOption } from "prowlarr";
|
||||||
|
|
||||||
|
let value: LocalizationOption = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `value` | *string* | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/logfileresource.md
Normal file
19
docs/models/logfileresource.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# LogFileResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { LogFileResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: LogFileResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `filename` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `lastWriteTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `contentsUrl` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `downloadUrl` | *string* | :heavy_minus_sign: | N/A |
|
||||||
22
docs/models/logresource.md
Normal file
22
docs/models/logresource.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# LogResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { LogResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: LogResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `time` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `exception` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `exceptionType` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `level` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `logger` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `method` | *string* | :heavy_minus_sign: | N/A |
|
||||||
20
docs/models/logresourcepagingresource.md
Normal file
20
docs/models/logresourcepagingresource.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# LogResourcePagingResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { LogResourcePagingResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: LogResourcePagingResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| `page` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `pageSize` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortKey` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortDirection` | [models.SortDirection](../models/sortdirection.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `totalRecords` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `records` | [models.LogResource](../models/logresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/moviesearchparam.md
Normal file
15
docs/models/moviesearchparam.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# MovieSearchParam
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { MovieSearchParam } from "prowlarr";
|
||||||
|
|
||||||
|
let value: MovieSearchParam = "tmdbId";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"q" | "imdbId" | "tmdbId" | "imdbTitle" | "imdbYear" | "traktId" | "genre" | "doubanId" | "year"
|
||||||
|
```
|
||||||
15
docs/models/musicsearchparam.md
Normal file
15
docs/models/musicsearchparam.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# MusicSearchParam
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { MusicSearchParam } from "prowlarr";
|
||||||
|
|
||||||
|
let value: MusicSearchParam = "album";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
"q" | "album" | "artist" | "label" | "year" | "genre" | "track"
|
||||||
|
```
|
||||||
36
docs/models/notificationresource.md
Normal file
36
docs/models/notificationresource.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# NotificationResource
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { NotificationResource } from "prowlarr";
|
||||||
|
|
||||||
|
let value: NotificationResource = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||||
|
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `fields` | [models.Field](../models/field.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementationName` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `implementation` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configContract` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `infoLink` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `message` | [models.ProviderMessage](../models/providermessage.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `tags` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `presets` | [models.NotificationResource](../models/notificationresource.md)[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `link` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `onGrab` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `onHealthIssue` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `onHealthRestored` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `onApplicationUpdate` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsOnGrab` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `includeManualGrabs` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsOnHealthIssue` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsOnHealthRestored` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `includeHealthWarnings` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `supportsOnApplicationUpdate` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `testCommand` | *string* | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1applicationsidrequest.md
Normal file
17
docs/models/operations/deleteapiv1applicationsidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1ApplicationsIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1ApplicationsIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1ApplicationsIdRequest = {
|
||||||
|
id: 257282,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1appprofileidrequest.md
Normal file
17
docs/models/operations/deleteapiv1appprofileidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1AppprofileIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1AppprofileIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1AppprofileIdRequest = {
|
||||||
|
id: 754406,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1commandidrequest.md
Normal file
17
docs/models/operations/deleteapiv1commandidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1CommandIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1CommandIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1CommandIdRequest = {
|
||||||
|
id: 160068,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1customfilteridrequest.md
Normal file
17
docs/models/operations/deleteapiv1customfilteridrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1CustomfilterIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1CustomfilterIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1CustomfilterIdRequest = {
|
||||||
|
id: 273790,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1downloadclientidrequest.md
Normal file
17
docs/models/operations/deleteapiv1downloadclientidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1DownloadclientIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1DownloadclientIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1DownloadclientIdRequest = {
|
||||||
|
id: 356423,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1indexeridrequest.md
Normal file
17
docs/models/operations/deleteapiv1indexeridrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1IndexerIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1IndexerIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1IndexerIdRequest = {
|
||||||
|
id: 204134,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1indexerproxyidrequest.md
Normal file
17
docs/models/operations/deleteapiv1indexerproxyidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1IndexerproxyIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1IndexerproxyIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1IndexerproxyIdRequest = {
|
||||||
|
id: 447102,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1notificationidrequest.md
Normal file
17
docs/models/operations/deleteapiv1notificationidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1NotificationIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1NotificationIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1NotificationIdRequest = {
|
||||||
|
id: 415026,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1systembackupidrequest.md
Normal file
17
docs/models/operations/deleteapiv1systembackupidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1SystemBackupIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1SystemBackupIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1SystemBackupIdRequest = {
|
||||||
|
id: 463312,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/deleteapiv1tagidrequest.md
Normal file
17
docs/models/operations/deleteapiv1tagidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# DeleteApiV1TagIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeleteApiV1TagIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: DeleteApiV1TagIdRequest = {
|
||||||
|
id: 664637,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1applicationsidrequest.md
Normal file
17
docs/models/operations/getapiv1applicationsidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1ApplicationsIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1ApplicationsIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1ApplicationsIdRequest = {
|
||||||
|
id: 487837,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1appprofileidrequest.md
Normal file
17
docs/models/operations/getapiv1appprofileidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1AppprofileIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1AppprofileIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1AppprofileIdRequest = {
|
||||||
|
id: 46413,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1commandidrequest.md
Normal file
17
docs/models/operations/getapiv1commandidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1CommandIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1CommandIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1CommandIdRequest = {
|
||||||
|
id: 612496,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1configdevelopmentidrequest.md
Normal file
17
docs/models/operations/getapiv1configdevelopmentidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1ConfigDevelopmentIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1ConfigDevelopmentIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1ConfigDevelopmentIdRequest = {
|
||||||
|
id: 540985,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1ConfigDownloadclientIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1ConfigDownloadclientIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1ConfigDownloadclientIdRequest = {
|
||||||
|
id: 581042,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1confighostidrequest.md
Normal file
17
docs/models/operations/getapiv1confighostidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1ConfigHostIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1ConfigHostIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1ConfigHostIdRequest = {
|
||||||
|
id: 283372,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1configuiidrequest.md
Normal file
17
docs/models/operations/getapiv1configuiidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1ConfigUiIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1ConfigUiIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1ConfigUiIdRequest = {
|
||||||
|
id: 968816,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1customfilteridrequest.md
Normal file
17
docs/models/operations/getapiv1customfilteridrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1CustomfilterIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1CustomfilterIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1CustomfilterIdRequest = {
|
||||||
|
id: 40710,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1downloadclientidrequest.md
Normal file
17
docs/models/operations/getapiv1downloadclientidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1DownloadclientIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1DownloadclientIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1DownloadclientIdRequest = {
|
||||||
|
id: 969540,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1filesystemrequest.md
Normal file
17
docs/models/operations/getapiv1filesystemrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1FilesystemRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1FilesystemRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1FilesystemRequest = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `path` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `includeFiles` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `allowFoldersWithoutTrailingSlashes` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
15
docs/models/operations/getapiv1filesystemtyperequest.md
Normal file
15
docs/models/operations/getapiv1filesystemtyperequest.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# GetApiV1FilesystemTypeRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1FilesystemTypeRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1FilesystemTypeRequest = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `path` | *string* | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/operations/getapiv1historyindexerrequest.md
Normal file
17
docs/models/operations/getapiv1historyindexerrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1HistoryIndexerRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1HistoryIndexerRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1HistoryIndexerRequest = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
|
| `indexerId` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `eventType` | [models.HistoryEventType](../../models/historyeventtype.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
||||||
22
docs/models/operations/getapiv1historyrequest.md
Normal file
22
docs/models/operations/getapiv1historyrequest.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# GetApiV1HistoryRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1HistoryRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1HistoryRequest = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||||
|
| `page` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `pageSize` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortKey` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `sortDirection` | [models.SortDirection](../../models/sortdirection.md) | :heavy_minus_sign: | N/A |
|
||||||
|
| `eventType` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
|
| `successful` | *boolean* | :heavy_minus_sign: | N/A |
|
||||||
|
| `downloadId` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `indexerIds` | *number*[] | :heavy_minus_sign: | N/A |
|
||||||
16
docs/models/operations/getapiv1historysincerequest.md
Normal file
16
docs/models/operations/getapiv1historysincerequest.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# GetApiV1HistorySinceRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1HistorySinceRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1HistorySinceRequest = {};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
|
| `date` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A |
|
||||||
|
| `eventType` | [models.HistoryEventType](../../models/historyeventtype.md) | :heavy_minus_sign: | N/A |
|
||||||
19
docs/models/operations/getapiv1indexeriddownloadrequest.md
Normal file
19
docs/models/operations/getapiv1indexeriddownloadrequest.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# GetApiV1IndexerIdDownloadRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1IndexerIdDownloadRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1IndexerIdDownloadRequest = {
|
||||||
|
id: 634018,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
|
| `link` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `file` | *string* | :heavy_minus_sign: | N/A |
|
||||||
49
docs/models/operations/getapiv1indexeridnewznabrequest.md
Normal file
49
docs/models/operations/getapiv1indexeridnewznabrequest.md
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
# GetApiV1IndexerIdNewznabRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1IndexerIdNewznabRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1IndexerIdNewznabRequest = {
|
||||||
|
id: 657661,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
|
| `t` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `q` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `cat` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `imdbid` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `tmdbid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `extended` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `limit` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `offset` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `minage` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `maxage` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `minsize` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `maxsize` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `rid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `tvmazeid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `traktid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `tvdbid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `doubanid` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `season` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `ep` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `album` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `artist` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `label` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `track` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `year` | *number* | :heavy_minus_sign: | N/A |
|
||||||
|
| `genre` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `author` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `title` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `publisher` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `configured` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `source` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `host` | *string* | :heavy_minus_sign: | N/A |
|
||||||
|
| `server` | *string* | :heavy_minus_sign: | N/A |
|
||||||
17
docs/models/operations/getapiv1indexeridrequest.md
Normal file
17
docs/models/operations/getapiv1indexeridrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1IndexerIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1IndexerIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1IndexerIdRequest = {
|
||||||
|
id: 644176,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
17
docs/models/operations/getapiv1indexerproxyidrequest.md
Normal file
17
docs/models/operations/getapiv1indexerproxyidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetApiV1IndexerproxyIdRequest
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetApiV1IndexerproxyIdRequest } from "prowlarr/models/operations";
|
||||||
|
|
||||||
|
let value: GetApiV1IndexerproxyIdRequest = {
|
||||||
|
id: 939321,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description |
|
||||||
|
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A |
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user