@globalscoutme/api-client 1.1.4 → 1.1.5
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 +23 -1
- package/dist/index.d.ts +1 -1
- package/dist/sdk.gen.d.ts +5 -1
- package/dist/sdk.gen.js +13 -0
- package/dist/types.gen.d.ts +68 -4
- package/index.ts +9 -0
- package/package.json +1 -1
- package/sdk.gen.ts +23 -0
- package/types.gen.ts +84 -4
package/README.md
CHANGED
|
@@ -186,13 +186,35 @@ await Invitations.deleteInvitation({ path: { id: 'invitation-uuid' } });
|
|
|
186
186
|
await Invitations.acceptInvitation(); // called after Supabase auth callback
|
|
187
187
|
|
|
188
188
|
// KYC — SmileID Enhanced Document Verification
|
|
189
|
+
//
|
|
190
|
+
// Two integration options:
|
|
191
|
+
|
|
192
|
+
// Option A — Smile Links (recommended for web)
|
|
193
|
+
// Backend returns a hosted SmileID URL; redirect the user to it.
|
|
194
|
+
// SmileID handles the full capture UI and fires the webhook when done.
|
|
195
|
+
const linkResult = await Kyc.startSmileLink({
|
|
196
|
+
body: {
|
|
197
|
+
country: 'gh',
|
|
198
|
+
channel: 'web',
|
|
199
|
+
returnUrl: 'https://yourapp.com/onboarding/kyc/callback',
|
|
200
|
+
},
|
|
201
|
+
});
|
|
202
|
+
// linkResult: { url, jobId, status, retriesRemaining }
|
|
203
|
+
// url is null when no redirect is needed (approved / blocked / processing).
|
|
204
|
+
if (linkResult.data.url) {
|
|
205
|
+
window.location.href = linkResult.data.url; // redirect user to SmileID
|
|
206
|
+
}
|
|
207
|
+
// After the user returns to returnUrl, poll getKycStatus to confirm the result.
|
|
208
|
+
// markSubmittedKyc is NOT needed for Smile Links — SmileID fires the webhook directly.
|
|
209
|
+
|
|
210
|
+
// Option B — SDK widget (embedded, for mobile / advanced web)
|
|
189
211
|
const kycResult = await Kyc.startKyc({
|
|
190
212
|
body: { country: 'gh', channel: 'web' },
|
|
191
213
|
});
|
|
192
214
|
// kycResult: { token, partnerId, jobId, status, retriesRemaining }
|
|
193
215
|
// Pass token + partnerId to the SmileID web SDK widget to start document capture.
|
|
194
216
|
// After the SDK reports successful submission, call markSubmittedKyc with jobId.
|
|
195
|
-
await Kyc.markSubmittedKyc({ body: { jobId: kycResult.jobId! } });
|
|
217
|
+
await Kyc.markSubmittedKyc({ body: { jobId: kycResult.data.jobId! } });
|
|
196
218
|
// SmileID also calls POST /kyc/webhook with final processing results.
|
|
197
219
|
|
|
198
220
|
const kycStatus = await Kyc.getKycStatus({
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { Achievements, Auth, Billing, Body, Challenges, Clubs, Cmj, Dashboard, Documents, GlobalScoutMeClient, Index, Invitations, Kyc, Measurements, Notifications, Offers, type Options, Organizations, Players, Profile, Storage, Subscriptions, Training, Videos, } from './sdk.gen.js';
|
|
2
|
-
export type { AchievementCatalogDto, AiReportClipDto, AiReportClipTargetDto, AiReportMetaDto, AiReportResultResponseDto, AiReportViewDto, AuthMeResponseDto, BillingEntitlementResponseDto, BillingManageActionDto, BillingPlanDto, BillingPlansResponseDto, BillingProductDto, BillingProductsResponseDto, BillingProviderProductDto, BodyMeasurementProfileDto, BodyMeasurementResponseDto, CancelKycRequestDto, CareerAchievementDto, ChallengeCatalogDto, CheckoutResultDto, ClientOptions, ClubResponseDto, CmjMeasurementProfileDto, CmjMeasurementResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateCheckoutDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateMeasurementPlayerSessionDto, CreatePortalDto, 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, GetApiBillingMeData, GetApiBillingMeResponse, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponse, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponse, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponse, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponse, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponse, GetApiCmjMeasurementsMeResponses, 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, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponse, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponse, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponse, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponse, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponse, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponse, GetApiSubscriptionsPlansResponses, 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, MeasurementProfileResponseDto, MeasurementSessionDto, MeasurementSessionMetricsDto, MeasurementTagEvaluationDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, MySubscriptionDto, NotificationPreferencesDto, OkDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponse, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlansListDto, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerReportResponseDto, PlayerReportViewDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PortalResultDto, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponse, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponse, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponse, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, 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, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponse, PostApiMeasurementsPlayerSessionMeResponses, 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, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponse, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponse, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, ProviderCheckoutRequestDto, PushDeviceRegistrationResultDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RedeemAccessCodeDto, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, RegisterPushDeviceDto, ReportGenerationStartResponseDto, ReportPlayerCandidateBboxDto, ReportPlayerCandidateDto, ReportPlayerCandidatesRequestDto, ReportPlayerCandidatesResponseDto, ReportPlayerCandidateTargetDto, ReportPrerequisiteDto, ReportPurchaseDto, ReportPurchaseStatusResponseDto, ReportVideoCandidatesDto, ScoutDashboardResponseDto, SendInvitationRequestDto, SendMessageDto, StartKycRequestDto, StartKycResponseDto, StartReportGenerationClipDto, StartReportGenerationRequestDto, StorePurchaseSyncRequestDto, SubscriptionPlanDto, TrainingCategoryGroupDto, TrainingContentDetailDto, TrainingContentListItemDto, UpdateClubDto, UpdateNotificationPreferencesDto, UpdateOrganizationDto, UpdatePlayerDto, UpdateProfileDto, UploadUrlResponseDto, UserAchievementResponseDto, VideoResponseDto, WatchingOrgDto, WebhookPartnerParamsDto, } from './types.gen.js';
|
|
2
|
+
export type { AchievementCatalogDto, AiReportClipDto, AiReportClipTargetDto, AiReportImprovementAreaDto, AiReportMetaDto, AiReportPillarDetailDto, AiReportResultResponseDto, AiReportSubcategoryDto, AiReportViewDto, AuthMeResponseDto, BillingEntitlementResponseDto, BillingManageActionDto, BillingPlanDto, BillingPlansResponseDto, BillingProductDto, BillingProductsResponseDto, BillingProviderProductDto, BodyMeasurementProfileDto, BodyMeasurementResponseDto, CancelKycRequestDto, CareerAchievementDto, ChallengeCatalogDto, CheckoutResultDto, ClientOptions, ClubResponseDto, CmjMeasurementProfileDto, CmjMeasurementResponseDto, ConversationDetailDto, ConversationItemDto, ConversationListResultDto, ConversationOrganizationDto, ConversationParticipantDto, CountryDto, CreateBodyMeasurementDto, CreateCheckoutDto, CreateClubDto, CreateConversationDto, CreateDocumentDto, CreateMeasurementPlayerSessionDto, CreatePortalDto, 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, GetApiBillingMeData, GetApiBillingMeResponse, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponse, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponse, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponse, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponse, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponse, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponse, GetApiChallengesMeResponses, GetApiChallengesResponse, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponse, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponse, GetApiCmjMeasurementsMeResponses, 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, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponse, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponse, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponse, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponse, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponse, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponse, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponse, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponse, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponse, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponse, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponse, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponse, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponse, GetApiSubscriptionsPlansResponses, 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, MeasurementProfileResponseDto, MeasurementSessionDto, MeasurementSessionMetricsDto, MeasurementTagEvaluationDto, MessageItemDto, MessageListResultDto, MessageSenderDto, MyChallengeDto, MySubscriptionDto, NotificationPreferencesDto, OkDto, OrganizationResponseDto, PaginatedTrainingContentDto, PatchApiClubsMeByIdData, PatchApiClubsMeByIdErrors, PatchApiClubsMeByIdResponse, PatchApiClubsMeByIdResponses, PatchApiNotificationsPreferencesData, PatchApiNotificationsPreferencesResponse, PatchApiNotificationsPreferencesResponses, PatchApiOffersConversationsByIdReadData, PatchApiOffersConversationsByIdReadErrors, PatchApiOffersConversationsByIdReadResponses, PatchApiPlayersMeData, PatchApiPlayersMeErrors, PatchApiPlayersMeResponse, PatchApiPlayersMeResponses, PlansListDto, PlayerAchievementDto, PlayerByIdDto, PlayerClubDto, PlayerReportResponseDto, PlayerReportViewDto, PlayerResponseDto, PlayerSearchItemDto, PlayerSearchRequestDto, PlayerSearchResultDto, PlayerVideoDto, PlayUrlResponseDto, PortalResultDto, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponse, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponse, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponse, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, 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, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponse, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponse, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponse, PostApiMeasurementsPlayerSessionMeResponses, 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, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponse, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponse, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, PostApiVideosData, PostApiVideosErrors, PostApiVideosResponse, PostApiVideosResponses, PreviousClubDto, ProfileResponseDto, ProviderCheckoutRequestDto, PushDeviceRegistrationResultDto, PutApiOrganizationsMeData, PutApiOrganizationsMeErrors, PutApiOrganizationsMeResponse, PutApiOrganizationsMeResponses, PutApiProfileMeData, PutApiProfileMeErrors, PutApiProfileMeResponse, PutApiProfileMeResponses, RedeemAccessCodeDto, RegisterAgentDto, RegisterAgentResponseDto, RegisterClubDto, RegisterClubResponseDto, RegisterPushDeviceDto, ReportGenerationStartResponseDto, ReportPlayerCandidateBboxDto, ReportPlayerCandidateDto, ReportPlayerCandidatesRequestDto, ReportPlayerCandidatesResponseDto, ReportPlayerCandidateTargetDto, ReportPrerequisiteDto, ReportPurchaseDto, ReportPurchaseStatusResponseDto, ReportVideoCandidatesDto, ScoutDashboardResponseDto, SendInvitationRequestDto, SendMessageDto, SmileLinkRequestDto, SmileLinkResponseDto, StartKycRequestDto, StartKycResponseDto, StartReportGenerationClipDto, StartReportGenerationRequestDto, StorePurchaseSyncRequestDto, SubscriptionPlanDto, 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/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, DeleteApiNotificationsDevicesCurrentData, DeleteApiNotificationsDevicesCurrentResponses, DeleteApiPlayersMeData, DeleteApiPlayersMeErrors, DeleteApiPlayersMeResponses, DeleteApiVideosByIdData, DeleteApiVideosByIdErrors, DeleteApiVideosByIdResponses, GetApiAchievementsData, GetApiAchievementsMeData, GetApiAchievementsMeErrors, GetApiAchievementsMeResponses, GetApiAchievementsResponses, GetApiAuthMeData, GetApiAuthMeErrors, GetApiAuthMeResponses, GetApiBillingMeData, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponses, 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, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, 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, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, 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, GetApiBillingMeData, GetApiBillingMeResponses, GetApiBillingPlansData, GetApiBillingPlansResponses, GetApiBillingProductsData, GetApiBillingProductsResponses, GetApiBillingReportPurchasesByIdReportData, GetApiBillingReportPurchasesByIdReportResponses, GetApiBillingReportPurchasesCurrentData, GetApiBillingReportPurchasesCurrentResponses, GetApiBodyMeasurementsMeData, GetApiBodyMeasurementsMeErrors, GetApiBodyMeasurementsMeResponses, GetApiChallengesData, GetApiChallengesErrors, GetApiChallengesMeData, GetApiChallengesMeErrors, GetApiChallengesMeResponses, GetApiChallengesResponses, GetApiClubsMeData, GetApiClubsMeErrors, GetApiClubsMeResponses, GetApiCmjMeasurementsMeData, GetApiCmjMeasurementsMeErrors, GetApiCmjMeasurementsMeResponses, GetApiDashboardMeData, GetApiDashboardMeErrors, GetApiDashboardMeResponses, GetApiDashboardVideosByIdPlayUrlData, GetApiDashboardVideosByIdPlayUrlErrors, GetApiDashboardVideosByIdPlayUrlResponses, GetApiDocumentsMeData, GetApiDocumentsMeErrors, GetApiDocumentsMeResponses, GetApiIndexByTableNameData, GetApiIndexByTableNameErrors, GetApiIndexByTableNameResponses, GetApiIndexCountriesData, GetApiIndexCountriesErrors, GetApiIndexCountriesResponses, GetApiInvitationsData, GetApiInvitationsResponses, GetApiKycStatusByUserIdData, GetApiKycStatusByUserIdErrors, GetApiKycStatusByUserIdResponses, GetApiMeasurementsProfileMeData, GetApiMeasurementsProfileMeErrors, GetApiMeasurementsProfileMeResponses, GetApiNotificationsPreferencesData, GetApiNotificationsPreferencesResponses, GetApiOffersConversationsByIdMessagesData, GetApiOffersConversationsByIdMessagesErrors, GetApiOffersConversationsByIdMessagesResponses, GetApiOffersConversationsData, GetApiOffersConversationsErrors, GetApiOffersConversationsResponses, GetApiOrganizationsMeData, GetApiOrganizationsMeErrors, GetApiOrganizationsMeResponses, GetApiPlayersByIdData, GetApiPlayersByIdErrors, GetApiPlayersByIdMeasurementsData, GetApiPlayersByIdMeasurementsErrors, GetApiPlayersByIdMeasurementsResponses, GetApiPlayersByIdReportData, GetApiPlayersByIdReportErrors, GetApiPlayersByIdReportResponses, GetApiPlayersByIdResponses, GetApiPlayersMeDashboardData, GetApiPlayersMeDashboardErrors, GetApiPlayersMeDashboardResponses, GetApiPlayersMeData, GetApiPlayersMeErrors, GetApiPlayersMeResponses, GetApiProfileMeData, GetApiProfileMeErrors, GetApiProfileMeResponses, GetApiSubscriptionsMeData, GetApiSubscriptionsMeResponses, GetApiSubscriptionsPlansData, GetApiSubscriptionsPlansResponses, 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, PostApiBillingAccessCodesRedeemData, PostApiBillingAccessCodesRedeemResponses, PostApiBillingAppleSyncPurchaseData, PostApiBillingAppleSyncPurchaseResponses, PostApiBillingGoogleSyncPurchaseData, PostApiBillingGoogleSyncPurchaseResponses, PostApiBillingReportPurchasesByIdStartGenerationData, PostApiBillingReportPurchasesByIdStartGenerationResponses, PostApiBillingReportPurchasesPlayerCandidatesData, PostApiBillingReportPurchasesPlayerCandidatesResponses, PostApiBillingStripeCheckoutSessionData, PostApiBillingStripeCheckoutSessionResponses, PostApiBillingStripePortalSessionData, PostApiBillingStripePortalSessionResponses, PostApiBodyMeasurementsData, PostApiBodyMeasurementsErrors, PostApiBodyMeasurementsResponses, PostApiClubsMeData, PostApiClubsMeErrors, PostApiClubsMeResponses, PostApiDocumentsData, PostApiDocumentsErrors, PostApiDocumentsResponses, PostApiInvitationsAcceptData, PostApiInvitationsAcceptResponses, PostApiInvitationsByIdResendData, PostApiInvitationsByIdResendErrors, PostApiInvitationsByIdResendResponses, PostApiInvitationsData, PostApiInvitationsErrors, PostApiInvitationsResponses, PostApiKycCancelData, PostApiKycCancelErrors, PostApiKycCancelResponses, PostApiKycMarkSubmittedData, PostApiKycMarkSubmittedErrors, PostApiKycMarkSubmittedResponses, PostApiKycSmileLinkData, PostApiKycSmileLinkErrors, PostApiKycSmileLinkResponses, PostApiKycStartData, PostApiKycStartErrors, PostApiKycStartResponses, PostApiKycWebhookData, PostApiKycWebhookErrors, PostApiKycWebhookResponses, PostApiMeasurementsPlayerSessionMeData, PostApiMeasurementsPlayerSessionMeErrors, PostApiMeasurementsPlayerSessionMeResponses, PostApiNotificationsDevicesData, PostApiNotificationsDevicesResponses, PostApiOffersConversationsByIdMessagesData, PostApiOffersConversationsByIdMessagesErrors, PostApiOffersConversationsByIdMessagesResponses, PostApiOffersConversationsData, PostApiOffersConversationsErrors, PostApiOffersConversationsResponses, PostApiOrganizationsRegisterAgentData, PostApiOrganizationsRegisterAgentErrors, PostApiOrganizationsRegisterAgentResponses, PostApiOrganizationsRegisterClubData, PostApiOrganizationsRegisterClubErrors, PostApiOrganizationsRegisterClubResponses, PostApiPlayersMeHeartbeatData, PostApiPlayersMeHeartbeatErrors, PostApiPlayersMeHeartbeatResponses, PostApiPlayersSearchData, PostApiPlayersSearchErrors, PostApiPlayersSearchResponses, PostApiStorageUploadUrlData, PostApiStorageUploadUrlErrors, PostApiStorageUploadUrlResponses, PostApiSubscriptionsCheckoutData, PostApiSubscriptionsCheckoutErrors, PostApiSubscriptionsCheckoutResponses, PostApiSubscriptionsPortalData, PostApiSubscriptionsPortalErrors, PostApiSubscriptionsPortalResponses, PostApiSubscriptionsWebhookData, PostApiSubscriptionsWebhookErrors, PostApiSubscriptionsWebhookResponses, 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
|
|
@@ -136,6 +136,10 @@ export declare class Kyc extends HeyApiClient {
|
|
|
136
136
|
* Start or resume a KYC verification job
|
|
137
137
|
*/
|
|
138
138
|
startKyc<ThrowOnError extends boolean = false>(options: Options<PostApiKycStartData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycStartResponses, PostApiKycStartErrors, ThrowOnError, "fields">;
|
|
139
|
+
/**
|
|
140
|
+
* Get a SmileID hosted verification URL (Smile Links) — redirect the user to this URL to complete KYC
|
|
141
|
+
*/
|
|
142
|
+
startSmileLink<ThrowOnError extends boolean = false>(options: Options<PostApiKycSmileLinkData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostApiKycSmileLinkResponses, PostApiKycSmileLinkErrors, ThrowOnError, "fields">;
|
|
139
143
|
/**
|
|
140
144
|
* SmileID webhook — receives job results (public, signature-verified)
|
|
141
145
|
*/
|
package/dist/sdk.gen.js
CHANGED
|
@@ -436,6 +436,19 @@ export class Kyc extends HeyApiClient {
|
|
|
436
436
|
},
|
|
437
437
|
});
|
|
438
438
|
}
|
|
439
|
+
/**
|
|
440
|
+
* Get a SmileID hosted verification URL (Smile Links) — redirect the user to this URL to complete KYC
|
|
441
|
+
*/
|
|
442
|
+
startSmileLink(options) {
|
|
443
|
+
return (options.client ?? this.client).post({
|
|
444
|
+
url: '/api/kyc/smile-link',
|
|
445
|
+
...options,
|
|
446
|
+
headers: {
|
|
447
|
+
'Content-Type': 'application/json',
|
|
448
|
+
...options.headers,
|
|
449
|
+
},
|
|
450
|
+
});
|
|
451
|
+
}
|
|
439
452
|
/**
|
|
440
453
|
* SmileID webhook — receives job results (public, signature-verified)
|
|
441
454
|
*/
|
package/dist/types.gen.d.ts
CHANGED
|
@@ -576,11 +576,30 @@ export type ReportPurchaseStatusResponseDto = {
|
|
|
576
576
|
purchase?: ReportPurchaseDto | null;
|
|
577
577
|
prerequisites: Array<ReportPrerequisiteDto>;
|
|
578
578
|
};
|
|
579
|
+
export type AiReportSubcategoryDto = {
|
|
580
|
+
label: string;
|
|
581
|
+
observation: string;
|
|
582
|
+
evidenceClips?: Array<number>;
|
|
583
|
+
};
|
|
584
|
+
export type AiReportPillarDetailDto = {
|
|
585
|
+
summary: string;
|
|
586
|
+
subcategories: Array<AiReportSubcategoryDto>;
|
|
587
|
+
};
|
|
588
|
+
export type AiReportImprovementAreaDto = {
|
|
589
|
+
label: string;
|
|
590
|
+
observation: string;
|
|
591
|
+
};
|
|
579
592
|
export type AiReportViewDto = {
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
593
|
+
verdict?: string | null;
|
|
594
|
+
technical?: AiReportPillarDetailDto | null;
|
|
595
|
+
physical?: AiReportPillarDetailDto | null;
|
|
596
|
+
tactical?: AiReportPillarDetailDto | null;
|
|
597
|
+
mental?: AiReportPillarDetailDto | null;
|
|
598
|
+
improvementAreas?: Array<AiReportImprovementAreaDto>;
|
|
599
|
+
technicalPillar?: string | null;
|
|
600
|
+
physicalPillar?: string | null;
|
|
601
|
+
tacticalPillar?: string | null;
|
|
602
|
+
mentalPillar?: string | null;
|
|
584
603
|
};
|
|
585
604
|
export type AiReportClipTargetDto = {
|
|
586
605
|
timestampS: number;
|
|
@@ -1649,6 +1668,35 @@ export type StartKycResponseDto = {
|
|
|
1649
1668
|
*/
|
|
1650
1669
|
country?: string | null;
|
|
1651
1670
|
};
|
|
1671
|
+
export type SmileLinkRequestDto = {
|
|
1672
|
+
/**
|
|
1673
|
+
* ISO 3166-1 alpha-2 country code (lowercase, matches index.countries)
|
|
1674
|
+
*/
|
|
1675
|
+
country: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* Channel initiating the KYC flow
|
|
1678
|
+
*/
|
|
1679
|
+
channel: 'web' | 'mobile';
|
|
1680
|
+
/**
|
|
1681
|
+
* URL SmileID redirects the user back to after completing verification (frontend callback page)
|
|
1682
|
+
*/
|
|
1683
|
+
returnUrl: string;
|
|
1684
|
+
};
|
|
1685
|
+
export type SmileLinkResponseDto = {
|
|
1686
|
+
/**
|
|
1687
|
+
* SmileID hosted verification URL — redirect the user here to complete KYC. Null when no redirect is needed (approved, blocked, or processing).
|
|
1688
|
+
*/
|
|
1689
|
+
url?: string | null;
|
|
1690
|
+
/**
|
|
1691
|
+
* SmileID job identifier
|
|
1692
|
+
*/
|
|
1693
|
+
jobId?: string | null;
|
|
1694
|
+
status: 'pending' | 'capture_started' | 'processing' | 'approved' | 'rejected' | 'blocked';
|
|
1695
|
+
/**
|
|
1696
|
+
* Number of retries left before the account is blocked
|
|
1697
|
+
*/
|
|
1698
|
+
retriesRemaining: number;
|
|
1699
|
+
};
|
|
1652
1700
|
export type WebhookPartnerParamsDto = {
|
|
1653
1701
|
/**
|
|
1654
1702
|
* Our job identifier echoed back by SmileID
|
|
@@ -3010,6 +3058,22 @@ export type PostApiKycStartResponses = {
|
|
|
3010
3058
|
200: StartKycResponseDto;
|
|
3011
3059
|
};
|
|
3012
3060
|
export type PostApiKycStartResponse = PostApiKycStartResponses[keyof PostApiKycStartResponses];
|
|
3061
|
+
export type PostApiKycSmileLinkData = {
|
|
3062
|
+
body: SmileLinkRequestDto;
|
|
3063
|
+
path?: never;
|
|
3064
|
+
query?: never;
|
|
3065
|
+
url: '/api/kyc/smile-link';
|
|
3066
|
+
};
|
|
3067
|
+
export type PostApiKycSmileLinkErrors = {
|
|
3068
|
+
/**
|
|
3069
|
+
* Invalid request
|
|
3070
|
+
*/
|
|
3071
|
+
400: unknown;
|
|
3072
|
+
};
|
|
3073
|
+
export type PostApiKycSmileLinkResponses = {
|
|
3074
|
+
200: SmileLinkResponseDto;
|
|
3075
|
+
};
|
|
3076
|
+
export type PostApiKycSmileLinkResponse = PostApiKycSmileLinkResponses[keyof PostApiKycSmileLinkResponses];
|
|
3013
3077
|
export type PostApiKycWebhookData = {
|
|
3014
3078
|
body: KycWebhookDto;
|
|
3015
3079
|
path?: never;
|
package/index.ts
CHANGED
|
@@ -30,8 +30,11 @@ export type {
|
|
|
30
30
|
AchievementCatalogDto,
|
|
31
31
|
AiReportClipDto,
|
|
32
32
|
AiReportClipTargetDto,
|
|
33
|
+
AiReportImprovementAreaDto,
|
|
33
34
|
AiReportMetaDto,
|
|
35
|
+
AiReportPillarDetailDto,
|
|
34
36
|
AiReportResultResponseDto,
|
|
37
|
+
AiReportSubcategoryDto,
|
|
35
38
|
AiReportViewDto,
|
|
36
39
|
AuthMeResponseDto,
|
|
37
40
|
BillingEntitlementResponseDto,
|
|
@@ -328,6 +331,10 @@ export type {
|
|
|
328
331
|
PostApiKycMarkSubmittedErrors,
|
|
329
332
|
PostApiKycMarkSubmittedResponse,
|
|
330
333
|
PostApiKycMarkSubmittedResponses,
|
|
334
|
+
PostApiKycSmileLinkData,
|
|
335
|
+
PostApiKycSmileLinkErrors,
|
|
336
|
+
PostApiKycSmileLinkResponse,
|
|
337
|
+
PostApiKycSmileLinkResponses,
|
|
331
338
|
PostApiKycStartData,
|
|
332
339
|
PostApiKycStartErrors,
|
|
333
340
|
PostApiKycStartResponse,
|
|
@@ -416,6 +423,8 @@ export type {
|
|
|
416
423
|
ScoutDashboardResponseDto,
|
|
417
424
|
SendInvitationRequestDto,
|
|
418
425
|
SendMessageDto,
|
|
426
|
+
SmileLinkRequestDto,
|
|
427
|
+
SmileLinkResponseDto,
|
|
419
428
|
StartKycRequestDto,
|
|
420
429
|
StartKycResponseDto,
|
|
421
430
|
StartReportGenerationClipDto,
|
package/package.json
CHANGED
package/sdk.gen.ts
CHANGED
|
@@ -173,6 +173,9 @@ import type {
|
|
|
173
173
|
PostApiKycMarkSubmittedData,
|
|
174
174
|
PostApiKycMarkSubmittedErrors,
|
|
175
175
|
PostApiKycMarkSubmittedResponses,
|
|
176
|
+
PostApiKycSmileLinkData,
|
|
177
|
+
PostApiKycSmileLinkErrors,
|
|
178
|
+
PostApiKycSmileLinkResponses,
|
|
176
179
|
PostApiKycStartData,
|
|
177
180
|
PostApiKycStartErrors,
|
|
178
181
|
PostApiKycStartResponses,
|
|
@@ -1120,6 +1123,26 @@ export class Kyc extends HeyApiClient {
|
|
|
1120
1123
|
});
|
|
1121
1124
|
}
|
|
1122
1125
|
|
|
1126
|
+
/**
|
|
1127
|
+
* Get a SmileID hosted verification URL (Smile Links) — redirect the user to this URL to complete KYC
|
|
1128
|
+
*/
|
|
1129
|
+
public startSmileLink<ThrowOnError extends boolean = false>(
|
|
1130
|
+
options: Options<PostApiKycSmileLinkData, ThrowOnError>,
|
|
1131
|
+
) {
|
|
1132
|
+
return (options.client ?? this.client).post<
|
|
1133
|
+
PostApiKycSmileLinkResponses,
|
|
1134
|
+
PostApiKycSmileLinkErrors,
|
|
1135
|
+
ThrowOnError
|
|
1136
|
+
>({
|
|
1137
|
+
url: '/api/kyc/smile-link',
|
|
1138
|
+
...options,
|
|
1139
|
+
headers: {
|
|
1140
|
+
'Content-Type': 'application/json',
|
|
1141
|
+
...options.headers,
|
|
1142
|
+
},
|
|
1143
|
+
});
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1123
1146
|
/**
|
|
1124
1147
|
* SmileID webhook — receives job results (public, signature-verified)
|
|
1125
1148
|
*/
|
package/types.gen.ts
CHANGED
|
@@ -626,11 +626,33 @@ export type ReportPurchaseStatusResponseDto = {
|
|
|
626
626
|
prerequisites: Array<ReportPrerequisiteDto>;
|
|
627
627
|
};
|
|
628
628
|
|
|
629
|
+
export type AiReportSubcategoryDto = {
|
|
630
|
+
label: string;
|
|
631
|
+
observation: string;
|
|
632
|
+
evidenceClips?: Array<number>;
|
|
633
|
+
};
|
|
634
|
+
|
|
635
|
+
export type AiReportPillarDetailDto = {
|
|
636
|
+
summary: string;
|
|
637
|
+
subcategories: Array<AiReportSubcategoryDto>;
|
|
638
|
+
};
|
|
639
|
+
|
|
640
|
+
export type AiReportImprovementAreaDto = {
|
|
641
|
+
label: string;
|
|
642
|
+
observation: string;
|
|
643
|
+
};
|
|
644
|
+
|
|
629
645
|
export type AiReportViewDto = {
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
646
|
+
verdict?: string | null;
|
|
647
|
+
technical?: AiReportPillarDetailDto | null;
|
|
648
|
+
physical?: AiReportPillarDetailDto | null;
|
|
649
|
+
tactical?: AiReportPillarDetailDto | null;
|
|
650
|
+
mental?: AiReportPillarDetailDto | null;
|
|
651
|
+
improvementAreas?: Array<AiReportImprovementAreaDto>;
|
|
652
|
+
technicalPillar?: string | null;
|
|
653
|
+
physicalPillar?: string | null;
|
|
654
|
+
tacticalPillar?: string | null;
|
|
655
|
+
mentalPillar?: string | null;
|
|
634
656
|
};
|
|
635
657
|
|
|
636
658
|
export type AiReportClipTargetDto = {
|
|
@@ -1768,6 +1790,43 @@ export type StartKycResponseDto = {
|
|
|
1768
1790
|
country?: string | null;
|
|
1769
1791
|
};
|
|
1770
1792
|
|
|
1793
|
+
export type SmileLinkRequestDto = {
|
|
1794
|
+
/**
|
|
1795
|
+
* ISO 3166-1 alpha-2 country code (lowercase, matches index.countries)
|
|
1796
|
+
*/
|
|
1797
|
+
country: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* Channel initiating the KYC flow
|
|
1800
|
+
*/
|
|
1801
|
+
channel: 'web' | 'mobile';
|
|
1802
|
+
/**
|
|
1803
|
+
* URL SmileID redirects the user back to after completing verification (frontend callback page)
|
|
1804
|
+
*/
|
|
1805
|
+
returnUrl: string;
|
|
1806
|
+
};
|
|
1807
|
+
|
|
1808
|
+
export type SmileLinkResponseDto = {
|
|
1809
|
+
/**
|
|
1810
|
+
* SmileID hosted verification URL — redirect the user here to complete KYC. Null when no redirect is needed (approved, blocked, or processing).
|
|
1811
|
+
*/
|
|
1812
|
+
url?: string | null;
|
|
1813
|
+
/**
|
|
1814
|
+
* SmileID job identifier
|
|
1815
|
+
*/
|
|
1816
|
+
jobId?: string | null;
|
|
1817
|
+
status:
|
|
1818
|
+
| 'pending'
|
|
1819
|
+
| 'capture_started'
|
|
1820
|
+
| 'processing'
|
|
1821
|
+
| 'approved'
|
|
1822
|
+
| 'rejected'
|
|
1823
|
+
| 'blocked';
|
|
1824
|
+
/**
|
|
1825
|
+
* Number of retries left before the account is blocked
|
|
1826
|
+
*/
|
|
1827
|
+
retriesRemaining: number;
|
|
1828
|
+
};
|
|
1829
|
+
|
|
1771
1830
|
export type WebhookPartnerParamsDto = {
|
|
1772
1831
|
/**
|
|
1773
1832
|
* Our job identifier echoed back by SmileID
|
|
@@ -3433,6 +3492,27 @@ export type PostApiKycStartResponses = {
|
|
|
3433
3492
|
export type PostApiKycStartResponse =
|
|
3434
3493
|
PostApiKycStartResponses[keyof PostApiKycStartResponses];
|
|
3435
3494
|
|
|
3495
|
+
export type PostApiKycSmileLinkData = {
|
|
3496
|
+
body: SmileLinkRequestDto;
|
|
3497
|
+
path?: never;
|
|
3498
|
+
query?: never;
|
|
3499
|
+
url: '/api/kyc/smile-link';
|
|
3500
|
+
};
|
|
3501
|
+
|
|
3502
|
+
export type PostApiKycSmileLinkErrors = {
|
|
3503
|
+
/**
|
|
3504
|
+
* Invalid request
|
|
3505
|
+
*/
|
|
3506
|
+
400: unknown;
|
|
3507
|
+
};
|
|
3508
|
+
|
|
3509
|
+
export type PostApiKycSmileLinkResponses = {
|
|
3510
|
+
200: SmileLinkResponseDto;
|
|
3511
|
+
};
|
|
3512
|
+
|
|
3513
|
+
export type PostApiKycSmileLinkResponse =
|
|
3514
|
+
PostApiKycSmileLinkResponses[keyof PostApiKycSmileLinkResponses];
|
|
3515
|
+
|
|
3436
3516
|
export type PostApiKycWebhookData = {
|
|
3437
3517
|
body: KycWebhookDto;
|
|
3438
3518
|
path?: never;
|