Function QuickConnectApiAxiosParamCreator

QuickConnectApi - axios parameter creator

Export

  • QuickConnectApiAxiosParamCreator(configuration?): {
        authorizeQuickConnect: ((code: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getQuickConnectEnabled: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getQuickConnectState: ((secret: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        initiateQuickConnect: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        authorizeQuickConnect: ((code: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getQuickConnectEnabled: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getQuickConnectState: ((secret: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        initiateQuickConnect: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • authorizeQuickConnect: ((code: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Authorizes a pending quick connect request.

      Throws

        • (code, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

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

      Summary

      Gets the current quick connect state.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getQuickConnectState: ((secret: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Attempts to retrieve authentication information.

      Throws

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

        • Parameters

          • secret: string

            Secret previously returned from the Initiate endpoint.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Summary

      Initiate a new quick connect request.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility