@roomstay/core 0.1.80 → 0.2.0-1

package/dist/types/Availability/Availability.types.d.ts

@@ -1,121 +0,0 @@
-import { Warning } from '../index.js';
-import { IItemisedBookingFeeResponse } from '../Booking/Itinerary.types';
-import { EGuaranteePolicyDepositMode } from '../Policies/EGuaranteePolicy.enum';
-import { EPromoCodeDiscountType } from '../PromoCode/EPromoCodeDiscountType.enum';
-export type IAvailability = {
-    roomTypes: {
-        [roomTypeCode: string]: IRoomType;
-    };
-    ratePlans: {
-        [ratePlanCode: string]: IRatePlan;
-    };
-    roomNights: {
-        [date: string]: {
-            [roomTypeCode: string]: IRoomNight;
-        };
-    };
-    /** @deprecated */
-    guaranteePolicies: {
-        [policyCode: string]: string;
-    };
-    guaranteePolicyDetails?: {
-        [policyCode: string]: IAvailabilityGuaranteePolicyDetails;
-    };
-    cancelPolicies: {
-        [policyCode: string]: string;
-    };
-    warnings: Warning<string>[];
-    alternativeAvailability?: IAlternativeAvailability;
-    promoCodeDetails?: IPromoCodeDetails | null;
-    hasMinStayUpsellOpportunities?: boolean;
-};
-export type IAlternativeAvailability = {
-    checkInDate: string;
-    checkOutDate: string;
-    availability: IAvailability;
-};
-export type IAvailabilityGuaranteePolicyDetails = {
-    code: string;
-    name: string;
-    longDescription: string;
-    depositMode: EGuaranteePolicyDepositMode;
-    depositPercentage?: number;
-    hide: boolean;
-};
-export type IRoomType = {
-    name: string;
-    shortDescription: string;
-    longDescription: string;
-    imageUrls: string[];
-    occupancy: number;
-    roomGroupId?: string | null;
-    auxiliaryValues?: {
-        [auxiliaryFilterId: string]: string[];
-    };
-    order: number;
-    doNotUpsell: boolean;
-};
-export type IRatePlan = {
-    name: string;
-    description: string;
-    longDescription?: string | null;
-    guaranteeCode: string;
-    cancelPolicyCode: string;
-    promoCode?: string | null;
-    promoCodeName?: string | null;
-    mealsIncluded: {
-        breakfast: boolean;
-        lunch: boolean;
-        dinner: boolean;
-        mealPlan: string | undefined;
-    };
-    rateOverrides: IRateOverride[];
-    nightsToDiscount?: number | null;
-    minNightStayOverride?: number | null;
-    isUpsellRate?: boolean;
-    isMemberOnly?: boolean;
-    artificialDiscountPercent: number | null;
-    artificialDiscountAmount: number | null;
-    freeChildrenIncluded: number;
-};
-export type IPromoCodeDetails = {
-    code: string;
-    oneTimeUseOnly: boolean;
-    discountType: EPromoCodeDiscountType;
-    discountAmount: number;
-    applyToAddons: boolean;
-};
-export type IRoomNight = {
-    available: number;
-    lowestPrice: number;
-    rates: {
-        [ratePlanCode: string]: IRoomNightRatePlan;
-    };
-};
-export type IRoomNightRatePlan = {
-    cost: number;
-    discount: number;
-    tax: number;
-    fee: number;
-    total: number;
-    fees?: IItemisedBookingFeeResponse[];
-};
-export type IRateOverride = {
-    name: string;
-    shortDescription: string;
-    longDescription: string;
-    enabledPerDay: IRateLabelsByDay | null;
-    startDate: string;
-    endDate: string | null;
-    queryStartDate: string | null;
-    queryEndDate: string | null;
-};
-export type IRateLabelsByDay = {
-    Monday: boolean;
-    Tuesday: boolean;
-    Wednesday: boolean;
-    Thursday: boolean;
-    Friday: boolean;
-    Saturday: boolean;
-    Sunday: boolean;
-};

package/dist/types/Booking/ConfirmBooking.types.d.ts

@@ -1,21 +0,0 @@
-import { IRoomstayMemberJWTData } from '../Member/IRoomstayMemberJWTData.type';
-import { ICommonQueryParameters } from './ICommonQueryParameters.type';
-import { ItineraryResponse } from './Itinerary.types';
-export type IConfirmBookingRequest = {
-    reservationIds: string[];
-    itineraryId: string;
-    planpayCheckoutId?: string;
-    paymentId?: string;
-    roomstayId?: string;
-    frontendMember?: IRoomstayMemberJWTData;
-    source?: 'External' | 'Frontend' | 'Admin';
-    isBlocking?: boolean;
-} & ICommonQueryParameters;
-export type IConfirmBookingResponse = ItineraryResponse;
-export type ICancelBookingRequest = {
-    email?: string;
-    reservationId: string;
-    frontendMember?: IRoomstayMemberJWTData;
-    companyUserId?: number;
-    cancellationReason?: string;
-} & ICommonQueryParameters;

