@riverbankcms/sdk 0.123.0 → 0.124.0

package/dist/_dts/api/src/publicExperience/commerceEndpoints.d.ts

@@ -0,0 +1,272 @@
+/**
+ * Public pass, membership, product, gifting, checkout and discount endpoints.
+ *
+ * Merged into `PublicExperienceAPIEndpoints` by `../publicExperienceEndpoints`.
+ */
+import type { APIEndpoint } from "../apiEndpointTypes";
+import type { DiscountsAvailableResponse, PublicDiscountContext } from "./sharedTypes";
+export type PublicCommerceAPIEndpoints = {
+    listPublicPasses: APIEndpoint<never, {
+        siteId: string;
+        categories?: string;
+    }, {
+        passes: Array<{
+            id: string;
+            productUseCase: "event_pass" | "appointment_package";
+            name: string;
+            description: string | null;
+            price: number;
+            currency: string;
+            creditsTotal: number;
+            pricePerCredit: number;
+            validDays: number | null;
+            eligibleCategoryIds: string[];
+            eligibleCategoryNames: string[];
+        }>;
+    }>;
+    listPublicMemberships: APIEndpoint<never, {
+        siteId: string;
+        categories?: string;
+    }, {
+        memberships: Array<{
+            id: string;
+            name: string;
+            description: string | null;
+            price: number;
+            currency: string;
+            billingInterval: "month" | "year";
+            eligibleCategoryIds: string[];
+            eligibleCategoryNames: string[];
+        }>;
+    }>;
+    listPublicProducts: APIEndpoint<never, {
+        siteId: string;
+        stage?: string;
+    } & ({
+        productCategoryScope?: undefined;
+        productCategoryId?: undefined;
+        productCategoryEntryId?: undefined;
+    } | {
+        productCategoryScope: "category";
+        productCategoryId: string;
+        productCategoryEntryId?: undefined;
+    } | {
+        productCategoryScope: "current-category-page";
+        productCategoryEntryId: string;
+        productCategoryId?: undefined;
+    }), {
+        products: Array<{
+            id: string;
+            contentEntryId: string | null;
+            title: string;
+            slug: string;
+            path: string | null;
+            status: "draft" | "active";
+            priceCents: number;
+            currency: string;
+            productType: "physical" | "digital";
+            requiresShipping: boolean;
+            hasVariants: boolean;
+            trackInventory: boolean;
+            soldOut: boolean;
+            category: {
+                id: string;
+                name: string;
+                slug: string;
+            } | null;
+            summary: string | null;
+            body: unknown;
+            gallery: Array<{
+                url: string;
+                alt: string | null;
+            }>;
+            variants: Array<{
+                id: string;
+                title: string;
+                sku: string | null;
+                priceCents: number;
+                stockQuantity: number | null;
+                soldOut: boolean;
+            }>;
+        }>;
+    }>;
+    listPublicGiftingOffers: APIEndpoint<never, {
+        siteId: string;
+    }, {
+        currency: string;
+        giftCards: Array<{
+            id: string;
+            kind: "gift_card";
+            title: string;
+            description: string | null;
+            sortOrder: number;
+            giftCard: {
+                fixedDenominations: number[];
+                customAmountEnabled: boolean;
+                customAmountMinCents: number;
+                customAmountMaxCents: number;
+            };
+            voucher: null;
+        }>;
+        vouchers: Array<{
+            id: string;
+            kind: "voucher";
+            title: string;
+            description: string | null;
+            sortOrder: number;
+            giftCard: null;
+            voucher: {
+                purchaseAmountCents: number;
+            };
+        }>;
+    }>;
+    createPublicGiftingCheckout: APIEndpoint<{
+        offerId: string;
+        purchaserName?: string | null;
+        purchaserEmail: string;
+        recipientName?: string | null;
+        recipientEmail: string;
+        message?: string | null;
+        amountCents?: number | null;
+        sendOnDate?: string | null;
+        successUrl: string;
+        cancelUrl: string;
+    }, {
+        siteId: string;
+    }, {
+        checkoutUrl: string;
+        sessionId: string;
+    }>;
+    claimGiftCardPublic: APIEndpoint<{
+        email: string;
+        token?: string | null;
+        code?: string | null;
+    }, {
+        siteId: string;
+    }, {
+        customerId: string;
+        amountCents: number;
+        currency: string;
+    }>;
+    createShopCheckout: APIEndpoint<{
+        productType: "pass" | "membership";
+        productId: string;
+        customerEmail: string;
+        customerName: string;
+        discountCode?: string;
+        successUrl: string;
+        cancelUrl: string;
+        confirmDuplicate?: boolean;
+    }, {
+        siteId: string;
+    }, {
+        type: "redirect";
+        checkoutUrl: string;
+        sessionId: string;
+    } | {
+        type: "bypassed";
+        sessionId: null;
+    } | {
+        type: "duplicate_membership_warning";
+        message: string;
+        existingMembership: {
+            id: string;
+            name: string;
+            expiresAt: string | null;
+        };
+    }>;
+    createUnifiedCheckout: APIEndpoint<{
+        mode: "one_time";
+        items: Array<{
+            type: "event_ticket";
+            occurrenceId: string;
+            ticketTypeId?: string;
+            selectedSlidingAmount?: number;
+            ticketCount: number;
+            attendeeInfo: {
+                email: string;
+                name: string;
+                formData?: Record<string, unknown>;
+            };
+        } | {
+            type: "product";
+            productId: string;
+            variantId?: string;
+            quantity: number;
+        } | {
+            type: "pass";
+            passId: string;
+        } | {
+            type: "course_enrollment";
+            eventSeriesId: string;
+            pricingOptionId?: string;
+            selectedSlidingAmount?: number;
+            attendeeInfo: {
+                email: string;
+                name: string;
+                formData?: Record<string, unknown>;
+            };
+        }>;
+        customer: {
+            email: string;
+            name: string;
+        };
+        discountCode?: string;
+        successUrl: string;
+        cancelUrl: string;
+    } | {
+        mode: "subscription";
+        membership: {
+            membershipId: string;
+        };
+        customer: {
+            email: string;
+            name: string;
+        };
+        discountCode?: string;
+        successUrl: string;
+        cancelUrl: string;
+    }, {
+        siteId: string;
+    }, {
+        type: "redirect";
+        checkoutUrl: string;
+        sessionId: string;
+        orderId: string | null;
+        orderNumber: string | null;
+    } | {
+        type: "bypassed";
+        orderId: string | null;
+        orderNumber: string | null;
+    }>;
+    getDiscountsAvailable: APIEndpoint<{
+        subtotalCents?: number;
+        context: PublicDiscountContext;
+    }, {
+        siteId: string;
+    }, DiscountsAvailableResponse>;
+    applyDiscountCode: APIEndpoint<{
+        discountCode: string;
+        customerEmail: string;
+        lines: Array<{
+            context: PublicDiscountContext;
+            subtotalCents: number;
+            currency: string;
+        }>;
+    }, {
+        siteId: string;
+    }, {
+        type: "applied";
+        code: string;
+        publicLabel: string;
+        description: string | null;
+        discountCents: number;
+        subtotalCents: number;
+        totalAfterDiscountCents: number;
+        currency: string;
+    } | {
+        type: "rejected";
+        reason: "invalid_or_not_applicable" | "unavailable" | "unknown";
+        message: string;
+    }>;
+};

