@vertikalx/vtx-backend-client 3.0.0-dev-max.141 → 3.0.0-dev-max.143

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

@@ -1,29 +1,34 @@
-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 { GraphQLClient } from 'graphql-request';
+import { Sdk } from '../generated/graphql';
+import { User, AddValuesResponse, UserToken, UserWithToken, Athlete, RegisterAthleteDto, Brand, CreateBrandDto, AWSS3UploadUrl, AWSS3GetUploadDto, CreateTenantInput, Tenant, TenantWithUserLogin, RegisterUserToDomainFromEmailInput, DecodedToken, Sponsorship, CreateSponsorshipDto, SponsorAthleteInvitation, InviteAthletesDto, RegisterUserDto, VerificationCode, FindSponsorAthleteInvitationDto, FindVtxUserDto, City, SportLevel, Sport, EditValueResponse, CreateAthleteCompetitionDto, AthleteCompetition, GetSportEventsDto, SportsEvent, CreateSportEventDto, UpdateSportEventDto, GetAthleteCompetitionsDto, AthleteMembership, MembershipOrganizationReference, CreateMembershipOrganizationDto, CreateAthleteMembershipDto, DeleteSingleValueDto, DeleteSingleValueResponse, FundRaisingCampaign, CreateFundingCampaignDto, AthleteQueryDto, AthleteQueryResponse, CreateStripeAccountDto, StripeSession, StripeAccountReference, StripeCheckoutSession, DonationCheckoutDto, GetDatabaseFileDto, TextDatabaseFile, StripeQueryDto, StripeObject, SetFundingStatusDto, EditPictureResponse, UploadAlbumsPicturesDto, UpdateUserSuspendedStatusDto, EditPictureDto, Album, State, Country, AWSS3DeleteUseTypeKeyDto, AthleteIntegrationReference, AWSS3CallResult, SetCompetitionResultDto, AthleteCompetitionResult, CodeVerificationResponse, resetPasswordDto, DeleteValuesDto, DeleteValuesResponse, ExistValueResponse, Receipt, ReceiptUrl, GetReceiptDto, BudgetData, AddCompetitionBudgetDto, EditCompetitionBudgetDto, EditCampaignBudgetDto, SetCurrentCampaignDto, GetAthleteCampaignsDto, BrowseCampaignsDto, BrowseCampaignsResult, UpdateFundingCampaignDto, EditDisplayIndexDto, MergeEventsResponse, MergeSportsEventsDto, BudgetConcept, BudgetItemUnit, CompetitionDeleteVerificationResponse, RegisterMemberDto, Member, Donation, GetHistoricalScoresDto, HistoricalScore, GetMyHistoricalScoresDto, HistoricalScoresPeriod, GetTransactionDetailsDto, TransactionDetails, AdminUserView, AdminTransactionView, PaginatedTransactions, TransactionQueryDto, PaginatedUsers, UserQueryDto, EventQueryDto, PaginatedSports, SportQueryDto, StripeBalance, DeleteVtxUserDto, DeleteVtxUserResponse, ForceScoreRefreshResponse, Offer, CreateOfferDto, Sponsor, 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, existValueDto, VerifyCodeDto } from '../client';
 import { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
 export declare class VTXBaseAPI {
     protected headers: APICallHeaders;
     protected backendUrl: string;
+    protected gqlClient: GraphQLClient;
+    protected sdk: Sdk;
     protected static Logger: {
-        debug: (str: string) => void;
-        log: (str: string) => void;
-        warn: (str: string) => void;
-        error: (str: string) => void;
+        debug: (str: any) => void;
+        log: (str: any) => void;
+        warn: (str: any) => void;
+        error: (str: any) => void;
     };
     constructor(backendUrl: string, headers?: APICallHeaders);
     getHeaders(): APICallHeaders;
     setHeader(key: string, value: string): void;
     static getVersion(): string;
     static isBrowser(): boolean;
+    protected execute<T>(sdkCall: () => Promise<any>, rootProperty: string, checker: (response: any) => boolean, logPrefix: string): Promise<ITypedBackendResponse<T>>;
     findUserByEmail(email: string): Promise<ITypedBackendResponse<User>>;
     loginUserFromEmail(loginEmail: string, loginMethod?: string): Promise<ITypedBackendResponse<UserToken>>;
     createUserAndLogin(loginEmail: string): Promise<ITypedBackendResponse<UserWithToken>>;
     registerMember(dto: RegisterMemberDto): Promise<ITypedBackendResponse<Member>>;
     registerAthlete(payload: RegisterAthleteDto): Promise<ITypedBackendResponse<Athlete>>;
     findBrandByName(name: string, translations?: boolean): Promise<ITypedBackendResponse<Brand>>;
-    createBrand(dto: CreateBrandDto, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
-    createSponsorship(dto: CreateSponsorshipDto, desiredFields?: SponsorshipGenqlSelection): Promise<ITypedBackendResponse<Sponsorship>>;
+    createBrand(dto: CreateBrandDto): Promise<ITypedBackendResponse<Brand>>;
+    createSponsorship(dto: CreateSponsorshipDto, _desiredFields?: any): Promise<ITypedBackendResponse<Sponsorship>>;
     getS3UploadUrl(dto: AWSS3GetUploadDto): Promise<ITypedBackendResponse<AWSS3UploadUrl>>;
     getVtxS3UploadUrl(dto: AWSS3GetUploadDto): Promise<ITypedBackendResponse<AWSS3UploadUrl>>;
     refreshToken(currentToken: string, refreshToken: string): Promise<ITypedBackendResponse<UserToken>>;
@@ -76,27 +81,27 @@ export declare class VTXBaseAPI {
     }): Promise<ITypedBackendResponse<SportsEvent>>;
     deleteSportsEvent(dto: {
         eventId: string;
-    }): Promise<ITypedBackendResponse<EditValueResponse>>;
+    }): Promise<ITypedBackendResponse<DeleteSingleValueResponse>>;
     mergeSportsEvents(dto: MergeSportsEventsDto): Promise<ITypedBackendResponse<MergeEventsResponse>>;
     getAthleteCompetitions(dto: GetAthleteCompetitionsDto): Promise<ITypedBackendResponse<AthleteCompetition[]>>;
     getAthleteMemberships(athleteId: string): Promise<ITypedBackendResponse<AthleteMembership[]>>;
     deleteAthleteCompetition(dto: DeleteSingleValueDto): Promise<ITypedBackendResponse<DeleteSingleValueResponse>>;
     createFundingCampaign(dto: CreateFundingCampaignDto): Promise<ITypedBackendResponse<FundRaisingCampaign>>;