package/dist/types/Booking/EBooking.types.d.ts

@@ -1,12 +0,0 @@
-export declare enum EBookingStatus {
-    Pending = "Pending",
-    Processing = "Processing",
-    Committed = "Committed",
-    Cancelled = "Cancelled",
-    Reverted = "Reverted"
-}
-export declare enum EBookingFlow {
-    Default = "Default",
-    PreCheckoutPencil = "PreCheckoutPencil",
-    PostCheckoutPencil = "PostCheckoutPencil"
-}

package/dist/types/Booking/GetBooking.types.d.ts

@@ -1,7 +0,0 @@
-import { ICommonQueryParameters } from './ICommonQueryParameters.type';
-import { ItineraryResponse } from './Itinerary.types';
-export type IGetBookingRequest = {
-    email?: string;
-    reservationId: string;
-} & ICommonQueryParameters;
-export type IGetBookingResponse = ItineraryResponse;

package/dist/types/Booking/IBookingCreateErrorResponse.type.d.ts

@@ -1,13 +0,0 @@
-import { IPaymentCheckoutDetails } from './IBookingPayment.type';
-/**
- * This is the response body that comes down if a booking fails anywhere in the booking flow.
- *
- * Object will contain a public message only, with partial reservation data to be able to attempt to "resume" the booking
- */
-export type IBookingCreateErrorResponse = {
-    canRetryPayment: boolean;
-    isPaymentTaken: boolean;
-    paymentRequired?: IPaymentCheckoutDetails;
-    publicMessage: string;
-    roomstayId: string;
-};

package/dist/types/Booking/IBookingExtraFields.type.d.ts

@@ -1,18 +0,0 @@
-export declare enum EBookingCustomFieldFormat {
-    Number = "number",
-    Text = "text",
-    Date = "date"
-}
-export type IBookingCustomFields = {
-    externalId: number;
-    label: string;
-    value: string;
-    format: EBookingCustomFieldFormat;
-};
-export type IBookingExtraFields = {
-    perRow: {
-        childAges?: number[];
-    }[];
-    customFields?: IBookingCustomFields[];
-    eta?: string;
-};

package/dist/types/Booking/IBookingPayment.type.d.ts

@@ -1,114 +0,0 @@
-export declare enum EBookingPaymentMethod {
-    Card = "Card",
-    SavedCard = "SavedCard",
-    Planpay = "Planpay",
-    Adyen = "Adyen",
-    Afterpay = "Afterpay",
-    PCIBookingCard = "PCIBookingCard",
-    TrueRewards = "TrueRewards"
-}
-/**
- * This enum is used to determine which payment processor to use for the booking.
- *
- * Usually only applies if the payment method is Card, SavedCard, or PCIBookingCard.
- *
- * Other payment methods will generate their own checkout flow that will differ from this.
- */
-export declare enum EHotelCardProcessor {
-    Passthrough = "Passthrough",
-    Adyen = "Adyen",
-    Till = "Till",
-    RMSPay = "RMSPay",
-    Windcave = "Windcave",
-    Mastercard = "Mastercard",
-    Stripe = "Stripe",
-    PayPal = "PayPal"
-}
-export declare enum EPlanpayBookingStatus {
-    Unknown = "unknown",// incase plan.deposit.status is unavailable
-    Unpaid = "unpaid",
-    Accepted = "accepted",
-    Cancelled = "cancelled",
-    Refunded = "refunded",
-    Rejected = "rejected"
-}
-export declare const PCIBookingCardProcessorTypes: any[];
-export type PCIBookingCardProcessorType = undefined;
-export type IBookingPaymentTokenizedCard = {
-    Type: string;
-    Number: string;
-    Expiry: number;
-    CVV: string;
-    Name: string;
-};
-type IPCIBookingCardNotificationData = {
-    CaptureCardRequestID: string;
-    CaptureCardRequestStatus: string;
-    CardUri: string;
-};
-/**
- * Booking payment attached to a booking.
- *
- * Could be either Card or Planpay
- */
-export type IBookingPayment = {
-    Method: EBookingPaymentMethod;
-    SavedCardID?: string;
-    PlanpayCheckoutId?: string;
-    PaymentCard?: IBookingPaymentTokenizedCard;
-    PCICardDetails?: IPCIBookingCardNotificationData;
-    RedirectUrl?: string;
-    SplitPaymentAmount?: number;
-};
-export type IPaymentCheckoutDetails = {
-    planpay?: {
-        id: string;
-        checkoutWorkflow: {
-            type: string;
-            id: string;
-            scriptUrl: string;
-        };
-    };
-    external?: {
-        id: string;
-        redirectUrl: string;
-    };
-    adyen?: {
-        roomstayId: string;
-        sessionData: string;
-        sessionId: string;
-        clientKey: string;
-        isLive: boolean;
-        currency: string;
-        amount: string;
-        countryCode: string;
-    };
-    mastercard?: {
-        sessionId: string;
-        paymentMode: 'EmbeddedPage' | 'PaymentPage';
-        baseUrl: string;
-    };
-    stripe?: {
-        clientSecret: string;
-        publishableApiKey: string;
-        successUrl: string;
-    };
-    paypal?: {
-        orderId: string;
-        clientId: string;
-        successUrl: string;
-        currencyCode: string;
-    };
-    windcave?: {
-        links: {
-            href: string;
-            rel: string;
-            method: string;
-        }[];
-        successUrl: string;
-        useTesting: boolean;
-    };
-    isSplitPayment?: boolean;
-    totalAuthorizedAmount?: number;
-};
-export {};

