@roomstay/core 0.1.53-12 → 0.1.53-4

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

@@ -0,0 +1,99 @@
+import { EBookingPaymentMethod } from './IBookingPayment.type';
+import { IPrice } from './IPrice.type';
+import { IReservedPackage } from '../Package/IPackage.type';
+export type IItineraryResponse = {
+    roomstayId: string;
+    itineraryNumber?: string;
+    total?: IAmount;
+    hotelFrontendId?: string;
+    reservations: IReservation[];
+    payment?: {
+        planpay?: {
+            id: string;
+            checkoutWorkflow: ICheckoutWorkflowType;
+        };
+        external?: {
+            id: string;
+            redirectUrl: string;
+        };
+    };
+    feesSummary?: IItemisedBookingFeeResponse[];
+    itemisedFees?: IItemisedBookingFeeResponse[];
+    warnings?: string[];
+};
+export type IReservation = {
+    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: IGuestCounts;
+    guest: IGuestProfile;
+    paymentCard: {
+        type: string | undefined;
+        last4: string;
+        expiry: string;
+        name: string;
+    };
+    paymentMethod: EBookingPaymentMethod;
+    total: IAmount;
+    status: string;
+    isCancelable: boolean;
+    addons: IReservedPackage[] | undefined;
+    comments?: string[];
+    specialRequests?: string[];
+    promoCode?: string;
+    guaranteePolicyLongDescription?: string;
+    cancellationPolicyLongDescription?: string;
+    itemisedFees?: IItemisedBookingFeeResponse[];
+};
+export type IGuestProfile = {
+    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;
+};

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

@@ -0,0 +1,105 @@
+import { EBookingPaymentMethod } from './IBookingPayment.type';
+import { IReservedPackage } from './Package.types';
+export type IItineraryResponse = {
+    roomstayId: string;
+    itineraryNumber?: string;
+    total?: IAmount;
+    hotelFrontendId?: string;
+    reservations: IReservation[];
+    payment?: {
+        planpay?: {
+            id: string;
+            checkoutWorkflow: ICheckoutWorkflowType;
+        };
+        external?: {
+            id: string;
+            redirectUrl: string;
+        };
+    };
+    feesSummary?: IItemisedBookingFeeResponse[];
+    itemisedFees?: IItemisedBookingFeeResponse[];
+    warnings?: string[];
+};
+export type IReservation = {
+    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: IGuestCounts;
+    guest: IGuestProfile;
+    paymentCard: {
+        type: string | undefined;
+        last4: string;
+        expiry: string;
+        name: string;
+    };
+    paymentMethod: EBookingPaymentMethod;
+    total: IAmount;
+    status: string;
+    isCancelable: boolean;
+    addons: IReservedPackage[] | undefined;
+    comments?: string[];
+    specialRequests?: string[];
+    promoCode?: string;
+    guaranteePolicyLongDescription?: string;
+    cancellationPolicyLongDescription?: string;
+    itemisedFees?: IItemisedBookingFeeResponse[];
+};
+export type IGuestProfile = {
+    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 IPrice = {
+    cost: number;
+    discount: number;
+    tax: number;
+    fee: number;
+    total: number;
+};
+export type ICheckoutWorkflowType = {
+    sdkWidget: {
+        type: string;
+        id: string;
+        scriptUrl: string;
+    };
+};
+export type IItemisedBookingFeeResponse = {
+    name: string;
+    description?: string;
+    amount: number;
+};

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

@@ -0,0 +1,89 @@
+import { IAddonPriceDetailsFee } from 'types/Addons/Addon.type';
+import { IItemisedBookingFeeResponse } from './IItinerary.type';
+export type IPackage = {
+    /**
+     * The SynXis CR RatePlan Code associated with the Package if the Package is restricted to certain RatePlans
+     */
+    ratePlanCode?: string;
+    name: string;
+    description: string;
+    /**
+     * Whether the price for this package is included in the room rate.
+     * (Always `false` unless the price is zero)
+     */
+    inclusive: boolean;
+    image: string[];
+    url?: string;
+    /**
+     * Defines how a service is priced.
+     * Values:
+     * Per Stay
+     * Per Night
+     * Per Person
+     * Per Person Per Night
+     */
+    pricingType: string;
+    /**
+     * Number of available items for sale.
+     */
+    quantity?: number;
+    category: string;
+    cancelPenalty?: string | null;
+    guaranteeDescription?: string | null;
+    availability: {
+        [date: string]: IPriceInfo;
+    };
+};
+export type IReservedPackage = IPackage & {
+    code?: string | undefined;
+    price?: number;
+    fees?: number;
+    itemisedFees?: IItemisedBookingFeeResponse[];
+    adultQuantity?: number;
+    childQuantity?: number;
+    adultPrice?: number;
+    childPrice?: number;
+    startDate?: string;
+    startTime?: string;
+    hideDatePicker?: boolean;
+    order?: number;
+};
+export type IPriceInfo = {
+    /**
+     * Number of available items for sale.
+     */
+    quantity: number;
+    /**
+     * Price per quantity
+     */
+    price?: number;
+    adultPrice?: number;
+    childPrice?: number;
+    fees?: IAddonPriceDetailsFee[];
+    adultFees?: IAddonPriceDetailsFee[];
+    childFees?: IAddonPriceDetailsFee[];
+    timeSlots?: ITimeSlot[];
+};
+export type ITimeSlot = {
+    /**
+     The start date and time when the package is available.
+     If the package applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates do not
+     include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
+     Type:  DateTime
+     **/
+    startTime?: string;
+    /**
+     The end date / time when the package is available.
+     If the package component applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates
+     do not include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
+     Type:  DateTime
+     */
+    endTime?: string;
+    /**
+     Used with @Start and @End.  Indicates the interval when the package or service is available.
+     For example, a package with golf lessons from 7:30 am to 5:30 pm with instructions and available hourly has the TimeSpan attributes set as: @Start="2015-
+     010-28T07:30:00" and @End="2015-10-28T17:30:00" and @Increment="00:60:00"
+     Type:  Time
+     */
+    increment?: string;
+};

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

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

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

@@ -0,0 +1,83 @@
+import { IRoomstayMemberJWTData } from '../Member/IRoomstayMemberJWTData.type';
+import { IBookingPayment } from './IBookingPayment.type';
+import { ItineraryResponse } from './Itinerary.types';
+import { ICommonQueryParameters } from './ICommonQueryParameters.type';
+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;
+} & 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/Booking/IPrice.type.d.ts

