@globalscoutme/api-client 1.2.7 → 1.4.0

package/dist/types.gen.d.ts

@@ -11,13 +11,21 @@ export type AuthMeResponseDto = {
      */
     userType?: string | null;
     /**
-     * The user's role within their organization (club/agency), e.g. for web page-level access. Null for user types without an organization membership (player, coach).
+     * The user's role within their organization (club/agency), e.g. for web page-level access. Multiple active memberships return the non-admin user role so privileged access fails closed. Null for user types without an organization membership (player, coach).
      */
-    orgRole?: 'admin' | 'user';
+    orgRole?: 'admin' | 'user' | null;
     /**
      * Preferred application and generated-content locale. Null until first selected.
      */
     preferredLocale?: 'en' | 'es' | 'fr' | 'de' | 'ro';
+    /**
+     * Whether this account can access the Super Admin portal.
+     */
+    isSuperAdmin: boolean;
+    /**
+     * Current account lifecycle status.
+     */
+    accountStatus: 'active' | 'pending' | 'suspended' | 'deactivated';
 };
 export type UpdateLocalePreferenceDto = {
     locale: 'en' | 'es' | 'fr' | 'de' | 'ro';
@@ -225,7 +233,7 @@ export type UpdatePlayerDto = {
     /**
      * User type code
      */
-    userType?: string;
+    userType?: 'player' | 'coach' | 'club_admin' | 'scouter';
     /**
      * Avatar URL
      */
@@ -292,6 +300,14 @@ export type PlayerSearchRequestDto = {
      * Height value in cm — must be paired with heightOperator
      */
     heightCm?: number;
+    /**
+     * Gender codes from index.genders (multi-select)
+     */
+    genders?: Array<string>;
+    /**
+     * Also include players with no gender set. Combined with genders as OR; on its own, returns only players without a gender
+     */
+    includeUnspecifiedGender?: boolean;
     /**
      * Only free agents
      */
@@ -963,6 +979,28 @@ export type BillingEntitlementResponseDto = {
 export type RedeemAccessCodeDto = {
     code: string;
 };
+export type RedeemAccessCodeResponseDto = {
+    hasAccess: boolean;
+    status: string;
+    provider?: string | null;
+    plan?: BillingPlanDto | null;
+    currentPeriodEnd?: string | null;
+    gracePeriodUntil?: string | null;
+    blockingReason?: string | null;
+    manageAction: BillingManageActionDto;
+    redemptionOutcome?: 'redeemed' | 'already_redeemed';
+};
+export type AccessCodeBadRequestResponseDto = {
+    statusCode: number;
+    error: string;
+    code?: 'ACCESS_CODE_REQUIRED' | 'ACCESS_CODE_INVALID' | 'ACCESS_CODE_INACTIVE' | 'ACCESS_CODE_NOT_ACTIVE_YET' | 'ACCESS_CODE_EXPIRED' | 'ACCESS_CODE_REDEMPTION_LIMIT_REACHED' | 'ACCESS_CODE_MISCONFIGURED';
+    message: string;
+};
+export type AccessCodeConflictResponseDto = {
+    statusCode: number;
+    code: 'ACCESS_CODE_ALREADY_REDEEMED' | 'ACTIVE_BILLING_ACCESS_EXISTS';
+    message: string;
+};
 export type ReportPurchaseDto = {
     id: string;
     paymentStatus: string;
@@ -2620,6 +2658,247 @@ export type MarkGlobalChatReadDto = {
 export type UpdateGlobalChatNotificationsDto = {
     notificationsEnabled: boolean;
 };
+export type AdminMetricDto = {
+    current: number;
+    periodCount: number;
+    byRole?: {
+        [key: string]: number;
+    };
+};
+export type AdminDashboardMetricsDto = {
+    registeredUsers: AdminMetricDto;
+    activeSubscriptions: AdminMetricDto;
+    pendingKyc: AdminMetricDto;
+    verifiedKyc: AdminMetricDto;
+    videosUploaded: AdminMetricDto;
+    aiReports: AdminMetricDto;
+    bodyMeasurements: AdminMetricDto;
+    speedSprintTests: AdminMetricDto;
+};
+export type AdminActivityBucketDto = {
+    bucketStart: string;
+    registrations: number;
+    videos: number;
+    aiReports: number;
+    bodyMeasurements: number;
+    speedSprintTests: number;
+};
+export type AdminSubscriptionHealthDto = {
+    role: string;
+    active: number;
+    cancelled: number;
+    expired: number;
+};
+export type AdminDashboardResponseDto = {
+    range: '7d' | '30d' | '3mo';
+    generatedAt: string;
+    metrics: AdminDashboardMetricsDto;
+    activity: Array<AdminActivityBucketDto>;
+    subscriptionHealth: Array<AdminSubscriptionHealthDto>;
+};
+export type AdminUserListItemDto = {
+    id: string;
+    name: string;
+    email: string;
+    role: string | null;
+    countryCode: string | null;
+    country: string | null;
+    accountStatus: 'active' | 'pending' | 'suspended' | 'deactivated';
+    kycStatus: string;
+    subscriptionStatus: string;
+    registrationDate: string | null;
+    isSuperAdmin: boolean;
+};
+export type AdminUserListResultDto = {
+    items: Array<AdminUserListItemDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type AdminUserDetailDto = {
+    id: string;
+    name: string;
+    email: string;
+    role: string | null;
+    countryCode: string | null;
+    country: string | null;
+    accountStatus: 'active' | 'pending' | 'suspended' | 'deactivated';
+    kycStatus: string;
+    subscriptionStatus: string;
+    registrationDate: string | null;
+    isSuperAdmin: boolean;
+};
+export type AdminSubscriptionListItemDto = {
+    id: string;
+    userId: string;
+    userName: string;
+    email: string;
+    role: string | null;
+    plan: string;
+    planInterval: string | null;
+    platform: string;
+    price: number;
+    currency: string;
+    status: string;
+    cancelsAtPeriodEnd: boolean;
+    startDate: string | null;
+    nextBillingDate: string | null;
+    externalUrl: string | null;
+};
+export type AdminSubscriptionListResultDto = {
+    items: Array<AdminSubscriptionListItemDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type AdminKycListItemDto = {
+    id: string;
+    userId: string;
+    userName: string;
+    email: string;
+    role: string | null;
+    country: string | null;
+    status: string;
+    provider: string;
+    submittedAt: string | null;
+    updatedAt: string | null;
+};
+export type AdminKycListResultDto = {
+    items: Array<AdminKycListItemDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type AdminAccessCodePlanDto = {
+    id: string;
+    name: string;
+    role: string | null;
+};
+export type AdminAccessCodeDto = {
+    id: string;
+    code: string | null;
+    description: string | null;
+    codeSuffix: string | null;
+    planId: string;
+    planName: string;
+    role: string | null;
+    durationDays: number;
+    startsAt: string | null;
+    expiresAt: string | null;
+    maxRedemptions: number | null;
+    redemptionCount: number;
+    isActive: boolean;
+    status: 'scheduled' | 'active' | 'inactive' | 'expired' | 'exhausted';
+    createdAt: string;
+};
+export type AdminAccessCodeListResultDto = {
+    items: Array<AdminAccessCodeDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type AdminCreateAccessCodeDto = {
+    planId: string;
+    description?: string;
+    durationDays: number;
+    startsAt?: string | null;
+    expiresAt?: string | null;
+    maxRedemptions?: number | null;
+};
+export type AdminCreateAccessCodeResponseDto = {
+    id: string;
+    /**
+     * Generated access code visible to Super Admins.
+     */
+    code: string | null;
+    description: string | null;
+    codeSuffix: string | null;
+    planId: string;
+    planName: string;
+    role: string | null;
+    durationDays: number;
+    startsAt: string | null;
+    expiresAt: string | null;
+    maxRedemptions: number | null;
+    redemptionCount: number;
+    isActive: boolean;
+    status: 'scheduled' | 'active' | 'inactive' | 'expired' | 'exhausted';
+    createdAt: string;
+};
+export type AdminSetAccessCodeStateDto = {
+    isActive: boolean;
+    reason?: string;
+};
+export type AdminAccessCodeRedemptionDto = {
+    id: string;
+    userId: string;
+    userName: string;
+    email: string;
+    redeemedAt: string;
+    startsAt: string;
+    endsAt: string;
+};
+export type AdminAccessCodeRedemptionListResultDto = {
+    items: Array<AdminAccessCodeRedemptionDto>;
+    /**
+     * Total matching records
+     */
+    total: number;
+    page: number;
+    pageSize: number;
+};
+export type AdminUserAccessDto = {
+    hasAccess: boolean;
+    status: string;
+    provider: string | null;
+    planId: string | null;
+    planName: string | null;
+    startsAt: string | null;
+    endsAt: string | null;
+    adminGrantId: string | null;
+};
+export type AdminGrantAccessDto = {
+    planId: string;
+    durationDays: number;
+    reason?: string;
+};
+export type AdminAccessGrantDto = {
+    id: string;
+    userId: string;
+    planId: string;
+    planName: string;
+    startsAt: string;
+    endsAt: string;
+    status: 'active' | 'revoked';
+};
+export type AdminRevokeAccessGrantDto = {
+    reason?: string;
+};
+export type AdminUserActionRequestDto = {
+    /**
+     * Optional reason stored in the audit trail
+     */
+    reason?: string;
+};
+export type AdminAccountActionResponseDto = {
+    accountStatus: 'active' | 'pending' | 'suspended' | 'deactivated';
+    authSyncStatus: 'succeeded' | 'failed';
+};
+export type AdminPasswordResetResponseDto = {
+    deliveryStatus: 'succeeded' | 'failed';
+};
 export type GetApiAuthMeData = {
     body?: never;
     path?: never;
@@ -2695,10 +2974,18 @@ export type PatchApiPlayersMeData = {
     url: '/api/players/me';
 };
 export type PatchApiPlayersMeErrors = {
+    /**
+     * Invalid persona assignment or active organization conflict
+     */
+    400: unknown;
     /**
      * Unauthorized
      */
     401: unknown;
+    /**
+     * Active billing entitlement is required to continue onboarding
+     */
+    403: unknown;
 };
 export type PatchApiPlayersMeResponses = {
     200: PlayerResponseDto;
@@ -2967,11 +3254,22 @@ export type PostApiBillingAccessCodesRedeemData = {
     query?: never;
     url: '/api/billing/access-codes/redeem';
 };
+export type PostApiBillingAccessCodesRedeemErrors = {
+    /**
+     * The code is invalid, inactive, not yet active, expired, or unavailable
+     */
+    400: AccessCodeBadRequestResponseDto;
+    /**
+     * The code was already redeemed or another entitlement is still active
+     */
+    409: AccessCodeConflictResponseDto;
+};
+export type PostApiBillingAccessCodesRedeemError = PostApiBillingAccessCodesRedeemErrors[keyof PostApiBillingAccessCodesRedeemErrors];
 export type PostApiBillingAccessCodesRedeemResponses = {
     /**
      * Redeemed access entitlement
      */
-    201: BillingEntitlementResponseDto;
+    201: RedeemAccessCodeResponseDto;
 };
 export type PostApiBillingAccessCodesRedeemResponse = PostApiBillingAccessCodesRedeemResponses[keyof PostApiBillingAccessCodesRedeemResponses];
 export type GetApiBillingReportPurchasesCurrentData = {
@@ -3809,6 +4107,16 @@ export type GetApiInvitationsData = {
     query?: never;
     url: '/api/invitations';
 };
+export type GetApiInvitationsErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Active organization admin membership required
+     */
+    403: unknown;
+};
 export type GetApiInvitationsResponses = {
     200: Array<InvitationResponseDto>;
 };
@@ -3821,9 +4129,25 @@ export type PostApiInvitationsData = {
 };
 export type PostApiInvitationsErrors = {
     /**
-     * Limit reached or duplicate email
+     * Limit reached, active invitation, membership or registered account exists, or invitee is a player
      */
     400: unknown;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Active organization admin membership required
+     */
+    403: unknown;
+    /**
+     * Invitation email rate limit exceeded
+     */
+    429: unknown;
+    /**
+     * Supabase Auth invitation delivery failed
+     */
+    502: unknown;
 };
 export type PostApiInvitationsResponses = {
     201: InvitationResponseDto;
@@ -3839,13 +4163,29 @@ export type PostApiInvitationsByIdResendData = {
 };
 export type PostApiInvitationsByIdResendErrors = {
     /**
-     * Cannot resend a confirmed invitation
+     * Invitation is confirmed, another active invitation, membership or registered account exists, or invitee is a player
      */
     400: unknown;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Active organization admin membership required
+     */
+    403: unknown;
     /**
      * Invitation not found
      */
     404: unknown;
+    /**
+     * Invitation email rate limit exceeded
+     */
+    429: unknown;
+    /**
+     * Supabase Auth invitation delivery failed
+     */
+    502: unknown;
 };
 export type PostApiInvitationsByIdResendResponses = {
     200: InvitationResponseDto;
@@ -3864,6 +4204,14 @@ export type DeleteApiInvitationsByIdErrors = {
      * Cannot delete a confirmed invitation
      */
     400: unknown;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Active organization admin membership required
+     */
+    403: unknown;
     /**
      * Invitation not found
      */
@@ -3882,9 +4230,27 @@ export type PostApiInvitationsAcceptData = {
     query?: never;
     url: '/api/invitations/accept';
 };
+export type PostApiInvitationsAcceptErrors = {
+    /**
+     * Invitation cannot be accepted for this account or has expired
+     */
+    400: unknown;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Invitation or account not found
+     */
+    404: unknown;
+    /**
+     * Invitation accepted; metadata cleanup can be retried
+     */
+    502: unknown;
+};
 export type PostApiInvitationsAcceptResponses = {
     /**
-     * Accepted (or no pending invitation — idempotent)
+     * Accepted or already linked to the selected invitation
      */
     204: void;
 };
@@ -4668,3 +5034,239 @@ export type PatchApiGlobalChatNotificationsResponses = {
     200: GlobalChatStatusDto;
 };
 export type PatchApiGlobalChatNotificationsResponse = PatchApiGlobalChatNotificationsResponses[keyof PatchApiGlobalChatNotificationsResponses];
+export type GetApiAdminDashboardData = {
+    body?: never;
+    path?: never;
+    query?: {
+        range?: '7d' | '30d' | '3mo';
+    };
+    url: '/api/admin/dashboard';
+};
+export type GetApiAdminDashboardErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Super Admin access required
+     */
+    403: unknown;
+};
+export type GetApiAdminDashboardResponses = {
+    200: AdminDashboardResponseDto;
+};
+export type GetApiAdminDashboardResponse = GetApiAdminDashboardResponses[keyof GetApiAdminDashboardResponses];
+export type GetApiAdminUsersData = {
+    body?: never;
+    path?: never;
+    query?: {
+        page?: number;
+        pageSize?: number;
+        search?: string;
+        role?: string;
+        status?: 'active' | 'pending' | 'suspended' | 'deactivated';
+        subscriptionStatus?: string;
+        country?: string;
+    };
+    url: '/api/admin/users';
+};
+export type GetApiAdminUsersResponses = {
+    200: AdminUserListResultDto;
+};
+export type GetApiAdminUsersResponse = GetApiAdminUsersResponses[keyof GetApiAdminUsersResponses];
+export type GetApiAdminUsersByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}';
+};
+export type GetApiAdminUsersByIdErrors = {
+    /**
+     * User not found
+     */
+    404: unknown;
+};
+export type GetApiAdminUsersByIdResponses = {
+    200: AdminUserDetailDto;
+};
+export type GetApiAdminUsersByIdResponse = GetApiAdminUsersByIdResponses[keyof GetApiAdminUsersByIdResponses];
+export type GetApiAdminSubscriptionsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        page?: number;
+        pageSize?: number;
+        search?: string;
+        role?: string;
+        plan?: string;
+        status?: string;
+    };
+    url: '/api/admin/subscriptions';
+};
+export type GetApiAdminSubscriptionsResponses = {
+    200: AdminSubscriptionListResultDto;
+};
+export type GetApiAdminSubscriptionsResponse = GetApiAdminSubscriptionsResponses[keyof GetApiAdminSubscriptionsResponses];
+export type GetApiAdminKycData = {
+    body?: never;
+    path?: never;
+    query?: {
+        page?: number;
+        pageSize?: number;
+        search?: string;
+        status?: string;
+        country?: string;
+    };
+    url: '/api/admin/kyc';
+};
+export type GetApiAdminKycResponses = {
+    200: AdminKycListResultDto;
+};
+export type GetApiAdminKycResponse = GetApiAdminKycResponses[keyof GetApiAdminKycResponses];
+export type GetApiAdminAccessCodesPlansData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/admin/access-codes/plans';
+};
+export type GetApiAdminAccessCodesPlansResponses = {
+    200: Array<AdminAccessCodePlanDto>;
+};
+export type GetApiAdminAccessCodesPlansResponse = GetApiAdminAccessCodesPlansResponses[keyof GetApiAdminAccessCodesPlansResponses];
+export type GetApiAdminAccessCodesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        page?: number;
+        pageSize?: number;
+        status?: 'scheduled' | 'active' | 'inactive' | 'expired' | 'exhausted';
+    };
+    url: '/api/admin/access-codes';
+};
+export type GetApiAdminAccessCodesResponses = {
+    200: AdminAccessCodeListResultDto;
+};
+export type GetApiAdminAccessCodesResponse = GetApiAdminAccessCodesResponses[keyof GetApiAdminAccessCodesResponses];
+export type PostApiAdminAccessCodesData = {
+    body: AdminCreateAccessCodeDto;
+    path?: never;
+    query?: never;
+    url: '/api/admin/access-codes';
+};
+export type PostApiAdminAccessCodesResponses = {
+    201: AdminCreateAccessCodeResponseDto;
+};
+export type PostApiAdminAccessCodesResponse = PostApiAdminAccessCodesResponses[keyof PostApiAdminAccessCodesResponses];
+export type PatchApiAdminAccessCodesByIdData = {
+    body: AdminSetAccessCodeStateDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/access-codes/{id}';
+};
+export type PatchApiAdminAccessCodesByIdResponses = {
+    200: AdminAccessCodeDto;
+};
+export type PatchApiAdminAccessCodesByIdResponse = PatchApiAdminAccessCodesByIdResponses[keyof PatchApiAdminAccessCodesByIdResponses];
+export type GetApiAdminAccessCodesByIdRedemptionsData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query: {
+        page: number;
+        pageSize: number;
+    };
+    url: '/api/admin/access-codes/{id}/redemptions';
+};
+export type GetApiAdminAccessCodesByIdRedemptionsResponses = {
+    200: AdminAccessCodeRedemptionListResultDto;
+};
+export type GetApiAdminAccessCodesByIdRedemptionsResponse = GetApiAdminAccessCodesByIdRedemptionsResponses[keyof GetApiAdminAccessCodesByIdRedemptionsResponses];
+export type GetApiAdminUsersByIdAccessData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/access';
+};
+export type GetApiAdminUsersByIdAccessResponses = {
+    200: AdminUserAccessDto;
+};
+export type GetApiAdminUsersByIdAccessResponse = GetApiAdminUsersByIdAccessResponses[keyof GetApiAdminUsersByIdAccessResponses];
+export type PostApiAdminUsersByIdAccessGrantsData = {
+    body: AdminGrantAccessDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/access-grants';
+};
+export type PostApiAdminUsersByIdAccessGrantsResponses = {
+    201: AdminAccessGrantDto;
+};
+export type PostApiAdminUsersByIdAccessGrantsResponse = PostApiAdminUsersByIdAccessGrantsResponses[keyof PostApiAdminUsersByIdAccessGrantsResponses];
+export type PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeData = {
+    body: AdminRevokeAccessGrantDto;
+    path: {
+        id: string;
+        grantId: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/access-grants/{grantId}/revoke';
+};
+export type PostApiAdminUsersByIdAccessGrantsByGrantIdRevokeResponses = {
+    201: unknown;
+};
+export type PostApiAdminUsersByIdSuspendData = {
+    body: AdminUserActionRequestDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/suspend';
+};
+export type PostApiAdminUsersByIdSuspendResponses = {
+    201: AdminAccountActionResponseDto;
+};
+export type PostApiAdminUsersByIdSuspendResponse = PostApiAdminUsersByIdSuspendResponses[keyof PostApiAdminUsersByIdSuspendResponses];
+export type PostApiAdminUsersByIdReactivateData = {
+    body: AdminUserActionRequestDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/reactivate';
+};
+export type PostApiAdminUsersByIdReactivateResponses = {
+    201: AdminAccountActionResponseDto;
+};
+export type PostApiAdminUsersByIdReactivateResponse = PostApiAdminUsersByIdReactivateResponses[keyof PostApiAdminUsersByIdReactivateResponses];
+export type PostApiAdminUsersByIdResetPasswordData = {
+    body: AdminUserActionRequestDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/reset-password';
+};
+export type PostApiAdminUsersByIdResetPasswordResponses = {
+    201: AdminPasswordResetResponseDto;
+};
+export type PostApiAdminUsersByIdResetPasswordResponse = PostApiAdminUsersByIdResetPasswordResponses[keyof PostApiAdminUsersByIdResetPasswordResponses];
+export type PostApiAdminUsersByIdDeactivateData = {
+    body: AdminUserActionRequestDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/admin/users/{id}/deactivate';
+};
+export type PostApiAdminUsersByIdDeactivateResponses = {
+    201: AdminAccountActionResponseDto;
+};
+export type PostApiAdminUsersByIdDeactivateResponse = PostApiAdminUsersByIdDeactivateResponses[keyof PostApiAdminUsersByIdDeactivateResponses];