@riverbankcms/sdk 0.121.0 → 0.124.0

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

@@ -0,0 +1,435 @@
+export declare const APPOINTMENT_ENDPOINT_DEFINITIONS: {
+    listAppointmentResources: {
+        path: "/sites/{siteId}/bookings/resources";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    createAppointmentResource: {
+        path: "/sites/{siteId}/bookings/resources";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "billing:plan_limit_exceeded" | "server:internal_error")[];
+    };
+    createAppointmentResourceWithAccountAccess: {
+        path: "/sites/{siteId}/bookings/resources/account-access";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "validation:invalid_input" | "resource:not_found" | "resource:conflict" | "billing:plan_limit_exceeded" | "server:internal_error")[];
+    };
+    getAppointmentResource: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    updateAppointmentResource: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    removeAppointmentResource: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    listAppointmentReservations: {
+        path: "/sites/{siteId}/bookings/appointment-reservations";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: never[];
+    };
+    createAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    getAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    updateAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    pauseAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}/pause";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    resumeAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}/resume";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    endAppointmentReservation: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}/end";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    previewAppointmentReservationRun: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}/run-preview";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    createAppointmentReservationRun: {
+        path: "/sites/{siteId}/bookings/appointment-reservations/{reservationId}/runs";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    createTeamMemberProfile: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    updateTeamMemberProfilePolicy: {
+        path: "/sites/{siteId}/bookings/resources/profile-policy";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "server:internal_error")[];
+    };
+    updateTeamMemberProfileContent: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/content";
+        method: "PUT";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    publishTeamMemberProfile: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/publish";
+        method: "POST";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    discardTeamMemberProfileDraft: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/discard";
+        method: "POST";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    unpublishTeamMemberProfile: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/unpublish";
+        method: "POST";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    scheduleTeamMemberProfile: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/schedule";
+        method: "POST";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    cancelScheduledTeamMemberProfile: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/{entryId}/schedule";
+        method: "DELETE";
+        tags: ("site-{siteId}" | "content-{siteId}-team-member" | "content-entry-{entryId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    updateTeamMemberProfileRouteMetadata: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/profile/routes/{routeId}/metadata";
+        method: "PATCH";
+        tags: ("riverbank:site" | "riverbank:site:{siteId}:routable-content" | "riverbank:route:{routeId}")[];
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+    listAppointmentServices: {
+        path: "/sites/{siteId}/bookings/services";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    exportAppointmentServicesCsv: {
+        path: "/sites/{siteId}/bookings/services/export.csv";
+        method: "GET";
+        tags: ("site-{siteId}" | "bookings" | "appointment-services-{siteId}")[];
+        errors: never[];
+        auth: "user";
+        responseKind: "blob";
+    };
+    createAppointmentService: {
+        path: "/sites/{siteId}/bookings/services";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "server:internal_error")[];
+    };
+    getAppointmentService: {
+        path: "/sites/{siteId}/bookings/services/{serviceId}";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    updateAppointmentService: {
+        path: "/sites/{siteId}/bookings/services/{serviceId}";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    deleteAppointmentService: {
+        path: "/sites/{siteId}/bookings/services/{serviceId}";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    getAppointmentSetup: {
+        path: "/sites/{siteId}/bookings/appointment-setup";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: "server:internal_error"[];
+    };
+    applyAppointmentSetup: {
+        path: "/sites/{siteId}/bookings/appointment-setup";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "server:internal_error")[];
+    };
+    getAppointmentServicesReference: {
+        path: "/sites/{siteId}/bookings/services/reference";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    getAppointmentResourcesReference: {
+        path: "/sites/{siteId}/bookings/resources/reference";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    getResourceServices: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/services";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    updateResourceServices: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/services";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+    };
+    getServiceResources: {
+        path: "/sites/{siteId}/bookings/services/{serviceId}/resources";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    updateServiceResources: {
+        path: "/sites/{siteId}/bookings/services/{serviceId}/resources";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+    };
+    listAvailabilityRules: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/availability";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    setWeeklyAvailability: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/weekly-availability";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    setServiceSpecificAvailability: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/service-availability";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    deleteServiceSpecificAvailability: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/service-availability/{scheduleId}";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    listBlackouts: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/blackouts";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    createBlackout: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/blackouts";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    deleteBlackout: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/blackouts/{blackoutId}";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("resource:not_found" | "server:internal_error")[];
+    };
+    getCalendarStatus: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "server:internal_error")[];
+    };
+    updateCalendarPreferences: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    disconnectCalendar: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    getResourceCalendarFeed: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar/feed";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    regenerateResourceCalendarFeed: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar/feed";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    revokeResourceCalendarFeed: {
+        path: "/sites/{siteId}/bookings/resources/{resourceId}/calendar/feed";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    getVenueCalendarFeed: {
+        path: "/sites/{siteId}/bookings/venues/{venueId}/calendar/feed";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    regenerateVenueCalendarFeed: {
+        path: "/sites/{siteId}/bookings/venues/{venueId}/calendar/feed";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    revokeVenueCalendarFeed: {
+        path: "/sites/{siteId}/bookings/venues/{venueId}/calendar/feed";
+        method: "DELETE";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "resource:not_found" | "server:internal_error")[];
+    };
+    googleCalendarAuthorize: {
+        path: "/sites/{siteId}/bookings/calendar/google/authorize";
+        method: "GET";
+        auth: "user";
+        responseKind: "void";
+    };
+    googleCalendarCallback: {
+        path: "/bookings/calendar/google/callback";
+        method: "GET";
+        auth: "user";
+        responseKind: "void";
+    };
+    getAvailableSlots: {
+        path: "/sites/{siteId}/bookings/availability/slots";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    listAppointments: {
+        path: "/sites/{siteId}/bookings/appointments";
+        method: "GET";
+        auth: "user";
+        responseKind: "json";
+    };
+    exportBookingAppointmentsCsv: {
+        path: "/sites/{siteId}/bookings/appointments/export.csv";
+        method: "GET";
+        auth: "user";
+        errors: never[];
+        responseKind: "blob";
+    };
+    createAppointment: {
+        path: "/sites/{siteId}/bookings/appointments";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+    };
+    upsertBookingRequirementConfig: {
+        path: "/sites/{siteId}/bookings/requirements/config";
+        method: "PUT";
+        auth: "user";
+        responseKind: "json";
+        errors: ("validation:invalid_input" | "resource:not_found" | "server:internal_error")[];
+    };
+    cancelAppointment: {
+        path: "/sites/{siteId}/bookings/appointments/{appointmentId}/cancel";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+    };
+    rescheduleAppointment: {
+        path: "/sites/{siteId}/bookings/appointments/{appointmentId}/reschedule";
+        method: "POST";
+        auth: "user";
+        responseKind: "json";
+        errors: ("auth:forbidden" | "validation:invalid_input" | "resource:not_found" | "resource:conflict" | "server:internal_error")[];
+    };
+};

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

@@ -23,10 +23,10 @@ export type BookingClosureImpactConfirmation = {
 };
 export type BookingClosureManualReviewReason = "spans_closure" | "partial_overlap" | "hybrid_venue_scope" | "existing_appointment" | "appointment_scope_unclear" | "in_progress";
 export type BookingClosureAutoCancelReason = "fully_contained_site_closure" | "fully_contained_venue_closure";
-export type BookingClosureAffectedItemKind = "event_occurrence" | "course_session" | "appointment";
+export type BookingClosureAffectedItemKind = "event_occurrence" | "whole_series" | "appointment";
 export type BookingClosureAutoCancelItem = {
     disposition: "auto_cancel";
-    itemKind: "event_occurrence" | "course_session";
+    itemKind: "event_occurrence" | "whole_series";
     itemId: string;
     occurrenceId: string;
     seriesId: string;
@@ -55,7 +55,7 @@ export type BookingClosureImpactSummary = {
     autoCancelCount: number;
     manualReviewCount: number;
     affectedAttendeeCount: number;
-    courseSessionCount: number;
+    wholeSeriesOccurrenceCount: number;
     eventOccurrenceCount: number;
     appointmentCount: number;
 };