@@ -0,0 +1,7 @@
+export type IPrice = {
+    cost: number;
+    discount: number;
+    tax: number;
+    fee: number;
+    total: number;
+};

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

@@ -0,0 +1,6 @@
+import { EBookingStatus } from './EBookingStatus.type';
+import { IConfirmBookingRequest } from './IConfirmBooking.type';
+export type IRollbackBookingRequest = IConfirmBookingRequest & {
+    status: EBookingStatus.Reverted | EBookingStatus.Cancelled;
+    reason: string;
+};

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

@@ -1,4 +1,4 @@
-import { EBookingPaymentMethod, IPaymentCheckoutDetails } from './IBookingPayment.type';
+import { EBookingPaymentMethod } from './IBookingPayment.type';
 import { ReservedPackage } from '../Package/Package.types';
 export declare class ItineraryResponse {
     roomstayId: string;
@@ -6,7 +6,16 @@ export declare class ItineraryResponse {
     total?: IAmount;
     hotelFrontendId?: string;
     reservations: Reservation[];
-    payment?: IPaymentCheckoutDetails;
+    payment?: {
+        planpay?: {
+            id: string;
+            checkoutWorkflow: ICheckoutWorkflowType;
+        };
+        external?: {
+            id: string;
+            redirectUrl: string;
+        };
+    };
     feesSummary?: IItemisedBookingFeeResponse[];
     itemisedFees?: IItemisedBookingFeeResponse[];
     warnings?: string[];

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

@@ -0,0 +1,89 @@
+import { IAddonPriceDetailsFee } from 'types/Addons/Addon.types';
+import { IItemisedBookingFeeResponse } from './IItineraryResponse';
+export type IPackage = {
+    /**
+     * The SynXis CR RatePlan Code associated with the Package if the Package is restricted to certain RatePlans
+     */
+    ratePlanCode?: string;
+    name: string;
+    description: string;
+    /**
+     * Whether the price for this package is included in the room rate.
+     * (Always `false` unless the price is zero)
+     */
+    inclusive: boolean;
+    image: string[];
+    url?: string;
+    /**
+     * Defines how a service is priced.
+     * Values:
+     * Per Stay
+     * Per Night
+     * Per Person
+     * Per Person Per Night
+     */
+    pricingType: string;
+    /**
+     * Number of available items for sale.
+     */
+    quantity?: number;
+    category: string;
+    cancelPenalty?: string | null;
+    guaranteeDescription?: string | null;
+    availability: {
+        [date: string]: IPriceInfo;
+    };
+};
+export type IReservedPackage = IPackage & {
+    code?: string | undefined;
+    price?: number;
+    fees?: number;
+    itemisedFees?: IItemisedBookingFeeResponse[];
+    adultQuantity?: number;
+    childQuantity?: number;
+    adultPrice?: number;
+    childPrice?: number;
+    startDate?: string;
+    startTime?: string;
+    hideDatePicker?: boolean;
+    order?: number;
+};
+export type IPriceInfo = {
+    /**
+     * Number of available items for sale.
+     */
+    quantity: number;
+    /**
+     * Price per quantity
+     */
+    price?: number;
+    adultPrice?: number;
+    childPrice?: number;
+    fees?: IAddonPriceDetailsFee[];
+    adultFees?: IAddonPriceDetailsFee[];
+    childFees?: IAddonPriceDetailsFee[];
+    timeSlots?: ITimeSlot[];
+};
+export type ITimeSlot = {
+    /**
+     The start date and time when the package is available.
+     If the package applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates do not
+     include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
+     Type:  DateTime
+     **/
+    startTime?: string;
+    /**
+     The end date / time when the package is available.
+     If the package component applies during the whole stay, this node is not returned unless the time needs to be selected.  In that case, the Start and End dates
+     do not include the date: @Start="T07:30:00" and @End="T17:30:00" and @Increment="00:60:00"
+     Type:  DateTime
+     */
+    endTime?: string;
+    /**
+     Used with @Start and @End.  Indicates the interval when the package or service is available.
+     For example, a package with golf lessons from 7:30 am to 5:30 pm with instructions and available hourly has the TimeSpan attributes set as: @Start="2015-
+     010-28T07:30:00" and @End="2015-10-28T17:30:00" and @Increment="00:60:00"
+     Type:  Time
+     */
+    increment?: string;
+};

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

@@ -3,6 +3,5 @@ export declare enum ECompanyProvider {
     Availpro = "Availpro",
     RMS = "RMS",
     Siteminder = "Siteminder",
-    Roomstay = "Roomstay",
-    OHIP = "OHIP"
+    Roomstay = "Roomstay"
 }

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

@@ -10,7 +10,6 @@ export interface IAdminCompany {
     isGiftCardsEnabled: boolean;
     isEventsEnabled: boolean;
     isAnalyticsEnabled: boolean;
-    preventMemberPortalWelcomeEmails: boolean;
     hotels: {
         name: string;
         label: string;
@@ -21,7 +20,6 @@ export interface IAdminCompany {
             clientPassword: string;
             useTrainingDb: boolean;
             apiUrl: string;
-            pencilGuestId?: number;
         };
     }[];
     enableLighthouseAvailability: boolean;

package/dist/types/General/IJsonString.type.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Basic object to wrap a string that is de/encoded as JSON.
+ */
+export type IJsonString = {
+    message: string;
+};

package/dist/types/GiftCards/GiftCard.types.d.ts

@@ -12,9 +12,6 @@ export declare const AddGiftCardSchema: z.ZodObject<{
     notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type IAddGiftCardRequest = z.infer<typeof AddGiftCardSchema>;
-export type IAddGiftCardResponse = IGiftCardDTO & {
-    password: string;
-};
 export type IGiftCardDTO = {
     code: string;
     createdBy?: string | null;

package/dist/types/Hotel/EIntegration.enum.d.ts

@@ -3,6 +3,5 @@ export declare enum EIntegration {
     RmsTop10 = "Top10",
     Top10 = "NewTop10",
     Gday = "Gday",
-    Salesforce = "Salesforce",
-    RAC = "RAC"
+    Salesforce = "Salesforce"
 }