@jellyfin/sdk/lib/generated-client/api/environment-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 *
 * Jellyfin API
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { DefaultDirectoryBrowserInfoDto } from '../models';
import type { FileSystemEntryInfo } from '../models';
import type { ValidatePathDto } from '../models';
/**
 * EnvironmentApi - axios parameter creator
 * @export
 */
export declare const EnvironmentApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get Default directory browser.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultDirectoryBrowser: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the contents of a given directory in the file system.
     * @param {string} path The path.
     * @param {boolean} [includeFiles] An optional filter to include or exclude files from the results. true/false.
     * @param {boolean} [includeDirectories] An optional filter to include or exclude folders from the results. true/false.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets available drives from the server\'s file system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDrives: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets network paths.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    getNetworkShares: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the parent path of a given path.
     * @param {string} path The path.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getParentPath: (path: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Validates path.
     * @param {ValidatePathDto} validatePathDto Validate request object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    validatePath: (validatePathDto: ValidatePathDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * EnvironmentApi - functional programming interface
 * @export
 */
export declare const EnvironmentApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get Default directory browser.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultDirectoryBrowser(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DefaultDirectoryBrowserInfoDto>>;
    /**
     *
     * @summary Gets the contents of a given directory in the file system.
     * @param {string} path The path.
     * @param {boolean} [includeFiles] An optional filter to include or exclude files from the results. true/false.
     * @param {boolean} [includeDirectories] An optional filter to include or exclude folders from the results. true/false.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FileSystemEntryInfo>>>;
    /**
     *
     * @summary Gets available drives from the server\'s file system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDrives(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FileSystemEntryInfo>>>;
    /**
     *
     * @summary Gets network paths.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    getNetworkShares(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<FileSystemEntryInfo>>>;
    /**
     *
     * @summary Gets the parent path of a given path.
     * @param {string} path The path.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getParentPath(path: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @summary Validates path.
     * @param {ValidatePathDto} validatePathDto Validate request object.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    validatePath(validatePathDto: ValidatePathDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * EnvironmentApi - factory interface
 * @export
 */
export declare const EnvironmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get Default directory browser.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDefaultDirectoryBrowser(options?: RawAxiosRequestConfig): AxiosPromise<DefaultDirectoryBrowserInfoDto>;
    /**
     *
     * @summary Gets the contents of a given directory in the file system.
     * @param {EnvironmentApiGetDirectoryContentsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDirectoryContents(requestParameters: EnvironmentApiGetDirectoryContentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<FileSystemEntryInfo>>;
    /**
     *
     * @summary Gets available drives from the server\'s file system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDrives(options?: RawAxiosRequestConfig): AxiosPromise<Array<FileSystemEntryInfo>>;
    /**
     *
     * @summary Gets network paths.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     */
    getNetworkShares(options?: RawAxiosRequestConfig): AxiosPromise<Array<FileSystemEntryInfo>>;
    /**
     *
     * @summary Gets the parent path of a given path.
     * @param {EnvironmentApiGetParentPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getParentPath(requestParameters: EnvironmentApiGetParentPathRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
    /**
     *
     * @summary Validates path.
     * @param {EnvironmentApiValidatePathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    validatePath(requestParameters: EnvironmentApiValidatePathRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for getDirectoryContents operation in EnvironmentApi.
 * @export
 * @interface EnvironmentApiGetDirectoryContentsRequest
 */
export interface EnvironmentApiGetDirectoryContentsRequest {
    /**
     * The path.
     * @type {string}
     * @memberof EnvironmentApiGetDirectoryContents
     */
    readonly path: string;
    /**
     * An optional filter to include or exclude files from the results. true/false.
     * @type {boolean}
     * @memberof EnvironmentApiGetDirectoryContents
     */
    readonly includeFiles?: boolean;
    /**
     * An optional filter to include or exclude folders from the results. true/false.
     * @type {boolean}
     * @memberof EnvironmentApiGetDirectoryContents
     */
    readonly includeDirectories?: boolean;
}
/**
 * Request parameters for getParentPath operation in EnvironmentApi.
 * @export
 * @interface EnvironmentApiGetParentPathRequest
 */
export interface EnvironmentApiGetParentPathRequest {
    /**
     * The path.
     * @type {string}
     * @memberof EnvironmentApiGetParentPath
     */
    readonly path: string;
}
/**
 * Request parameters for validatePath operation in EnvironmentApi.
 * @export
 * @interface EnvironmentApiValidatePathRequest
 */
export interface EnvironmentApiValidatePathRequest {
    /**
     * Validate request object.
     * @type {ValidatePathDto}
     * @memberof EnvironmentApiValidatePath
     */
    readonly validatePathDto: ValidatePathDto;
}
/**
 * EnvironmentApi - object-oriented interface
 * @export
 * @class EnvironmentApi
 * @extends {BaseAPI}
 */
export declare class EnvironmentApi extends BaseAPI {
    /**
     *
     * @summary Get Default directory browser.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    getDefaultDirectoryBrowser(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DefaultDirectoryBrowserInfoDto, any>>;
    /**
     *
     * @summary Gets the contents of a given directory in the file system.
     * @param {EnvironmentApiGetDirectoryContentsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    getDirectoryContents(requestParameters: EnvironmentApiGetDirectoryContentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileSystemEntryInfo[], any>>;
    /**
     *
     * @summary Gets available drives from the server\'s file system.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    getDrives(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileSystemEntryInfo[], any>>;
    /**
     *
     * @summary Gets network paths.
     * @param {*} [options] Override http request option.
     * @deprecated
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    getNetworkShares(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileSystemEntryInfo[], any>>;
    /**
     *
     * @summary Gets the parent path of a given path.
     * @param {EnvironmentApiGetParentPathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    getParentPath(requestParameters: EnvironmentApiGetParentPathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Validates path.
     * @param {EnvironmentApiValidatePathRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof EnvironmentApi
     */
    validatePath(requestParameters: EnvironmentApiValidatePathRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}