@globalscoutme/api-client 1.0.13 → 1.0.15
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 +197 -119
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/sdk.gen.d.ts +82 -30
- package/dist/sdk.gen.js +143 -29
- package/dist/types.gen.d.ts +603 -144
- package/index.ts +191 -114
- package/package.json +1 -1
- package/sdk.gen.ts +471 -201
- package/types.gen.ts +719 -170
package/README.md
CHANGED
|
@@ -1,119 +1,197 @@
|
|
|
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
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
await
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
await
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
await
|
|
84
|
-
await
|
|
85
|
-
|
|
86
|
-
//
|
|
87
|
-
const
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
});
|
|
93
|
-
|
|
94
|
-
//
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
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
|
+
Players,
|
|
34
|
+
Profile,
|
|
35
|
+
Documents,
|
|
36
|
+
Videos,
|
|
37
|
+
Achievements,
|
|
38
|
+
Body,
|
|
39
|
+
Index,
|
|
40
|
+
Offers,
|
|
41
|
+
Organizations,
|
|
42
|
+
Clubs,
|
|
43
|
+
Challenges,
|
|
44
|
+
Training,
|
|
45
|
+
Invitations,
|
|
46
|
+
Storage,
|
|
47
|
+
} from '@globalscoutme/api-client';
|
|
48
|
+
|
|
49
|
+
// Auth
|
|
50
|
+
const authMe = await Auth.getAuthMe();
|
|
51
|
+
// Returns { id: string, userType: string | null }
|
|
52
|
+
|
|
53
|
+
// Players
|
|
54
|
+
const player = await Players.getMe();
|
|
55
|
+
await Players.patchMe({ body: { fullName: 'John Doe' } });
|
|
56
|
+
await Players.deleteMe();
|
|
57
|
+
const dashboard = await Players.getMyDashboard();
|
|
58
|
+
await Players.heartbeat({ body: { timezone: 'Europe/Bucharest' } });
|
|
59
|
+
const results = await Players.searchPlayers({
|
|
60
|
+
body: {
|
|
61
|
+
search: 'John',
|
|
62
|
+
page: 1,
|
|
63
|
+
pageSize: 20,
|
|
64
|
+
sortBy: 'age_asc',
|
|
65
|
+
nationalities: ['EG', 'MA'],
|
|
66
|
+
positions: ['CM', 'CB'],
|
|
67
|
+
baseFoot: 'right',
|
|
68
|
+
isFreeAgent: true,
|
|
69
|
+
hasVideo: true,
|
|
70
|
+
heightOperator: 'gte',
|
|
71
|
+
heightCm: 180,
|
|
72
|
+
},
|
|
73
|
+
});
|
|
74
|
+
const playerProfile = await Players.getPlayerById({
|
|
75
|
+
path: { id: 'player-uuid' },
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
// Profile
|
|
79
|
+
const profile = await Profile.getProfileMe();
|
|
80
|
+
await Profile.updateProfileMe({ body: { dominantFoot: 'Right' } });
|
|
81
|
+
|
|
82
|
+
// Documents
|
|
83
|
+
const docs = await Documents.getMyDocuments();
|
|
84
|
+
await Documents.createDocument({ body: { type: 'license' } });
|
|
85
|
+
|
|
86
|
+
// Videos
|
|
87
|
+
const videos = await Videos.getMyVideos();
|
|
88
|
+
await Videos.createVideo({
|
|
89
|
+
body: { type: 'cmj', storagePath: 'path/to/video' },
|
|
90
|
+
});
|
|
91
|
+
const playUrl = await Videos.getVideoPlayUrl({ path: { id: 'video-uuid' } });
|
|
92
|
+
await Videos.deleteVideo({ path: { id: 'video-uuid' } });
|
|
93
|
+
|
|
94
|
+
// Achievements
|
|
95
|
+
const catalog = await Achievements.getAchievementsCatalog();
|
|
96
|
+
const myAchievements = await Achievements.getMyAchievements();
|
|
97
|
+
|
|
98
|
+
// Body measurements
|
|
99
|
+
const measurement = await Body.getMyMeasurements();
|
|
100
|
+
await Body.createMeasurement({ body: { heightCm: 180 } });
|
|
101
|
+
|
|
102
|
+
// Index (lookup tables)
|
|
103
|
+
const positions = await Index.getIndexItems({
|
|
104
|
+
path: { tableName: 'positions' },
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
// Offers (conversations between scouts and players)
|
|
108
|
+
const conversations = await Offers.listConversations({
|
|
109
|
+
query: { filter: 'all', page: 1, pageSize: 20 },
|
|
110
|
+
});
|
|
111
|
+
const conversation = await Offers.createConversation({
|
|
112
|
+
body: { playerId: 'player-uuid', initialMessage: 'Hi!' },
|
|
113
|
+
});
|
|
114
|
+
const messages = await Offers.listMessages({
|
|
115
|
+
path: { id: 'conversation-uuid' },
|
|
116
|
+
query: { page: 1, pageSize: 20 },
|
|
117
|
+
});
|
|
118
|
+
await Offers.sendMessage({
|
|
119
|
+
path: { id: 'conversation-uuid' },
|
|
120
|
+
body: { body: 'Looking forward to it!' },
|
|
121
|
+
});
|
|
122
|
+
await Offers.markConversationRead({ path: { id: 'conversation-uuid' } });
|
|
123
|
+
|
|
124
|
+
// Organizations
|
|
125
|
+
const org = await Organizations.getMyOrganization();
|
|
126
|
+
await Organizations.updateMyOrganization({ body: { name: 'FC Example' } });
|
|
127
|
+
await Organizations.registerClub({
|
|
128
|
+
body: { name: 'FC Example', email: 'admin@example.com' },
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
// Clubs (coach/admin club entries within an organization)
|
|
132
|
+
const clubs = await Clubs.getMyClubs();
|
|
133
|
+
const club = await Clubs.createMyClub({ body: { name: 'U19 Team' } });
|
|
134
|
+
await Clubs.updateMyClub({
|
|
135
|
+
path: { id: 'club-uuid' },
|
|
136
|
+
body: { name: 'U21 Team' },
|
|
137
|
+
});
|
|
138
|
+
await Clubs.deleteMyClub({ path: { id: 'club-uuid' } });
|
|
139
|
+
|
|
140
|
+
// Challenges
|
|
141
|
+
const challengeCatalog = await Challenges.getChallengesCatalog();
|
|
142
|
+
const myChallenges = await Challenges.getMyChallenges();
|
|
143
|
+
|
|
144
|
+
// Training
|
|
145
|
+
const grouped = await Training.getTrainingGrouped();
|
|
146
|
+
const trainingList = await Training.getTrainingList({
|
|
147
|
+
query: { categoryCode: 'fitness', page: 1, pageSize: 20 },
|
|
148
|
+
});
|
|
149
|
+
const trainingItem = await Training.getTrainingById({
|
|
150
|
+
path: { id: 'training-uuid' },
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
// Invitations (org admin invites members)
|
|
154
|
+
await Invitations.sendInvitation({
|
|
155
|
+
body: { email: 'coach@example.com', role: 'coach' },
|
|
156
|
+
});
|
|
157
|
+
const invitations = await Invitations.listInvitations();
|
|
158
|
+
await Invitations.resendInvitation({ path: { id: 'invitation-uuid' } });
|
|
159
|
+
await Invitations.deleteInvitation({ path: { id: 'invitation-uuid' } });
|
|
160
|
+
await Invitations.acceptInvitation(); // called after Supabase auth callback
|
|
161
|
+
|
|
162
|
+
// Storage — get a signed upload URL, then PUT the file directly to Supabase Storage
|
|
163
|
+
const { uploadUrl, token, path, bucket, expiresIn } =
|
|
164
|
+
await Storage.createUploadUrl({
|
|
165
|
+
body: { bucket: 'avatars', contentType: 'image/jpeg', sizeBytes: 204800 },
|
|
166
|
+
});
|
|
167
|
+
await fetch(uploadUrl, {
|
|
168
|
+
method: 'PUT',
|
|
169
|
+
body: fileBlob,
|
|
170
|
+
headers: { 'Content-Type': 'image/jpeg' },
|
|
171
|
+
});
|
|
172
|
+
// persist `path` on the player record (e.g. patchMe with avatarPath: path)
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Updating auth token
|
|
176
|
+
|
|
177
|
+
Update the Bearer token after sign-in or token refresh:
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
client.setConfig({
|
|
181
|
+
headers: {
|
|
182
|
+
Authorization: `Bearer ${newAccessToken}`,
|
|
183
|
+
},
|
|
184
|
+
});
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## Versioning
|
|
188
|
+
|
|
189
|
+
This package is auto-generated from the backend OpenAPI spec. Version increments follow semver:
|
|
190
|
+
|
|
191
|
+
- **patch** — no API shape changes
|
|
192
|
+
- **minor** — new endpoints added
|
|
193
|
+
- **major** — breaking changes (renamed/removed endpoints or fields)
|
|
194
|
+
|
|
195
|
+
## Package format
|
|
196
|
+
|
|
197
|
+
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,3 +1,3 @@
|
|
|
1
|
-
export { Achievements, Auth, Body, Documents, GlobalScoutMeClient, Index, Offers, type Options, Organizations, Players, Profile, Storage, Videos, } from './sdk.gen.js';
|
|
2
|
-
export type { AchievementCatalogDto, AuthMeResponseDto, BodyMeasurementResponseDto, CareerAchievementDto, ClientOptions, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationParticipantDto, CreateBodyMeasurementDto, CreateConversationDto, CreateDocumentDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto,
|
|
1
|
+
export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Offers, type Options, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
|
|
2
|
+
export type { AchievementCatalogDto, AuthMeResponseDto, BodyMeasurementResponseDto, CareerAchievementDto, ChallengeCatalogDto, ClientOptions, ClubResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CreateBodyMeasurementDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateUploadUrlDto, CreateVideoDto, DashboardResponseDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponse, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponse, GetApiTrainingGroupedResponses, GetApiTrainingResponse, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponse, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponse, GetApiVideosMeResponses, HeartbeatDto, HeartbeatResponseDto, IndexItemDto, InvitationResponseDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponse, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponse, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponse, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponse, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponse, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponse, PostApiInvitationsResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RegisterClubDto, RegisterClubResponseDto, SendInvitationRequestDto, SendMessageDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, } from './types.gen.js';
|
|
3
3
|
export { client, type CreateClientConfig } from './client.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, Body, Documents, GlobalScoutMeClient, Index, Offers, Organizations, Players, Profile, Storage, Videos, } from './sdk.gen.js';
|
|
2
|
+
export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Offers, Organizations, Players, Profile, Storage, Training, 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 {
|
|
2
|
+
import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiTrainingByIdData, GetApiTrainingByIdErrors, GetApiTrainingByIdResponses, GetApiTrainingData, GetApiTrainingErrors, GetApiTrainingGroupedData, GetApiTrainingGroupedErrors, GetApiTrainingGroupedResponses, GetApiTrainingResponses, GetApiVideosByIdPlayUrlData, GetApiVideosByIdPlayUrlErrors, GetApiVideosByIdPlayUrlResponses, GetApiVideosMeData, GetApiVideosMeErrors, GetApiVideosMeResponses, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, 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
|
|
@@ -26,55 +26,99 @@ declare class HeyApiRegistry<T> {
|
|
|
26
26
|
set(value: T, key?: string): void;
|
|
27
27
|
}
|
|
28
28
|
export declare class Auth extends HeyApiClient {
|
|
29
|
-
getAuthMe<ThrowOnError extends boolean = false>(options?: Options<
|
|
29
|
+
getAuthMe<ThrowOnError extends boolean = false>(options?: Options<GetApiAuthMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiAuthMeResponses, GetApiAuthMeErrors, ThrowOnError, "fields">;
|
|
30
30
|
}
|
|
31
31
|
export declare class Players extends HeyApiClient {
|
|
32
|
-
deleteMe<ThrowOnError extends boolean = false>(options?: Options<
|
|
33
|
-
getMe<ThrowOnError extends boolean = false>(options?: Options<
|
|
34
|
-
patchMe<ThrowOnError extends boolean = false>(options: Options<
|
|
35
|
-
getMyDashboard<ThrowOnError extends boolean = false>(options?: Options<
|
|
36
|
-
|
|
37
|
-
|
|
32
|
+
deleteMe<ThrowOnError extends boolean = false>(options?: Options<DeleteApiPlayersMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiPlayersMeResponses, DeleteApiPlayersMeErrors, ThrowOnError, "fields">;
|
|
33
|
+
getMe<ThrowOnError extends boolean = false>(options?: Options<GetApiPlayersMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersMeResponses, GetApiPlayersMeErrors, ThrowOnError, "fields">;
|
|
34
|
+
patchMe<ThrowOnError extends boolean = false>(options: Options<PatchApiPlayersMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchApiPlayersMeResponses, PatchApiPlayersMeErrors, ThrowOnError, "fields">;
|
|
35
|
+
getMyDashboard<ThrowOnError extends boolean = false>(options?: Options<GetApiPlayersMeDashboardData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersMeDashboardResponses, GetApiPlayersMeDashboardErrors, ThrowOnError, "fields">;
|
|
36
|
+
/**
|
|
37
|
+
* Ping presence; records login day and updates user timezone
|
|
38
|
+
*/
|
|
39
|
+
heartbeat<ThrowOnError extends boolean = false>(options: Options<PostApiPlayersMeHeartbeatData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiPlayersMeHeartbeatResponses, PostApiPlayersMeHeartbeatErrors, ThrowOnError, "fields">;
|
|
40
|
+
searchPlayers<ThrowOnError extends boolean = false>(options: Options<PostApiPlayersSearchData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiPlayersSearchResponses, PostApiPlayersSearchErrors, ThrowOnError, "fields">;
|
|
41
|
+
getPlayerById<ThrowOnError extends boolean = false>(options: Options<GetApiPlayersByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiPlayersByIdResponses, GetApiPlayersByIdErrors, ThrowOnError, "fields">;
|
|
38
42
|
}
|
|
39
43
|
export declare class Profile extends HeyApiClient {
|
|
40
|
-
getProfileMe<ThrowOnError extends boolean = false>(options?: Options<
|
|
41
|
-
updateProfileMe<ThrowOnError extends boolean = false>(options: Options<
|
|
44
|
+
getProfileMe<ThrowOnError extends boolean = false>(options?: Options<GetApiProfileMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiProfileMeResponses, GetApiProfileMeErrors, ThrowOnError, "fields">;
|
|
45
|
+
updateProfileMe<ThrowOnError extends boolean = false>(options: Options<PutApiProfileMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutApiProfileMeResponses, PutApiProfileMeErrors, ThrowOnError, "fields">;
|
|
42
46
|
}
|
|
43
47
|
export declare class Achievements extends HeyApiClient {
|
|
44
|
-
getAchievementsCatalog<ThrowOnError extends boolean = false>(options?: Options<
|
|
45
|
-
getMyAchievements<ThrowOnError extends boolean = false>(options?: Options<
|
|
48
|
+
getAchievementsCatalog<ThrowOnError extends boolean = false>(options?: Options<GetApiAchievementsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiAchievementsResponses, unknown, ThrowOnError, "fields">;
|
|
49
|
+
getMyAchievements<ThrowOnError extends boolean = false>(options?: Options<GetApiAchievementsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiAchievementsMeResponses, GetApiAchievementsMeErrors, ThrowOnError, "fields">;
|
|
46
50
|
}
|
|
47
51
|
export declare class Body extends HeyApiClient {
|
|
48
|
-
getMyMeasurements<ThrowOnError extends boolean = false>(options?: Options<
|
|
49
|
-
createMeasurement<ThrowOnError extends boolean = false>(options: Options<
|
|
52
|
+
getMyMeasurements<ThrowOnError extends boolean = false>(options?: Options<GetApiBodyMeasurementsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiBodyMeasurementsMeResponses, GetApiBodyMeasurementsMeErrors, ThrowOnError, "fields">;
|
|
53
|
+
createMeasurement<ThrowOnError extends boolean = false>(options: Options<PostApiBodyMeasurementsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiBodyMeasurementsResponses, PostApiBodyMeasurementsErrors, ThrowOnError, "fields">;
|
|
54
|
+
}
|
|
55
|
+
export declare class Challenges extends HeyApiClient {
|
|
56
|
+
/**
|
|
57
|
+
* List all active challenges
|
|
58
|
+
*/
|
|
59
|
+
getChallengesCatalog<ThrowOnError extends boolean = false>(options?: Options<GetApiChallengesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiChallengesResponses, GetApiChallengesErrors, ThrowOnError, "fields">;
|
|
60
|
+
/**
|
|
61
|
+
* Get the current user's active + recently-expired challenges
|
|
62
|
+
*/
|
|
63
|
+
getMyChallenges<ThrowOnError extends boolean = false>(options?: Options<GetApiChallengesMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiChallengesMeResponses, GetApiChallengesMeErrors, ThrowOnError, "fields">;
|
|
64
|
+
}
|
|
65
|
+
export declare class Clubs extends HeyApiClient {
|
|
66
|
+
getMyClubs<ThrowOnError extends boolean = false>(options?: Options<GetApiClubsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiClubsMeResponses, GetApiClubsMeErrors, ThrowOnError, "fields">;
|
|
67
|
+
createMyClub<ThrowOnError extends boolean = false>(options: Options<PostApiClubsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiClubsMeResponses, PostApiClubsMeErrors, ThrowOnError, "fields">;
|
|
68
|
+
deleteMyClub<ThrowOnError extends boolean = false>(options: Options<DeleteApiClubsMeByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiClubsMeByIdResponses, DeleteApiClubsMeByIdErrors, ThrowOnError, "fields">;
|
|
69
|
+
updateMyClub<ThrowOnError extends boolean = false>(options: Options<PatchApiClubsMeByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchApiClubsMeByIdResponses, PatchApiClubsMeByIdErrors, ThrowOnError, "fields">;
|
|
50
70
|
}
|
|
51
71
|
export declare class Documents extends HeyApiClient {
|
|
52
|
-
getMyDocuments<ThrowOnError extends boolean = false>(options?: Options<
|
|
53
|
-
createDocument<ThrowOnError extends boolean = false>(options: Options<
|
|
72
|
+
getMyDocuments<ThrowOnError extends boolean = false>(options?: Options<GetApiDocumentsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiDocumentsMeResponses, GetApiDocumentsMeErrors, ThrowOnError, "fields">;
|
|
73
|
+
createDocument<ThrowOnError extends boolean = false>(options: Options<PostApiDocumentsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiDocumentsResponses, PostApiDocumentsErrors, ThrowOnError, "fields">;
|
|
54
74
|
}
|
|
55
75
|
export declare class Index extends HeyApiClient {
|
|
56
|
-
getIndexItems<ThrowOnError extends boolean = false>(options: Options<
|
|
76
|
+
getIndexItems<ThrowOnError extends boolean = false>(options: Options<GetApiIndexByTableNameData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiIndexByTableNameResponses, GetApiIndexByTableNameErrors, ThrowOnError, "fields">;
|
|
57
77
|
}
|
|
58
78
|
export declare class Offers extends HeyApiClient {
|
|
59
|
-
listConversations<ThrowOnError extends boolean = false>(options?: Options<
|
|
60
|
-
createConversation<ThrowOnError extends boolean = false>(options: Options<
|
|
61
|
-
listMessages<ThrowOnError extends boolean = false>(options: Options<
|
|
62
|
-
sendMessage<ThrowOnError extends boolean = false>(options: Options<
|
|
63
|
-
markConversationRead<ThrowOnError extends boolean = false>(options: Options<
|
|
79
|
+
listConversations<ThrowOnError extends boolean = false>(options?: Options<GetApiOffersConversationsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiOffersConversationsResponses, GetApiOffersConversationsErrors, ThrowOnError, "fields">;
|
|
80
|
+
createConversation<ThrowOnError extends boolean = false>(options: Options<PostApiOffersConversationsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOffersConversationsResponses, PostApiOffersConversationsErrors, ThrowOnError, "fields">;
|
|
81
|
+
listMessages<ThrowOnError extends boolean = false>(options: Options<GetApiOffersConversationsByIdMessagesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsByIdMessagesErrors, ThrowOnError, "fields">;
|
|
82
|
+
sendMessage<ThrowOnError extends boolean = false>(options: Options<PostApiOffersConversationsByIdMessagesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsByIdMessagesErrors, ThrowOnError, "fields">;
|
|
83
|
+
markConversationRead<ThrowOnError extends boolean = false>(options: Options<PatchApiOffersConversationsByIdReadData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchApiOffersConversationsByIdReadResponses, PatchApiOffersConversationsByIdReadErrors, ThrowOnError, "fields">;
|
|
64
84
|
}
|
|
65
85
|
export declare class Organizations extends HeyApiClient {
|
|
66
|
-
registerClub<ThrowOnError extends boolean = false>(options: Options<
|
|
67
|
-
getMyOrganization<ThrowOnError extends boolean = false>(options?: Options<
|
|
68
|
-
updateMyOrganization<ThrowOnError extends boolean = false>(options: Options<
|
|
86
|
+
registerClub<ThrowOnError extends boolean = false>(options: Options<PostApiOrganizationsRegisterClubData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOrganizationsRegisterClubResponses, PostApiOrganizationsRegisterClubErrors, ThrowOnError, "fields">;
|
|
87
|
+
getMyOrganization<ThrowOnError extends boolean = false>(options?: Options<GetApiOrganizationsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiOrganizationsMeResponses, GetApiOrganizationsMeErrors, ThrowOnError, "fields">;
|
|
88
|
+
updateMyOrganization<ThrowOnError extends boolean = false>(options: Options<PutApiOrganizationsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutApiOrganizationsMeResponses, PutApiOrganizationsMeErrors, ThrowOnError, "fields">;
|
|
69
89
|
}
|
|
70
90
|
export declare class Storage extends HeyApiClient {
|
|
71
|
-
createUploadUrl<ThrowOnError extends boolean = false>(options: Options<
|
|
91
|
+
createUploadUrl<ThrowOnError extends boolean = false>(options: Options<PostApiStorageUploadUrlData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiStorageUploadUrlResponses, PostApiStorageUploadUrlErrors, ThrowOnError, "fields">;
|
|
92
|
+
}
|
|
93
|
+
export declare class Invitations extends HeyApiClient {
|
|
94
|
+
listInvitations<ThrowOnError extends boolean = false>(options?: Options<GetApiInvitationsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiInvitationsResponses, unknown, ThrowOnError, "fields">;
|
|
95
|
+
sendInvitation<ThrowOnError extends boolean = false>(options: Options<PostApiInvitationsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiInvitationsResponses, PostApiInvitationsErrors, ThrowOnError, "fields">;
|
|
96
|
+
resendInvitation<ThrowOnError extends boolean = false>(options: Options<PostApiInvitationsByIdResendData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiInvitationsByIdResendResponses, PostApiInvitationsByIdResendErrors, ThrowOnError, "fields">;
|
|
97
|
+
deleteInvitation<ThrowOnError extends boolean = false>(options: Options<DeleteApiInvitationsByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiInvitationsByIdResponses, DeleteApiInvitationsByIdErrors, ThrowOnError, "fields">;
|
|
98
|
+
/**
|
|
99
|
+
* Called by web app after Supabase auth callback to link invitee to their organization
|
|
100
|
+
*/
|
|
101
|
+
acceptInvitation<ThrowOnError extends boolean = false>(options?: Options<PostApiInvitationsAcceptData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiInvitationsAcceptResponses, unknown, ThrowOnError, "fields">;
|
|
102
|
+
}
|
|
103
|
+
export declare class Training extends HeyApiClient {
|
|
104
|
+
/**
|
|
105
|
+
* Get training content grouped by category, top 3 per category
|
|
106
|
+
*/
|
|
107
|
+
getTrainingGrouped<ThrowOnError extends boolean = false>(options?: Options<GetApiTrainingGroupedData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiTrainingGroupedResponses, GetApiTrainingGroupedErrors, ThrowOnError, "fields">;
|
|
108
|
+
/**
|
|
109
|
+
* List training content, optionally filtered by category
|
|
110
|
+
*/
|
|
111
|
+
getTrainingList<ThrowOnError extends boolean = false>(options?: Options<GetApiTrainingData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiTrainingResponses, GetApiTrainingErrors, ThrowOnError, "fields">;
|
|
112
|
+
/**
|
|
113
|
+
* Get full detail of a training content item
|
|
114
|
+
*/
|
|
115
|
+
getTrainingById<ThrowOnError extends boolean = false>(options: Options<GetApiTrainingByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiTrainingByIdResponses, GetApiTrainingByIdErrors, ThrowOnError, "fields">;
|
|
72
116
|
}
|
|
73
117
|
export declare class Videos extends HeyApiClient {
|
|
74
|
-
getMyVideos<ThrowOnError extends boolean = false>(options: Options<
|
|
75
|
-
createVideo<ThrowOnError extends boolean = false>(options: Options<
|
|
76
|
-
getVideoPlayUrl<ThrowOnError extends boolean = false>(options: Options<
|
|
77
|
-
deleteVideo<ThrowOnError extends boolean = false>(options: Options<
|
|
118
|
+
getMyVideos<ThrowOnError extends boolean = false>(options: Options<GetApiVideosMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiVideosMeResponses, GetApiVideosMeErrors, ThrowOnError, "fields">;
|
|
119
|
+
createVideo<ThrowOnError extends boolean = false>(options: Options<PostApiVideosData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiVideosResponses, PostApiVideosErrors, ThrowOnError, "fields">;
|
|
120
|
+
getVideoPlayUrl<ThrowOnError extends boolean = false>(options: Options<GetApiVideosByIdPlayUrlData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiVideosByIdPlayUrlResponses, GetApiVideosByIdPlayUrlErrors, ThrowOnError, "fields">;
|
|
121
|
+
deleteVideo<ThrowOnError extends boolean = false>(options: Options<DeleteApiVideosByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiVideosByIdResponses, DeleteApiVideosByIdErrors, ThrowOnError, "fields">;
|
|
78
122
|
}
|
|
79
123
|
export declare class GlobalScoutMeClient extends HeyApiClient {
|
|
80
124
|
static readonly __registry: HeyApiRegistry<GlobalScoutMeClient>;
|
|
@@ -92,6 +136,10 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
|
|
|
92
136
|
get achievements(): Achievements;
|
|
93
137
|
private _body?;
|
|
94
138
|
get body(): Body;
|
|
139
|
+
private _challenges?;
|
|
140
|
+
get challenges(): Challenges;
|
|
141
|
+
private _clubs?;
|
|
142
|
+
get clubs(): Clubs;
|
|
95
143
|
private _documents?;
|
|
96
144
|
get documents(): Documents;
|
|
97
145
|
private _index?;
|
|
@@ -102,6 +150,10 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
|
|
|
102
150
|
get organizations(): Organizations;
|
|
103
151
|
private _storage?;
|
|
104
152
|
get storage(): Storage;
|
|
153
|
+
private _invitations?;
|
|
154
|
+
get invitations(): Invitations;
|
|
155
|
+
private _training?;
|
|
156
|
+
get training(): Training;
|
|
105
157
|
private _videos?;
|
|
106
158
|
get videos(): Videos;
|
|
107
159
|
}
|