@riverbankcms/sdk 0.123.0 → 0.125.0

package/dist/_dts/blocks/src/system/runtime/api/types/events.d.ts

@@ -0,0 +1,241 @@
+/**
+ * Public event, registration, checkout and eligibility types
+ *
+ * Part of the block API client type surface; re-exported from `../types`.
+ */
+import type { DirectCheckoutCollectionOptionKind } from "./core";
+import type { PublicEvent as _PublicEvent, EventVenue as _EventVenue, PricingType as _PricingType, AccessRestriction as _AccessRestriction, PublicEventTicketType as _PublicEventTicketType, PublicEventTicketTypeAvailability as _PublicEventTicketTypeAvailability } from "../../../blocks/events/shared/types";
+import type { EventScheduleScope, EventSurfaceScope } from "../../../blocks/events/shared/filtering";
+export type PublicEvent = _PublicEvent;
+export type EventVenue = _EventVenue;
+export type PricingType = _PricingType;
+export type AccessRestriction = _AccessRestriction;
+export type PublicEventTicketType = _PublicEventTicketType;
+export type PublicEventTicketTypeAvailability = _PublicEventTicketTypeAvailability;
+export interface EligibilityEventTicketType {
+    id: string;
+    name: string;
+    description: string | null;
+    priceAmount: number;
+    isActive: boolean;
+    sortOrder: number;
+    capacityMode: "limited" | "unlimited";
+    capacityLimit: number | null;
+    attendanceScope?: 'in_person' | 'online' | 'both';
+    saleStartsAt: string | null;
+    saleEndsAt: string | null;
+    availability: PublicEventTicketTypeAvailability;
+}
+export interface PublicEventsRequest {
+    siteId: string;
+    from?: string;
+    to?: string;
+    /** Cursor: only return events after this startsAt */
+    afterStartsAt?: string;
+    /** Cursor: tie-breaker for events with same startsAt (occurrenceId) */
+    afterId?: string;
+    limit?: number;
+    stage?: "preview" | "published";
+    /** Semantic event surface scope */
+    eventSurface?: EventSurfaceScope;
+    /** Filter by event presets (comma-separated) */
+    eventPresets?: string;
+    /** Filter by event schedule cadence */
+    scheduleScope?: EventScheduleScope;
+    /** Filter by category IDs (comma-separated) */
+    categoryIds?: string;
+    /** Filter by venue ID */
+    venueId?: string;
+    /** Filter by staff member ID */
+    staffMemberId?: string;
+    /** Scope results to a single series (by series ID) */
+    seriesId?: string;
+    /** Ensure this occurrence is included even if outside date window */
+    includeOccurrenceId?: string;
+    /** Response detail level for list-style blocks */
+    detailLevel?: 'full' | 'listing';
+}
+export interface PublicEventsResponse {
+    success: boolean;
+    data: PublicEvent[];
+}
+export interface EventFilterCategory {
+    id: string;
+    name: string;
+    identifier: string | null;
+    color: string | null;
+    /** Count of upcoming events in this category */
+    upcomingCount: number;
+}
+export interface EventFilterVenue {
+    id: string;
+    name: string;
+    /** Count of upcoming events at this venue */
+    upcomingCount: number;
+}
+export interface EventFilterStaffMember {
+    id: string;
+    name: string;
+    /** Count of upcoming events for this staff member */
+    upcomingCount: number;
+}
+export interface EventFiltersResponse {
+    categories: EventFilterCategory[];
+    venues: EventFilterVenue[];
+    staffMembers: EventFilterStaffMember[];
+}
+export type PaymentMethod = "free" | "pass" | "membership" | "stripe" | "pass_bundle" | "membership_bundle";
+/**
+ * Guest details for additional attendees
+ */
+export interface EventRegisterGuest {
+    name: string;
+    email?: string | null;
+    phone?: string | null;
+}
+export interface EventTicketSelectionRequest {
+    ticketTypeId?: string | null;
+    quantity: number;
+}
+export interface EventTicketLineSummary {
+    ticketTypeId: string | null;
+    label: string;
+    description: string | null;
+    quantity: number;
+    unitPriceCents: number;
+    subtotalCents: number;
+    currency: string;
+}
+export interface EventRegisterRequest {
+    siteId: string;
+    occurrenceId: string;
+    attendanceMode?: 'in_person' | 'online';
+    ticketSelections: EventTicketSelectionRequest[];
+    selectedSlidingAmount?: number;
+    email: string;
+    name: string;
+    phone?: string;
+    notes?: string;
+    altchaSolution?: string | null;
+    stage?: "preview" | "published";
+    paymentMethod?: PaymentMethod;
+    customerPassId?: string;
+    customerMembershipId?: string;
+    /** Product ID for bundle purchases (pass or membership ID to buy) */
+    bundleProductId?: string;
+    claimToken?: string;
+    /** Guest details when "collect all attendee details" is enabled */
+    guests?: EventRegisterGuest[];
+}
+export type EventRegisterResponse = {
+    success: boolean;
+    attendeeId: string;
+    status: "confirmed";
+    paymentMethod: PaymentMethod;
+    pendingPayment: boolean;
+    passCreditsUsed?: number;
+    passCreditsRemaining?: number;
+    alreadyRegistered?: boolean;
+    ticketLines: EventTicketLineSummary[];
+    message?: string;
+} | {
+    success: boolean;
+    attendeeId: string;
+    status: "waitlist";
+    waitlistPosition: number | null;
+    alreadyRegistered?: boolean;
+    message?: string;
+};
+/** Type of checkout for event payment */
+export type EventCheckoutType = "event" | "pass_bundle" | "membership_bundle";
+export interface EventCheckoutRequest {
+    siteId: string;
+    attendeeId: string;
+    /** Type of checkout: 'event' for direct payment, or bundle types */
+    checkoutType?: EventCheckoutType;
+    /** Product ID for bundle purchases (pass or membership ID) */
+    productId?: string;
+    /** Optional booking discount code (applies only to Stripe/card flows) */
+    discountCode?: string;
+    collectionOptionKind?: DirectCheckoutCollectionOptionKind;
+    successUrl: string;
+    cancelUrl: string;
+}
+export interface EventCheckoutResponse {
+    checkoutUrl: string | null;
+    sessionId: string | null;
+    bypassed: boolean;
+}
+export interface EligiblePass {
+    customerPassId: string;
+    passName: string;
+    creditsRemaining: number;
+}
+export interface EligibleMembership {
+    customerMembershipId: string;
+    membershipName: string;
+}
+export interface AvailablePass {
+    id: string;
+    name: string;
+    description: string | null;
+    price: number;
+    currency: string;
+    creditsTotal: number;
+    pricePerCredit: number;
+    validDays: number | null;
+}
+export interface AvailableMembership {
+    id: string;
+    name: string;
+    description: string | null;
+    price: number;
+    currency: string;
+    interval: "month" | "year";
+}
+export interface EligibilityCheckRequest {
+    siteId: string;
+    occurrenceId: string;
+    attendanceMode?: 'in_person' | 'online';
+    ticketSelections: EventTicketSelectionRequest[];
+    selectedSlidingAmount?: number;
+    email: string;
+}
+export interface EligibilityCheckResponse {
+    customerExists: boolean;
+    eligibility: {
+        isFull: boolean;
+        waitlistEnabled: boolean;
+        canJoinWaitlist: boolean;
+        membership: EligibleMembership | null;
+        passes: EligiblePass[];
+        requiresPayment: boolean;
+        pricingMode?: "single" | "ticket_types" | "sliding_scale";
+        selectedTicketTypeId?: string | null;
+        ticketLines: EventTicketLineSummary[];
+        ticketTypes?: EligibilityEventTicketType[];
+        eventPrice: number | null;
+        eventPriceCurrency: string | null;
+        eventAcceptsPasses: boolean;
+        eventAcceptsMemberships: boolean;
+        requiresAuthForPasses: boolean;
+        requiresAuthForMemberships: boolean;
+        availableForPurchase: {
+            passes: AvailablePass[];
+            memberships: AvailableMembership[];
+        };
+    };
+}
+/** Payment status values returned by the backend */
+export type PaymentStatus = "pending" | "completed" | "failed" | "not_required" | "refunded";
+/** Attendee status values returned by the backend */
+export type AttendeeStatus = "confirmed" | "waitlist" | "cancelled";
+export interface EventRegistrationStatusRequest {
+    siteId: string;
+    attendeeId: string;
+}
+export interface EventRegistrationStatusResponse {
+    paymentStatus: PaymentStatus;
+    attendeeStatus: AttendeeStatus;
+    waitlistPosition: number | null;
+}

