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

UpdateLogFile

(updateLogFile)

Overview

Available Operations

• getApiV1LogFileUpdate
• getApiV1LogFileUpdateFilename

getApiV1LogFileUpdate

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.updateLogFile.getApiV1LogFileUpdate();

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

Errors

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

getApiV1LogFileUpdateFilename

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.updateLogFile.getApiV1LogFileUpdateFilename({
    filename: "example.file",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

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

run();

Parameters

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

Errors

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