teambattles_sdk 0.1.0

Official Dart SDK for the TeamBattles public developer API.

teambattles_sdk

Official Dart SDK for the TeamBattles public developer API.

Auto-generated from the TeamBattles OpenAPI 3.1 specification with Microsoft Kiota. This README is generated by pnpm sdk:docs and regenerates on every API change - do not edit it by hand.

• Language: Dart
• Registry: pub.dev
• Maturity: Preview (may be quarantined in CI; see sdks/QUARANTINE.md)

Install

dart pub add teambattles_sdk

Dependencies

The generated client is a thin veneer over the shared Kiota runtime. This package depends on:

• microsoft_kiota_abstractions
• microsoft_kiota_http
• microsoft_kiota_serialization_json
• microsoft_kiota_serialization_text
• microsoft_kiota_serialization_form
• microsoft_kiota_serialization_multipart
• microsoft_kiota_bundle

Create a client

Construct a client once with your API key. The factory wires a bearer-token authentication provider and points the client at the production base URL.

import 'package:teambattles_sdk/teambattles_sdk.dart';

final client = createTeamBattlesClient(
  Platform.environment['TEAMBATTLES_API_KEY']!,
);

First call: list the authenticated user's matches

// List the authenticated user's matches (requires matches.user_matches: read)
final body = MatchesRequestBody()..numItems = 25;
final result = await client.user.matches.post(body);
for (final match in result?.page ?? []) {
  print('${match.id} ${match.status}');
}

Authentication

Every request is authenticated with an API key sent as a bearer token:

Authorization: Bearer tb_<your-key>

Create and manage keys at Settings > Developer. Keys carry granular permission scopes - listing the authenticated user's matches requires matches.user_matches: read.

Errors return a JSON body of the form { "error": "<machine_code>", "details": "<optional message>" }. Treat the error machine code - not the details message - as the stable programmatic contract: branch on error, and use details only for human-readable context (it may be absent on auth and permission errors).

Documentation

• API reference and guides: https://teambattles.gg/docs/developers
• SDKs overview: https://teambattles.gg/docs/sdks
• This SDK: https://teambattles.gg/docs/sdks/dart
• Authentication: https://teambattles.gg/docs/developers/authentication

License

MIT