Documentation
API Reference
Types
Registration

Registration

RegisterExchangeInstanceReturn

{
  exchangeInstanceId: string;
  oauth?: {
    accessToken: string;
    refreshToken: string;
    expiresAt: number;
  };
}
  • exchangeInstanceId - string
    The unique identifier of the exchange instance.
  • oauth.accessToken - string
    The OAuth access token.
  • oauth.refreshToken - string
    The OAuth refresh token.
  • oauth.expiresAt - number
    The expiration time of the OAuth token.

OAuth2Tokens

interface OAuth2Tokens {
  accessToken: string;
  refreshToken: string;
  expiresAt: number;
  refreshedAt?: number;
  deviceId?: string;
}
  • accessToken - string
    The OAuth access token.
  • refreshToken - string
    The OAuth refresh token.
  • expiresAt - number
    The expiration time of the OAuth token.
  • refreshedAt - number, optional
    The time when the token was refreshed.
  • deviceId - string, optional
    The device ID for OAuth authentication, if required.