package/dist/types/Booking/IBookingQuote.type.d.ts

@@ -1,30 +0,0 @@
-export type IBookingQuoteRequest = {
-    rows: {
-        rowId: string;
-        rateCode: string;
-        roomCode: string;
-        adults?: number;
-        children?: number;
-        infants?: number;
-        promoCode?: string;
-        /**
-         * Example format "2023-10-22 10:00:00"
-         */
-        checkIn: string;
-        /**
-         * Example format "2023-10-22 10:00:00"
-         */
-        checkOut: string;
-        memberNumber?: string;
-        totalDisplayedPrice?: number;
-    }[];
-};
-export type IBookingQuoteResponse = {
-    rows: {
-        rowId: string;
-        totalRate: number;
-        totalDeposit: number;
-        totalFees: number;
-        quoteId: number;
-    }[];
-} | null;

package/dist/types/Booking/ICommonQueryParameters.type.d.ts

@@ -1,3 +0,0 @@
-export type ICommonQueryParameters = {
-    language?: string;
-};

package/dist/types/Booking/Itinerary.types.d.ts

@@ -1,99 +0,0 @@
-import { EBookingPaymentMethod, IPaymentCheckoutDetails } from './IBookingPayment.type';
-import { ReservedPackage } from '../Package/Package.types';
-export declare class ItineraryResponse {
-    roomstayId: string;
-    itineraryNumber?: string;
-    total?: IAmount;
-    hotelFrontendId?: string;
-    reservations: Reservation[];
-    payment?: IPaymentCheckoutDetails;
-    feesSummary?: IItemisedBookingFeeResponse[];
-    itemisedFees?: IItemisedBookingFeeResponse[];
-    warnings?: string[];
-}
-export declare class Reservation {
-    reservationNumber: string;
-    roomType: string;
-    roomCode: string;
-    rate: string;
-    rateCode?: string;
-    images: string[];
-    guaranteePolicy?: string;
-    cancellationPolicy?: string;
-    checkInDate: string;
-    checkOutDate: string;
-    nights: {
-        [date: string]: IPrice;
-    };
-    guestCounts: {
-        adults: number;
-        children: number;
-    };
-    guest: GuestProfile;
-    paymentCard: {
-        type: string | undefined;
-        last4: string;
-        expiry: string;
-        name: string;
-    };
-    paymentMethod: EBookingPaymentMethod;
-    total: IAmount;
-    status: string;
-    isCancelable: boolean;
-    addons: ReservedPackage[] | undefined;
-    comments?: string[];
-    specialRequests?: string[];
-    promoCode?: string;
-    guaranteePolicyLongDescription?: string;
-    cancellationPolicyLongDescription?: string;
-    itemisedFees?: IItemisedBookingFeeResponse[];
-}
-export declare class GuestProfile {
-    title?: string;
-    firstName?: string;
-    middleName?: string;
-    lastName?: string;
-    nameSuffix?: string;
-    phone?: string;
-    email?: string;
-    address: IAddress;
-    marketingOptIn?: boolean;
-    country: string;
-}
-export type IGuestCounts = {
-    adults: number;
-    children: number;
-};
-export type IAddress = {
-    line1?: string;
-    line2?: string;
-    line3?: string;
-    city?: string;
-    postalCode?: string;
-    state?: string;
-    country?: string;
-};
-export type IAmount = {
-    beforeTax: number;
-    afterTax: number;
-    beforeFees?: number;
-};
-export type ICheckoutWorkflowType = {
-    sdkWidget: {
-        type: string;
-        id: string;
-        scriptUrl: string;
-    };
-};
-export type IItemisedBookingFeeResponse = {
-    name: string;
-    description?: string;
-    amount: number;
-};
-export type IPrice = {
-    cost: number;
-    discount: number;
-    tax: number;
-    fee: number;
-    total: number;
-};

