Function ConfigurationApiFp

ConfigurationApi - functional programming interface

Export

  • ConfigurationApiFp(
        configuration?: Configuration,
    ): {
        getConfiguration(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ServerConfiguration>,
        >;
        getDefaultMetadataOptions(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<MetadataOptions>,
        >;
        getNamedConfiguration(
            key: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
        updateConfiguration(
            serverConfiguration: ServerConfiguration,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateNamedConfiguration(
            key: string,
            body: any,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
    }

  • Parameters

    Returns {
        getConfiguration(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ServerConfiguration>,
        >;
        getDefaultMetadataOptions(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<MetadataOptions>,
        >;
        getNamedConfiguration(
            key: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
        updateConfiguration(
            serverConfiguration: ServerConfiguration,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updateNamedConfiguration(
            key: string,
            body: any,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
    }

    • getConfiguration:function
      • getConfiguration(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<ServerConfiguration>,
        >

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getDefaultMetadataOptions:function
      • getDefaultMetadataOptions(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<MetadataOptions>,
        >

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getNamedConfiguration:function
      • getNamedConfiguration(
            key: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

      • Parameters

        • key: string

          Configuration key.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updateConfiguration:function
      • updateConfiguration(
            serverConfiguration: ServerConfiguration,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • serverConfiguration: ServerConfiguration

          Configuration.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updateNamedConfiguration:function
      • updateNamedConfiguration(
            key: string,
            body: any,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • key: string

          Configuration key.

        • body: any

          Configuration.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility