Class FtnEndpoint

Finnish Trust Network (FTN) operations.

Index

Constructors

Methods

ageVerification ageVerificationStatus auth authStatus cancelAgeVerification cancelAuth waitForAgeVerification waitForAuth

Constructors

constructor

new FtnEndpoint(client: IdkollenClient): FtnEndpoint
Parameters
- client: IdkollenClient
Returns FtnEndpoint
- Defined in src/endpoints/ftn.ts:9

Methods

ageVerification

ageVerification(req: AgeVerificationRequest): Promise<AgeVerificationStatus>
Start a FTN age verification session.
Parameters
- req: AgeVerificationRequest
Returns Promise<AgeVerificationStatus>
- Defined in src/endpoints/ftn.ts:17

ageVerificationStatus

ageVerificationStatus(id: string): Promise<AgeVerificationStatus>
Poll the current status of a FTN age verification session.
Parameters
- id: string
Returns Promise<AgeVerificationStatus>
- Defined in src/endpoints/ftn.ts:27

auth

auth(req: FtnAuthRequest): Promise<FtnStatus>
Start a FTN authentication session.
Parameters
- req: FtnAuthRequest
Returns Promise<FtnStatus>
- Defined in src/endpoints/ftn.ts:12

authStatus

authStatus(id: string): Promise<FtnStatus>
Poll the current status of a FTN authentication session.
Parameters
- id: string
Returns Promise<FtnStatus>
- Defined in src/endpoints/ftn.ts:22

cancelAgeVerification

cancelAgeVerification(id: string): Promise<void>
Cancel a FTN age verification session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/ftn.ts:37

cancelAuth

cancelAuth(id: string): Promise<void>
Cancel a FTN authentication session.
Parameters
- id: string
Returns Promise<void>
- Defined in src/endpoints/ftn.ts:32

waitForAgeVerification

waitForAgeVerification(
id: string,
opts?: PollOptions,
): Promise<AgeVerificationStatus>
Poll until the age verification session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<AgeVerificationStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/ftn.ts:67

waitForAuth

waitForAuth(id: string, opts?: PollOptions): Promise<FtnStatus>
Poll until the authentication session reaches a terminal state or the timeout elapses.
Parameters
- id: string
- opts: PollOptions = ...
Returns Promise<FtnStatus>
Throws
with code "poll_timeout" if the timeout is exceeded.
- Defined in src/endpoints/ftn.ts:45