@atzentis/booking-sdk 0.1.4 → 0.1.5

package/dist/index.d.cts

@@ -94,6 +94,277 @@ declare class HttpClient {
     private buildHeaders;
 }
 
+/**
+ * All supported space types in the v4.0 API.
+ *
+ * Grouped by vertical:
+ * - **Stays:** `room`, `sunbed`, `parking`
+ * - **Tables:** `table`, `locker`
+ * - **Services:** `service`, `meeting_room`, `desk`
+ * - **Universal:** `custom`
+ */
+type SpaceType = "room" | "table" | "sunbed" | "parking" | "desk" | "meeting_room" | "locker" | "service" | "custom";
+/** All 9 space types as a readonly tuple for runtime enumeration */
+declare const SPACE_TYPES: readonly ["room", "table", "sunbed", "parking", "desk", "meeting_room", "locker", "service", "custom"];
+/** Space availability/lifecycle status */
+type SpaceStatus = "available" | "occupied" | "maintenance" | "blocked" | "inactive";
+/** All 5 space statuses as a readonly tuple for runtime enumeration */
+declare const SPACE_STATUSES: readonly ["available", "occupied", "maintenance", "blocked", "inactive"];
+/** A bookable space in the Atzentis Booking system */
+interface Space {
+    id: string;
+    propertyId: string;
+    categoryId: string | null;
+    name: string;
+    type: SpaceType;
+    status: SpaceStatus;
+    /** Used for rooms (hotel floor) and desks/meeting rooms (office floor). Use string to support labels like "B1", "G", "1", "2". */
+    floor: string | null;
+    /** Used for tables (cover count) and meeting rooms (person count). Null if not applicable. */
+    capacity: number | null;
+    /** POS table reference; set via `linkPosTable()`. Tables vertical only. Null until linked. */
+    posTableId: string | null;
+    /** Open bag for vertical-specific extras not covered by standard fields. Schema is consumer-defined. */
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Input for creating a new space */
+interface CreateSpaceInput {
+    propertyId: string;
+    name: string;
+    type: SpaceType;
+    categoryId?: string;
+    /** Optional. See `Space.floor` for usage by vertical. */
+    floor?: string;
+    /** Optional. See `Space.capacity` for usage by vertical. */
+    capacity?: number;
+    /** Optional. See `Space.metadata` for usage by vertical. */
+    metadata?: Record<string, unknown>;
+}
+/** Input for updating an existing space — all fields optional */
+type UpdateSpaceInput = Partial<Omit<CreateSpaceInput, "propertyId">>;
+/** Input for bulk updating spaces — requires `id` to identify each space */
+type BulkUpdateSpaceInput = UpdateSpaceInput & {
+    id: string;
+};
+/** Input for linking a space to a POS table */
+interface LinkPosTableInput {
+    posTableId: string;
+}
+/** Query parameters for listing spaces — propertyId is required */
+interface ListSpacesParams {
+    propertyId: string;
+    type?: SpaceType;
+    status?: SpaceStatus;
+    categoryId?: string;
+    floor?: number | string;
+    limit?: number;
+    cursor?: string;
+}
+
+/** Parameters for checking availability of a specific property */
+interface AvailabilityCheckParams {
+    /** Property to check availability for */
+    propertyId: string;
+    /** Check-in date in YYYY-MM-DD format */
+    checkIn: string;
+    /** Check-out date in YYYY-MM-DD format */
+    checkOut: string;
+    /** Filter by space category */
+    categoryId?: string;
+    /** Check a specific space */
+    spaceId?: string;
+    /** Number of guests */
+    guests?: number;
+    /** Filter by space type */
+    type?: SpaceType;
+}
+/** Result of an availability check */
+interface AvailabilityResult {
+    /** Whether any spaces are available for the requested dates */
+    available: boolean;
+    /** Available spaces matching the criteria */
+    spaces: AvailableSpace[];
+    /** Pricing details for the available spaces, null if not available */
+    pricing: AvailabilityPricing | null;
+    /** Stay restrictions, null if none apply */
+    restrictions: AvailabilityRestrictions | null;
+}
+/** A single available space from an availability check */
+interface AvailableSpace {
+    /** Space identifier */
+    spaceId: string;
+    /** Category the space belongs to */
+    categoryId: string | null;
+    /** Display name of the space */
+    name: string;
+    /** Space type (room, table, service, etc.) */
+    type: SpaceType;
+    /** Price in cents */
+    price: number;
+    /** Whether this specific space is available */
+    available: boolean;
+}
+/** Pricing breakdown from an availability check */
+interface AvailabilityPricing {
+    /** 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;
+}
+/** Stay restriction rules */
+interface AvailabilityRestrictions {
+    /** Minimum stay duration in nights */
+    minStay: number | null;
+    /** Maximum stay duration in nights */
+    maxStay: number | null;
+    /** Whether arrivals are blocked on this date */
+    closedToArrival: boolean;
+    /** Whether departures are blocked on this date */
+    closedToDeparture: boolean;
+}
+/** Parameters for searching availability across multiple properties */
+interface AvailabilitySearchParams {
+    /** Property IDs to search across */
+    propertyIds: string[];
+    /** 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;
+    /** Filter by space type */
+    type?: SpaceType;
+    /** Price range filter */
+    priceRange?: PriceRange;
+    /** Filter by category IDs */
+    categoryIds?: string[];
+    /** Maximum results per page */
+    limit?: number;
+    /** Pagination cursor */
+    cursor?: string;
+}
+/** Price range filter with min/max in cents */
+interface PriceRange {
+    /** Minimum price in cents */
+    min?: number;
+    /** Maximum price in cents */
+    max?: number;
+}
+/** Result of a multi-property availability search */
+interface AvailabilitySearchResult {
+    /** Matching properties with availability */
+    results: AvailabilitySearchResultEntry[];
+    /** Total number of matching properties */
+    totalCount: number;
+    /** Cursor for next page, null if no more results */
+    cursor: string | null;
+    /** Whether more results are available */
+    hasMore: boolean;
+}
+/** A single property's availability in a search result */
+interface AvailabilitySearchResultEntry {
+    /** Property identifier */
+    propertyId: string;
+    /** Available spaces at this property */
+    spaces: AvailableSpace[];
+    /** Lowest price in cents among available spaces */
+    bestPrice: number;
+}
+/** Parameters for generating a calendar view */
+interface CalendarParams extends AvailabilityCheckParams {
+    /** Number of months to generate (default: 1). Each month is 30 days. */
+    months?: number;
+}
+/** A single day in a calendar view */
+interface CalendarDay {
+    /** Date in YYYY-MM-DD format */
+    date: string;
+    /** Whether spaces are available on this date */
+    available: boolean;
+    /** Price in cents for this date, null if unavailable */
+    price: number | null;
+    /** Minimum stay requirement in nights, null if none */
+    minStay: number | null;
+    /** Whether arrivals are blocked on this date */
+    closedToArrival: boolean;
+    /** Whether departures are blocked on this date */
+    closedToDeparture: boolean;
+    /** Number of spaces available on this date */
+    spacesAvailable: number;
+}
+/** Parameters for querying table time slots */
+interface TableSlotParams {
+    /** Property to query */
+    propertyId: string;
+    /** Date to check in YYYY-MM-DD format */
+    date: string;
+    /** Number of guests (filters by table capacity) */
+    guests?: number;
+    /** Filter by table category (e.g., indoor, outdoor) */
+    categoryId?: string;
+    /** Reservation duration in minutes (default: 90) */
+    duration?: number;
+}
+/** Parameters for querying service appointment slots */
+interface ServiceSlotParams {
+    /** Property to query */
+    propertyId: string;
+    /** Date to check in YYYY-MM-DD format */
+    date: string;
+    /** Filter by specific provider/staff member */
+    providerId?: string;
+    /** Filter by service category */
+    categoryId?: string;
+    /** Appointment duration in minutes */
+    duration?: number;
+}
+/** A time slot for table reservations */
+interface TimeSlot {
+    /** Start time in HH:MM format (24-hour) */
+    startTime: string;
+    /** End time in HH:MM format (24-hour) */
+    endTime: string;
+    /** Whether this slot is available */
+    available: boolean;
+    /** Number of tables available in this slot */
+    tablesAvailable: number;
+    /** Price in cents for this slot, null if not priced */
+    price: number | null;
+}
+/** A time slot for service appointments, extends TimeSlot with provider info */
+interface ServiceTimeSlot extends TimeSlot {
+    /** Provider/staff member identifier */
+    providerId: string;
+    /** Display name of the provider */
+    providerName: string;
+}
+/** Parameters for pricing aggregation */
+interface PricingParams extends AvailabilityCheckParams {
+    /** ISO 4217 currency code override (default: property currency) */
+    currency?: string;
+}
+/** Aggregated pricing statistics */
+interface PricingResult {
+    /** Lowest price in cents among available spaces */
+    minPrice: number;
+    /** Highest price in cents among available spaces */
+    maxPrice: number;
+    /** Mean price in cents (rounded to integer) */
+    averagePrice: number;
+    /** Total price in cents for the full stay/booking */
+    totalPrice: number;
+    /** Per-night rate in cents, null for Tables/Services */
+    perNight: number | null;
+    /** Number of nights (date difference), 0 for same-day */
+    nights: number;
+    /** ISO 4217 currency code */
+    currency: string;
+}
+
 /** The standard paginated response shape returned by all v4.0 list endpoints */
 interface Paginated<T> {
     /** The items for this page */
@@ -113,6 +384,160 @@ interface PaginationOptions {
 /** Callback type: a function that fetches one page given current cursor options */
 type PageFetcher<T> = (options: PaginationOptions) => Promise<Paginated<T>>;
 
+/**
+ * Abstract base class for all SDK services.
+ * Provides typed HTTP helper methods and path construction.
+ * Not exported from the public API.
+ */
+declare abstract class BaseService {
+    protected readonly http: HttpClient;
+    protected abstract readonly basePath: string;
+    constructor(http: HttpClient);
+    /** Build a full path from the base path and additional segments */
+    protected _buildPath(...segments: string[]): string;
+    /** GET request returning typed response */
+    protected _get<T>(path: string, query?: Record<string, string | number | boolean | null | undefined>): Promise<T>;
+    /** POST request with body, returning typed response */
+    protected _post<T>(path: string, body: unknown): Promise<T>;
+    /** PATCH request with body, returning typed response */
+    protected _patch<T>(path: string, body: unknown): Promise<T>;
+    /** DELETE request, returning void */
+    protected _delete(path: string): Promise<void>;
+    /** GET list request with optional query params, returning paginated response */
+    protected _list<T>(params?: any): Promise<Paginated<T>>;
+}
+
+/**
+ * Service for checking and searching availability in the Atzentis Booking API.
+ *
+ * Provides two API endpoints (`check` and `search`) plus four client-side helper
+ * methods for calendar views, table time-slots, service appointment slots, and
+ * pricing aggregation.
+ *
+ * @example
+ * ```typescript
+ * const booking = new BookingClient({ apiKey: "atz_io_live_xxxxx" });
+ *
+ * // Check availability for a property
+ * const result = await booking.availability.check({
+ *   propertyId: "prop_abc123",
+ *   checkIn: "2025-06-01",
+ *   checkOut: "2025-06-05",
+ * });
+ * ```
+ */
+declare class AvailabilityService extends BaseService {
+    protected readonly basePath = "/booking/v1/availability";
+    /**
+     * Check availability for a property and date range.
+     *
+     * @param params - Must include `propertyId`, `checkIn`, `checkOut`; supports optional filters
+     *
+     * @example
+     * ```typescript
+     * const result = await booking.availability.check({
+     *   propertyId: "prop_abc123",
+     *   checkIn: "2025-06-01",
+     *   checkOut: "2025-06-05",
+     *   type: "room",
+     *   guests: 2,
+     * });
+     * ```
+     */
+    check(params: AvailabilityCheckParams): Promise<AvailabilityResult>;
+    /**
+     * Search availability across multiple properties.
+     *
+     * @param params - Must include `propertyIds`, `checkIn`, `checkOut`; supports filtering and pagination
+     *
+     * @example
+     * ```typescript
+     * const results = await booking.availability.search({
+     *   propertyIds: ["prop_abc", "prop_def"],
+     *   checkIn: "2025-06-01",
+     *   checkOut: "2025-06-05",
+     *   guests: 2,
+     *   priceRange: { min: 5000, max: 20000 },
+     * });
+     * ```
+     */
+    search(params: AvailabilitySearchParams): Promise<AvailabilitySearchResult>;
+    /**
+     * Generate a calendar view of daily availability for a property.
+     *
+     * Client-side helper that calls `check()` internally and transforms the result
+     * into a `CalendarDay[]` suitable for calendar UI rendering.
+     *
+     * @param params - Extends `AvailabilityCheckParams` with optional `months` (default: 1)
+     *
+     * @example
+     * ```typescript
+     * const calendar = await booking.availability.getCalendar({
+     *   propertyId: "prop_abc123",
+     *   checkIn: "2025-06-01",
+     *   checkOut: "2025-06-30",
+     * });
+     * ```
+     */
+    getCalendar(params: CalendarParams): Promise<CalendarDay[]>;
+    /**
+     * Get available table reservation time slots for a specific date.
+     *
+     * Client-side helper for the Tables vertical. Calls `check()` internally
+     * with `type: "table"` and reshapes the response into `TimeSlot[]`.
+     *
+     * @param params - Must include `propertyId` and `date`
+     *
+     * @example
+     * ```typescript
+     * const slots = await booking.availability.getTableSlots({
+     *   propertyId: "prop_abc123",
+     *   date: "2025-06-15",
+     *   guests: 4,
+     * });
+     * ```
+     */
+    getTableSlots(params: TableSlotParams): Promise<TimeSlot[]>;
+    /**
+     * Get available service appointment slots for a specific date.
+     *
+     * Client-side helper for the Services vertical. Calls `check()` internally
+     * with `type: "service"` and reshapes the response into `ServiceTimeSlot[]`.
+     *
+     * @param params - Must include `propertyId` and `date`
+     *
+     * @example
+     * ```typescript
+     * const slots = await booking.availability.getServiceSlots({
+     *   propertyId: "prop_abc123",
+     *   date: "2025-06-15",
+     *   providerId: "staff_001",
+     *   duration: 60,
+     * });
+     * ```
+     */
+    getServiceSlots(params: ServiceSlotParams): Promise<ServiceTimeSlot[]>;
+    /**
+     * Get aggregated pricing statistics for a property and date range.
+     *
+     * Client-side helper that calls `check()` internally and computes
+     * min/max/average/total pricing from available spaces.
+     *
+     * @param params - Extends `AvailabilityCheckParams` with optional `currency`
+     *
+     * @example
+     * ```typescript
+     * const pricing = await booking.availability.getPricing({
+     *   propertyId: "prop_abc123",
+     *   checkIn: "2025-06-01",
+     *   checkOut: "2025-06-05",
+     * });
+     * console.log(`From €${pricing.minPrice / 100} to €${pricing.maxPrice / 100}`);
+     * ```
+     */
+    getPricing(params: PricingParams): Promise<PricingResult>;
+}
+
 /** 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 */
@@ -225,29 +650,6 @@ interface ListCategoriesParams {
     limit?: number;
 }
 
-/**
- * Abstract base class for all SDK services.
- * Provides typed HTTP helper methods and path construction.
- * Not exported from the public API.
- */
-declare abstract class BaseService {
-    protected readonly http: HttpClient;
-    protected abstract readonly basePath: string;
-    constructor(http: HttpClient);
-    /** Build a full path from the base path and additional segments */
-    protected _buildPath(...segments: string[]): string;
-    /** GET request returning typed response */
-    protected _get<T>(path: string, query?: Record<string, string | number | boolean | null | undefined>): Promise<T>;
-    /** POST request with body, returning typed response */
-    protected _post<T>(path: string, body: unknown): Promise<T>;
-    /** PATCH request with body, returning typed response */
-    protected _patch<T>(path: string, body: unknown): Promise<T>;
-    /** DELETE request, returning void */
-    protected _delete(path: string): Promise<void>;
-    /** GET list request with optional query params, returning paginated response */
-    protected _list<T>(params?: any): Promise<Paginated<T>>;
-}
-
 /**
  * Service for managing space categories (room types) in the Atzentis Booking API.
  *
@@ -402,75 +804,6 @@ declare class PropertiesService extends BaseService {
     delete(propertyId: string): Promise<void>;
 }
 
-/**
- * All supported space types in the v4.0 API.
- *
- * Grouped by vertical:
- * - **Stays:** `room`, `sunbed`, `parking`
- * - **Tables:** `table`, `locker`
- * - **Services:** `service`, `meeting_room`, `desk`
- * - **Universal:** `custom`
- */
-type SpaceType = "room" | "table" | "sunbed" | "parking" | "desk" | "meeting_room" | "locker" | "service" | "custom";
-/** All 9 space types as a readonly tuple for runtime enumeration */
-declare const SPACE_TYPES: readonly ["room", "table", "sunbed", "parking", "desk", "meeting_room", "locker", "service", "custom"];
-/** Space availability/lifecycle status */
-type SpaceStatus = "available" | "occupied" | "maintenance" | "blocked" | "inactive";
-/** All 5 space statuses as a readonly tuple for runtime enumeration */
-declare const SPACE_STATUSES: readonly ["available", "occupied", "maintenance", "blocked", "inactive"];
-/** A bookable space in the Atzentis Booking system */
-interface Space {
-    id: string;
-    propertyId: string;
-    categoryId: string | null;
-    name: string;
-    type: SpaceType;
-    status: SpaceStatus;
-    /** Used for rooms (hotel floor) and desks/meeting rooms (office floor). Use string to support labels like "B1", "G", "1", "2". */
-    floor: string | null;
-    /** Used for tables (cover count) and meeting rooms (person count). Null if not applicable. */
-    capacity: number | null;
-    /** POS table reference; set via `linkPosTable()`. Tables vertical only. Null until linked. */
-    posTableId: string | null;
-    /** Open bag for vertical-specific extras not covered by standard fields. Schema is consumer-defined. */
-    metadata: Record<string, unknown> | null;
-    createdAt: string;
-    updatedAt: string;
-}
-/** Input for creating a new space */
-interface CreateSpaceInput {
-    propertyId: string;
-    name: string;
-    type: SpaceType;
-    categoryId?: string;
-    /** Optional. See `Space.floor` for usage by vertical. */
-    floor?: string;
-    /** Optional. See `Space.capacity` for usage by vertical. */
-    capacity?: number;
-    /** Optional. See `Space.metadata` for usage by vertical. */
-    metadata?: Record<string, unknown>;
-}
-/** Input for updating an existing space — all fields optional */
-type UpdateSpaceInput = Partial<Omit<CreateSpaceInput, "propertyId">>;
-/** Input for bulk updating spaces — requires `id` to identify each space */
-type BulkUpdateSpaceInput = UpdateSpaceInput & {
-    id: string;
-};
-/** Input for linking a space to a POS table */
-interface LinkPosTableInput {
-    posTableId: string;
-}
-/** Query parameters for listing spaces — propertyId is required */
-interface ListSpacesParams {
-    propertyId: string;
-    type?: SpaceType;
-    status?: SpaceStatus;
-    categoryId?: string;
-    floor?: number | string;
-    limit?: number;
-    cursor?: string;
-}
-
 /**
  * Service for managing bookable spaces in the Atzentis Booking API.
  *
@@ -611,10 +944,13 @@ declare class SpacesService extends BaseService {
  */
 declare class BookingClient {
     readonly httpClient: HttpClient;
+    private _availability?;
     private _properties?;
     private _categories?;
     private _spaces?;
     constructor(config: BookingClientConfig);
+    /** Availability service — lazy-initialized on first access */
+    get availability(): AvailabilityService;
     /** Properties service — lazy-initialized on first access */
     get properties(): PropertiesService;
     /** Categories service — lazy-initialized on first access */
@@ -703,4 +1039,4 @@ declare function firstPage<T>(fetcher: PageFetcher<T>, options?: PaginationOptio
 
 declare const VERSION = "0.1.0";
 
-export { AuthenticationError, BookingClient, type BookingClientConfig, BookingError, type BookingErrorOptions, type BulkUpdateSpaceInput, 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, 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 Space, type SpaceCategory, type SpaceStatus, type SpaceType, SpacesService, TimeoutError, type UpdateCategoryInput, type UpdatePropertyInput, type UpdateSpaceInput, VERSION, ValidationError, bookingClientConfigSchema, createErrorFromResponse, firstPage, paginate };
+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 };