@jellyfin/sdk/lib/generated-client/api/startup-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 { StartupConfigurationDto } from '../models';
import type { StartupRemoteAccessDto } from '../models';
import type { StartupUserDto } from '../models';
/**
 * StartupApi - axios parameter creator
 * @export
 */
export declare const StartupApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Completes the startup wizard.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeWizard: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser2: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the initial startup wizard configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStartupConfiguration: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Sets remote access and UPnP.
     * @param {StartupRemoteAccessDto} startupRemoteAccessDto The startup remote access dto.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Sets the initial startup wizard configuration.
     * @param {StartupConfigurationDto} startupConfigurationDto The updated startup configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Sets the user name and password.
     * @param {StartupUserDto} [startupUserDto] The DTO containing username and password.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateStartupUser: (startupUserDto?: StartupUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * StartupApi - functional programming interface
 * @export
 */
export declare const StartupApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Completes the startup wizard.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeWizard(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>;
    /**
     *
     * @summary Gets the initial startup wizard configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStartupConfiguration(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>>;
    /**
     *
     * @summary Sets remote access and UPnP.
     * @param {StartupRemoteAccessDto} startupRemoteAccessDto The startup remote access dto.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Sets the initial startup wizard configuration.
     * @param {StartupConfigurationDto} startupConfigurationDto The updated startup configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Sets the user name and password.
     * @param {StartupUserDto} [startupUserDto] The DTO containing username and password.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateStartupUser(startupUserDto?: StartupUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * StartupApi - factory interface
 * @export
 */
export declare const StartupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Completes the startup wizard.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    completeWizard(options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser(options?: RawAxiosRequestConfig): AxiosPromise<StartupUserDto>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFirstUser2(options?: RawAxiosRequestConfig): AxiosPromise<StartupUserDto>;
    /**
     *
     * @summary Gets the initial startup wizard configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStartupConfiguration(options?: RawAxiosRequestConfig): AxiosPromise<StartupConfigurationDto>;
    /**
     *
     * @summary Sets remote access and UPnP.
     * @param {StartupApiSetRemoteAccessRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    setRemoteAccess(requestParameters: StartupApiSetRemoteAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Sets the initial startup wizard configuration.
     * @param {StartupApiUpdateInitialConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateInitialConfiguration(requestParameters: StartupApiUpdateInitialConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     *
     * @summary Sets the user name and password.
     * @param {StartupApiUpdateStartupUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateStartupUser(requestParameters?: StartupApiUpdateStartupUserRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
 * Request parameters for setRemoteAccess operation in StartupApi.
 * @export
 * @interface StartupApiSetRemoteAccessRequest
 */
export interface StartupApiSetRemoteAccessRequest {
    /**
     * The startup remote access dto.
     * @type {StartupRemoteAccessDto}
     * @memberof StartupApiSetRemoteAccess
     */
    readonly startupRemoteAccessDto: StartupRemoteAccessDto;
}
/**
 * Request parameters for updateInitialConfiguration operation in StartupApi.
 * @export
 * @interface StartupApiUpdateInitialConfigurationRequest
 */
export interface StartupApiUpdateInitialConfigurationRequest {
    /**
     * The updated startup configuration.
     * @type {StartupConfigurationDto}
     * @memberof StartupApiUpdateInitialConfiguration
     */
    readonly startupConfigurationDto: StartupConfigurationDto;
}
/**
 * Request parameters for updateStartupUser operation in StartupApi.
 * @export
 * @interface StartupApiUpdateStartupUserRequest
 */
export interface StartupApiUpdateStartupUserRequest {
    /**
     * The DTO containing username and password.
     * @type {StartupUserDto}
     * @memberof StartupApiUpdateStartupUser
     */
    readonly startupUserDto?: StartupUserDto;
}
/**
 * StartupApi - object-oriented interface
 * @export
 * @class StartupApi
 * @extends {BaseAPI}
 */
export declare class StartupApi extends BaseAPI {
    /**
     *
     * @summary Completes the startup wizard.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    completeWizard(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    getFirstUser(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StartupUserDto, any>>;
    /**
     *
     * @summary Gets the first user.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    getFirstUser2(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StartupUserDto, any>>;
    /**
     *
     * @summary Gets the initial startup wizard configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    getStartupConfiguration(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StartupConfigurationDto, any>>;
    /**
     *
     * @summary Sets remote access and UPnP.
     * @param {StartupApiSetRemoteAccessRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    setRemoteAccess(requestParameters: StartupApiSetRemoteAccessRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Sets the initial startup wizard configuration.
     * @param {StartupApiUpdateInitialConfigurationRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    updateInitialConfiguration(requestParameters: StartupApiUpdateInitialConfigurationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Sets the user name and password.
     * @param {StartupApiUpdateStartupUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StartupApi
     */
    updateStartupUser(requestParameters?: StartupApiUpdateStartupUserRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}