@globalscoutme/api-client 1.0.2 → 1.0.3

package/README.md

@@ -0,0 +1,85 @@
+# @globalscoutme/api-client
+
+Auto-generated TypeScript HTTP client for the GlobalScoutMe API, built with [`@hey-api/openapi-ts`](https://heyapi.dev/) and axios.
+
+## Install
+
+```bash
+npm install @globalscoutme/api-client
+```
+
+## Setup
+
+Configure the client once at app startup with your API base URL and auth token:
+
+```ts
+import { client } from '@globalscoutme/api-client';
+
+client.setConfig({
+  baseURL: 'https://your-api-url.com',
+  headers: {
+    Authorization: `Bearer ${yourSupabaseAccessToken}`,
+  },
+});
+```
+
+## Usage
+
+All endpoints are grouped by controller and fully typed:
+
+```ts
+import { Players, Profile, Documents, Videos, Achievements, Body, Index, Organizations } from '@globalscoutme/api-client';
+
+// Players
+const player = await Players.getPlayersMe();
+await Players.patchPlayersMe({ body: { fullName: 'John Doe' } });
+await Players.deletePlayersMe();
+const dashboard = await Players.getPlayersMeDashboard();
+
+// Profile
+const profile = await Profile.getProfileMe();
+await Profile.putProfileMe({ body: { dominantFoot: 'Right' } });
+
+// Documents
+const docs = await Documents.getDocumentsMe();
+await Documents.postDocuments({ body: { type: 'license' } });
+
+// Videos
+const videos = await Videos.getVideosMe();
+await Videos.postVideos({ body: { type: 'cmj', storagePath: 'path/to/video' } });
+await Videos.deleteVideosById({ path: { id: 'video-id' } });
+
+// Achievements
+const achievements = await Achievements.getAchievementsMe();
+await Achievements.postAchievements({ body: { title: 'Top scorer' } });
+
+// Body measurements
+const measurement = await Body.getBodyMeasurementsMe();
+await Body.postBodyMeasurements({ body: { heightCm: 180 } });
+
+// Index (lookup tables)
+const positions = await Index.getIndexByTableName({ path: { tableName: 'positions' } });
+
+// Organizations
+const org = await Organizations.getOrganizationsMe();
+```
+
+## Updating auth token
+
+Update the Bearer token after sign-in or token refresh:
+
+```ts
+client.setConfig({
+  headers: {
+    Authorization: `Bearer ${newAccessToken}`,
+  },
+});
+```
+
+## Versioning
+
+This package is auto-generated from the backend OpenAPI spec. Version increments follow semver:
+
+- **patch** — no API shape changes
+- **minor** — new endpoints added
+- **major** — breaking changes (renamed/removed endpoints or fields)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalscoutme/api-client",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "GlobalScoutMe API client (generated)",
   "author": "GlobalScoutMe",
   "license": "UNLICENSED",