package/dist/_dts/blocks/src/system/runtime/api/types/forms.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Form submission and configuration types
+ *
+ * Part of the block API client type surface; re-exported from `../types`.
+ */
+export interface FormSubmitRequest {
+    formId: string;
+    data: Record<string, unknown>;
+    meta?: {
+        honeypot?: string;
+        altchaSolution?: string | null;
+        referer?: string;
+        userAgent?: string;
+        path?: string;
+    };
+}
+export interface FormSubmitResponse {
+    success: boolean;
+    submissionId?: string;
+}
+export type { FormField } from "../../components/multi-step/DynamicFormFields";
+import type { FormField } from "../../components/multi-step/DynamicFormFields";
+export interface FormConfigResponse {
+    form: {
+        id: string;
+        name: string;
+        slug: string;
+        settingsJson?: {
+            type: "booking";
+            serviceId?: string;
+            serviceIds?: string[];
+            resourceId?: string;
+            requiresApproval?: boolean;
+            successMessage?: string;
+        };
+        schemaJson?: {
+            version: string;
+            fields: FormField[];
+        };
+        settings?: {
+            type: "booking";
+            serviceId?: string;
+            serviceIds?: string[];
+            resourceId?: string;
+            requiresApproval?: boolean;
+            successMessage?: string;
+        };
+        schema?: {
+            version: string;
+            fields: FormField[];
+        };
+    };
+}

