fingerprint_dart_auth_sdk library
Classes
- DecryptionKey
- Represents the decryption key information required for unsealing operations.
- DefaultDecryptionKey
- A data class that implements the DecryptionKey interface.
- DefaultErrorResponse
- A concrete implementation of ErrorResponse.
- DefaultOptions
- A default implementation of the Options interface.
- DefaultWebhookSignatureParams
- A default implementation of IsValidWebhookSignatureParams.
- ErrorPlainResponse
- Represents a standardized error response from the FingerprintJS Pro API.
- ErrorResponse
- Abstract class representing a standardized error response.
- Event
- Represents an individual event returned by the FingerprintJS Pro API.
- EventsGetResponse
- Represents the response received when fetching events from the FingerprintJS Pro API.
- EventsUpdateRequest
- Represents the request payload for updating an event in the FingerprintJS Pro API
- ExtractQueryParams
- Represents query parameters for API requests in a structured format.
- FingerprintApi
- Defines a unified API interface for interacting with the FingerprintJS Pro API.
- FingerprintAuth
- FingerprintAuth handles fingerprint authentication using the FingerprintJS API. It allows verifying fingerprint payloads by making HTTP requests to the API.
- FingerprintJsServerApiClient
- A client for interacting with the FingerprintJS Pro Server API.
- IntegrationInfo
- Represents the integration metadata retrieved from the FingerprintJS Pro API.
- IsValidWebhookSignatureParams
- Represents the parameters required to validate a webhook signature.
- Options
- Represents configuration options for the Fingerprint Dart Auth SDK.
- RelatedVisitorsFilter
- Represents filtering criteria for retrieving related visitors.
- RelatedVisitorsResponse
- Represents the response from the FingerprintJS Pro API when querying for related visitors.
- SearchEventsFilter
- Represents the filtering criteria for searching events in the FingerprintJS Pro API.
- SearchEventsResponse
- Represents the response from the FingerprintJS Pro API when searching for events.
- VerificationRequest
- Represents a request for fingerprint verification.
- VerificationResponse
- Represents the response received after fingerprint verification.
- VisitorDataResponse
- Represents the response containing visitor data.
- VisitorHistoryFilter
- Represents the filtering criteria for querying visitor history from the FingerprintJS Pro API.
- VisitorsResponse
- Represents the response from the FingerprintJS Pro API when fetching visitors data.
- Webhook
- Represents a webhook event payload received from the FingerprintJS Pro API.
Enums
- AuthenticationMode
- Represents the strictness level for fingerprint authentication.
- DecryptionAlgorithm
- Represents the decryption algorithm to be used for processing fingerprint data.
- Region
- Represents the geographic region for processing fingerprint requests.
Functions
-
getRequestPath(
String basePath, [Map< String, dynamic> ? queryParams]) → String - Constructs a properly encoded request path with optional query parameters.
-
getRetryAfter(
Map< String, String> headers) → Duration? - Extracts the retry duration from the HTTP response headers when a rate limit (429) error occurs.
-
isValidWebhookSignature(
{required String payload, required String signature, required String secret}) → bool - Verifies the authenticity of an incoming webhook request.
Exceptions / Errors
- RequestError
- A custom exception for handling errors during API requests.
- SdkError
- A custom exception for internal SDK errors.
- TooManyRequestsError
- A custom exception for handling HTTP 429 Too Many Requests errors.
- UnsealAggregateError
- Represents an error that occurs when unsealing aggregated response data fails.
- UnsealError
- A custom exception for errors occurring during the unsealing of a single sealed data element.