reach-api-sdk 1.0.227 → 1.0.228
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/README.md +49 -7
- package/dist/reach-sdk.d.ts +129 -1
- package/dist/reach-sdk.js +30 -2
- package/package.json +5 -1
- package/scripts/sync-swagger.mjs +33 -0
- package/src/definition/swagger.yaml +208 -1
- package/src/index.ts +3 -0
- package/src/models/AttendeePost.ts +17 -0
- package/src/models/DatabaseState.ts +4 -0
- package/src/models/TenantSetting.ts +5 -0
- package/src/models/Wallet.ts +10 -0
- package/src/models/WalletCreditPeriod.ts +59 -0
- package/src/models/WalletCreditPeriodReassessPost.ts +22 -0
- package/src/models/WalletCreditPeriodStatus.ts +12 -0
- package/src/services/WalletsService.ts +35 -0
package/README.md
CHANGED
|
@@ -1,10 +1,52 @@
|
|
|
1
1
|
# reach-sdk usage
|
|
2
|
-
When changes are made to reach-api that affect exposed models and services, perform the following to update the SDK
|
|
3
2
|
|
|
4
|
-
|
|
5
|
-
- copy the contents and paste in \src\definition\swagger.yaml
|
|
6
|
-
- run `npm run build` to build models and services from the new yaml definition
|
|
7
|
-
- check the current build version in package.json and increment by one `npm version 1.0.xxx`
|
|
3
|
+
When changes are made to reach-api that affect exposed models and services, regenerate the SDK from OpenAPI — do not hand-edit generated files under `src/models`, `src/services`, `src/core`, or `src/index.ts`.
|
|
8
4
|
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
## Regenerate from reach-api
|
|
6
|
+
|
|
7
|
+
1. Run **reach-api** locally.
|
|
8
|
+
2. Sync swagger and rebuild:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm run sync
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
`npm run sync` fetches `https://localhost:44310/swagger/v1/swagger.yaml` (override with `REACH_API_SWAGGER_URL`) and runs the full build.
|
|
15
|
+
|
|
16
|
+
## Local development with played-partner-platform
|
|
17
|
+
|
|
18
|
+
played-partner-platform overlays this package locally via `npm run sdk:local` (does not modify package.json). After regenerating:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# In played-partner-platform
|
|
22
|
+
npm run sdk:local
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or sync + dev server in one step:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm run sync:sdk
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Before commit, restore the published SDK:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run sdk:published
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Publishing to registry
|
|
38
|
+
|
|
39
|
+
Check the current version in `package.json`, increment, then publish:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm version 1.0.xxx
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Contact Shervin to publish to NPM.
|
|
46
|
+
|
|
47
|
+
After publishing, restore the published SDK in partner platform when not doing local API work:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# In played-partner-platform
|
|
51
|
+
npm run sdk:published
|
|
52
|
+
```
|
package/dist/reach-sdk.d.ts
CHANGED
|
@@ -1888,6 +1888,66 @@ type Customer = {
|
|
|
1888
1888
|
wallet?: Wallet;
|
|
1889
1889
|
};
|
|
1890
1890
|
|
|
1891
|
+
/**
|
|
1892
|
+
* Controls the wallet credit period status.
|
|
1893
|
+
*/
|
|
1894
|
+
declare enum WalletCreditPeriodStatus {
|
|
1895
|
+
ACTIVE = "Active",
|
|
1896
|
+
CLOSED = "Closed"
|
|
1897
|
+
}
|
|
1898
|
+
|
|
1899
|
+
/**
|
|
1900
|
+
* Represents a credit entitlement window for a wallet.
|
|
1901
|
+
*/
|
|
1902
|
+
type WalletCreditPeriod = {
|
|
1903
|
+
/**
|
|
1904
|
+
* Gets or sets the entities Id.
|
|
1905
|
+
*/
|
|
1906
|
+
id?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* Gets or sets the tenant Id.
|
|
1909
|
+
*/
|
|
1910
|
+
tenantId: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Gets or sets the created date of this entity.
|
|
1913
|
+
*/
|
|
1914
|
+
dateCreated: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Gets or sets the last modified date of this entity.
|
|
1917
|
+
*/
|
|
1918
|
+
dateModified: string;
|
|
1919
|
+
/**
|
|
1920
|
+
* Gets or sets the modified by Id.
|
|
1921
|
+
*/
|
|
1922
|
+
modifiedById?: string | null;
|
|
1923
|
+
/**
|
|
1924
|
+
* Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
1925
|
+
*/
|
|
1926
|
+
isLive: boolean;
|
|
1927
|
+
/**
|
|
1928
|
+
* Gets or sets the wallet id.
|
|
1929
|
+
*/
|
|
1930
|
+
walletId: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* Gets or sets the first day credits are usable (inclusive).
|
|
1933
|
+
*/
|
|
1934
|
+
periodStartDate: string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Gets or sets the last day credits are usable (inclusive).
|
|
1937
|
+
*/
|
|
1938
|
+
periodEndDate: string;
|
|
1939
|
+
/**
|
|
1940
|
+
* Gets or sets the credit award amount for this period.
|
|
1941
|
+
*/
|
|
1942
|
+
creditAllocation: number;
|
|
1943
|
+
/**
|
|
1944
|
+
* Gets or sets a value indicating whether this period should auto-renew when it ends.
|
|
1945
|
+
*/
|
|
1946
|
+
autoRenew: boolean;
|
|
1947
|
+
status: WalletCreditPeriodStatus;
|
|
1948
|
+
wallet?: Wallet;
|
|
1949
|
+
};
|
|
1950
|
+
|
|
1891
1951
|
/**
|
|
1892
1952
|
* Controls the customer cancellation options.
|
|
1893
1953
|
*/
|
|
@@ -6200,8 +6260,17 @@ type Wallet = {
|
|
|
6200
6260
|
* Gets or sets the wallet currency.
|
|
6201
6261
|
*/
|
|
6202
6262
|
currency?: string | null;
|
|
6263
|
+
/**
|
|
6264
|
+
* Gets or sets the current active credit period id when wallet credit periods are enabled.
|
|
6265
|
+
*/
|
|
6266
|
+
currentCreditPeriodId?: string | null;
|
|
6267
|
+
/**
|
|
6268
|
+
* Gets the period end date for the current credit period. Used by partner platform wallet UI.
|
|
6269
|
+
*/
|
|
6270
|
+
readonly cycleEndDate?: string | null;
|
|
6203
6271
|
customer?: Customer;
|
|
6204
6272
|
attendee?: Attendee;
|
|
6273
|
+
currentCreditPeriod?: WalletCreditPeriod;
|
|
6205
6274
|
/**
|
|
6206
6275
|
* Gets or sets the wallet transactions.
|
|
6207
6276
|
*/
|
|
@@ -6323,8 +6392,25 @@ type AttendeePost = {
|
|
|
6323
6392
|
* When wallet tracking level is Attendee, a wallet is always created for the attendee.
|
|
6324
6393
|
* If InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.
|
|
6325
6394
|
* If not provided or set to 0, the wallet will be created with a balance of 0.
|
|
6395
|
+
* Ignored when enable_wallet_credit_periods is enabled; use credit period fields instead.
|
|
6326
6396
|
*/
|
|
6327
6397
|
initialWalletBalance?: number | null;
|
|
6398
|
+
/**
|
|
6399
|
+
* Gets or sets the credit period start date. Required when wallet credit periods are enabled.
|
|
6400
|
+
*/
|
|
6401
|
+
creditPeriodStartDate?: string | null;
|
|
6402
|
+
/**
|
|
6403
|
+
* Gets or sets the credit period end date. Required when wallet credit periods are enabled.
|
|
6404
|
+
*/
|
|
6405
|
+
creditPeriodEndDate?: string | null;
|
|
6406
|
+
/**
|
|
6407
|
+
* Gets or sets the credit allocation for the initial period. Required when wallet credit periods are enabled.
|
|
6408
|
+
*/
|
|
6409
|
+
creditAllocation?: number | null;
|
|
6410
|
+
/**
|
|
6411
|
+
* Gets or sets a value indicating whether the credit period auto-renews. Defaults to true when not specified.
|
|
6412
|
+
*/
|
|
6413
|
+
creditPeriodAutoRenew?: boolean | null;
|
|
6328
6414
|
/**
|
|
6329
6415
|
* Gets or sets the attendee date of birth.
|
|
6330
6416
|
* This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
|
|
@@ -46400,6 +46486,11 @@ type TenantSetting = {
|
|
|
46400
46486
|
* When enabled, prices will be displayed as 'credits' rather than currency.
|
|
46401
46487
|
*/
|
|
46402
46488
|
walletOnlyPayments?: boolean;
|
|
46489
|
+
/**
|
|
46490
|
+
* Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.
|
|
46491
|
+
* When enabled, attendee wallets require an active credit period for bookings and allocation management.
|
|
46492
|
+
*/
|
|
46493
|
+
enableWalletCreditPeriods?: boolean;
|
|
46403
46494
|
/**
|
|
46404
46495
|
* Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.
|
|
46405
46496
|
* When true, the authenticated email must match a live customer row (email or display_email) for this tenant.
|
|
@@ -62449,6 +62540,10 @@ type DatabaseState = {
|
|
|
62449
62540
|
* Gets or sets a value indicating whether facilities database records exist.
|
|
62450
62541
|
*/
|
|
62451
62542
|
facilitiesExist: boolean;
|
|
62543
|
+
/**
|
|
62544
|
+
* Gets or sets a value indicating whether sellable item (product) database records exist.
|
|
62545
|
+
*/
|
|
62546
|
+
sellableItemsExist: boolean;
|
|
62452
62547
|
/**
|
|
62453
62548
|
* Gets or sets a value indicating whether scheduled session database records exist.
|
|
62454
62549
|
*/
|
|
@@ -71862,6 +71957,24 @@ declare class WaitlistOpportunityReportService {
|
|
|
71862
71957
|
}): CancelablePromise<Array<WaitlistOpportunityReport>>;
|
|
71863
71958
|
}
|
|
71864
71959
|
|
|
71960
|
+
/**
|
|
71961
|
+
* Request body for mid-cycle credit reassessment.
|
|
71962
|
+
*/
|
|
71963
|
+
type WalletCreditPeriodReassessPost = {
|
|
71964
|
+
/**
|
|
71965
|
+
* Gets or sets the new credit allocation. Wallet balance is set to this amount immediately.
|
|
71966
|
+
*/
|
|
71967
|
+
creditAllocation: number;
|
|
71968
|
+
/**
|
|
71969
|
+
* Gets or sets an optional updated period end date.
|
|
71970
|
+
*/
|
|
71971
|
+
periodEndDate?: string | null;
|
|
71972
|
+
/**
|
|
71973
|
+
* Gets or sets an optional auto-renew flag.
|
|
71974
|
+
*/
|
|
71975
|
+
autoRenew?: boolean | null;
|
|
71976
|
+
};
|
|
71977
|
+
|
|
71865
71978
|
type WalletPage = {
|
|
71866
71979
|
pagination: Pagination;
|
|
71867
71980
|
readonly items: Array<Wallet>;
|
|
@@ -71966,6 +72079,21 @@ declare class WalletsService {
|
|
|
71966
72079
|
*/
|
|
71967
72080
|
attendeeId: string;
|
|
71968
72081
|
}): CancelablePromise<Wallet>;
|
|
72082
|
+
/**
|
|
72083
|
+
* Reassesses the active credit period for a wallet and sets balance to the new allocation.
|
|
72084
|
+
* @returns Wallet OK
|
|
72085
|
+
* @throws ApiError
|
|
72086
|
+
*/
|
|
72087
|
+
reassessCreditPeriod({ id, requestBody, }: {
|
|
72088
|
+
/**
|
|
72089
|
+
* The wallet id.
|
|
72090
|
+
*/
|
|
72091
|
+
id: string;
|
|
72092
|
+
/**
|
|
72093
|
+
* The reassessment request.
|
|
72094
|
+
*/
|
|
72095
|
+
requestBody?: WalletCreditPeriodReassessPost;
|
|
72096
|
+
}): CancelablePromise<Wallet>;
|
|
71969
72097
|
/**
|
|
71970
72098
|
* Gets the transaction history for a wallet.
|
|
71971
72099
|
* @returns WalletTransaction OK
|
|
@@ -73134,4 +73262,4 @@ type ValidationResultModel = {
|
|
|
73134
73262
|
readonly errors?: Array<ValidationError> | null;
|
|
73135
73263
|
};
|
|
73136
73264
|
|
|
73137
|
-
export { AccessCredential, AccessCredentialPage, AccessCredentialPatch, AccessCredentialPost, AccessCredentialsService, Activity, ActivityFacet, ActivityPerformance, ActivityPerformancePage, ActivityPerformancePatch, ActivityPerformancePost, ActivityPerformanceService, ActivitySearchResponse, ActivityService, ActivityType, ActivityTypeCategory, ActivityTypeCategoryService, AddressBookItem, AddressBooksRequest, AddressComponent, AdvanceBooking, Amenity, AmenityService, AmenityType, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeeWalletDeductionPreview, AttendeesService, AutoCompleteResponseModel, AvailabilityIndicator, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, CancellationPoliciesService, CancellationPolicy, CancellationPolicyPage, CancellationPolicyPatch, CancellationPolicyPost, ChatService, CheckoutPlatform, ChoiceMessage, CodelocksLock, CodelocksLockPage, CodelocksLockPatch, CodelocksLockPost, CodelocksLocksService, CompletionChoice, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CourseCreate, CourseEmailAttendeesPatch, CourseEmailWaitlistPatch, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionReschedulePatch, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CourseStatus, CoursesService, CreateDeal, CreateEmailSettings, CreateOffer, CreateQuestion, CreateQuestionOption, CreateTemplateDetail, CreateTemplateFieldPermission, CreateVenue, CustomDateRange, CustomDateRangeOption, CustomFieldDataType, CustomFieldDefinition, CustomFieldDefinitionPage, CustomFieldDefinitionPatch, CustomFieldDefinitionPost, CustomFieldDefinitionWithValue, CustomFieldOption, CustomFieldOptionDto, CustomFieldOptionPost, CustomFieldValueEntityType, CustomFieldValueUpdate, CustomFieldsBulkUpdate, CustomFieldsService, Customer, CustomerAccountInvitePatch, CustomerAuthService, CustomerCancellationOption, CustomerEmailPatch, CustomerPage, CustomerPatch, CustomerPortalAccountPatch, CustomerPortalService, CustomerPost, CustomerStats, CustomerType, CustomerWalletDeductionPreview, CustomersService, DatabaseState, DayOfWeek, Deal, DealActivitiesService, DealActivity, DealActivityPage, DealActivityPatch, DealActivityPost, DealCreate, DealDiscountType, DealPage, DealPatch, DealPost, DealTarget, DealType, DealsService, DescriptionCompletionResponse, DiscountCodeUse, DiscountCodeUsePage, DiscountCodeUsePatch, DiscountCodeUsePost, DiscountCodeUsesService, DotdigitalCanonicalField, DotdigitalService, DotdigitalSourceType, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, EndUserAccessibleTenantDto, EndUserIdentity, EndUserIdentitySecureToken, EndUserIdentitySecureTokenService, EnglandGolfReportService, EventTiming, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FeatureAnnouncementDismissPost, FeatureAnnouncementForUserDto, FeatureAnnouncementsService, FieldPermission, FilestackImageMetaResponseModel, FilestackService, Gender, GenericActivity, GenericActivityPage, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HelpersService, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImageLibraryCategory, ImageLibraryCategoryService, ImageLibraryImage, ImageLibraryImageService, ImagePage, ImagePatch, ImagePost, ImageUploadHistory, ImageUploadHistoryPage, ImageUploadHistoryPatch, ImageUploadHistoryPost, ImageUploadHistoryService, ImagesService, IntegrationCodelocksSettings, IntegrationCodelocksSettingsCreate, IntegrationCodelocksSettingsPage, IntegrationCodelocksSettingsPatch, IntegrationCodelocksSettingsPost, IntegrationCodelocksSettingsService, IntegrationDotDigitalSettingsService, IntegrationDotdigitalFieldMap, IntegrationDotdigitalFieldMapPage, IntegrationDotdigitalFieldMapPatch, IntegrationDotdigitalFieldMapPost, IntegrationDotdigitalFieldMapService, IntegrationDotdigitalLog, IntegrationDotdigitalLogPage, IntegrationDotdigitalLogPatch, IntegrationDotdigitalLogPost, IntegrationDotdigitalLogService, IntegrationDotdigitalLogStatus, IntegrationDotdigitalSettings, IntegrationDotdigitalSettingsCreate, IntegrationDotdigitalSettingsPage, IntegrationDotdigitalSettingsPatch, IntegrationDotdigitalSettingsPost, IntegrationQueue, IntegrationQueuePage, IntegrationQueuePatch, IntegrationQueuePost, IntegrationQueueService, IntegrationType, InviteStatus, LeasingService, LocationReport, LocationReportPage, LocationReportPatch, LocationReportPost, LocationReportSummary, LocationsReportService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityRegisterStatus, OpportunityType, Order, OrderApplyDiscountCode, OrderDeal, OrderEmailCustomerPatch, OrderItem, OrderItemCodelocksAccess, OrderItemDeal, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemReport, OrderItemReportPage, OrderItemReportPatch, OrderItemReportPost, OrderItemReportService, OrderItemReportSummary, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPatchItem, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPoliciesService, PaymentPolicy, PaymentPolicyPage, PaymentPolicyPatch, PaymentPolicyPost, PaymentPolicySplitType, PaymentPost, PaymentsService, PeriodsOfWeek, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceAddress, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlatformPayout, PlatformPayoutPage, PlatformPayoutPatch, PlatformPayoutPost, PlatformPayoutsService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, Provider, ProviderActivityLocation, ProviderCreate, ProviderPage, ProviderPatch, ProviderPost, ProviderType, ProviderTypesService, ProvidersService, PublicBookingService, PublicCalendarService, PublicCoursesService, PublicCustomersService, PublicFacilitiesService, PublicFilestackWebhookService, PublicGenericActivityService, PublicHealthCheckService, PublicLeasingService, PublicNetworksService, PublicOpportunityRegisterService, PublicOrderItemsService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicProvidersService, PublicScheduledSessionsService, PublicSellableItemsService, PublicSessionsService, PublicSlotsService, PublicStorefrontStaffPreviewService, PublicStripeWebhookService, PublicSurveyCompletionLogsService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantFaqsService, PublicTenantsService, PublicVenueTypesService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, RefundSource, RefundStatus, RegisterReport, RegisterReportPage, RegisterReportPatch, RegisterReportPost, RegisterReportService, RegisterReportSummary, RescheduleLog, RescheduleLogPage, RescheduleLogPatch, RescheduleLogPost, RescheduleLogService, ResolveSecureAccessTokenRequest, ScheduleStatus, ScheduledSession, ScheduledSessionEmailAttendeesPatch, ScheduledSessionEmailWaitlistPatch, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionReschedulePatch, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, SellableItem, SellableItemPage, SellableItemPatch, SellableItemPost, SellableItemsService, Session, SessionCreate, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, SortIndex, Southwest, StorefrontStaffPreviewService, StorefrontStaffPreviewTokenResponse, StorefrontStaffPreviewValidateRequest, StorefrontStaffPreviewValidateResponse, StripeAccount, StripeAccountLinkedEntityType, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StripeSetupRequirement, StripeStatus, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCompletionLog, SurveyCompletionLogPage, SurveyCompletionLogPatch, SurveyCompletionLogPost, SurveyCompletionLogService, SurveyCreate, SurveyDuplicatePost, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPatchOption, SurveyQuestionPost, SurveyQuestionPostOption, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmit, SurveySubmitAttendee, SurveySubmitQuestions, SurveyType, SurveysService, Tax, Template, TemplateCreate, TemplateDeal, TemplateDetail, TemplateDetailPage, TemplateDetailPatch, TemplateDetailPost, TemplateDetailsService, TemplateDuplicatePost, TemplateFieldPermission, TemplateFieldPermissionPage, TemplateFieldPermissionPatch, TemplateFieldPermissionPost, TemplateFieldPermissionsService, TemplateFromPost, TemplateOffer, TemplateOfferPage, TemplateOfferPatch, TemplateOfferPost, TemplateOffersService, TemplatePage, TemplatePatch, TemplatePost, TemplateUseResponse, TemplatesService, Tenant, TenantFaq, TenantFaqPage, TenantFaqPatch, TenantFaqPost, TenantFaqsService, TenantPage, TenantPatch, TenantPost, TenantSetting, TenantStatus, TenantStorefrontSettingsPatch, TenantTier, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UnsplashSearchResponse, UnsplashService, UpcomingLayout, UpdateCustomFieldOption, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPermission, UserPermissionPage, UserPermissionPatch, UserPermissionPost, UserPermissionsService, UserPost, UserProgramme, UserProgrammePage, UserProgrammePatch, UserProgrammePost, UserProgrammesService, UserProvider, UserProviderPage, UserProviderPatch, UserProviderPost, UserProvidersService, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueManager, VenueManagerPage, VenueManagerPatch, VenueManagerPost, VenueManagersService, VenueOpeningHourUpdate, VenueOpeningHours, VenuePage, VenuePatch, VenuePerformance, VenuePerformancePage, VenuePerformancePatch, VenuePerformancePost, VenuePerformanceService, VenuePost, VenueType, VenueTypePage, VenueTypePatch, VenueTypePost, VenueTypeService, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityReport, WaitlistActivityReportPage, WaitlistActivityReportPatch, WaitlistActivityReportPost, WaitlistActivityReportService, WaitlistActivityService, WaitlistConversionStatsResponseDto, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityReport, WaitlistOpportunityReportPage, WaitlistOpportunityReportPatch, WaitlistOpportunityReportPost, WaitlistOpportunityReportService, WaitlistOpportunityService, Wallet, WalletDeductionPreview, WalletPage, WalletPatch, WalletPost, WalletRemoveCreditPost, WalletTopUpPost, WalletTrackingLevel, WalletTransaction, WalletTransactionPage, WalletTransactionPatch, WalletTransactionPost, WalletTransactionType, WalletTransactionsService, WalletsService, WebsiteHomepage };
|
|
73265
|
+
export { AccessCredential, AccessCredentialPage, AccessCredentialPatch, AccessCredentialPost, AccessCredentialsService, Activity, ActivityFacet, ActivityPerformance, ActivityPerformancePage, ActivityPerformancePatch, ActivityPerformancePost, ActivityPerformanceService, ActivitySearchResponse, ActivityService, ActivityType, ActivityTypeCategory, ActivityTypeCategoryService, AddressBookItem, AddressBooksRequest, AddressComponent, AdvanceBooking, Amenity, AmenityService, AmenityType, ApiClient, ApiError, AppUserRole, ApplicationRole, Attendee, AttendeePage, AttendeePatch, AttendeePost, AttendeeWalletDeductionPreview, AttendeesService, AutoCompleteResponseModel, AvailabilityIndicator, BadEnglandReportService, BaseHttpRequest, BookingService, BookingStatus, CancelError, CancelablePromise, CancellationPoliciesService, CancellationPolicy, CancellationPolicyPage, CancellationPolicyPatch, CancellationPolicyPost, ChatService, CheckoutPlatform, ChoiceMessage, CodelocksLock, CodelocksLockPage, CodelocksLockPatch, CodelocksLockPost, CodelocksLocksService, CompletionChoice, ContactOnConfirmation, Country, CountryService, Course, CourseBookingCutoff, CourseCreate, CourseEmailAttendeesPatch, CourseEmailWaitlistPatch, CoursePage, CoursePatch, CoursePost, CourseSearchSortBy, CourseSession, CourseSessionPage, CourseSessionPatch, CourseSessionPost, CourseSessionReschedulePatch, CourseSessionSchedule, CourseSessionSchedulePage, CourseSessionSchedulePatch, CourseSessionSchedulePost, CourseSessionSchedulesService, CourseSessionsService, CourseStatus, CoursesService, CreateDeal, CreateEmailSettings, CreateOffer, CreateQuestion, CreateQuestionOption, CreateTemplateDetail, CreateTemplateFieldPermission, CreateVenue, CustomDateRange, CustomDateRangeOption, CustomFieldDataType, CustomFieldDefinition, CustomFieldDefinitionPage, CustomFieldDefinitionPatch, CustomFieldDefinitionPost, CustomFieldDefinitionWithValue, CustomFieldOption, CustomFieldOptionDto, CustomFieldOptionPost, CustomFieldValueEntityType, CustomFieldValueUpdate, CustomFieldsBulkUpdate, CustomFieldsService, Customer, CustomerAccountInvitePatch, CustomerAuthService, CustomerCancellationOption, CustomerEmailPatch, CustomerPage, CustomerPatch, CustomerPortalAccountPatch, CustomerPortalService, CustomerPost, CustomerStats, CustomerType, CustomerWalletDeductionPreview, CustomersService, DatabaseState, DayOfWeek, Deal, DealActivitiesService, DealActivity, DealActivityPage, DealActivityPatch, DealActivityPost, DealCreate, DealDiscountType, DealPage, DealPatch, DealPost, DealTarget, DealType, DealsService, DescriptionCompletionResponse, DiscountCodeUse, DiscountCodeUsePage, DiscountCodeUsePatch, DiscountCodeUsePost, DiscountCodeUsesService, DotdigitalCanonicalField, DotdigitalService, DotdigitalSourceType, EmailReminderSchedule, EmailReminderSchedulePage, EmailReminderSchedulePatch, EmailReminderSchedulePost, EmailReminderSchedulesService, EmailSetting, EmailSettingPage, EmailSettingPatch, EmailSettingPost, EmailSettingsService, EndUserAccessibleTenantDto, EndUserIdentity, EndUserIdentitySecureToken, EndUserIdentitySecureTokenService, EnglandGolfReportService, EventTiming, FacilitiesService, Facility, FacilityIndividual, FacilityIndividualPage, FacilityIndividualPatch, FacilityIndividualPost, FacilityIndividualsService, FacilityIndividualsType, FacilityPage, FacilityPatch, FacilityPost, FeatureAnnouncementDismissPost, FeatureAnnouncementForUserDto, FeatureAnnouncementsService, FieldPermission, FilestackImageMetaResponseModel, FilestackService, Gender, GenericActivity, GenericActivityPage, GenericActivityService, GeocodeResponseModel, GeocodeService, GooglePrediction, HelpersService, HereAddressDetails, HereAutoComplete, HereAutocompleteLookupService, HereLookupResults, HereMapDetails, HerePositionDetails, HttpStatusCode, IOpportunity, Image, ImageLibraryCategory, ImageLibraryCategoryService, ImageLibraryImage, ImageLibraryImageService, ImagePage, ImagePatch, ImagePost, ImageUploadHistory, ImageUploadHistoryPage, ImageUploadHistoryPatch, ImageUploadHistoryPost, ImageUploadHistoryService, ImagesService, IntegrationCodelocksSettings, IntegrationCodelocksSettingsCreate, IntegrationCodelocksSettingsPage, IntegrationCodelocksSettingsPatch, IntegrationCodelocksSettingsPost, IntegrationCodelocksSettingsService, IntegrationDotDigitalSettingsService, IntegrationDotdigitalFieldMap, IntegrationDotdigitalFieldMapPage, IntegrationDotdigitalFieldMapPatch, IntegrationDotdigitalFieldMapPost, IntegrationDotdigitalFieldMapService, IntegrationDotdigitalLog, IntegrationDotdigitalLogPage, IntegrationDotdigitalLogPatch, IntegrationDotdigitalLogPost, IntegrationDotdigitalLogService, IntegrationDotdigitalLogStatus, IntegrationDotdigitalSettings, IntegrationDotdigitalSettingsCreate, IntegrationDotdigitalSettingsPage, IntegrationDotdigitalSettingsPatch, IntegrationDotdigitalSettingsPost, IntegrationQueue, IntegrationQueuePage, IntegrationQueuePatch, IntegrationQueuePost, IntegrationQueueService, IntegrationType, InviteStatus, LeasingService, LocationReport, LocationReportPage, LocationReportPatch, LocationReportPost, LocationReportSummary, LocationsReportService, LoqateGeocode, LoqatePlaceResult, LoqatePlacesService, LoqatePrediction, Northeast, NotificationQueue, NotificationQueuePage, NotificationQueuePatch, NotificationQueuePost, NotificationQueueService, NotificationSetting, NotificationSettingPage, NotificationSettingPatch, NotificationSettingPost, NotificationSettingsService, NotificationType, Offer, OfferPage, OfferPatch, OfferPost, OffersService, OpenAPI, OpenAPIConfig, OpenactiveFeedIntermediate, OpenactiveFeedIntermediatePage, OpenactiveFeedIntermediatePatch, OpenactiveFeedIntermediatePost, OpenactiveFeedIntermediateService, OpenactiveFeedItem, OpenactiveFeedItemPage, OpenactiveFeedItemPatch, OpenactiveFeedItemPost, OpenactiveFeedItemService, OpportunityRegister, OpportunityRegisterPage, OpportunityRegisterPatch, OpportunityRegisterPost, OpportunityRegisterService, OpportunityRegisterStatus, OpportunityType, Order, OrderApplyDiscountCode, OrderDeal, OrderEmailCustomerPatch, OrderItem, OrderItemCodelocksAccess, OrderItemDeal, OrderItemPage, OrderItemPatch, OrderItemPost, OrderItemReport, OrderItemReportPage, OrderItemReportPatch, OrderItemReportPost, OrderItemReportService, OrderItemReportSummary, OrderItemStatus, OrderItemsService, OrderPage, OrderPatch, OrderPatchItem, OrderPost, OrderPostItem, OrderRefresh, OrderSource, OrderStage, OrderToken, OrderTokenPage, OrderTokenPatch, OrderTokenPost, OrderUpdateContact, OrdersService, OrgCourseUtilisation, OrgCourseUtilisationPage, OrgCourseUtilisationPatch, OrgCourseUtilisationPost, OrgCourseUtilisationService, OrganisationApplicationFeeHandling, OrganisationAvailableChannel, OrganisationRefundPolicy, OrganisationTaxMode, OrganisationType, Pagination, Payment, PaymentMethod, PaymentPage, PaymentPatch, PaymentPoliciesService, PaymentPolicy, PaymentPolicyPage, PaymentPolicyPatch, PaymentPolicyPost, PaymentPolicySplitType, PaymentPost, PaymentsService, PeriodsOfWeek, Permission, PermissionPage, PermissionPatch, PermissionPost, PermissionsService, PlaceAddress, PlaceDetailsResponseModel, PlaceGeometry, PlaceLocation, PlaceResult, PlaceViewport, PlacesService, PlatformPayout, PlatformPayoutPage, PlatformPayoutPatch, PlatformPayoutPost, PlatformPayoutsService, PlusCode, Prepayment, Programme, ProgrammePage, ProgrammePatch, ProgrammePost, ProgrammesService, Provider, ProviderActivityLocation, ProviderCreate, ProviderPage, ProviderPatch, ProviderPost, ProviderType, ProviderTypesService, ProvidersService, PublicBookingService, PublicCalendarService, PublicCoursesService, PublicCustomersService, PublicFacilitiesService, PublicFilestackWebhookService, PublicGenericActivityService, PublicHealthCheckService, PublicLeasingService, PublicNetworksService, PublicOpportunityRegisterService, PublicOrderItemsService, PublicOrderTokensService, PublicOrdersService, PublicProgrammesService, PublicProvidersService, PublicScheduledSessionsService, PublicSellableItemsService, PublicSessionsService, PublicSlotsService, PublicStorefrontStaffPreviewService, PublicStripeWebhookService, PublicSurveyCompletionLogsService, PublicSurveyQuestionsService, PublicSurveysService, PublicTenantFaqsService, PublicTenantsService, PublicVenueTypesService, PublicVenuesService, PublicWaitlistActivityService, PublicWaitlistOpportunityService, ReachEntity, ReachError, ReachOperation, RecentOrderActivityReport, RecentOrderActivityReportPage, RecentOrderActivityReportPatch, RecentOrderActivityReportPost, RecentOrderActivityReportService, RefundSource, RefundStatus, RegisterReport, RegisterReportPage, RegisterReportPatch, RegisterReportPost, RegisterReportService, RegisterReportSummary, RescheduleLog, RescheduleLogPage, RescheduleLogPatch, RescheduleLogPost, RescheduleLogService, ResolveSecureAccessTokenRequest, ScheduleStatus, ScheduledSession, ScheduledSessionEmailAttendeesPatch, ScheduledSessionEmailWaitlistPatch, ScheduledSessionPage, ScheduledSessionPatch, ScheduledSessionPost, ScheduledSessionReschedulePatch, ScheduledSessionSchedule, ScheduledSessionSchedulePage, ScheduledSessionSchedulePatch, ScheduledSessionSchedulePost, ScheduledSessionSearchSortBy, ScheduledSessionsSchedulesService, ScheduledSessionsService, SearchSortOrderDirection, SellableItem, SellableItemPage, SellableItemPatch, SellableItemPost, SellableItemsService, Session, SessionCreate, SessionPage, SessionPatch, SessionPost, SessionType, SessionsService, Slot, SlotAvailabilityStatus, SlotOffer, SlotOfferPage, SlotOfferPatch, SlotOfferPost, SlotOffersService, SlotPage, SlotPatch, SlotPost, SlotSchedule, SlotScheduleOffer, SlotScheduleOfferPage, SlotScheduleOfferPatch, SlotScheduleOfferPost, SlotScheduleOffersService, SlotSchedulePage, SlotSchedulePatch, SlotSchedulePost, SlotSchedulesService, SlotStatus, SlotsService, SortIndex, Southwest, StorefrontStaffPreviewService, StorefrontStaffPreviewTokenResponse, StorefrontStaffPreviewValidateRequest, StorefrontStaffPreviewValidateResponse, StripeAccount, StripeAccountLinkedEntityType, StripeAccountPage, StripeAccountPatch, StripeAccountPost, StripeAccountService, StripeSetupRequirement, StripeStatus, StructuredFormatting, Surface, SurfacesService, Survey, SurveyAnswer, SurveyAnswerPage, SurveyAnswerPatch, SurveyAnswerPost, SurveyAnswersService, SurveyCompletionLog, SurveyCompletionLogPage, SurveyCompletionLogPatch, SurveyCompletionLogPost, SurveyCompletionLogService, SurveyCreate, SurveyDuplicatePost, SurveyPage, SurveyPatch, SurveyPost, SurveyQuestion, SurveyQuestionOption, SurveyQuestionPage, SurveyQuestionPatch, SurveyQuestionPatchOption, SurveyQuestionPost, SurveyQuestionPostOption, SurveyQuestionType, SurveyQuestionsService, SurveyQuestionsTarget, SurveyReportExtended, SurveyReportExtendedPage, SurveyReportExtendedPatch, SurveyReportExtendedPost, SurveyReportExtendedService, SurveyResponseMode, SurveySubmissionModel, SurveySubmit, SurveySubmitAttendee, SurveySubmitQuestions, SurveyType, SurveysService, Tax, Template, TemplateCreate, TemplateDeal, TemplateDetail, TemplateDetailPage, TemplateDetailPatch, TemplateDetailPost, TemplateDetailsService, TemplateDuplicatePost, TemplateFieldPermission, TemplateFieldPermissionPage, TemplateFieldPermissionPatch, TemplateFieldPermissionPost, TemplateFieldPermissionsService, TemplateFromPost, TemplateOffer, TemplateOfferPage, TemplateOfferPatch, TemplateOfferPost, TemplateOffersService, TemplatePage, TemplatePatch, TemplatePost, TemplateUseResponse, TemplatesService, Tenant, TenantFaq, TenantFaqPage, TenantFaqPatch, TenantFaqPost, TenantFaqsService, TenantPage, TenantPatch, TenantPost, TenantSetting, TenantStatus, TenantStorefrontSettingsPatch, TenantTier, TenantWebsiteSetting, TenantWebsiteSettingPage, TenantWebsiteSettingPatch, TenantWebsiteSettingPost, TenantWebsiteSettingsService, TenantsService, Timezone, TimezoneService, TotalRevenueReport, TotalRevenueReportPage, TotalRevenueReportPatch, TotalRevenueReportPost, TotalRevenueReportService, UnsplashSearchResponse, UnsplashService, UpcomingLayout, UpdateCustomFieldOption, UpdateEmailSettings, UpdateOffer, User, UserPage, UserPatch, UserPermission, UserPermissionPage, UserPermissionPatch, UserPermissionPost, UserPermissionsService, UserPost, UserProgramme, UserProgrammePage, UserProgrammePatch, UserProgrammePost, UserProgrammesService, UserProvider, UserProviderPage, UserProviderPatch, UserProviderPost, UserProvidersService, UserRole, UsersService, ValidationError, ValidationResultModel, Venue, VenueBadmintonEnglandReport, VenueBadmintonEnglandReportPage, VenueBadmintonEnglandReportPatch, VenueBadmintonEnglandReportPost, VenueCreate, VenueManager, VenueManagerPage, VenueManagerPatch, VenueManagerPost, VenueManagersService, VenueOpeningHourUpdate, VenueOpeningHours, VenuePage, VenuePatch, VenuePerformance, VenuePerformancePage, VenuePerformancePatch, VenuePerformancePost, VenuePerformanceService, VenuePost, VenueType, VenueTypePage, VenueTypePatch, VenueTypePost, VenueTypeService, VenuesReport, VenuesReportPage, VenuesReportPatch, VenuesReportPost, VenuesReportService, VenuesService, WaitlistActivity, WaitlistActivityPage, WaitlistActivityPatch, WaitlistActivityPost, WaitlistActivityReport, WaitlistActivityReportPage, WaitlistActivityReportPatch, WaitlistActivityReportPost, WaitlistActivityReportService, WaitlistActivityService, WaitlistConversionStatsResponseDto, WaitlistOpportunity, WaitlistOpportunityPage, WaitlistOpportunityPatch, WaitlistOpportunityPost, WaitlistOpportunityReport, WaitlistOpportunityReportPage, WaitlistOpportunityReportPatch, WaitlistOpportunityReportPost, WaitlistOpportunityReportService, WaitlistOpportunityService, Wallet, WalletCreditPeriod, WalletCreditPeriodReassessPost, WalletCreditPeriodStatus, WalletDeductionPreview, WalletPage, WalletPatch, WalletPost, WalletRemoveCreditPost, WalletTopUpPost, WalletTrackingLevel, WalletTransaction, WalletTransactionPage, WalletTransactionPatch, WalletTransactionPost, WalletTransactionType, WalletTransactionsService, WalletsService, WebsiteHomepage };
|
package/dist/reach-sdk.js
CHANGED
|
@@ -52228,6 +52228,30 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
52228
52228
|
}
|
|
52229
52229
|
});
|
|
52230
52230
|
}
|
|
52231
|
+
/**
|
|
52232
|
+
* Reassesses the active credit period for a wallet and sets balance to the new allocation.
|
|
52233
|
+
* @returns Wallet OK
|
|
52234
|
+
* @throws ApiError
|
|
52235
|
+
*/
|
|
52236
|
+
reassessCreditPeriod({
|
|
52237
|
+
id,
|
|
52238
|
+
requestBody
|
|
52239
|
+
}) {
|
|
52240
|
+
return this.httpRequest.request({
|
|
52241
|
+
method: "POST",
|
|
52242
|
+
url: "/api/wallets/{id}/credit-periods/reassess",
|
|
52243
|
+
path: {
|
|
52244
|
+
id
|
|
52245
|
+
},
|
|
52246
|
+
body: requestBody,
|
|
52247
|
+
mediaType: "application/json",
|
|
52248
|
+
errors: {
|
|
52249
|
+
400: `Bad Request`,
|
|
52250
|
+
422: `Unprocessable Content`,
|
|
52251
|
+
500: `Internal Server Error`
|
|
52252
|
+
}
|
|
52253
|
+
});
|
|
52254
|
+
}
|
|
52231
52255
|
/**
|
|
52232
52256
|
* Gets the transaction history for a wallet.
|
|
52233
52257
|
* @returns WalletTransaction OK
|
|
@@ -53856,7 +53880,11 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
53856
53880
|
UpcomingLayout2["GRID"] = "Grid";
|
|
53857
53881
|
UpcomingLayout2["CALENDAR"] = "Calendar";
|
|
53858
53882
|
return UpcomingLayout2;
|
|
53859
|
-
})(UpcomingLayout || {});var
|
|
53883
|
+
})(UpcomingLayout || {});var WalletCreditPeriodStatus = /* @__PURE__ */ ((WalletCreditPeriodStatus2) => {
|
|
53884
|
+
WalletCreditPeriodStatus2["ACTIVE"] = "Active";
|
|
53885
|
+
WalletCreditPeriodStatus2["CLOSED"] = "Closed";
|
|
53886
|
+
return WalletCreditPeriodStatus2;
|
|
53887
|
+
})(WalletCreditPeriodStatus || {});var WalletTrackingLevel = /* @__PURE__ */ ((WalletTrackingLevel2) => {
|
|
53860
53888
|
WalletTrackingLevel2["CUSTOMER"] = "Customer";
|
|
53861
53889
|
WalletTrackingLevel2["ATTENDEE"] = "Attendee";
|
|
53862
53890
|
return WalletTrackingLevel2;
|
|
@@ -53870,4 +53898,4 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
53870
53898
|
WebsiteHomepage2["DEFAULT"] = "Default";
|
|
53871
53899
|
WebsiteHomepage2["MAP"] = "Map";
|
|
53872
53900
|
return WebsiteHomepage2;
|
|
53873
|
-
})(WebsiteHomepage || {});export{AccessCredentialsService,ActivityPerformanceService,ActivityService,ActivityType,ActivityTypeCategoryService,AdvanceBooking,AmenityService,AmenityType,ApiClient,ApiError,AppUserRole,ApplicationRole,AttendeesService,AvailabilityIndicator,BadEnglandReportService,BaseHttpRequest,BookingService,BookingStatus,CancelError,CancelablePromise,CancellationPoliciesService,ChatService,CheckoutPlatform,CodelocksLocksService,ContactOnConfirmation,CountryService,CourseBookingCutoff,CourseSearchSortBy,CourseSessionSchedulesService,CourseSessionsService,CourseStatus,CoursesService,CustomDateRange,CustomFieldDataType,CustomFieldValueEntityType,CustomFieldsService,CustomerAuthService,CustomerCancellationOption,CustomerPortalService,CustomerType,CustomersService,DayOfWeek,DealActivitiesService,DealDiscountType,DealTarget,DealType,DealsService,DiscountCodeUsesService,DotdigitalCanonicalField,DotdigitalService,DotdigitalSourceType,EmailReminderSchedulesService,EmailSettingsService,EndUserIdentitySecureTokenService,EnglandGolfReportService,EventTiming,FacilitiesService,FacilityIndividualsService,FacilityIndividualsType,FeatureAnnouncementsService,FieldPermission,FilestackService,Gender,GenericActivityService,GeocodeService,HelpersService,HereAutocompleteLookupService,HttpStatusCode,ImageLibraryCategoryService,ImageLibraryImageService,ImageUploadHistoryService,ImagesService,IntegrationCodelocksSettingsService,IntegrationDotDigitalSettingsService,IntegrationDotdigitalFieldMapService,IntegrationDotdigitalLogService,IntegrationDotdigitalLogStatus,IntegrationQueueService,IntegrationType,InviteStatus,LeasingService,LocationsReportService,LoqatePlacesService,NotificationQueueService,NotificationSettingsService,NotificationType,OffersService,OpenAPI,OpenactiveFeedIntermediateService,OpenactiveFeedItemService,OpportunityRegisterService,OpportunityRegisterStatus,OpportunityType,OrderItemReportService,OrderItemStatus,OrderItemsService,OrderSource,OrderStage,OrdersService,OrgCourseUtilisationService,OrganisationApplicationFeeHandling,OrganisationAvailableChannel,OrganisationRefundPolicy,OrganisationTaxMode,OrganisationType,PaymentMethod,PaymentPoliciesService,PaymentPolicySplitType,PaymentsService,PeriodsOfWeek,PermissionsService,PlacesService,PlatformPayoutsService,Prepayment,ProgrammesService,ProviderTypesService,ProvidersService,PublicBookingService,PublicCalendarService,PublicCoursesService,PublicCustomersService,PublicFacilitiesService,PublicFilestackWebhookService,PublicGenericActivityService,PublicHealthCheckService,PublicLeasingService,PublicNetworksService,PublicOpportunityRegisterService,PublicOrderItemsService,PublicOrderTokensService,PublicOrdersService,PublicProgrammesService,PublicProvidersService,PublicScheduledSessionsService,PublicSellableItemsService,PublicSessionsService,PublicSlotsService,PublicStorefrontStaffPreviewService,PublicStripeWebhookService,PublicSurveyCompletionLogsService,PublicSurveyQuestionsService,PublicSurveysService,PublicTenantFaqsService,PublicTenantsService,PublicVenueTypesService,PublicVenuesService,PublicWaitlistActivityService,PublicWaitlistOpportunityService,ReachEntity,ReachOperation,RecentOrderActivityReportService,RefundSource,RefundStatus,RegisterReportService,RescheduleLogService,ScheduleStatus,ScheduledSessionSearchSortBy,ScheduledSessionsSchedulesService,ScheduledSessionsService,SearchSortOrderDirection,SellableItemsService,SessionType,SessionsService,SlotAvailabilityStatus,SlotOffersService,SlotScheduleOffersService,SlotSchedulesService,SlotStatus,SlotsService,StorefrontStaffPreviewService,StripeAccountLinkedEntityType,StripeAccountService,StripeStatus,SurfacesService,SurveyAnswersService,SurveyCompletionLogService,SurveyQuestionType,SurveyQuestionsService,SurveyQuestionsTarget,SurveyReportExtendedService,SurveyResponseMode,SurveyType,SurveysService,TemplateDetailsService,TemplateFieldPermissionsService,TemplateOffersService,TemplatesService,TenantFaqsService,TenantStatus,TenantTier,TenantWebsiteSettingsService,TenantsService,TimezoneService,TotalRevenueReportService,UnsplashService,UpcomingLayout,UserPermissionsService,UserProgrammesService,UserProvidersService,UsersService,VenueManagersService,VenuePerformanceService,VenueTypeService,VenuesReportService,VenuesService,WaitlistActivityReportService,WaitlistActivityService,WaitlistOpportunityReportService,WaitlistOpportunityService,WalletTrackingLevel,WalletTransactionType,WalletTransactionsService,WalletsService,WebsiteHomepage};
|
|
53901
|
+
})(WebsiteHomepage || {});export{AccessCredentialsService,ActivityPerformanceService,ActivityService,ActivityType,ActivityTypeCategoryService,AdvanceBooking,AmenityService,AmenityType,ApiClient,ApiError,AppUserRole,ApplicationRole,AttendeesService,AvailabilityIndicator,BadEnglandReportService,BaseHttpRequest,BookingService,BookingStatus,CancelError,CancelablePromise,CancellationPoliciesService,ChatService,CheckoutPlatform,CodelocksLocksService,ContactOnConfirmation,CountryService,CourseBookingCutoff,CourseSearchSortBy,CourseSessionSchedulesService,CourseSessionsService,CourseStatus,CoursesService,CustomDateRange,CustomFieldDataType,CustomFieldValueEntityType,CustomFieldsService,CustomerAuthService,CustomerCancellationOption,CustomerPortalService,CustomerType,CustomersService,DayOfWeek,DealActivitiesService,DealDiscountType,DealTarget,DealType,DealsService,DiscountCodeUsesService,DotdigitalCanonicalField,DotdigitalService,DotdigitalSourceType,EmailReminderSchedulesService,EmailSettingsService,EndUserIdentitySecureTokenService,EnglandGolfReportService,EventTiming,FacilitiesService,FacilityIndividualsService,FacilityIndividualsType,FeatureAnnouncementsService,FieldPermission,FilestackService,Gender,GenericActivityService,GeocodeService,HelpersService,HereAutocompleteLookupService,HttpStatusCode,ImageLibraryCategoryService,ImageLibraryImageService,ImageUploadHistoryService,ImagesService,IntegrationCodelocksSettingsService,IntegrationDotDigitalSettingsService,IntegrationDotdigitalFieldMapService,IntegrationDotdigitalLogService,IntegrationDotdigitalLogStatus,IntegrationQueueService,IntegrationType,InviteStatus,LeasingService,LocationsReportService,LoqatePlacesService,NotificationQueueService,NotificationSettingsService,NotificationType,OffersService,OpenAPI,OpenactiveFeedIntermediateService,OpenactiveFeedItemService,OpportunityRegisterService,OpportunityRegisterStatus,OpportunityType,OrderItemReportService,OrderItemStatus,OrderItemsService,OrderSource,OrderStage,OrdersService,OrgCourseUtilisationService,OrganisationApplicationFeeHandling,OrganisationAvailableChannel,OrganisationRefundPolicy,OrganisationTaxMode,OrganisationType,PaymentMethod,PaymentPoliciesService,PaymentPolicySplitType,PaymentsService,PeriodsOfWeek,PermissionsService,PlacesService,PlatformPayoutsService,Prepayment,ProgrammesService,ProviderTypesService,ProvidersService,PublicBookingService,PublicCalendarService,PublicCoursesService,PublicCustomersService,PublicFacilitiesService,PublicFilestackWebhookService,PublicGenericActivityService,PublicHealthCheckService,PublicLeasingService,PublicNetworksService,PublicOpportunityRegisterService,PublicOrderItemsService,PublicOrderTokensService,PublicOrdersService,PublicProgrammesService,PublicProvidersService,PublicScheduledSessionsService,PublicSellableItemsService,PublicSessionsService,PublicSlotsService,PublicStorefrontStaffPreviewService,PublicStripeWebhookService,PublicSurveyCompletionLogsService,PublicSurveyQuestionsService,PublicSurveysService,PublicTenantFaqsService,PublicTenantsService,PublicVenueTypesService,PublicVenuesService,PublicWaitlistActivityService,PublicWaitlistOpportunityService,ReachEntity,ReachOperation,RecentOrderActivityReportService,RefundSource,RefundStatus,RegisterReportService,RescheduleLogService,ScheduleStatus,ScheduledSessionSearchSortBy,ScheduledSessionsSchedulesService,ScheduledSessionsService,SearchSortOrderDirection,SellableItemsService,SessionType,SessionsService,SlotAvailabilityStatus,SlotOffersService,SlotScheduleOffersService,SlotSchedulesService,SlotStatus,SlotsService,StorefrontStaffPreviewService,StripeAccountLinkedEntityType,StripeAccountService,StripeStatus,SurfacesService,SurveyAnswersService,SurveyCompletionLogService,SurveyQuestionType,SurveyQuestionsService,SurveyQuestionsTarget,SurveyReportExtendedService,SurveyResponseMode,SurveyType,SurveysService,TemplateDetailsService,TemplateFieldPermissionsService,TemplateOffersService,TemplatesService,TenantFaqsService,TenantStatus,TenantTier,TenantWebsiteSettingsService,TenantsService,TimezoneService,TotalRevenueReportService,UnsplashService,UpcomingLayout,UserPermissionsService,UserProgrammesService,UserProvidersService,UsersService,VenueManagersService,VenuePerformanceService,VenueTypeService,VenuesReportService,VenuesService,WaitlistActivityReportService,WaitlistActivityService,WaitlistOpportunityReportService,WaitlistOpportunityService,WalletCreditPeriodStatus,WalletTrackingLevel,WalletTransactionType,WalletTransactionsService,WalletsService,WebsiteHomepage};
|
package/package.json
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "reach-api-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.228",
|
|
4
4
|
"description": "sdk for reach api",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
|
+
"sync:swagger": "node scripts/sync-swagger.mjs",
|
|
9
|
+
"sync": "npm run sync:swagger && npm run build",
|
|
10
|
+
"dev:link": "npm run sync && npm link",
|
|
8
11
|
"build": "npm run generate-client && npm run format && rollup -c",
|
|
9
12
|
"build-only": "rollup -c",
|
|
13
|
+
"prepare": "npm run build-only",
|
|
10
14
|
"lint": "eslint --ext .ts src",
|
|
11
15
|
"generate-client": "openapi --input ./src/definition/swagger.yaml --output ./src/ --client axios --name ApiClient --useOptions",
|
|
12
16
|
"format": "prettier --write src/"
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import fs from 'node:fs'
|
|
2
|
+
import https from 'node:https'
|
|
3
|
+
import path from 'node:path'
|
|
4
|
+
import { fileURLToPath } from 'node:url'
|
|
5
|
+
|
|
6
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
|
7
|
+
const swaggerUrl =
|
|
8
|
+
process.env.REACH_API_SWAGGER_URL ?? 'https://localhost:44310/swagger/v1/swagger.yaml'
|
|
9
|
+
const outPath = path.join(__dirname, '../src/definition/swagger.yaml')
|
|
10
|
+
|
|
11
|
+
function fetchSwagger(url) {
|
|
12
|
+
return new Promise((resolve, reject) => {
|
|
13
|
+
https
|
|
14
|
+
.get(url, { rejectUnauthorized: false }, (res) => {
|
|
15
|
+
if (res.statusCode !== 200) {
|
|
16
|
+
reject(new Error(`Failed to fetch swagger (${res.statusCode}) from ${url}`))
|
|
17
|
+
res.resume()
|
|
18
|
+
return
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const chunks = []
|
|
22
|
+
res.on('data', (chunk) => chunks.push(chunk))
|
|
23
|
+
res.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')))
|
|
24
|
+
res.on('error', reject)
|
|
25
|
+
})
|
|
26
|
+
.on('error', reject)
|
|
27
|
+
})
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
const yaml = await fetchSwagger(swaggerUrl)
|
|
31
|
+
fs.mkdirSync(path.dirname(outPath), { recursive: true })
|
|
32
|
+
fs.writeFileSync(outPath, yaml, 'utf8')
|
|
33
|
+
console.log(`Synced swagger to ${outPath}`)
|
|
@@ -154639,6 +154639,81 @@ paths:
|
|
|
154639
154639
|
text/json:
|
|
154640
154640
|
schema:
|
|
154641
154641
|
$ref: '#/components/schemas/ValidationResultModel'
|
|
154642
|
+
'/api/wallets/{id}/credit-periods/reassess':
|
|
154643
|
+
post:
|
|
154644
|
+
tags:
|
|
154645
|
+
- Wallets
|
|
154646
|
+
summary: Reassesses the active credit period for a wallet and sets balance to the new allocation.
|
|
154647
|
+
operationId: ReassessCreditPeriod
|
|
154648
|
+
parameters:
|
|
154649
|
+
- name: id
|
|
154650
|
+
in: path
|
|
154651
|
+
description: The wallet id.
|
|
154652
|
+
required: true
|
|
154653
|
+
schema:
|
|
154654
|
+
type: string
|
|
154655
|
+
format: uuid
|
|
154656
|
+
requestBody:
|
|
154657
|
+
description: The reassessment request.
|
|
154658
|
+
content:
|
|
154659
|
+
application/json:
|
|
154660
|
+
schema:
|
|
154661
|
+
$ref: '#/components/schemas/WalletCreditPeriodReassessPost'
|
|
154662
|
+
text/json:
|
|
154663
|
+
schema:
|
|
154664
|
+
$ref: '#/components/schemas/WalletCreditPeriodReassessPost'
|
|
154665
|
+
application/*+json:
|
|
154666
|
+
schema:
|
|
154667
|
+
$ref: '#/components/schemas/WalletCreditPeriodReassessPost'
|
|
154668
|
+
responses:
|
|
154669
|
+
'200':
|
|
154670
|
+
description: OK
|
|
154671
|
+
content:
|
|
154672
|
+
text/plain:
|
|
154673
|
+
schema:
|
|
154674
|
+
$ref: '#/components/schemas/Wallet'
|
|
154675
|
+
application/json:
|
|
154676
|
+
schema:
|
|
154677
|
+
$ref: '#/components/schemas/Wallet'
|
|
154678
|
+
text/json:
|
|
154679
|
+
schema:
|
|
154680
|
+
$ref: '#/components/schemas/Wallet'
|
|
154681
|
+
'400':
|
|
154682
|
+
description: Bad Request
|
|
154683
|
+
content:
|
|
154684
|
+
text/plain:
|
|
154685
|
+
schema:
|
|
154686
|
+
$ref: '#/components/schemas/ReachError'
|
|
154687
|
+
application/json:
|
|
154688
|
+
schema:
|
|
154689
|
+
$ref: '#/components/schemas/ReachError'
|
|
154690
|
+
text/json:
|
|
154691
|
+
schema:
|
|
154692
|
+
$ref: '#/components/schemas/ReachError'
|
|
154693
|
+
'500':
|
|
154694
|
+
description: Internal Server Error
|
|
154695
|
+
content:
|
|
154696
|
+
text/plain:
|
|
154697
|
+
schema:
|
|
154698
|
+
$ref: '#/components/schemas/ReachError'
|
|
154699
|
+
application/json:
|
|
154700
|
+
schema:
|
|
154701
|
+
$ref: '#/components/schemas/ReachError'
|
|
154702
|
+
text/json:
|
|
154703
|
+
schema:
|
|
154704
|
+
$ref: '#/components/schemas/ReachError'
|
|
154705
|
+
'422':
|
|
154706
|
+
description: Unprocessable Content
|
|
154707
|
+
content:
|
|
154708
|
+
text/plain:
|
|
154709
|
+
schema:
|
|
154710
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
154711
|
+
application/json:
|
|
154712
|
+
schema:
|
|
154713
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
154714
|
+
text/json:
|
|
154715
|
+
schema:
|
|
154716
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
154642
154717
|
'/api/wallets/{id}/transactions':
|
|
154643
154718
|
get:
|
|
154644
154719
|
tags:
|
|
@@ -157939,9 +158014,28 @@ components:
|
|
|
157939
158014
|
format: uuid
|
|
157940
158015
|
initialWalletBalance:
|
|
157941
158016
|
type: number
|
|
157942
|
-
description: "Gets or sets the initial wallet balance for the attendee.\r\nThis is only applicable when wallet tracking level is set to Attendee.\r\nWhen wallet tracking level is Attendee, a wallet is always created for the attendee.\r\nIf InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.\r\nIf not provided or set to 0, the wallet will be created with a balance of 0."
|
|
158017
|
+
description: "Gets or sets the initial wallet balance for the attendee.\r\nThis is only applicable when wallet tracking level is set to Attendee.\r\nWhen wallet tracking level is Attendee, a wallet is always created for the attendee.\r\nIf InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.\r\nIf not provided or set to 0, the wallet will be created with a balance of 0.\r\nIgnored when enable_wallet_credit_periods is enabled; use credit period fields instead."
|
|
158018
|
+
format: double
|
|
158019
|
+
nullable: true
|
|
158020
|
+
creditPeriodStartDate:
|
|
158021
|
+
type: string
|
|
158022
|
+
description: Gets or sets the credit period start date. Required when wallet credit periods are enabled.
|
|
158023
|
+
format: date-time
|
|
158024
|
+
nullable: true
|
|
158025
|
+
creditPeriodEndDate:
|
|
158026
|
+
type: string
|
|
158027
|
+
description: Gets or sets the credit period end date. Required when wallet credit periods are enabled.
|
|
158028
|
+
format: date-time
|
|
158029
|
+
nullable: true
|
|
158030
|
+
creditAllocation:
|
|
158031
|
+
type: number
|
|
158032
|
+
description: Gets or sets the credit allocation for the initial period. Required when wallet credit periods are enabled.
|
|
157943
158033
|
format: double
|
|
157944
158034
|
nullable: true
|
|
158035
|
+
creditPeriodAutoRenew:
|
|
158036
|
+
type: boolean
|
|
158037
|
+
description: Gets or sets a value indicating whether the credit period auto-renews. Defaults to true when not specified.
|
|
158038
|
+
nullable: true
|
|
157945
158039
|
dateOfBirth:
|
|
157946
158040
|
type: string
|
|
157947
158041
|
description: "Gets or sets the attendee date of birth.\r\nThis is used to resolve or create the linked end_user_identity record for person-level identity tracking."
|
|
@@ -161192,6 +161286,7 @@ components:
|
|
|
161192
161286
|
- paidOpportunitiesExist
|
|
161193
161287
|
- providersExist
|
|
161194
161288
|
- scheduledSessionsExist
|
|
161289
|
+
- sellableItemsExist
|
|
161195
161290
|
- sessionsExist
|
|
161196
161291
|
- slotsExist
|
|
161197
161292
|
- storefrontTouched
|
|
@@ -161268,6 +161363,10 @@ components:
|
|
|
161268
161363
|
type: boolean
|
|
161269
161364
|
description: Gets or sets a value indicating whether facilities database records exist.
|
|
161270
161365
|
default: false
|
|
161366
|
+
sellableItemsExist:
|
|
161367
|
+
type: boolean
|
|
161368
|
+
description: Gets or sets a value indicating whether sellable item (product) database records exist.
|
|
161369
|
+
default: false
|
|
161271
161370
|
scheduledSessionsExist:
|
|
161272
161371
|
type: boolean
|
|
161273
161372
|
description: Gets or sets a value indicating whether scheduled session database records exist.
|
|
@@ -173872,6 +173971,10 @@ components:
|
|
|
173872
173971
|
type: boolean
|
|
173873
173972
|
description: "Gets or sets a value indicating whether customers are only allowed to use wallet transactions (no card payments).\r\nWhen enabled, prices will be displayed as 'credits' rather than currency."
|
|
173874
173973
|
default: false
|
|
173974
|
+
enableWalletCreditPeriods:
|
|
173975
|
+
type: boolean
|
|
173976
|
+
description: "Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.\r\nWhen enabled, attendee wallets require an active credit period for bookings and allocation management."
|
|
173977
|
+
default: false
|
|
173875
173978
|
customerLoginRequiresPreprovision:
|
|
173876
173979
|
type: boolean
|
|
173877
173980
|
description: "Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.\r\nWhen true, the authenticated email must match a live customer row (email or display_email) for this tenant."
|
|
@@ -176723,10 +176826,23 @@ components:
|
|
|
176723
176826
|
type: string
|
|
176724
176827
|
description: Gets or sets the wallet currency.
|
|
176725
176828
|
nullable: true
|
|
176829
|
+
currentCreditPeriodId:
|
|
176830
|
+
type: string
|
|
176831
|
+
description: Gets or sets the current active credit period id when wallet credit periods are enabled.
|
|
176832
|
+
format: uuid
|
|
176833
|
+
nullable: true
|
|
176834
|
+
cycleEndDate:
|
|
176835
|
+
type: string
|
|
176836
|
+
description: Gets the period end date for the current credit period. Used by partner platform wallet UI.
|
|
176837
|
+
format: date-time
|
|
176838
|
+
nullable: true
|
|
176839
|
+
readOnly: true
|
|
176726
176840
|
customer:
|
|
176727
176841
|
$ref: '#/components/schemas/Customer'
|
|
176728
176842
|
attendee:
|
|
176729
176843
|
$ref: '#/components/schemas/Attendee'
|
|
176844
|
+
currentCreditPeriod:
|
|
176845
|
+
$ref: '#/components/schemas/WalletCreditPeriod'
|
|
176730
176846
|
transactions:
|
|
176731
176847
|
type: array
|
|
176732
176848
|
items:
|
|
@@ -176735,6 +176851,97 @@ components:
|
|
|
176735
176851
|
nullable: true
|
|
176736
176852
|
additionalProperties: false
|
|
176737
176853
|
description: Represents a wallet within the Reach application.
|
|
176854
|
+
WalletCreditPeriod:
|
|
176855
|
+
required:
|
|
176856
|
+
- autoRenew
|
|
176857
|
+
- creditAllocation
|
|
176858
|
+
- dateCreated
|
|
176859
|
+
- dateModified
|
|
176860
|
+
- isLive
|
|
176861
|
+
- periodEndDate
|
|
176862
|
+
- periodStartDate
|
|
176863
|
+
- status
|
|
176864
|
+
- tenantId
|
|
176865
|
+
- walletId
|
|
176866
|
+
type: object
|
|
176867
|
+
properties:
|
|
176868
|
+
id:
|
|
176869
|
+
type: string
|
|
176870
|
+
description: Gets or sets the entities Id.
|
|
176871
|
+
format: uuid
|
|
176872
|
+
tenantId:
|
|
176873
|
+
type: string
|
|
176874
|
+
description: Gets or sets the tenant Id.
|
|
176875
|
+
format: uuid
|
|
176876
|
+
dateCreated:
|
|
176877
|
+
type: string
|
|
176878
|
+
description: Gets or sets the created date of this entity.
|
|
176879
|
+
format: date-time
|
|
176880
|
+
dateModified:
|
|
176881
|
+
type: string
|
|
176882
|
+
description: Gets or sets the last modified date of this entity.
|
|
176883
|
+
format: date-time
|
|
176884
|
+
modifiedById:
|
|
176885
|
+
type: string
|
|
176886
|
+
description: Gets or sets the modified by Id.
|
|
176887
|
+
format: uuid
|
|
176888
|
+
nullable: true
|
|
176889
|
+
isLive:
|
|
176890
|
+
type: boolean
|
|
176891
|
+
description: Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
176892
|
+
default: false
|
|
176893
|
+
walletId:
|
|
176894
|
+
type: string
|
|
176895
|
+
description: Gets or sets the wallet id.
|
|
176896
|
+
format: uuid
|
|
176897
|
+
periodStartDate:
|
|
176898
|
+
type: string
|
|
176899
|
+
description: Gets or sets the first day credits are usable (inclusive).
|
|
176900
|
+
format: date-time
|
|
176901
|
+
periodEndDate:
|
|
176902
|
+
type: string
|
|
176903
|
+
description: Gets or sets the last day credits are usable (inclusive).
|
|
176904
|
+
format: date-time
|
|
176905
|
+
creditAllocation:
|
|
176906
|
+
type: number
|
|
176907
|
+
description: Gets or sets the credit award amount for this period.
|
|
176908
|
+
format: double
|
|
176909
|
+
autoRenew:
|
|
176910
|
+
type: boolean
|
|
176911
|
+
description: Gets or sets a value indicating whether this period should auto-renew when it ends.
|
|
176912
|
+
default: false
|
|
176913
|
+
status:
|
|
176914
|
+
$ref: '#/components/schemas/WalletCreditPeriodStatus'
|
|
176915
|
+
wallet:
|
|
176916
|
+
$ref: '#/components/schemas/Wallet'
|
|
176917
|
+
additionalProperties: false
|
|
176918
|
+
description: Represents a credit entitlement window for a wallet.
|
|
176919
|
+
WalletCreditPeriodReassessPost:
|
|
176920
|
+
required:
|
|
176921
|
+
- creditAllocation
|
|
176922
|
+
type: object
|
|
176923
|
+
properties:
|
|
176924
|
+
creditAllocation:
|
|
176925
|
+
type: number
|
|
176926
|
+
description: Gets or sets the new credit allocation. Wallet balance is set to this amount immediately.
|
|
176927
|
+
format: double
|
|
176928
|
+
periodEndDate:
|
|
176929
|
+
type: string
|
|
176930
|
+
description: Gets or sets an optional updated period end date.
|
|
176931
|
+
format: date-time
|
|
176932
|
+
nullable: true
|
|
176933
|
+
autoRenew:
|
|
176934
|
+
type: boolean
|
|
176935
|
+
description: Gets or sets an optional auto-renew flag.
|
|
176936
|
+
nullable: true
|
|
176937
|
+
additionalProperties: false
|
|
176938
|
+
description: Request body for mid-cycle credit reassessment.
|
|
176939
|
+
WalletCreditPeriodStatus:
|
|
176940
|
+
enum:
|
|
176941
|
+
- Active
|
|
176942
|
+
- Closed
|
|
176943
|
+
type: string
|
|
176944
|
+
description: Controls the wallet credit period status.
|
|
176738
176945
|
WalletDeductionPreview:
|
|
176739
176946
|
type: object
|
|
176740
176947
|
properties:
|
package/src/index.ts
CHANGED
|
@@ -530,6 +530,9 @@ export type { WaitlistOpportunityReportPage } from './models/WaitlistOpportunity
|
|
|
530
530
|
export type { WaitlistOpportunityReportPatch } from './models/WaitlistOpportunityReportPatch';
|
|
531
531
|
export type { WaitlistOpportunityReportPost } from './models/WaitlistOpportunityReportPost';
|
|
532
532
|
export type { Wallet } from './models/Wallet';
|
|
533
|
+
export type { WalletCreditPeriod } from './models/WalletCreditPeriod';
|
|
534
|
+
export type { WalletCreditPeriodReassessPost } from './models/WalletCreditPeriodReassessPost';
|
|
535
|
+
export { WalletCreditPeriodStatus } from './models/WalletCreditPeriodStatus';
|
|
533
536
|
export type { WalletDeductionPreview } from './models/WalletDeductionPreview';
|
|
534
537
|
export type { WalletPage } from './models/WalletPage';
|
|
535
538
|
export type { WalletPatch } from './models/WalletPatch';
|
|
@@ -29,8 +29,25 @@ export type AttendeePost = {
|
|
|
29
29
|
* When wallet tracking level is Attendee, a wallet is always created for the attendee.
|
|
30
30
|
* If InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.
|
|
31
31
|
* If not provided or set to 0, the wallet will be created with a balance of 0.
|
|
32
|
+
* Ignored when enable_wallet_credit_periods is enabled; use credit period fields instead.
|
|
32
33
|
*/
|
|
33
34
|
initialWalletBalance?: number | null;
|
|
35
|
+
/**
|
|
36
|
+
* Gets or sets the credit period start date. Required when wallet credit periods are enabled.
|
|
37
|
+
*/
|
|
38
|
+
creditPeriodStartDate?: string | null;
|
|
39
|
+
/**
|
|
40
|
+
* Gets or sets the credit period end date. Required when wallet credit periods are enabled.
|
|
41
|
+
*/
|
|
42
|
+
creditPeriodEndDate?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Gets or sets the credit allocation for the initial period. Required when wallet credit periods are enabled.
|
|
45
|
+
*/
|
|
46
|
+
creditAllocation?: number | null;
|
|
47
|
+
/**
|
|
48
|
+
* Gets or sets a value indicating whether the credit period auto-renews. Defaults to true when not specified.
|
|
49
|
+
*/
|
|
50
|
+
creditPeriodAutoRenew?: boolean | null;
|
|
34
51
|
/**
|
|
35
52
|
* Gets or sets the attendee date of birth.
|
|
36
53
|
* This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
|
|
@@ -73,6 +73,10 @@ export type DatabaseState = {
|
|
|
73
73
|
* Gets or sets a value indicating whether facilities database records exist.
|
|
74
74
|
*/
|
|
75
75
|
facilitiesExist: boolean;
|
|
76
|
+
/**
|
|
77
|
+
* Gets or sets a value indicating whether sellable item (product) database records exist.
|
|
78
|
+
*/
|
|
79
|
+
sellableItemsExist: boolean;
|
|
76
80
|
/**
|
|
77
81
|
* Gets or sets a value indicating whether scheduled session database records exist.
|
|
78
82
|
*/
|
|
@@ -63,6 +63,11 @@ export type TenantSetting = {
|
|
|
63
63
|
* When enabled, prices will be displayed as 'credits' rather than currency.
|
|
64
64
|
*/
|
|
65
65
|
walletOnlyPayments?: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.
|
|
68
|
+
* When enabled, attendee wallets require an active credit period for bookings and allocation management.
|
|
69
|
+
*/
|
|
70
|
+
enableWalletCreditPeriods?: boolean;
|
|
66
71
|
/**
|
|
67
72
|
* Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.
|
|
68
73
|
* When true, the authenticated email must match a live customer row (email or display_email) for this tenant.
|
package/src/models/Wallet.ts
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
import type { Attendee } from './Attendee';
|
|
7
7
|
import type { Customer } from './Customer';
|
|
8
|
+
import type { WalletCreditPeriod } from './WalletCreditPeriod';
|
|
8
9
|
import type { WalletTransaction } from './WalletTransaction';
|
|
9
10
|
|
|
10
11
|
/**
|
|
@@ -51,8 +52,17 @@ export type Wallet = {
|
|
|
51
52
|
* Gets or sets the wallet currency.
|
|
52
53
|
*/
|
|
53
54
|
currency?: string | null;
|
|
55
|
+
/**
|
|
56
|
+
* Gets or sets the current active credit period id when wallet credit periods are enabled.
|
|
57
|
+
*/
|
|
58
|
+
currentCreditPeriodId?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* Gets the period end date for the current credit period. Used by partner platform wallet UI.
|
|
61
|
+
*/
|
|
62
|
+
readonly cycleEndDate?: string | null;
|
|
54
63
|
customer?: Customer;
|
|
55
64
|
attendee?: Attendee;
|
|
65
|
+
currentCreditPeriod?: WalletCreditPeriod;
|
|
56
66
|
/**
|
|
57
67
|
* Gets or sets the wallet transactions.
|
|
58
68
|
*/
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
import type { Wallet } from './Wallet';
|
|
7
|
+
import type { WalletCreditPeriodStatus } from './WalletCreditPeriodStatus';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Represents a credit entitlement window for a wallet.
|
|
11
|
+
*/
|
|
12
|
+
export type WalletCreditPeriod = {
|
|
13
|
+
/**
|
|
14
|
+
* Gets or sets the entities Id.
|
|
15
|
+
*/
|
|
16
|
+
id?: string;
|
|
17
|
+
/**
|
|
18
|
+
* Gets or sets the tenant Id.
|
|
19
|
+
*/
|
|
20
|
+
tenantId: string;
|
|
21
|
+
/**
|
|
22
|
+
* Gets or sets the created date of this entity.
|
|
23
|
+
*/
|
|
24
|
+
dateCreated: string;
|
|
25
|
+
/**
|
|
26
|
+
* Gets or sets the last modified date of this entity.
|
|
27
|
+
*/
|
|
28
|
+
dateModified: string;
|
|
29
|
+
/**
|
|
30
|
+
* Gets or sets the modified by Id.
|
|
31
|
+
*/
|
|
32
|
+
modifiedById?: string | null;
|
|
33
|
+
/**
|
|
34
|
+
* Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
35
|
+
*/
|
|
36
|
+
isLive: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Gets or sets the wallet id.
|
|
39
|
+
*/
|
|
40
|
+
walletId: string;
|
|
41
|
+
/**
|
|
42
|
+
* Gets or sets the first day credits are usable (inclusive).
|
|
43
|
+
*/
|
|
44
|
+
periodStartDate: string;
|
|
45
|
+
/**
|
|
46
|
+
* Gets or sets the last day credits are usable (inclusive).
|
|
47
|
+
*/
|
|
48
|
+
periodEndDate: string;
|
|
49
|
+
/**
|
|
50
|
+
* Gets or sets the credit award amount for this period.
|
|
51
|
+
*/
|
|
52
|
+
creditAllocation: number;
|
|
53
|
+
/**
|
|
54
|
+
* Gets or sets a value indicating whether this period should auto-renew when it ends.
|
|
55
|
+
*/
|
|
56
|
+
autoRenew: boolean;
|
|
57
|
+
status: WalletCreditPeriodStatus;
|
|
58
|
+
wallet?: Wallet;
|
|
59
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Request body for mid-cycle credit reassessment.
|
|
8
|
+
*/
|
|
9
|
+
export type WalletCreditPeriodReassessPost = {
|
|
10
|
+
/**
|
|
11
|
+
* Gets or sets the new credit allocation. Wallet balance is set to this amount immediately.
|
|
12
|
+
*/
|
|
13
|
+
creditAllocation: number;
|
|
14
|
+
/**
|
|
15
|
+
* Gets or sets an optional updated period end date.
|
|
16
|
+
*/
|
|
17
|
+
periodEndDate?: string | null;
|
|
18
|
+
/**
|
|
19
|
+
* Gets or sets an optional auto-renew flag.
|
|
20
|
+
*/
|
|
21
|
+
autoRenew?: boolean | null;
|
|
22
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Controls the wallet credit period status.
|
|
8
|
+
*/
|
|
9
|
+
export enum WalletCreditPeriodStatus {
|
|
10
|
+
ACTIVE = 'Active',
|
|
11
|
+
CLOSED = 'Closed',
|
|
12
|
+
}
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
|
|
6
6
|
import type { Wallet } from '../models/Wallet';
|
|
7
|
+
import type { WalletCreditPeriodReassessPost } from '../models/WalletCreditPeriodReassessPost';
|
|
7
8
|
import type { WalletPage } from '../models/WalletPage';
|
|
8
9
|
import type { WalletPatch } from '../models/WalletPatch';
|
|
9
10
|
import type { WalletPost } from '../models/WalletPost';
|
|
@@ -71,6 +72,40 @@ export class WalletsService {
|
|
|
71
72
|
});
|
|
72
73
|
}
|
|
73
74
|
|
|
75
|
+
/**
|
|
76
|
+
* Reassesses the active credit period for a wallet and sets balance to the new allocation.
|
|
77
|
+
* @returns Wallet OK
|
|
78
|
+
* @throws ApiError
|
|
79
|
+
*/
|
|
80
|
+
public reassessCreditPeriod({
|
|
81
|
+
id,
|
|
82
|
+
requestBody,
|
|
83
|
+
}: {
|
|
84
|
+
/**
|
|
85
|
+
* The wallet id.
|
|
86
|
+
*/
|
|
87
|
+
id: string;
|
|
88
|
+
/**
|
|
89
|
+
* The reassessment request.
|
|
90
|
+
*/
|
|
91
|
+
requestBody?: WalletCreditPeriodReassessPost;
|
|
92
|
+
}): CancelablePromise<Wallet> {
|
|
93
|
+
return this.httpRequest.request({
|
|
94
|
+
method: 'POST',
|
|
95
|
+
url: '/api/wallets/{id}/credit-periods/reassess',
|
|
96
|
+
path: {
|
|
97
|
+
id: id,
|
|
98
|
+
},
|
|
99
|
+
body: requestBody,
|
|
100
|
+
mediaType: 'application/json',
|
|
101
|
+
errors: {
|
|
102
|
+
400: `Bad Request`,
|
|
103
|
+
422: `Unprocessable Content`,
|
|
104
|
+
500: `Internal Server Error`,
|
|
105
|
+
},
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
74
109
|
/**
|
|
75
110
|
* Gets the transaction history for a wallet.
|
|
76
111
|
* @returns WalletTransaction OK
|