package/dist/types/Booking/PencilReservation.types.d.ts

@@ -1,19 +0,0 @@
-import { IBookingQuoteRequest, IBookingQuoteResponse } from './IBookingQuote.type';
-export type IPencilReservationRequest = IBookingQuoteRequest & {
-    pencilId?: string;
-    rows: ({
-        pencilId?: string;
-        auxInputs?: {
-            [auxInputId: string]: string;
-        };
-    } & IBookingQuoteRequest['rows'][number])[];
-};
-export type IPencilReservationResponse = {
-    timeout?: Date;
-    pencilId?: string;
-    rows: {
-        rowId: string;
-        pencilId: string;
-    }[];
-    quote?: IBookingQuoteResponse;
-};

package/dist/types/Booking/PlaceBooking.types.d.ts

@@ -1,89 +0,0 @@
-import { IRoomstayMemberJWTData } from '../Member/IRoomstayMemberJWTData.type';
-import { IBookingExtraFields } from './IBookingExtraFields.type';
-import { IBookingPayment } from './IBookingPayment.type';
-import { ICommonQueryParameters } from './ICommonQueryParameters.type';
-import { ItineraryResponse } from './Itinerary.types';
-export type IPlaceBookingRequest = {
-    rooms: IPlaceBookingRoomsDTO[];
-    services: IPlaceBookingServicesDTO[];
-    profiles?: IPlaceBookingProfilesDTO[];
-    specialRequest?: string;
-    comments?: string;
-    iataCode?: string;
-    sessionId?: string;
-    pencilId?: string;
-    tracking: {
-        sourceIp: string;
-        userAgent: string;
-        sourceUrl: string;
-    } & IPlaceBookingGCLIDAndUTM;
-    payment: IBookingPayment;
-    frontendMember?: IRoomstayMemberJWTData;
-    giftCard?: {
-        token: string;
-        code: string;
-    };
-    extraFields?: IBookingExtraFields;
-} & ICommonQueryParameters;
-export type IRepeatPaymentRequest = IPlaceBookingRequest & {
-    roomstayId: string;
-};
-export type IPlaceBookingResponse = ItineraryResponse;
-export type IPlaceBookingRoomsDTO = {
-    roomType: string;
-    ratePlan: string;
-    promoCode?: string;
-    adults: number;
-    children: number;
-    infants?: number;
-    checkInDate: Date;
-    checkOutDate: Date;
-    quoteId?: number;
-    rowId?: string;
-    memberNumber?: string;
-    pencilId?: string;
-};
-export type IPlaceBookingServicesDTO = {
-    code: string;
-    ratePlanCode: string;
-    startDate: Date;
-    startTime?: string;
-    quantity?: number;
-    adults?: number;
-    children?: number;
-    pricingType?: string;
-};
-export type IPlaceBookingProfilesDTO = {
-    title?: string;
-    firstName: string;
-    middleName?: string;
-    lastName: string;
-    nameSuffix?: string;
-    phone: string;
-    email: string;
-    address: {
-        line1: string;
-        line2?: string;
-        line3?: string;
-        city?: string;
-        postalCode?: string;
-        state?: string;
-        country?: string;
-        countryId?: number;
-        countryCode?: string;
-    };
-    marketingOptIn: boolean;
-    auxInputs: {
-        [auxInputId: string]: string;
-    };
-};
-export type IPlaceBookingGCLIDAndUTM = {
-    utm: {
-        utmSource: string | null;
-        utmMedium: string | null;
-        utmCampaign: string | null;
-        utmTerm: string | null;
-        utmContent: string | null;
-    };
-    gclid: string | null;
-};

package/dist/types/Company/ECompanyProvider.enum.d.ts

@@ -1,8 +0,0 @@
-export declare enum ECompanyProvider {
-    Synxis = "Synxis",
-    Availpro = "Availpro",
-    RMS = "RMS",
-    Siteminder = "Siteminder",
-    Roomstay = "Roomstay",
-    OHIP = "OHIP"
-}

