Function SettingsApiFactory

SettingsApi - factory interface

Export

  • SettingsApiFactory(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): {
        settingsControllerDelete(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<APIOutput>;
        settingsControllerGet(
            keys?: SettingsControllerGetKeysEnum[],
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputArrayDTOAPI>;
        settingsControllerGetOne(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputDTOAPI>;
        settingsControllerSet(
            key: string,
            settingsSetDTO?: SettingsSetDTO,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputDTOAPI>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        settingsControllerDelete(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<APIOutput>;
        settingsControllerGet(
            keys?: SettingsControllerGetKeysEnum[],
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputArrayDTOAPI>;
        settingsControllerGetOne(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputDTOAPI>;
        settingsControllerSet(
            key: string,
            settingsSetDTO?: SettingsSetDTO,
            options?: RawAxiosRequestConfig,
        ): AxiosPromise<SettingsOutputDTOAPI>;
    }

Settings

Member Visibility