@konnectio/core 4.0.5 → 4.0.7

package/dist/types/index.d.ts

@@ -0,0 +1,868 @@
+export type Translatable = string;
+export type Timer = undefined | number;
+export type Name = [number, string];
+export type metaDataType = 'none' | 'event' | 'gift-card' | 'hotel';
+export interface Time {
+    hours: number | string;
+    minutes: number | string;
+    seconds?: number | string;
+}
+export interface Base64Image {
+    base64: string;
+    type: string;
+    name: string;
+}
+export interface ReepayObject {
+    html_element: string;
+}
+export declare const enum ReepayEvent {
+    Accept = 0,
+    Error = 1,
+    Cancel = 2,
+    Close = 3,
+    Open = 4,
+    CheckResult = 5
+}
+export declare namespace Reepay {
+    class EmbeddedCheckout {
+        constructor(SessionId: string, ReepayObject: ReepayObject);
+        addEventHandler(eventName: ReepayEvent, callback: () => void): void;
+    }
+}
+export declare const enum Layout {
+    Selective = "selective",
+    Wholesale = "wholesale"
+}
+export declare const enum SupportedLanguages {
+    Danish = "da",
+    English = "en",
+    German = "de",
+    Swedish = "se",
+    Norwegian = "no",
+    French = "fr",
+    Turkish = "tr",
+    Spanish = "es",
+    Italian = "it"
+}
+export declare enum QuantityStrategy {
+    Invalid = 0,
+    PerUnit = 1,
+    PerPerson = 2,
+    PerAdult = 3,
+    PerChild = 4,
+    PerNight = 5,
+    PerPersonPerNight = 6,
+    PerAdultPerNight = 7,
+    PerChildPerNight = 8,
+    Consumption = 9,
+    EarlyCheckIn = 10,
+    EarlyCheckOut = 11,
+    OneTimePayment = 12
+}
+export declare const enum OctopusCardinality {
+    Invalid = 0,
+    Mandatory = 1,
+    OptionalSingle = 2,
+    OptionalMultiple = 3,
+    DefaultSingle = 4
+}
+export declare enum PaymentGateway {
+    None = 0,
+    AskForCreditCard = 2,
+    Stripe = 18,
+    DIBS = 47,
+    EasyPay = 56,
+    ReePay = 57
+}
+export interface DibsCheckout {
+    on(key: string, callback: () => void): void;
+    send(key: string, success: boolean): void;
+}
+export interface GTagItem {
+    brand?: string;
+    category?: string;
+    creative_name?: string;
+    creative_slot?: string;
+    id?: string;
+    location_id?: string;
+    name?: string;
+    price?: string | number;
+    quantity?: number;
+}
+export interface RecaptchaResponse {
+    success: boolean;
+}
+export interface WPAuth {
+    nonce: string;
+    url: string;
+}
+export interface TranslationDB {
+    iso: string;
+    message: string;
+}
+export interface KeyString {
+    [key: string]: string;
+}
+export interface KeyQuantity {
+    [key: string]: number;
+}
+export interface KeyBoolean {
+    [key: string]: boolean;
+}
+export interface giftCard {
+    voucher: string;
+    amount: number;
+}
+export interface Translation {
+    [key: string]: string;
+}
+export interface Translations {
+    [key: string]: Translation;
+}
+export interface KeyValue {
+    [key: string]: string | number;
+}
+export interface HashMap {
+    [key: number]: string;
+}
+export interface SchemaField {
+    label: string;
+    key: string;
+    description?: string;
+    locale?: string;
+    type?: string;
+}
+export interface SchemaGroup {
+    title: string;
+    group: Array<SchemaField>;
+}
+export interface Alert {
+    message: Translatable;
+    type: string;
+    status: string;
+    timer: number | undefined;
+    domain: string;
+}
+export interface Option {
+    [key: string]: string | number | null;
+}
+export interface Offer {
+    adultsMin: number;
+    adultsMax: number;
+    adultsRange: number | string;
+    childrenMin?: number;
+    childrenMax?: number;
+    childrenRange?: number | string;
+    hasChildren: boolean;
+    maximumOccupants?: number;
+}
+export interface HTTPParams {
+    hotelName: string;
+    language: string;
+}
+export interface HTTPHeaders {
+    Authorization: string;
+}
+export interface HTTPConfig {
+    params: HTTPParams;
+    headers?: HTTPHeaders;
+}
+export interface ModalStyling {
+    headerColor: string;
+    fontColor: string;
+    fontSize: string;
+    fontFamily: string;
+    panelPadding: string;
+}
+export interface WPSettings {
+    maximumNightsAvailable: string;
+    enableTracking: string;
+    googleApiKey: string;
+    recaptchaSiteKey: string;
+    recaptchaSecretKey: string;
+    maxAdultAmount: string;
+    maxChildAmount: string;
+    firstSelectableDateOffset: string;
+    lastSelectableDateOffset: string;
+    disableAdultSelection: string;
+    disableArrivalUserSelection: string;
+    disableChildSelection: string;
+    disableDepartureUserSelection: string;
+    bookingUri: string;
+    hideTitle: string;
+    headerHeight: string;
+    arrivalDefault: string;
+    arrivalEarliest: string;
+    arrivalLatest: string;
+    departureDefault: string;
+    departureEarliest: string;
+    departureLatest: string;
+    hideArrivalDepartureInputs: string;
+    disableNamePrefix: string;
+    disableGiftCardVoucher: string;
+    enablePackages: string;
+    disablePricesFrom: string;
+    hideAvailableRoomAmount: string;
+    hideEvents: string;
+    hideEventTemplates: string;
+    disableNewsletterSignup: string;
+    disableTravelingFor: string;
+    disableCompanyField: string;
+}
+export interface WPPages {
+    [id: number]: string;
+}
+export interface AvailabilityData {
+    adults: number;
+    children: number;
+    arrivalDate: string;
+    departureDate: string;
+}
+export interface AvailabilityStyling {
+    panelBackground: string;
+    panelPadding: string;
+    panelBorder: string | null;
+    panelBorderRadius: string;
+    inputBorder: string;
+    inputBackground: string;
+    inputBorderRadius: string;
+    headerColor: string;
+    headerFontSize: string;
+    labelFontWeight: string;
+    labelPadding: string;
+    buttonTextTransform: string;
+    buttonFontFamily: string;
+    buttonBackground: string;
+    buttonColor: string;
+    buttonBorderRadius: string;
+    buttonFontWeight: string;
+    buttonFontSize: string;
+    buttonBorder: string;
+    accentColor: string;
+    accentSecondaryColor: string;
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    linkColor: string;
+    calendarWeekendColor: string;
+    calendarHighlightedColor: string;
+}
+export interface BookingStyling {
+    panelBackground: string;
+    panelPadding: string;
+    panelBorder: string | null;
+    panelBorderRadius: string;
+    inputBorder: string;
+    inputBackground: string;
+    inputBorderRadius: string;
+    labelFontWeight: string;
+    labelPadding: string;
+    headerColor: string;
+    buttonTextTransform: string;
+    buttonFontFamily: string;
+    buttonBackground: string;
+    buttonColor: string;
+    buttonBorderRadius: string;
+    buttonFontWeight: string;
+    buttonFontSize: string;
+    accentColor: string;
+    accentSecondaryColor: string;
+    fontFamily: string;
+    fontSize: string;
+    fontColor: string;
+    grayColor: string;
+    loadingColor: string;
+    successColor: string;
+    dangerColor: string;
+    calendarWeekendColor: string;
+    calendarHighlightedColor: string;
+}
+export declare enum BookingLayout {
+    Selective = "selective",
+    Wholesale = "wholesale",
+    Simplified = "simplified",
+    Template = "template",
+    Event = "event"
+}
+export declare enum BookingHeaderLayout {
+    Default = "default",
+    Minimal = "minimal"
+}
+export interface ButtonStyling {
+    textTransform: string;
+    fontFamily: string;
+    background: string;
+    color: string;
+    borderRadius: string;
+    fontWeight: string;
+    fontSize: string;
+}
+export interface GuestData {
+    name: string;
+    email: string;
+    firmName: string | null;
+    phone: string;
+    country: string;
+    address1: string;
+    postal: string | number;
+    city: string;
+}
+export interface Step {
+    id: string;
+    label?: Translatable;
+    buttonLabel?: Translatable;
+    icon?: string;
+    validation?: boolean;
+    hidden?: boolean;
+}
+export interface OctopusFacility {
+    readonly facilityID: number;
+    readonly id: number;
+    readonly isTopFacility: boolean;
+    readonly name: string;
+}
+export interface FacilityGroup {
+    [key: string]: Array<RoomFacility>;
+}
+export interface OctopusHotelImage {
+    readonly imageUrl: string;
+}
+export interface OctopusOfferGuest {
+    name: string;
+    email: string;
+    phone: string;
+}
+export interface OctopusOfferRoom {
+    id: number;
+    checkOutTime: string;
+    roomName: string;
+    totalPrice: number;
+    leaveDate: string;
+    arriveDate: string;
+}
+export interface OctopusOfferOrderLineSummary {
+    productName: string;
+    quantity: number;
+    totalPrice: number;
+    unitPrice: number;
+}
+export interface OctopusOffer {
+    id: number;
+    guest: OctopusOfferGuest;
+    totalVAT: number;
+    totalPrice: number;
+    offerDate: string;
+    adults: number;
+    children: number;
+    uniqueID: string;
+    orderLinesSummary: Array<OctopusOfferOrderLineSummary>;
+    rooms: Array<OctopusOfferRoom>;
+}
+export interface EasyPayment {
+    checkoutSecretKey: string;
+    paymentID: string;
+}
+interface Error {
+    [key: string]: Array<string>;
+}
+export interface OctopusCreateReservationResponse {
+    offer: OctopusOffer;
+    easyPayment?: EasyPayment;
+    error?: Error;
+}
+export interface OctopusGuest {
+    travellingFor?: string;
+    title?: Translatable;
+    guestID: number;
+    name: string;
+    email: string;
+    firmName?: string;
+    phone: string;
+    country?: string;
+    address1?: string;
+    postal?: string;
+    city?: string;
+    newsmails: boolean;
+}
+export interface OctopusSelectedRoom {
+    templateID?: number;
+    roomGroupID: number;
+    ratePlanID: number | null;
+    adultsCount: number;
+    childrenCount: number;
+    guest: OctopusGuest;
+    roomAddons?: Array<RoomAddon>;
+}
+export interface SelectedRoom {
+    roomName: string;
+    roomGroupID: number;
+    ratePlanID: number;
+    children: number;
+    adults: number;
+    guestName: string;
+    guestNameTitle: number;
+    guestEmail: string;
+    guestPhone: string;
+}
+export interface SelectedRoomPreview {
+    name: string;
+    roomGroupID: number;
+    ratePlanID: number;
+    adults: number;
+    children: number;
+    amount: number;
+    index?: number;
+    price: number;
+}
+export interface OctopusOccupant {
+    occupantRates: Array<OctopusOccupantRate>;
+    readonly ratePlan: OctopusRatePlan;
+}
+export interface OctopusRatePlan {
+    readonly extraAdultRate: number;
+    readonly extraChildRate: number;
+    readonly id: number;
+    readonly roomGroupID: number;
+    readonly roomGroupRatePlanID: number;
+    readonly maximumOccupants: number;
+    readonly ratePlanID: number;
+}
+export interface OctopusOccupantRate {
+    readonly uid: string;
+    readonly adultsCount: number;
+    readonly childrenCount: number;
+    readonly price: number;
+    readonly ratePlanID: number;
+    readonly roomGroupID: number;
+    readonly rooms: number;
+    readonly totalPrice: number;
+}
+export interface OctopusHotelRackRate {
+    breakfastIncluded: boolean;
+    cancellationHourLimit: number;
+    extraAdultRate: number;
+    extraChildRate: number;
+    extraInfantRate: number;
+    id: number;
+    includedOccupants: number;
+    isDefault: boolean;
+    maximumAdults: number;
+    maximumChildren: number;
+    maximumInfants: number;
+    maximumOccupants: number;
+    name: string;
+    rackRate: number;
+    roomGroupID: number;
+    roomGroupName: string;
+    roomGroupRatePlanID: number;
+    showOnBookingForm: boolean;
+    showOnOnlineBooking: boolean;
+    occupantRates?: Array<OctopusOccupantRate>;
+}
+export interface OctopusRoomGroup {
+    readonly name: string;
+    readonly roomGroupId: number;
+    readonly available: number;
+    readonly description: string;
+    occupantRates?: Array<OctopusOccupantRate>;
+}
+export interface OctopusAvailableRoomGroup {
+    readonly extraPrice: number;
+    readonly isDefault: boolean;
+    readonly roomGroupID: number;
+    readonly roomGroupName: string;
+    readonly totalPrice: number;
+}
+export interface OctopusTemplate {
+    readonly description: string;
+    readonly id: number;
+    readonly templateRoomGroups: Array<OctopusAvailableRoomGroup>;
+    readonly name: string;
+    readonly imageUrl?: string;
+    readonly weekendFee: number;
+}
+interface OctopusNextAvailableDate {
+    fromDate: string;
+    toDate: string;
+    roomCount: number;
+    priceStartFrom: number;
+}
+export interface OctopusListing {
+    readonly roomGroups: Array<FreshBookingRoom>;
+    readonly templates: Array<OctopusTemplate>;
+    readonly nextAvailableDates: Array<OctopusNextAvailableDate>;
+}
+export interface AvailableRoomAddon {
+    [key: number]: Array<RoomAddon>;
+}
+export interface RoomAddon {
+    addonID: number;
+    cardinality?: number;
+    id: number;
+    maximumNumber?: number;
+    name?: string;
+    price?: number;
+    quantity: number;
+    quantityStrategy?: number;
+}
+export interface RoomGroupImage {
+    readonly imageUrl: string;
+    readonly roomGroupID: number;
+}
+export interface RoomGroupFacility {
+    readonly facilityID: number;
+    readonly isTopFacility: boolean;
+    readonly roomGroupID: number;
+}
+export interface OctopusHotelImage {
+    readonly imageUrl: string;
+}
+export interface OctopusFacility {
+    readonly facilityTypeID: number;
+    readonly parentFacilityTypeID?: number;
+    readonly id: number;
+    readonly facilityTypeName: string;
+    readonly name: string;
+}
+export interface OctopusSettings {
+    readonly roomGroupImages: Array<RoomGroupImage>;
+    readonly roomGroupFacilities: Array<RoomGroupFacility>;
+    readonly hotelImages: Array<OctopusHotelImage>;
+    readonly hotelName: string;
+}
+export interface OctopusDetails {
+    readonly automaticRoomPlacement: boolean;
+    readonly currencyID: number;
+    readonly requireDeposit: boolean;
+}
+export interface OctopusCountry {
+    readonly id: number;
+    readonly name: string;
+    readonly isO2Code: string;
+}
+interface Currency {
+    id: number;
+    currencyCode: string;
+    name: string;
+}
+export interface RoomImage {
+    '1x': string;
+    '2x': string;
+    thumb: string;
+    roomGroupID: number;
+}
+export interface RoomFacility {
+    name: string;
+    category: string;
+    categoryID: number;
+    roomGroupID: number;
+}
+export interface FreshBookingImage {
+    large: string | null;
+    medium: string | null;
+    thumb: string | null;
+    url: string;
+}
+export interface Country {
+    id: number;
+    iso: string;
+    name: string;
+}
+interface HotelAddon {
+    id: number;
+    maximumNumber: number;
+    name: string;
+    price: number;
+}
+export interface HotelSubFacility {
+    name: string;
+}
+export interface HotelFacility {
+    name: string;
+    icon: string | null;
+    subFacilities: HotelSubFacility[];
+}
+interface HotelOccupantRate {
+    adultsCount: number;
+    childrenCount: number;
+    hasBreakfast: boolean;
+    includedOccupants: number;
+    index: number;
+    occupants: number;
+    price: number;
+    priceWithOutAddons: number;
+    ratePlanID: number;
+    roomGroupID: number;
+    rooms: number;
+    totalPrice: number;
+}
+export interface HotelRate {
+    cancellationHourLimit: number;
+    extraAdultRate: number;
+    extraChildrenRate: number;
+    id: number;
+    includedOccupants: number;
+    isBreakfastIncluded: boolean;
+    isDefault: boolean;
+    maximumAdults: number;
+    maximumChildren: number;
+    maximumOccupants: number;
+    name: string;
+    occupantRates: HotelOccupantRate[];
+    occupantRateIndex: number | null;
+    rackRate: number;
+}
+export interface FreshBookingRoom {
+    addons: HotelAddon[];
+    description: string | null;
+    facilities: HotelFacility[];
+    id: number;
+    images: FreshBookingImage[];
+    rates: HotelRate[];
+    title: string;
+}
+export interface OctopusMetaData {
+    country: Country;
+    countries: Array<Country>;
+    name: string;
+    currency: Currency;
+    hotelImages: Array<FreshBookingImage>;
+    shortDescription: string;
+    longDescription: string;
+    paymentGatewayId: PaymentGateway;
+    termsOfService: string;
+    website: string;
+}
+export interface CheckoutThemeOptions {
+    textColor: string;
+    primaryColor: string;
+    buttonRadius: string;
+    buttonTextColor: string;
+    linkColor: string;
+    footerBackgroundColor: string;
+    footerOutlineColor: string;
+    footerTextColor: string;
+    backgroundColor: string;
+    panelColor: string;
+    outlineColor: string;
+    primaryOutlineColor: string;
+    panelTextColor: string;
+    panelLinkColor: string;
+    fontFamily: string;
+    buttonFontWeight: string;
+    buttonFontStyle: string;
+    buttonTextTransform: string;
+    panelOutlineColor: string;
+    placeholderColor: string;
+    useLightIcons: boolean;
+    useLightFooterIcons: boolean;
+}
+export interface CheckoutOptions {
+    checkoutKey: string;
+    paymentId: string;
+    containerId: string;
+    language: string;
+    theme: CheckoutThemeOptions;
+}
+interface FreshBookingProduct {
+    title: string;
+    icon: string;
+    access?: boolean;
+}
+export interface FreshBookingProducts {
+    [key: string]: FreshBookingProduct;
+}
+export interface OctopusGiftCardValidationData {
+    amount: number;
+    expirationDate: string;
+    productName: string;
+    valid: boolean;
+}
+export interface OctopusPlace extends Option {
+    id: number;
+    name: string;
+    placeType: number;
+}
+export interface OctopusGiftCardRestaurant {
+    currencyCode: string;
+    currencyID: number;
+}
+interface Language {
+    name: string;
+    shortName: string;
+    nativeName: string;
+    image: FreshBookingImage;
+}
+export interface OctopusGiftCardMetaData {
+    currency: Currency;
+    giftCardExpirationMonths: number;
+    images: FreshBookingImage[];
+    languages: Language[];
+    name: string;
+    paymentGatewayId: number;
+    places: Array<OctopusPlace>;
+    template: unknown[];
+    termsOfService: string;
+}
+export interface PlaceData {
+    label: Translatable;
+    data: Array<OctopusPlace>;
+}
+export interface Place {
+    [key: number]: PlaceData;
+}
+export declare enum GiftCardModuleState {
+    InitialState = 0,
+    WaitingForResponse = 1,
+    ReadyToPay = 2,
+    PaymentSuccess = 3
+}
+export interface EventAddon {
+    [key: string]: number;
+}
+export declare enum OctopusEventRateType {
+    None = 0,
+    Hourly = 1,
+    FullDayEvent = 2,
+    Weekly = 3
+}
+export interface ListingImage {
+    '1x': string;
+    '2x': string;
+    thumb: string;
+    eventID?: number;
+    roomGroupID?: number;
+}
+export type actionType = 'default' | 'success' | 'info' | 'danger';
+export interface OctopusEventMetaDataTableGroup {
+    id: number;
+    name: string;
+}
+export interface EventProduct {
+    [key: number]: number;
+}
+export interface OctopusEventMetaData {
+    currency: string;
+    description: string;
+    maxNumberPerBooking: number;
+    subtitle: string;
+    title: string;
+    slideshow: Array<string>;
+    eventImages: Array<ListingImage>;
+}
+export interface OctopusRestaurantTemplate {
+    description: string;
+    fromDate: string;
+    fromDateTime: string;
+    fromPrice: number;
+    id: number;
+    imageUrl?: string;
+    minimumPersonCount: number;
+    name: string;
+    toDate: string;
+}
+export interface OctopusEventProductTemplate {
+    description: string;
+    orderBy: number;
+    price: number;
+    productID: number;
+    productName: string;
+    productTabID: number;
+}
+interface OctopusEventOptionTemplate {
+    id: number;
+    name: string;
+    orderBy: number;
+    type: number;
+}
+export interface OctopusEventTemplate {
+    capacity: number;
+    days: string;
+    eventRateType?: OctopusEventRateType;
+    description?: string;
+    fromDate: string;
+    hideLocationOnline: boolean;
+    id: number;
+    isAvailability: boolean;
+    length: string;
+    maxOnlineReservationLimit: number;
+    name: string;
+    options: Array<OctopusEventOptionTemplate>;
+    showAllwaysOnline: boolean;
+    soldOut?: boolean;
+    products?: Array<OctopusEventProductTemplate>;
+    tableGroupID: number;
+    timeFrom: string;
+    timeTo: string;
+    toDate: string;
+}
+export interface OctopusRestaurantEventData {
+    templates: Array<OctopusRestaurantTemplate>;
+    events: Array<OctopusEventTemplate>;
+}
+export interface OctopusEventAvailabilityTemplateAddon {
+    addonID: number;
+    cardinality: number;
+    created: string;
+    id: number;
+    name: string;
+    offerID: number;
+    offerRoomID: number;
+    price: number;
+    quantity: number;
+    quantityStrategy: number;
+    state: number;
+}
+export interface OctopusEventAvailabilityTemplate {
+    addons: Array<OctopusEventAvailabilityTemplateAddon>;
+    adultPerRoom: number;
+    count: number;
+    roomGroupID: number;
+    roomUpgrade: number;
+    totalPrice: number;
+    unitPrice: number;
+    weekendFee: number;
+}
+export interface OctopusEventAvailabilityEventTables {
+    id: number;
+    isHidden: boolean;
+    name: string;
+    orderBy: number;
+    tableGroupID: number;
+}
+export interface OctopusEventAvailabilityEvent {
+    availableTables: Array<OctopusEventAvailabilityEventTables>;
+    numberOfPeople: number;
+    numberOfTables: number;
+    time: string;
+    unitPrice: number;
+    price?: number;
+    untilDate: string;
+}
+export interface OctopusEventAvailability {
+    fromDate: string;
+    localTime: string;
+    numberOfDays: number;
+    packageCount: number;
+    templateCounts: Array<OctopusEventAvailabilityTemplate>;
+    templateID: number;
+    totalPerson: number;
+    totalPrice: number;
+}
+export interface TemplateGroupAddonPayload {
+    addonID: number;
+    quantity: number;
+}
+export interface TemplateGroupPayload {
+    roomGroupID: number;
+    addons: Array<TemplateGroupAddonPayload>;
+    count: number;
+    adultPerRoom: number;
+}
+export declare enum EventModuleState {
+    InitialState = 0,
+    AvailabilityState = 1,
+    ReservationState = 2,
+    PaymentState = 3
+}
+export {};