package/dist/_dts/api/src/publicExperience/eventEndpoints.d.ts

@@ -0,0 +1,274 @@
+/**
+ * Storefront event discovery, registration, checkout and eligibility endpoints.
+ *
+ * Merged into `PublicExperienceAPIEndpoints` by `../publicExperienceEndpoints`.
+ */
+import type { APIEndpoint } from '../apiEndpointTypes';
+import type { PublicEventPricing } from '../../../core/src/index';
+import type { PublicEventDestination } from '../event-listing-destination';
+import type { BookingPaymentTermsConfig, BookingPricing, DirectCheckoutCollectionOptionKind, EventAttendanceMode, EventDeliveryMode, EventPricingMode, GenericEventPreset, PublicEventEligibilityTicketTypeRecord, PublicEventTicketTypeRecord } from '../bookingConfig';
+import type { PublicTeamMemberSummary } from '../teamMembers';
+import type { EventTicketLineSummaryResponse, EventTicketSelectionRequest, PublicEventLoaderParams, PublicEventRecurrence, PublicEventScheduleScope } from './sharedTypes';
+export type PublicEventAPIEndpoints = {
+    getPublicBookingCalendarFeedIcs: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+    listPublicEvents: APIEndpoint<never, {
+        siteId: string;
+        stage?: string;
+    } & PublicEventLoaderParams, Array<{
+        bookingScope: 'single_occurrence' | 'whole_series';
+        eventPreset?: GenericEventPreset;
+        eventDestinationMode?: import('../event-destination-policy').EventDestinationMode;
+        destination: PublicEventDestination;
+        scheduleScope?: Exclude<PublicEventScheduleScope, 'any'>;
+        recurrence?: PublicEventRecurrence;
+        id: string;
+        occurrenceId: string;
+        seriesId: string;
+        title: string;
+        description: string | null;
+        presentation?: {
+            title?: string | null;
+            summary?: string | null;
+            image?: {
+                type: 'image' | 'video' | 'audio';
+                purpose?: string;
+                placeholder?: boolean;
+                assetId?: string;
+                src?: string;
+                alt?: string;
+                width?: number;
+                height?: number;
+                storageBucket?: string;
+                storagePath?: string;
+                transform?: {
+                    rect?: [number, number, number, number];
+                    hotspot?: {
+                        x: number;
+                        y: number;
+                        radius?: number;
+                    };
+                };
+            } | null;
+        };
+        slug: string;
+        path: string | null;
+        requiresRegistration: boolean;
+        deliveryMode: EventDeliveryMode;
+        attendanceModes: Array<{
+            mode: EventAttendanceMode;
+            capacity: number | null;
+            registeredCount: number;
+            availableSpots: number | null;
+            waitlistEnabled: boolean;
+        }>;
+        startsAt: string;
+        endsAt: string;
+        capacity: number | null;
+        registeredCount: number;
+        availableSpots: number | null;
+        waitlistEnabled: boolean;
+        venue: {
+            id: string;
+            name: string;
+            address: string | null;
+            location: {
+                lat: number;
+                lng: number;
+            } | null;
+        } | null;
+        eventCategory: {
+            id: string;
+            name: string;
+            color: string | null;
+        } | null;
+        teamMembers?: PublicTeamMemberSummary[];
+        status?: 'active' | 'draft' | 'archived';
+        pricing: PublicEventPricing<PublicEventTicketTypeRecord>;
+        paymentTerms: BookingPaymentTermsConfig;
+        accessRestriction: 'none' | 'category';
+        allowedCategoryIds: string[];
+        requireGuestDetails?: boolean;
+        timeZone: string;
+        acceptsPasses?: boolean;
+        acceptsMemberships?: boolean;
+        wholeSeries?: {
+            eventSeriesId: string;
+            pricing: BookingPricing;
+            currency: string;
+            enrollmentOpen: boolean;
+        } | null;
+    }>>;
+    getPublicEventFilters: APIEndpoint<never, {
+        siteId: string;
+        stage?: string;
+        categoryIds?: string;
+        venueId?: string;
+        staffMemberId?: string;
+        eventSurface?: string;
+        eventPresets?: string;
+        scheduleScope?: string;
+    }, {
+        categories: Array<{
+            id: string;
+            name: string;
+            identifier: string | null;
+            color: string | null;
+            upcomingCount: number;
+        }>;
+        venues: Array<{
+            id: string;
+            name: string;
+            upcomingCount: number;
+        }>;
+        staffMembers: Array<{
+            id: string;
+            name: string;
+            upcomingCount: number;
+        }>;
+    }>;
+    resolveEventOccurrence: APIEndpoint<never, {
+        siteId: string;
+        eventSeriesIds: string;
+        segment: string;
+    }, {
+        occurrence: {
+            id: string;
+            seriesId: string;
+            startsAt: string;
+            endsAt: string;
+            timeZone: string;
+            status: string;
+            capacityOverride: number | null;
+            overridesJson: Record<string, unknown>;
+        } | null;
+    }>;
+    registerForEvent: APIEndpoint<{
+        occurrenceId: string;
+        attendanceMode?: EventAttendanceMode;
+        selectedSlidingAmount?: number;
+        email: string;
+        name: string;
+        ticketSelections: EventTicketSelectionRequest[];
+        phone?: string;
+        notes?: string;
+        formData?: Record<string, unknown>;
+        altchaSolution?: string | null;
+        stage?: 'preview' | 'published';
+        paymentMethod?: 'free' | 'pass' | 'membership' | 'stripe' | 'pass_bundle' | 'membership_bundle';
+        customerPassId?: string;
+        customerMembershipId?: string;
+        bundleProductId?: string;
+        claimToken?: string;
+        guests?: Array<{
+            name: string;
+            email?: string | null;
+            phone?: string | null;
+        }>;
+    }, {
+        siteId: string;
+    }, {
+        success: boolean;
+        attendeeId: string;
+        status: 'confirmed';
+        paymentMethod: 'free' | 'pass' | 'membership' | 'stripe' | 'pass_bundle' | 'membership_bundle';
+        pendingPayment: boolean;
+        passCreditsUsed?: number;
+        passCreditsRemaining?: number;
+        alreadyRegistered?: boolean;
+        ticketLines: EventTicketLineSummaryResponse[];
+        message: string;
+    } | {
+        success: boolean;
+        attendeeId: string;
+        status: 'waitlist';
+        waitlistPosition: number | null;
+        alreadyRegistered?: boolean;
+        message: string;
+    }>;
+    createPublicEventCheckout: APIEndpoint<{
+        attendeeId: string;
+        checkoutType?: 'event' | 'pass_bundle' | 'membership_bundle';
+        productId?: string;
+        discountCode?: string;
+        collectionOptionKind?: DirectCheckoutCollectionOptionKind;
+        successUrl: string;
+        cancelUrl: string;
+    }, {
+        siteId: string;
+    }, {
+        checkoutUrl: string | null;
+        sessionId: string | null;
+        bypassed: boolean;
+    }>;
+    checkPublicEventEligibility: APIEndpoint<{
+        occurrenceId: string;
+        attendanceMode?: EventAttendanceMode;
+        email: string;
+        ticketSelections: EventTicketSelectionRequest[];
+        selectedSlidingAmount?: number;
+    }, {
+        siteId: string;
+    }, {
+        customerExists: boolean;
+        eligibility: {
+            isFull: boolean;
+            waitlistEnabled: boolean;
+            canJoinWaitlist: boolean;
+            membership: {
+                customerMembershipId: string;
+                membershipName: string;
+            } | null;
+            passes: Array<{
+                customerPassId: string;
+                passName: string;
+                creditsRemaining: number;
+            }>;
+            requiresPayment: boolean;
+            pricingMode?: EventPricingMode;
+            selectedTicketTypeId?: string | null;
+            ticketLines: EventTicketLineSummaryResponse[];
+            ticketTypes?: PublicEventEligibilityTicketTypeRecord[];
+            eventPrice: number | null;
+            eventPriceCurrency: string | null;
+            eventAcceptsPasses: boolean;
+            eventAcceptsMemberships: boolean;
+            requiresAuthForPasses: boolean;
+            requiresAuthForMemberships: boolean;
+            availableForPurchase: {
+                passes: Array<{
+                    id: string;
+                    name: string;
+                    description: string | null;
+                    price: number;
+                    currency: string;
+                    creditsTotal: number;
+                    pricePerCredit: number;
+                    validDays: number | null;
+                }>;
+                memberships: Array<{
+                    id: string;
+                    name: string;
+                    description: string | null;
+                    price: number;
+                    currency: string;
+                    interval: 'month' | 'year';
+                }>;
+            };
+        };
+    }>;
+    getPublicEventRegistrationStatus: APIEndpoint<never, {
+        siteId: string;
+        attendeeId: string;
+    }, {
+        paymentStatus: 'not_required' | 'pending' | 'completed' | 'failed' | 'refunded';
+        attendeeStatus: 'confirmed' | 'waitlist' | 'cancelled';
+        waitlistPosition: number | null;
+    }>;
+    getPublicEventTicketQrSvg: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+};

package/dist/_dts/api/src/publicExperience/newsletterEndpoints.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Public newsletter subscription, confirmation and archive endpoints.
+ *
+ * Merged into `PublicExperienceAPIEndpoints` by `../publicExperienceEndpoints`.
+ */
+import type { APIEndpoint } from "../apiEndpointTypes";
+import type { NewsletterSubscribeBody } from "./sharedTypes";
+export type PublicNewsletterAPIEndpoints = {
+    subscribeNewsletter: APIEndpoint<NewsletterSubscribeBody, {
+        siteId: string;
+    }, {
+        subscribed: true;
+        requiresConfirmation?: boolean;
+    }>;
+    confirmNewsletter: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+    unsubscribeNewsletter: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+    unsubscribeNewsletterPost: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+    getNewsletterArchive: APIEndpoint<never, {
+        siteId: string;
+        token: string;
+    }, string>;
+};