-    createMembershipOrganization(dto: CreateMembershipOrganizationDto, desiredFields?: MembershipOrganizationReferenceGenqlSelection): Promise<ITypedBackendResponse<MembershipOrganizationReference>>;
+    createMembershipOrganization(dto: CreateMembershipOrganizationDto): Promise<ITypedBackendResponse<MembershipOrganizationReference>>;
     getMembershipOrganizations(): Promise<ITypedBackendResponse<MembershipOrganizationReference[]>>;
-    createAthleteMembershipAffilation(dto: CreateAthleteMembershipDto, desiredFields?: AthleteMembershipGenqlSelection): Promise<ITypedBackendResponse<AthleteMembership>>;
+    createAthleteMembershipAffilation(dto: CreateAthleteMembershipDto): Promise<ITypedBackendResponse<AthleteMembership>>;
     deleteMembershipAffiliation(dto: DeleteSingleValueDto): Promise<ITypedBackendResponse<DeleteSingleValueResponse>>;
     queryAthleteFundingCampaigns(dto: AthleteQueryDto): Promise<ITypedBackendResponse<AthleteQueryResponse>>;
-    createStripeAccount(dto: CreateStripeAccountDto, desiredFields?: StripeAccountReferenceGenqlSelection): Promise<ITypedBackendResponse<StripeAccountReference>>;
-    createAthleteStripeSession(desiredFields?: StripeSessionGenqlSelection): Promise<ITypedBackendResponse<StripeSession>>;
-    createStripeCheckoutSession(dto: DonationCheckoutDto, desiredFields?: StripeCheckoutSessionGenqlSelection): Promise<ITypedBackendResponse<StripeCheckoutSession>>;
+    createStripeAccount(dto: CreateStripeAccountDto): Promise<ITypedBackendResponse<StripeAccountReference>>;
+    createAthleteStripeSession(): Promise<ITypedBackendResponse<StripeSession>>;
+    createStripeCheckoutSession(dto: DonationCheckoutDto, _desiredFields?: any): 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>>;
+    getStripeBalance(): Promise<ITypedBackendResponse<StripeBalance>>;
+    getDatabaseTextFile(dto: GetDatabaseFileDto): Promise<ITypedBackendResponse<TextDatabaseFile>>;
     getReceiptUrl(dto: GetReceiptDto): Promise<ITypedBackendResponse<ReceiptUrl>>;
     stripeQuery(dto: StripeQueryDto): Promise<ITypedBackendResponse<StripeObject>>;
