Function ConfigurationApiAxiosParamCreator

ConfigurationApi - axios parameter creator

Export

  • ConfigurationApiAxiosParamCreator(configuration?): {
        getConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDefaultMetadataOptions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getNamedConfiguration: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateConfiguration: ((serverConfiguration: ServerConfiguration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateNamedConfiguration: ((key: string, body: any, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDefaultMetadataOptions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getNamedConfiguration: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateConfiguration: ((serverConfiguration: ServerConfiguration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateNamedConfiguration: ((key: string, body: any, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getConfiguration: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets application configuration.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDefaultMetadataOptions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a default MetadataOptions object.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getNamedConfiguration: ((key: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a named configuration.

      Throws

        • (key, options?): Promise<RequestArgs>

        • Parameters

          • key: string

            Configuration key.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateConfiguration: ((serverConfiguration: ServerConfiguration, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Updates application configuration.

      Throws

        • (serverConfiguration, options?): Promise<RequestArgs>

        • Parameters

          • serverConfiguration: ServerConfiguration

            Configuration.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateNamedConfiguration: ((key: string, body: any, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Updates named configuration.

      Throws

        • (key, body, options?): Promise<RequestArgs>

        • Parameters

          • key: string

            Configuration key.

          • body: any

            Configuration.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility