@voyant-travel/storefront-react 0.120.1

package/dist/operations.d.ts

@@ -0,0 +1,827 @@
+import { type FetchWithValidationOptions } from "./client.js";
+import { type StorefrontDepartureListQuery, type StorefrontDeparturePricePreviewInput, type StorefrontOfferApplyInput, type StorefrontOfferRedeemInput, type StorefrontProductExtensionsQuery, type StorefrontPromotionalOfferListQuery, type StorefrontSettingsPatchInput } from "./schemas.js";
+export declare function getStorefrontSettings(client: FetchWithValidationOptions): Promise<{
+    data: {
+        branding: {
+            logoUrl: string | null;
+            faviconUrl: string | null;
+            brandMarkUrl: string | null;
+            primaryColor: string | null;
+            accentColor: string | null;
+            supportedLanguages: string[];
+        };
+        support: {
+            email: string | null;
+            phone: string | null;
+            links: {
+                label: string;
+                url: string;
+            }[];
+        };
+        legal: {
+            termsUrl: string | null;
+            privacyUrl: string | null;
+            cancellationUrl: string | null;
+            defaultContractTemplateId: string | null;
+        };
+        localization: {
+            defaultLocale: string | null;
+            currencyDisplay: "symbol" | "name" | "code";
+        };
+        forms: {
+            billing: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+            travelers: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+        };
+        payment: {
+            defaultMethod: "card" | "bank_transfer" | "cash" | "voucher" | "invoice" | null;
+            methods: {
+                code: "card" | "bank_transfer" | "cash" | "voucher" | "invoice";
+                label: string;
+                description: string | null;
+                enabled: boolean;
+            }[];
+            structure: "split" | "full";
+            schedule: {
+                percent: number;
+                dueInDays: number;
+                dueCondition: "after_booking" | "before_departure";
+            }[];
+            defaultSchedule: {
+                depositPercent: number | null;
+                balanceDueDaysBeforeDeparture: number | null;
+            } | null;
+            bankTransfer: {
+                dueDays: number | null;
+                account: {
+                    provider: string | null;
+                    currency: string | null;
+                    iban: string;
+                    beneficiary: string;
+                    bank: string;
+                } | null;
+                accountHolder: string | null;
+                bankName: string | null;
+                iban: string | null;
+                bic: string | null;
+                paymentReference: string | null;
+                instructions: string | null;
+            } | null;
+        };
+    };
+}>;
+export declare function getAdminStorefrontSettings(client: FetchWithValidationOptions): Promise<{
+    data: {
+        branding: {
+            logoUrl: string | null;
+            faviconUrl: string | null;
+            brandMarkUrl: string | null;
+            primaryColor: string | null;
+            accentColor: string | null;
+            supportedLanguages: string[];
+        };
+        support: {
+            email: string | null;
+            phone: string | null;
+            links: {
+                label: string;
+                url: string;
+            }[];
+        };
+        legal: {
+            termsUrl: string | null;
+            privacyUrl: string | null;
+            cancellationUrl: string | null;
+            defaultContractTemplateId: string | null;
+        };
+        localization: {
+            defaultLocale: string | null;
+            currencyDisplay: "symbol" | "name" | "code";
+        };
+        forms: {
+            billing: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+            travelers: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+        };
+        payment: {
+            defaultMethod: "card" | "bank_transfer" | "cash" | "voucher" | "invoice" | null;
+            methods: {
+                code: "card" | "bank_transfer" | "cash" | "voucher" | "invoice";
+                label: string;
+                description: string | null;
+                enabled: boolean;
+            }[];
+            structure: "split" | "full";
+            schedule: {
+                percent: number;
+                dueInDays: number;
+                dueCondition: "after_booking" | "before_departure";
+            }[];
+            defaultSchedule: {
+                depositPercent: number | null;
+                balanceDueDaysBeforeDeparture: number | null;
+            } | null;
+            bankTransfer: {
+                dueDays: number | null;
+                account: {
+                    provider: string | null;
+                    currency: string | null;
+                    iban: string;
+                    beneficiary: string;
+                    bank: string;
+                } | null;
+                accountHolder: string | null;
+                bankName: string | null;
+                iban: string | null;
+                bic: string | null;
+                paymentReference: string | null;
+                instructions: string | null;
+            } | null;
+        };
+    };
+}>;
+export declare function updateAdminStorefrontSettings(client: FetchWithValidationOptions, input: StorefrontSettingsPatchInput): Promise<{
+    data: {
+        branding: {
+            logoUrl: string | null;
+            faviconUrl: string | null;
+            brandMarkUrl: string | null;
+            primaryColor: string | null;
+            accentColor: string | null;
+            supportedLanguages: string[];
+        };
+        support: {
+            email: string | null;
+            phone: string | null;
+            links: {
+                label: string;
+                url: string;
+            }[];
+        };
+        legal: {
+            termsUrl: string | null;
+            privacyUrl: string | null;
+            cancellationUrl: string | null;
+            defaultContractTemplateId: string | null;
+        };
+        localization: {
+            defaultLocale: string | null;
+            currencyDisplay: "symbol" | "name" | "code";
+        };
+        forms: {
+            billing: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+            travelers: {
+                fields: {
+                    key: string;
+                    label: string;
+                    type: "select" | "textarea" | "text" | "date" | "email" | "tel" | "checkbox" | "country";
+                    required: boolean;
+                    placeholder: string | null;
+                    description: string | null;
+                    autocomplete: string | null;
+                    options: {
+                        value: string;
+                        label: string;
+                    }[];
+                }[];
+            };
+        };
+        payment: {
+            defaultMethod: "card" | "bank_transfer" | "cash" | "voucher" | "invoice" | null;
+            methods: {
+                code: "card" | "bank_transfer" | "cash" | "voucher" | "invoice";
+                label: string;
+                description: string | null;
+                enabled: boolean;
+            }[];
+            structure: "split" | "full";
+            schedule: {
+                percent: number;
+                dueInDays: number;
+                dueCondition: "after_booking" | "before_departure";
+            }[];
+            defaultSchedule: {
+                depositPercent: number | null;
+                balanceDueDaysBeforeDeparture: number | null;
+            } | null;
+            bankTransfer: {
+                dueDays: number | null;
+                account: {
+                    provider: string | null;
+                    currency: string | null;
+                    iban: string;
+                    beneficiary: string;
+                    bank: string;
+                } | null;
+                accountHolder: string | null;
+                bankName: string | null;
+                iban: string | null;
+                bic: string | null;
+                paymentReference: string | null;
+                instructions: string | null;
+            } | null;
+        };
+    };
+}>;
+export declare function getStorefrontDeparture(client: FetchWithValidationOptions, departureId: string): Promise<{
+    data: {
+        id: string;
+        productId: string;
+        itineraryId: string;
+        optionId: string | null;
+        dateLocal: string | null;
+        startAt: string | null;
+        endAt: string | null;
+        timezone: string;
+        startTime: {
+            id: string;
+            label: string | null;
+            startTimeLocal: string;
+            durationMinutes: number | null;
+        } | null;
+        meetingPoint: string | null;
+        capacity: number | null;
+        remaining: number | null;
+        departureStatus: "cancelled" | "on_request" | "open" | "closed" | "sold_out";
+        nights: number | null;
+        days: number | null;
+        ratePlans: {
+            id: string;
+            active: boolean;
+            name: string;
+            pricingModel: string;
+            basePrices: {
+                amount: number;
+                currencyCode: string;
+            }[];
+            roomPrices: {
+                amount: number;
+                currencyCode: string;
+                roomType: {
+                    id: string;
+                    name: string;
+                    occupancy: {
+                        adultsMin: number;
+                        adultsMax: number;
+                        childrenMax: number;
+                    };
+                };
+            }[];
+        }[];
+    };
+}>;
+export declare function listStorefrontProductDepartures(client: FetchWithValidationOptions, productId: string, query?: StorefrontDepartureListQuery): Promise<{
+    data: {
+        id: string;
+        productId: string;
+        itineraryId: string;
+        optionId: string | null;
+        dateLocal: string | null;
+        startAt: string | null;
+        endAt: string | null;
+        timezone: string;
+        startTime: {
+            id: string;
+            label: string | null;
+            startTimeLocal: string;
+            durationMinutes: number | null;
+        } | null;
+        meetingPoint: string | null;
+        capacity: number | null;
+        remaining: number | null;
+        departureStatus: "cancelled" | "on_request" | "open" | "closed" | "sold_out";
+        nights: number | null;
+        days: number | null;
+        ratePlans: {
+            id: string;
+            active: boolean;
+            name: string;
+            pricingModel: string;
+            basePrices: {
+                amount: number;
+                currencyCode: string;
+            }[];
+            roomPrices: {
+                amount: number;
+                currencyCode: string;
+                roomType: {
+                    id: string;
+                    name: string;
+                    occupancy: {
+                        adultsMin: number;
+                        adultsMax: number;
+                        childrenMax: number;
+                    };
+                };
+            }[];
+        }[];
+    }[];
+    total: number;
+    limit: number;
+    offset: number;
+}>;
+export declare function previewStorefrontDeparturePrice(client: FetchWithValidationOptions, departureId: string, input: StorefrontDeparturePricePreviewInput): Promise<{
+    data: {
+        departureId: string;
+        productId: string;
+        optionId: string | null;
+        currencyCode: string;
+        basePrice: number;
+        taxAmount: number;
+        total: number;
+        notes: string | null;
+        lineItems: {
+            name: string;
+            total: number;
+            quantity: number;
+            unitPrice: number;
+        }[];
+        allocation: {
+            slot: {
+                id: string;
+                productId: string;
+                optionId: string | null;
+                dateLocal: string | null;
+                startAt: string | null;
+                endAt: string | null;
+                timezone: string;
+                status: "cancelled" | "on_request" | "open" | "closed" | "sold_out";
+                availabilityState: "cancelled" | "available" | "unavailable" | "on_request" | "closed" | "sold_out" | "past_cutoff" | "too_early";
+                capacity: number | null;
+                remaining: number | null;
+                pastCutoff: boolean;
+                tooEarly: boolean;
+            };
+            pax: {
+                adults: number;
+                children: number;
+                infants: number;
+                total: number;
+            };
+            requestedUnits: {
+                unitId: string | null;
+                requestRef: string | null;
+                name: string;
+                unitType: string | null;
+                quantity: number;
+                pricingMode: string | null;
+                unitPrice: number;
+                total: number;
+                currencyCode: string;
+                tierId: string | null;
+            }[];
+            rooms: {
+                unitId: string;
+                name: string;
+                occupancy: number;
+                quantity: number;
+                pax: number;
+                pricingMode: string | null;
+                unitPrice: number;
+                total: number;
+                currencyCode: string;
+                tierId: string | null;
+            }[];
+        };
+        units: {
+            unitId: string | null;
+            requestRef: string | null;
+            name: string;
+            unitType: string | null;
+            quantity: number;
+            pricingMode: string | null;
+            unitPrice: number;
+            total: number;
+            currencyCode: string;
+            tierId: string | null;
+        }[];
+        rooms: {
+            unitId: string;
+            name: string;
+            occupancy: number;
+            quantity: number;
+            pax: number;
+            pricingMode: string | null;
+            unitPrice: number;
+            total: number;
+            currencyCode: string;
+            tierId: string | null;
+        }[];
+        extras: {
+            extraId: string;
+            name: string;
+            required: boolean;
+            selectable: boolean;
+            selected: boolean;
+            pricingMode: "included" | "per_person" | "per_booking" | "quantity_based" | "on_request" | "free";
+            quantity: number;
+            unitPrice: number;
+            total: number;
+            currencyCode: string;
+        }[];
+        offers: {
+            available: {
+                offer: {
+                    id: string;
+                    name: string;
+                    slug: string | null;
+                    description: string | null;
+                    discountType: "percentage" | "fixed_amount";
+                    discountValue: string;
+                    currency: string | null;
+                    applicableProductIds: string[];
+                    applicableDepartureIds: string[];
+                    validFrom: string | null;
+                    validTo: string | null;
+                    minTravelers: number | null;
+                    imageMobileUrl: string | null;
+                    imageDesktopUrl: string | null;
+                    stackable: boolean;
+                    createdAt: string;
+                    updatedAt: string;
+                };
+                status: "applied" | "not_applicable" | "conflict";
+                reason: "currency" | "conflict" | "min_pax" | "eligibility" | "no_discount" | null;
+                selected: boolean;
+                discountAppliedCents: number;
+                discountedPriceCents: number;
+            }[];
+            requested: {
+                kind: "code" | "slug";
+                value: string;
+                result: {
+                    status: "applied" | "not_applicable" | "conflict" | "invalid";
+                    reason: "currency" | "scope" | "conflict" | "min_pax" | "eligibility" | "no_discount" | "offer_not_found" | "offer_expired" | "offer_not_yet_valid" | "code_not_found" | "code_required" | "code_expired" | "code_not_yet_valid" | "booking_mismatch" | "session_mismatch" | null;
+                    offer: {
+                        id: string;
+                        name: string;
+                        slug: string | null;
+                        description: string | null;
+                        discountType: "percentage" | "fixed_amount";
+                        discountValue: string;
+                        currency: string | null;
+                        applicableProductIds: string[];
+                        applicableDepartureIds: string[];
+                        validFrom: string | null;
+                        validTo: string | null;
+                        minTravelers: number | null;
+                        imageMobileUrl: string | null;
+                        imageDesktopUrl: string | null;
+                        stackable: boolean;
+                        createdAt: string;
+                        updatedAt: string;
+                    } | null;
+                    target: {
+                        bookingId: string | null;
+                        sessionId: string | null;
+                        productId: string;
+                        departureId: string | null;
+                    };
+                    pricing: {
+                        basePriceCents: number;
+                        currency: string;
+                        discountAppliedCents: number;
+                        discountedPriceCents: number;
+                    };
+                    appliedOffers: {
+                        offerId: string;
+                        offerName: string;
+                        discountAppliedCents: number;
+                        discountedPriceCents: number;
+                        currency: string;
+                        discountKind: "percentage" | "fixed_amount";
+                        discountPercent: number | null;
+                        discountAmountCents: number | null;
+                        appliedCode: string | null;
+                        stackable: boolean;
+                    }[];
+                    conflict: {
+                        policy: "best_discount_wins" | "stackable_compose";
+                        autoAppliedOfferIds: string[];
+                        manualOfferId: string | null;
+                        selectedOfferIds: string[];
+                        message: string;
+                    } | null;
+                } | null;
+            }[];
+            applied: {
+                offerId: string;
+                offerName: string;
+                discountAppliedCents: number;
+                discountedPriceCents: number;
+                currency: string;
+                discountKind: "percentage" | "fixed_amount";
+                discountPercent: number | null;
+                discountAmountCents: number | null;
+                appliedCode: string | null;
+                stackable: boolean;
+            }[];
+            conflict: {
+                policy: "best_discount_wins" | "stackable_compose";
+                autoAppliedOfferIds: string[];
+                manualOfferId: string | null;
+                selectedOfferIds: string[];
+                message: string;
+            } | null;
+            discountTotal: number;
+            discountTotalCents: number;
+            totalAfterDiscount: number;
+            currencyCode: string;
+        };
+        totals: {
+            currencyCode: string;
+            base: number;
+            extras: number;
+            subtotal: number;
+            discount: number;
+            tax: number;
+            total: number;
+            perPerson: number;
+            perBooking: number;
+        };
+    };
+}>;
+export declare function listStorefrontProductExtensions(client: FetchWithValidationOptions, productId: string, query?: StorefrontProductExtensionsQuery): Promise<{
+    extensions: {
+        id: string;
+        name: string;
+        label: string;
+        required: boolean;
+        selectable: boolean;
+        hasOptions: boolean;
+        refProductId: string | null;
+        thumb: string | null;
+        pricePerPerson: number | null;
+        currencyCode: string;
+        pricingMode: "included" | "per_person" | "per_booking" | "quantity_based" | "on_request" | "free";
+        defaultQuantity: number | null;
+        minQuantity: number | null;
+        maxQuantity: number | null;
+    }[];
+    items: {
+        id: string;
+        name: string;
+        label: string;
+        required: boolean;
+        selectable: boolean;
+        hasOptions: boolean;
+        refProductId: string | null;
+        thumb: string | null;
+        pricePerPerson: number | null;
+        currencyCode: string;
+        pricingMode: "included" | "per_person" | "per_booking" | "quantity_based" | "on_request" | "free";
+        defaultQuantity: number | null;
+        minQuantity: number | null;
+        maxQuantity: number | null;
+    }[];
+    details: Record<string, {
+        description: string | null;
+        media: {
+            url: string;
+            alt: string | null;
+        }[];
+    }>;
+    currencyCode: string;
+}>;
+export declare function getStorefrontDepartureItinerary(client: FetchWithValidationOptions, productId: string, departureId: string): Promise<{
+    data: {
+        id: string;
+        itineraryId: string;
+        days: {
+            id: string;
+            title: string;
+            description: string | null;
+            thumbnail: {
+                url: string;
+            } | null;
+            segments: {
+                id: string;
+                title: string;
+                description: string | null;
+            }[];
+        }[];
+    };
+}>;
+export declare function listStorefrontProductOffers(client: FetchWithValidationOptions, productId: string, query?: StorefrontPromotionalOfferListQuery): Promise<{
+    data: {
+        id: string;
+        name: string;
+        slug: string | null;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountValue: string;
+        currency: string | null;
+        applicableProductIds: string[];
+        applicableDepartureIds: string[];
+        validFrom: string | null;
+        validTo: string | null;
+        minTravelers: number | null;
+        imageMobileUrl: string | null;
+        imageDesktopUrl: string | null;
+        stackable: boolean;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+}>;
+export declare function getStorefrontOfferBySlug(client: FetchWithValidationOptions, slug: string, query?: Pick<StorefrontPromotionalOfferListQuery, "locale">): Promise<{
+    data: {
+        id: string;
+        name: string;
+        slug: string | null;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountValue: string;
+        currency: string | null;
+        applicableProductIds: string[];
+        applicableDepartureIds: string[];
+        validFrom: string | null;
+        validTo: string | null;
+        minTravelers: number | null;
+        imageMobileUrl: string | null;
+        imageDesktopUrl: string | null;
+        stackable: boolean;
+        createdAt: string;
+        updatedAt: string;
+    };
+}>;
+export declare function applyStorefrontOffer(client: FetchWithValidationOptions, slug: string, input: StorefrontOfferApplyInput): Promise<{
+    data: {
+        status: "applied" | "not_applicable" | "conflict" | "invalid";
+        reason: "currency" | "scope" | "conflict" | "min_pax" | "eligibility" | "no_discount" | "offer_not_found" | "offer_expired" | "offer_not_yet_valid" | "code_not_found" | "code_required" | "code_expired" | "code_not_yet_valid" | "booking_mismatch" | "session_mismatch" | null;
+        offer: {
+            id: string;
+            name: string;
+            slug: string | null;
+            description: string | null;
+            discountType: "percentage" | "fixed_amount";
+            discountValue: string;
+            currency: string | null;
+            applicableProductIds: string[];
+            applicableDepartureIds: string[];
+            validFrom: string | null;
+            validTo: string | null;
+            minTravelers: number | null;
+            imageMobileUrl: string | null;
+            imageDesktopUrl: string | null;
+            stackable: boolean;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+        target: {
+            bookingId: string | null;
+            sessionId: string | null;
+            productId: string;
+            departureId: string | null;
+        };
+        pricing: {
+            basePriceCents: number;
+            currency: string;
+            discountAppliedCents: number;
+            discountedPriceCents: number;
+        };
+        appliedOffers: {
+            offerId: string;
+            offerName: string;
+            discountAppliedCents: number;
+            discountedPriceCents: number;
+            currency: string;
+            discountKind: "percentage" | "fixed_amount";
+            discountPercent: number | null;
+            discountAmountCents: number | null;
+            appliedCode: string | null;
+            stackable: boolean;
+        }[];
+        conflict: {
+            policy: "best_discount_wins" | "stackable_compose";
+            autoAppliedOfferIds: string[];
+            manualOfferId: string | null;
+            selectedOfferIds: string[];
+            message: string;
+        } | null;
+    };
+}>;
+export declare function redeemStorefrontOffer(client: FetchWithValidationOptions, input: StorefrontOfferRedeemInput): Promise<{
+    data: {
+        status: "applied" | "not_applicable" | "conflict" | "invalid";
+        reason: "currency" | "scope" | "conflict" | "min_pax" | "eligibility" | "no_discount" | "offer_not_found" | "offer_expired" | "offer_not_yet_valid" | "code_not_found" | "code_required" | "code_expired" | "code_not_yet_valid" | "booking_mismatch" | "session_mismatch" | null;
+        offer: {
+            id: string;
+            name: string;
+            slug: string | null;
+            description: string | null;
+            discountType: "percentage" | "fixed_amount";
+            discountValue: string;
+            currency: string | null;
+            applicableProductIds: string[];
+            applicableDepartureIds: string[];
+            validFrom: string | null;
+            validTo: string | null;
+            minTravelers: number | null;
+            imageMobileUrl: string | null;
+            imageDesktopUrl: string | null;
+            stackable: boolean;
+            createdAt: string;
+            updatedAt: string;
+        } | null;
+        target: {
+            bookingId: string | null;
+            sessionId: string | null;
+            productId: string;
+            departureId: string | null;
+        };
+        pricing: {
+            basePriceCents: number;
+            currency: string;
+            discountAppliedCents: number;
+            discountedPriceCents: number;
+        };
+        appliedOffers: {
+            offerId: string;
+            offerName: string;
+            discountAppliedCents: number;
+            discountedPriceCents: number;
+            currency: string;
+            discountKind: "percentage" | "fixed_amount";
+            discountPercent: number | null;
+            discountAmountCents: number | null;
+            appliedCode: string | null;
+            stackable: boolean;
+        }[];
+        conflict: {
+            policy: "best_discount_wins" | "stackable_compose";
+            autoAppliedOfferIds: string[];
+            manualOfferId: string | null;
+            selectedOfferIds: string[];
+            message: string;
+        } | null;
+    };
+}>;
+//# sourceMappingURL=operations.d.ts.map