@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/types.gen.ts
CHANGED
|
@@ -183,6 +183,10 @@ export type UpdatePlayerDto = {
|
|
|
183
183
|
* Bio
|
|
184
184
|
*/
|
|
185
185
|
bio?: string;
|
|
186
|
+
/**
|
|
187
|
+
* Phone number
|
|
188
|
+
*/
|
|
189
|
+
phone?: string | null;
|
|
186
190
|
};
|
|
187
191
|
|
|
188
192
|
export type PlayerSearchRequestDto = {
|
|
@@ -562,6 +566,10 @@ export type ProfileResponseDto = {
|
|
|
562
566
|
* Agency name
|
|
563
567
|
*/
|
|
564
568
|
agencyName?: string | null;
|
|
569
|
+
/**
|
|
570
|
+
* FIFA / scouting license number
|
|
571
|
+
*/
|
|
572
|
+
scoutingLicenseNumber?: string | null;
|
|
565
573
|
/**
|
|
566
574
|
* Agency website URL
|
|
567
575
|
*/
|
|
@@ -689,6 +697,10 @@ export type UpdateProfileDto = {
|
|
|
689
697
|
* Agency name
|
|
690
698
|
*/
|
|
691
699
|
agencyName?: string;
|
|
700
|
+
/**
|
|
701
|
+
* FIFA / scouting license number
|
|
702
|
+
*/
|
|
703
|
+
scoutingLicenseNumber?: string;
|
|
692
704
|
/**
|
|
693
705
|
* Agency website URL
|
|
694
706
|
*/
|
|
@@ -1074,6 +1086,52 @@ export type RegisterClubResponseDto = {
|
|
|
1074
1086
|
slug?: string;
|
|
1075
1087
|
};
|
|
1076
1088
|
|
|
1089
|
+
export type RegisterAgentDto = {
|
|
1090
|
+
/**
|
|
1091
|
+
* Scout agency name
|
|
1092
|
+
*/
|
|
1093
|
+
agencyName: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* Agent first name
|
|
1096
|
+
*/
|
|
1097
|
+
firstName: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Agent last name
|
|
1100
|
+
*/
|
|
1101
|
+
lastName: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* Agent email
|
|
1104
|
+
*/
|
|
1105
|
+
email: string;
|
|
1106
|
+
/**
|
|
1107
|
+
* Password (min 8 characters)
|
|
1108
|
+
*/
|
|
1109
|
+
password: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Agent phone number
|
|
1112
|
+
*/
|
|
1113
|
+
phone?: string;
|
|
1114
|
+
};
|
|
1115
|
+
|
|
1116
|
+
export type RegisterAgentResponseDto = {
|
|
1117
|
+
/**
|
|
1118
|
+
* Internal user_data id
|
|
1119
|
+
*/
|
|
1120
|
+
userId: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Scout agency organization id
|
|
1123
|
+
*/
|
|
1124
|
+
organizationId: string;
|
|
1125
|
+
/**
|
|
1126
|
+
* Scout agency name
|
|
1127
|
+
*/
|
|
1128
|
+
agencyName: string;
|
|
1129
|
+
/**
|
|
1130
|
+
* Scout agency slug
|
|
1131
|
+
*/
|
|
1132
|
+
slug?: string;
|
|
1133
|
+
};
|
|
1134
|
+
|
|
1077
1135
|
export type OrganizationResponseDto = {
|
|
1078
1136
|
/**
|
|
1079
1137
|
* Organization id
|
|
@@ -1229,6 +1287,111 @@ export type InvitationResponseDto = {
|
|
|
1229
1287
|
acceptedAt?: string | null;
|
|
1230
1288
|
};
|
|
1231
1289
|
|
|
1290
|
+
export type StartKycRequestDto = {
|
|
1291
|
+
/**
|
|
1292
|
+
* ISO 3166-1 alpha-2 country code (lowercase, matches index.countries)
|
|
1293
|
+
*/
|
|
1294
|
+
country: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* Channel initiating the KYC flow
|
|
1297
|
+
*/
|
|
1298
|
+
channel: 'web' | 'mobile';
|
|
1299
|
+
};
|
|
1300
|
+
|
|
1301
|
+
export type StartKycResponseDto = {
|
|
1302
|
+
/**
|
|
1303
|
+
* Short-lived token to Initialize the SmileID SDK widget
|
|
1304
|
+
*/
|
|
1305
|
+
token?: string | null;
|
|
1306
|
+
/**
|
|
1307
|
+
* SmileID partner ID — required by the SDK
|
|
1308
|
+
*/
|
|
1309
|
+
partnerId: string;
|
|
1310
|
+
/**
|
|
1311
|
+
* SmileID job identifier
|
|
1312
|
+
*/
|
|
1313
|
+
jobId?: string | null;
|
|
1314
|
+
status:
|
|
1315
|
+
| 'pending'
|
|
1316
|
+
| 'capture_started'
|
|
1317
|
+
| 'processing'
|
|
1318
|
+
| 'approved'
|
|
1319
|
+
| 'rejected'
|
|
1320
|
+
| 'blocked';
|
|
1321
|
+
/**
|
|
1322
|
+
* Number of retries left before the account is blocked
|
|
1323
|
+
*/
|
|
1324
|
+
retriesRemaining: number;
|
|
1325
|
+
/**
|
|
1326
|
+
* ISO 3166-1 alpha-2 country code used for the KYC attempt
|
|
1327
|
+
*/
|
|
1328
|
+
country?: string | null;
|
|
1329
|
+
};
|
|
1330
|
+
|
|
1331
|
+
export type WebhookPartnerParamsDto = {
|
|
1332
|
+
/**
|
|
1333
|
+
* Our job identifier echoed back by SmileID
|
|
1334
|
+
*/
|
|
1335
|
+
job_id?: string;
|
|
1336
|
+
user_id?: string;
|
|
1337
|
+
job_type?: string;
|
|
1338
|
+
};
|
|
1339
|
+
|
|
1340
|
+
export type KycWebhookDto = {
|
|
1341
|
+
/**
|
|
1342
|
+
* SmileID internal job ID
|
|
1343
|
+
*/
|
|
1344
|
+
SmileJobID?: string;
|
|
1345
|
+
PartnerParams?: WebhookPartnerParamsDto;
|
|
1346
|
+
/**
|
|
1347
|
+
* SmileID result code — 0810/1220/1221 = approved; 0001/0811/0812/0816/0903/1014 and 2xxx = rejected
|
|
1348
|
+
*/
|
|
1349
|
+
ResultCode?: string;
|
|
1350
|
+
ResultText?: string;
|
|
1351
|
+
/**
|
|
1352
|
+
* ISO timestamp used in HMAC-SHA256 signature
|
|
1353
|
+
*/
|
|
1354
|
+
timestamp: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* HMAC-SHA256 signature for request authenticity
|
|
1357
|
+
*/
|
|
1358
|
+
signature: string;
|
|
1359
|
+
};
|
|
1360
|
+
|
|
1361
|
+
export type MarkSubmittedKycRequestDto = {
|
|
1362
|
+
/**
|
|
1363
|
+
* SmileID job identifier returned by /kyc/start
|
|
1364
|
+
*/
|
|
1365
|
+
jobId: string;
|
|
1366
|
+
};
|
|
1367
|
+
|
|
1368
|
+
export type KycStatusDto = {
|
|
1369
|
+
status:
|
|
1370
|
+
| 'pending'
|
|
1371
|
+
| 'capture_started'
|
|
1372
|
+
| 'processing'
|
|
1373
|
+
| 'approved'
|
|
1374
|
+
| 'rejected'
|
|
1375
|
+
| 'blocked';
|
|
1376
|
+
retryCount: number;
|
|
1377
|
+
retriesRemaining: number;
|
|
1378
|
+
/**
|
|
1379
|
+
* SmileID job identifier for the current or latest KYC attempt
|
|
1380
|
+
*/
|
|
1381
|
+
jobId?: string | null;
|
|
1382
|
+
/**
|
|
1383
|
+
* ISO 3166-1 alpha-2 country code used for the KYC attempt
|
|
1384
|
+
*/
|
|
1385
|
+
country?: string | null;
|
|
1386
|
+
};
|
|
1387
|
+
|
|
1388
|
+
export type CancelKycRequestDto = {
|
|
1389
|
+
/**
|
|
1390
|
+
* SmileID job identifier returned by /kyc/start or status
|
|
1391
|
+
*/
|
|
1392
|
+
jobId: string;
|
|
1393
|
+
};
|
|
1394
|
+
|
|
1232
1395
|
export type TrainingContentListItemDto = {
|
|
1233
1396
|
id: string;
|
|
1234
1397
|
title: string;
|
|
@@ -1930,6 +2093,10 @@ export type PostApiOffersConversationsErrors = {
|
|
|
1930
2093
|
* Unauthorized
|
|
1931
2094
|
*/
|
|
1932
2095
|
401: unknown;
|
|
2096
|
+
/**
|
|
2097
|
+
* Only clubs and scouters can create offer conversations
|
|
2098
|
+
*/
|
|
2099
|
+
403: unknown;
|
|
1933
2100
|
};
|
|
1934
2101
|
|
|
1935
2102
|
export type PostApiOffersConversationsResponses = {
|
|
@@ -2057,6 +2224,31 @@ export type PostApiOrganizationsRegisterClubResponses = {
|
|
|
2057
2224
|
export type PostApiOrganizationsRegisterClubResponse =
|
|
2058
2225
|
PostApiOrganizationsRegisterClubResponses[keyof PostApiOrganizationsRegisterClubResponses];
|
|
2059
2226
|
|
|
2227
|
+
export type PostApiOrganizationsRegisterAgentData = {
|
|
2228
|
+
body: RegisterAgentDto;
|
|
2229
|
+
path?: never;
|
|
2230
|
+
query?: never;
|
|
2231
|
+
url: '/api/organizations/register-agent';
|
|
2232
|
+
};
|
|
2233
|
+
|
|
2234
|
+
export type PostApiOrganizationsRegisterAgentErrors = {
|
|
2235
|
+
/**
|
|
2236
|
+
* Bad request
|
|
2237
|
+
*/
|
|
2238
|
+
400: unknown;
|
|
2239
|
+
/**
|
|
2240
|
+
* Email already exists
|
|
2241
|
+
*/
|
|
2242
|
+
409: unknown;
|
|
2243
|
+
};
|
|
2244
|
+
|
|
2245
|
+
export type PostApiOrganizationsRegisterAgentResponses = {
|
|
2246
|
+
201: RegisterAgentResponseDto;
|
|
2247
|
+
};
|
|
2248
|
+
|
|
2249
|
+
export type PostApiOrganizationsRegisterAgentResponse =
|
|
2250
|
+
PostApiOrganizationsRegisterAgentResponses[keyof PostApiOrganizationsRegisterAgentResponses];
|
|
2251
|
+
|
|
2060
2252
|
export type GetApiOrganizationsMeData = {
|
|
2061
2253
|
body?: never;
|
|
2062
2254
|
path?: never;
|
|
@@ -2248,6 +2440,133 @@ export type PostApiInvitationsAcceptResponses = {
|
|
|
2248
2440
|
export type PostApiInvitationsAcceptResponse =
|
|
2249
2441
|
PostApiInvitationsAcceptResponses[keyof PostApiInvitationsAcceptResponses];
|
|
2250
2442
|
|
|
2443
|
+
export type PostApiKycStartData = {
|
|
2444
|
+
body: StartKycRequestDto;
|
|
2445
|
+
path?: never;
|
|
2446
|
+
query?: never;
|
|
2447
|
+
url: '/api/kyc/start';
|
|
2448
|
+
};
|
|
2449
|
+
|
|
2450
|
+
export type PostApiKycStartErrors = {
|
|
2451
|
+
/**
|
|
2452
|
+
* Invalid request
|
|
2453
|
+
*/
|
|
2454
|
+
400: unknown;
|
|
2455
|
+
};
|
|
2456
|
+
|
|
2457
|
+
export type PostApiKycStartResponses = {
|
|
2458
|
+
200: StartKycResponseDto;
|
|
2459
|
+
};
|
|
2460
|
+
|
|
2461
|
+
export type PostApiKycStartResponse =
|
|
2462
|
+
PostApiKycStartResponses[keyof PostApiKycStartResponses];
|
|
2463
|
+
|
|
2464
|
+
export type PostApiKycWebhookData = {
|
|
2465
|
+
body: KycWebhookDto;
|
|
2466
|
+
path?: never;
|
|
2467
|
+
query?: never;
|
|
2468
|
+
url: '/api/kyc/webhook';
|
|
2469
|
+
};
|
|
2470
|
+
|
|
2471
|
+
export type PostApiKycWebhookErrors = {
|
|
2472
|
+
/**
|
|
2473
|
+
* Invalid signature
|
|
2474
|
+
*/
|
|
2475
|
+
400: unknown;
|
|
2476
|
+
};
|
|
2477
|
+
|
|
2478
|
+
export type PostApiKycWebhookResponses = {
|
|
2479
|
+
/**
|
|
2480
|
+
* Acknowledged
|
|
2481
|
+
*/
|
|
2482
|
+
200: unknown;
|
|
2483
|
+
};
|
|
2484
|
+
|
|
2485
|
+
export type PostApiKycMarkSubmittedData = {
|
|
2486
|
+
body: MarkSubmittedKycRequestDto;
|
|
2487
|
+
path?: never;
|
|
2488
|
+
query?: never;
|
|
2489
|
+
url: '/api/kyc/mark-submitted';
|
|
2490
|
+
};
|
|
2491
|
+
|
|
2492
|
+
export type PostApiKycMarkSubmittedErrors = {
|
|
2493
|
+
/**
|
|
2494
|
+
* Invalid request
|
|
2495
|
+
*/
|
|
2496
|
+
400: unknown;
|
|
2497
|
+
/**
|
|
2498
|
+
* No active KYC job found
|
|
2499
|
+
*/
|
|
2500
|
+
404: unknown;
|
|
2501
|
+
/**
|
|
2502
|
+
* Submitted job is stale
|
|
2503
|
+
*/
|
|
2504
|
+
409: unknown;
|
|
2505
|
+
};
|
|
2506
|
+
|
|
2507
|
+
export type PostApiKycMarkSubmittedResponses = {
|
|
2508
|
+
200: KycStatusDto;
|
|
2509
|
+
};
|
|
2510
|
+
|
|
2511
|
+
export type PostApiKycMarkSubmittedResponse =
|
|
2512
|
+
PostApiKycMarkSubmittedResponses[keyof PostApiKycMarkSubmittedResponses];
|
|
2513
|
+
|
|
2514
|
+
export type PostApiKycCancelData = {
|
|
2515
|
+
body: CancelKycRequestDto;
|
|
2516
|
+
path?: never;
|
|
2517
|
+
query?: never;
|
|
2518
|
+
url: '/api/kyc/cancel';
|
|
2519
|
+
};
|
|
2520
|
+
|
|
2521
|
+
export type PostApiKycCancelErrors = {
|
|
2522
|
+
/**
|
|
2523
|
+
* Invalid request
|
|
2524
|
+
*/
|
|
2525
|
+
400: unknown;
|
|
2526
|
+
/**
|
|
2527
|
+
* No active KYC job found
|
|
2528
|
+
*/
|
|
2529
|
+
404: unknown;
|
|
2530
|
+
/**
|
|
2531
|
+
* Cancel job is stale
|
|
2532
|
+
*/
|
|
2533
|
+
409: unknown;
|
|
2534
|
+
};
|
|
2535
|
+
|
|
2536
|
+
export type PostApiKycCancelResponses = {
|
|
2537
|
+
200: KycStatusDto;
|
|
2538
|
+
};
|
|
2539
|
+
|
|
2540
|
+
export type PostApiKycCancelResponse =
|
|
2541
|
+
PostApiKycCancelResponses[keyof PostApiKycCancelResponses];
|
|
2542
|
+
|
|
2543
|
+
export type GetApiKycStatusByUserIdData = {
|
|
2544
|
+
body?: never;
|
|
2545
|
+
path: {
|
|
2546
|
+
userId: string;
|
|
2547
|
+
};
|
|
2548
|
+
query?: never;
|
|
2549
|
+
url: '/api/kyc/status/{userId}';
|
|
2550
|
+
};
|
|
2551
|
+
|
|
2552
|
+
export type GetApiKycStatusByUserIdErrors = {
|
|
2553
|
+
/**
|
|
2554
|
+
* Cannot access another user's KYC status
|
|
2555
|
+
*/
|
|
2556
|
+
403: unknown;
|
|
2557
|
+
/**
|
|
2558
|
+
* No KYC record found
|
|
2559
|
+
*/
|
|
2560
|
+
404: unknown;
|
|
2561
|
+
};
|
|
2562
|
+
|
|
2563
|
+
export type GetApiKycStatusByUserIdResponses = {
|
|
2564
|
+
200: KycStatusDto;
|
|
2565
|
+
};
|
|
2566
|
+
|
|
2567
|
+
export type GetApiKycStatusByUserIdResponse =
|
|
2568
|
+
GetApiKycStatusByUserIdResponses[keyof GetApiKycStatusByUserIdResponses];
|
|
2569
|
+
|
|
2251
2570
|
export type GetApiTrainingGroupedData = {
|
|
2252
2571
|
body?: never;
|
|
2253
2572
|
path?: never;
|