@vertikalx/vtx-backend-client 3.0.0-dev.27 → 3.0.0-dev.29

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vertikalx/vtx-backend-client",
-    "version": "3.0.0-dev.27",
+    "version": "3.0.0-dev.29",
     "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 } 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, Platform, PeriodType, ContentType, PostSortOption } from '../client';
 import { ITypedBackendResponse } from './backend-response';
 import { APICallHeaders } from './api-call-headers';
 import { VerificationCodeType } from '@vertikalx/common-types';
@@ -200,4 +200,43 @@ export declare class VTXBaseAPI {
         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>>;
 }

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

@@ -10623,6 +10623,390 @@ class VTXBaseAPI {
         }
         return retValue;
     }
+    async getAthleteDashboard(athleteId) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            vtxScore: true,
+            socialScore: true,
+            trainingScore: true,
+            competitionScore: true,
+            lastUpdated: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteDashboard: {
+                    __args: { athleteId },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteDashboard Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteDashboard', (r) => {
+                const isResponseOk = response?.athleteDashboard?.vtxScore !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteDashboard err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteScoreHistory(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            date: true,
+            vtxScore: true,
+            socialScore: true,
+            trainingScore: true,
+            competitionScore: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteScoreHistory: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteScoreHistory Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteScoreHistory', (r) => {
+                const isResponseOk = Array.isArray(response?.athleteScoreHistory);
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteScoreHistory err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteRankHistory(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            date: true,
+            globalRank: true,
+            countryRank: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteRankHistory: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteRankHistory Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteRankHistory', (r) => {
+                const isResponseOk = Array.isArray(response?.athleteRankHistory);
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteRankHistory err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteRankContext(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            globalRank: true,
+            countryRank: true,
+            rankChange: true,
+            percentile: true,
+            gapToNext: true,
+            gapFromPrevious: true,
+            totalAthletes: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteRankContext: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteRankContext Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteRankContext', (r) => {
+                const isResponseOk = response?.athleteRankContext !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteRankContext err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteActivities(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const itemFields = {
+            id: true,
+            date: true,
+            type: true,
+            metrics: true,
+            pointsEarned: true,
+            counted: true,
+            notCountedReason: true,
+        };
+        const fields = {
+            items: itemFields,
+            total: true,
+            hasMore: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteActivities: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteActivities Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteActivities', (r) => {
+                const isResponseOk = response?.athleteActivities?.items !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteActivities err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteActivityDetail(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const metricFields = {
+            name: true,
+            value: true,
+            unit: true,
+            athleteAverage: true,
+            comparisonPercent: true,
+        };
+        const scoreInfoFields = {
+            earned: true,
+            maxPossible: true,
+            componentAverage: true,
+        };
+        const fields = {
+            id: true,
+            date: true,
+            type: true,
+            category: true,
+            metrics: metricFields,
+            scoreInfo: scoreInfoFields,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteActivityDetail: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteActivityDetail Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteActivityDetail', (r) => {
+                const isResponseOk = response?.athleteActivityDetail?.id !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteActivityDetail err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getAthleteComponentSummary(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const topMetricFields = {
+            name: true,
+            status: true,
+        };
+        const fields = {
+            name: true,
+            score: true,
+            maxScore: true,
+            trend: true,
+            trendPeriod: true,
+            activityCount: true,
+            avgScorePerActivity: true,
+            topMetrics: topMetricFields,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                athleteComponentSummary: {
+                    __args: args,
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getAthleteComponentSummary Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'athleteComponentSummary', (r) => {
+                const isResponseOk = response?.athleteComponentSummary?.name !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getAthleteComponentSummary err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getSocialAggregates(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const fields = {
+            _id: true,
+            athleteId: true,
+            platform: true,
+            contentType: true,
+            periodType: true,
+            periodLabel: true,
+            periodStart: true,
+            periodEnd: true,
+            totalLikes: true,
+            totalComments: true,
+            totalShares: true,
+            totalSaves: true,
+            totalReach: true,
+            totalViews: true,
+            totalImpressions: true,
+            postCount: true,
+            followerCount: true,
+            avgEngagementRate: true,
+            avgPostEngagement: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                socialAggregates: {
+                    __args: {
+                        athleteId: args.input.athleteId,
+                        platform: args.input.platform,
+                        range: {
+                            start: args.input.startDate,
+                            end: args.input.endDate,
+                        },
+                        periodType: args.input.periodType,
+                    },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getSocialAggregates Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'socialAggregates', (r) => {
+                const isResponseOk = response?.socialAggregates !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getSocialAggregates err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
+    async getPostsWithComparison(args) {
+        const client = (0, client_1.createClient)({
+            url: this.backendUrl + "/graphql",
+            headers: this.headers,
+        });
+        const postFields = {
+            id: true,
+            postId: true,
+            permalink: true,
+            thumbnailUrl: true,
+            contentType: true,
+            caption: true,
+            postedAt: true,
+            likes: true,
+            comments: true,
+            shares: true,
+            saves: true,
+            reach: true,
+            vsAvgPercent: true,
+        };
+        const fields = {
+            posts: postFields,
+            averages: {
+                likes: true,
+                comments: true,
+                reach: true,
+                engagementRate: true,
+            },
+            total: true,
+            hasMore: true,
+        };
+        let retValue;
+        try {
+            const response = await client.query({
+                postsWithComparison: {
+                    __args: {
+                        athleteId: args.input.athleteId,
+                        platform: args.input.platform,
+                        options: {
+                            sortBy: args.input.sortBy,
+                            contentType: args.input.contentType,
+                            limit: args.input.limit,
+                            offset: args.input.offset,
+                            comparisonWindowDays: args.input.comparisonWindowDays,
+                        },
+                    },
+                    ...fields
+                }
+            });
+            VTXBaseAPI.Logger.debug('getPostsWithComparison Response:');
+            VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
+            retValue = (0, response_builder_1.buildResponse)(response, 'postsWithComparison', (r) => {
+                const isResponseOk = response?.postsWithComparison !== undefined;
+                return isResponseOk;
+            });
+        }
+        catch (err1) {
+            VTXBaseAPI.Logger.error('getPostsWithComparison err1:');
+            VTXBaseAPI.Logger.error(err1);
+            retValue = (0, response_builder_1.buildErrorResponse)(err1);
+        }
+        return retValue;
+    }
 }
 exports.VTXBaseAPI = VTXBaseAPI;
 VTXBaseAPI.Logger = {