Class Miro

Hierarchy

Miro

Index

Constructors

Properties

basePath clientId clientSecret httpTimeout? logger? redirectUrl storage

Methods

as exchangeCodeForAccessToken getAccessToken getAuthUrl getToken handleAuthorizationCodeRequest isAuthorized refreshAccessToken revokeToken

Constructors

constructor

new Miro(options?: MiroOptions): Miro
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
- Optional options: MiroOptions
Returns Miro
- Defined in index.ts:24

Properties

basePath

basePath: string

clientId

clientId: string

clientSecret

clientSecret: string

`Optional` httpTimeout

httpTimeout?: number

`Optional` logger

logger?: ((l: any) => void)

Type declaration

- (l: any): void
- Parameters
  - l: any
  Returns void

redirectUrl

redirectUrl: string

storage

storage: Storage

Methods

as

as(userId: ExternalUserId): MiroApi
Returns an instance of the highlevel Miro API for the given user id
Parameters
- userId: ExternalUserId
Returns MiroApi
- Defined in index.ts:51

exchangeCodeForAccessToken

exchangeCodeForAccessToken(userId: ExternalUserId, urlOrCode: string): 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
- userId: ExternalUserId
- urlOrCode: string
Returns Promise<string>
- Defined in index.ts:93

getAccessToken

getAccessToken(userId: ExternalUserId): Promise<string>
Parameters
- userId: ExternalUserId
Returns Promise<string>
- Defined in index.ts:153

getAuthUrl

getAuthUrl(state?: string, teamId?: string): 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
- Defined in index.ts:69

getToken

getToken(userId: ExternalUserId, params: {
[key: string]: string;
}): Promise<string>
Parameters
- userId: ExternalUserId
- params: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<string>
- Defined in index.ts:123

handleAuthorizationCodeRequest

handleAuthorizationCodeRequest(userId: ExternalUserId, req: Request): Promise<void>
Parse request to extract authorization code and get access token
Parameters
- userId: ExternalUserId
- req: Request
Returns Promise<void>
- Defined in index.ts:84

isAuthorized

isAuthorized(userId: ExternalUserId): Promise<boolean>
Checks if the given user id already has token stored
Parameters
- userId: ExternalUserId
Returns Promise<boolean>
- Defined in index.ts:58

`Private` refreshAccessToken

refreshAccessToken(userId: ExternalUserId, refresh_token: string): Promise<string>
Parameters
- userId: ExternalUserId
- refresh_token: string
Returns Promise<string>
- Defined in index.ts:144

revokeToken

revokeToken(userId: ExternalUserId): Promise<void>
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
- userId: ExternalUserId
Returns Promise<void>
- Defined in index.ts:118