Features

Installation

dependencies:splitwise_api:^2.0.3

dart pub get

Getting Started

1. Register Your Application

2. Import the Package

import'package:splitwise_api/splitwise_api.dart';

3. Authentication Flow

// Initialize the serviceSplitWiseService splitWiseService=SplitWiseService.initialize('YOUR_CONSUMER_KEY','YOUR_CONSUMER_SECRET',);// Step 1: Get authorization URLvar authURL=await splitWiseService.validateClient();print('Please authorize at: $authURL');// Step 2: After user authorizes, exchange verifier for tokensTokensHelper tokens=await splitWiseService.validateClient(  verifier:'VERIFIER_CODE_FROM_USER',);// Save tokens for future use (see Token Persistence section)awaitsaveTokens(tokens);// Step 3: Use the authenticated clientvar currentUser=await splitWiseService.getCurrentUser();print(currentUser);

4. Subsequent Sessions

// Initialize serviceSplitWiseService splitWiseService=SplitWiseService.initialize('YOUR_CONSUMER_KEY','YOUR_CONSUMER_SECRET',);// Load saved tokensTokensHelper savedTokens=awaitloadTokens();// Validate with saved tokensawait splitWiseService.validateClient(tokens: savedTokens);// Ready to make API callsvar user=await splitWiseService.getCurrentUser();

Token Persistence

import'package:shared_preferences/shared_preferences.dart';import'package:splitwise_api/splitwise_api.dart';classTokenStorage {staticconst _tokenKey='splitwise_token';staticconst _tokenSecretKey='splitwise_token_secret';Future<void>saveTokens(TokensHelper tokens)async {final prefs=awaitSharedPreferences.getInstance();await prefs.setString(_tokenKey, tokens.token??'');await prefs.setString(_tokenSecretKey, tokens.tokenSecret??'');  }Future<TokensHelper?>loadTokens()async {final prefs=awaitSharedPreferences.getInstance();final token= prefs.getString(_tokenKey);final tokenSecret= prefs.getString(_tokenSecretKey);if (token==null|| tokenSecret==null)returnnull;returnTokensHelper(token, tokenSecret);  }Future<void>clearTokens()async {final prefs=awaitSharedPreferences.getInstance();await prefs.remove(_tokenKey);await prefs.remove(_tokenSecretKey);  }}

API Methods

Users

await splitWiseService.getCurrentUser();await splitWiseService.getUser(userId);await splitWiseService.updateUser(userId, options);

Groups

await splitWiseService.getGroups();await splitWiseService.getGroup(groupId);await splitWiseService.createGroup(options);await splitWiseService.deleteGroup(groupId);await splitWiseService.addUserToGroup(options);await splitWiseService.removeUserFromGroup(options);

Friends

await splitWiseService.getFriends();await splitWiseService.getFriend(friendId);await splitWiseService.createFriend(options);await splitWiseService.createFriends(options);await splitWiseService.deleteFriend(friendId);

Expenses

await splitWiseService.getExpenses(options: filters);await splitWiseService.getExpense(expenseId);await splitWiseService.createExpense(options);await splitWiseService.updateExpense(expenseId, options);await splitWiseService.deleteExpense(expenseId);

Comments

await splitWiseService.getComments(expenseId);await splitWiseService.createComment(options);await splitWiseService.deleteComment(commentId);

Other

await splitWiseService.getNotifications(options: filters);await splitWiseService.getCurrencies();await splitWiseService.getCategories();await splitWiseService.parseSentence(options);

Important Notes

Example

Contributing

Resources

License