@globalscoutme/api-client 1.1.6 → 1.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +298 -287
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/sdk.gen.d.ts +8 -1
- package/dist/sdk.gen.js +14 -0
- package/dist/types.gen.d.ts +115 -2
- package/index.ts +15 -0
- package/package.json +1 -1
- package/sdk.gen.ts +46 -0
- package/types.gen.ts +132 -2
package/README.md
CHANGED
|
@@ -1,287 +1,298 @@
|
|
|
1
|
-
# @globalscoutme/api-client
|
|
2
|
-
|
|
3
|
-
Auto-generated TypeScript HTTP client for the GlobalScoutMe API, built with [`@hey-api/openapi-ts`](https://heyapi.dev/) and axios.
|
|
4
|
-
|
|
5
|
-
## Install
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm install @globalscoutme/api-client
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Setup
|
|
12
|
-
|
|
13
|
-
Configure the client once at app startup with your API base URL and auth token:
|
|
14
|
-
|
|
15
|
-
```ts
|
|
16
|
-
import { client } from '@globalscoutme/api-client';
|
|
17
|
-
|
|
18
|
-
client.setConfig({
|
|
19
|
-
baseURL: 'https://your-api-url.com',
|
|
20
|
-
headers: {
|
|
21
|
-
Authorization: `Bearer ${yourSupabaseAccessToken}`,
|
|
22
|
-
},
|
|
23
|
-
});
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Usage
|
|
27
|
-
|
|
28
|
-
All endpoints are grouped by controller and fully typed:
|
|
29
|
-
|
|
30
|
-
```ts
|
|
31
|
-
import {
|
|
32
|
-
Auth,
|
|
33
|
-
Dashboard,
|
|
34
|
-
Players,
|
|
35
|
-
Profile,
|
|
36
|
-
Documents,
|
|
37
|
-
Videos,
|
|
38
|
-
Achievements,
|
|
39
|
-
Body,
|
|
40
|
-
Index,
|
|
41
|
-
Kyc,
|
|
42
|
-
Offers,
|
|
43
|
-
Organizations,
|
|
44
|
-
Clubs,
|
|
45
|
-
Challenges,
|
|
46
|
-
Training,
|
|
47
|
-
Invitations,
|
|
48
|
-
Storage,
|
|
49
|
-
Subscriptions,
|
|
50
|
-
} from '@globalscoutme/api-client';
|
|
51
|
-
|
|
52
|
-
// Auth
|
|
53
|
-
const authMe = await Auth.getAuthMe();
|
|
54
|
-
// Returns { id: string, userType: string | null }
|
|
55
|
-
|
|
56
|
-
// Players
|
|
57
|
-
const player = await Players.getMe();
|
|
58
|
-
await Players.patchMe({ body: { fullName: 'John Doe' } });
|
|
59
|
-
await Players.deleteMe();
|
|
60
|
-
const dashboard = await Players.getMyDashboard();
|
|
61
|
-
await Players.heartbeat({ body: { timezone: 'Europe/Bucharest' } });
|
|
62
|
-
const results = await Players.searchPlayers({
|
|
63
|
-
body: {
|
|
64
|
-
search: 'John',
|
|
65
|
-
page: 1,
|
|
66
|
-
pageSize: 20,
|
|
67
|
-
sortBy: 'age_asc',
|
|
68
|
-
nationalities: ['EG', 'MA'],
|
|
69
|
-
positions: ['CM', 'CB'],
|
|
70
|
-
baseFoot: 'right',
|
|
71
|
-
isFreeAgent: true,
|
|
72
|
-
hasVideo: true,
|
|
73
|
-
heightOperator: 'gte',
|
|
74
|
-
heightCm: 180,
|
|
75
|
-
},
|
|
76
|
-
});
|
|
77
|
-
const playerProfile = await Players.getPlayerById({
|
|
78
|
-
path: { id: 'player-uuid' },
|
|
79
|
-
});
|
|
80
|
-
const playerMeasurements = await Players.getPlayerMeasurementProfile({
|
|
81
|
-
path: { id: 'player-uuid' },
|
|
82
|
-
});
|
|
83
|
-
// Returns { status, body, cmj, session, updatedAt } — accessible to all roles (no player-only restriction)
|
|
84
|
-
// status: 'missing' | 'partial' | 'ready' | 'needs_update'
|
|
85
|
-
const
|
|
86
|
-
path: { id: 'player-uuid' },
|
|
87
|
-
});
|
|
88
|
-
// Returns {
|
|
89
|
-
//
|
|
90
|
-
|
|
91
|
-
//
|
|
92
|
-
|
|
93
|
-
await
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
//
|
|
100
|
-
const
|
|
101
|
-
await
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
const
|
|
105
|
-
await
|
|
106
|
-
|
|
107
|
-
//
|
|
108
|
-
const
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
const
|
|
113
|
-
await
|
|
114
|
-
|
|
115
|
-
//
|
|
116
|
-
const
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
//
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
}
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
body: {
|
|
147
|
-
});
|
|
148
|
-
await Offers.
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
await
|
|
153
|
-
|
|
154
|
-
body: {
|
|
155
|
-
});
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
const
|
|
160
|
-
await
|
|
161
|
-
|
|
162
|
-
body: { name: '
|
|
163
|
-
});
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
const
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
const
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
await
|
|
181
|
-
|
|
182
|
-
});
|
|
183
|
-
const
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
//
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
//
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
//
|
|
216
|
-
//
|
|
217
|
-
|
|
218
|
-
//
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
//
|
|
225
|
-
//
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
//
|
|
230
|
-
|
|
231
|
-
const
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
//
|
|
235
|
-
|
|
236
|
-
//
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
//
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
//
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
body:
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
headers: {
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
1
|
+
# @globalscoutme/api-client
|
|
2
|
+
|
|
3
|
+
Auto-generated TypeScript HTTP client for the GlobalScoutMe API, built with [`@hey-api/openapi-ts`](https://heyapi.dev/) and axios.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @globalscoutme/api-client
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
Configure the client once at app startup with your API base URL and auth token:
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { client } from '@globalscoutme/api-client';
|
|
17
|
+
|
|
18
|
+
client.setConfig({
|
|
19
|
+
baseURL: 'https://your-api-url.com',
|
|
20
|
+
headers: {
|
|
21
|
+
Authorization: `Bearer ${yourSupabaseAccessToken}`,
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
All endpoints are grouped by controller and fully typed:
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import {
|
|
32
|
+
Auth,
|
|
33
|
+
Dashboard,
|
|
34
|
+
Players,
|
|
35
|
+
Profile,
|
|
36
|
+
Documents,
|
|
37
|
+
Videos,
|
|
38
|
+
Achievements,
|
|
39
|
+
Body,
|
|
40
|
+
Index,
|
|
41
|
+
Kyc,
|
|
42
|
+
Offers,
|
|
43
|
+
Organizations,
|
|
44
|
+
Clubs,
|
|
45
|
+
Challenges,
|
|
46
|
+
Training,
|
|
47
|
+
Invitations,
|
|
48
|
+
Storage,
|
|
49
|
+
Subscriptions,
|
|
50
|
+
} from '@globalscoutme/api-client';
|
|
51
|
+
|
|
52
|
+
// Auth
|
|
53
|
+
const authMe = await Auth.getAuthMe();
|
|
54
|
+
// Returns { id: string, userType: string | null }
|
|
55
|
+
|
|
56
|
+
// Players
|
|
57
|
+
const player = await Players.getMe();
|
|
58
|
+
await Players.patchMe({ body: { fullName: 'John Doe' } });
|
|
59
|
+
await Players.deleteMe();
|
|
60
|
+
const dashboard = await Players.getMyDashboard();
|
|
61
|
+
await Players.heartbeat({ body: { timezone: 'Europe/Bucharest' } });
|
|
62
|
+
const results = await Players.searchPlayers({
|
|
63
|
+
body: {
|
|
64
|
+
search: 'John',
|
|
65
|
+
page: 1,
|
|
66
|
+
pageSize: 20,
|
|
67
|
+
sortBy: 'age_asc',
|
|
68
|
+
nationalities: ['EG', 'MA'],
|
|
69
|
+
positions: ['CM', 'CB'],
|
|
70
|
+
baseFoot: 'right',
|
|
71
|
+
isFreeAgent: true,
|
|
72
|
+
hasVideo: true,
|
|
73
|
+
heightOperator: 'gte',
|
|
74
|
+
heightCm: 180,
|
|
75
|
+
},
|
|
76
|
+
});
|
|
77
|
+
const playerProfile = await Players.getPlayerById({
|
|
78
|
+
path: { id: 'player-uuid' },
|
|
79
|
+
});
|
|
80
|
+
const playerMeasurements = await Players.getPlayerMeasurementProfile({
|
|
81
|
+
path: { id: 'player-uuid' },
|
|
82
|
+
});
|
|
83
|
+
// Returns { status, body, cmj, session, updatedAt } — accessible to all roles (no player-only restriction)
|
|
84
|
+
// status: 'missing' | 'partial' | 'ready' | 'needs_update'
|
|
85
|
+
const playerVideoMetrics = await Players.getPlayerVideoMetrics({
|
|
86
|
+
path: { id: 'player-uuid' },
|
|
87
|
+
});
|
|
88
|
+
// Returns { id, createdAt, videoDurationS, physicalMetrics, trackingQuality, trackedFrames, totalFrames }
|
|
89
|
+
// physicalMetrics: { totalDistance, sprintDistance, maxSpeed, averageSpeed, highIntensityRuns, sprints }
|
|
90
|
+
// Speed/distance values are strings with units already included (e.g. "31.0 km/h", "21.4 m")
|
|
91
|
+
// trackingQuality: confidence label from the analysis service (e.g. "High Confidence") — null if unavailable
|
|
92
|
+
// Returns 404 if the player has no completed video analysis yet
|
|
93
|
+
const playerReport = await Players.getPlayerReport({
|
|
94
|
+
path: { id: 'player-uuid' },
|
|
95
|
+
});
|
|
96
|
+
// Returns { reportReferenceId, generatedAt, scouterView: { technicalPillar, physicalPillar, tacticalPillar, mentalPillar } }
|
|
97
|
+
// Returns 404 if the player has no completed AI report yet
|
|
98
|
+
|
|
99
|
+
// Profile
|
|
100
|
+
const profile = await Profile.getProfileMe();
|
|
101
|
+
await Profile.updateProfileMe({ body: { dominantFoot: 'Right' } });
|
|
102
|
+
|
|
103
|
+
// Documents
|
|
104
|
+
const docs = await Documents.getMyDocuments();
|
|
105
|
+
await Documents.createDocument({ body: { type: 'license' } });
|
|
106
|
+
|
|
107
|
+
// Videos
|
|
108
|
+
const videos = await Videos.getMyVideos();
|
|
109
|
+
await Videos.createVideo({
|
|
110
|
+
body: { type: 'cmj', storagePath: 'path/to/video' },
|
|
111
|
+
});
|
|
112
|
+
const playUrl = await Videos.getVideoPlayUrl({ path: { id: 'video-uuid' } });
|
|
113
|
+
await Videos.deleteVideo({ path: { id: 'video-uuid' } });
|
|
114
|
+
|
|
115
|
+
// Achievements
|
|
116
|
+
const catalog = await Achievements.getAchievementsCatalog();
|
|
117
|
+
const myAchievements = await Achievements.getMyAchievements();
|
|
118
|
+
|
|
119
|
+
// Body measurements
|
|
120
|
+
const measurement = await Body.getMyMeasurements();
|
|
121
|
+
await Body.createMeasurement({ body: { heightCm: 180 } });
|
|
122
|
+
|
|
123
|
+
// Index (lookup tables)
|
|
124
|
+
const positions = await Index.getIndexItems({
|
|
125
|
+
path: { tableName: 'positions' },
|
|
126
|
+
});
|
|
127
|
+
const countries = await Index.getCountries();
|
|
128
|
+
// Returns [{ code: 'BR', name: 'Brazil', nationalityName: 'Brazilian', flagEmoji: '🇧🇷' }, ...]
|
|
129
|
+
|
|
130
|
+
// Dashboard (scout/club portal — single aggregated call)
|
|
131
|
+
const dashboard = await Dashboard.getScoutDashboard();
|
|
132
|
+
// Returns: stats (watchlisted, offersSent, playersViewed, videosWatched),
|
|
133
|
+
// lastPlayersViewed (last 6 distinct players),
|
|
134
|
+
// lastVideosWatched (last 6 distinct videos with player info)
|
|
135
|
+
|
|
136
|
+
const videoUrl = await Dashboard.getScoutVideoPlayUrl({
|
|
137
|
+
path: { id: 'video-uuid' },
|
|
138
|
+
});
|
|
139
|
+
// Returns signed play URL + records the view in video_views
|
|
140
|
+
|
|
141
|
+
// Offers (conversations between scouts and players)
|
|
142
|
+
const conversations = await Offers.listConversations({
|
|
143
|
+
query: { filter: 'all', page: 1, pageSize: 20 },
|
|
144
|
+
});
|
|
145
|
+
const conversation = await Offers.createConversation({
|
|
146
|
+
body: { playerId: 'player-uuid', initialMessage: 'Hi!' },
|
|
147
|
+
});
|
|
148
|
+
const messages = await Offers.listMessages({
|
|
149
|
+
path: { id: 'conversation-uuid' },
|
|
150
|
+
query: { page: 1, pageSize: 20 },
|
|
151
|
+
});
|
|
152
|
+
await Offers.sendMessage({
|
|
153
|
+
path: { id: 'conversation-uuid' },
|
|
154
|
+
body: { body: 'Looking forward to it!' },
|
|
155
|
+
});
|
|
156
|
+
await Offers.markConversationRead({ path: { id: 'conversation-uuid' } });
|
|
157
|
+
|
|
158
|
+
// Organizations
|
|
159
|
+
const org = await Organizations.getMyOrganization();
|
|
160
|
+
await Organizations.updateMyOrganization({ body: { name: 'FC Example' } });
|
|
161
|
+
await Organizations.registerClub({
|
|
162
|
+
body: { name: 'FC Example', email: 'admin@example.com' },
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
// Clubs (coach/admin club entries within an organization)
|
|
166
|
+
const clubs = await Clubs.getMyClubs();
|
|
167
|
+
const club = await Clubs.createMyClub({ body: { name: 'U19 Team' } });
|
|
168
|
+
await Clubs.updateMyClub({
|
|
169
|
+
path: { id: 'club-uuid' },
|
|
170
|
+
body: { name: 'U21 Team' },
|
|
171
|
+
});
|
|
172
|
+
await Clubs.deleteMyClub({ path: { id: 'club-uuid' } });
|
|
173
|
+
|
|
174
|
+
// Challenges
|
|
175
|
+
const challengeCatalog = await Challenges.getChallengesCatalog();
|
|
176
|
+
const myChallenges = await Challenges.getMyChallenges();
|
|
177
|
+
|
|
178
|
+
// Training
|
|
179
|
+
const grouped = await Training.getTrainingGrouped();
|
|
180
|
+
const trainingList = await Training.getTrainingList({
|
|
181
|
+
query: { categoryCode: 'fitness', page: 1, pageSize: 20 },
|
|
182
|
+
});
|
|
183
|
+
const trainingItem = await Training.getTrainingById({
|
|
184
|
+
path: { id: 'training-uuid' },
|
|
185
|
+
});
|
|
186
|
+
|
|
187
|
+
// Invitations (org admin invites members)
|
|
188
|
+
await Invitations.sendInvitation({
|
|
189
|
+
body: { email: 'coach@example.com', role: 'coach' },
|
|
190
|
+
});
|
|
191
|
+
const invitations = await Invitations.listInvitations();
|
|
192
|
+
await Invitations.resendInvitation({ path: { id: 'invitation-uuid' } });
|
|
193
|
+
await Invitations.deleteInvitation({ path: { id: 'invitation-uuid' } });
|
|
194
|
+
await Invitations.acceptInvitation(); // called after Supabase auth callback
|
|
195
|
+
|
|
196
|
+
// KYC — SmileID Enhanced Document Verification
|
|
197
|
+
//
|
|
198
|
+
// Two integration options:
|
|
199
|
+
|
|
200
|
+
// Option A — Smile Links (recommended for web)
|
|
201
|
+
// Backend returns a hosted SmileID URL; redirect the user to it.
|
|
202
|
+
// SmileID handles the full capture UI and fires the webhook when done.
|
|
203
|
+
const linkResult = await Kyc.startSmileLink({
|
|
204
|
+
body: {
|
|
205
|
+
country: 'gh', // stored on the verification record; does NOT filter the SmileID dropdown
|
|
206
|
+
channel: 'web',
|
|
207
|
+
returnUrl: 'https://yourapp.com/onboarding/kyc/callback',
|
|
208
|
+
},
|
|
209
|
+
});
|
|
210
|
+
// linkResult: { url, jobId, status, retriesRemaining }
|
|
211
|
+
// url is null when no redirect is needed (approved / blocked / processing).
|
|
212
|
+
if (linkResult.data.url) {
|
|
213
|
+
window.location.href = linkResult.data.url; // redirect user to SmileID
|
|
214
|
+
}
|
|
215
|
+
// The SmileID hosted page shows all countries configured in index.kyc_supported_id_types.
|
|
216
|
+
// The user selects their country and document type on that page.
|
|
217
|
+
// After the user returns to returnUrl, poll getKycStatus to confirm the result.
|
|
218
|
+
// markSubmittedKyc is NOT needed for Smile Links — SmileID fires the webhook directly.
|
|
219
|
+
|
|
220
|
+
// Option B — SDK widget (embedded, for mobile / advanced web)
|
|
221
|
+
const kycResult = await Kyc.startKyc({
|
|
222
|
+
body: { country: 'gh', channel: 'web' },
|
|
223
|
+
});
|
|
224
|
+
// kycResult: { token, partnerId, jobId, status, retriesRemaining }
|
|
225
|
+
// Pass token + partnerId to the SmileID web SDK widget to start document capture.
|
|
226
|
+
// After the SDK reports successful submission, call markSubmittedKyc with jobId.
|
|
227
|
+
await Kyc.markSubmittedKyc({ body: { jobId: kycResult.data.jobId! } });
|
|
228
|
+
// SmileID also calls POST /kyc/webhook under the configured API base/prefix
|
|
229
|
+
// (for staging: https://staging.globalscoutme.com/api/kyc/webhook).
|
|
230
|
+
|
|
231
|
+
const kycStatus = await Kyc.getKycStatus({
|
|
232
|
+
path: { userId: supabaseAuthUuid },
|
|
233
|
+
});
|
|
234
|
+
// kycStatus: { status, retryCount, retriesRemaining }
|
|
235
|
+
// status: 'pending' | 'capture_started' | 'processing' | 'approved' | 'rejected' | 'blocked'
|
|
236
|
+
// Older API clients may still see legacy 'in_progress', which maps to 'capture_started'.
|
|
237
|
+
|
|
238
|
+
// Subscriptions (Stripe recurring billing)
|
|
239
|
+
const plans = await Subscriptions.getSubscriptionPlans();
|
|
240
|
+
// Returns: { plans: [{ id, code, name, price, currency, billingInterval, trialDays, features, displayOrder }] }
|
|
241
|
+
|
|
242
|
+
const mySubscription = await Subscriptions.getMySubscription();
|
|
243
|
+
// Returns: { status, isActive, planId, planName, billingInterval,
|
|
244
|
+
// currentPeriodStart, currentPeriodEnd, cancelAtPeriodEnd, canceledAt, gracePeriodUntil }
|
|
245
|
+
// status: 'inactive' when the user has never subscribed
|
|
246
|
+
|
|
247
|
+
// Start a subscription — redirect the user to the returned URL
|
|
248
|
+
const checkout = await Subscriptions.createCheckout({
|
|
249
|
+
body: {
|
|
250
|
+
providerProductId: 'billing-provider-products-uuid', // pick from billing_provider_products table
|
|
251
|
+
successUrl: 'https://yourapp.com/subscription/success', // or a mobile deep-link
|
|
252
|
+
cancelUrl: 'https://yourapp.com/subscription/cancel',
|
|
253
|
+
},
|
|
254
|
+
});
|
|
255
|
+
// redirect user to checkout.url
|
|
256
|
+
|
|
257
|
+
// Open the Stripe Billing Portal (manage / cancel subscription)
|
|
258
|
+
const portal = await Subscriptions.createPortal({
|
|
259
|
+
body: { returnUrl: 'https://yourapp.com/account' },
|
|
260
|
+
});
|
|
261
|
+
// redirect user to portal.url
|
|
262
|
+
|
|
263
|
+
// Storage — get a signed upload URL, then PUT the file directly to Supabase Storage
|
|
264
|
+
const { uploadUrl, token, path, bucket, expiresIn } =
|
|
265
|
+
await Storage.createUploadUrl({
|
|
266
|
+
body: { bucket: 'avatars', contentType: 'image/jpeg', sizeBytes: 204800 },
|
|
267
|
+
});
|
|
268
|
+
await fetch(uploadUrl, {
|
|
269
|
+
method: 'PUT',
|
|
270
|
+
body: fileBlob,
|
|
271
|
+
headers: { 'Content-Type': 'image/jpeg' },
|
|
272
|
+
});
|
|
273
|
+
// persist `path` on the player record (e.g. patchMe with avatarPath: path)
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
## Updating auth token
|
|
277
|
+
|
|
278
|
+
Update the Bearer token after sign-in or token refresh:
|
|
279
|
+
|
|
280
|
+
```ts
|
|
281
|
+
client.setConfig({
|
|
282
|
+
headers: {
|
|
283
|
+
Authorization: `Bearer ${newAccessToken}`,
|
|
284
|
+
},
|
|
285
|
+
});
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
## Versioning
|
|
289
|
+
|
|
290
|
+
This package is auto-generated from the backend OpenAPI spec. Version increments follow semver:
|
|
291
|
+
|
|
292
|
+
- **patch** — no API shape changes
|
|
293
|
+
- **minor** — new endpoints added
|
|
294
|
+
- **major** — breaking changes (renamed/removed endpoints or fields)
|
|
295
|
+
|
|
296
|
+
## Package format
|
|
297
|
+
|
|
298
|
+
The published package ships compiled JavaScript (`dist/`) alongside the raw TypeScript source. `main` points to `dist/index.js` so all bundlers work without extra configuration.
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Achievements, Auth, Billing, Body, Challenges, Clubs, Cmj, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Measurements, Notifications, Offers, type Options, Organizations, Players, Profile, Storage, Subscriptions, Training, Videos, } from './sdk.gen.js';
|
|
2
|
-
export type { AchievementCatalogDto, AiReportClipDto, AiReportClipTargetDto, AiReportImprovementAreaDto, AiReportMetaDto, AiReportPillarDetailDto, AiReportResultResponseDto, AiReportSubcategoryDto, AiReportViewDto, AuthMeResponseDto, BillingEntitlementResponseDto, BillingManageActionDto, BillingPlanDto, BillingPlansResponseDto, BillingProductDto, BillingProductsResponseDto, BillingProviderProductDto, BodyMeasurementProfileDto, BodyMeasurementResponseDto, CancelKycRequestDto, CareerAchievementDto, ChallengeCatalogDto, CheckoutResultDto, ClientOptions, ClubResponseDto, CmjMeasurementProfileDto, CmjMeasurementResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateCheckoutDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateMeasurementPlayerSessionDto, CreatePortalDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto, DashboardStatsDto, DashboardVideoCardDto, DeactivatePushDeviceDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponse, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBillingMeData, GetApiBillingMeResponse, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponse, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponse, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponse, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponse, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponse, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponse, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponse, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponse, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponse, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponse, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponse, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponse, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponse, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponse, GetApiSubscriptionsPlansResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponse, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponse, GetApiTrainingGroupedResponses, GetApiTrainingResponse, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponse, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponse, GetApiVideosMeResponses, HeartbeatDto, HeartbeatResponseDto, IndexItemDto, InvitationResponseDto, KycStatusDto, KycWebhookDto, MarkSubmittedKycRequestDto, MeasurementProfileResponseDto, MeasurementSessionDto, MeasurementSessionMetricsDto, MeasurementTagEvaluationDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, MySubscriptionDto, NotificationPreferencesDto, OkDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponse, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlansListDto, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerReportResponseDto, PlayerReportViewDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PortalResultDto, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponse, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponse, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponse, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponse, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponse, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponse, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponse, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponse, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponse, PostApiInvitationsResponses, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponse, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponse, PostApiKycMarkSubmittedResponses, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponse, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponse, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponse, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponse, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponse, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponse, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponse, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, ProviderCheckoutRequestDto, PushDeviceRegistrationResultDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RedeemAccessCodeDto, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, RegisterPushDeviceDto, ReportGenerationStartResponseDto, ReportPlayerCandidateBboxDto, ReportPlayerCandidateDto, ReportPlayerCandidatesRequestDto, ReportPlayerCandidatesResponseDto, ReportPlayerCandidateTargetDto, ReportPrerequisiteDto, ReportPurchaseDto, ReportPurchaseStatusResponseDto, ReportVideoCandidatesDto, ScoutDashboardResponseDto, SendInvitationRequestDto, SendMessageDto, SmileLinkRequestDto, SmileLinkResponseDto, StartKycRequestDto, StartKycResponseDto, StartReportGenerationClipDto, StartReportGenerationRequestDto, StorePurchaseSyncRequestDto, SubscriptionPlanDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateNotificationPreferencesDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } from './types.gen.js';
|
|
1
|
+
export { Achievements, Auth, Billing, Body, Challenges, Clubs, Cmj, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Measurements, Notifications, Offers, type Options, Organizations, Players, Profile, Storage, Subscriptions, Training, VideoMetrics, Videos, } from './sdk.gen.js';
|
|
2
|
+
export type { AchievementCatalogDto, AiReportClipDto, AiReportClipTargetDto, AiReportImprovementAreaDto, AiReportMetaDto, AiReportPillarDetailDto, AiReportResultResponseDto, AiReportSubcategoryDto, AiReportViewDto, AuthMeResponseDto, BillingEntitlementResponseDto, BillingManageActionDto, BillingPlanDto, BillingPlansResponseDto, BillingProductDto, BillingProductsResponseDto, BillingProviderProductDto, BodyMeasurementProfileDto, BodyMeasurementResponseDto, CancelKycRequestDto, CareerAchievementDto, ChallengeCatalogDto, CheckoutResultDto, ClientOptions, ClubResponseDto, CmjMeasurementProfileDto, CmjMeasurementResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateCheckoutDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateMeasurementPlayerSessionDto, CreatePortalDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto, DashboardStatsDto, DashboardVideoCardDto, DeactivatePushDeviceDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiDocumentsByIdData, DeleteApiDocumentsByIdErrors, DeleteApiDocumentsByIdResponse, DeleteApiDocumentsByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponse, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBillingMeData, GetApiBillingMeResponse, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponse, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponse, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponse, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponse, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponse, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponse, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponse, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponse, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponse, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponse, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponse, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponse, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersByIdVideoMetricsData, GetApiPlayersByIdVideoMetricsErrors, GetApiPlayersByIdVideoMetricsResponse, GetApiPlayersByIdVideoMetricsResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponse, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponse, GetApiSubscriptionsPlansResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponse, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponse, GetApiTrainingGroupedResponses, GetApiTrainingResponse, GetApiTrainingResponses, GetApiVideoMetricsMeData, GetApiVideoMetricsMeErrors, GetApiVideoMetricsMeResponse, GetApiVideoMetricsMeResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponse, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponse, GetApiVideosMeResponses, HeartbeatDto, HeartbeatResponseDto, IndexItemDto, InvitationResponseDto, KycStatusDto, KycWebhookDto, MarkSubmittedKycRequestDto, MeasurementProfileResponseDto, MeasurementSessionDto, MeasurementSessionMetricsDto, MeasurementTagEvaluationDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, MySubscriptionDto, NotificationPreferencesDto, OkDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponse, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlansListDto, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerReportResponseDto, PlayerReportViewDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PortalResultDto, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponse, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponse, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponse, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponse, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponse, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponse, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponse, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponse, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponse, PostApiInvitationsResponses, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponse, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponse, PostApiKycMarkSubmittedResponses, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponse, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponse, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponse, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponse, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponse, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponse, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponse, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, ProviderCheckoutRequestDto, PushDeviceRegistrationResultDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RedeemAccessCodeDto, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, RegisterPushDeviceDto, ReportGenerationStartResponseDto, ReportPlayerCandidateBboxDto, ReportPlayerCandidateDto, ReportPlayerCandidatesRequestDto, ReportPlayerCandidatesResponseDto, ReportPlayerCandidateTargetDto, ReportPrerequisiteDto, ReportPurchaseDto, ReportPurchaseStatusResponseDto, ReportVideoCandidatesDto, ScoutDashboardResponseDto, SendInvitationRequestDto, SendMessageDto, SmileLinkRequestDto, SmileLinkResponseDto, StartKycRequestDto, StartKycResponseDto, StartReportGenerationClipDto, StartReportGenerationRequestDto, StorePurchaseSyncRequestDto, SubscriptionPlanDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateNotificationPreferencesDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoMetricsMeResponseDto, VideoMetricsPhysicalMetricsDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } from './types.gen.js';
|
|
3
3
|
export { client, type CreateClientConfig } from './client.gen.js';
|
|
4
4
|
export type { GetApiOffersConversationsData as GetOffersConversationsData } from './types.gen.js';
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
export { Achievements, Auth, Billing, Body, Challenges, Clubs, Cmj, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Measurements, Notifications, Offers, Organizations, Players, Profile, Storage, Subscriptions, Training, Videos, } from './sdk.gen.js';
|
|
2
|
+
export { Achievements, Auth, Billing, Body, Challenges, Clubs, Cmj, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Measurements, Notifications, Offers, Organizations, Players, Profile, Storage, Subscriptions, Training, VideoMetrics, Videos, } from './sdk.gen.js';
|
|
3
3
|
export { client } from './client.gen.js';
|
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client/index.js';
|
|
2
|
-
import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBillingMeData, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponses, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponses, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponses, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponses, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponses, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponses } from './types.gen.js';
|
|
2
|
+
import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiDocumentsByIdData, DeleteApiDocumentsByIdErrors, DeleteApiDocumentsByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBillingMeData, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponses, GetApiPlayersByIdVideoMetricsData, GetApiPlayersByIdVideoMetricsErrors, GetApiPlayersByIdVideoMetricsResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponses, GetApiTrainingResponses, GetApiVideoMetricsMeData, GetApiVideoMetricsMeErrors, GetApiVideoMetricsMeResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponses, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponses, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponses, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponses, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponses } from './types.gen.js';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -39,6 +39,7 @@ export declare class Players extends HeyApiClient {
|
|
|
39
39
|
heartbeat<ThrowOnError extends boolean = false>(options: Options<PostApiPlayersMeHeartbeatData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiPlayersMeHeartbeatResponses, PostApiPlayersMeHeartbeatErrors, ThrowOnError, "fields">;
|
|
40
40
|
searchPlayers<ThrowOnError extends boolean = false>(options: Options<PostApiPlayersSearchData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiPlayersSearchResponses, PostApiPlayersSearchErrors, ThrowOnError, "fields">;
|
|
41
41
|
getPlayerMeasurementProfile<ThrowOnError extends boolean = false>(options: Options<GetApiPlayersByIdMeasurementsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdMeasurementsErrors, ThrowOnError, "fields">;
|
|
42
|
+
getPlayerVideoMetrics<ThrowOnError extends boolean = false>(options: Options<GetApiPlayersByIdVideoMetricsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersByIdVideoMetricsResponses, GetApiPlayersByIdVideoMetricsErrors, ThrowOnError, "fields">;
|
|
42
43
|
getPlayerReport<ThrowOnError extends boolean = false>(options: Options<GetApiPlayersByIdReportData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersByIdReportResponses, GetApiPlayersByIdReportErrors, ThrowOnError, "fields">;
|
|
43
44
|
getPlayerById<ThrowOnError extends boolean = false>(options: Options<GetApiPlayersByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersByIdResponses, GetApiPlayersByIdErrors, ThrowOnError, "fields">;
|
|
44
45
|
}
|
|
@@ -69,6 +70,9 @@ export declare class Measurements extends HeyApiClient {
|
|
|
69
70
|
getMyMeasurementProfile<ThrowOnError extends boolean = false>(options?: Options<GetApiMeasurementsProfileMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiMeasurementsProfileMeResponses, GetApiMeasurementsProfileMeErrors, ThrowOnError, "fields">;
|
|
70
71
|
createMyMeasurementPlayerSession<ThrowOnError extends boolean = false>(options: Options<PostApiMeasurementsPlayerSessionMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiMeasurementsPlayerSessionMeResponses, PostApiMeasurementsPlayerSessionMeErrors, ThrowOnError, "fields">;
|
|
71
72
|
}
|
|
73
|
+
export declare class VideoMetrics extends HeyApiClient {
|
|
74
|
+
getMyVideoMetrics<ThrowOnError extends boolean = false>(options?: Options<GetApiVideoMetricsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiVideoMetricsMeResponses, GetApiVideoMetricsMeErrors, ThrowOnError, "fields">;
|
|
75
|
+
}
|
|
72
76
|
export declare class Profile extends HeyApiClient {
|
|
73
77
|
getProfileMe<ThrowOnError extends boolean = false>(options?: Options<GetApiProfileMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiProfileMeResponses, GetApiProfileMeErrors, ThrowOnError, "fields">;
|
|
74
78
|
updateProfileMe<ThrowOnError extends boolean = false>(options: Options<PutApiProfileMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutApiProfileMeResponses, PutApiProfileMeErrors, ThrowOnError, "fields">;
|
|
@@ -103,6 +107,7 @@ export declare class Clubs extends HeyApiClient {
|
|
|
103
107
|
export declare class Documents extends HeyApiClient {
|
|
104
108
|
getMyDocuments<ThrowOnError extends boolean = false>(options?: Options<GetApiDocumentsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiDocumentsMeResponses, GetApiDocumentsMeErrors, ThrowOnError, "fields">;
|
|
105
109
|
createDocument<ThrowOnError extends boolean = false>(options: Options<PostApiDocumentsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiDocumentsResponses, PostApiDocumentsErrors, ThrowOnError, "fields">;
|
|
110
|
+
deleteDocument<ThrowOnError extends boolean = false>(options: Options<DeleteApiDocumentsByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiDocumentsByIdResponses, DeleteApiDocumentsByIdErrors, ThrowOnError, "fields">;
|
|
106
111
|
}
|
|
107
112
|
export declare class Index extends HeyApiClient {
|
|
108
113
|
getCountries<ThrowOnError extends boolean = false>(options?: Options<GetApiIndexCountriesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiIndexCountriesResponses, GetApiIndexCountriesErrors, ThrowOnError, "fields">;
|
|
@@ -224,6 +229,8 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
|
|
|
224
229
|
get storage(): Storage;
|
|
225
230
|
private _measurements?;
|
|
226
231
|
get measurements(): Measurements;
|
|
232
|
+
private _videoMetrics?;
|
|
233
|
+
get videoMetrics(): VideoMetrics;
|
|
227
234
|
private _profile?;
|
|
228
235
|
get profile(): Profile;
|
|
229
236
|
private _achievements?;
|
package/dist/sdk.gen.js
CHANGED
|
@@ -72,6 +72,9 @@ export class Players extends HeyApiClient {
|
|
|
72
72
|
getPlayerMeasurementProfile(options) {
|
|
73
73
|
return (options.client ?? this.client).get({ url: '/api/players/{id}/measurements', ...options });
|
|
74
74
|
}
|
|
75
|
+
getPlayerVideoMetrics(options) {
|
|
76
|
+
return (options.client ?? this.client).get({ url: '/api/players/{id}/video-metrics', ...options });
|
|
77
|
+
}
|
|
75
78
|
getPlayerReport(options) {
|
|
76
79
|
return (options.client ?? this.client).get({ url: '/api/players/{id}/report', ...options });
|
|
77
80
|
}
|
|
@@ -221,6 +224,11 @@ export class Measurements extends HeyApiClient {
|
|
|
221
224
|
});
|
|
222
225
|
}
|
|
223
226
|
}
|
|
227
|
+
export class VideoMetrics extends HeyApiClient {
|
|
228
|
+
getMyVideoMetrics(options) {
|
|
229
|
+
return (options?.client ?? this.client).get({ url: '/api/video-metrics/me', ...options });
|
|
230
|
+
}
|
|
231
|
+
}
|
|
224
232
|
export class Profile extends HeyApiClient {
|
|
225
233
|
getProfileMe(options) {
|
|
226
234
|
return (options?.client ?? this.client).get({ url: '/api/profile/me', ...options });
|
|
@@ -320,6 +328,9 @@ export class Documents extends HeyApiClient {
|
|
|
320
328
|
},
|
|
321
329
|
});
|
|
322
330
|
}
|
|
331
|
+
deleteDocument(options) {
|
|
332
|
+
return (options.client ?? this.client).delete({ url: '/api/documents/{id}', ...options });
|
|
333
|
+
}
|
|
323
334
|
}
|
|
324
335
|
export class Index extends HeyApiClient {
|
|
325
336
|
getCountries(options) {
|
|
@@ -616,6 +627,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
|
|
|
616
627
|
get measurements() {
|
|
617
628
|
return (this._measurements ?? (this._measurements = new Measurements({ client: this.client })));
|
|
618
629
|
}
|
|
630
|
+
get videoMetrics() {
|
|
631
|
+
return (this._videoMetrics ?? (this._videoMetrics = new VideoMetrics({ client: this.client })));
|
|
632
|
+
}
|
|
619
633
|
get profile() {
|
|
620
634
|
return (this._profile ?? (this._profile = new Profile({ client: this.client })));
|
|
621
635
|
}
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -104,6 +104,10 @@ export type DashboardResponseDto = {
|
|
|
104
104
|
* Total times this profile was viewed
|
|
105
105
|
*/
|
|
106
106
|
profileViewCount: number;
|
|
107
|
+
/**
|
|
108
|
+
* Distinct scout-side viewers for this profile since the current ISO week started
|
|
109
|
+
*/
|
|
110
|
+
weeklyUniqueScoutProfileViewCount: number;
|
|
107
111
|
/**
|
|
108
112
|
* Total offer conversations for the player
|
|
109
113
|
*/
|
|
@@ -389,6 +393,29 @@ export type MeasurementProfileResponseDto = {
|
|
|
389
393
|
session?: MeasurementSessionDto | null;
|
|
390
394
|
updatedAt?: string | null;
|
|
391
395
|
};
|
|
396
|
+
export type VideoMetricsPhysicalMetricsDto = {
|
|
397
|
+
totalDistance: string;
|
|
398
|
+
sprintDistance: string;
|
|
399
|
+
maxSpeed: string;
|
|
400
|
+
averageSpeed: string;
|
|
401
|
+
highIntensityRuns: number;
|
|
402
|
+
sprints: number;
|
|
403
|
+
};
|
|
404
|
+
export type VideoMetricsMeResponseDto = {
|
|
405
|
+
id: string;
|
|
406
|
+
/**
|
|
407
|
+
* When the analysis completed (ISO timestamp)
|
|
408
|
+
*/
|
|
409
|
+
createdAt: string;
|
|
410
|
+
videoDurationS?: number | null;
|
|
411
|
+
physicalMetrics: VideoMetricsPhysicalMetricsDto;
|
|
412
|
+
/**
|
|
413
|
+
* Tracking quality reported by the analysis service, e.g. "94.5%"
|
|
414
|
+
*/
|
|
415
|
+
trackingQuality?: string | null;
|
|
416
|
+
trackedFrames?: number | null;
|
|
417
|
+
totalFrames?: number | null;
|
|
418
|
+
};
|
|
392
419
|
export type PlayerReportViewDto = {
|
|
393
420
|
technicalPillar: string;
|
|
394
421
|
physicalPillar: string;
|
|
@@ -1289,6 +1316,14 @@ export type DocumentResponseDto = {
|
|
|
1289
1316
|
documentType?: string | null;
|
|
1290
1317
|
fileUrl?: string | null;
|
|
1291
1318
|
filePath?: string | null;
|
|
1319
|
+
/**
|
|
1320
|
+
* Original uploaded file size in bytes, when known.
|
|
1321
|
+
*/
|
|
1322
|
+
fileSizeBytes?: number | null;
|
|
1323
|
+
/**
|
|
1324
|
+
* Uploaded document MIME type, when known.
|
|
1325
|
+
*/
|
|
1326
|
+
mimeType?: string | null;
|
|
1292
1327
|
status?: string | null;
|
|
1293
1328
|
uploadedAt?: string | null;
|
|
1294
1329
|
};
|
|
@@ -1298,13 +1333,21 @@ export type CreateDocumentDto = {
|
|
|
1298
1333
|
*/
|
|
1299
1334
|
documentType: string;
|
|
1300
1335
|
/**
|
|
1301
|
-
*
|
|
1336
|
+
* Legacy public URL. Ignored for new private document uploads; server stores filePath instead.
|
|
1302
1337
|
*/
|
|
1303
|
-
fileUrl
|
|
1338
|
+
fileUrl?: string;
|
|
1304
1339
|
/**
|
|
1305
1340
|
* Storage path
|
|
1306
1341
|
*/
|
|
1307
1342
|
filePath: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Original uploaded file size in bytes.
|
|
1345
|
+
*/
|
|
1346
|
+
fileSizeBytes?: number;
|
|
1347
|
+
/**
|
|
1348
|
+
* Uploaded document MIME type.
|
|
1349
|
+
*/
|
|
1350
|
+
mimeType?: string;
|
|
1308
1351
|
/**
|
|
1309
1352
|
* KYC verification id this document belongs to
|
|
1310
1353
|
*/
|
|
@@ -2131,6 +2174,28 @@ export type GetApiPlayersByIdMeasurementsResponses = {
|
|
|
2131
2174
|
200: MeasurementProfileResponseDto;
|
|
2132
2175
|
};
|
|
2133
2176
|
export type GetApiPlayersByIdMeasurementsResponse = GetApiPlayersByIdMeasurementsResponses[keyof GetApiPlayersByIdMeasurementsResponses];
|
|
2177
|
+
export type GetApiPlayersByIdVideoMetricsData = {
|
|
2178
|
+
body?: never;
|
|
2179
|
+
path: {
|
|
2180
|
+
id: string;
|
|
2181
|
+
};
|
|
2182
|
+
query?: never;
|
|
2183
|
+
url: '/api/players/{id}/video-metrics';
|
|
2184
|
+
};
|
|
2185
|
+
export type GetApiPlayersByIdVideoMetricsErrors = {
|
|
2186
|
+
/**
|
|
2187
|
+
* Unauthorized
|
|
2188
|
+
*/
|
|
2189
|
+
401: unknown;
|
|
2190
|
+
/**
|
|
2191
|
+
* Player or video metrics not found
|
|
2192
|
+
*/
|
|
2193
|
+
404: unknown;
|
|
2194
|
+
};
|
|
2195
|
+
export type GetApiPlayersByIdVideoMetricsResponses = {
|
|
2196
|
+
200: VideoMetricsMeResponseDto;
|
|
2197
|
+
};
|
|
2198
|
+
export type GetApiPlayersByIdVideoMetricsResponse = GetApiPlayersByIdVideoMetricsResponses[keyof GetApiPlayersByIdVideoMetricsResponses];
|
|
2134
2199
|
export type GetApiPlayersByIdReportData = {
|
|
2135
2200
|
body?: never;
|
|
2136
2201
|
path: {
|
|
@@ -2440,6 +2505,29 @@ export type PostApiMeasurementsPlayerSessionMeResponses = {
|
|
|
2440
2505
|
201: MeasurementSessionDto;
|
|
2441
2506
|
};
|
|
2442
2507
|
export type PostApiMeasurementsPlayerSessionMeResponse = PostApiMeasurementsPlayerSessionMeResponses[keyof PostApiMeasurementsPlayerSessionMeResponses];
|
|
2508
|
+
export type GetApiVideoMetricsMeData = {
|
|
2509
|
+
body?: never;
|
|
2510
|
+
path?: never;
|
|
2511
|
+
query?: never;
|
|
2512
|
+
url: '/api/video-metrics/me';
|
|
2513
|
+
};
|
|
2514
|
+
export type GetApiVideoMetricsMeErrors = {
|
|
2515
|
+
/**
|
|
2516
|
+
* Unauthorized
|
|
2517
|
+
*/
|
|
2518
|
+
401: unknown;
|
|
2519
|
+
/**
|
|
2520
|
+
* No result found
|
|
2521
|
+
*/
|
|
2522
|
+
404: unknown;
|
|
2523
|
+
};
|
|
2524
|
+
export type GetApiVideoMetricsMeResponses = {
|
|
2525
|
+
/**
|
|
2526
|
+
* Latest completed Sprint & Speed Test result
|
|
2527
|
+
*/
|
|
2528
|
+
200: VideoMetricsMeResponseDto;
|
|
2529
|
+
};
|
|
2530
|
+
export type GetApiVideoMetricsMeResponse = GetApiVideoMetricsMeResponses[keyof GetApiVideoMetricsMeResponses];
|
|
2443
2531
|
export type GetApiProfileMeData = {
|
|
2444
2532
|
body?: never;
|
|
2445
2533
|
path?: never;
|
|
@@ -2736,6 +2824,31 @@ export type PostApiDocumentsResponses = {
|
|
|
2736
2824
|
201: DocumentResponseDto;
|
|
2737
2825
|
};
|
|
2738
2826
|
export type PostApiDocumentsResponse = PostApiDocumentsResponses[keyof PostApiDocumentsResponses];
|
|
2827
|
+
export type DeleteApiDocumentsByIdData = {
|
|
2828
|
+
body?: never;
|
|
2829
|
+
path: {
|
|
2830
|
+
id: string;
|
|
2831
|
+
};
|
|
2832
|
+
query?: never;
|
|
2833
|
+
url: '/api/documents/{id}';
|
|
2834
|
+
};
|
|
2835
|
+
export type DeleteApiDocumentsByIdErrors = {
|
|
2836
|
+
/**
|
|
2837
|
+
* Unauthorized
|
|
2838
|
+
*/
|
|
2839
|
+
401: unknown;
|
|
2840
|
+
/**
|
|
2841
|
+
* Document not found
|
|
2842
|
+
*/
|
|
2843
|
+
404: unknown;
|
|
2844
|
+
};
|
|
2845
|
+
export type DeleteApiDocumentsByIdResponses = {
|
|
2846
|
+
/**
|
|
2847
|
+
* Document deleted
|
|
2848
|
+
*/
|
|
2849
|
+
204: void;
|
|
2850
|
+
};
|
|
2851
|
+
export type DeleteApiDocumentsByIdResponse = DeleteApiDocumentsByIdResponses[keyof DeleteApiDocumentsByIdResponses];
|
|
2739
2852
|
export type GetApiIndexCountriesData = {
|
|
2740
2853
|
body?: never;
|
|
2741
2854
|
path?: never;
|
package/index.ts
CHANGED
|
@@ -24,6 +24,7 @@ export {
|
|
|
24
24
|
Storage,
|
|
25
25
|
Subscriptions,
|
|
26
26
|
Training,
|
|
27
|
+
VideoMetrics,
|
|
27
28
|
Videos,
|
|
28
29
|
} from './sdk.gen.js';
|
|
29
30
|
export type {
|
|
@@ -77,6 +78,10 @@ export type {
|
|
|
77
78
|
DeleteApiClubsMeByIdErrors,
|
|
78
79
|
DeleteApiClubsMeByIdResponse,
|
|
79
80
|
DeleteApiClubsMeByIdResponses,
|
|
81
|
+
DeleteApiDocumentsByIdData,
|
|
82
|
+
DeleteApiDocumentsByIdErrors,
|
|
83
|
+
DeleteApiDocumentsByIdResponse,
|
|
84
|
+
DeleteApiDocumentsByIdResponses,
|
|
80
85
|
DeleteApiInvitationsByIdData,
|
|
81
86
|
DeleteApiInvitationsByIdErrors,
|
|
82
87
|
DeleteApiInvitationsByIdResponse,
|
|
@@ -198,6 +203,10 @@ export type {
|
|
|
198
203
|
GetApiPlayersByIdReportResponses,
|
|
199
204
|
GetApiPlayersByIdResponse,
|
|
200
205
|
GetApiPlayersByIdResponses,
|
|
206
|
+
GetApiPlayersByIdVideoMetricsData,
|
|
207
|
+
GetApiPlayersByIdVideoMetricsErrors,
|
|
208
|
+
GetApiPlayersByIdVideoMetricsResponse,
|
|
209
|
+
GetApiPlayersByIdVideoMetricsResponses,
|
|
201
210
|
GetApiPlayersMeDashboardData,
|
|
202
211
|
GetApiPlayersMeDashboardErrors,
|
|
203
212
|
GetApiPlayersMeDashboardResponse,
|
|
@@ -228,6 +237,10 @@ export type {
|
|
|
228
237
|
GetApiTrainingGroupedResponses,
|
|
229
238
|
GetApiTrainingResponse,
|
|
230
239
|
GetApiTrainingResponses,
|
|
240
|
+
GetApiVideoMetricsMeData,
|
|
241
|
+
GetApiVideoMetricsMeErrors,
|
|
242
|
+
GetApiVideoMetricsMeResponse,
|
|
243
|
+
GetApiVideoMetricsMeResponses,
|
|
231
244
|
GetApiVideosByIdPlayUrlData,
|
|
232
245
|
GetApiVideosByIdPlayUrlErrors,
|
|
233
246
|
GetApiVideosByIdPlayUrlResponse,
|
|
@@ -441,6 +454,8 @@ export type {
|
|
|
441
454
|
UpdateProfileDto,
|
|
442
455
|
UploadUrlResponseDto,
|
|
443
456
|
UserAchievementResponseDto,
|
|
457
|
+
VideoMetricsMeResponseDto,
|
|
458
|
+
VideoMetricsPhysicalMetricsDto,
|
|
444
459
|
VideoResponseDto,
|
|
445
460
|
WatchingOrgDto,
|
|
446
461
|
WebhookPartnerParamsDto,
|
package/package.json
CHANGED
package/sdk.gen.ts
CHANGED
|
@@ -10,6 +10,9 @@ import type {
|
|
|
10
10
|
DeleteApiClubsMeByIdData,
|
|
11
11
|
DeleteApiClubsMeByIdErrors,
|
|
12
12
|
DeleteApiClubsMeByIdResponses,
|
|
13
|
+
DeleteApiDocumentsByIdData,
|
|
14
|
+
DeleteApiDocumentsByIdErrors,
|
|
15
|
+
DeleteApiDocumentsByIdResponses,
|
|
13
16
|
DeleteApiInvitationsByIdData,
|
|
14
17
|
DeleteApiInvitationsByIdErrors,
|
|
15
18
|
DeleteApiInvitationsByIdResponses,
|
|
@@ -97,6 +100,9 @@ import type {
|
|
|
97
100
|
GetApiPlayersByIdReportErrors,
|
|
98
101
|
GetApiPlayersByIdReportResponses,
|
|
99
102
|
GetApiPlayersByIdResponses,
|
|
103
|
+
GetApiPlayersByIdVideoMetricsData,
|
|
104
|
+
GetApiPlayersByIdVideoMetricsErrors,
|
|
105
|
+
GetApiPlayersByIdVideoMetricsResponses,
|
|
100
106
|
GetApiPlayersMeDashboardData,
|
|
101
107
|
GetApiPlayersMeDashboardErrors,
|
|
102
108
|
GetApiPlayersMeDashboardResponses,
|
|
@@ -119,6 +125,9 @@ import type {
|
|
|
119
125
|
GetApiTrainingGroupedErrors,
|
|
120
126
|
GetApiTrainingGroupedResponses,
|
|
121
127
|
GetApiTrainingResponses,
|
|
128
|
+
GetApiVideoMetricsMeData,
|
|
129
|
+
GetApiVideoMetricsMeErrors,
|
|
130
|
+
GetApiVideoMetricsMeResponses,
|
|
122
131
|
GetApiVideosByIdPlayUrlData,
|
|
123
132
|
GetApiVideosByIdPlayUrlErrors,
|
|
124
133
|
GetApiVideosByIdPlayUrlResponses,
|
|
@@ -380,6 +389,16 @@ export class Players extends HeyApiClient {
|
|
|
380
389
|
>({ url: '/api/players/{id}/measurements', ...options });
|
|
381
390
|
}
|
|
382
391
|
|
|
392
|
+
public getPlayerVideoMetrics<ThrowOnError extends boolean = false>(
|
|
393
|
+
options: Options<GetApiPlayersByIdVideoMetricsData, ThrowOnError>,
|
|
394
|
+
) {
|
|
395
|
+
return (options.client ?? this.client).get<
|
|
396
|
+
GetApiPlayersByIdVideoMetricsResponses,
|
|
397
|
+
GetApiPlayersByIdVideoMetricsErrors,
|
|
398
|
+
ThrowOnError
|
|
399
|
+
>({ url: '/api/players/{id}/video-metrics', ...options });
|
|
400
|
+
}
|
|
401
|
+
|
|
383
402
|
public getPlayerReport<ThrowOnError extends boolean = false>(
|
|
384
403
|
options: Options<GetApiPlayersByIdReportData, ThrowOnError>,
|
|
385
404
|
) {
|
|
@@ -684,6 +703,18 @@ export class Measurements extends HeyApiClient {
|
|
|
684
703
|
}
|
|
685
704
|
}
|
|
686
705
|
|
|
706
|
+
export class VideoMetrics extends HeyApiClient {
|
|
707
|
+
public getMyVideoMetrics<ThrowOnError extends boolean = false>(
|
|
708
|
+
options?: Options<GetApiVideoMetricsMeData, ThrowOnError>,
|
|
709
|
+
) {
|
|
710
|
+
return (options?.client ?? this.client).get<
|
|
711
|
+
GetApiVideoMetricsMeResponses,
|
|
712
|
+
GetApiVideoMetricsMeErrors,
|
|
713
|
+
ThrowOnError
|
|
714
|
+
>({ url: '/api/video-metrics/me', ...options });
|
|
715
|
+
}
|
|
716
|
+
}
|
|
717
|
+
|
|
687
718
|
export class Profile extends HeyApiClient {
|
|
688
719
|
public getProfileMe<ThrowOnError extends boolean = false>(
|
|
689
720
|
options?: Options<GetApiProfileMeData, ThrowOnError>,
|
|
@@ -887,6 +918,16 @@ export class Documents extends HeyApiClient {
|
|
|
887
918
|
},
|
|
888
919
|
});
|
|
889
920
|
}
|
|
921
|
+
|
|
922
|
+
public deleteDocument<ThrowOnError extends boolean = false>(
|
|
923
|
+
options: Options<DeleteApiDocumentsByIdData, ThrowOnError>,
|
|
924
|
+
) {
|
|
925
|
+
return (options.client ?? this.client).delete<
|
|
926
|
+
DeleteApiDocumentsByIdResponses,
|
|
927
|
+
DeleteApiDocumentsByIdErrors,
|
|
928
|
+
ThrowOnError
|
|
929
|
+
>({ url: '/api/documents/{id}', ...options });
|
|
930
|
+
}
|
|
890
931
|
}
|
|
891
932
|
|
|
892
933
|
export class Index extends HeyApiClient {
|
|
@@ -1451,6 +1492,11 @@ export class GlobalScoutMeClient extends HeyApiClient {
|
|
|
1451
1492
|
return (this._measurements ??= new Measurements({ client: this.client }));
|
|
1452
1493
|
}
|
|
1453
1494
|
|
|
1495
|
+
private _videoMetrics?: VideoMetrics;
|
|
1496
|
+
get videoMetrics(): VideoMetrics {
|
|
1497
|
+
return (this._videoMetrics ??= new VideoMetrics({ client: this.client }));
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1454
1500
|
private _profile?: Profile;
|
|
1455
1501
|
get profile(): Profile {
|
|
1456
1502
|
return (this._profile ??= new Profile({ client: this.client }));
|
package/types.gen.ts
CHANGED
|
@@ -110,6 +110,10 @@ export type DashboardResponseDto = {
|
|
|
110
110
|
* Total times this profile was viewed
|
|
111
111
|
*/
|
|
112
112
|
profileViewCount: number;
|
|
113
|
+
/**
|
|
114
|
+
* Distinct scout-side viewers for this profile since the current ISO week started
|
|
115
|
+
*/
|
|
116
|
+
weeklyUniqueScoutProfileViewCount: number;
|
|
113
117
|
/**
|
|
114
118
|
* Total offer conversations for the player
|
|
115
119
|
*/
|
|
@@ -421,6 +425,31 @@ export type MeasurementProfileResponseDto = {
|
|
|
421
425
|
updatedAt?: string | null;
|
|
422
426
|
};
|
|
423
427
|
|
|
428
|
+
export type VideoMetricsPhysicalMetricsDto = {
|
|
429
|
+
totalDistance: string;
|
|
430
|
+
sprintDistance: string;
|
|
431
|
+
maxSpeed: string;
|
|
432
|
+
averageSpeed: string;
|
|
433
|
+
highIntensityRuns: number;
|
|
434
|
+
sprints: number;
|
|
435
|
+
};
|
|
436
|
+
|
|
437
|
+
export type VideoMetricsMeResponseDto = {
|
|
438
|
+
id: string;
|
|
439
|
+
/**
|
|
440
|
+
* When the analysis completed (ISO timestamp)
|
|
441
|
+
*/
|
|
442
|
+
createdAt: string;
|
|
443
|
+
videoDurationS?: number | null;
|
|
444
|
+
physicalMetrics: VideoMetricsPhysicalMetricsDto;
|
|
445
|
+
/**
|
|
446
|
+
* Tracking quality reported by the analysis service, e.g. "94.5%"
|
|
447
|
+
*/
|
|
448
|
+
trackingQuality?: string | null;
|
|
449
|
+
trackedFrames?: number | null;
|
|
450
|
+
totalFrames?: number | null;
|
|
451
|
+
};
|
|
452
|
+
|
|
424
453
|
export type PlayerReportViewDto = {
|
|
425
454
|
technicalPillar: string;
|
|
426
455
|
physicalPillar: string;
|
|
@@ -1381,6 +1410,14 @@ export type DocumentResponseDto = {
|
|
|
1381
1410
|
documentType?: string | null;
|
|
1382
1411
|
fileUrl?: string | null;
|
|
1383
1412
|
filePath?: string | null;
|
|
1413
|
+
/**
|
|
1414
|
+
* Original uploaded file size in bytes, when known.
|
|
1415
|
+
*/
|
|
1416
|
+
fileSizeBytes?: number | null;
|
|
1417
|
+
/**
|
|
1418
|
+
* Uploaded document MIME type, when known.
|
|
1419
|
+
*/
|
|
1420
|
+
mimeType?: string | null;
|
|
1384
1421
|
status?: string | null;
|
|
1385
1422
|
uploadedAt?: string | null;
|
|
1386
1423
|
};
|
|
@@ -1391,13 +1428,21 @@ export type CreateDocumentDto = {
|
|
|
1391
1428
|
*/
|
|
1392
1429
|
documentType: string;
|
|
1393
1430
|
/**
|
|
1394
|
-
*
|
|
1431
|
+
* Legacy public URL. Ignored for new private document uploads; server stores filePath instead.
|
|
1395
1432
|
*/
|
|
1396
|
-
fileUrl
|
|
1433
|
+
fileUrl?: string;
|
|
1397
1434
|
/**
|
|
1398
1435
|
* Storage path
|
|
1399
1436
|
*/
|
|
1400
1437
|
filePath: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* Original uploaded file size in bytes.
|
|
1440
|
+
*/
|
|
1441
|
+
fileSizeBytes?: number;
|
|
1442
|
+
/**
|
|
1443
|
+
* Uploaded document MIME type.
|
|
1444
|
+
*/
|
|
1445
|
+
mimeType?: string;
|
|
1401
1446
|
/**
|
|
1402
1447
|
* KYC verification id this document belongs to
|
|
1403
1448
|
*/
|
|
@@ -2329,6 +2374,33 @@ export type GetApiPlayersByIdMeasurementsResponses = {
|
|
|
2329
2374
|
export type GetApiPlayersByIdMeasurementsResponse =
|
|
2330
2375
|
GetApiPlayersByIdMeasurementsResponses[keyof GetApiPlayersByIdMeasurementsResponses];
|
|
2331
2376
|
|
|
2377
|
+
export type GetApiPlayersByIdVideoMetricsData = {
|
|
2378
|
+
body?: never;
|
|
2379
|
+
path: {
|
|
2380
|
+
id: string;
|
|
2381
|
+
};
|
|
2382
|
+
query?: never;
|
|
2383
|
+
url: '/api/players/{id}/video-metrics';
|
|
2384
|
+
};
|
|
2385
|
+
|
|
2386
|
+
export type GetApiPlayersByIdVideoMetricsErrors = {
|
|
2387
|
+
/**
|
|
2388
|
+
* Unauthorized
|
|
2389
|
+
*/
|
|
2390
|
+
401: unknown;
|
|
2391
|
+
/**
|
|
2392
|
+
* Player or video metrics not found
|
|
2393
|
+
*/
|
|
2394
|
+
404: unknown;
|
|
2395
|
+
};
|
|
2396
|
+
|
|
2397
|
+
export type GetApiPlayersByIdVideoMetricsResponses = {
|
|
2398
|
+
200: VideoMetricsMeResponseDto;
|
|
2399
|
+
};
|
|
2400
|
+
|
|
2401
|
+
export type GetApiPlayersByIdVideoMetricsResponse =
|
|
2402
|
+
GetApiPlayersByIdVideoMetricsResponses[keyof GetApiPlayersByIdVideoMetricsResponses];
|
|
2403
|
+
|
|
2332
2404
|
export type GetApiPlayersByIdReportData = {
|
|
2333
2405
|
body?: never;
|
|
2334
2406
|
path: {
|
|
@@ -2719,6 +2791,34 @@ export type PostApiMeasurementsPlayerSessionMeResponses = {
|
|
|
2719
2791
|
export type PostApiMeasurementsPlayerSessionMeResponse =
|
|
2720
2792
|
PostApiMeasurementsPlayerSessionMeResponses[keyof PostApiMeasurementsPlayerSessionMeResponses];
|
|
2721
2793
|
|
|
2794
|
+
export type GetApiVideoMetricsMeData = {
|
|
2795
|
+
body?: never;
|
|
2796
|
+
path?: never;
|
|
2797
|
+
query?: never;
|
|
2798
|
+
url: '/api/video-metrics/me';
|
|
2799
|
+
};
|
|
2800
|
+
|
|
2801
|
+
export type GetApiVideoMetricsMeErrors = {
|
|
2802
|
+
/**
|
|
2803
|
+
* Unauthorized
|
|
2804
|
+
*/
|
|
2805
|
+
401: unknown;
|
|
2806
|
+
/**
|
|
2807
|
+
* No result found
|
|
2808
|
+
*/
|
|
2809
|
+
404: unknown;
|
|
2810
|
+
};
|
|
2811
|
+
|
|
2812
|
+
export type GetApiVideoMetricsMeResponses = {
|
|
2813
|
+
/**
|
|
2814
|
+
* Latest completed Sprint & Speed Test result
|
|
2815
|
+
*/
|
|
2816
|
+
200: VideoMetricsMeResponseDto;
|
|
2817
|
+
};
|
|
2818
|
+
|
|
2819
|
+
export type GetApiVideoMetricsMeResponse =
|
|
2820
|
+
GetApiVideoMetricsMeResponses[keyof GetApiVideoMetricsMeResponses];
|
|
2821
|
+
|
|
2722
2822
|
export type GetApiProfileMeData = {
|
|
2723
2823
|
body?: never;
|
|
2724
2824
|
path?: never;
|
|
@@ -3089,6 +3189,36 @@ export type PostApiDocumentsResponses = {
|
|
|
3089
3189
|
export type PostApiDocumentsResponse =
|
|
3090
3190
|
PostApiDocumentsResponses[keyof PostApiDocumentsResponses];
|
|
3091
3191
|
|
|
3192
|
+
export type DeleteApiDocumentsByIdData = {
|
|
3193
|
+
body?: never;
|
|
3194
|
+
path: {
|
|
3195
|
+
id: string;
|
|
3196
|
+
};
|
|
3197
|
+
query?: never;
|
|
3198
|
+
url: '/api/documents/{id}';
|
|
3199
|
+
};
|
|
3200
|
+
|
|
3201
|
+
export type DeleteApiDocumentsByIdErrors = {
|
|
3202
|
+
/**
|
|
3203
|
+
* Unauthorized
|
|
3204
|
+
*/
|
|
3205
|
+
401: unknown;
|
|
3206
|
+
/**
|
|
3207
|
+
* Document not found
|
|
3208
|
+
*/
|
|
3209
|
+
404: unknown;
|
|
3210
|
+
};
|
|
3211
|
+
|
|
3212
|
+
export type DeleteApiDocumentsByIdResponses = {
|
|
3213
|
+
/**
|
|
3214
|
+
* Document deleted
|
|
3215
|
+
*/
|
|
3216
|
+
204: void;
|
|
3217
|
+
};
|
|
3218
|
+
|
|
3219
|
+
export type DeleteApiDocumentsByIdResponse =
|
|
3220
|
+
DeleteApiDocumentsByIdResponses[keyof DeleteApiDocumentsByIdResponses];
|
|
3221
|
+
|
|
3092
3222
|
export type GetApiIndexCountriesData = {
|
|
3093
3223
|
body?: never;
|
|
3094
3224
|
path?: never;
|