@vertikalx/vtx-backend-client 3.0.0-dev.23 → 3.0.0-dev.25

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev.23",
+    "version": "3.0.0-dev.25",
     "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,19 +1,7 @@
-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, PaginatedTransactionsType, TransactionQueryDto, PaginatedUsersType, UserQueryDto, PaginatedEventsType, EventQueryDto, PaginatedSportsType, SportQueryDto, StripeBalanceType, StripeBalanceTypeGenqlSelection, DeleteVtxUserDto, DeleteVtxUserResponse } 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 } from '../client';
 import { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
-export interface ForceScoreRefreshResult {
-    athleteId: string;
-    athleteName?: string | null;
-    status: string;
-    message?: string | null;
-}
-export interface ForceScoreRefreshResponse {
-    results: ForceScoreRefreshResult[];
-    successCount: number;
-    failureCount: number;
-    skippedCount: number;
-}
 export declare class VTXBaseAPI {
     protected headers: APICallHeaders;
     protected backendUrl: string;
@@ -37,6 +25,7 @@ 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>>;
@@ -59,13 +48,16 @@ export declare class VTXBaseAPI {
     getSports(): Promise<ITypedBackendResponse<Sport[]>>;
     getSportsPaginated(args: {
         query: SportQueryDto;
-    }): Promise<ITypedBackendResponse<PaginatedSportsType>>;
+    }): 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[]>>;
@@ -77,7 +69,7 @@ export declare class VTXBaseAPI {
     getSportsEvents(dto: GetSportEventsDto): Promise<ITypedBackendResponse<SportsEvent[]>>;
     getSportsEventsPaginated(dto: {
         query: EventQueryDto;
-    }): Promise<ITypedBackendResponse<PaginatedEventsType>>;
+    }): Promise<ITypedBackendResponse<PaginatedEvents>>;
     createSportsEvent(dto: CreateSportEventDto): Promise<ITypedBackendResponse<SportsEvent>>;
     updateSportsEvent(dto: {
         input: UpdateSportEventDto;
@@ -100,7 +92,7 @@ export declare class VTXBaseAPI {
     createStripeCheckoutSession(dto: DonationCheckoutDto, desiredFields?: StripeCheckoutSessionGenqlSelection): Promise<ITypedBackendResponse<StripeCheckoutSession>>;
     createStripeLoginLink(): Promise<ITypedBackendResponse<string>>;
     createStripeAccountLink(): Promise<ITypedBackendResponse<string>>;
-    getStripeBalance(desiredFields?: StripeBalanceTypeGenqlSelection): Promise<ITypedBackendResponse<StripeBalanceType>>;
+    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>>;
@@ -133,6 +125,9 @@ export declare class VTXBaseAPI {
     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>>;
@@ -164,11 +159,38 @@ export declare class VTXBaseAPI {
     getAllTransactions(): Promise<ITypedBackendResponse<AdminTransactionView[]>>;
     getTransactionsPaginated(args?: {
         query?: TransactionQueryDto;
-    }): Promise<ITypedBackendResponse<PaginatedTransactionsType>>;
+    }): Promise<ITypedBackendResponse<PaginatedTransactions>>;
     getUsersPaginated(args: {
         query: UserQueryDto;
-    }): Promise<ITypedBackendResponse<PaginatedUsersType>>;
+    }): 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>>;
 }