@riverbankcms/sdk 0.146.0 → 0.147.0

package/dist/_dts/api/src/bookingOperations.d.ts

@@ -1,4 +1,6 @@
 import type { TimeSlot } from './availability';
+import type { PublicCreateBookingAppointmentRequest, PublicCreateBookingAppointmentResponse } from './publicAppointmentBookingContracts';
+export type { PublicCreateBookingAppointmentRequest, PublicCreateBookingAppointmentResponse, PublicBookingAppointmentSummary, PublicBookingCustomerSummary, } from './publicAppointmentBookingContracts';
 import type { InviteSiteMemberEmailResult, SiteInvitation, StaffOperationalCapability } from './accessAdmin';
 import type { EventSeriesRegistrationRefundFailedCode, EventAttendeeRefundFailedCode } from './bookingRefundOutcomes';
 /**
@@ -647,50 +649,6 @@ export type PublicWeeklySlotAvailabilityResponse = {
     startDate: string;
     endDate: string;
 };
-export type PublicCreateBookingAppointmentRequest = {
-    formId: string;
-    serviceId: string;
-    resourceId?: string | null;
-    startAt: string;
-    endAt: string;
-    customFields: Record<string, unknown>;
-    timezone?: string;
-    discountCode?: string;
-    selectedSlidingAmount?: number;
-    selectedCollectionOptionKind?: 'upfront' | 'deferred_manual' | 'instalment_plan' | 'flexible_balance';
-    altchaSolution?: string | null;
-    successUrl?: string;
-    cancelUrl?: string;
-};
-export type PublicBookingAppointmentSummary = {
-    id: string;
-    status: 'confirmed' | 'pending' | 'cancelled';
-    startAt: string;
-    endAt: string;
-    timezone: string;
-    resourceName: string | null;
-};
-export type PublicBookingCustomerSummary = {
-    id: string;
-    email: string | null;
-    name: string | null;
-    phone: string | null;
-};
-export type PublicCreateBookingAppointmentResponse = {
-    type: 'booked';
-    orderId: string;
-    orderNumber: string;
-    appointment: PublicBookingAppointmentSummary;
-    customer: PublicBookingCustomerSummary;
-} | {
-    type: 'checkout_redirect';
-    orderId: string;
-    orderNumber: string;
-    checkoutUrl: string;
-    sessionId: string;
-    appointment: PublicBookingAppointmentSummary;
-    customer: PublicBookingCustomerSummary;
-};
 export type PublicBookingAppointmentStatusResponse = {
     appointmentId: string;
     appointmentStatus: 'pending' | 'confirmed' | 'cancelled';

package/dist/_dts/api/src/bookingPeople.d.ts

@@ -0,0 +1,92 @@
+import type { APIEndpoint } from './apiEndpointTypes';
+import type { CustomerAggregateSnapshot } from './bookingRecords';
+export declare const PEOPLE_LIST_SORT_VALUES: readonly ["name", "passes", "memberships", "lastBooking", "added"];
+export type PeopleListSort = (typeof PEOPLE_LIST_SORT_VALUES)[number];
+export declare const PEOPLE_LIST_FILTER_VALUES: readonly ["everyone", "hasBought", "hasActivePass", "hasMembership", "guests", "nothingBought"];
+export type PeopleListFilter = (typeof PEOPLE_LIST_FILTER_VALUES)[number];
+/**
+ * A person's customer account, when they have one. Guests have none: someone
+ * else booked for them and they haven't booked or bought anything themselves.
+ */
+export type PersonListAccount = {
+    kind: 'guest';
+} | {
+    kind: 'customer';
+    customerId: string;
+    /** Lifecycle facts; only loaded for the rows on the current page. */
+    aggregate: CustomerAggregateSnapshot | null;
+};
+export type PersonListItem = {
+    personId: string;
+    name: string | null;
+    email: string | null;
+    phone: string | null;
+    addedAt: string;
+    activePassesCount: number;
+    activeMembershipsCount: number;
+    hasBought: boolean;
+    /** Latest start among the person's own non-cancelled bookings, upcoming included. */
+    lastBookingAt: string | null;
+    account: PersonListAccount;
+};
+export type ListPeopleRequest = {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sortBy?: PeopleListSort;
+    sortDirection?: 'asc' | 'desc';
+    filter?: PeopleListFilter;
+};
+export type ListPeopleResponse = {
+    people: PersonListItem[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+    };
+};
+/** What can be attached to a person, in the order the dialog lists it. */
+export declare const PERSON_DELETION_BLOCKER_CATEGORY_VALUES: readonly ["bookings", "guest_places", "waitlist_places", "payments", "orders", "passes", "memberships", "credit", "digital_products", "discounts", "gifts", "notes", "forms", "uploads", "contact_corrections"];
+export type PersonDeletionBlockerCategory = (typeof PERSON_DELETION_BLOCKER_CATEGORY_VALUES)[number];
+/** One attached category with a count above zero. */
+export type PersonDeletionBlocker = {
+    category: PersonDeletionBlockerCategory;
+    count: number;
+};
+/** GET .../people/{personId}/deletion-check */
+export type PersonDeletionCheckResponse = {
+    kind: 'deletable';
+    /** A newsletter subscriber with the same email is a separate record and stays. */
+    stillOnNewsletterList: boolean;
+} | {
+    kind: 'blocked';
+    blockers: PersonDeletionBlocker[];
+};
+/**
+ * DELETE .../people/{personId}. `blocked` means something was attached by the
+ * time of the delete, with the fresh counts, so the dialog can say so without
+ * a second call.
+ */
+export type DeletePersonResponse = {
+    kind: 'deleted';
+} | {
+    kind: 'blocked';
+    blockers: PersonDeletionBlocker[];
+};
+/** The People endpoints' request and response types. */
+export type BookingPeopleEndpoints = {
+    listPeople: APIEndpoint<never, {
+        siteId: string;
+    } & ListPeopleRequest, ListPeopleResponse>;
+    exportPeopleCsv: APIEndpoint<never, {
+        siteId: string;
+    } & ListPeopleRequest, Blob>;
+    checkPersonDeletion: APIEndpoint<never, {
+        siteId: string;
+        personId: string;
+    }, PersonDeletionCheckResponse>;
+    deletePerson: APIEndpoint<never, {
+        siteId: string;
+        personId: string;
+    }, DeletePersonResponse>;
+};

