@vertikalx/vtx-backend-client 3.0.0-dev-max.130 → 3.0.0-dev-max.132

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertikalx/vtx-backend-client",
3
- "version": "3.0.0-dev-max.130",
3
+ "version": "3.0.0-dev-max.132",
4
4
  "description": "GraphQL API generated client for VTX",
5
5
  "types": "src/index.d.ts",
6
6
  "main": "src/index.js",
@@ -1,4 +1,4 @@
1
- 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, DeviceTokenType, FollowedAthletesListResponse, IsFollowingResponse, DonationDates, PaginatedDonations, DonationQueryDto } from '../client';
1
+ 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, 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';
2
2
  import { ITypedBackendResponse } from './backend-response';
3
3
  import { APICallHeaders } from './api-call-headers';
4
4
  import { VerificationCodeType } from '@vertikalx/common-types';
@@ -187,6 +187,12 @@ export declare class VTXBaseAPI {
187
187
  activateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
188
188
  deactivateOffer(id: string, desiredFields?: OfferGenqlSelection): Promise<ITypedBackendResponse<Offer>>;
189
189
  uploadCouponCodes(offerId: string, csvContent: string): Promise<ITypedBackendResponse<UploadResult>>;
190
+ claimOffer(offerId: string, athleteId: string): Promise<ITypedBackendResponse<OfferClaim>>;
191
+ getMyOfferClaims(args: {
192
+ athleteId: string;
193
+ query?: OfferClaimQueryDto;
194
+ }): Promise<ITypedBackendResponse<OfferClaim[]>>;
195
+ removeOfferClaim(claimId: string, athleteId: string): Promise<ITypedBackendResponse<boolean>>;
190
196
  updateBrand(id: string, dto: CreateBrandDto, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
191
197
  deleteBrand(id: string): Promise<ITypedBackendResponse<boolean>>;
192
198
  linkBrandToSponsor(brandId: string, sponsorId: string, desiredFields?: BrandGenqlSelection): Promise<ITypedBackendResponse<Brand>>;
@@ -2392,6 +2392,15 @@ class VTXBaseAPI {
2392
2392
  url: true,
2393
2393
  sourceData: true
2394
2394
  },
2395
+ coverImage: {
2396
+ _id: true,
2397
+ name: true,
2398
+ contentType: true,
2399
+ size: true,
2400
+ useType: true,
2401
+ url: true,
2402
+ key: true
2403
+ },
2395
2404
  location: {
2396
2405
  _id: true,
2397
2406
  userProvidedLatitude: true,
@@ -5140,6 +5149,15 @@ class VTXBaseAPI {
5140
5149
  url: true,
5141
5150
  sourceData: true
5142
5151
  },
5152
+ coverImage: {
5153
+ _id: true,
5154
+ name: true,
5155
+ contentType: true,
5156
+ size: true,
5157
+ useType: true,
5158
+ url: true,
5159
+ key: true
5160
+ },
5143
5161
  endingDate: true,
5144
5162
  competitions: {
5145
5163
  _id: true,
@@ -6119,6 +6137,15 @@ class VTXBaseAPI {
6119
6137
  url: true,
6120
6138
  sourceData: true
6121
6139
  },
6140
+ coverImage: {
6141
+ _id: true,
6142
+ name: true,
6143
+ contentType: true,
6144
+ size: true,
6145
+ useType: true,
6146
+ url: true,
6147
+ key: true
6148
+ },
6122
6149
  location: {
6123
6150
  _id: true,
6124
6151
  userProvidedLatitude: true,
@@ -7207,6 +7234,15 @@ class VTXBaseAPI {
7207
7234
  url: true,
7208
7235
  sourceData: true
7209
7236
  },
7237
+ coverImage: {
7238
+ _id: true,
7239
+ name: true,
7240
+ contentType: true,
7241
+ size: true,
7242
+ useType: true,
7243
+ url: true,
7244
+ key: true
7245
+ },
7210
7246
  endingDate: true,
7211
7247
  competitions: {
7212
7248
  _id: true,
@@ -10315,6 +10351,144 @@ class VTXBaseAPI {
10315
10351
  }
10316
10352
  return retValue;
10317
10353
  }
10354
+ async claimOffer(offerId, athleteId) {
10355
+ const client = (0, client_1.createClient)({
10356
+ url: this.backendUrl + "/graphql",
10357
+ headers: this.headers,
10358
+ });
10359
+ const fields = {
10360
+ _id: true,
10361
+ claimedAt: true,
10362
+ code: true,
10363
+ offer: {
10364
+ _id: true,
10365
+ label: true,
10366
+ type: true,
10367
+ dateEnd: true,
10368
+ discountTypeData: true,
10369
+ offerImage: {
10370
+ url: true
10371
+ },
10372
+ brand: {
10373
+ _id: true,
10374
+ name: true,
10375
+ website: true,
10376
+ affiliateLink: true,
10377
+ logo: {
10378
+ url: true
10379
+ }
10380
+ }
10381
+ }
10382
+ };
10383
+ let retValue = {};
10384
+ try {
10385
+ const response = await client.mutation({
10386
+ claimOffer: {
10387
+ __args: {
10388
+ offerId: offerId,
10389
+ athleteId: athleteId
10390
+ },
10391
+ ...fields
10392
+ }
10393
+ });
10394
+ VTXBaseAPI.Logger.debug('claimOffer Response:');
10395
+ VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
10396
+ retValue = (0, response_builder_1.buildResponse)(response, 'claimOffer', (r) => {
10397
+ const isResponseOk = response?.claimOffer?._id !== undefined;
10398
+ return isResponseOk;
10399
+ });
10400
+ }
10401
+ catch (err1) {
10402
+ VTXBaseAPI.Logger.error('claimOffer err1:');
10403
+ VTXBaseAPI.Logger.error(err1);
10404
+ retValue = (0, response_builder_1.buildErrorResponse)(err1);
10405
+ }
10406
+ return retValue;
10407
+ }
10408
+ async getMyOfferClaims(args) {
10409
+ const client = (0, client_1.createClient)({
10410
+ url: this.backendUrl + "/graphql",
10411
+ headers: this.headers,
10412
+ });
10413
+ const fields = {
10414
+ _id: true,
10415
+ claimedAt: true,
10416
+ code: true,
10417
+ offer: {
10418
+ _id: true,
10419
+ label: true,
10420
+ type: true,
10421
+ dateEnd: true,
10422
+ discountTypeData: true,
10423
+ offerImage: {
10424
+ url: true
10425
+ },
10426
+ brand: {
10427
+ _id: true,
10428
+ name: true,
10429
+ website: true,
10430
+ affiliateLink: true,
10431
+ logo: {
10432
+ url: true
10433
+ }
10434
+ }
10435
+ }
10436
+ };
10437
+ let retValue = {};
10438
+ try {
10439
+ const response = await client.query({
10440
+ myOfferClaims: {
10441
+ __args: {
10442
+ athleteId: args.athleteId,
10443
+ query: args.query
10444
+ },
10445
+ ...fields
10446
+ }
10447
+ });
10448
+ VTXBaseAPI.Logger.debug('getMyOfferClaims Response:');
10449
+ VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
10450
+ retValue = (0, response_builder_1.buildResponse)(response, 'myOfferClaims', (r) => {
10451
+ const isResponseOk = Array.isArray(response?.myOfferClaims);
10452
+ return isResponseOk;
10453
+ });
10454
+ }
10455
+ catch (err1) {
10456
+ VTXBaseAPI.Logger.error('getMyOfferClaims err1:');
10457
+ VTXBaseAPI.Logger.error(err1);
10458
+ retValue = (0, response_builder_1.buildErrorResponse)(err1);
10459
+ }
10460
+ return retValue;
10461
+ }
10462
+ async removeOfferClaim(claimId, athleteId) {
10463
+ const client = (0, client_1.createClient)({
10464
+ url: this.backendUrl + "/graphql",
10465
+ headers: this.headers,
10466
+ });
10467
+ let retValue = {};
10468
+ try {
10469
+ const response = await client.mutation({
10470
+ removeOfferClaim: {
10471
+ __args: {
10472
+ claimId: claimId,
10473
+ athleteId: athleteId
10474
+ },
10475
+ __scalar: true
10476
+ }
10477
+ });
10478
+ VTXBaseAPI.Logger.debug('removeOfferClaim Response:');
10479
+ VTXBaseAPI.Logger.debug(JSON.stringify(response, null, 2));
10480
+ retValue = (0, response_builder_1.buildResponse)(response, 'removeOfferClaim', (r) => {
10481
+ const isResponseOk = response?.removeOfferClaim === true;
10482
+ return isResponseOk;
10483
+ });
10484
+ }
10485
+ catch (err1) {
10486
+ VTXBaseAPI.Logger.error('removeOfferClaim err1:');
10487
+ VTXBaseAPI.Logger.error(err1);
10488
+ retValue = (0, response_builder_1.buildErrorResponse)(err1);
10489
+ }
10490
+ return retValue;
10491
+ }
10318
10492
  async updateBrand(id, dto, desiredFields) {
10319
10493
  const client = (0, client_1.createClient)({
10320
10494
  url: this.backendUrl + "/graphql",