Class ConnectionRequest

constructor

• new ConnectionRequest(connectionStatus, connectedAccountId, redirectUrl?, client): ConnectionRequest

• Connection request model.

  Parameters

  • connectionStatus: string

    The status of the connection.
  • connectedAccountId: string

    The unique identifier of the connected account.
  • Optional redirectUrl: null | string = null

    The redirect URL for completing the connection flow.
  • client: Composio

  Returns ConnectionRequest

connectedAccountId

connectionStatus

redirectUrl

saveUserAccessData

• saveUserAccessData(data): Promise<CreateConnectionResponse>

• Save user access data.

  Parameters

  • data: {
        entityId?: string;
        fieldInputs: Record<string, string>;
        redirectUrl?: string;
    }

    The data to save.

    • Optional entityId?: string

      The entity ID associated with the user.

    • fieldInputs: Record<string, string>

      The field inputs to save.

    • Optional redirectUrl?: string

      The redirect URL for completing the connection flow.

  Returns Promise<CreateConnectionResponse>

  The response from the server.

waitUntilActive

• waitUntilActive(timeout?): Promise<GetConnectedAccountResponse>

• Wait until the connection becomes active.

  Parameters

  • Optional timeout: number = 60

    The timeout period in seconds.

  Returns Promise<GetConnectedAccountResponse>

  The connected account model.

  Throws

  If the connection does not become active within the timeout period.