mirror of
https://github.com/LukeHagar/Prowlarr-TS-SDK.git
synced 2025-12-06 04:21:03 +00:00
initial generation
This commit is contained in:
Luke Hagar
312
docs/sdks/command/README.md
Normal file
312
docs/sdks/command/README.md
Normal file
@@ -0,0 +1,312 @@
|
||||
# Command
|
||||
(*command*)
|
||||
|
||||
## Overview
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [getApiV1CommandId](#getapiv1commandid)
|
||||
* [deleteApiV1CommandId](#deleteapiv1commandid)
|
||||
* [postApiV1Command](#postapiv1command)
|
||||
* [getApiV1Command](#getapiv1command)
|
||||
|
||||
## getApiV1CommandId
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { Prowlarr } from "prowlarr";
|
||||
|
||||
const prowlarr = new Prowlarr({
|
||||
security: {
|
||||
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||
},
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await prowlarr.command.getApiV1CommandId({
|
||||
id: 274829,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { ProwlarrCore } from "prowlarr/core.js";
|
||||
import { commandGetApiV1CommandId } from "prowlarr/funcs/commandGetApiV1CommandId.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 commandGetApiV1CommandId(prowlarr, {
|
||||
id: 274829,
|
||||
});
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
}
|
||||
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.GetApiV1CommandIdRequest](../../models/operations/getapiv1commandidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.CommandResource](../../models/commandresource.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## deleteApiV1CommandId
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { Prowlarr } from "prowlarr";
|
||||
|
||||
const prowlarr = new Prowlarr({
|
||||
security: {
|
||||
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||
},
|
||||
});
|
||||
|
||||
async function run() {
|
||||
await prowlarr.command.deleteApiV1CommandId({
|
||||
id: 932632,
|
||||
});
|
||||
|
||||
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { ProwlarrCore } from "prowlarr/core.js";
|
||||
import { commandDeleteApiV1CommandId } from "prowlarr/funcs/commandDeleteApiV1CommandId.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 commandDeleteApiV1CommandId(prowlarr, {
|
||||
id: 932632,
|
||||
});
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
}
|
||||
|
||||
const { value: result } = res;
|
||||
|
||||
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [operations.DeleteApiV1CommandIdRequest](../../models/operations/deleteapiv1commandidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<void\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## postApiV1Command
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { Prowlarr } from "prowlarr";
|
||||
|
||||
const prowlarr = new Prowlarr({
|
||||
security: {
|
||||
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||
},
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await prowlarr.command.postApiV1Command();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { ProwlarrCore } from "prowlarr/core.js";
|
||||
import { commandPostApiV1Command } from "prowlarr/funcs/commandPostApiV1Command.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 commandPostApiV1Command(prowlarr);
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
}
|
||||
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `request` | [models.CommandResourceInput](../../models/commandresourceinput.md) | :heavy_check_mark: | The request object to use for the request. |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.CommandResource](../../models/commandresource.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||
|
||||
## getApiV1Command
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { Prowlarr } from "prowlarr";
|
||||
|
||||
const prowlarr = new Prowlarr({
|
||||
security: {
|
||||
xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
|
||||
},
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await prowlarr.command.getApiV1Command();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Standalone function
|
||||
|
||||
The standalone function version of this method:
|
||||
|
||||
```typescript
|
||||
import { ProwlarrCore } from "prowlarr/core.js";
|
||||
import { commandGetApiV1Command } from "prowlarr/funcs/commandGetApiV1Command.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 commandGetApiV1Command(prowlarr);
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
}
|
||||
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
||||
|
||||
### Response
|
||||
|
||||
**Promise\<[models.CommandResource[]](../../models/.md)\>**
|
||||
|
||||
### Errors
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||
Reference in New Issue
Block a user