# DownloadClient (*downloadClient*) ## Overview ### Available Operations * [getApiV1DownloadclientId](#getapiv1downloadclientid) * [putApiV1DownloadclientId](#putapiv1downloadclientid) * [deleteApiV1DownloadclientId](#deleteapiv1downloadclientid) * [getApiV1Downloadclient](#getapiv1downloadclient) * [postApiV1Downloadclient](#postapiv1downloadclient) * [putApiV1DownloadclientBulk](#putapiv1downloadclientbulk) * [deleteApiV1DownloadclientBulk](#deleteapiv1downloadclientbulk) * [getApiV1DownloadclientSchema](#getapiv1downloadclientschema) * [postApiV1DownloadclientTest](#postapiv1downloadclienttest) * [postApiV1DownloadclientTestall](#postapiv1downloadclienttestall) * [postApiV1DownloadclientActionName](#postapiv1downloadclientactionname) ## getApiV1DownloadclientId ### 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.downloadClient.getApiV1DownloadclientId({ id: 335668, }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientGetApiV1DownloadclientId } from "prowlarr/funcs/downloadClientGetApiV1DownloadclientId.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 downloadClientGetApiV1DownloadclientId(prowlarr, { id: 335668, }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientGetApiV1DownloadclientId failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiV1DownloadclientIdRequest](../../models/operations/getapiv1downloadclientidrequest.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.DownloadClientResource](../../models/downloadclientresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## putApiV1DownloadclientId ### 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.downloadClient.putApiV1DownloadclientId({ id: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPutApiV1DownloadclientId } from "prowlarr/funcs/downloadClientPutApiV1DownloadclientId.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 downloadClientPutApiV1DownloadclientId(prowlarr, { id: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientPutApiV1DownloadclientId failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutApiV1DownloadclientIdRequest](../../models/operations/putapiv1downloadclientidrequest.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.DownloadClientResource](../../models/downloadclientresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## deleteApiV1DownloadclientId ### Example Usage ```typescript import { Prowlarr } from "prowlarr"; const prowlarr = new Prowlarr({ security: { xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "", }, }); async function run() { await prowlarr.downloadClient.deleteApiV1DownloadclientId({ id: 670627, }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientDeleteApiV1DownloadclientId } from "prowlarr/funcs/downloadClientDeleteApiV1DownloadclientId.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 downloadClientDeleteApiV1DownloadclientId(prowlarr, { id: 670627, }); if (res.ok) { const { value: result } = res; } else { console.log("downloadClientDeleteApiV1DownloadclientId failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.DeleteApiV1DownloadclientIdRequest](../../models/operations/deleteapiv1downloadclientidrequest.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\** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## getApiV1Downloadclient ### 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.downloadClient.getApiV1Downloadclient(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientGetApiV1Downloadclient } from "prowlarr/funcs/downloadClientGetApiV1Downloadclient.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 downloadClientGetApiV1Downloadclient(prowlarr); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientGetApiV1Downloadclient failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.DownloadClientResource[]](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## postApiV1Downloadclient ### 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.downloadClient.postApiV1Downloadclient({}); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPostApiV1Downloadclient } from "prowlarr/funcs/downloadClientPostApiV1Downloadclient.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 downloadClientPostApiV1Downloadclient(prowlarr, {}); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientPostApiV1Downloadclient failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostApiV1DownloadclientRequest](../../models/operations/postapiv1downloadclientrequest.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.DownloadClientResource](../../models/downloadclientresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## putApiV1DownloadclientBulk ### 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.downloadClient.putApiV1DownloadclientBulk(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPutApiV1DownloadclientBulk } from "prowlarr/funcs/downloadClientPutApiV1DownloadclientBulk.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 downloadClientPutApiV1DownloadclientBulk(prowlarr); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientPutApiV1DownloadclientBulk failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.DownloadClientBulkResource](../../models/downloadclientbulkresource.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.DownloadClientResource](../../models/downloadclientresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## deleteApiV1DownloadclientBulk ### Example Usage ```typescript import { Prowlarr } from "prowlarr"; const prowlarr = new Prowlarr({ security: { xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "", }, }); async function run() { await prowlarr.downloadClient.deleteApiV1DownloadclientBulk(); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientDeleteApiV1DownloadclientBulk } from "prowlarr/funcs/downloadClientDeleteApiV1DownloadclientBulk.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 downloadClientDeleteApiV1DownloadclientBulk(prowlarr); if (res.ok) { const { value: result } = res; } else { console.log("downloadClientDeleteApiV1DownloadclientBulk failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.DownloadClientBulkResource](../../models/downloadclientbulkresource.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\** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## getApiV1DownloadclientSchema ### 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.downloadClient.getApiV1DownloadclientSchema(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientGetApiV1DownloadclientSchema } from "prowlarr/funcs/downloadClientGetApiV1DownloadclientSchema.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 downloadClientGetApiV1DownloadclientSchema(prowlarr); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("downloadClientGetApiV1DownloadclientSchema failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.DownloadClientResource[]](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## postApiV1DownloadclientTest ### Example Usage ```typescript import { Prowlarr } from "prowlarr"; const prowlarr = new Prowlarr({ security: { xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "", }, }); async function run() { await prowlarr.downloadClient.postApiV1DownloadclientTest({}); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPostApiV1DownloadclientTest } from "prowlarr/funcs/downloadClientPostApiV1DownloadclientTest.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 downloadClientPostApiV1DownloadclientTest(prowlarr, {}); if (res.ok) { const { value: result } = res; } else { console.log("downloadClientPostApiV1DownloadclientTest failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostApiV1DownloadclientTestRequest](../../models/operations/postapiv1downloadclienttestrequest.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\** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## postApiV1DownloadclientTestall ### Example Usage ```typescript import { Prowlarr } from "prowlarr"; const prowlarr = new Prowlarr({ security: { xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "", }, }); async function run() { await prowlarr.downloadClient.postApiV1DownloadclientTestall(); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPostApiV1DownloadclientTestall } from "prowlarr/funcs/downloadClientPostApiV1DownloadclientTestall.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 downloadClientPostApiV1DownloadclientTestall(prowlarr); if (res.ok) { const { value: result } = res; } else { console.log("downloadClientPostApiV1DownloadclientTestall failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## postApiV1DownloadclientActionName ### Example Usage ```typescript import { Prowlarr } from "prowlarr"; const prowlarr = new Prowlarr({ security: { xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "", }, }); async function run() { await prowlarr.downloadClient.postApiV1DownloadclientActionName({ name: "", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ProwlarrCore } from "prowlarr/core.js"; import { downloadClientPostApiV1DownloadclientActionName } from "prowlarr/funcs/downloadClientPostApiV1DownloadclientActionName.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 downloadClientPostApiV1DownloadclientActionName(prowlarr, { name: "", }); if (res.ok) { const { value: result } = res; } else { console.log("downloadClientPostApiV1DownloadclientActionName failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PostApiV1DownloadclientActionNameRequest](../../models/operations/postapiv1downloadclientactionnamerequest.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\** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* |