@vertikalx/vtx-backend-client 3.0.0-dev.3 → 3.0.0-dev.31

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev.3",
+    "version": "3.0.0-dev.31",
     "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, 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, 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 } 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, 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 { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
@@ -25,12 +25,14 @@ export declare class VTXBaseAPI {
     createBrand(dto: CreateBrandDto, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
     createSponsorship(dto: CreateSponsorshipDto, desiredFields?: SponsorshipGenqlSelection): Promise<ITypedBackendResponse<Sponsorship>>;
     getS3UploadUrl(dto: AWSS3GetUploadDto): Promise<ITypedBackendResponse<AWSS3UploadUrl>>;
+    getVtxS3UploadUrl(dto: AWSS3GetUploadDto): Promise<ITypedBackendResponse<AWSS3UploadUrl>>;
     refreshToken(currentToken: string, refreshToken: string): Promise<ITypedBackendResponse<UserToken>>;
     registerNewDomainTenant(input: CreateTenantInput): Promise<ITypedBackendResponse<Tenant>>;
     registerNewDomainTenantWithLogin(input: CreateTenantInput): Promise<ITypedBackendResponse<TenantWithUserLogin>>;
     registerUserToDomainFromEmail(input: RegisterUserToDomainFromEmailInput): Promise<ITypedBackendResponse<User>>;
     getPublicSponsorships(): Promise<ITypedBackendResponse<Sponsorship[]>>;
     getTenantSponsorshipsFromUri(tenantUri: string, token: DecodedToken): Promise<ITypedBackendResponse<Sponsorship[]>>;
+    isUserSuspended(loginEmail: string): Promise<ITypedBackendResponse<boolean>>;
     getTenantSponsorships(tenantId: string): Promise<ITypedBackendResponse<Sponsorship[]>>;
     sendAthleteInvitations(input: InviteAthletesDto): Promise<ITypedBackendResponse<SponsorAthleteInvitation[]>>;
     registerSponsorUser(input: RegisterUserDto): Promise<ITypedBackendResponse<User>>;
@@ -44,12 +46,18 @@ export declare class VTXBaseAPI {
     findCityById(cityId: string): Promise<ITypedBackendResponse<City>>;
     getSportLevels(): Promise<ITypedBackendResponse<SportLevel[]>>;
     getSports(): Promise<ITypedBackendResponse<Sport[]>>;
+    getSportsPaginated(args: {
+        query: SportQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedSports>>;
     getStates(): Promise<ITypedBackendResponse<State[]>>;
     getCountries(): Promise<ITypedBackendResponse<Country[]>>;
     loginUserFromCredentialsVtx(username: string, password: string): Promise<ITypedBackendResponse<UserWithToken>>;
     validateUserCredentialsVtx(username: string, password: string): Promise<ITypedBackendResponse<User>>;
     findAthleteForUser(loginEmail: string): Promise<ITypedBackendResponse<Athlete>>;
     getBrands(): Promise<ITypedBackendResponse<Brand[]>>;
+    getBrandsPaginated(args: {
+        query: BrandQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedBrands>>;
     getAthletes(): Promise<ITypedBackendResponse<Athlete[]>>;
     searchAthletes(searchString: string): Promise<ITypedBackendResponse<Athlete[]>>;
     getRecommendedAthletes(loginEmail: string): Promise<ITypedBackendResponse<Athlete[]>>;
@@ -59,7 +67,16 @@ export declare class VTXBaseAPI {
     editProfileValue(newValue: string, field: string): Promise<ITypedBackendResponse<EditValueResponse>>;
     addAthleteCompetition(dto: CreateAthleteCompetitionDto): Promise<ITypedBackendResponse<AthleteCompetition>>;
     getSportsEvents(dto: GetSportEventsDto): Promise<ITypedBackendResponse<SportsEvent[]>>;
+    getSportsEventsPaginated(dto: {
+        query: EventQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedEvents>>;
     createSportsEvent(dto: CreateSportEventDto): Promise<ITypedBackendResponse<SportsEvent>>;
+    updateSportsEvent(dto: {
+        input: UpdateSportEventDto;
+    }): Promise<ITypedBackendResponse<SportsEvent>>;
+    deleteSportsEvent(dto: {
+        eventId: string;
+    }): Promise<ITypedBackendResponse<EditValueResponse>>;
     mergeSportsEvents(dto: MergeSportsEventsDto): Promise<ITypedBackendResponse<MergeEventsResponse>>;
     getAthleteCompetitions(dto: GetAthleteCompetitionsDto): Promise<ITypedBackendResponse<AthleteCompetition[]>>;
     getAthleteMemberships(athleteId: string): Promise<ITypedBackendResponse<AthleteMembership[]>>;
@@ -75,6 +92,7 @@ export declare class VTXBaseAPI {
     createStripeCheckoutSession(dto: DonationCheckoutDto, desiredFields?: StripeCheckoutSessionGenqlSelection): Promise<ITypedBackendResponse<StripeCheckoutSession>>;
     createStripeLoginLink(): Promise<ITypedBackendResponse<string>>;
     createStripeAccountLink(): Promise<ITypedBackendResponse<string>>;
+    getStripeBalance(desiredFields?: StripeBalanceGenqlSelection): Promise<ITypedBackendResponse<StripeBalance>>;
     getDatabaseTextFile(dto: GetDatabaseFileDto, desiredFields?: TextDatabaseFileGenqlSelection): Promise<ITypedBackendResponse<TextDatabaseFile>>;
     getReceiptUrl(dto: GetReceiptDto): Promise<ITypedBackendResponse<ReceiptUrl>>;
     stripeQuery(dto: StripeQueryDto): Promise<ITypedBackendResponse<StripeObject>>;
@@ -105,6 +123,11 @@ export declare class VTXBaseAPI {
     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>>;
+    checkScoreRefreshCapabilities(input: {
+        athleteIds: string[];
+    }): Promise<ITypedBackendResponse<any>>;
     createResetPasswordCode(email: string): Promise<ITypedBackendResponse<EditValueResponse>>;
     getResetVerificationCode(id: string): Promise<ITypedBackendResponse<VerificationCodeType>>;
     verifyCode(input: VerifyCodeDto): Promise<ITypedBackendResponse<CodeVerificationResponse>>;
@@ -118,11 +141,103 @@ export declare class VTXBaseAPI {
     editCampaignBudget(input: EditCampaignBudgetDto): Promise<ITypedBackendResponse<Boolean>>;
     editCompetitionBudgetForCampaign(input: EditCampaignBudgetDto): Promise<ITypedBackendResponse<Boolean>>;
     getDonationsByAthlete(): Promise<ITypedBackendResponse<Receipt[]>>;
-    getDonationsByMember(): Promise<ITypedBackendResponse<Donation[]>>;
+    getDonationsByMember(desiredFields?: DonationGenqlSelection): Promise<ITypedBackendResponse<Donation[]>>;
     findMemberForUser(loginEmail: string): Promise<ITypedBackendResponse<Member>>;
     getBudgetConcepts(): Promise<ITypedBackendResponse<BudgetConcept[]>>;
     getBudgetItemsUnits(): Promise<ITypedBackendResponse<BudgetItemUnit[]>>;
     verifyAthleteCompetitionLinkedForDelete(dto: existValueDto): Promise<ITypedBackendResponse<CompetitionDeleteVerificationResponse>>;
     forceDeleteAthleteCompetition(dto: DeleteSingleValueDto): Promise<ITypedBackendResponse<DeleteSingleValueResponse>>;
     registerUser(input: RegisterUserDto): Promise<ITypedBackendResponse<User>>;
+    getDonationsToAthlete(athleteId: string): Promise<ITypedBackendResponse<Donation[]>>;
+    getDonationsToMe(): Promise<ITypedBackendResponse<Donation[]>>;
+    getAthleteHistoricalScores(dto: GetHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScore[]>>;
+    getMyHistoricalScores(dto: GetMyHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScore[]>>;
+    getAthleteHistoricalScoresPeriod(dto: GetHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScoresPeriod>>;
+    getMyHistoricalScoresPeriod(dto: GetMyHistoricalScoresDto): Promise<ITypedBackendResponse<HistoricalScoresPeriod>>;
+    getTransactionDetails(dto: GetTransactionDetailsDto, desiredFields?: TransactionDetailsGenqlSelection): Promise<ITypedBackendResponse<TransactionDetails>>;
+    getAllUsers(): Promise<ITypedBackendResponse<AdminUserView[]>>;
+    getAllTransactions(): Promise<ITypedBackendResponse<AdminTransactionView[]>>;
+    getTransactionsPaginated(args?: {
+        query?: TransactionQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedTransactions>>;
+    getUsersPaginated(args: {
+        query: UserQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedUsers>>;
+    updateUserSuspendedStatus(input: UpdateUserSuspendedStatusDto): Promise<ITypedBackendResponse<EditValueResponse>>;
+    deleteVtxUser(input: DeleteVtxUserDto): Promise<ITypedBackendResponse<DeleteVtxUserResponse>>;
+    deleteMyAccount(): Promise<ITypedBackendResponse<DeleteVtxUserResponse>>;
+    createOffer(dto: CreateOfferDto, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    getOffers(): Promise<ITypedBackendResponse<Offer[]>>;
+    getOffersPaginated(args: {
+        query: OfferQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedOffers>>;
+    getOffersWithEligibility(args: {
+        query?: OfferQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedOffersWithEligibility>>;
+    getOfferById(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    getOffersForAthlete(athleteId: string | null, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer[]>>;
+    updateOffer(id: string, dto: CreateOfferDto, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    deleteOffer(id: string): Promise<ITypedBackendResponse<boolean>>;
+    setOfferStatus(id: string, status: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    activateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    deactivateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    uploadCouponCodes(offerId: string, csvContent: string): Promise<ITypedBackendResponse<UploadResult>>;
+    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>>;
+    unlinkBrandFromSponsor(brandId: string, sponsorId: string, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
+    getSponsors(): Promise<ITypedBackendResponse<Sponsor[]>>;
+    getSponsorsPaginated(args: {
+        query: SponsorQueryDto;
+    }): Promise<ITypedBackendResponse<PaginatedSponsors>>;
+    createSponsor(dto: CreateSponsorDto, desiredFields?: SponsorGenqlSelection): Promise<ITypedBackendResponse<Sponsor>>;
+    updateSponsor(id: string, dto: CreateSponsorDto, desiredFields?: SponsorGenqlSelection): Promise<ITypedBackendResponse<Sponsor>>;
+    deleteSponsor(id: string): Promise<ITypedBackendResponse<boolean>>;
+    getLeaderboard(args?: {
+        input?: LeaderboardQueryDto;
+    }): Promise<ITypedBackendResponse<LeaderboardResponse>>;
+    getUserRank(args: {
+        input: UserRankQueryDto;
+    }): Promise<ITypedBackendResponse<UserRank>>;
+    rebuildLeaderboardCache(): Promise<ITypedBackendResponse<boolean>>;
+    getAthleteDashboard(athleteId: string): Promise<ITypedBackendResponse<DashboardSummary>>;
+    getAthleteScoreHistory(args: {
+        input: ScoreHistoryQueryDto;
+    }): Promise<ITypedBackendResponse<ScoreHistoryEntry[]>>;
+    getAthleteRankHistory(args: {
+        input: RankHistoryQueryDto;
+    }): Promise<ITypedBackendResponse<RankHistoryEntry[]>>;
+    getAthleteRankContext(args: {
+        input: RankContextQueryDto;
+    }): Promise<ITypedBackendResponse<RankContext>>;
+    getAthleteActivities(args: {
+        input: ActivitiesQueryDto;
+    }): Promise<ITypedBackendResponse<ActivitiesResponse>>;
+    getAthleteActivityDetail(args: {
+        input: ActivityDetailQueryDto;
+    }): Promise<ITypedBackendResponse<ActivityDetail>>;
+    getAthleteComponentSummary(args: {
+        input: ComponentSummaryQueryDto;
+    }): Promise<ITypedBackendResponse<ComponentSummary>>;
+    getSocialAggregates(args: {
+        input: {
+            athleteId: string;
+            platform: Platform;
+            startDate: string;
+            endDate: string;
+            periodType?: PeriodType;
+        };
+    }): Promise<ITypedBackendResponse<any[]>>;
+    getPostsWithComparison(args: {
+        input: {
+            athleteId: string;
+            platform: Platform;
+            sortBy?: PostSortOption;
+            contentType?: ContentType;
+            limit?: number;
+            offset?: number;
+            comparisonWindowDays?: number;
+        };
+    }): Promise<ITypedBackendResponse<any>>;
+    getAthleteActivityDates(athleteId: string): Promise<ITypedBackendResponse<ActivityDatesResponse>>;
 }