Hierarchy

  • Miro

Constructors

  • Initializes the Miro API with the given client id and client secret All options are optional and will fallback to environment variables clientId: MIRO_CLIENT_ID clientSecret: MIRO_CLIENT_SECRET redirectUrl: MIRO_REDIRECT_URL logger: MIRO_DEBUG

    Parameters

    Returns Miro

Properties

basePath: string
clientId: string
clientSecret: string
httpTimeout?: number
logger?: ((l: any) => void)

Type declaration

    • (l: any): void
    • Parameters

      • l: any

      Returns void

redirectUrl: string
storage: Storage

Methods

  • Exchanges the authorization code for an access token by calling the token endpoint It will store the token information in storage for later reuse

    Parameters

    Returns Promise<string>

  • Returns a URL that user should be redirected to in order to authorize the application, accepts an optional state argument and a teamId that will be used as a default

    Parameters

    • Optional state: string
    • Optional teamId: string

    Returns string

  • Parameters

    • userId: ExternalUserId
    • params: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns Promise<string>

  • Exchanges the authorization code for an access token by calling the token endpoint It will store the token information in storage for later reuse

    Parameters

    Returns Promise<void>