@globalscoutme/api-client 1.0.11 → 1.0.14

package/dist/types.gen.d.ts

@@ -57,6 +57,24 @@ export type PlayerResponseDto = {
      */
     updatedAt?: string | null;
 };
+export type DivisionDto = {
+    /**
+     * Division tier 1 (highest) to 5 (lowest)
+     */
+    number: 1 | 2 | 3 | 4 | 5;
+    /**
+     * Minimum XP of the current tier
+     */
+    currentTierMin: number;
+    /**
+     * Minimum XP of the next tier; null at top tier
+     */
+    nextTierMin: number | null;
+    /**
+     * Progress through current tier, range [0, 1]
+     */
+    progressInTier: number;
+};
 export type DashboardResponseDto = {
     /**
      * First name
@@ -102,6 +120,20 @@ export type DashboardResponseDto = {
      * Has at least one language set
      */
     hasLanguages: boolean;
+    /**
+     * Cumulative XP from completed challenges
+     */
+    totalXp: number;
+    division: DivisionDto;
+};
+export type HeartbeatDto = {
+    /**
+     * IANA timezone from the client device
+     */
+    timezone: string;
+};
+export type HeartbeatResponseDto = {
+    ok: boolean;
 };
 export type UpdatePlayerDto = {
     /**
@@ -377,6 +409,10 @@ export type ProfileResponseDto = {
      * Internal user_data id
      */
     id: string;
+    /**
+     * Email address
+     */
+    email?: string | null;
     /**
      * First name
      */
@@ -662,6 +698,97 @@ export type CreateBodyMeasurementDto = {
      */
     imageUrl?: string;
 };
+export type ChallengeCatalogDto = {
+    id: string;
+    code: string;
+    name: string;
+    description?: string | null;
+    categoryCode: string;
+    xpReward: number;
+    deadlineDays: number;
+    resetPeriod?: string | null;
+    iconUrl?: string | null;
+    displayOrder?: number | null;
+};
+export type MyChallengeDto = {
+    /**
+     * user_challenges.id — stable per (user, challenge, period)
+     */
+    id: string;
+    code: string;
+    name: string;
+    description?: string | null;
+    categoryCode: string;
+    xpReward: number;
+    deadlineDays: number;
+    resetPeriod?: string | null;
+    iconUrl?: string | null;
+    status: 'active' | 'completed' | 'expired';
+    /**
+     * Current progress, 0..target
+     */
+    progress: number;
+    /**
+     * Completion threshold
+     */
+    target: number;
+    /**
+     * ISO timestamp when this instance expires
+     */
+    expiresAt: string;
+    /**
+     * ISO timestamp — when the user first saw this challenge instance
+     */
+    startedAt: string;
+    /**
+     * ISO timestamp; null if not yet completed
+     */
+    completedAt?: string | null;
+    /**
+     * ISO date for period start (0001-01-01 sentinel for non-resetting)
+     */
+    periodStart: string;
+};
+export type ClubResponseDto = {
+    id: string;
+    userId: string;
+    clubName: string;
+    userTypeCode?: string | null;
+    isCurrent: boolean;
+    joinedAt?: string | null;
+    leftAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+export type CreateClubDto = {
+    /**
+     * Display name of the club (free text).
+     */
+    clubName: string;
+    /**
+     * ISO date string — when the player joined.
+     */
+    joinedAt?: string;
+    /**
+     * ISO date string — when the player left.
+     */
+    leftAt?: string;
+    /**
+     * Whether this is the currently active club.
+     */
+    isCurrent?: boolean;
+    /**
+     * Role at the club (e.g. player, coach). Matches index.user_types.code.
+     */
+    userTypeCode?: string;
+};
+export type UpdateClubDto = {
+    clubName?: string;
+    joinedAt?: string;
+    leftAt?: string;
+    isCurrent?: boolean;
+    userTypeCode?: string;
+};
 export type DocumentResponseDto = {
     id: string;
     userId: string;
@@ -703,6 +830,11 @@ export type IndexItemDto = {
      */
     displayOrder: number | null;
 };
+export type ConversationOrganizationDto = {
+    id: string;
+    name: string;
+    logoUrl: string | null;
+};
 export type ConversationParticipantDto = {
     /**
      * user_data id
@@ -719,6 +851,11 @@ export type ConversationParticipantDto = {
      * Primary position code
      */
     primaryPosition?: string | null;
+    /**
+     * user_data.user_type code (e.g. club_admin, scouter)
+     */
+    userType: string | null;
+    organization?: ConversationOrganizationDto | null;
 };
 export type ConversationItemDto = {
     /**
@@ -856,6 +993,10 @@ export type OrganizationResponseDto = {
      * Club name
      */
     name: string;
+    /**
+     * Club crest / logo URL
+     */
+    logoUrl?: string | null;
     /**
      * Slug
      */
@@ -902,6 +1043,10 @@ export type UpdateOrganizationDto = {
      * Club name
      */
     name?: string;
+    /**
+     * Club crest / logo URL, null to clear
+     */
+    logoUrl?: string | null;
     /**
      * Country code (2-letter ISO)
      */
@@ -975,6 +1120,57 @@ export type UploadUrlResponseDto = {
      */
     expiresIn: number;
 };
+export type SendInvitationRequestDto = {
+    email: string;
+};
+export type InvitationResponseDto = {
+    id: string;
+    email: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    status: 'confirmed' | 'pending' | 'expired';
+    invitedAt: string;
+    expiresAt: string;
+    acceptedAt?: string | null;
+};
+export type TrainingContentListItemDto = {
+    id: string;
+    title: string;
+    summary?: string | null;
+    thumbnailUrl?: string | null;
+    durationSeconds?: number | null;
+    categoryCode: string;
+    difficultyLevel: string;
+    xpReward: number;
+    displayOrder?: number | null;
+};
+export type TrainingCategoryGroupDto = {
+    categoryCode: string;
+    categoryName: string;
+    items: Array<TrainingContentListItemDto>;
+};
+export type PaginatedTrainingContentDto = {
+    items: Array<TrainingContentListItemDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type TrainingContentDetailDto = {
+    id: string;
+    title: string;
+    subtitle?: string | null;
+    description?: string | null;
+    thumbnailUrl?: string | null;
+    videoUrl?: string | null;
+    durationSeconds?: number | null;
+    categoryCode: string;
+    difficultyLevel: string;
+    xpReward: number;
+    displayOrder?: number | null;
+};
 export type VideoResponseDto = {
     id: string;
     userId: string;
@@ -1110,6 +1306,22 @@ export type GetPlayersMeDashboardResponses = {
     200: DashboardResponseDto;
 };
 export type GetPlayersMeDashboardResponse = GetPlayersMeDashboardResponses[keyof GetPlayersMeDashboardResponses];
+export type PostPlayersMeHeartbeatData = {
+    body: HeartbeatDto;
+    path?: never;
+    query?: never;
+    url: '/players/me/heartbeat';
+};
+export type PostPlayersMeHeartbeatErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type PostPlayersMeHeartbeatResponses = {
+    200: HeartbeatResponseDto;
+};
+export type PostPlayersMeHeartbeatResponse = PostPlayersMeHeartbeatResponses[keyof PostPlayersMeHeartbeatResponses];
 export type PostPlayersSearchData = {
     body: PlayerSearchRequestDto;
     path?: never;
@@ -1262,6 +1474,121 @@ export type PostBodyMeasurementsResponses = {
     201: BodyMeasurementResponseDto;
 };
 export type PostBodyMeasurementsResponse = PostBodyMeasurementsResponses[keyof PostBodyMeasurementsResponses];
+export type GetChallengesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/challenges';
+};
+export type GetChallengesErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type GetChallengesResponses = {
+    200: Array<ChallengeCatalogDto>;
+};
+export type GetChallengesResponse = GetChallengesResponses[keyof GetChallengesResponses];
+export type GetChallengesMeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/challenges/me';
+};
+export type GetChallengesMeErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Player-only endpoint
+     */
+    403: unknown;
+};
+export type GetChallengesMeResponses = {
+    200: Array<MyChallengeDto>;
+};
+export type GetChallengesMeResponse = GetChallengesMeResponses[keyof GetChallengesMeResponses];
+export type GetClubsMeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/clubs/me';
+};
+export type GetClubsMeErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type GetClubsMeResponses = {
+    200: Array<ClubResponseDto>;
+};
+export type GetClubsMeResponse = GetClubsMeResponses[keyof GetClubsMeResponses];
+export type PostClubsMeData = {
+    body: CreateClubDto;
+    path?: never;
+    query?: never;
+    url: '/clubs/me';
+};
+export type PostClubsMeErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type PostClubsMeResponses = {
+    201: ClubResponseDto;
+};
+export type PostClubsMeResponse = PostClubsMeResponses[keyof PostClubsMeResponses];
+export type DeleteClubsMeByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/clubs/me/{id}';
+};
+export type DeleteClubsMeByIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Club not found
+     */
+    404: unknown;
+};
+export type DeleteClubsMeByIdResponses = {
+    /**
+     * Club deleted
+     */
+    204: void;
+};
+export type DeleteClubsMeByIdResponse = DeleteClubsMeByIdResponses[keyof DeleteClubsMeByIdResponses];
+export type PatchClubsMeByIdData = {
+    body: UpdateClubDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/clubs/me/{id}';
+};
+export type PatchClubsMeByIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Club not found
+     */
+    404: unknown;
+};
+export type PatchClubsMeByIdResponses = {
+    200: ClubResponseDto;
+};
+export type PatchClubsMeByIdResponse = PatchClubsMeByIdResponses[keyof PatchClubsMeByIdResponses];
 export type GetDocumentsMeData = {
     body?: never;
     path?: never;
@@ -1329,7 +1656,7 @@ export type GetOffersConversationsData = {
     body?: never;
     path?: never;
     query?: {
-        filter?: 'all' | 'unread' | 'read';
+        filter?: 'all' | 'unread' | 'read' | 'clubs' | 'agents';
         page?: number;
         pageSize?: number;
     };
@@ -1528,6 +1855,150 @@ export type PostStorageUploadUrlResponses = {
     201: UploadUrlResponseDto;
 };
 export type PostStorageUploadUrlResponse = PostStorageUploadUrlResponses[keyof PostStorageUploadUrlResponses];
+export type GetInvitationsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/invitations';
+};
+export type GetInvitationsResponses = {
+    200: Array<InvitationResponseDto>;
+};
+export type GetInvitationsResponse = GetInvitationsResponses[keyof GetInvitationsResponses];
+export type PostInvitationsData = {
+    body: SendInvitationRequestDto;
+    path?: never;
+    query?: never;
+    url: '/invitations';
+};
+export type PostInvitationsErrors = {
+    /**
+     * Limit reached or duplicate email
+     */
+    400: unknown;
+};
+export type PostInvitationsResponses = {
+    201: InvitationResponseDto;
+};
+export type PostInvitationsResponse = PostInvitationsResponses[keyof PostInvitationsResponses];
+export type PostInvitationsByIdResendData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/invitations/{id}/resend';
+};
+export type PostInvitationsByIdResendErrors = {
+    /**
+     * Cannot resend a confirmed invitation
+     */
+    400: unknown;
+    /**
+     * Invitation not found
+     */
+    404: unknown;
+};
+export type PostInvitationsByIdResendResponses = {
+    200: InvitationResponseDto;
+};
+export type PostInvitationsByIdResendResponse = PostInvitationsByIdResendResponses[keyof PostInvitationsByIdResendResponses];
+export type DeleteInvitationsByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/invitations/{id}';
+};
+export type DeleteInvitationsByIdErrors = {
+    /**
+     * Cannot delete a confirmed invitation
+     */
+    400: unknown;
+    /**
+     * Invitation not found
+     */
+    404: unknown;
+};
+export type DeleteInvitationsByIdResponses = {
+    /**
+     * Deleted
+     */
+    204: void;
+};
+export type DeleteInvitationsByIdResponse = DeleteInvitationsByIdResponses[keyof DeleteInvitationsByIdResponses];
+export type PostInvitationsAcceptData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/invitations/accept';
+};
+export type PostInvitationsAcceptResponses = {
+    /**
+     * Accepted (or no pending invitation — idempotent)
+     */
+    204: void;
+};
+export type PostInvitationsAcceptResponse = PostInvitationsAcceptResponses[keyof PostInvitationsAcceptResponses];
+export type GetTrainingGroupedData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/training/grouped';
+};
+export type GetTrainingGroupedErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type GetTrainingGroupedResponses = {
+    200: Array<TrainingCategoryGroupDto>;
+};
+export type GetTrainingGroupedResponse = GetTrainingGroupedResponses[keyof GetTrainingGroupedResponses];
+export type GetTrainingData = {
+    body?: never;
+    path?: never;
+    query?: {
+        categoryCode?: string;
+        page?: number;
+        pageSize?: number;
+    };
+    url: '/training';
+};
+export type GetTrainingErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type GetTrainingResponses = {
+    200: PaginatedTrainingContentDto;
+};
+export type GetTrainingResponse = GetTrainingResponses[keyof GetTrainingResponses];
+export type GetTrainingByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/training/{id}';
+};
+export type GetTrainingByIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Not found
+     */
+    404: unknown;
+};
+export type GetTrainingByIdResponses = {
+    200: TrainingContentDetailDto;
+};
+export type GetTrainingByIdResponse = GetTrainingByIdResponses[keyof GetTrainingByIdResponses];
 export type GetVideosMeData = {
     body?: never;
     path?: never;

package/index.ts

@@ -4,15 +4,19 @@ export {
   Achievements,
   Auth,
   Body,
+  Challenges,
+  Clubs,
   Documents,
   GlobalScoutMeClient,
   Index,
+  Invitations,
   Offers,
   type Options,
   Organizations,
   Players,
   Profile,
   Storage,
+  Training,
   Videos,
 } from './sdk.gen.js';
 export type {
@@ -20,17 +24,29 @@ export type {
   AuthMeResponseDto,
   BodyMeasurementResponseDto,
   CareerAchievementDto,
+  ChallengeCatalogDto,
   ClientOptions,
+  ClubResponseDto,
   ConversationDetailDto,
   ConversationItemDto,
   ConversationListResultDto,
+  ConversationOrganizationDto,
   ConversationParticipantDto,
   CreateBodyMeasurementDto,
+  CreateClubDto,
   CreateConversationDto,
   CreateDocumentDto,
   CreateUploadUrlDto,
   CreateVideoDto,
   DashboardResponseDto,
+  DeleteClubsMeByIdData,
+  DeleteClubsMeByIdErrors,
+  DeleteClubsMeByIdResponse,
+  DeleteClubsMeByIdResponses,
+  DeleteInvitationsByIdData,
+  DeleteInvitationsByIdErrors,
+  DeleteInvitationsByIdResponse,
+  DeleteInvitationsByIdResponses,
   DeletePlayersMeData,
   DeletePlayersMeErrors,
   DeletePlayersMeResponse,
@@ -39,6 +55,7 @@ export type {
   DeleteVideosByIdErrors,
   DeleteVideosByIdResponse,
   DeleteVideosByIdResponses,
+  DivisionDto,
   DocumentResponseDto,
   GetAchievementsData,
   GetAchievementsMeData,
@@ -55,6 +72,18 @@ export type {
   GetBodyMeasurementsMeErrors,
   GetBodyMeasurementsMeResponse,
   GetBodyMeasurementsMeResponses,
+  GetChallengesData,
+  GetChallengesErrors,
+  GetChallengesMeData,
+  GetChallengesMeErrors,
+  GetChallengesMeResponse,
+  GetChallengesMeResponses,
+  GetChallengesResponse,
+  GetChallengesResponses,
+  GetClubsMeData,
+  GetClubsMeErrors,
+  GetClubsMeResponse,
+  GetClubsMeResponses,
   GetDocumentsMeData,
   GetDocumentsMeErrors,
   GetDocumentsMeResponse,
@@ -63,6 +92,9 @@ export type {
   GetIndexByTableNameErrors,
   GetIndexByTableNameResponse,
   GetIndexByTableNameResponses,
+  GetInvitationsData,
+  GetInvitationsResponse,
+  GetInvitationsResponses,
   GetOffersConversationsByIdMessagesData,
   GetOffersConversationsByIdMessagesErrors,
   GetOffersConversationsByIdMessagesResponse,
@@ -91,6 +123,18 @@ export type {
   GetProfileMeErrors,
   GetProfileMeResponse,
   GetProfileMeResponses,
+  GetTrainingByIdData,
+  GetTrainingByIdErrors,
+  GetTrainingByIdResponse,
+  GetTrainingByIdResponses,
+  GetTrainingData,
+  GetTrainingErrors,
+  GetTrainingGroupedData,
+  GetTrainingGroupedErrors,
+  GetTrainingGroupedResponse,
+  GetTrainingGroupedResponses,
+  GetTrainingResponse,
+  GetTrainingResponses,
   GetVideosByIdPlayUrlData,
   GetVideosByIdPlayUrlErrors,
   GetVideosByIdPlayUrlResponse,
@@ -99,11 +143,20 @@ export type {
   GetVideosMeErrors,
   GetVideosMeResponse,
   GetVideosMeResponses,
+  HeartbeatDto,
+  HeartbeatResponseDto,
   IndexItemDto,
+  InvitationResponseDto,
   MessageItemDto,
   MessageListResultDto,
   MessageSenderDto,
+  MyChallengeDto,
   OrganizationResponseDto,
+  PaginatedTrainingContentDto,
+  PatchClubsMeByIdData,
+  PatchClubsMeByIdErrors,
+  PatchClubsMeByIdResponse,
+  PatchClubsMeByIdResponses,
   PatchOffersConversationsByIdReadData,
   PatchOffersConversationsByIdReadErrors,
   PatchOffersConversationsByIdReadResponses,
@@ -124,10 +177,25 @@ export type {
   PostBodyMeasurementsErrors,
   PostBodyMeasurementsResponse,
   PostBodyMeasurementsResponses,
+  PostClubsMeData,
+  PostClubsMeErrors,
+  PostClubsMeResponse,
+  PostClubsMeResponses,
   PostDocumentsData,
   PostDocumentsErrors,
   PostDocumentsResponse,
   PostDocumentsResponses,
+  PostInvitationsAcceptData,
+  PostInvitationsAcceptResponse,
+  PostInvitationsAcceptResponses,
+  PostInvitationsByIdResendData,
+  PostInvitationsByIdResendErrors,
+  PostInvitationsByIdResendResponse,
+  PostInvitationsByIdResendResponses,
+  PostInvitationsData,
+  PostInvitationsErrors,
+  PostInvitationsResponse,
+  PostInvitationsResponses,
   PostOffersConversationsByIdMessagesData,
   PostOffersConversationsByIdMessagesErrors,
   PostOffersConversationsByIdMessagesResponse,
@@ -140,6 +208,10 @@ export type {
   PostOrganizationsRegisterClubErrors,
   PostOrganizationsRegisterClubResponse,
   PostOrganizationsRegisterClubResponses,
+  PostPlayersMeHeartbeatData,
+  PostPlayersMeHeartbeatErrors,
+  PostPlayersMeHeartbeatResponse,
+  PostPlayersMeHeartbeatResponses,
   PostPlayersSearchData,
   PostPlayersSearchErrors,
   PostPlayersSearchResponse,
@@ -164,7 +236,12 @@ export type {
   PutProfileMeResponses,
   RegisterClubDto,
   RegisterClubResponseDto,
+  SendInvitationRequestDto,
   SendMessageDto,
+  TrainingCategoryGroupDto,
+  TrainingContentDetailDto,
+  TrainingContentListItemDto,
+  UpdateClubDto,
   UpdateOrganizationDto,
   UpdatePlayerDto,
   UpdateProfileDto,