@vertikalx/vtx-backend-client 3.0.0-dev.32 → 3.0.0-dev.33

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev.32",
+    "version": "3.0.0-dev.33",
     "description": "GraphQL API generated client for VTX",
     "types": "src/index.d.ts",
     "main": "src/index.js",

package/src/api/vtx-base-api.d.ts

@@ -1,4 +1,4 @@
-import { User, AddValuesResponse, UserToken, UserWithToken, Athlete, RegisterAthleteDto, Brand, CreateBrandDto, BrandGenqlSelection, AWSS3UploadUrl, AWSS3GetUploadDto, CreateTenantInput, Tenant, TenantWithUserLogin, RegisterUserToDomainFromEmailInput, DecodedToken, Sponsorship, SponsorshipGenqlSelection, CreateSponsorshipDto, SponsorAthleteInvitation, InviteAthletesDto, RegisterUserDto, VerificationCode, VerifyCodeDto, FindSponsorAthleteInvitationDto, FindVtxUserDto, City, SportLevel, Sport, UserImages, EditValueResponse, CreateAthleteCompetitionDto, AthleteCompetition, GetSportEventsDto, SportsEvent, CreateSportEventDto, UpdateSportEventDto, GetAthleteCompetitionsDto, AthleteMembership, AthleteMembershipGenqlSelection, MembershipOrganizationReferenceGenqlSelection, MembershipOrganizationReference, CreateMembershipOrganizationDto, CreateAthleteMembershipDto, DeleteSingleValueDto, DeleteSingleValueResponse, FundRaisingCampaign, CreateFundingCampaignDto, FundRaisingCampaignGenqlSelection, AthleteQueryDto, AthleteQueryResponse, StripeSessionGenqlSelection, CreateStripeAccountDto, StripeSession, StripeAccountReferenceGenqlSelection, StripeAccountReference, StripeCheckoutSessionGenqlSelection, StripeCheckoutSession, DonationCheckoutDto, GetDatabaseFileDto, TextDatabaseFileGenqlSelection, TextDatabaseFile, StripeQueryDto, StripeObject, SetFundingStatusDto, EditPictureResponse, UploadAlbumsPicturesDto, UpdateUserSuspendedStatusDto, EditPictureDto, Album, State, Country, AWSS3DeleteUseTypeKeyDto, AthleteIntegrationReference, AWSS3CallResult, SetCompetitionResultDto, AthleteCompetitionResult, CodeVerificationResponse, resetPasswordDto, DeleteValuesDto, existValueDto, ExistValueResponse, Receipt, ReceiptUrl, GetReceiptDto, DeleteValuesResponse, BudgetData, AddCompetitionBudgetDto, EditCompetitionBudgetDto, EditCampaignBudgetDto, SetCurrentCampaignDto, GetAthleteCampaignsDto, UpdateFundingCampaignDto, EditDisplayIndexDto, MergeEventsResponse, MergeSportsEventsDto, BudgetConcept, BudgetItemUnit, CompetitionDeleteVerificationResponse, RegisterMemberDto, Member, Donation, DonationGenqlSelection, GetHistoricalScoresDto, HistoricalScore, GetMyHistoricalScoresDto, HistoricalScoresPeriod, GetTransactionDetailsDto, TransactionDetails, TransactionDetailsGenqlSelection, AdminUserView, AdminTransactionView, PaginatedTransactions, TransactionQueryDto, PaginatedUsers, UserQueryDto, EventQueryDto, PaginatedSports, SportQueryDto, StripeBalance, StripeBalanceGenqlSelection, DeleteVtxUserDto, DeleteVtxUserResponse, ForceScoreRefreshResponse, Offer, OfferGenqlSelection, CreateOfferDto, Sponsor, SponsorGenqlSelection, CreateSponsorDto, PaginatedBrands, BrandQueryDto, PaginatedEvents, SponsorQueryDto, PaginatedSponsors, OfferQueryDto, PaginatedOffers, PaginatedOffersWithEligibility, UploadResult, LeaderboardResponse, UserRank, LeaderboardQueryDto, UserRankQueryDto, DashboardSummary, ScoreHistoryEntry, RankHistoryEntry, RankContext, ActivitiesResponse, ActivityDetail, ComponentSummary, ScoreHistoryQueryDto, RankHistoryQueryDto, RankContextQueryDto, ActivitiesQueryDto, ActivityDetailQueryDto, ComponentSummaryQueryDto, ActivityDatesResponse, Platform, PeriodType, ContentType, PostSortOption } from '../client';
+import { User, AddValuesResponse, UserToken, UserWithToken, Athlete, RegisterAthleteDto, Brand, CreateBrandDto, BrandGenqlSelection, AWSS3UploadUrl, AWSS3GetUploadDto, CreateTenantInput, Tenant, TenantWithUserLogin, RegisterUserToDomainFromEmailInput, DecodedToken, Sponsorship, SponsorshipGenqlSelection, CreateSponsorshipDto, SponsorAthleteInvitation, InviteAthletesDto, RegisterUserDto, VerificationCode, VerifyCodeDto, FindSponsorAthleteInvitationDto, FindVtxUserDto, City, SportLevel, Sport, UserImages, EditValueResponse, CreateAthleteCompetitionDto, AthleteCompetition, GetSportEventsDto, SportsEvent, CreateSportEventDto, UpdateSportEventDto, GetAthleteCompetitionsDto, AthleteMembership, AthleteMembershipGenqlSelection, MembershipOrganizationReferenceGenqlSelection, MembershipOrganizationReference, CreateMembershipOrganizationDto, CreateAthleteMembershipDto, DeleteSingleValueDto, DeleteSingleValueResponse, FundRaisingCampaign, CreateFundingCampaignDto, FundRaisingCampaignGenqlSelection, AthleteQueryDto, AthleteQueryResponse, StripeSessionGenqlSelection, CreateStripeAccountDto, StripeSession, StripeAccountReferenceGenqlSelection, StripeAccountReference, StripeCheckoutSessionGenqlSelection, StripeCheckoutSession, DonationCheckoutDto, GetDatabaseFileDto, TextDatabaseFileGenqlSelection, TextDatabaseFile, StripeQueryDto, StripeObject, SetFundingStatusDto, EditPictureResponse, UploadAlbumsPicturesDto, UpdateUserSuspendedStatusDto, EditPictureDto, Album, State, Country, AWSS3DeleteUseTypeKeyDto, AthleteIntegrationReference, AWSS3CallResult, SetCompetitionResultDto, AthleteCompetitionResult, CodeVerificationResponse, resetPasswordDto, DeleteValuesDto, existValueDto, ExistValueResponse, Receipt, ReceiptUrl, GetReceiptDto, DeleteValuesResponse, BudgetData, AddCompetitionBudgetDto, EditCompetitionBudgetDto, EditCampaignBudgetDto, SetCurrentCampaignDto, GetAthleteCampaignsDto, BrowseCampaignsDto, BrowseCampaignsResult, UpdateFundingCampaignDto, EditDisplayIndexDto, MergeEventsResponse, MergeSportsEventsDto, BudgetConcept, BudgetItemUnit, CompetitionDeleteVerificationResponse, RegisterMemberDto, Member, Donation, DonationGenqlSelection, GetHistoricalScoresDto, HistoricalScore, GetMyHistoricalScoresDto, HistoricalScoresPeriod, GetTransactionDetailsDto, TransactionDetails, TransactionDetailsGenqlSelection, AdminUserView, AdminTransactionView, PaginatedTransactions, TransactionQueryDto, PaginatedUsers, UserQueryDto, EventQueryDto, PaginatedSports, SportQueryDto, StripeBalance, StripeBalanceGenqlSelection, DeleteVtxUserDto, DeleteVtxUserResponse, ForceScoreRefreshResponse, Offer, OfferGenqlSelection, CreateOfferDto, Sponsor, SponsorGenqlSelection, CreateSponsorDto, PaginatedBrands, BrandQueryDto, PaginatedEvents, SponsorQueryDto, PaginatedSponsors, OfferQueryDto, PaginatedOffers, PaginatedOffersWithEligibility, UploadResult, OfferClaim, OfferClaimQueryDto, LeaderboardResponse, UserRank, LeaderboardQueryDto, UserRankQueryDto, DashboardSummary, ScoreHistoryEntry, RankHistoryEntry, RankContext, ActivitiesResponse, ActivityDetail, ComponentSummary, ScoreHistoryQueryDto, RankHistoryQueryDto, RankContextQueryDto, ActivitiesQueryDto, ActivityDetailQueryDto, ComponentSummaryQueryDto, ActivityDatesResponse, Platform, PeriodType, ContentType, PostSortOption, Notification, NotificationListResponse, UnreadCountResponse, NotificationPreference, DeviceTokenType, FollowedAthletesListResponse, IsFollowingResponse, DonationDates, PaginatedDonations, DonationQueryDto } from '../client';
 import { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
@@ -119,12 +119,16 @@ export declare class VTXBaseAPI {
     getReceipt(dto: GetReceiptDto): Promise<ITypedBackendResponse<Receipt>>;
     getAthleteIntegrations(): Promise<ITypedBackendResponse<AthleteIntegrationReference>>;
     getAthleteCampaigns(dto: GetAthleteCampaignsDto): Promise<ITypedBackendResponse<FundRaisingCampaign[]>>;
+    browseCampaigns(dto: BrowseCampaignsDto): Promise<ITypedBackendResponse<BrowseCampaignsResult>>;
     updateAthleteIntegration(type: string): Promise<ITypedBackendResponse<boolean>>;
     deleteUploadedTypeKeyFile(dto: AWSS3DeleteUseTypeKeyDto): Promise<ITypedBackendResponse<AWSS3CallResult>>;
     saveAthleteCompetitionResult(dto: SetCompetitionResultDto): Promise<ITypedBackendResponse<AthleteCompetitionResult>>;
     updateAthleteScores(): Promise<ITypedBackendResponse<Athlete>>;
     updateAthleteCompetitionScores(): Promise<ITypedBackendResponse<Athlete>>;
-    forceRefreshAthleteScores(athleteIds: string[]): Promise<ITypedBackendResponse<ForceScoreRefreshResponse>>;
+    forceRefreshAthleteScores(athleteIds: string[], options?: {
+        rebuildHistorical?: boolean;
+        historicalDays?: number;
+    }): Promise<ITypedBackendResponse<ForceScoreRefreshResponse>>;
     checkScoreRefreshCapabilities(input: {
         athleteIds: string[];
     }): Promise<ITypedBackendResponse<any>>;
@@ -150,6 +154,8 @@ export declare class VTXBaseAPI {
     registerUser(input: RegisterUserDto): Promise<ITypedBackendResponse<User>>;
     getDonationsToAthlete(athleteId: string): Promise<ITypedBackendResponse<Donation[]>>;
     getDonationsToMe(): Promise<ITypedBackendResponse<Donation[]>>;
+    getDonationDatesForCalendar(campaignId?: string): Promise<ITypedBackendResponse<DonationDates>>;
+    getDonationsPaginated(query?: DonationQueryDto): Promise<ITypedBackendResponse<PaginatedDonations>>;
     getAthleteHistoricalScores(dto: GetHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScore[]>>;
     getMyHistoricalScores(dto: GetMyHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScore[]>>;
     getAthleteHistoricalScoresPeriod(dto: GetHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScoresPeriod>>;
@@ -182,6 +188,12 @@ export declare class VTXBaseAPI {
     activateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
     deactivateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
     uploadCouponCodes(offerId: string, csvContent: string): Promise<ITypedBackendResponse<UploadResult>>;
+    claimOffer(offerId: string, athleteId: string): Promise<ITypedBackendResponse<OfferClaim>>;
+    getMyOfferClaims(args: {
+        athleteId: string;
+        query?: OfferClaimQueryDto;
+    }): Promise<ITypedBackendResponse<OfferClaim[]>>;
+    removeOfferClaim(claimId: string, athleteId: string): Promise<ITypedBackendResponse<boolean>>;
     updateBrand(id: string, dto: CreateBrandDto, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
     deleteBrand(id: string): Promise<ITypedBackendResponse<boolean>>;
     linkBrandToSponsor(brandId: string, sponsorId: string, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
@@ -240,4 +252,70 @@ export declare class VTXBaseAPI {
         };
     }): Promise<ITypedBackendResponse<any>>;
     getAthleteActivityDates(athleteId: string): Promise<ITypedBackendResponse<ActivityDatesResponse>>;
+    getMyNotifications(options?: {
+        limit?: number;
+        offset?: number;
+        includeRead?: boolean;
+        includeDismissed?: boolean;
+        types?: string[];
+    }): Promise<ITypedBackendResponse<NotificationListResponse>>;
+    getNotificationUnreadCount(): Promise<ITypedBackendResponse<UnreadCountResponse>>;
+    getMyNotificationPreferences(): Promise<ITypedBackendResponse<NotificationPreference>>;
+    markNotificationAsRead(notificationId: string): Promise<ITypedBackendResponse<Notification>>;
+    markAllNotificationsAsRead(): Promise<ITypedBackendResponse<number>>;
+    dismissNotification(notificationId: string): Promise<ITypedBackendResponse<boolean>>;
+    registerDeviceToken(token: string, platform: string, deviceName?: string): Promise<ITypedBackendResponse<DeviceTokenType>>;
+    unregisterDeviceToken(token: string): Promise<ITypedBackendResponse<boolean>>;
+    updateNotificationPreferences(input: {
+        emailEnabled?: boolean;
+        inAppEnabled?: boolean;
+        pushEnabled?: boolean;
+        mutedTypes?: string[];
+    }): Promise<ITypedBackendResponse<NotificationPreference>>;
+    followAthlete(athleteId: string): Promise<ITypedBackendResponse<boolean>>;
+    unfollowAthlete(athleteId: string): Promise<ITypedBackendResponse<boolean>>;
+    isFollowingAthlete(athleteId: string): Promise<ITypedBackendResponse<IsFollowingResponse>>;
+    getMyFollowedAthletes(options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<ITypedBackendResponse<FollowedAthletesListResponse>>;
+    deleteOnboardingAthlete(): Promise<ITypedBackendResponse<{
+        success: boolean;
+        athleteId?: string;
+        error?: string;
+    }>>;
+    updateOnboardingProgress(step: number, complete?: boolean): Promise<ITypedBackendResponse<{
+        success: boolean;
+        step?: number;
+        complete?: boolean;
+        error?: string;
+    }>>;
+    getOnboardingProgress(): Promise<ITypedBackendResponse<{
+        success: boolean;
+        step?: number;
+        complete?: boolean;
+        athleteId?: string;
+        error?: string;
+    }>>;
+    getPublicAthleteIntegrationStatus(athleteId: string): Promise<ITypedBackendResponse<any>>;
+    getEmailCampaigns(args: {
+        status: string;
+        search?: string;
+        page?: number;
+        limit?: number;
+    }): Promise<ITypedBackendResponse<any>>;
+    createEmailCampaign(input: any): Promise<ITypedBackendResponse<any>>;
+    updateEmailCampaign(id: string, input: any): Promise<ITypedBackendResponse<any>>;
+    deleteEmailCampaign(id: string): Promise<ITypedBackendResponse<boolean>>;
+    cloneEmailCampaign(id: string): Promise<ITypedBackendResponse<any>>;
+    sendTestEmail(campaignId: string, email: string): Promise<ITypedBackendResponse<any>>;
+    sendBulkEmail(campaignId: string): Promise<ITypedBackendResponse<any>>;
+    scheduleEmailCampaign(campaignId: string, scheduledFor: string): Promise<ITypedBackendResponse<any>>;
+    cancelScheduledEmail(campaignId: string): Promise<ITypedBackendResponse<any>>;
+    getAudiencePreview(filters: any): Promise<ITypedBackendResponse<any>>;
+    getSendGridTemplates(): Promise<ITypedBackendResponse<any[]>>;
+    getEmailSegments(): Promise<ITypedBackendResponse<any[]>>;
+    createEmailSegment(input: any): Promise<ITypedBackendResponse<any>>;
+    updateEmailSegment(id: string, input: any): Promise<ITypedBackendResponse<any>>;
+    deleteEmailSegment(id: string): Promise<ITypedBackendResponse<boolean>>;
 }