package/dist/_dts/blocks/src/system/runtime/api/types/newsletter.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Newsletter subscription types
+ *
+ * Part of the block API client type surface; re-exported from `../types`.
+ */
+import type { NewsletterSignupPublicDestinationRef } from "../../../blocks/newsletter-signup-destination";
+export type NewsletterSubscribeTarget = Readonly<{
+    tag: "legacy_riverbank_list";
+    listId: string;
+    destinationRef?: NewsletterSignupPublicDestinationRef;
+}> | Readonly<{
+    tag: "published_block_ref";
+    destinationRef: NewsletterSignupPublicDestinationRef;
+}>;
+export interface NewsletterSubscribeRequest {
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    name?: string;
+    company?: string;
+    phone?: string;
+    target: NewsletterSubscribeTarget;
+    tags?: string[];
+    meta?: {
+        honeypot?: string;
+        altchaSolution?: string | null;
+    };
+}
+export interface NewsletterSubscribeResponse {
+    subscribed: boolean;
+    requiresConfirmation?: boolean;
+}

package/dist/_dts/blocks/src/system/runtime/api/types/portal.d.ts

@@ -0,0 +1,220 @@
+/**
+ * Customer portal types, including guest and self-service actions
+ *
+ * Part of the block API client type surface; re-exported from `../types`.
+ */
+export type { AppointmentBookingQuestionsTaskDetail, BookingQuestionsTaskDetail, BookingQuestionsAnswerValue, BookingQuestionsDocumentAnswerValue, BookingQuestionsField, BookingQuestionsFieldOption, BookingQuestionsSection, BeforeYouComeTaskSummary, CustomerProfile, CustomerOrderInstalmentPlan, CustomerOrderInstalmentPlanStatus, CustomerOrderInstalmentRow, CustomerOrderInstalmentStatus, CustomerOrder, CustomerOrderFilter, CustomerOrderItem, CustomerOrderPaymentState, CustomerOrderRefund, CustomerPass, CustomerPassCreditHistoryEntry, CustomerMembership, EventTicketBreakdownLine, CustomerEventRegistration, CustomerCourseEnrollment, CustomerAppointment, EnabledModules, EventGuest, PortalCredit, PortalCreditSummary, PortalCreditTransaction, PortalDigitalProduct, PortalDigitalProductFile, } from "../../../../portal/types";
+import type { EventGuest as EventGuestType, EventTicketBreakdownLine } from "../../../../portal/types";
+/**
+ * Full response from GET /api/portal/me including profile and enabled modules
+ */
+export interface PortalMeResponse {
+    profile: import("../../../../portal/types").CustomerProfile;
+    modules: import("../../../../portal/types").EnabledModules;
+}
+export interface PortalMeUpdateRequest {
+    name?: string;
+    phone?: string | null;
+}
+export interface PortalEventTicket {
+    ticketUrl: string;
+    qrImageUrl: string;
+    fallbackCode: string;
+    registration: {
+        id: string;
+        eventTitle: string;
+        seriesName: string | null;
+        startsAt: string;
+        endsAt: string;
+        timeZone: string;
+        venueName: string | null;
+        venueAddress: string | null;
+        ticketsCount: number;
+        ticketLines: EventTicketBreakdownLine[];
+        ticketBreakdown: string | null;
+    };
+}
+export interface MagicLinkRequest {
+    siteId: string;
+    email: string;
+    /** URL to redirect to after magic link verification. Required by server. */
+    redirectUrl: string;
+}
+export interface PortalCreditResponse {
+    credit: import("../../../../portal/types").PortalCredit | null;
+}
+export interface PortalOrdersResponse {
+    orders: import("../../../../portal/types").CustomerOrder[];
+}
+export interface PortalOrderCheckoutRequest {
+    successUrl: string;
+    cancelUrl: string;
+    amountCents?: number;
+}
+export interface PortalOrderCheckoutResponse {
+    checkoutUrl: string;
+    sessionId: string;
+}
+export interface PortalDigitalProductsResponse {
+    tabLabel: string;
+    products: import("../../../../portal/types").PortalDigitalProduct[];
+}
+export interface PortalDigitalProductAccessResponse {
+    product: import("../../../../portal/types").PortalDigitalProduct;
+    guardedHref: string | null;
+}
+export interface PortalDigitalProductDownloadUrlResponse {
+    signedUrl: string;
+    filename: string;
+}
+export interface PortalAppointmentBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalUpdateAppointmentBookingQuestionsRequest {
+    answers: Record<string, unknown>;
+}
+export interface PortalUpdateAppointmentBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalCreateAppointmentBookingQuestionsUploadUrlRequest {
+    fieldId: string;
+    filename: string;
+    bytes: number;
+}
+export interface PortalCreateAppointmentBookingQuestionsUploadUrlResponse {
+    uploadId: string;
+    signedUrl: string;
+}
+export interface PortalFinalizeAppointmentBookingQuestionsUploadRequest {
+    fieldId: string;
+    uploadId: string;
+}
+export interface PortalFinalizeAppointmentBookingQuestionsUploadResponse {
+    answer: import("../../../../portal/types").BookingQuestionsDocumentAnswerValue;
+}
+export interface PortalEventBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalUpdateEventBookingQuestionsRequest {
+    answers: Record<string, unknown>;
+}
+export interface PortalUpdateEventBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalCreateEventBookingQuestionsUploadUrlRequest {
+    fieldId: string;
+    filename: string;
+    bytes: number;
+}
+export interface PortalCreateEventBookingQuestionsUploadUrlResponse {
+    uploadId: string;
+    signedUrl: string;
+}
+export interface PortalFinalizeEventBookingQuestionsUploadRequest {
+    fieldId: string;
+    uploadId: string;
+}
+export interface PortalFinalizeEventBookingQuestionsUploadResponse {
+    answer: import("../../../../portal/types").BookingQuestionsDocumentAnswerValue;
+}
+export interface PortalWholeSeriesBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalUpdateWholeSeriesBookingQuestionsRequest {
+    answers: Record<string, unknown>;
+}
+export interface PortalUpdateWholeSeriesBookingQuestionsResponse {
+    task: import("../../../../portal/types").BookingQuestionsTaskDetail;
+}
+export interface PortalCreateWholeSeriesBookingQuestionsUploadUrlRequest {
+    fieldId: string;
+    filename: string;
+    bytes: number;
+}
+export interface PortalCreateWholeSeriesBookingQuestionsUploadUrlResponse {
+    uploadId: string;
+    signedUrl: string;
+}
+export interface PortalFinalizeWholeSeriesBookingQuestionsUploadRequest {
+    fieldId: string;
+    uploadId: string;
+}
+export interface PortalFinalizeWholeSeriesBookingQuestionsUploadResponse {
+    answer: import("../../../../portal/types").BookingQuestionsDocumentAnswerValue;
+}
+export interface UpdateEventGuestsRequest {
+    guests: Array<{
+        name: string;
+        phone?: string | null;
+    }>;
+}
+export interface EventGuestsResponse {
+    guests: EventGuestType[];
+}
+export interface PortalCancelEventRegistrationRequest {
+    confirmCancelWithoutRefund?: boolean;
+}
+export interface PortalCancelWholeSeriesRegistrationRequest {
+    confirmCancelWithoutRefund?: boolean;
+}
+export interface PortalRescheduleAppointmentRequest {
+    startAt: string;
+    endAt: string;
+    resourceId: string;
+}
+export interface PortalRescheduleAppointmentResponse {
+    appointment: {
+        id: string;
+        status: string;
+        startAt: string;
+        endAt: string;
+        resourceId: string;
+    };
+}
+export interface PortalCancelAppointmentRequest {
+    confirmCancelWithoutRefund?: boolean;
+}
+export interface PortalCancelWholeSeriesRegistrationResult {
+    cancelled: boolean;
+    refunded: boolean;
+    refund?: PortalRefundInfo;
+    requiresCancelWithoutRefundConfirmation?: boolean;
+    message: string;
+}
+export interface PortalRefundInfo {
+    status: "succeeded" | "failed" | "skipped";
+    amountCents: number | null;
+    currency: string | null;
+    paymentLast4: string | null;
+    stripeRefundId: string | null;
+    errorMessage?: string;
+    errorCode?: string;
+}
+export interface PortalCancelEventRegistrationResult {
+    cancelled: boolean;
+    refunded: boolean;
+    refund?: PortalRefundInfo;
+    requiresCancelWithoutRefundConfirmation?: boolean;
+    message: string;
+}
+export interface PortalCancelAppointmentResult {
+    cancelled: boolean;
+    refunded: boolean;
+    refund?: PortalRefundInfo;
+    requiresCancelWithoutRefundConfirmation?: boolean;
+    failedToRestoreCredit?: boolean;
+    message: string;
+}
+export interface PortalTransferEventRegistrationRequest {
+    toEmail: string;
+    toName?: string;
+}
+export interface PortalTransferEventRegistrationResult {
+    transferred: boolean;
+    message: string;
+    transferId?: string;
+}
+export interface PortalCancelMembershipAtPeriodEndResult {
+    cancelled: boolean;
+    message: string;
+}