@globalscoutme/api-client 1.0.19 → 1.0.21
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 +217 -199
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/sdk.gen.d.ts +26 -1
- package/dist/sdk.gen.js +73 -0
- package/dist/types.gen.d.ts +270 -0
- package/index.ts +33 -0
- package/package.json +1 -1
- package/sdk.gen.ts +135 -0
- package/types.gen.ts +319 -0
package/README.md
CHANGED
|
@@ -1,199 +1,217 @@
|
|
|
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
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
await Players.
|
|
56
|
-
await Players.
|
|
57
|
-
|
|
58
|
-
await Players.
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
await Profile.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
await Documents.
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
await Videos.
|
|
89
|
-
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
await Videos.
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
const
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
await Body.
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
await Organizations.
|
|
129
|
-
await Organizations.
|
|
130
|
-
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
const
|
|
136
|
-
await Clubs.
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
const
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
const
|
|
149
|
-
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
await Invitations.
|
|
161
|
-
await Invitations.
|
|
162
|
-
await Invitations.
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
});
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
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
|
+
Kyc,
|
|
41
|
+
Offers,
|
|
42
|
+
Organizations,
|
|
43
|
+
Clubs,
|
|
44
|
+
Challenges,
|
|
45
|
+
Training,
|
|
46
|
+
Invitations,
|
|
47
|
+
Storage,
|
|
48
|
+
} from '@globalscoutme/api-client';
|
|
49
|
+
|
|
50
|
+
// Auth
|
|
51
|
+
const authMe = await Auth.getAuthMe();
|
|
52
|
+
// Returns { id: string, userType: string | null }
|
|
53
|
+
|
|
54
|
+
// Players
|
|
55
|
+
const player = await Players.getMe();
|
|
56
|
+
await Players.patchMe({ body: { fullName: 'John Doe' } });
|
|
57
|
+
await Players.deleteMe();
|
|
58
|
+
const dashboard = await Players.getMyDashboard();
|
|
59
|
+
await Players.heartbeat({ body: { timezone: 'Europe/Bucharest' } });
|
|
60
|
+
const results = await Players.searchPlayers({
|
|
61
|
+
body: {
|
|
62
|
+
search: 'John',
|
|
63
|
+
page: 1,
|
|
64
|
+
pageSize: 20,
|
|
65
|
+
sortBy: 'age_asc',
|
|
66
|
+
nationalities: ['EG', 'MA'],
|
|
67
|
+
positions: ['CM', 'CB'],
|
|
68
|
+
baseFoot: 'right',
|
|
69
|
+
isFreeAgent: true,
|
|
70
|
+
hasVideo: true,
|
|
71
|
+
heightOperator: 'gte',
|
|
72
|
+
heightCm: 180,
|
|
73
|
+
},
|
|
74
|
+
});
|
|
75
|
+
const playerProfile = await Players.getPlayerById({
|
|
76
|
+
path: { id: 'player-uuid' },
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
// Profile
|
|
80
|
+
const profile = await Profile.getProfileMe();
|
|
81
|
+
await Profile.updateProfileMe({ body: { dominantFoot: 'Right' } });
|
|
82
|
+
|
|
83
|
+
// Documents
|
|
84
|
+
const docs = await Documents.getMyDocuments();
|
|
85
|
+
await Documents.createDocument({ body: { type: 'license' } });
|
|
86
|
+
|
|
87
|
+
// Videos
|
|
88
|
+
const videos = await Videos.getMyVideos();
|
|
89
|
+
await Videos.createVideo({
|
|
90
|
+
body: { type: 'cmj', storagePath: 'path/to/video' },
|
|
91
|
+
});
|
|
92
|
+
const playUrl = await Videos.getVideoPlayUrl({ path: { id: 'video-uuid' } });
|
|
93
|
+
await Videos.deleteVideo({ path: { id: 'video-uuid' } });
|
|
94
|
+
|
|
95
|
+
// Achievements
|
|
96
|
+
const catalog = await Achievements.getAchievementsCatalog();
|
|
97
|
+
const myAchievements = await Achievements.getMyAchievements();
|
|
98
|
+
|
|
99
|
+
// Body measurements
|
|
100
|
+
const measurement = await Body.getMyMeasurements();
|
|
101
|
+
await Body.createMeasurement({ body: { heightCm: 180 } });
|
|
102
|
+
|
|
103
|
+
// Index (lookup tables)
|
|
104
|
+
const positions = await Index.getIndexItems({
|
|
105
|
+
path: { tableName: 'positions' },
|
|
106
|
+
});
|
|
107
|
+
const countries = await Index.getCountries();
|
|
108
|
+
// Returns [{ code: 'BR', name: 'Brazil', nationalityName: 'Brazilian', flagEmoji: '🇧🇷' }, ...]
|
|
109
|
+
|
|
110
|
+
// Offers (conversations between scouts and players)
|
|
111
|
+
const conversations = await Offers.listConversations({
|
|
112
|
+
query: { filter: 'all', page: 1, pageSize: 20 },
|
|
113
|
+
});
|
|
114
|
+
const conversation = await Offers.createConversation({
|
|
115
|
+
body: { playerId: 'player-uuid', initialMessage: 'Hi!' },
|
|
116
|
+
});
|
|
117
|
+
const messages = await Offers.listMessages({
|
|
118
|
+
path: { id: 'conversation-uuid' },
|
|
119
|
+
query: { page: 1, pageSize: 20 },
|
|
120
|
+
});
|
|
121
|
+
await Offers.sendMessage({
|
|
122
|
+
path: { id: 'conversation-uuid' },
|
|
123
|
+
body: { body: 'Looking forward to it!' },
|
|
124
|
+
});
|
|
125
|
+
await Offers.markConversationRead({ path: { id: 'conversation-uuid' } });
|
|
126
|
+
|
|
127
|
+
// Organizations
|
|
128
|
+
const org = await Organizations.getMyOrganization();
|
|
129
|
+
await Organizations.updateMyOrganization({ body: { name: 'FC Example' } });
|
|
130
|
+
await Organizations.registerClub({
|
|
131
|
+
body: { name: 'FC Example', email: 'admin@example.com' },
|
|
132
|
+
});
|
|
133
|
+
|
|
134
|
+
// Clubs (coach/admin club entries within an organization)
|
|
135
|
+
const clubs = await Clubs.getMyClubs();
|
|
136
|
+
const club = await Clubs.createMyClub({ body: { name: 'U19 Team' } });
|
|
137
|
+
await Clubs.updateMyClub({
|
|
138
|
+
path: { id: 'club-uuid' },
|
|
139
|
+
body: { name: 'U21 Team' },
|
|
140
|
+
});
|
|
141
|
+
await Clubs.deleteMyClub({ path: { id: 'club-uuid' } });
|
|
142
|
+
|
|
143
|
+
// Challenges
|
|
144
|
+
const challengeCatalog = await Challenges.getChallengesCatalog();
|
|
145
|
+
const myChallenges = await Challenges.getMyChallenges();
|
|
146
|
+
|
|
147
|
+
// Training
|
|
148
|
+
const grouped = await Training.getTrainingGrouped();
|
|
149
|
+
const trainingList = await Training.getTrainingList({
|
|
150
|
+
query: { categoryCode: 'fitness', page: 1, pageSize: 20 },
|
|
151
|
+
});
|
|
152
|
+
const trainingItem = await Training.getTrainingById({
|
|
153
|
+
path: { id: 'training-uuid' },
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
// Invitations (org admin invites members)
|
|
157
|
+
await Invitations.sendInvitation({
|
|
158
|
+
body: { email: 'coach@example.com', role: 'coach' },
|
|
159
|
+
});
|
|
160
|
+
const invitations = await Invitations.listInvitations();
|
|
161
|
+
await Invitations.resendInvitation({ path: { id: 'invitation-uuid' } });
|
|
162
|
+
await Invitations.deleteInvitation({ path: { id: 'invitation-uuid' } });
|
|
163
|
+
await Invitations.acceptInvitation(); // called after Supabase auth callback
|
|
164
|
+
|
|
165
|
+
// KYC — SmileID Enhanced Document Verification
|
|
166
|
+
const kycResult = await Kyc.startKyc({
|
|
167
|
+
body: { country: 'gh', channel: 'web' },
|
|
168
|
+
});
|
|
169
|
+
// kycResult: { token, partnerId, jobId, status, retriesRemaining }
|
|
170
|
+
// Pass token + partnerId to the SmileID web SDK widget to start document capture.
|
|
171
|
+
// After the SDK reports successful submission, call markSubmittedKyc with jobId.
|
|
172
|
+
await Kyc.markSubmittedKyc({ body: { jobId: kycResult.jobId! } });
|
|
173
|
+
// SmileID also calls POST /kyc/webhook with final processing results.
|
|
174
|
+
|
|
175
|
+
const kycStatus = await Kyc.getKycStatus({
|
|
176
|
+
path: { userId: supabaseAuthUuid },
|
|
177
|
+
});
|
|
178
|
+
// kycStatus: { status, retryCount, retriesRemaining }
|
|
179
|
+
// status: 'pending' | 'capture_started' | 'processing' | 'approved' | 'rejected' | 'blocked'
|
|
180
|
+
// Older API clients may still see legacy 'in_progress', which maps to 'capture_started'.
|
|
181
|
+
|
|
182
|
+
// Storage — get a signed upload URL, then PUT the file directly to Supabase Storage
|
|
183
|
+
const { uploadUrl, token, path, bucket, expiresIn } =
|
|
184
|
+
await Storage.createUploadUrl({
|
|
185
|
+
body: { bucket: 'avatars', contentType: 'image/jpeg', sizeBytes: 204800 },
|
|
186
|
+
});
|
|
187
|
+
await fetch(uploadUrl, {
|
|
188
|
+
method: 'PUT',
|
|
189
|
+
body: fileBlob,
|
|
190
|
+
headers: { 'Content-Type': 'image/jpeg' },
|
|
191
|
+
});
|
|
192
|
+
// persist `path` on the player record (e.g. patchMe with avatarPath: path)
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Updating auth token
|
|
196
|
+
|
|
197
|
+
Update the Bearer token after sign-in or token refresh:
|
|
198
|
+
|
|
199
|
+
```ts
|
|
200
|
+
client.setConfig({
|
|
201
|
+
headers: {
|
|
202
|
+
Authorization: `Bearer ${newAccessToken}`,
|
|
203
|
+
},
|
|
204
|
+
});
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## Versioning
|
|
208
|
+
|
|
209
|
+
This package is auto-generated from the backend OpenAPI spec. Version increments follow semver:
|
|
210
|
+
|
|
211
|
+
- **patch** — no API shape changes
|
|
212
|
+
- **minor** — new endpoints added
|
|
213
|
+
- **major** — breaking changes (renamed/removed endpoints or fields)
|
|
214
|
+
|
|
215
|
+
## Package format
|
|
216
|
+
|
|
217
|
+
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, 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, CountryDto, 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, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, 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';
|
|
1
|
+
export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Offers, type Options, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
|
|
2
|
+
export type { AchievementCatalogDto, AuthMeResponseDto, BodyMeasurementResponseDto, CancelKycRequestDto, CareerAchievementDto, ChallengeCatalogDto, ClientOptions, ClubResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, 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, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponse, GetApiKycStatusByUserIdResponses, 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, KycStatusDto, KycWebhookDto, MarkSubmittedKycRequestDto, 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, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponse, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponse, PostApiKycMarkSubmittedResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponse, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, 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, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, SendInvitationRequestDto, SendMessageDto, StartKycRequestDto, StartKycResponseDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } 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, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Offers, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
|
|
2
|
+
export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, 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 { 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, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, 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';
|
|
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, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, 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, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponses, 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
|
|
@@ -85,6 +85,7 @@ export declare class Offers extends HeyApiClient {
|
|
|
85
85
|
}
|
|
86
86
|
export declare class Organizations extends HeyApiClient {
|
|
87
87
|
registerClub<ThrowOnError extends boolean = false>(options: Options<PostApiOrganizationsRegisterClubData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOrganizationsRegisterClubResponses, PostApiOrganizationsRegisterClubErrors, ThrowOnError, "fields">;
|
|
88
|
+
registerAgent<ThrowOnError extends boolean = false>(options: Options<PostApiOrganizationsRegisterAgentData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterAgentErrors, ThrowOnError, "fields">;
|
|
88
89
|
getMyOrganization<ThrowOnError extends boolean = false>(options?: Options<GetApiOrganizationsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiOrganizationsMeResponses, GetApiOrganizationsMeErrors, ThrowOnError, "fields">;
|
|
89
90
|
updateMyOrganization<ThrowOnError extends boolean = false>(options: Options<PutApiOrganizationsMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PutApiOrganizationsMeResponses, PutApiOrganizationsMeErrors, ThrowOnError, "fields">;
|
|
90
91
|
}
|
|
@@ -101,6 +102,28 @@ export declare class Invitations extends HeyApiClient {
|
|
|
101
102
|
*/
|
|
102
103
|
acceptInvitation<ThrowOnError extends boolean = false>(options?: Options<PostApiInvitationsAcceptData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiInvitationsAcceptResponses, unknown, ThrowOnError, "fields">;
|
|
103
104
|
}
|
|
105
|
+
export declare class Kyc extends HeyApiClient {
|
|
106
|
+
/**
|
|
107
|
+
* Start or resume a KYC verification job
|
|
108
|
+
*/
|
|
109
|
+
startKyc<ThrowOnError extends boolean = false>(options: Options<PostApiKycStartData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycStartResponses, PostApiKycStartErrors, ThrowOnError, "fields">;
|
|
110
|
+
/**
|
|
111
|
+
* SmileID webhook — receives job results (public, signature-verified)
|
|
112
|
+
*/
|
|
113
|
+
kycWebhook<ThrowOnError extends boolean = false>(options: Options<PostApiKycWebhookData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycWebhookResponses, PostApiKycWebhookErrors, ThrowOnError, "fields">;
|
|
114
|
+
/**
|
|
115
|
+
* Mark the current KYC capture job as submitted
|
|
116
|
+
*/
|
|
117
|
+
markSubmittedKyc<ThrowOnError extends boolean = false>(options: Options<PostApiKycMarkSubmittedData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycMarkSubmittedResponses, PostApiKycMarkSubmittedErrors, ThrowOnError, "fields">;
|
|
118
|
+
/**
|
|
119
|
+
* Cancel the active KYC verification job for the current user
|
|
120
|
+
*/
|
|
121
|
+
cancelKyc<ThrowOnError extends boolean = false>(options: Options<PostApiKycCancelData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycCancelResponses, PostApiKycCancelErrors, ThrowOnError, "fields">;
|
|
122
|
+
/**
|
|
123
|
+
* Get KYC status for a user
|
|
124
|
+
*/
|
|
125
|
+
getKycStatus<ThrowOnError extends boolean = false>(options: Options<GetApiKycStatusByUserIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiKycStatusByUserIdResponses, GetApiKycStatusByUserIdErrors, ThrowOnError, "fields">;
|
|
126
|
+
}
|
|
104
127
|
export declare class Training extends HeyApiClient {
|
|
105
128
|
/**
|
|
106
129
|
* Get training content grouped by category, top 3 per category
|
|
@@ -153,6 +176,8 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
|
|
|
153
176
|
get storage(): Storage;
|
|
154
177
|
private _invitations?;
|
|
155
178
|
get invitations(): Invitations;
|
|
179
|
+
private _kyc?;
|
|
180
|
+
get kyc(): Kyc;
|
|
156
181
|
private _training?;
|
|
157
182
|
get training(): Training;
|
|
158
183
|
private _videos?;
|
package/dist/sdk.gen.js
CHANGED
|
@@ -218,6 +218,16 @@ export class Organizations extends HeyApiClient {
|
|
|
218
218
|
},
|
|
219
219
|
});
|
|
220
220
|
}
|
|
221
|
+
registerAgent(options) {
|
|
222
|
+
return (options.client ?? this.client).post({
|
|
223
|
+
url: '/api/organizations/register-agent',
|
|
224
|
+
...options,
|
|
225
|
+
headers: {
|
|
226
|
+
'Content-Type': 'application/json',
|
|
227
|
+
...options.headers,
|
|
228
|
+
},
|
|
229
|
+
});
|
|
230
|
+
}
|
|
221
231
|
getMyOrganization(options) {
|
|
222
232
|
return (options?.client ?? this.client).get({ url: '/api/organizations/me', ...options });
|
|
223
233
|
}
|
|
@@ -271,6 +281,66 @@ export class Invitations extends HeyApiClient {
|
|
|
271
281
|
return (options?.client ?? this.client).post({ url: '/api/invitations/accept', ...options });
|
|
272
282
|
}
|
|
273
283
|
}
|
|
284
|
+
export class Kyc extends HeyApiClient {
|
|
285
|
+
/**
|
|
286
|
+
* Start or resume a KYC verification job
|
|
287
|
+
*/
|
|
288
|
+
startKyc(options) {
|
|
289
|
+
return (options.client ?? this.client).post({
|
|
290
|
+
url: '/api/kyc/start',
|
|
291
|
+
...options,
|
|
292
|
+
headers: {
|
|
293
|
+
'Content-Type': 'application/json',
|
|
294
|
+
...options.headers,
|
|
295
|
+
},
|
|
296
|
+
});
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* SmileID webhook — receives job results (public, signature-verified)
|
|
300
|
+
*/
|
|
301
|
+
kycWebhook(options) {
|
|
302
|
+
return (options.client ?? this.client).post({
|
|
303
|
+
url: '/api/kyc/webhook',
|
|
304
|
+
...options,
|
|
305
|
+
headers: {
|
|
306
|
+
'Content-Type': 'application/json',
|
|
307
|
+
...options.headers,
|
|
308
|
+
},
|
|
309
|
+
});
|
|
310
|
+
}
|
|
311
|
+
/**
|
|
312
|
+
* Mark the current KYC capture job as submitted
|
|
313
|
+
*/
|
|
314
|
+
markSubmittedKyc(options) {
|
|
315
|
+
return (options.client ?? this.client).post({
|
|
316
|
+
url: '/api/kyc/mark-submitted',
|
|
317
|
+
...options,
|
|
318
|
+
headers: {
|
|
319
|
+
'Content-Type': 'application/json',
|
|
320
|
+
...options.headers,
|
|
321
|
+
},
|
|
322
|
+
});
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* Cancel the active KYC verification job for the current user
|
|
326
|
+
*/
|
|
327
|
+
cancelKyc(options) {
|
|
328
|
+
return (options.client ?? this.client).post({
|
|
329
|
+
url: '/api/kyc/cancel',
|
|
330
|
+
...options,
|
|
331
|
+
headers: {
|
|
332
|
+
'Content-Type': 'application/json',
|
|
333
|
+
...options.headers,
|
|
334
|
+
},
|
|
335
|
+
});
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Get KYC status for a user
|
|
339
|
+
*/
|
|
340
|
+
getKycStatus(options) {
|
|
341
|
+
return (options.client ?? this.client).get({ url: '/api/kyc/status/{userId}', ...options });
|
|
342
|
+
}
|
|
343
|
+
}
|
|
274
344
|
export class Training extends HeyApiClient {
|
|
275
345
|
/**
|
|
276
346
|
* Get training content grouped by category, top 3 per category
|
|
@@ -356,6 +426,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
|
|
|
356
426
|
get invitations() {
|
|
357
427
|
return (this._invitations ?? (this._invitations = new Invitations({ client: this.client })));
|
|
358
428
|
}
|
|
429
|
+
get kyc() {
|
|
430
|
+
return (this._kyc ?? (this._kyc = new Kyc({ client: this.client })));
|
|
431
|
+
}
|
|
359
432
|
get training() {
|
|
360
433
|
return (this._training ?? (this._training = new Training({ client: this.client })));
|
|
361
434
|
}
|