# AppProfile (*appProfile*) ## Overview ### Available Operations * [postApiV1Appprofile](#postapiv1appprofile) * [getApiV1Appprofile](#getapiv1appprofile) * [deleteApiV1AppprofileId](#deleteapiv1appprofileid) * [putApiV1AppprofileId](#putapiv1appprofileid) * [getApiV1AppprofileId](#getapiv1appprofileid) * [getApiV1AppprofileSchema](#getapiv1appprofileschema) ## postApiV1Appprofile ### 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.appProfile.postApiV1Appprofile(); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript 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) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [models.AppProfileResource](../../models/appprofileresource.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.AppProfileResource](../../models/appprofileresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## getApiV1Appprofile ### 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.appProfile.getApiV1Appprofile(); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript 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) { 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.AppProfileResource[]](../../models/.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## deleteApiV1AppprofileId ### Example Usage ```typescript 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: ```typescript 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) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.DeleteApiV1AppprofileIdRequest](../../models/operations/deleteapiv1appprofileidrequest.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 | \*/\* | ## putApiV1AppprofileId ### 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.appProfile.putApiV1AppprofileId({ id: "", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript 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: "", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.PutApiV1AppprofileIdRequest](../../models/operations/putapiv1appprofileidrequest.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.AppProfileResource](../../models/appprofileresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## getApiV1AppprofileId ### 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.appProfile.getApiV1AppprofileId({ id: 92439, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript 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) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.GetApiV1AppprofileIdRequest](../../models/operations/getapiv1appprofileidrequest.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.AppProfileResource](../../models/appprofileresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* | ## getApiV1AppprofileSchema ### 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.appProfile.getApiV1AppprofileSchema(); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript 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) { 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.AppProfileResource](../../models/appprofileresource.md)\>** ### Errors | Error Type | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.APIError | 4XX, 5XX | \*/\* |