Function QuickConnectApiFp

QuickConnectApi - functional programming interface

Export

  • QuickConnectApiFp(
        configuration?: Configuration,
    ): {
        authorizeQuickConnect(
            code: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
        >;
        getQuickConnectEnabled(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
        >;
        getQuickConnectState(
            secret: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<QuickConnectResult>,
        >;
        initiateQuickConnect(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<QuickConnectResult>,
        >;
    }

  • Parameters

    Returns {
        authorizeQuickConnect(
            code: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
        >;
        getQuickConnectEnabled(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
        >;
        getQuickConnectState(
            secret: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<QuickConnectResult>,
        >;
        initiateQuickConnect(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<QuickConnectResult>,
        >;
    }

    • authorizeQuickConnect:function
      • authorizeQuickConnect(
            code: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
        >

      • Parameters

        • code: string

          Quick connect code to authorize.

        • OptionaluserId: string

          The user the authorize. Access to the requested user is required.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getQuickConnectState:function
      • getQuickConnectState(
            secret: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<QuickConnectResult>,
        >

      • Parameters

        • secret: string

          Secret previously returned from the Initiate endpoint.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility