@atzentis/booking-sdk 0.1.5 → 0.1.6

package/dist/index.d.cts

@@ -538,6 +538,478 @@ declare class AvailabilityService extends BaseService {
     getPricing(params: PricingParams): Promise<PricingResult>;
 }
 
+/**
+ * All supported booking types across the three verticals.
+ *
+ * - **Stays:** `stay`, `dayuse`
+ * - **Tables:** `table`
+ * - **Services:** `service`
+ * - **Universal:** `parking`, `desk`, `meeting`, `custom`
+ */
+type BookingType = "stay" | "table" | "service" | "parking" | "desk" | "meeting" | "dayuse" | "custom";
+/** All 8 booking types as a readonly tuple for runtime enumeration */
+declare const BOOKING_TYPES: readonly ["stay", "table", "service", "parking", "desk", "meeting", "dayuse", "custom"];
+/**
+ * Booking lifecycle statuses.
+ *
+ * State machine:
+ * ```
+ * pending ──→ confirmed ──→ checked_in ──→ checked_out
+ *    │             │              │
+ *    ├─→ cancelled ├─→ cancelled  ├─→ cancelled
+ *    ├─→ waitlist   └─→ no_show   └─→ no_show
+ *    └─→ no_show
+ * ```
+ */
+type BookingStatus = "pending" | "confirmed" | "checked_in" | "checked_out" | "cancelled" | "no_show" | "waitlist";
+/** All 7 booking statuses as a readonly tuple for runtime enumeration */
+declare const BOOKING_STATUSES: readonly ["pending", "confirmed", "checked_in", "checked_out", "cancelled", "no_show", "waitlist"];
+/** Guest summary embedded in a booking */
+interface BookingGuest {
+    /** Guest identifier */
+    id: string;
+    /** Guest first name */
+    firstName: string;
+    /** Guest last name */
+    lastName: string;
+    /** Guest email address */
+    email: string | null;
+    /** Guest phone number */
+    phone: string | null;
+}
+/** Space summary embedded in a booking */
+interface BookingSpace {
+    /** Space identifier */
+    id: string;
+    /** Display name of the space */
+    name: string;
+    /** Space type (room, table, service, etc.) */
+    type: SpaceType;
+    /** Category the space belongs to */
+    categoryId: string | null;
+    /** Floor the space is on */
+    floor: string | null;
+}
+/** Pricing breakdown for a booking */
+interface BookingPricing {
+    /** Total price in cents */
+    total: number;
+    /** Per-night rate in cents, null for non-Stays verticals */
+    perNight: number | null;
+    /** ISO 4217 currency code (e.g., "EUR", "USD") */
+    currency: string;
+    /** Tax amount in cents */
+    taxes: number;
+    /** Fee amount in cents */
+    fees: number;
+}
+/** A booking in the Atzentis Booking system */
+interface Booking {
+    /** Booking identifier */
+    id: string;
+    /** Human-readable confirmation code */
+    confirmationCode: string;
+    /** Property this booking belongs to */
+    propertyId: string;
+    /** Category for the booked space */
+    categoryId: string | null;
+    /** Guest who made the booking */
+    guestId: string;
+    /** Assigned space, null until assigned */
+    spaceId: string | null;
+    /** Booking type */
+    type: BookingType;
+    /** Current lifecycle status */
+    status: BookingStatus;
+    /** Check-in date in YYYY-MM-DD format */
+    checkIn: string;
+    /** Check-out date in YYYY-MM-DD format */
+    checkOut: string;
+    /** Number of guests */
+    guests: number;
+    /** Free-text notes */
+    notes: string | null;
+    /** Booking source (e.g., "website", "phone", "walk-in") */
+    source: string | null;
+    /** Rate plan identifier */
+    rateId: string | null;
+    /** Open bag for custom data */
+    metadata: Record<string, unknown> | null;
+    /** Guest summary */
+    guest: BookingGuest | null;
+    /** Assigned space summary */
+    space: BookingSpace | null;
+    /** Pricing breakdown */
+    pricing: BookingPricing | null;
+    /** When the booking was confirmed */
+    confirmedAt: string | null;
+    /** When the guest checked in */
+    checkedInAt: string | null;
+    /** When the guest checked out */
+    checkedOutAt: string | null;
+    /** When the booking was cancelled */
+    cancelledAt: string | null;
+    /** Cancellation reason, populated on cancel */
+    cancellationReason: string | null;
+    /** When the booking was marked as no-show */
+    noShowAt: string | null;
+    /** Record creation timestamp */
+    createdAt: string;
+    /** Record last-update timestamp */
+    updatedAt: string;
+}
+/** Input for creating a new booking */
+interface CreateBookingInput {
+    /** Property to create the booking for */
+    propertyId: string;
+    /** Category for the booked space */
+    categoryId: string;
+    /** Guest identifier */
+    guestId: string;
+    /** Check-in date in YYYY-MM-DD format */
+    checkIn: string;
+    /** Check-out date in YYYY-MM-DD format */
+    checkOut: string;
+    /** Booking type */
+    type: BookingType;
+    /** Number of guests */
+    guests?: number;
+    /** Assign a specific space */
+    spaceId?: string;
+    /** Free-text notes */
+    notes?: string;
+    /** Booking source */
+    source?: string;
+    /** Rate plan identifier */
+    rateId?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+    /** Auto-confirm the booking on creation */
+    autoConfirm?: boolean;
+}
+/** Input for updating an existing booking — all fields optional */
+interface UpdateBookingInput {
+    /** Update the category */
+    categoryId?: string;
+    /** Update check-in date */
+    checkIn?: string;
+    /** Update check-out date */
+    checkOut?: string;
+    /** Update number of guests */
+    guests?: number;
+    /** Update notes */
+    notes?: string;
+    /** Update source */
+    source?: string;
+    /** Update rate plan */
+    rateId?: string;
+    /** Update metadata */
+    metadata?: Record<string, unknown>;
+}
+/** Input for check-in operation */
+interface CheckInInput {
+    /** Actual arrival time in ISO 8601 format */
+    actualArrival?: string;
+    /** Check-in notes */
+    notes?: string;
+    /** Assign or change space at check-in */
+    spaceId?: string;
+}
+/** Input for check-out operation */
+interface CheckOutInput {
+    /** Actual departure time in ISO 8601 format */
+    actualDeparture?: string;
+    /** Check-out notes */
+    notes?: string;
+}
+/** Input for cancel operation */
+interface CancelBookingInput {
+    /** Cancellation reason (required) */
+    reason: string;
+    /** Who cancelled the booking */
+    cancelledBy?: string;
+    /** Whether a refund was requested */
+    refundRequested?: boolean;
+}
+/** Input for no-show operation */
+interface NoShowInput {
+    /** No-show notes */
+    notes?: string;
+    /** Whether to charge a no-show fee */
+    chargeNoShowFee?: boolean;
+}
+/** Input for space assignment */
+interface AssignSpaceInput {
+    /** Space to assign (required) */
+    spaceId: string;
+    /** Assignment notes */
+    notes?: string;
+}
+/** Sort configuration for booking list queries */
+interface BookingSort {
+    /** Field to sort by */
+    field: "checkIn" | "checkOut" | "createdAt" | "updatedAt" | "status";
+    /** Sort direction */
+    direction: "asc" | "desc";
+}
+/** Query parameters for listing bookings */
+interface ListBookingsParams {
+    /** Property to list bookings for (required) */
+    propertyId: string;
+    /** Filter by status (single or array) */
+    status?: BookingStatus | BookingStatus[];
+    /** Filter by type (single or array) */
+    type?: BookingType | BookingType[];
+    /** Filter by guest */
+    guestId?: string;
+    /** Filter by check-in date (from) */
+    checkInFrom?: string;
+    /** Filter by check-in date (to) */
+    checkInTo?: string;
+    /** Filter by check-out date (from) */
+    checkOutFrom?: string;
+    /** Filter by check-out date (to) */
+    checkOutTo?: string;
+    /** Search by confirmation code or guest name */
+    search?: string;
+    /** Sort configuration */
+    sort?: BookingSort;
+    /** Maximum results per page */
+    limit?: number;
+    /** Pagination cursor */
+    cursor?: string;
+}
+/** Paginated list of bookings */
+interface PaginatedBookings {
+    /** Bookings in this page */
+    data: Booking[];
+    /** Total number of matching bookings */
+    totalCount: number;
+    /** Cursor for next page, null if no more results */
+    cursor: string | null;
+    /** Whether more results are available */
+    hasMore: boolean;
+}
+
+/**
+ * Service for managing bookings in the Atzentis Booking API.
+ *
+ * Provides full CRUD operations and lifecycle management across all
+ * 8 booking types (stay, table, service, parking, desk, meeting, dayuse, custom)
+ * and 7 statuses (pending, confirmed, checked_in, checked_out, cancelled, no_show, waitlist).
+ *
+ * **Lifecycle state machine:**
+ * ```
+ * pending ──→ confirmed ──→ checked_in ──→ checked_out
+ *    │             │              │
+ *    ├─→ cancelled ├─→ cancelled  ├─→ cancelled
+ *    ├─→ waitlist   └─→ no_show   └─→ no_show
+ *    └─→ no_show
+ * ```
+ *
+ * @example
+ * ```typescript
+ * const booking = new BookingClient({ apiKey: "atz_io_live_xxxxx" });
+ *
+ * // Create a stay booking
+ * const newBooking = await booking.bookings.create({
+ *   propertyId: "prop_abc123",
+ *   categoryId: "cat_deluxe",
+ *   guestId: "guest_42",
+ *   checkIn: "2025-07-01",
+ *   checkOut: "2025-07-05",
+ *   type: "stay",
+ * });
+ *
+ * // Lifecycle: confirm → check-in → check-out
+ * await booking.bookings.confirm(newBooking.id);
+ * await booking.bookings.checkIn(newBooking.id);
+ * await booking.bookings.checkOut(newBooking.id);
+ * ```
+ */
+declare class BookingsService extends BaseService {
+    protected readonly basePath = "/booking/v1/bookings";
+    /**
+     * Create a new booking.
+     *
+     * @example
+     * ```typescript
+     * const booking = await client.bookings.create({
+     *   propertyId: "prop_abc123",
+     *   categoryId: "cat_deluxe",
+     *   guestId: "guest_42",
+     *   checkIn: "2025-07-01",
+     *   checkOut: "2025-07-05",
+     *   type: "stay",
+     *   guests: 2,
+     *   autoConfirm: true,
+     * });
+     * ```
+     */
+    create(input: CreateBookingInput): Promise<Booking>;
+    /**
+     * Get a single booking by ID.
+     *
+     * @example
+     * ```typescript
+     * const booking = await client.bookings.get("bk_abc123");
+     * ```
+     */
+    get(bookingId: string): Promise<Booking>;
+    /**
+     * List bookings for a property with optional filters and cursor-based pagination.
+     *
+     * Supports filtering by status, type, guest, date ranges, search term,
+     * and custom sort order. Array values for `status` and `type` are serialized
+     * as comma-separated strings.
+     *
+     * @example
+     * ```typescript
+     * // List all confirmed stay bookings
+     * const page = await client.bookings.list({
+     *   propertyId: "prop_abc123",
+     *   status: "confirmed",
+     *   type: "stay",
+     * });
+     *
+     * // Multi-status filter with date range
+     * const page2 = await client.bookings.list({
+     *   propertyId: "prop_abc123",
+     *   status: ["confirmed", "checked_in"],
+     *   checkInFrom: "2025-07-01",
+     *   checkInTo: "2025-07-31",
+     *   sort: { field: "checkIn", direction: "asc" },
+     *   limit: 20,
+     * });
+     * ```
+     */
+    list(params: ListBookingsParams): Promise<PaginatedBookings>;
+    /**
+     * Update an existing booking.
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.bookings.update("bk_abc123", {
+     *   guests: 3,
+     *   notes: "Extra bed requested",
+     * });
+     * ```
+     */
+    update(bookingId: string, input: UpdateBookingInput): Promise<Booking>;
+    /**
+     * Delete a booking.
+     *
+     * @example
+     * ```typescript
+     * await client.bookings.delete("bk_abc123");
+     * ```
+     */
+    delete(bookingId: string): Promise<void>;
+    /**
+     * Confirm a pending booking.
+     *
+     * Transitions: `pending` → `confirmed`
+     *
+     * @throws {ConflictError} 409 if the booking is not in `pending` status
+     *
+     * @example
+     * ```typescript
+     * const confirmed = await client.bookings.confirm("bk_abc123");
+     * // confirmed.status === "confirmed"
+     * // confirmed.confirmedAt is populated
+     * ```
+     */
+    confirm(bookingId: string): Promise<Booking>;
+    /**
+     * Check in a guest.
+     *
+     * Transitions: `confirmed` → `checked_in`
+     *
+     * @throws {ConflictError} 409 if the booking is not in `confirmed` status
+     *
+     * @example
+     * ```typescript
+     * const checkedIn = await client.bookings.checkIn("bk_abc123", {
+     *   actualArrival: "2025-07-01T14:30:00Z",
+     * });
+     * // checkedIn.status === "checked_in"
+     * // checkedIn.checkedInAt is populated
+     * ```
+     */
+    checkIn(bookingId: string, input?: CheckInInput): Promise<Booking>;
+    /**
+     * Check out a guest.
+     *
+     * Transitions: `checked_in` → `checked_out`
+     *
+     * @throws {ConflictError} 409 if the booking is not in `checked_in` status
+     *
+     * @example
+     * ```typescript
+     * const checkedOut = await client.bookings.checkOut("bk_abc123", {
+     *   actualDeparture: "2025-07-05T11:00:00Z",
+     * });
+     * // checkedOut.status === "checked_out"
+     * // checkedOut.checkedOutAt is populated
+     * ```
+     */
+    checkOut(bookingId: string, input?: CheckOutInput): Promise<Booking>;
+    /**
+     * Cancel a booking.
+     *
+     * Transitions: `pending` | `confirmed` | `checked_in` → `cancelled`
+     *
+     * @throws {ConflictError} 409 if the booking is already cancelled, checked out, or no-show
+     *
+     * @example
+     * ```typescript
+     * const cancelled = await client.bookings.cancel("bk_abc123", {
+     *   reason: "Guest requested cancellation",
+     *   refundRequested: true,
+     * });
+     * // cancelled.status === "cancelled"
+     * // cancelled.cancelledAt is populated
+     * // cancelled.cancellationReason === "Guest requested cancellation"
+     * ```
+     */
+    cancel(bookingId: string, input: CancelBookingInput): Promise<Booking>;
+    /**
+     * Mark a booking as no-show.
+     *
+     * Transitions: `pending` | `confirmed` | `checked_in` → `no_show`
+     *
+     * @throws {ConflictError} 409 if the booking is already checked out, cancelled, or no-show
+     *
+     * @example
+     * ```typescript
+     * const noShow = await client.bookings.noShow("bk_abc123", {
+     *   chargeNoShowFee: true,
+     * });
+     * // noShow.status === "no_show"
+     * // noShow.noShowAt is populated
+     * ```
+     */
+    noShow(bookingId: string, input?: NoShowInput): Promise<Booking>;
+    /**
+     * Assign or reassign a space to a booking.
+     *
+     * Can be called on any active booking (pending, confirmed, checked_in).
+     *
+     * @throws {ConflictError} 409 if the booking is in a terminal status
+     *
+     * @example
+     * ```typescript
+     * const assigned = await client.bookings.assignSpace("bk_abc123", {
+     *   spaceId: "spc_room101",
+     *   notes: "Upgraded to deluxe",
+     * });
+     * // assigned.spaceId === "spc_room101"
+     * // assigned.space is populated
+     * ```
+     */
+    assignSpace(bookingId: string, input: AssignSpaceInput): Promise<Booking>;
+}
+
 /** All supported property types in the v4.0 API */
 type PropertyType = "hotel" | "resort" | "villa" | "apartment" | "hostel" | "bnb" | "restaurant" | "cafe" | "bar" | "beach" | "spa" | "salon" | "custom";
 /** Property lifecycle status */
@@ -945,12 +1417,15 @@ declare class SpacesService extends BaseService {
 declare class BookingClient {
     readonly httpClient: HttpClient;
     private _availability?;
+    private _bookings?;
     private _properties?;
     private _categories?;
     private _spaces?;
     constructor(config: BookingClientConfig);
     /** Availability service — lazy-initialized on first access */
     get availability(): AvailabilityService;
+    /** Bookings service — lazy-initialized on first access */
+    get bookings(): BookingsService;
     /** Properties service — lazy-initialized on first access */
     get properties(): PropertiesService;
     /** Categories service — lazy-initialized on first access */
@@ -1039,4 +1514,4 @@ declare function firstPage<T>(fetcher: PageFetcher<T>, options?: PaginationOptio
 
 declare const VERSION = "0.1.0";
 
-export { AuthenticationError, type AvailabilityCheckParams, type AvailabilityPricing, type AvailabilityRestrictions, type AvailabilityResult, type AvailabilitySearchParams, type AvailabilitySearchResult, type AvailabilitySearchResultEntry, AvailabilityService, type AvailableSpace, BookingClient, type BookingClientConfig, BookingError, type BookingErrorOptions, type BulkUpdateSpaceInput, type CalendarDay, type CalendarParams, CategoriesService, ConflictError, type Coordinates, type CreateCategoryInput, type CreatePropertyInput, type CreateSpaceInput, DEFAULT_MODULES, ForbiddenError, HttpClient, type HttpClientOptions, type HttpMethod, type HttpResponse, type LinkPosTableInput, type ListCategoriesParams, type ListPropertiesParams, type ListSpacesParams, type Logger, NotFoundError, PROPERTY_MODULES, type PageFetcher, type Paginated, type PaginationOptions, PaymentError, type PriceRange, type PricingParams, type PricingResult, PropertiesService, type Property, type PropertyAddress, type PropertyModules, type PropertyStatus, type PropertyType, RateLimitError, type RequestOptions, type ResolvedBookingClientConfig, type RetryConfig, type RetryOptions, SPACE_STATUSES, SPACE_TYPES, ServerError, type ServiceSlotParams, type ServiceTimeSlot, type Space, type SpaceCategory, type SpaceStatus, type SpaceType, SpacesService, type TableSlotParams, type TimeSlot, TimeoutError, type UpdateCategoryInput, type UpdatePropertyInput, type UpdateSpaceInput, VERSION, ValidationError, bookingClientConfigSchema, createErrorFromResponse, firstPage, paginate };
+export { type AssignSpaceInput, AuthenticationError, type AvailabilityCheckParams, type AvailabilityPricing, type AvailabilityRestrictions, type AvailabilityResult, type AvailabilitySearchParams, type AvailabilitySearchResult, type AvailabilitySearchResultEntry, AvailabilityService, type AvailableSpace, BOOKING_STATUSES, BOOKING_TYPES, type Booking, BookingClient, type BookingClientConfig, BookingError, type BookingErrorOptions, type BookingGuest, type BookingPricing, type BookingSort, type BookingSpace, type BookingStatus, type BookingType, BookingsService, type BulkUpdateSpaceInput, type CalendarDay, type CalendarParams, type CancelBookingInput, CategoriesService, type CheckInInput, type CheckOutInput, ConflictError, type Coordinates, type CreateBookingInput, type CreateCategoryInput, type CreatePropertyInput, type CreateSpaceInput, DEFAULT_MODULES, ForbiddenError, HttpClient, type HttpClientOptions, type HttpMethod, type HttpResponse, type LinkPosTableInput, type ListBookingsParams, type ListCategoriesParams, type ListPropertiesParams, type ListSpacesParams, type Logger, type NoShowInput, NotFoundError, PROPERTY_MODULES, type PageFetcher, type Paginated, type PaginatedBookings, type PaginationOptions, PaymentError, type PriceRange, type PricingParams, type PricingResult, PropertiesService, type Property, type PropertyAddress, type PropertyModules, type PropertyStatus, type PropertyType, RateLimitError, type RequestOptions, type ResolvedBookingClientConfig, type RetryConfig, type RetryOptions, SPACE_STATUSES, SPACE_TYPES, ServerError, type ServiceSlotParams, type ServiceTimeSlot, type Space, type SpaceCategory, type SpaceStatus, type SpaceType, SpacesService, type TableSlotParams, type TimeSlot, TimeoutError, type UpdateBookingInput, type UpdateCategoryInput, type UpdatePropertyInput, type UpdateSpaceInput, VERSION, ValidationError, bookingClientConfigSchema, createErrorFromResponse, firstPage, paginate };