Prowlarr-TS-SDK/docs/sdks/downloadclientconfig/README.md

DownloadClientConfig

(downloadClientConfig)

Overview

Available Operations

• getApiV1ConfigDownloadclientId
• putApiV1ConfigDownloadclientId
• getApiV1ConfigDownloadclient

getApiV1ConfigDownloadclientId

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.downloadClientConfig.getApiV1ConfigDownloadclientId({
    id: 300484,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { downloadClientConfigGetApiV1ConfigDownloadclientId } from "prowlarr/funcs/downloadClientConfigGetApiV1ConfigDownloadclientId.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 downloadClientConfigGetApiV1ConfigDownloadclientId(prowlarr, {
    id: 300484,
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("downloadClientConfigGetApiV1ConfigDownloadclientId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.GetApiV1ConfigDownloadclientIdRequest	✔️	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.DownloadClientConfigResource>

Errors

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

putApiV1ConfigDownloadclientId

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.downloadClientConfig.putApiV1ConfigDownloadclientId({
    id: "<id>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { downloadClientConfigPutApiV1ConfigDownloadclientId } from "prowlarr/funcs/downloadClientConfigPutApiV1ConfigDownloadclientId.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 downloadClientConfigPutApiV1ConfigDownloadclientId(prowlarr, {
    id: "<id>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("downloadClientConfigPutApiV1ConfigDownloadclientId failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.PutApiV1ConfigDownloadclientIdRequest	✔️	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.DownloadClientConfigResource>

Errors

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

getApiV1ConfigDownloadclient

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.downloadClientConfig.getApiV1ConfigDownloadclient();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ProwlarrCore } from "prowlarr/core.js";
import { downloadClientConfigGetApiV1ConfigDownloadclient } from "prowlarr/funcs/downloadClientConfigGetApiV1ConfigDownloadclient.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 downloadClientConfigGetApiV1ConfigDownloadclient(prowlarr);
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("downloadClientConfigGetApiV1ConfigDownloadclient failed:", res.error);
  }
}

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.DownloadClientConfigResource>

Errors

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