LukeParke/Prowlarr-TS-SDK

Fork 0

mirror of https://github.com/LukeHagar/Prowlarr-TS-SDK.git synced 2025-12-06 04:21:03 +00:00

Files

Luke Hagar 5994271d04 initial generation

2025-05-16 17:01:58 -05:00

59 KiB

Raw Blame History

DownloadClient

(downloadClient)

Overview

Available Operations

getApiV1DownloadclientId
putApiV1DownloadclientId
deleteApiV1DownloadclientId
getApiV1Downloadclient
postApiV1Downloadclient
putApiV1DownloadclientBulk
deleteApiV1DownloadclientBulk
getApiV1DownloadclientSchema
postApiV1DownloadclientTest
postApiV1DownloadclientTestall
postApiV1DownloadclientActionName

getApiV1DownloadclientId

Example Usage

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,
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetApiV1DownloadclientIdRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

putApiV1DownloadclientId

Example Usage

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: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.PutApiV1DownloadclientIdRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

deleteApiV1DownloadclientId

Example Usage

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:

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) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteApiV1DownloadclientIdRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

getApiV1Downloadclient

Example Usage

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();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource[]>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

postApiV1Downloadclient

Example Usage

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({});

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.PostApiV1DownloadclientRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

putApiV1DownloadclientBulk

Example Usage

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();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	models.DownloadClientBulkResource	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

deleteApiV1DownloadclientBulk

Example Usage

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:

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) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	models.DownloadClientBulkResource	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

getApiV1DownloadclientSchema

Example Usage

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();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.DownloadClientResource[]>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

postApiV1DownloadclientTest

Example Usage

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:

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) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.PostApiV1DownloadclientTestRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

postApiV1DownloadclientTestall

Example Usage

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:

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) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

postApiV1DownloadclientActionName

Example Usage

import { Prowlarr } from "prowlarr";

const prowlarr = new Prowlarr({
  security: {
    xApiKey: process.env["PROWLARR_X_API_KEY"] ?? "",
  },
});

async function run() {
  await prowlarr.downloadClient.postApiV1DownloadclientActionName({
    name: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

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: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.PostApiV1DownloadclientActionNameRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	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	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	/

59 KiB Raw Blame History Unescape Escape

DownloadClient

Overview

Available Operations

getApiV1DownloadclientId

Example Usage

Standalone function

Parameters

Response

Errors

putApiV1DownloadclientId

Example Usage

Standalone function

Parameters

Response

Errors

deleteApiV1DownloadclientId

Example Usage

Standalone function

Parameters

Response

Errors

getApiV1Downloadclient

Example Usage

Standalone function

Parameters

Response

Errors

postApiV1Downloadclient

Example Usage

Standalone function

Parameters

Response

Errors

putApiV1DownloadclientBulk

Example Usage

Standalone function

Parameters

Response

Errors

deleteApiV1DownloadclientBulk

Example Usage

Standalone function

Parameters

Response

Errors

getApiV1DownloadclientSchema

Example Usage

Standalone function

Parameters

Response

Errors

postApiV1DownloadclientTest

Example Usage

Standalone function

Parameters

Response

Errors

postApiV1DownloadclientTestall

Example Usage

Standalone function

Parameters

Response

Errors

postApiV1DownloadclientActionName

Example Usage

Standalone function

Parameters

Response

Errors

59 KiB

Raw Blame History