tawakkalna_sdk_flutter library

Tawakkalna SDK for Flutter

A comprehensive Flutter SDK for integrating with Tawakkalna, Saudi Arabia's super app that unifies government services in one platform.

This SDK provides:

  • Access to user data (personal info, documents, health, family, vehicles)
  • Strongly-typed Dart models and enums
  • Mock implementation for testing
  • JavaScript interop for Flutter Web
  • Built-in logging and debugging tools

Example usage:

import 'package:tawakkalna_sdk_flutter/tawakkalna_sdk_flutter.dart';

final twk = TwkHelper();
final fullName = await twk.getUserFullName();
print('Name: ${fullName.en} / ${fullName.ar}');

Classes

FamilyMember
Represents a family member in the Saudi Arabian family registry.
FullName
Represents a bilingual full name with Arabic and English versions.
JsonUtil
Utility class for JSON parsing and data type conversions.
LogEntry
A single log entry
NationalityEnity
Represents a person's nationality with bilingual names.
Represents a sponsor (kafeel) in the Saudi Arabian sponsorship system.
TwkApiV1
Tawakkalna SDK Helper for V1 API
TwkApiV1DemoJsonImpl
TwkApiV2
Tawakkalna SDK Helper for V2 API
TwkApiV2DemoJsonImpl
TwkFile
Represents a file (image, video, document) from the Tawakkalna SDK.
TwkHelper
Main helper class for interacting with the Tawakkalna SDK.
TwkLogger
Singleton logger for the Tawakkalna SDK.
UserDetails
Detailed information about a user or family member.

Enums

BloodType
Enumeration of blood type classifications.
Gender
Gender enum representing user gender types TODO:(TWK-team) know the actual gender types and their values
IqamaType
Enumeration of Iqama (residence permit) types in Saudi Arabia.
LogLevel
Log level for categorizing log messages
Nationality
TODO:(TWK-team) know the actual nationality and their values
Relation
Relation enum representing family relationships TODO:(TWK-team) know the actual relations and their values
UserType
User type enum representing different types of users todo:(twk-team) know the actual user types and their values