package/dist/types/Company/IAdminCompany.type.d.ts

@@ -1,46 +0,0 @@
-import type { ECompanyProvider, MediaType } from '../index.js';
-export interface IAdminCompany {
-    id: number;
-    name: string;
-    logo?: MediaType;
-    url: string;
-    provider: ECompanyProvider;
-    providerLogin: string;
-    providerPassword: string;
-    isGiftCardsEnabled: boolean;
-    /**
-     * @deprecated Use `isRoomstayEventsEnabled` or `isHotelEventsEnabled` instead.
-     */
-    isEventsEnabled: boolean;
-    isRoomstayEventsEnabled: boolean;
-    isHotelEventsEnabled: boolean;
-    isAnalyticsEnabled: boolean;
-    preventMemberPortalWelcomeEmails: boolean;
-    hotels: {
-        name: string;
-        label: string;
-        id: string;
-        frontendId: string;
-        rms?: {
-            clientId: number;
-            clientPassword: string;
-            useTrainingDb: boolean;
-            apiUrl: string;
-            pencilGuestId?: number;
-        };
-    }[];
-    enableLighthouseAvailability: boolean;
-    enableDerbysoftFeed: boolean;
-}
-export type IAdminGetCompaniesResponse = IAdminCompany[];
-/** What the API expects */
-export type IAdminFetchRMSHotelsRequest = {
-    /** Passing this field will apply changes */
-    confirm?: boolean;
-};
-/** Response type of the Fetch RMS hotels endpoint. This endpoint will contact RMS and fetch Hotel's details directly from their database.
- * On initial call the data won't be applied, you must call this API again and set {@link IAdminFetchRMSHotelsRequest.confirm} to true to apply the data */
-export type IAdminFetchRMSHotelsResponse = {
-    /** If the hotels have in fact been synced, this will be true */
-    hasConfirmed: boolean;
-};

package/dist/types/Company/IAdminCompanyUser.type.d.ts

@@ -1,15 +0,0 @@
-export declare enum EAdminCompanyUserRole {
-    SuperAdmin = "SuperAdmin",
-    Admin = "Admin",
-    Limited = "Limited"
-}
-export type IAdminCompanyUser = {
-    id: number;
-    email: string;
-    title: string;
-    firstName: string;
-    lastName: string;
-    newPassword?: string;
-    deletedDate?: Date;
-    role?: EAdminCompanyUserRole;
-};

package/dist/types/Events/ERoomstayEventSource.enum.d.ts

@@ -1,4 +0,0 @@
-export declare enum ERoomstayEventSource {
-    Eventbrite = "eventbrite",
-    ATDW = "atdw"
-}

package/dist/types/Events/IRoomstayEvent.type.d.ts

@@ -1,50 +0,0 @@
-import { ERoomstayEventSource } from "./ERoomstayEventSource.enum";
-type IRoomstayEventAvailabilityPrice = {
-    currency: string;
-    majorValue: string;
-    value: number;
-};
-export type IRoomstayEventAvailability = {
-    isSoldOut?: boolean;
-    hasAvailableTickets?: boolean;
-    isFree: boolean;
-    minPrice?: IRoomstayEventAvailabilityPrice;
-    maxPrice?: IRoomstayEventAvailabilityPrice;
-};
-export type IRoomstayEvent = {
-    eventId: string;
-    source: ERoomstayEventSource | string;
-    name: string;
-    summary: string;
-    description: string;
-    image: {
-        background?: string;
-        url: string;
-        isRoomstay?: boolean;
-        id?: string;
-    };
-    checkoutUrl?: string;
-    url: string;
-    endDate: string;
-    startDate: string;
-    /**
-     * Used to override the startDate (if event is repeating for example, say every thursday at 6pm)
-     */
-    eventTimeDescription?: string;
-    unixStartTime: number;
-    timezone: string;
-    searchCity: string[];
-    latitude: number;
-    longitude: number;
-    isPermanent?: boolean;
-    address: {
-        line1: string;
-        line2: string;
-        city: string;
-        country: string;
-        region: string;
-    };
-    availability?: IRoomstayEventAvailability;
-    tags: any;
-};
-export {};

package/dist/types/Fees/EFeeType.enum.d.ts

@@ -1,7 +0,0 @@
-export declare enum EFeeType {
-    PercentageOfBooking = "PercentageOfBooking",
-    FixedChargePerRoom = "FixedChargePerRoom",
-    NightlyChargePerRoom = "NightlyChargePerRoom",
-    FixedChargePerBooking = "FixedChargePerBooking",
-    DepositSurcharge = "DepositSurcharge"
-}