All files / src types.ts

100% Statements 4/4
100% Branches 2/2
100% Functions 1/1
100% Lines 4/4

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58    8x 8x 8x 8x                                                                                                        
import { components, paths } from './generatedApiTypes'
 
export enum Region {
  EU = 'EU',
  AP = 'AP',
  Global = 'Global',
}
 
/**
 * Options for FingerprintJS server API client
 */
export interface Options {
  /**
   * Secret API key
   */
  apiKey: string
  /**
   * Region of the FingerprintJS service server
   */
  region?: Region | `${Region}`
 
  /**
   * Optional fetch implementation
   * */
  fetch?: typeof fetch
 
  /**
   * Optional default headers
   */
  defaultHeaders?: Record<string, string>
}
 
export type ErrorResponse = components['schemas']['ErrorResponse']
 
/**
 * More info: https://dev.fingerprintjs.com/docs/server-api#query-parameters
 */
export type SearchEventsFilter = paths['/events']['get']['parameters']['query']
export type SearchEventsResponse = components['schemas']['EventSearch']
 
/**
 * More info: https://dev.fingerprint.com/reference/server-api-v4-get-event
 */
export type Event = components['schemas']['Event']
 
export type GetEventOptions = paths['/events/{event_id}']['get']['parameters']['query']
 
export type EventUpdate = components['schemas']['EventUpdate']
 
export type EventRuleAction = components['schemas']['EventRuleAction']
 
export interface FingerprintApi {
  getEvent(eventId: string, options?: GetEventOptions): Promise<Event>
  updateEvent(eventId: string, body: EventUpdate): Promise<void>
  searchEvents(filter: SearchEventsFilter): Promise<SearchEventsResponse>
  deleteVisitorData(visitorId: string): Promise<void>
}