@globalscoutme/api-client 1.0.24 → 1.0.26

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 CHANGED
@@ -30,6 +30,7 @@ All endpoints are grouped by controller and fully typed:
30
30
  ```ts
31
31
  import {
32
32
  Auth,
33
+ Dashboard,
33
34
  Players,
34
35
  Profile,
35
36
  Documents,
@@ -107,6 +108,17 @@ const positions = await Index.getIndexItems({
107
108
  const countries = await Index.getCountries();
108
109
  // Returns [{ code: 'BR', name: 'Brazil', nationalityName: 'Brazilian', flagEmoji: '🇧🇷' }, ...]
109
110
 
111
+ // Dashboard (scout/club portal — single aggregated call)
112
+ const dashboard = await Dashboard.getScoutDashboard();
113
+ // Returns: stats (watchlisted, offersSent, playersViewed, videosWatched),
114
+ // lastPlayersViewed (last 6 distinct players),
115
+ // lastVideosWatched (last 6 distinct videos with player info)
116
+
117
+ const videoUrl = await Dashboard.getScoutVideoPlayUrl({
118
+ path: { id: 'video-uuid' },
119
+ });
120
+ // Returns signed play URL + records the view in video_views
121
+
110
122
  // Offers (conversations between scouts and players)
111
123
  const conversations = await Offers.listConversations({
112
124
  query: { filter: 'all', page: 1, pageSize: 20 },
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
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';
1
+ export { Achievements, Auth, Body, Challenges, Clubs, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Notifications, 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, DashboardStatsDto, DashboardVideoCardDto, DeactivatePushDeviceDto, DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponse, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponse, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponse, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponse, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponse, DeleteApiVideosByIdResponses, DivisionDto, DocumentResponseDto, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponse, GetApiAchievementsMeResponses, GetApiAchievementsResponse, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponse, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponse, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponse, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponse, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponse, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponse, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponse, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponse, GetApiKycStatusByUserIdResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponse, GetApiNotificationsPreferencesResponses, 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, NotificationPreferencesDto, OkDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponse, PatchApiNotificationsPreferencesResponses, 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, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponse, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponse, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponse, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponse, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponse, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponse, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponse, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponse, PostApiStorageUploadUrlResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, PushDeviceRegistrationResultDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, RegisterPushDeviceDto, ScoutDashboardResponseDto, SendInvitationRequestDto, SendMessageDto, StartKycRequestDto, StartKycResponseDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateNotificationPreferencesDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } from './types.gen.js';
3
3
  export { client, type CreateClientConfig } from './client.gen.js';
4
4
  export type { GetApiOffersConversationsData as GetOffersConversationsData } from './types.gen.js';
package/dist/index.js CHANGED
@@ -1,3 +1,3 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
- export { Achievements, Auth, Body, Challenges, Clubs, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Offers, Organizations, Players, Profile, Storage, Training, Videos, } from './sdk.gen.js';
2
+ export { Achievements, Auth, Body, Challenges, Clubs, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Notifications, 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, 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';
2
+ import type { DeleteApiClubsMeByIdData, DeleteApiClubsMeByIdErrors, DeleteApiClubsMeByIdResponses, DeleteApiInvitationsByIdData, DeleteApiInvitationsByIdErrors, DeleteApiInvitationsByIdResponses, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponses, 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, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponses, 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, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponses, 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
@@ -83,6 +83,12 @@ export declare class Offers extends HeyApiClient {
83
83
  sendMessage<ThrowOnError extends boolean = false>(options: Options<PostApiOffersConversationsByIdMessagesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsByIdMessagesErrors, ThrowOnError, "fields">;
84
84
  markConversationRead<ThrowOnError extends boolean = false>(options: Options<PatchApiOffersConversationsByIdReadData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchApiOffersConversationsByIdReadResponses, PatchApiOffersConversationsByIdReadErrors, ThrowOnError, "fields">;
85
85
  }
86
+ export declare class Notifications extends HeyApiClient {
87
+ getNotificationPreferences<ThrowOnError extends boolean = false>(options?: Options<GetApiNotificationsPreferencesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiNotificationsPreferencesResponses, unknown, ThrowOnError, "fields">;
88
+ updateNotificationPreferences<ThrowOnError extends boolean = false>(options: Options<PatchApiNotificationsPreferencesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PatchApiNotificationsPreferencesResponses, unknown, ThrowOnError, "fields">;
89
+ registerPushDevice<ThrowOnError extends boolean = false>(options: Options<PostApiNotificationsDevicesData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiNotificationsDevicesResponses, unknown, ThrowOnError, "fields">;
90
+ deactivateCurrentPushDevice<ThrowOnError extends boolean = false>(options: Options<DeleteApiNotificationsDevicesCurrentData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiNotificationsDevicesCurrentResponses, unknown, ThrowOnError, "fields">;
91
+ }
86
92
  export declare class Organizations extends HeyApiClient {
87
93
  registerClub<ThrowOnError extends boolean = false>(options: Options<PostApiOrganizationsRegisterClubData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOrganizationsRegisterClubResponses, PostApiOrganizationsRegisterClubErrors, ThrowOnError, "fields">;
88
94
  registerAgent<ThrowOnError extends boolean = false>(options: Options<PostApiOrganizationsRegisterAgentData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterAgentErrors, ThrowOnError, "fields">;
@@ -144,6 +150,13 @@ export declare class Videos extends HeyApiClient {
144
150
  getVideoPlayUrl<ThrowOnError extends boolean = false>(options: Options<GetApiVideosByIdPlayUrlData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiVideosByIdPlayUrlResponses, GetApiVideosByIdPlayUrlErrors, ThrowOnError, "fields">;
145
151
  deleteVideo<ThrowOnError extends boolean = false>(options: Options<DeleteApiVideosByIdData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteApiVideosByIdResponses, DeleteApiVideosByIdErrors, ThrowOnError, "fields">;
146
152
  }
153
+ export declare class Dashboard extends HeyApiClient {
154
+ getScoutDashboard<ThrowOnError extends boolean = false>(options?: Options<GetApiDashboardMeData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiDashboardMeResponses, GetApiDashboardMeErrors, ThrowOnError, "fields">;
155
+ /**
156
+ * Signed play URL for a player video — records the view
157
+ */
158
+ getScoutVideoPlayUrl<ThrowOnError extends boolean = false>(options: Options<GetApiDashboardVideosByIdPlayUrlData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetApiDashboardVideosByIdPlayUrlResponses, GetApiDashboardVideosByIdPlayUrlErrors, ThrowOnError, "fields">;
159
+ }
147
160
  export declare class GlobalScoutMeClient extends HeyApiClient {
148
161
  static readonly __registry: HeyApiRegistry<GlobalScoutMeClient>;
149
162
  constructor(args?: {
@@ -170,6 +183,8 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
170
183
  get index(): Index;
171
184
  private _offers?;
172
185
  get offers(): Offers;
186
+ private _notifications?;
187
+ get notifications(): Notifications;
173
188
  private _organizations?;
174
189
  get organizations(): Organizations;
175
190
  private _storage?;
@@ -182,5 +197,7 @@ export declare class GlobalScoutMeClient extends HeyApiClient {
182
197
  get training(): Training;
183
198
  private _videos?;
184
199
  get videos(): Videos;
200
+ private _dashboard?;
201
+ get dashboard(): Dashboard;
185
202
  }
186
203
  export {};
package/dist/sdk.gen.js CHANGED
@@ -207,6 +207,41 @@ export class Offers extends HeyApiClient {
207
207
  return (options.client ?? this.client).patch({ url: '/api/offers/conversations/{id}/read', ...options });
208
208
  }
209
209
  }
210
+ export class Notifications extends HeyApiClient {
211
+ getNotificationPreferences(options) {
212
+ return (options?.client ?? this.client).get({ url: '/api/notifications/preferences', ...options });
213
+ }
214
+ updateNotificationPreferences(options) {
215
+ return (options.client ?? this.client).patch({
216
+ url: '/api/notifications/preferences',
217
+ ...options,
218
+ headers: {
219
+ 'Content-Type': 'application/json',
220
+ ...options.headers,
221
+ },
222
+ });
223
+ }
224
+ registerPushDevice(options) {
225
+ return (options.client ?? this.client).post({
226
+ url: '/api/notifications/devices',
227
+ ...options,
228
+ headers: {
229
+ 'Content-Type': 'application/json',
230
+ ...options.headers,
231
+ },
232
+ });
233
+ }
234
+ deactivateCurrentPushDevice(options) {
235
+ return (options.client ?? this.client).delete({
236
+ url: '/api/notifications/devices/current',
237
+ ...options,
238
+ headers: {
239
+ 'Content-Type': 'application/json',
240
+ ...options.headers,
241
+ },
242
+ });
243
+ }
244
+ }
210
245
  export class Organizations extends HeyApiClient {
211
246
  registerClub(options) {
212
247
  return (options.client ?? this.client).post({
@@ -382,6 +417,17 @@ export class Videos extends HeyApiClient {
382
417
  return (options.client ?? this.client).delete({ url: '/api/videos/{id}', ...options });
383
418
  }
384
419
  }
420
+ export class Dashboard extends HeyApiClient {
421
+ getScoutDashboard(options) {
422
+ return (options?.client ?? this.client).get({ url: '/api/dashboard/me', ...options });
423
+ }
424
+ /**
425
+ * Signed play URL for a player video — records the view
426
+ */
427
+ getScoutVideoPlayUrl(options) {
428
+ return (options.client ?? this.client).get({ url: '/api/dashboard/videos/{id}/play-url', ...options });
429
+ }
430
+ }
385
431
  export class GlobalScoutMeClient extends HeyApiClient {
386
432
  constructor(args) {
387
433
  super(args);
@@ -417,6 +463,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
417
463
  get offers() {
418
464
  return (this._offers ?? (this._offers = new Offers({ client: this.client })));
419
465
  }
466
+ get notifications() {
467
+ return (this._notifications ?? (this._notifications = new Notifications({ client: this.client })));
468
+ }
420
469
  get organizations() {
421
470
  return (this._organizations ?? (this._organizations = new Organizations({ client: this.client })));
422
471
  }
@@ -435,5 +484,8 @@ export class GlobalScoutMeClient extends HeyApiClient {
435
484
  get videos() {
436
485
  return (this._videos ?? (this._videos = new Videos({ client: this.client })));
437
486
  }
487
+ get dashboard() {
488
+ return (this._dashboard ?? (this._dashboard = new Dashboard({ client: this.client })));
489
+ }
438
490
  }
439
491
  GlobalScoutMeClient.__registry = new HeyApiRegistry();
@@ -282,6 +282,10 @@ export type PlayerSearchItemDto = {
282
282
  * Has at least one non-deleted video
283
283
  */
284
284
  hasVideo: boolean;
285
+ /**
286
+ * GSI profile score
287
+ */
288
+ gsiScore?: number | null;
285
289
  };
286
290
  export type PlayerSearchResultDto = {
287
291
  items: Array<PlayerSearchItemDto>;
@@ -986,6 +990,37 @@ export type SendMessageDto = {
986
990
  */
987
991
  body: string;
988
992
  };
993
+ export type NotificationPreferencesDto = {
994
+ pushEnabled: boolean;
995
+ offersEnabled: boolean;
996
+ messagesEnabled: boolean;
997
+ };
998
+ export type UpdateNotificationPreferencesDto = {
999
+ pushEnabled?: boolean;
1000
+ offersEnabled?: boolean;
1001
+ messagesEnabled?: boolean;
1002
+ };
1003
+ export type RegisterPushDeviceDto = {
1004
+ fcmToken: string;
1005
+ platform: 'ios' | 'android';
1006
+ installId: string;
1007
+ appVersion?: string;
1008
+ buildNumber?: string;
1009
+ locale?: string;
1010
+ timezone?: string;
1011
+ };
1012
+ export type PushDeviceRegistrationResultDto = {
1013
+ pushEnabled: boolean;
1014
+ offersEnabled: boolean;
1015
+ messagesEnabled: boolean;
1016
+ id: string;
1017
+ };
1018
+ export type DeactivatePushDeviceDto = {
1019
+ fcmToken: string;
1020
+ };
1021
+ export type OkDto = {
1022
+ ok: boolean;
1023
+ };
989
1024
  export type RegisterClubDto = {
990
1025
  /**
991
1026
  * Club name
@@ -1402,6 +1437,65 @@ export type PlayUrlResponseDto = {
1402
1437
  */
1403
1438
  expiresIn: number;
1404
1439
  };
1440
+ export type DashboardStatsDto = {
1441
+ /**
1442
+ * Number of players on the watchlist
1443
+ */
1444
+ watchlisted: number;
1445
+ /**
1446
+ * Number of offer conversations sent
1447
+ */
1448
+ offersSent: number;
1449
+ /**
1450
+ * Number of distinct players viewed
1451
+ */
1452
+ playersViewed: number;
1453
+ /**
1454
+ * Number of distinct videos watched
1455
+ */
1456
+ videosWatched: number;
1457
+ };
1458
+ export type DashboardVideoCardDto = {
1459
+ videoId: string;
1460
+ /**
1461
+ * Signed thumbnail URL
1462
+ */
1463
+ thumbnailUrl?: string | null;
1464
+ /**
1465
+ * Video duration in seconds
1466
+ */
1467
+ durationSeconds?: number | null;
1468
+ /**
1469
+ * Player (owner) ID
1470
+ */
1471
+ playerId: string;
1472
+ firstName?: string | null;
1473
+ lastName?: string | null;
1474
+ avatarUrl?: string | null;
1475
+ /**
1476
+ * Age computed from date_of_birth
1477
+ */
1478
+ age?: number | null;
1479
+ /**
1480
+ * Primary position code
1481
+ */
1482
+ primaryPosition?: string | null;
1483
+ /**
1484
+ * GSI profile score
1485
+ */
1486
+ gsiScore?: number | null;
1487
+ };
1488
+ export type ScoutDashboardResponseDto = {
1489
+ stats: DashboardStatsDto;
1490
+ /**
1491
+ * Last 6 distinct players viewed
1492
+ */
1493
+ lastPlayersViewed: Array<PlayerSearchItemDto>;
1494
+ /**
1495
+ * Last 6 distinct videos watched
1496
+ */
1497
+ lastVideosWatched: Array<DashboardVideoCardDto>;
1498
+ };
1405
1499
  export type GetApiAuthMeData = {
1406
1500
  body?: never;
1407
1501
  path?: never;
@@ -1967,6 +2061,46 @@ export type PatchApiOffersConversationsByIdReadErrors = {
1967
2061
  export type PatchApiOffersConversationsByIdReadResponses = {
1968
2062
  200: unknown;
1969
2063
  };
2064
+ export type GetApiNotificationsPreferencesData = {
2065
+ body?: never;
2066
+ path?: never;
2067
+ query?: never;
2068
+ url: '/api/notifications/preferences';
2069
+ };
2070
+ export type GetApiNotificationsPreferencesResponses = {
2071
+ 200: NotificationPreferencesDto;
2072
+ };
2073
+ export type GetApiNotificationsPreferencesResponse = GetApiNotificationsPreferencesResponses[keyof GetApiNotificationsPreferencesResponses];
2074
+ export type PatchApiNotificationsPreferencesData = {
2075
+ body: UpdateNotificationPreferencesDto;
2076
+ path?: never;
2077
+ query?: never;
2078
+ url: '/api/notifications/preferences';
2079
+ };
2080
+ export type PatchApiNotificationsPreferencesResponses = {
2081
+ 200: NotificationPreferencesDto;
2082
+ };
2083
+ export type PatchApiNotificationsPreferencesResponse = PatchApiNotificationsPreferencesResponses[keyof PatchApiNotificationsPreferencesResponses];
2084
+ export type PostApiNotificationsDevicesData = {
2085
+ body: RegisterPushDeviceDto;
2086
+ path?: never;
2087
+ query?: never;
2088
+ url: '/api/notifications/devices';
2089
+ };
2090
+ export type PostApiNotificationsDevicesResponses = {
2091
+ 201: PushDeviceRegistrationResultDto;
2092
+ };
2093
+ export type PostApiNotificationsDevicesResponse = PostApiNotificationsDevicesResponses[keyof PostApiNotificationsDevicesResponses];
2094
+ export type DeleteApiNotificationsDevicesCurrentData = {
2095
+ body: DeactivatePushDeviceDto;
2096
+ path?: never;
2097
+ query?: never;
2098
+ url: '/api/notifications/devices/current';
2099
+ };
2100
+ export type DeleteApiNotificationsDevicesCurrentResponses = {
2101
+ 200: OkDto;
2102
+ };
2103
+ export type DeleteApiNotificationsDevicesCurrentResponse = DeleteApiNotificationsDevicesCurrentResponses[keyof DeleteApiNotificationsDevicesCurrentResponses];
1970
2104
  export type PostApiOrganizationsRegisterClubData = {
1971
2105
  body: RegisterClubDto;
1972
2106
  path?: never;
@@ -2416,3 +2550,41 @@ export type DeleteApiVideosByIdResponses = {
2416
2550
  204: void;
2417
2551
  };
2418
2552
  export type DeleteApiVideosByIdResponse = DeleteApiVideosByIdResponses[keyof DeleteApiVideosByIdResponses];
2553
+ export type GetApiDashboardMeData = {
2554
+ body?: never;
2555
+ path?: never;
2556
+ query?: never;
2557
+ url: '/api/dashboard/me';
2558
+ };
2559
+ export type GetApiDashboardMeErrors = {
2560
+ /**
2561
+ * Unauthorized
2562
+ */
2563
+ 401: unknown;
2564
+ };
2565
+ export type GetApiDashboardMeResponses = {
2566
+ 200: ScoutDashboardResponseDto;
2567
+ };
2568
+ export type GetApiDashboardMeResponse = GetApiDashboardMeResponses[keyof GetApiDashboardMeResponses];
2569
+ export type GetApiDashboardVideosByIdPlayUrlData = {
2570
+ body?: never;
2571
+ path: {
2572
+ id: string;
2573
+ };
2574
+ query?: never;
2575
+ url: '/api/dashboard/videos/{id}/play-url';
2576
+ };
2577
+ export type GetApiDashboardVideosByIdPlayUrlErrors = {
2578
+ /**
2579
+ * Unauthorized
2580
+ */
2581
+ 401: unknown;
2582
+ /**
2583
+ * Video not found
2584
+ */
2585
+ 404: unknown;
2586
+ };
2587
+ export type GetApiDashboardVideosByIdPlayUrlResponses = {
2588
+ 200: PlayUrlResponseDto;
2589
+ };
2590
+ export type GetApiDashboardVideosByIdPlayUrlResponse = GetApiDashboardVideosByIdPlayUrlResponses[keyof GetApiDashboardVideosByIdPlayUrlResponses];
package/index.ts CHANGED
@@ -6,11 +6,13 @@ export {
6
6
  Body,
7
7
  Challenges,
8
8
  Clubs,
9
+ Dashboard,
9
10
  Documents,
10
11
  GlobalScoutMeClient,
11
12
  Index,
12
13
  Invitations,
13
14
  Kyc,
15
+ Notifications,
14
16
  Offers,
15
17
  type Options,
16
18
  Organizations,
@@ -42,6 +44,9 @@ export type {
42
44
  CreateUploadUrlDto,
43
45
  CreateVideoDto,
44
46
  DashboardResponseDto,
47
+ DashboardStatsDto,
48
+ DashboardVideoCardDto,
49
+ DeactivatePushDeviceDto,
45
50
  DeleteApiClubsMeByIdData,
46
51
  DeleteApiClubsMeByIdErrors,
47
52
  DeleteApiClubsMeByIdResponse,
@@ -50,6 +55,9 @@ export type {
50
55
  DeleteApiInvitationsByIdErrors,
51
56
  DeleteApiInvitationsByIdResponse,
52
57
  DeleteApiInvitationsByIdResponses,
58
+ DeleteApiNotificationsDevicesCurrentData,
59
+ DeleteApiNotificationsDevicesCurrentResponse,
60
+ DeleteApiNotificationsDevicesCurrentResponses,
53
61
  DeleteApiPlayersMeData,
54
62
  DeleteApiPlayersMeErrors,
55
63
  DeleteApiPlayersMeResponse,
@@ -87,6 +95,14 @@ export type {
87
95
  GetApiClubsMeErrors,
88
96
  GetApiClubsMeResponse,
89
97
  GetApiClubsMeResponses,
98
+ GetApiDashboardMeData,
99
+ GetApiDashboardMeErrors,
100
+ GetApiDashboardMeResponse,
101
+ GetApiDashboardMeResponses,
102
+ GetApiDashboardVideosByIdPlayUrlData,
103
+ GetApiDashboardVideosByIdPlayUrlErrors,
104
+ GetApiDashboardVideosByIdPlayUrlResponse,
105
+ GetApiDashboardVideosByIdPlayUrlResponses,
90
106
  GetApiDocumentsMeData,
91
107
  GetApiDocumentsMeErrors,
92
108
  GetApiDocumentsMeResponse,
@@ -106,6 +122,9 @@ export type {
106
122
  GetApiKycStatusByUserIdErrors,
107
123
  GetApiKycStatusByUserIdResponse,
108
124
  GetApiKycStatusByUserIdResponses,
125
+ GetApiNotificationsPreferencesData,
126
+ GetApiNotificationsPreferencesResponse,
127
+ GetApiNotificationsPreferencesResponses,
109
128
  GetApiOffersConversationsByIdMessagesData,
110
129
  GetApiOffersConversationsByIdMessagesErrors,
111
130
  GetApiOffersConversationsByIdMessagesResponse,
@@ -165,12 +184,17 @@ export type {
165
184
  MessageListResultDto,
166
185
  MessageSenderDto,
167
186
  MyChallengeDto,
187
+ NotificationPreferencesDto,
188
+ OkDto,
168
189
  OrganizationResponseDto,
169
190
  PaginatedTrainingContentDto,
170
191
  PatchApiClubsMeByIdData,
171
192
  PatchApiClubsMeByIdErrors,
172
193
  PatchApiClubsMeByIdResponse,
173
194
  PatchApiClubsMeByIdResponses,
195
+ PatchApiNotificationsPreferencesData,
196
+ PatchApiNotificationsPreferencesResponse,
197
+ PatchApiNotificationsPreferencesResponses,
174
198
  PatchApiOffersConversationsByIdReadData,
175
199
  PatchApiOffersConversationsByIdReadErrors,
176
200
  PatchApiOffersConversationsByIdReadResponses,
@@ -225,6 +249,9 @@ export type {
225
249
  PostApiKycWebhookData,
226
250
  PostApiKycWebhookErrors,
227
251
  PostApiKycWebhookResponses,
252
+ PostApiNotificationsDevicesData,
253
+ PostApiNotificationsDevicesResponse,
254
+ PostApiNotificationsDevicesResponses,
228
255
  PostApiOffersConversationsByIdMessagesData,
229
256
  PostApiOffersConversationsByIdMessagesErrors,
230
257
  PostApiOffersConversationsByIdMessagesResponse,
@@ -259,6 +286,7 @@ export type {
259
286
  PostApiVideosResponses,
260
287
  PreviousClubDto,
261
288
  ProfileResponseDto,
289
+ PushDeviceRegistrationResultDto,
262
290
  PutApiOrganizationsMeData,
263
291
  PutApiOrganizationsMeErrors,
264
292
  PutApiOrganizationsMeResponse,
@@ -271,6 +299,8 @@ export type {
271
299
  RegisterAgentResponseDto,
272
300
  RegisterClubDto,
273
301
  RegisterClubResponseDto,
302
+ RegisterPushDeviceDto,
303
+ ScoutDashboardResponseDto,
274
304
  SendInvitationRequestDto,
275
305
  SendMessageDto,
276
306
  StartKycRequestDto,
@@ -279,6 +309,7 @@ export type {
279
309
  TrainingContentDetailDto,
280
310
  TrainingContentListItemDto,
281
311
  UpdateClubDto,
312
+ UpdateNotificationPreferencesDto,
282
313
  UpdateOrganizationDto,
283
314
  UpdatePlayerDto,
284
315
  UpdateProfileDto,
package/package.json CHANGED
@@ -1,12 +1,20 @@
1
1
  {
2
2
  "name": "@globalscoutme/api-client",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
4
4
  "description": "GlobalScoutMe API client (generated)",
5
5
  "author": "GlobalScoutMe",
6
6
  "license": "UNLICENSED",
7
7
  "type": "module",
8
8
  "main": "./dist/index.js",
9
- "types": "./index.ts",
9
+ "module": "./dist/index.js",
10
+ "types": "./dist/index.d.ts",
11
+ "exports": {
12
+ ".": {
13
+ "types": "./dist/index.d.ts",
14
+ "import": "./dist/index.js",
15
+ "default": "./dist/index.js"
16
+ }
17
+ },
10
18
  "keywords": ["api-client","typescript"],
11
19
  "dependencies": {
12
20
  "@hey-api/client-axios": "^0.2.5",
package/sdk.gen.ts CHANGED
@@ -13,6 +13,8 @@ import type {
13
13
  DeleteApiInvitationsByIdData,
14
14
  DeleteApiInvitationsByIdErrors,
15
15
  DeleteApiInvitationsByIdResponses,
16
+ DeleteApiNotificationsDevicesCurrentData,
17
+ DeleteApiNotificationsDevicesCurrentResponses,
16
18
  DeleteApiPlayersMeData,
17
19
  DeleteApiPlayersMeErrors,
18
20
  DeleteApiPlayersMeResponses,
@@ -39,6 +41,12 @@ import type {
39
41
  GetApiClubsMeData,
40
42
  GetApiClubsMeErrors,
41
43
  GetApiClubsMeResponses,
44
+ GetApiDashboardMeData,
45
+ GetApiDashboardMeErrors,
46
+ GetApiDashboardMeResponses,
47
+ GetApiDashboardVideosByIdPlayUrlData,
48
+ GetApiDashboardVideosByIdPlayUrlErrors,
49
+ GetApiDashboardVideosByIdPlayUrlResponses,
42
50
  GetApiDocumentsMeData,
43
51
  GetApiDocumentsMeErrors,
44
52
  GetApiDocumentsMeResponses,
@@ -53,6 +61,8 @@ import type {
53
61
  GetApiKycStatusByUserIdData,
54
62
  GetApiKycStatusByUserIdErrors,
55
63
  GetApiKycStatusByUserIdResponses,
64
+ GetApiNotificationsPreferencesData,
65
+ GetApiNotificationsPreferencesResponses,
56
66
  GetApiOffersConversationsByIdMessagesData,
57
67
  GetApiOffersConversationsByIdMessagesErrors,
58
68
  GetApiOffersConversationsByIdMessagesResponses,
@@ -92,6 +102,8 @@ import type {
92
102
  PatchApiClubsMeByIdData,
93
103
  PatchApiClubsMeByIdErrors,
94
104
  PatchApiClubsMeByIdResponses,
105
+ PatchApiNotificationsPreferencesData,
106
+ PatchApiNotificationsPreferencesResponses,
95
107
  PatchApiOffersConversationsByIdReadData,
96
108
  PatchApiOffersConversationsByIdReadErrors,
97
109
  PatchApiOffersConversationsByIdReadResponses,
@@ -127,6 +139,8 @@ import type {
127
139
  PostApiKycWebhookData,
128
140
  PostApiKycWebhookErrors,
129
141
  PostApiKycWebhookResponses,
142
+ PostApiNotificationsDevicesData,
143
+ PostApiNotificationsDevicesResponses,
130
144
  PostApiOffersConversationsByIdMessagesData,
131
145
  PostApiOffersConversationsByIdMessagesErrors,
132
146
  PostApiOffersConversationsByIdMessagesResponses,
@@ -593,6 +607,69 @@ export class Offers extends HeyApiClient {
593
607
  }
594
608
  }
595
609
 
610
+ export class Notifications extends HeyApiClient {
611
+ public getNotificationPreferences<ThrowOnError extends boolean = false>(
612
+ options?: Options<GetApiNotificationsPreferencesData, ThrowOnError>,
613
+ ) {
614
+ return (options?.client ?? this.client).get<
615
+ GetApiNotificationsPreferencesResponses,
616
+ unknown,
617
+ ThrowOnError
618
+ >({ url: '/api/notifications/preferences', ...options });
619
+ }
620
+
621
+ public updateNotificationPreferences<ThrowOnError extends boolean = false>(
622
+ options: Options<PatchApiNotificationsPreferencesData, ThrowOnError>,
623
+ ) {
624
+ return (options.client ?? this.client).patch<
625
+ PatchApiNotificationsPreferencesResponses,
626
+ unknown,
627
+ ThrowOnError
628
+ >({
629
+ url: '/api/notifications/preferences',
630
+ ...options,
631
+ headers: {
632
+ 'Content-Type': 'application/json',
633
+ ...options.headers,
634
+ },
635
+ });
636
+ }
637
+
638
+ public registerPushDevice<ThrowOnError extends boolean = false>(
639
+ options: Options<PostApiNotificationsDevicesData, ThrowOnError>,
640
+ ) {
641
+ return (options.client ?? this.client).post<
642
+ PostApiNotificationsDevicesResponses,
643
+ unknown,
644
+ ThrowOnError
645
+ >({
646
+ url: '/api/notifications/devices',
647
+ ...options,
648
+ headers: {
649
+ 'Content-Type': 'application/json',
650
+ ...options.headers,
651
+ },
652
+ });
653
+ }
654
+
655
+ public deactivateCurrentPushDevice<ThrowOnError extends boolean = false>(
656
+ options: Options<DeleteApiNotificationsDevicesCurrentData, ThrowOnError>,
657
+ ) {
658
+ return (options.client ?? this.client).delete<
659
+ DeleteApiNotificationsDevicesCurrentResponses,
660
+ unknown,
661
+ ThrowOnError
662
+ >({
663
+ url: '/api/notifications/devices/current',
664
+ ...options,
665
+ headers: {
666
+ 'Content-Type': 'application/json',
667
+ ...options.headers,
668
+ },
669
+ });
670
+ }
671
+ }
672
+
596
673
  export class Organizations extends HeyApiClient {
597
674
  public registerClub<ThrowOnError extends boolean = false>(
598
675
  options: Options<PostApiOrganizationsRegisterClubData, ThrowOnError>,
@@ -922,6 +999,31 @@ export class Videos extends HeyApiClient {
922
999
  }
923
1000
  }
924
1001
 
1002
+ export class Dashboard extends HeyApiClient {
1003
+ public getScoutDashboard<ThrowOnError extends boolean = false>(
1004
+ options?: Options<GetApiDashboardMeData, ThrowOnError>,
1005
+ ) {
1006
+ return (options?.client ?? this.client).get<
1007
+ GetApiDashboardMeResponses,
1008
+ GetApiDashboardMeErrors,
1009
+ ThrowOnError
1010
+ >({ url: '/api/dashboard/me', ...options });
1011
+ }
1012
+
1013
+ /**
1014
+ * Signed play URL for a player video — records the view
1015
+ */
1016
+ public getScoutVideoPlayUrl<ThrowOnError extends boolean = false>(
1017
+ options: Options<GetApiDashboardVideosByIdPlayUrlData, ThrowOnError>,
1018
+ ) {
1019
+ return (options.client ?? this.client).get<
1020
+ GetApiDashboardVideosByIdPlayUrlResponses,
1021
+ GetApiDashboardVideosByIdPlayUrlErrors,
1022
+ ThrowOnError
1023
+ >({ url: '/api/dashboard/videos/{id}/play-url', ...options });
1024
+ }
1025
+ }
1026
+
925
1027
  export class GlobalScoutMeClient extends HeyApiClient {
926
1028
  public static readonly __registry = new HeyApiRegistry<GlobalScoutMeClient>();
927
1029
 
@@ -980,6 +1082,11 @@ export class GlobalScoutMeClient extends HeyApiClient {
980
1082
  return (this._offers ??= new Offers({ client: this.client }));
981
1083
  }
982
1084
 
1085
+ private _notifications?: Notifications;
1086
+ get notifications(): Notifications {
1087
+ return (this._notifications ??= new Notifications({ client: this.client }));
1088
+ }
1089
+
983
1090
  private _organizations?: Organizations;
984
1091
  get organizations(): Organizations {
985
1092
  return (this._organizations ??= new Organizations({ client: this.client }));
@@ -1009,4 +1116,9 @@ export class GlobalScoutMeClient extends HeyApiClient {
1009
1116
  get videos(): Videos {
1010
1117
  return (this._videos ??= new Videos({ client: this.client }));
1011
1118
  }
1119
+
1120
+ private _dashboard?: Dashboard;
1121
+ get dashboard(): Dashboard {
1122
+ return (this._dashboard ??= new Dashboard({ client: this.client }));
1123
+ }
1012
1124
  }
package/types.gen.ts CHANGED
@@ -306,6 +306,10 @@ export type PlayerSearchItemDto = {
306
306
  * Has at least one non-deleted video
307
307
  */
308
308
  hasVideo: boolean;
309
+ /**
310
+ * GSI profile score
311
+ */
312
+ gsiScore?: number | null;
309
313
  };
310
314
 
311
315
  export type PlayerSearchResultDto = {
@@ -1044,6 +1048,43 @@ export type SendMessageDto = {
1044
1048
  body: string;
1045
1049
  };
1046
1050
 
1051
+ export type NotificationPreferencesDto = {
1052
+ pushEnabled: boolean;
1053
+ offersEnabled: boolean;
1054
+ messagesEnabled: boolean;
1055
+ };
1056
+
1057
+ export type UpdateNotificationPreferencesDto = {
1058
+ pushEnabled?: boolean;
1059
+ offersEnabled?: boolean;
1060
+ messagesEnabled?: boolean;
1061
+ };
1062
+
1063
+ export type RegisterPushDeviceDto = {
1064
+ fcmToken: string;
1065
+ platform: 'ios' | 'android';
1066
+ installId: string;
1067
+ appVersion?: string;
1068
+ buildNumber?: string;
1069
+ locale?: string;
1070
+ timezone?: string;
1071
+ };
1072
+
1073
+ export type PushDeviceRegistrationResultDto = {
1074
+ pushEnabled: boolean;
1075
+ offersEnabled: boolean;
1076
+ messagesEnabled: boolean;
1077
+ id: string;
1078
+ };
1079
+
1080
+ export type DeactivatePushDeviceDto = {
1081
+ fcmToken: string;
1082
+ };
1083
+
1084
+ export type OkDto = {
1085
+ ok: boolean;
1086
+ };
1087
+
1047
1088
  export type RegisterClubDto = {
1048
1089
  /**
1049
1090
  * Club name
@@ -1496,6 +1537,68 @@ export type PlayUrlResponseDto = {
1496
1537
  expiresIn: number;
1497
1538
  };
1498
1539
 
1540
+ export type DashboardStatsDto = {
1541
+ /**
1542
+ * Number of players on the watchlist
1543
+ */
1544
+ watchlisted: number;
1545
+ /**
1546
+ * Number of offer conversations sent
1547
+ */
1548
+ offersSent: number;
1549
+ /**
1550
+ * Number of distinct players viewed
1551
+ */
1552
+ playersViewed: number;
1553
+ /**
1554
+ * Number of distinct videos watched
1555
+ */
1556
+ videosWatched: number;
1557
+ };
1558
+
1559
+ export type DashboardVideoCardDto = {
1560
+ videoId: string;
1561
+ /**
1562
+ * Signed thumbnail URL
1563
+ */
1564
+ thumbnailUrl?: string | null;
1565
+ /**
1566
+ * Video duration in seconds
1567
+ */
1568
+ durationSeconds?: number | null;
1569
+ /**
1570
+ * Player (owner) ID
1571
+ */
1572
+ playerId: string;
1573
+ firstName?: string | null;
1574
+ lastName?: string | null;
1575
+ avatarUrl?: string | null;
1576
+ /**
1577
+ * Age computed from date_of_birth
1578
+ */
1579
+ age?: number | null;
1580
+ /**
1581
+ * Primary position code
1582
+ */
1583
+ primaryPosition?: string | null;
1584
+ /**
1585
+ * GSI profile score
1586
+ */
1587
+ gsiScore?: number | null;
1588
+ };
1589
+
1590
+ export type ScoutDashboardResponseDto = {
1591
+ stats: DashboardStatsDto;
1592
+ /**
1593
+ * Last 6 distinct players viewed
1594
+ */
1595
+ lastPlayersViewed: Array<PlayerSearchItemDto>;
1596
+ /**
1597
+ * Last 6 distinct videos watched
1598
+ */
1599
+ lastVideosWatched: Array<DashboardVideoCardDto>;
1600
+ };
1601
+
1499
1602
  export type GetApiAuthMeData = {
1500
1603
  body?: never;
1501
1604
  path?: never;
@@ -2203,6 +2306,62 @@ export type PatchApiOffersConversationsByIdReadResponses = {
2203
2306
  200: unknown;
2204
2307
  };
2205
2308
 
2309
+ export type GetApiNotificationsPreferencesData = {
2310
+ body?: never;
2311
+ path?: never;
2312
+ query?: never;
2313
+ url: '/api/notifications/preferences';
2314
+ };
2315
+
2316
+ export type GetApiNotificationsPreferencesResponses = {
2317
+ 200: NotificationPreferencesDto;
2318
+ };
2319
+
2320
+ export type GetApiNotificationsPreferencesResponse =
2321
+ GetApiNotificationsPreferencesResponses[keyof GetApiNotificationsPreferencesResponses];
2322
+
2323
+ export type PatchApiNotificationsPreferencesData = {
2324
+ body: UpdateNotificationPreferencesDto;
2325
+ path?: never;
2326
+ query?: never;
2327
+ url: '/api/notifications/preferences';
2328
+ };
2329
+
2330
+ export type PatchApiNotificationsPreferencesResponses = {
2331
+ 200: NotificationPreferencesDto;
2332
+ };
2333
+
2334
+ export type PatchApiNotificationsPreferencesResponse =
2335
+ PatchApiNotificationsPreferencesResponses[keyof PatchApiNotificationsPreferencesResponses];
2336
+
2337
+ export type PostApiNotificationsDevicesData = {
2338
+ body: RegisterPushDeviceDto;
2339
+ path?: never;
2340
+ query?: never;
2341
+ url: '/api/notifications/devices';
2342
+ };
2343
+
2344
+ export type PostApiNotificationsDevicesResponses = {
2345
+ 201: PushDeviceRegistrationResultDto;
2346
+ };
2347
+
2348
+ export type PostApiNotificationsDevicesResponse =
2349
+ PostApiNotificationsDevicesResponses[keyof PostApiNotificationsDevicesResponses];
2350
+
2351
+ export type DeleteApiNotificationsDevicesCurrentData = {
2352
+ body: DeactivatePushDeviceDto;
2353
+ path?: never;
2354
+ query?: never;
2355
+ url: '/api/notifications/devices/current';
2356
+ };
2357
+
2358
+ export type DeleteApiNotificationsDevicesCurrentResponses = {
2359
+ 200: OkDto;
2360
+ };
2361
+
2362
+ export type DeleteApiNotificationsDevicesCurrentResponse =
2363
+ DeleteApiNotificationsDevicesCurrentResponses[keyof DeleteApiNotificationsDevicesCurrentResponses];
2364
+
2206
2365
  export type PostApiOrganizationsRegisterClubData = {
2207
2366
  body: RegisterClubDto;
2208
2367
  path?: never;
@@ -2757,3 +2916,51 @@ export type DeleteApiVideosByIdResponses = {
2757
2916
 
2758
2917
  export type DeleteApiVideosByIdResponse =
2759
2918
  DeleteApiVideosByIdResponses[keyof DeleteApiVideosByIdResponses];
2919
+
2920
+ export type GetApiDashboardMeData = {
2921
+ body?: never;
2922
+ path?: never;
2923
+ query?: never;
2924
+ url: '/api/dashboard/me';
2925
+ };
2926
+
2927
+ export type GetApiDashboardMeErrors = {
2928
+ /**
2929
+ * Unauthorized
2930
+ */
2931
+ 401: unknown;
2932
+ };
2933
+
2934
+ export type GetApiDashboardMeResponses = {
2935
+ 200: ScoutDashboardResponseDto;
2936
+ };
2937
+
2938
+ export type GetApiDashboardMeResponse =
2939
+ GetApiDashboardMeResponses[keyof GetApiDashboardMeResponses];
2940
+
2941
+ export type GetApiDashboardVideosByIdPlayUrlData = {
2942
+ body?: never;
2943
+ path: {
2944
+ id: string;
2945
+ };
2946
+ query?: never;
2947
+ url: '/api/dashboard/videos/{id}/play-url';
2948
+ };
2949
+
2950
+ export type GetApiDashboardVideosByIdPlayUrlErrors = {
2951
+ /**
2952
+ * Unauthorized
2953
+ */
2954
+ 401: unknown;
2955
+ /**
2956
+ * Video not found
2957
+ */
2958
+ 404: unknown;
2959
+ };
2960
+
2961
+ export type GetApiDashboardVideosByIdPlayUrlResponses = {
2962
+ 200: PlayUrlResponseDto;
2963
+ };
2964
+
2965
+ export type GetApiDashboardVideosByIdPlayUrlResponse =
2966
+ GetApiDashboardVideosByIdPlayUrlResponses[keyof GetApiDashboardVideosByIdPlayUrlResponses];