@globalscoutme/api-client 1.0.19 → 1.0.21

package/dist/types.gen.d.ts

@@ -168,6 +168,10 @@ export type UpdatePlayerDto = {
      * Bio
      */
     bio?: string;
+    /**
+     * Phone number
+     */
+    phone?: string | null;
 };
 export type PlayerSearchRequestDto = {
     /**
@@ -529,6 +533,10 @@ export type ProfileResponseDto = {
      * Agency name
      */
     agencyName?: string | null;
+    /**
+     * FIFA / scouting license number
+     */
+    scoutingLicenseNumber?: string | null;
     /**
      * Agency website URL
      */
@@ -655,6 +663,10 @@ export type UpdateProfileDto = {
      * Agency name
      */
     agencyName?: string;
+    /**
+     * FIFA / scouting license number
+     */
+    scoutingLicenseNumber?: string;
     /**
      * Agency website URL
      */
@@ -1014,6 +1026,50 @@ export type RegisterClubResponseDto = {
      */
     slug?: string;
 };
+export type RegisterAgentDto = {
+    /**
+     * Scout agency name
+     */
+    agencyName: string;
+    /**
+     * Agent first name
+     */
+    firstName: string;
+    /**
+     * Agent last name
+     */
+    lastName: string;
+    /**
+     * Agent email
+     */
+    email: string;
+    /**
+     * Password (min 8 characters)
+     */
+    password: string;
+    /**
+     * Agent phone number
+     */
+    phone?: string;
+};
+export type RegisterAgentResponseDto = {
+    /**
+     * Internal user_data id
+     */
+    userId: string;
+    /**
+     * Scout agency organization id
+     */
+    organizationId: string;
+    /**
+     * Scout agency name
+     */
+    agencyName: string;
+    /**
+     * Scout agency slug
+     */
+    slug?: string;
+};
 export type OrganizationResponseDto = {
     /**
      * Organization id
@@ -1163,6 +1219,92 @@ export type InvitationResponseDto = {
     expiresAt: string;
     acceptedAt?: string | null;
 };
+export type StartKycRequestDto = {
+    /**
+     * ISO 3166-1 alpha-2 country code (lowercase, matches index.countries)
+     */
+    country: string;
+    /**
+     * Channel initiating the KYC flow
+     */
+    channel: 'web' | 'mobile';
+};
+export type StartKycResponseDto = {
+    /**
+     * Short-lived token to Initialize the SmileID SDK widget
+     */
+    token?: string | null;
+    /**
+     * SmileID partner ID — required by the SDK
+     */
+    partnerId: string;
+    /**
+     * SmileID job identifier
+     */
+    jobId?: string | null;
+    status: 'pending' | 'capture_started' | 'processing' | 'approved' | 'rejected' | 'blocked';
+    /**
+     * Number of retries left before the account is blocked
+     */
+    retriesRemaining: number;
+    /**
+     * ISO 3166-1 alpha-2 country code used for the KYC attempt
+     */
+    country?: string | null;
+};
+export type WebhookPartnerParamsDto = {
+    /**
+     * Our job identifier echoed back by SmileID
+     */
+    job_id?: string;
+    user_id?: string;
+    job_type?: string;
+};
+export type KycWebhookDto = {
+    /**
+     * SmileID internal job ID
+     */
+    SmileJobID?: string;
+    PartnerParams?: WebhookPartnerParamsDto;
+    /**
+     * SmileID result code — 0810/1220/1221 = approved; 0001/0811/0812/0816/0903/1014 and 2xxx = rejected
+     */
+    ResultCode?: string;
+    ResultText?: string;
+    /**
+     * ISO timestamp used in HMAC-SHA256 signature
+     */
+    timestamp: string;
+    /**
+     * HMAC-SHA256 signature for request authenticity
+     */
+    signature: string;
+};
+export type MarkSubmittedKycRequestDto = {
+    /**
+     * SmileID job identifier returned by /kyc/start
+     */
+    jobId: string;
+};
+export type KycStatusDto = {
+    status: 'pending' | 'capture_started' | 'processing' | 'approved' | 'rejected' | 'blocked';
+    retryCount: number;
+    retriesRemaining: number;
+    /**
+     * SmileID job identifier for the current or latest KYC attempt
+     */
+    jobId?: string | null;
+    /**
+     * ISO 3166-1 alpha-2 country code used for the KYC attempt
+     */
+    country?: string | null;
+};
+export type CancelKycRequestDto = {
+    /**
+     * SmileID job identifier returned by /kyc/start or status
+     */
+    jobId: string;
+};
 export type TrainingContentListItemDto = {
     id: string;
     title: string;
@@ -1732,6 +1874,10 @@ export type PostApiOffersConversationsErrors = {
      * Unauthorized
      */
     401: unknown;
+    /**
+     * Only clubs and scouters can create offer conversations
+     */
+    403: unknown;
 };
 export type PostApiOffersConversationsResponses = {
     201: ConversationDetailDto;
@@ -1837,6 +1983,26 @@ export type PostApiOrganizationsRegisterClubResponses = {
     201: RegisterClubResponseDto;
 };
 export type PostApiOrganizationsRegisterClubResponse = PostApiOrganizationsRegisterClubResponses[keyof PostApiOrganizationsRegisterClubResponses];
+export type PostApiOrganizationsRegisterAgentData = {
+    body: RegisterAgentDto;
+    path?: never;
+    query?: never;
+    url: '/api/organizations/register-agent';
+};
+export type PostApiOrganizationsRegisterAgentErrors = {
+    /**
+     * Bad request
+     */
+    400: unknown;
+    /**
+     * Email already exists
+     */
+    409: unknown;
+};
+export type PostApiOrganizationsRegisterAgentResponses = {
+    201: RegisterAgentResponseDto;
+};
+export type PostApiOrganizationsRegisterAgentResponse = PostApiOrganizationsRegisterAgentResponses[keyof PostApiOrganizationsRegisterAgentResponses];
 export type GetApiOrganizationsMeData = {
     body?: never;
     path?: never;
@@ -1990,6 +2156,110 @@ export type PostApiInvitationsAcceptResponses = {
     204: void;
 };
 export type PostApiInvitationsAcceptResponse = PostApiInvitationsAcceptResponses[keyof PostApiInvitationsAcceptResponses];
+export type PostApiKycStartData = {
+    body: StartKycRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/start';
+};
+export type PostApiKycStartErrors = {
+    /**
+     * Invalid request
+     */
+    400: unknown;
+};
+export type PostApiKycStartResponses = {
+    200: StartKycResponseDto;
+};
+export type PostApiKycStartResponse = PostApiKycStartResponses[keyof PostApiKycStartResponses];
+export type PostApiKycWebhookData = {
+    body: KycWebhookDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/webhook';
+};
+export type PostApiKycWebhookErrors = {
+    /**
+     * Invalid signature
+     */
+    400: unknown;
+};
+export type PostApiKycWebhookResponses = {
+    /**
+     * Acknowledged
+     */
+    200: unknown;
+};
+export type PostApiKycMarkSubmittedData = {
+    body: MarkSubmittedKycRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/mark-submitted';
+};
+export type PostApiKycMarkSubmittedErrors = {
+    /**
+     * Invalid request
+     */
+    400: unknown;
+    /**
+     * No active KYC job found
+     */
+    404: unknown;
+    /**
+     * Submitted job is stale
+     */
+    409: unknown;
+};
+export type PostApiKycMarkSubmittedResponses = {
+    200: KycStatusDto;
+};
+export type PostApiKycMarkSubmittedResponse = PostApiKycMarkSubmittedResponses[keyof PostApiKycMarkSubmittedResponses];
+export type PostApiKycCancelData = {
+    body: CancelKycRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/kyc/cancel';
+};
+export type PostApiKycCancelErrors = {
+    /**
+     * Invalid request
+     */
+    400: unknown;
+    /**
+     * No active KYC job found
+     */
+    404: unknown;
+    /**
+     * Cancel job is stale
+     */
+    409: unknown;
+};
+export type PostApiKycCancelResponses = {
+    200: KycStatusDto;
+};
+export type PostApiKycCancelResponse = PostApiKycCancelResponses[keyof PostApiKycCancelResponses];
+export type GetApiKycStatusByUserIdData = {
+    body?: never;
+    path: {
+        userId: string;
+    };
+    query?: never;
+    url: '/api/kyc/status/{userId}';
+};
+export type GetApiKycStatusByUserIdErrors = {
+    /**
+     * Cannot access another user's KYC status
+     */
+    403: unknown;
+    /**
+     * No KYC record found
+     */
+    404: unknown;
+};
+export type GetApiKycStatusByUserIdResponses = {
+    200: KycStatusDto;
+};
+export type GetApiKycStatusByUserIdResponse = GetApiKycStatusByUserIdResponses[keyof GetApiKycStatusByUserIdResponses];
 export type GetApiTrainingGroupedData = {
     body?: never;
     path?: never;

package/index.ts

@@ -10,6 +10,7 @@ export {
   GlobalScoutMeClient,
   Index,
   Invitations,
+  Kyc,
   Offers,
   type Options,
   Organizations,
@@ -23,6 +24,7 @@ export type {
   AchievementCatalogDto,
   AuthMeResponseDto,
   BodyMeasurementResponseDto,
+  CancelKycRequestDto,
   CareerAchievementDto,
   ChallengeCatalogDto,
   ClientOptions,
@@ -100,6 +102,10 @@ export type {
   GetApiInvitationsData,
   GetApiInvitationsResponse,
   GetApiInvitationsResponses,
+  GetApiKycStatusByUserIdData,
+  GetApiKycStatusByUserIdErrors,
+  GetApiKycStatusByUserIdResponse,
+  GetApiKycStatusByUserIdResponses,
   GetApiOffersConversationsByIdMessagesData,
   GetApiOffersConversationsByIdMessagesErrors,
   GetApiOffersConversationsByIdMessagesResponse,
@@ -152,6 +158,9 @@ export type {
   HeartbeatResponseDto,
   IndexItemDto,
   InvitationResponseDto,
+  KycStatusDto,
+  KycWebhookDto,
+  MarkSubmittedKycRequestDto,
   MessageItemDto,
   MessageListResultDto,
   MessageSenderDto,
@@ -201,6 +210,21 @@ export type {
   PostApiInvitationsErrors,
   PostApiInvitationsResponse,
   PostApiInvitationsResponses,
+  PostApiKycCancelData,
+  PostApiKycCancelErrors,
+  PostApiKycCancelResponse,
+  PostApiKycCancelResponses,
+  PostApiKycMarkSubmittedData,
+  PostApiKycMarkSubmittedErrors,
+  PostApiKycMarkSubmittedResponse,
+  PostApiKycMarkSubmittedResponses,
+  PostApiKycStartData,
+  PostApiKycStartErrors,
+  PostApiKycStartResponse,
+  PostApiKycStartResponses,
+  PostApiKycWebhookData,
+  PostApiKycWebhookErrors,
+  PostApiKycWebhookResponses,
   PostApiOffersConversationsByIdMessagesData,
   PostApiOffersConversationsByIdMessagesErrors,
   PostApiOffersConversationsByIdMessagesResponse,
@@ -209,6 +233,10 @@ export type {
   PostApiOffersConversationsErrors,
   PostApiOffersConversationsResponse,
   PostApiOffersConversationsResponses,
+  PostApiOrganizationsRegisterAgentData,
+  PostApiOrganizationsRegisterAgentErrors,
+  PostApiOrganizationsRegisterAgentResponse,
+  PostApiOrganizationsRegisterAgentResponses,
   PostApiOrganizationsRegisterClubData,
   PostApiOrganizationsRegisterClubErrors,
   PostApiOrganizationsRegisterClubResponse,
@@ -239,10 +267,14 @@ export type {
   PutApiProfileMeErrors,
   PutApiProfileMeResponse,
   PutApiProfileMeResponses,
+  RegisterAgentDto,
+  RegisterAgentResponseDto,
   RegisterClubDto,
   RegisterClubResponseDto,
   SendInvitationRequestDto,
   SendMessageDto,
+  StartKycRequestDto,
+  StartKycResponseDto,
   TrainingCategoryGroupDto,
   TrainingContentDetailDto,
   TrainingContentListItemDto,
@@ -254,6 +286,7 @@ export type {
   UserAchievementResponseDto,
   VideoResponseDto,
   WatchingOrgDto,
+  WebhookPartnerParamsDto,
 } from './types.gen.js';
 
 export { client, type CreateClientConfig } from './client.gen.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@globalscoutme/api-client",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "GlobalScoutMe API client (generated)",
   "author": "GlobalScoutMe",
   "license": "UNLICENSED",

package/sdk.gen.ts

@@ -50,6 +50,9 @@ import type {
   GetApiIndexCountriesResponses,
   GetApiInvitationsData,
   GetApiInvitationsResponses,
+  GetApiKycStatusByUserIdData,
+  GetApiKycStatusByUserIdErrors,
+  GetApiKycStatusByUserIdResponses,
   GetApiOffersConversationsByIdMessagesData,
   GetApiOffersConversationsByIdMessagesErrors,
   GetApiOffersConversationsByIdMessagesResponses,
@@ -112,12 +115,27 @@ import type {
   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,
@@ -593,6 +611,23 @@ export class Organizations extends HeyApiClient {
     });
   }
 
+  public registerAgent<ThrowOnError extends boolean = false>(
+    options: Options<PostApiOrganizationsRegisterAgentData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiOrganizationsRegisterAgentResponses,
+      PostApiOrganizationsRegisterAgentErrors,
+      ThrowOnError
+    >({
+      url: '/api/organizations/register-agent',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
   public getMyOrganization<ThrowOnError extends boolean = false>(
     options?: Options<GetApiOrganizationsMeData, ThrowOnError>,
   ) {
@@ -702,6 +737,101 @@ export class Invitations extends HeyApiClient {
   }
 }
 
+export class Kyc extends HeyApiClient {
+  /**
+   * Start or resume a KYC verification job
+   */
+  public startKyc<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycStartData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycStartResponses,
+      PostApiKycStartErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/start',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * SmileID webhook — receives job results (public, signature-verified)
+   */
+  public kycWebhook<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycWebhookData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycWebhookResponses,
+      PostApiKycWebhookErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/webhook',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Mark the current KYC capture job as submitted
+   */
+  public markSubmittedKyc<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycMarkSubmittedData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycMarkSubmittedResponses,
+      PostApiKycMarkSubmittedErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/mark-submitted',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Cancel the active KYC verification job for the current user
+   */
+  public cancelKyc<ThrowOnError extends boolean = false>(
+    options: Options<PostApiKycCancelData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).post<
+      PostApiKycCancelResponses,
+      PostApiKycCancelErrors,
+      ThrowOnError
+    >({
+      url: '/api/kyc/cancel',
+      ...options,
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Get KYC status for a user
+   */
+  public getKycStatus<ThrowOnError extends boolean = false>(
+    options: Options<GetApiKycStatusByUserIdData, ThrowOnError>,
+  ) {
+    return (options.client ?? this.client).get<
+      GetApiKycStatusByUserIdResponses,
+      GetApiKycStatusByUserIdErrors,
+      ThrowOnError
+    >({ url: '/api/kyc/status/{userId}', ...options });
+  }
+}
+
 export class Training extends HeyApiClient {
   /**
    * Get training content grouped by category, top 3 per category
@@ -865,6 +995,11 @@ export class GlobalScoutMeClient extends HeyApiClient {
     return (this._invitations ??= new Invitations({ client: this.client }));
   }
 
+  private _kyc?: Kyc;
+  get kyc(): Kyc {
+    return (this._kyc ??= new Kyc({ client: this.client }));
+  }
+
   private _training?: Training;
   get training(): Training {
     return (this._training ??= new Training({ client: this.client }));