@jellyfin/sdk/lib/generated-client/api/dashboard-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 { ConfigurationPageInfo } from '../models';
/**
 * DashboardApi - axios parameter creator
 * @export
 */
export declare const DashboardApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets the configuration pages.
     * @param {boolean} [enableInMainMenu] Whether to enable in the main menu.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfigurationPages: (enableInMainMenu?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets a dashboard configuration page.
     * @param {string} [name] The name of the page.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDashboardConfigurationPage: (name?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DashboardApi - functional programming interface
 * @export
 */
export declare const DashboardApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Gets the configuration pages.
     * @param {boolean} [enableInMainMenu] Whether to enable in the main menu.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfigurationPages(enableInMainMenu?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationPageInfo>>>;
    /**
     *
     * @summary Gets a dashboard configuration page.
     * @param {string} [name] The name of the page.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDashboardConfigurationPage(name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
};
/**
 * DashboardApi - factory interface
 * @export
 */
export declare const DashboardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Gets the configuration pages.
     * @param {DashboardApiGetConfigurationPagesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getConfigurationPages(requestParameters?: DashboardApiGetConfigurationPagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationPageInfo>>;
    /**
     *
     * @summary Gets a dashboard configuration page.
     * @param {DashboardApiGetDashboardConfigurationPageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getDashboardConfigurationPage(requestParameters?: DashboardApiGetDashboardConfigurationPageRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
};
/**
 * Request parameters for getConfigurationPages operation in DashboardApi.
 * @export
 * @interface DashboardApiGetConfigurationPagesRequest
 */
export interface DashboardApiGetConfigurationPagesRequest {
    /**
     * Whether to enable in the main menu.
     * @type {boolean}
     * @memberof DashboardApiGetConfigurationPages
     */
    readonly enableInMainMenu?: boolean;
}
/**
 * Request parameters for getDashboardConfigurationPage operation in DashboardApi.
 * @export
 * @interface DashboardApiGetDashboardConfigurationPageRequest
 */
export interface DashboardApiGetDashboardConfigurationPageRequest {
    /**
     * The name of the page.
     * @type {string}
     * @memberof DashboardApiGetDashboardConfigurationPage
     */
    readonly name?: string;
}
/**
 * DashboardApi - object-oriented interface
 * @export
 * @class DashboardApi
 * @extends {BaseAPI}
 */
export declare class DashboardApi extends BaseAPI {
    /**
     *
     * @summary Gets the configuration pages.
     * @param {DashboardApiGetConfigurationPagesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DashboardApi
     */
    getConfigurationPages(requestParameters?: DashboardApiGetConfigurationPagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationPageInfo[], any>>;
    /**
     *
     * @summary Gets a dashboard configuration page.
     * @param {DashboardApiGetDashboardConfigurationPageRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DashboardApi
     */
    getDashboardConfigurationPage(requestParameters?: DashboardApiGetDashboardConfigurationPageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
}