@peektravel/app-utilities 0.8.2 → 0.9.0
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/dist/index.cjs +56 -47
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +46 -46
- package/dist/index.d.ts +46 -46
- package/dist/index.js +56 -47
- package/dist/index.js.map +1 -1
- package/llms.txt +4 -3
- package/package.json +1 -2
- package/docs/ui.md +0 -1175
package/dist/index.d.cts
CHANGED
|
@@ -2178,89 +2178,89 @@ declare class PeekAccessService {
|
|
|
2178
2178
|
* authenticated transport. The instance is created lazily and reused.
|
|
2179
2179
|
*/
|
|
2180
2180
|
getReviewService(): ReviewService;
|
|
2181
|
-
/** All products (activities + add-ons).
|
|
2181
|
+
/** All products (activities + add-ons). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllProducts}. */
|
|
2182
2182
|
getAllProducts(): Promise<Product[]>;
|
|
2183
|
-
/** All activity products (excludes add-ons).
|
|
2183
|
+
/** All activity products (excludes add-ons). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllActivities}. */
|
|
2184
2184
|
getAllActivities(): Promise<Product[]>;
|
|
2185
|
-
/** All rental products.
|
|
2185
|
+
/** All rental products. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllRentals}. */
|
|
2186
2186
|
getAllRentals(): Promise<Product[]>;
|
|
2187
|
-
/** All add-on products.
|
|
2187
|
+
/** All add-on products. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllAddons}. */
|
|
2188
2188
|
getAllAddons(): Promise<Product[]>;
|
|
2189
|
-
/** An activity's custom questions.
|
|
2189
|
+
/** An activity's custom questions. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getCustomQuestions}. */
|
|
2190
2190
|
getCustomQuestions(productId: string): Promise<CustomQuestion[]>;
|
|
2191
|
-
/** All active account users.
|
|
2191
|
+
/** All active account users. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AccountUserService.getAll}. */
|
|
2192
2192
|
getAllAccountUsers(): Promise<AccountUser[]>;
|
|
2193
|
-
/** Account user by id, or null.
|
|
2193
|
+
/** Account user by id, or null. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AccountUserService.getById}. */
|
|
2194
2194
|
getAccountUserById(userId: string): Promise<AccountUser | null>;
|
|
2195
|
-
/** All resource pools.
|
|
2195
|
+
/** All resource pools. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ResourcePoolService.getAll}. */
|
|
2196
2196
|
getAllResourcePools(mode?: ResourcePoolMode): Promise<ResourcePool[]>;
|
|
2197
|
-
/** Timeslots for an activity on a given date.
|
|
2197
|
+
/** Timeslots for an activity on a given date. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.getForDay}. */
|
|
2198
2198
|
getTimeslotsForDay(productId: string, date: string, filter?: TimeslotFilter): Promise<Timeslot[]>;
|
|
2199
|
-
/** Single timeslot by id.
|
|
2199
|
+
/** Single timeslot by id. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.getById}. */
|
|
2200
2200
|
getTimeslotById(timeslotId: string): Promise<Timeslot | null>;
|
|
2201
|
-
/** Set timeslot status.
|
|
2201
|
+
/** Set timeslot status. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.setAvailability}. */
|
|
2202
2202
|
setTimeslotAvailability(timeslotId: string, status: string): Promise<UpdateTimeslotResult>;
|
|
2203
|
-
/** Set timeslot manifest notes.
|
|
2203
|
+
/** Set timeslot manifest notes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.setNotes}. */
|
|
2204
2204
|
setTimeslotNotes(timeslotId: string, manifestNotes: string): Promise<UpdateTimeslotResult>;
|
|
2205
|
-
/** Assign or unassign guides on timeslots.
|
|
2205
|
+
/** Assign or unassign guides on timeslots. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.assignGuide}. */
|
|
2206
2206
|
assignTimeslotGuide(assignment: GuideAssignment): Promise<AssignGuideResult>;
|
|
2207
|
-
/** All reseller channels.
|
|
2207
|
+
/** All reseller channels. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ResellerService.getAllChannels}. */
|
|
2208
2208
|
getAllChannels(agentsPerChannel?: number): Promise<Channel[]>;
|
|
2209
|
-
/** All promo codes.
|
|
2209
|
+
/** All promo codes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PromoCodeService.getAll}. */
|
|
2210
2210
|
getAllPromoCodes(): Promise<PromoCode[]>;
|
|
2211
|
-
/** Create a promo code.
|
|
2211
|
+
/** Create a promo code. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PromoCodeService.create}. */
|
|
2212
2212
|
createPromoCode(input: CreatePromoCodeInput): Promise<CreatedPromoCode>;
|
|
2213
|
-
/** Create a pricing engine.
|
|
2213
|
+
/** Create a pricing engine. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.createEngine}. */
|
|
2214
2214
|
createPricingEngine(input: CreateEngineInput): Promise<CreatedPricingEngine>;
|
|
2215
|
-
/** Update a pricing engine.
|
|
2215
|
+
/** Update a pricing engine. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.updateEngine}. */
|
|
2216
2216
|
updatePricingEngine(input: UpdateEngineInput): Promise<PricingEngine>;
|
|
2217
|
-
/** Delete a pricing engine (idempotent).
|
|
2217
|
+
/** Delete a pricing engine (idempotent). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.deleteEngine}. */
|
|
2218
2218
|
deletePricingEngine(engineId: string): Promise<void>;
|
|
2219
|
-
/** Upsert pricing overrides.
|
|
2219
|
+
/** Upsert pricing overrides. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.upsertOverrides}. */
|
|
2220
2220
|
upsertPricingOverrides(input: UpsertOverridesInput): Promise<UpsertOverridesResult>;
|
|
2221
|
-
/** Clear pricing overrides for a set of activities.
|
|
2221
|
+
/** Clear pricing overrides for a set of activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.clearOverrides}. */
|
|
2222
2222
|
clearPricingOverrides(input: ClearOverridesInput): Promise<UpsertOverridesResult>;
|
|
2223
|
-
/** Today's daily note.
|
|
2223
|
+
/** Today's daily note. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link DailyNoteService.getToday}. */
|
|
2224
2224
|
getDailyNoteToday(): Promise<DailyNote | null>;
|
|
2225
|
-
/** Update today's daily note.
|
|
2225
|
+
/** Update today's daily note. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link DailyNoteService.update}. */
|
|
2226
2226
|
updateDailyNote(note: string): Promise<DailyNote | null>;
|
|
2227
|
-
/** Availability times for an activity.
|
|
2227
|
+
/** Availability times for an activity. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AvailabilityService.getAvailabilityTimes}. */
|
|
2228
2228
|
getAvailabilityTimes(query: AvailabilityTimesQuery): Promise<AvailabilityTime[]>;
|
|
2229
|
-
/** All memberships.
|
|
2229
|
+
/** All memberships. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link MembershipService.getAll}. */
|
|
2230
2230
|
getAllMemberships(): Promise<Membership[]>;
|
|
2231
|
-
/** Purchase a membership.
|
|
2231
|
+
/** Purchase a membership. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link MembershipService.purchase}. */
|
|
2232
2232
|
purchaseMembership(input: MembershipPurchaseInput): Promise<PurchasedMembership>;
|
|
2233
|
-
/** Booking by id.
|
|
2233
|
+
/** Booking by id. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getById}. */
|
|
2234
2234
|
getBookingById(bookingId: string, options?: BookingReadOptions): Promise<Booking | null>;
|
|
2235
|
-
/** Bookings by time range.
|
|
2235
|
+
/** Bookings by time range. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.searchByTimeRange}. */
|
|
2236
2236
|
searchBookingsByTimeRange(input: BookingTimeRangeSearch): Promise<Booking[]>;
|
|
2237
|
-
/** Bookings on a timeslot.
|
|
2237
|
+
/** Bookings on a timeslot. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.searchByTimeslot}. */
|
|
2238
2238
|
searchBookingsByTimeslot(timeslotId: string, options?: BookingReadOptions): Promise<Booking[]>;
|
|
2239
|
-
/** Guests on a booking.
|
|
2239
|
+
/** Guests on a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getGuests}. */
|
|
2240
2240
|
getBookingGuests(bookingId: string): Promise<Guest[]>;
|
|
2241
|
-
/** Payments on file for a booking.
|
|
2241
|
+
/** Payments on file for a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getPaymentsOnFile}. */
|
|
2242
2242
|
getBookingPaymentsOnFile(bookingId: string): Promise<BookingPaymentsOnFile | null>;
|
|
2243
|
-
/** Append or overwrite operator notes.
|
|
2243
|
+
/** Append or overwrite operator notes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.appendNote}. */
|
|
2244
2244
|
appendBookingNote(bookingId: string, note: string, mode?: NoteMode): Promise<Booking | null>;
|
|
2245
|
-
/** Set booking check-in status.
|
|
2245
|
+
/** Set booking check-in status. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.setCheckinStatus}. */
|
|
2246
2246
|
setBookingCheckinStatus(bookingId: string, checkedIn: boolean): Promise<Booking | null>;
|
|
2247
|
-
/** Cancel a booking.
|
|
2247
|
+
/** Cancel a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.cancel}. */
|
|
2248
2248
|
cancelBooking(bookingId: string, notes?: string): Promise<CancelBookingResult>;
|
|
2249
|
-
/** Charge a booking.
|
|
2249
|
+
/** Charge a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.makePayment}. */
|
|
2250
2250
|
makeBookingPayment(input: MakePaymentInput): Promise<MakePaymentResult>;
|
|
2251
|
-
/** Refund a booking payment.
|
|
2251
|
+
/** Refund a booking payment. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.refund}. */
|
|
2252
2252
|
refundBooking(input: RefundInput): Promise<RefundResult>;
|
|
2253
|
-
/** Create an invoice link.
|
|
2253
|
+
/** Create an invoice link. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.createInvoiceLink}. */
|
|
2254
2254
|
createBookingInvoiceLink(bookingId: string): Promise<InvoiceLinkResult>;
|
|
2255
|
-
/** List add-ons on a booking.
|
|
2255
|
+
/** List add-ons on a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.listAddons}. */
|
|
2256
2256
|
listBookingAddons(bookingId: string): Promise<BookingAddons>;
|
|
2257
|
-
/** Add an add-on to a booking.
|
|
2257
|
+
/** Add an add-on to a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.addAddon}. */
|
|
2258
2258
|
addBookingAddon(bookingId: string, input: AddAddonInput): Promise<BookingAddonsMutationResult>;
|
|
2259
|
-
/** Remove an add-on from a booking.
|
|
2259
|
+
/** Remove an add-on from a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.removeAddon}. */
|
|
2260
2260
|
removeBookingAddon(bookingId: string, input: AddAddonInput): Promise<BookingAddonsMutationResult>;
|
|
2261
|
-
/** Create a booking.
|
|
2261
|
+
/** Create a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.create}. */
|
|
2262
2262
|
createBooking(input: CreateBookingInput): Promise<CreatedBooking>;
|
|
2263
|
-
/** Reviews for an activity.
|
|
2263
|
+
/** Reviews for an activity. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ReviewService.getReviews}. */
|
|
2264
2264
|
getReviews(productId: string, reviewCount?: number, reviewOffset?: number): Promise<Review[]>;
|
|
2265
2265
|
}
|
|
2266
2266
|
|
|
@@ -2390,7 +2390,7 @@ type CngAccessServiceConfig = BaseAccessServiceConfig;
|
|
|
2390
2390
|
* appId: process.env.PEEK_APP_ID!,
|
|
2391
2391
|
* });
|
|
2392
2392
|
*
|
|
2393
|
-
* const activities: Activity[] = await cng.getAllActivities();
|
|
2393
|
+
* const activities: Activity[] = await cng.getProductService().getAllActivities();
|
|
2394
2394
|
* ```
|
|
2395
2395
|
*
|
|
2396
2396
|
* @throws {Error} from the constructor when any required config field
|
|
@@ -2405,7 +2405,7 @@ declare class CngAccessService {
|
|
|
2405
2405
|
* authenticated transport. The instance is created lazily and reused.
|
|
2406
2406
|
*/
|
|
2407
2407
|
getProductService(): CngProductService;
|
|
2408
|
-
/** All activities.
|
|
2408
|
+
/** All activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link CngProductService.getAllActivities}. */
|
|
2409
2409
|
getAllActivities(): Promise<Activity[]>;
|
|
2410
2410
|
}
|
|
2411
2411
|
|
|
@@ -2525,7 +2525,7 @@ type AcmeAccessServiceConfig = BaseAccessServiceConfig;
|
|
|
2525
2525
|
* appId: process.env.PEEK_APP_ID!,
|
|
2526
2526
|
* });
|
|
2527
2527
|
*
|
|
2528
|
-
* const activities: AcmeActivity[] = await acme.getAllActivities();
|
|
2528
|
+
* const activities: AcmeActivity[] = await acme.getProductService().getAllActivities();
|
|
2529
2529
|
* ```
|
|
2530
2530
|
*
|
|
2531
2531
|
* @throws {Error} from the constructor when any required config field
|
|
@@ -2540,7 +2540,7 @@ declare class AcmeAccessService {
|
|
|
2540
2540
|
* authenticated transport. The instance is created lazily and reused.
|
|
2541
2541
|
*/
|
|
2542
2542
|
getProductService(): AcmeProductService;
|
|
2543
|
-
/** All activities.
|
|
2543
|
+
/** All activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AcmeProductService.getAllActivities}. */
|
|
2544
2544
|
getAllActivities(): Promise<AcmeActivity[]>;
|
|
2545
2545
|
}
|
|
2546
2546
|
|
package/dist/index.d.ts
CHANGED
|
@@ -2178,89 +2178,89 @@ declare class PeekAccessService {
|
|
|
2178
2178
|
* authenticated transport. The instance is created lazily and reused.
|
|
2179
2179
|
*/
|
|
2180
2180
|
getReviewService(): ReviewService;
|
|
2181
|
-
/** All products (activities + add-ons).
|
|
2181
|
+
/** All products (activities + add-ons). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllProducts}. */
|
|
2182
2182
|
getAllProducts(): Promise<Product[]>;
|
|
2183
|
-
/** All activity products (excludes add-ons).
|
|
2183
|
+
/** All activity products (excludes add-ons). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllActivities}. */
|
|
2184
2184
|
getAllActivities(): Promise<Product[]>;
|
|
2185
|
-
/** All rental products.
|
|
2185
|
+
/** All rental products. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllRentals}. */
|
|
2186
2186
|
getAllRentals(): Promise<Product[]>;
|
|
2187
|
-
/** All add-on products.
|
|
2187
|
+
/** All add-on products. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getAllAddons}. */
|
|
2188
2188
|
getAllAddons(): Promise<Product[]>;
|
|
2189
|
-
/** An activity's custom questions.
|
|
2189
|
+
/** An activity's custom questions. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ProductService.getCustomQuestions}. */
|
|
2190
2190
|
getCustomQuestions(productId: string): Promise<CustomQuestion[]>;
|
|
2191
|
-
/** All active account users.
|
|
2191
|
+
/** All active account users. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AccountUserService.getAll}. */
|
|
2192
2192
|
getAllAccountUsers(): Promise<AccountUser[]>;
|
|
2193
|
-
/** Account user by id, or null.
|
|
2193
|
+
/** Account user by id, or null. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AccountUserService.getById}. */
|
|
2194
2194
|
getAccountUserById(userId: string): Promise<AccountUser | null>;
|
|
2195
|
-
/** All resource pools.
|
|
2195
|
+
/** All resource pools. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ResourcePoolService.getAll}. */
|
|
2196
2196
|
getAllResourcePools(mode?: ResourcePoolMode): Promise<ResourcePool[]>;
|
|
2197
|
-
/** Timeslots for an activity on a given date.
|
|
2197
|
+
/** Timeslots for an activity on a given date. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.getForDay}. */
|
|
2198
2198
|
getTimeslotsForDay(productId: string, date: string, filter?: TimeslotFilter): Promise<Timeslot[]>;
|
|
2199
|
-
/** Single timeslot by id.
|
|
2199
|
+
/** Single timeslot by id. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.getById}. */
|
|
2200
2200
|
getTimeslotById(timeslotId: string): Promise<Timeslot | null>;
|
|
2201
|
-
/** Set timeslot status.
|
|
2201
|
+
/** Set timeslot status. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.setAvailability}. */
|
|
2202
2202
|
setTimeslotAvailability(timeslotId: string, status: string): Promise<UpdateTimeslotResult>;
|
|
2203
|
-
/** Set timeslot manifest notes.
|
|
2203
|
+
/** Set timeslot manifest notes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.setNotes}. */
|
|
2204
2204
|
setTimeslotNotes(timeslotId: string, manifestNotes: string): Promise<UpdateTimeslotResult>;
|
|
2205
|
-
/** Assign or unassign guides on timeslots.
|
|
2205
|
+
/** Assign or unassign guides on timeslots. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link TimeslotService.assignGuide}. */
|
|
2206
2206
|
assignTimeslotGuide(assignment: GuideAssignment): Promise<AssignGuideResult>;
|
|
2207
|
-
/** All reseller channels.
|
|
2207
|
+
/** All reseller channels. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ResellerService.getAllChannels}. */
|
|
2208
2208
|
getAllChannels(agentsPerChannel?: number): Promise<Channel[]>;
|
|
2209
|
-
/** All promo codes.
|
|
2209
|
+
/** All promo codes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PromoCodeService.getAll}. */
|
|
2210
2210
|
getAllPromoCodes(): Promise<PromoCode[]>;
|
|
2211
|
-
/** Create a promo code.
|
|
2211
|
+
/** Create a promo code. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PromoCodeService.create}. */
|
|
2212
2212
|
createPromoCode(input: CreatePromoCodeInput): Promise<CreatedPromoCode>;
|
|
2213
|
-
/** Create a pricing engine.
|
|
2213
|
+
/** Create a pricing engine. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.createEngine}. */
|
|
2214
2214
|
createPricingEngine(input: CreateEngineInput): Promise<CreatedPricingEngine>;
|
|
2215
|
-
/** Update a pricing engine.
|
|
2215
|
+
/** Update a pricing engine. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.updateEngine}. */
|
|
2216
2216
|
updatePricingEngine(input: UpdateEngineInput): Promise<PricingEngine>;
|
|
2217
|
-
/** Delete a pricing engine (idempotent).
|
|
2217
|
+
/** Delete a pricing engine (idempotent). @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.deleteEngine}. */
|
|
2218
2218
|
deletePricingEngine(engineId: string): Promise<void>;
|
|
2219
|
-
/** Upsert pricing overrides.
|
|
2219
|
+
/** Upsert pricing overrides. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.upsertOverrides}. */
|
|
2220
2220
|
upsertPricingOverrides(input: UpsertOverridesInput): Promise<UpsertOverridesResult>;
|
|
2221
|
-
/** Clear pricing overrides for a set of activities.
|
|
2221
|
+
/** Clear pricing overrides for a set of activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link PricingService.clearOverrides}. */
|
|
2222
2222
|
clearPricingOverrides(input: ClearOverridesInput): Promise<UpsertOverridesResult>;
|
|
2223
|
-
/** Today's daily note.
|
|
2223
|
+
/** Today's daily note. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link DailyNoteService.getToday}. */
|
|
2224
2224
|
getDailyNoteToday(): Promise<DailyNote | null>;
|
|
2225
|
-
/** Update today's daily note.
|
|
2225
|
+
/** Update today's daily note. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link DailyNoteService.update}. */
|
|
2226
2226
|
updateDailyNote(note: string): Promise<DailyNote | null>;
|
|
2227
|
-
/** Availability times for an activity.
|
|
2227
|
+
/** Availability times for an activity. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AvailabilityService.getAvailabilityTimes}. */
|
|
2228
2228
|
getAvailabilityTimes(query: AvailabilityTimesQuery): Promise<AvailabilityTime[]>;
|
|
2229
|
-
/** All memberships.
|
|
2229
|
+
/** All memberships. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link MembershipService.getAll}. */
|
|
2230
2230
|
getAllMemberships(): Promise<Membership[]>;
|
|
2231
|
-
/** Purchase a membership.
|
|
2231
|
+
/** Purchase a membership. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link MembershipService.purchase}. */
|
|
2232
2232
|
purchaseMembership(input: MembershipPurchaseInput): Promise<PurchasedMembership>;
|
|
2233
|
-
/** Booking by id.
|
|
2233
|
+
/** Booking by id. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getById}. */
|
|
2234
2234
|
getBookingById(bookingId: string, options?: BookingReadOptions): Promise<Booking | null>;
|
|
2235
|
-
/** Bookings by time range.
|
|
2235
|
+
/** Bookings by time range. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.searchByTimeRange}. */
|
|
2236
2236
|
searchBookingsByTimeRange(input: BookingTimeRangeSearch): Promise<Booking[]>;
|
|
2237
|
-
/** Bookings on a timeslot.
|
|
2237
|
+
/** Bookings on a timeslot. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.searchByTimeslot}. */
|
|
2238
2238
|
searchBookingsByTimeslot(timeslotId: string, options?: BookingReadOptions): Promise<Booking[]>;
|
|
2239
|
-
/** Guests on a booking.
|
|
2239
|
+
/** Guests on a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getGuests}. */
|
|
2240
2240
|
getBookingGuests(bookingId: string): Promise<Guest[]>;
|
|
2241
|
-
/** Payments on file for a booking.
|
|
2241
|
+
/** Payments on file for a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.getPaymentsOnFile}. */
|
|
2242
2242
|
getBookingPaymentsOnFile(bookingId: string): Promise<BookingPaymentsOnFile | null>;
|
|
2243
|
-
/** Append or overwrite operator notes.
|
|
2243
|
+
/** Append or overwrite operator notes. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.appendNote}. */
|
|
2244
2244
|
appendBookingNote(bookingId: string, note: string, mode?: NoteMode): Promise<Booking | null>;
|
|
2245
|
-
/** Set booking check-in status.
|
|
2245
|
+
/** Set booking check-in status. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.setCheckinStatus}. */
|
|
2246
2246
|
setBookingCheckinStatus(bookingId: string, checkedIn: boolean): Promise<Booking | null>;
|
|
2247
|
-
/** Cancel a booking.
|
|
2247
|
+
/** Cancel a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.cancel}. */
|
|
2248
2248
|
cancelBooking(bookingId: string, notes?: string): Promise<CancelBookingResult>;
|
|
2249
|
-
/** Charge a booking.
|
|
2249
|
+
/** Charge a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.makePayment}. */
|
|
2250
2250
|
makeBookingPayment(input: MakePaymentInput): Promise<MakePaymentResult>;
|
|
2251
|
-
/** Refund a booking payment.
|
|
2251
|
+
/** Refund a booking payment. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.refund}. */
|
|
2252
2252
|
refundBooking(input: RefundInput): Promise<RefundResult>;
|
|
2253
|
-
/** Create an invoice link.
|
|
2253
|
+
/** Create an invoice link. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.createInvoiceLink}. */
|
|
2254
2254
|
createBookingInvoiceLink(bookingId: string): Promise<InvoiceLinkResult>;
|
|
2255
|
-
/** List add-ons on a booking.
|
|
2255
|
+
/** List add-ons on a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.listAddons}. */
|
|
2256
2256
|
listBookingAddons(bookingId: string): Promise<BookingAddons>;
|
|
2257
|
-
/** Add an add-on to a booking.
|
|
2257
|
+
/** Add an add-on to a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.addAddon}. */
|
|
2258
2258
|
addBookingAddon(bookingId: string, input: AddAddonInput): Promise<BookingAddonsMutationResult>;
|
|
2259
|
-
/** Remove an add-on from a booking.
|
|
2259
|
+
/** Remove an add-on from a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.removeAddon}. */
|
|
2260
2260
|
removeBookingAddon(bookingId: string, input: AddAddonInput): Promise<BookingAddonsMutationResult>;
|
|
2261
|
-
/** Create a booking.
|
|
2261
|
+
/** Create a booking. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link BookingService.create}. */
|
|
2262
2262
|
createBooking(input: CreateBookingInput): Promise<CreatedBooking>;
|
|
2263
|
-
/** Reviews for an activity.
|
|
2263
|
+
/** Reviews for an activity. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link ReviewService.getReviews}. */
|
|
2264
2264
|
getReviews(productId: string, reviewCount?: number, reviewOffset?: number): Promise<Review[]>;
|
|
2265
2265
|
}
|
|
2266
2266
|
|
|
@@ -2390,7 +2390,7 @@ type CngAccessServiceConfig = BaseAccessServiceConfig;
|
|
|
2390
2390
|
* appId: process.env.PEEK_APP_ID!,
|
|
2391
2391
|
* });
|
|
2392
2392
|
*
|
|
2393
|
-
* const activities: Activity[] = await cng.getAllActivities();
|
|
2393
|
+
* const activities: Activity[] = await cng.getProductService().getAllActivities();
|
|
2394
2394
|
* ```
|
|
2395
2395
|
*
|
|
2396
2396
|
* @throws {Error} from the constructor when any required config field
|
|
@@ -2405,7 +2405,7 @@ declare class CngAccessService {
|
|
|
2405
2405
|
* authenticated transport. The instance is created lazily and reused.
|
|
2406
2406
|
*/
|
|
2407
2407
|
getProductService(): CngProductService;
|
|
2408
|
-
/** All activities.
|
|
2408
|
+
/** All activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link CngProductService.getAllActivities}. */
|
|
2409
2409
|
getAllActivities(): Promise<Activity[]>;
|
|
2410
2410
|
}
|
|
2411
2411
|
|
|
@@ -2525,7 +2525,7 @@ type AcmeAccessServiceConfig = BaseAccessServiceConfig;
|
|
|
2525
2525
|
* appId: process.env.PEEK_APP_ID!,
|
|
2526
2526
|
* });
|
|
2527
2527
|
*
|
|
2528
|
-
* const activities: AcmeActivity[] = await acme.getAllActivities();
|
|
2528
|
+
* const activities: AcmeActivity[] = await acme.getProductService().getAllActivities();
|
|
2529
2529
|
* ```
|
|
2530
2530
|
*
|
|
2531
2531
|
* @throws {Error} from the constructor when any required config field
|
|
@@ -2540,7 +2540,7 @@ declare class AcmeAccessService {
|
|
|
2540
2540
|
* authenticated transport. The instance is created lazily and reused.
|
|
2541
2541
|
*/
|
|
2542
2542
|
getProductService(): AcmeProductService;
|
|
2543
|
-
/** All activities.
|
|
2543
|
+
/** All activities. @deprecated The access service exposes only its resource-service accessors; call the service directly instead. See {@link AcmeProductService.getAllActivities}. */
|
|
2544
2544
|
getAllActivities(): Promise<AcmeActivity[]>;
|
|
2545
2545
|
}
|
|
2546
2546
|
|