Function DiagnosticsApiAxiosParamCreator

DiagnosticsApi - axios parameter creator export

  • DiagnosticsApiAxiosParamCreator(configuration?): {
        apiDiagnosticsAccountsTestGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsPingGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsSignalRExample1Get: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsSignalRExample2Get: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getCurrentEnvironment: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        parseEnvironment: ((environment: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiDiagnosticsAccountsTestGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsPingGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsSignalRExample1Get: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiDiagnosticsSignalRExample2Get: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getCurrentEnvironment: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        parseEnvironment: ((environment: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

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

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      The API ping is the simplest way to test availbility and authentcation of the Mozaic API summary Simple ping test call

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      summary Returns the current environment of the API's service host

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • parseEnvironment: ((environment: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Returns the an AspnetCoreEnvironment Enum based on the environment string provided

      Throws

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

        • Parameters

          • environment: string

            dev, development, stage, staging, prod, production, sandbox, demo

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility