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

AppProfile

(appProfile)

Overview

Available Operations

• postApiV1Appprofile
• getApiV1Appprofile
• deleteApiV1AppprofileId
• putApiV1AppprofileId
• getApiV1AppprofileId
• getApiV1AppprofileSchema

postApiV1Appprofile

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.appProfile.postApiV1Appprofile();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

run();

Parameters

Parameter	Type	Required	Description
request	models.AppProfileResource	✔️	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.AppProfileResource>

Errors

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

getApiV1Appprofile

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.appProfile.getApiV1Appprofile();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

Errors

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

deleteApiV1AppprofileId

Example Usage

import { Prowlarr } from "prowlarr";

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

async function run() {
  await prowlarr.appProfile.deleteApiV1AppprofileId({
    id: 344853,
  });


}

run();

Standalone function

The standalone function version of this method:

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

run();

Parameters

Parameter	Type	Required	Description
request	operations.DeleteApiV1AppprofileIdRequest	✔️	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	*/*

putApiV1AppprofileId

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

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

run();

Parameters

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

Errors

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

getApiV1AppprofileId

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.appProfile.getApiV1AppprofileId({
    id: 92439,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

run();

Parameters

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

Errors

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

getApiV1AppprofileSchema

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.appProfile.getApiV1AppprofileSchema();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

Errors

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