-    setFundingStatus(dto: SetFundingStatusDto, desiredFields?: FundRaisingCampaignGenqlSelection): Promise<ITypedBackendResponse<FundRaisingCampaign>>;
+    setFundingStatus(dto: SetFundingStatusDto, _desiredFields?: any): Promise<ITypedBackendResponse<FundRaisingCampaign>>;
     findAthleteForIdPublic(id: string): Promise<ITypedBackendResponse<Athlete>>;
     editPicture(newPicDto: EditPictureDto): Promise<ITypedBackendResponse<EditPictureResponse>>;
     addAlbumsPictures(dto: UploadAlbumsPicturesDto): Promise<ITypedBackendResponse<AddValuesResponse>>;
@@ -114,6 +119,7 @@ export declare class VTXBaseAPI {
     getAndSetAlbumById(albumId: string): Promise<ITypedBackendResponse<Album>>;
     queryAthletesWithFilters(dto: AthleteQueryDto): Promise<ITypedBackendResponse<AthleteQueryResponse>>;
     getAthleteIntegrationsByAthlete(): Promise<ITypedBackendResponse<AthleteIntegrationReference>>;
+    deleteAthleteIntegration(): Promise<ITypedBackendResponse<boolean>>;
     getAthleteStravaIntegration(): Promise<ITypedBackendResponse<AthleteIntegrationReference>>;
     getAthleteInstagramIntegration(): Promise<ITypedBackendResponse<AthleteIntegrationReference>>;
     getReceipt(dto: GetReceiptDto): Promise<ITypedBackendResponse<Receipt>>;
@@ -145,7 +151,7 @@ export declare class VTXBaseAPI {
     editCampaignBudget(input: EditCampaignBudgetDto): Promise<ITypedBackendResponse<Boolean>>;
     editCompetitionBudgetForCampaign(input: EditCampaignBudgetDto): Promise<ITypedBackendResponse<Boolean>>;
     getDonationsByAthlete(): Promise<ITypedBackendResponse<Receipt[]>>;
-    getDonationsByMember(desiredFields?: DonationGenqlSelection): Promise<ITypedBackendResponse<Donation[]>>;
+    getDonationsByMember(): Promise<ITypedBackendResponse<Donation[]>>;
     findMemberForUser(loginEmail: string): Promise<ITypedBackendResponse<Member>>;
     getBudgetConcepts(): Promise<ITypedBackendResponse<BudgetConcept[]>>;
     getBudgetItemsUnits(): Promise<ITypedBackendResponse<BudgetItemUnit[]>>;
@@ -160,7 +166,7 @@ export declare class VTXBaseAPI {
     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>>;
+    getTransactionDetails(dto: GetTransactionDetailsDto): Promise<ITypedBackendResponse<TransactionDetails>>;
     getAllUsers(): Promise<ITypedBackendResponse<AdminUserView[]>>;
     getAllTransactions(): Promise<ITypedBackendResponse<AdminTransactionView[]>>;
     getTransactionsPaginated(args?: {
@@ -169,10 +175,10 @@ export declare class VTXBaseAPI {
     getUsersPaginated(args: {
         query: UserQueryDto;
     }): Promise<ITypedBackendResponse<PaginatedUsers>>;
-    updateUserSuspendedStatus(input: UpdateUserSuspendedStatusDto): Promise<ITypedBackendResponse<EditValueResponse>>;
-    deleteVtxUser(input: DeleteVtxUserDto): Promise<ITypedBackendResponse<DeleteVtxUserResponse>>;
+    updateUserSuspendedStatus(dto: UpdateUserSuspendedStatusDto): Promise<ITypedBackendResponse<EditValueResponse>>;
+    deleteVtxUser(dto: DeleteVtxUserDto): Promise<ITypedBackendResponse<DeleteVtxUserResponse>>;
     deleteMyAccount(): Promise<ITypedBackendResponse<DeleteVtxUserResponse>>;
-    createOffer(dto: CreateOfferDto, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
+    createOffer(dto: CreateOfferDto): Promise<ITypedBackendResponse<Offer>>;
     getOffers(): Promise<ITypedBackendResponse<Offer[]>>;
     getOffersPaginated(args: {
         query: OfferQueryDto;
@@ -180,13 +186,13 @@ export declare class VTXBaseAPI {
     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>>;
+    getOfferById(id: string): Promise<ITypedBackendResponse<Offer>>;
+    getOffersForAthlete(athleteId: string | null): Promise<ITypedBackendResponse<Offer[]>>;
+    updateOffer(id: string, dto: CreateOfferDto): 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>>;
+    setOfferStatus(id: string, status: string): Promise<ITypedBackendResponse<Offer>>;
+    activateOffer(id: string): Promise<ITypedBackendResponse<Offer>>;
+    deactivateOffer(id: string): Promise<ITypedBackendResponse<Offer>>;
     uploadCouponCodes(offerId: string, csvContent: string): Promise<ITypedBackendResponse<UploadResult>>;
     claimOffer(offerId: string, athleteId: string): Promise<ITypedBackendResponse<OfferClaim>>;
     getMyOfferClaims(args: {
@@ -194,16 +200,16 @@ export declare class VTXBaseAPI {
         query?: OfferClaimQueryDto;
     }): Promise<ITypedBackendResponse<OfferClaim[]>>;
     removeOfferClaim(claimId: string, athleteId: string): Promise<ITypedBackendResponse<boolean>>;
-    updateBrand(id: string, dto: CreateBrandDto, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
+    updateBrand(id: string, dto: CreateBrandDto): 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>>;
+    linkBrandToSponsor(brandId: string, sponsorId: string): Promise<ITypedBackendResponse<Brand>>;
+    unlinkBrandFromSponsor(brandId: string, sponsorId: string): 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>>;
+    createSponsor(dto: CreateSponsorDto): Promise<ITypedBackendResponse<Sponsor>>;
+    updateSponsor(id: string, dto: CreateSponsorDto): Promise<ITypedBackendResponse<Sponsor>>;
     deleteSponsor(id: string): Promise<ITypedBackendResponse<boolean>>;
     getLeaderboard(args?: {
         input?: LeaderboardQueryDto;
@@ -319,3 +325,4 @@ export declare class VTXBaseAPI {
     updateEmailSegment(id: string, input: any): Promise<ITypedBackendResponse<any>>;
     deleteEmailSegment(id: string): Promise<ITypedBackendResponse<boolean>>;
 }
+import { UserImages } from '../client';