Function SettingsApiFp

SettingsApi - functional programming interface

Export

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

  • Parameters

    • Optionalconfiguration: Configuration

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

    • settingsControllerDelete:function
      • settingsControllerDelete(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >

      • Required permissions: MANAGE_SETTINGS
        OperationId: SettingsControllerDelete

        Parameters

        • key: string
        • OptionalgameServerId: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>

        Throws

    • settingsControllerGet:function
    • settingsControllerGetOne:function
      • settingsControllerGetOne(
            key: string,
            gameServerId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SettingsOutputDTOAPI>,
        >


      • OperationId: SettingsControllerGetOne

        Parameters

        • key: string
        • OptionalgameServerId: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SettingsOutputDTOAPI>,
        >

        Throws

    • settingsControllerSet:function
      • settingsControllerSet(
            key: string,
            settingsSetDTO?: SettingsSetDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SettingsOutputDTOAPI>,
        >

      • Required permissions: MANAGE_SETTINGS
        OperationId: SettingsControllerSet

        Parameters

        • key: string
        • OptionalsettingsSetDTO: SettingsSetDTO

          SettingsSetDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<SettingsOutputDTOAPI>,
        >

        Throws

Settings

Member Visibility