@vertikalx/vtx-backend-client 3.0.0-dev-max.110 → 3.0.0-dev-max.111

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev-max.110",
+    "version": "3.0.0-dev-max.111",
     "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, 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, Notification, NotificationListResponse, UnreadCountResponse, NotificationPreference, FollowedAthletesListResponse, IsFollowingResponse } from '../client';
 import { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
@@ -240,6 +240,31 @@ 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>>;
+    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;

package/src/api/vtx-base-api.js

@@ -2383,6 +2383,7 @@ class VTXBaseAPI {
                 fundsRequired: true,
                 initialFundsObtained: true,
                 fundsObtained: true,
+                vtxComissionPct: true,
                 video: {
                     _id: true,
                     source: true,
@@ -6109,6 +6110,7 @@ class VTXBaseAPI {
                 fundsRequired: true,
                 initialFundsObtained: true,
                 fundsObtained: true,
+                vtxComissionPct: true,
                 video: {
                     _id: true,
                     source: true,
@@ -7197,6 +7199,7 @@ class VTXBaseAPI {
                 fundsRequired: true,
                 initialFundsObtained: true,
                 fundsObtained: true,
+                vtxComissionPct: true,
                 video: {
                     _id: true,
                     source: true,
@@ -11046,6 +11049,356 @@ class VTXBaseAPI {
         }
         return retValue;
     }
+    async getMyNotifications(options) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const notificationFields = {
+            id: true,
+            type: true,
+            title: true,
+            message: true,
+            iconType: true,
+            iconUrl: true,
+            actionRoute: true,
+            actionParams: true,
+            actionLabel: true,
+            read: true,
+            dismissed: true,
+            createdAt: true,
+        };
+        const fields = {
+            notifications: notificationFields,
+            total: true,
+            hasMore: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                myNotifications: {
+                    __args: { input: options || {} },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getMyNotifications Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'myNotifications', (r) => {
+                const isResponseOk = response?.myNotifications?.notifications !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getMyNotifications err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getNotificationUnreadCount() {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            count: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                notificationUnreadCount: {
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getNotificationUnreadCount Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'notificationUnreadCount', (r) => {
+                const isResponseOk = response?.notificationUnreadCount?.count !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getNotificationUnreadCount err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getMyNotificationPreferences() {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            id: true,
+            emailEnabled: true,
+            inAppEnabled: true,
+            pushEnabled: true,
+            mutedTypes: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                myNotificationPreferences: {
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getMyNotificationPreferences Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'myNotificationPreferences', (r) => {
+                const isResponseOk = response?.myNotificationPreferences?.id !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getMyNotificationPreferences err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async markNotificationAsRead(notificationId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            id: true,
+            read: true,
+        };
+        let retValue;
+        try {
+            const response = await client.mutation({
+                markNotificationAsRead: {
+                    __args: { input: { notificationId } },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('markNotificationAsRead Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'markNotificationAsRead', (r) => {
+                const isResponseOk = response?.markNotificationAsRead?.id !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('markNotificationAsRead err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async markAllNotificationsAsRead() {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        let retValue;
+        try {
+            const response = await client.mutation({
+                markAllNotificationsAsRead: true
+            });
+            VTXBaseAPI.Logger.debug('markAllNotificationsAsRead Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'markAllNotificationsAsRead', (r) => {
+                const isResponseOk = response?.markAllNotificationsAsRead !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('markAllNotificationsAsRead err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async dismissNotification(notificationId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        let retValue;
+        try {
+            const response = await client.mutation({
+                dismissNotification: {
+                    __args: { input: { notificationId } },
+                }
+            });
+            VTXBaseAPI.Logger.debug('dismissNotification Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'dismissNotification', (r) => {
+                const isResponseOk = response?.dismissNotification !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('dismissNotification err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async updateNotificationPreferences(input) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            id: true,
+            emailEnabled: true,
+            inAppEnabled: true,
+            pushEnabled: true,
+            mutedTypes: true,
+        };
+        let retValue;
+        try {
+            const response = await client.mutation({
+                updateNotificationPreferences: {
+                    __args: { input },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('updateNotificationPreferences Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'updateNotificationPreferences', (r) => {
+                const isResponseOk = response?.updateNotificationPreferences?.id !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('updateNotificationPreferences err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async followAthlete(athleteId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        let retValue;
+        try {
+            const response = await client.mutation({
+                followAthlete: {
+                    __args: { input: { athleteId } },
+                }
+            });
+            VTXBaseAPI.Logger.debug('followAthlete Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'followAthlete', (r) => {
+                const isResponseOk = response?.followAthlete !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('followAthlete err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async unfollowAthlete(athleteId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        let retValue;
+        try {
+            const response = await client.mutation({
+                unfollowAthlete: {
+                    __args: { input: { athleteId } },
+                }
+            });
+            VTXBaseAPI.Logger.debug('unfollowAthlete Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'unfollowAthlete', (r) => {
+                const isResponseOk = response?.unfollowAthlete !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('unfollowAthlete err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async isFollowingAthlete(athleteId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            isFollowing: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                isFollowingAthlete: {
+                    __args: { input: { athleteId } },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('isFollowingAthlete Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'isFollowingAthlete', (r) => {
+                const isResponseOk = response?.isFollowingAthlete?.isFollowing !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('isFollowingAthlete err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getMyFollowedAthletes(options) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const athleteFields = {
+            id: true,
+            firstName: true,
+            lastName: true,
+            screenName: true,
+            profilePicture: {
+                _id: true,
+                url: true,
+                key: true,
+            },
+            sportName: true,
+            vtxScore: true,
+        };
+        const fields = {
+            athletes: athleteFields,
+            total: true,
+            hasMore: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                myFollowedAthletes: {
+                    __args: { input: options || null },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getMyFollowedAthletes Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'myFollowedAthletes', (r) => {
+                const isResponseOk = response?.myFollowedAthletes?.athletes !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getMyFollowedAthletes err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
     async deleteOnboardingAthlete() {
         const client = (0, client_1.createClient)({
             url: this.backendUrl + '/graphql',