API to manage teams, members and tokens
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.3.13 bordering-jerilyn
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://docs.lab5e.com
Dart 2.0 or later
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
userapi:
git: https://github.com/lab5e/dart-userapi.git
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
userapi:
path: /path/to/userapi
TODO
Please follow the installation procedure and then run the following:
import 'package:userapi/api.dart';
// TODO Configure API key authorization: APIToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIToken').apiKeyPrefix = 'Bearer';
final api_instance = ProfileApi();
try {
final result = api_instance.getUserProfile();
print(result);
} catch (e) {
print('Exception when calling ProfileApi->getUserProfile: $e\n');
}
All URIs are relative to https://api.lab5e.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ProfileApi | getUserProfile | GET /user/profile | Logged in profile |
| TeamsApi | acceptInvite | POST /user/teams/accept | Accept invite |
| TeamsApi | createTeam | POST /user/teams | Create team |
| TeamsApi | deleteInvite | DELETE /user/teams/{teamId}/invites/{code} | Delete invite |
| TeamsApi | deleteMember | DELETE /user/teams/{teamId}/members/{userId} | Remove member |
| TeamsApi | deleteTeam | DELETE /user/teams/{teamId} | Remove team |
| TeamsApi | generateInvite | POST /user/teams/{teamId}/invites | Generate invite |
| TeamsApi | listInvites | GET /user/teams/{teamId}/invites | List invites |
| TeamsApi | listTeams | GET /user/teams | List teams |
| TeamsApi | retrieveInvite | GET /user/teams/{teamId}/invites/{code} | Retrieve invite |
| TeamsApi | retrieveMember | GET /user/teams/{teamId}/members/{userId} | Retrieve member |
| TeamsApi | retrieveTeam | GET /user/teams/{teamId} | Retrieve team |
| TeamsApi | retrieveTeamMembers | GET /user/teams/{teamId}/members | List members |
| TeamsApi | updateMember | PATCH /user/teams/{teamId}/members/{userId} | Update member |
| TeamsApi | updateTeam | PATCH /user/teams/{teamId} | Update team |
| TokensApi | createToken | POST /user/tokens | Create token |
| TokensApi | deleteToken | DELETE /user/tokens/{token} | Remove token |
| TokensApi | listTokens | GET /user/tokens | List tokens |
| TokensApi | retrieveToken | GET /user/tokens/{token} | Retrieve token |
| TokensApi | updateToken | PATCH /user/tokens/{token} | Update token |
- ATeam
- AcceptInviteRequest
- AnAPIToken
- DeleteInviteResponse
- DeleteTokenResponse
- Invite
- InviteList
- Member
- MemberList
- MemberOfATeam
- ProtobufAny
- RequestInviteDetails
- RpcStatus
- Team
- TeamList
- Token
- TokenList
- UserProfile
- Type: API key
- API key parameter name: X-API-Token
- Location: HTTP header