package/dist/_dts/api/src/bookingPeopleEndpointDefinitions.d.ts

@@ -0,0 +1,38 @@
+/**
+ * People endpoints (#1356): the People list, its CSV export, and deleting a
+ * person when nothing is attached to them.
+ */
+export declare const BOOKING_PEOPLE_ENDPOINT_DEFINITIONS: {
+    listPeople: {
+        path: "/sites/{siteId}/bookings/people";
+        method: "GET";
+        tags: ("site-{siteId}" | "customers-{siteId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: "server:internal_error"[];
+    };
+    exportPeopleCsv: {
+        path: "/sites/{siteId}/bookings/people/export.csv";
+        method: "GET";
+        tags: ("site-{siteId}" | "customers-{siteId}")[];
+        auth: "user";
+        errors: never[];
+        responseKind: "blob";
+    };
+    checkPersonDeletion: {
+        path: "/sites/{siteId}/bookings/people/{personId}/deletion-check";
+        method: "GET";
+        tags: ("site-{siteId}" | "customers-{siteId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    deletePerson: {
+        path: "/sites/{siteId}/bookings/people/{personId}";
+        method: "DELETE";
+        tags: ("site-{siteId}" | "customers-{siteId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+};

package/dist/_dts/api/src/bookingRecords.d.ts

@@ -99,9 +99,6 @@ export type BookingBeforeYouComeReview = {
 };
 export type { PersonRecordNoteKind };
 export type PersonRecordEntrySubject = {
-    kind: 'customer';
-    customerId: string;
-} | {
     kind: 'appointment';
     appointmentId: string;
 } | {
@@ -253,18 +250,6 @@ export type EventOccurrenceListRecord = EventOccurrenceRecord & {
         status: string;
     };
 };
-export type CreateOccurrenceRequest = {
-    startsAt: string;
-    endsAt: string;
-    staffAssignmentMode?: StaffAssignmentMode;
-    staffMemberIds?: string[];
-    mainHostStaffMemberId?: string | null;
-    capacityOverride?: number | null;
-    overridesJson?: EventOccurrenceOverrides;
-    onlineDetailsOverride?: EventOnlineDetailsInput | null;
-    isException?: boolean;
-    metadata?: Record<string, unknown>;
-};
 export type VenueLocation = {
     lat: number;
     lng: number;
@@ -482,25 +467,6 @@ export type CustomerAggregateSnapshot = {
 export type BookingCustomerListItem = BookingCustomerWithCounts & {
     aggregate: CustomerAggregateSnapshot | null;
 };
-export type ListBookingCustomersResponse = {
-    customers: BookingCustomerListItem[];
-    pagination: {
-        page: number;
-        limit: number;
-        total: number;
-    };
-};
-export type CustomerSortColumn = 'name' | 'email' | 'createdAt' | 'passesCount' | 'membershipsCount';
-export type CustomerFilter = 'all' | 'hasActivePass' | 'hasActiveProducts' | 'hasMembership' | 'noProducts';
-export type ListBookingCustomersRequest = {
-    page?: number;
-    limit?: number;
-    search?: string;
-    sortBy?: CustomerSortColumn;
-    sortDirection?: 'asc' | 'desc';
-    filter?: CustomerFilter;
-    includeAggregates?: boolean;
-};
 export type CreateBookingCustomerRequest = {
     name?: string;
     email?: string;
@@ -508,6 +474,8 @@ export type CreateBookingCustomerRequest = {
 };
 export type CreateBookingCustomerResponse = {
     customer: BookingCustomerWithCounts;
+    /** The person the database created for the new customer. */
+    personId: string;
 };
 export type CustomerContactField = 'name' | 'email' | 'phone';
 export type CustomerContactChange = {
@@ -596,8 +564,15 @@ export type SiteCustomerRecord = {
     email: string;
     name: string | null;
 };
+/**
+ * A pass or membership holder; `personId` links to their person page. Every
+ * customer has exactly one person, so it is always present.
+ */
+export type SiteHolderRecord = SiteCustomerRecord & {
+    personId: string;
+};
 export type SiteCustomerPassRecord = CustomerPassRecord & {
-    customer: SiteCustomerRecord;
+    customer: SiteHolderRecord;
     redemptions: {
         count: number;
         creditsUsed: number;
@@ -638,7 +613,7 @@ export type ListCustomerMembershipsResponse = {
     memberships: CustomerMembershipRecord[];
 };
 export type SiteCustomerMembershipRecord = CustomerMembershipRecord & {
-    customer: SiteCustomerRecord;
+    customer: SiteHolderRecord;
     cancelAtPeriodEnd: boolean;
     /** True when this membership is managed by Stripe (has a subscription ID). */
     stripeManaged: boolean;
@@ -1149,11 +1124,6 @@ export type ListDiscountRedemptionsResponse = {
         hasMore: boolean;
     };
 };
-export type ListCustomerAttendancesRequest = {
-    limit?: number;
-    offset?: number;
-    status?: 'confirmed' | 'waitlist' | 'cancelled';
-};
 export type CustomerAttendancePaymentMethod = 'free' | 'pass' | 'membership' | 'stripe';
 export type CustomerAttendancePaymentStatus = 'not_required' | 'pending' | 'completed' | 'failed' | 'refunded';
 export type CustomerAttendanceLivePayment = {
@@ -1184,11 +1154,3 @@ export type CustomerAttendanceRecord = {
     };
     payment: CustomerAttendancePayment;
 };
-export type ListCustomerAttendancesResponse = {
-    attendances: CustomerAttendanceRecord[];
-    pagination: {
-        total: number;
-        limit: number;
-        offset: number;
-    };
-};

package/dist/_dts/api/src/bookingSettingsSections.d.ts

@@ -3,7 +3,7 @@ export declare const BOOKING_SETTINGS_SECTION_LABELS: Record<BookingSettingsSect
 export declare const BOOKING_SETTINGS_SECTION_KEYS: {
     readonly basics: readonly ["modules", "verticalConfig", "eventTypePresets", "personRecordMode", "defaultTimezone", "calendarDisplay", "icsFeedsEnabled", "waitlists", "teamMemberProfilePages"];
     readonly payments: readonly ["paymentDefaults", "currency", "refundsIssueCredit"];
-    readonly events: readonly ["defaultVenueId", "eventReminderHours", "eventReminderOverrides", "eventScheduleWindowMonths", "eventOrganizerNotifications", "eventOrganizerEmail", "eventTicketingDefaultEnabled", "collectAllAttendeeDetails", "eventBookingPolicies", "defaultEventImage", "eventDestinationPolicy"];
+    readonly events: readonly ["defaultVenueId", "eventReminderHours", "eventReminderOverrides", "eventScheduleWindowMonths", "eventOrganizerNotifications", "eventOrganizerEmail", "eventTicketingDefaultEnabled", "collectAllAttendeeDetails", "eventTypeBookingDefaults", "eventBookingPolicies", "defaultEventImage", "eventDestinationPolicy"];
     readonly appointments: readonly ["appointmentReminderHours", "appointmentReminderOverrides", "appointmentRescheduleHours", "appointmentDefaultMinLeadMinutes", "appointmentDefaultMaxBookingNoticeMinutes", "appointmentBookingPolicies"];
     readonly messages: readonly ["remindersEnabled", "notificationSettings", "appointmentStaffReminder", "appointmentStaffChangeNotifications", "eventFeedback", "appointmentFollowUp"];
 };

package/dist/_dts/api/src/bookings.d.ts

@@ -2,6 +2,7 @@ import type { ApiClient } from './request';
 import type { RichTextDoc, SensitiveCollectionConfirmationVersion, SensitiveCollectionMode } from '../../core/src/index';
 import type { BookingSettingsResponse, UpdateBookingSettingsRequest, DeleteEventOfferingResponse, AddEventSeriesRegistrationRequest, AddEventSeriesRegistrationResponse, AddEventOccurrenceAttendeeRequest, AddEventOccurrenceAttendeeResponse, UpdateEventSeriesRegistrationRequest, UpdateEventSeriesRegistrationResponse } from './types';
 export { CUSTOMER_MEMBERSHIP_STATUS_VALUES, CUSTOMER_PASS_STATUS_VALUES, } from './bookingRecords';
+export { PERSON_DELETION_BLOCKER_CATEGORY_VALUES } from './bookingPeople';
 export type { CustomerMembershipStatus, CustomerPassStatus, } from './bookingRecords';
 export { DELETE_EVENT_OFFERING_CONFLICT_REASONS, isDeleteEventOfferingConflictReason, } from './wholeSeriesRuns';
 export type { DeleteEventOfferingConflictReason } from './wholeSeriesRuns';