@hubbyesim/sdk 2.1.0

package/dist/index.d.cts

@@ -0,0 +1,1877 @@
+type Fetch = (request: Request) => Promise<Response>;
+type RetryOptions = {
+    /** Total attempts, the first included. Default 3. */
+    maxAttempts?: number;
+    /** The longest wait before a retry. A longer `Retry-After` is answered, not waited out. Default 30 000. */
+    maxDelayMs?: number;
+    /** The first wait after a network error or a 429 without `Retry-After`, doubled per attempt. Default 500. */
+    baseDelayMs?: number;
+};
+
+type SigningClientOptions = {
+    /** Your public key id, sent as `X-Api-Key`. */
+    apiKey: string;
+    /** Your secret. It signs requests and never leaves your server. */
+    apiSecret: string;
+    /** For example `https://core.hubbyesim.com/api`. */
+    baseUrl: string;
+    /** The `fetch` to send with. Default: the global `fetch`. */
+    fetch?: Fetch;
+    /** Epoch milliseconds. Default: `Date.now`. */
+    now?: () => number;
+    /** Waits between retries. Default: `setTimeout`. */
+    sleep?: (milliseconds: number) => Promise<void>;
+    /** Retry policy for 429s and network errors, or `false` to send each request once. */
+    retry?: RetryOptions | false;
+};
+
+/**
+ * AnalyticsActivation
+ */
+type AnalyticsActivation = {
+    /**
+     * Activated over claimed, as a rate.
+     */
+    rate: AnalyticsRatio;
+    /**
+     * Booking codes first claimed in the judged part of the range.
+     */
+    claimed: number;
+    /**
+     * Of those, how many had their eSIM package activated within the window.
+     */
+    activated: number;
+    /**
+     * How long after the first claim an activation still counts, in days.
+     */
+    window_days: number;
+    /**
+     * The part of the range old enough to judge, as UTC dates with both ends included; null when none of it is.
+     */
+    judged_range: {
+        /**
+         * First judged day (UTC).
+         */
+        from: string;
+        /**
+         * Last judged day (UTC).
+         */
+        to: string;
+    } | null;
+    /**
+     * True when the whole range is too recent to judge, so no rate is given; read it as "too early to tell", not as a low rate.
+     */
+    is_immature: boolean;
+};
+/**
+ * AnalyticsBreakdowns
+ */
+type AnalyticsBreakdowns = {
+    /**
+     * Codes issued in the range, by destination. Includes codes of bookings moved over from the previous platform.
+     */
+    destinations: {
+        /**
+         * Codes issued in the range that have a destination. The `top` counts add up to it.
+         */
+        codes: number;
+        /**
+         * Every destination with a code issued in the range, most codes first.
+         */
+        top: Array<AnalyticsDestinationCount>;
+    };
+    /**
+     * Codes issued in the range, by bundle size. Includes codes of bookings moved over from the previous platform.
+     */
+    bundle_sizes: {
+        /**
+         * Codes issued in the range. The `distribution` counts add up to it.
+         */
+        codes: number;
+        /**
+         * One row per bundle size, most codes first.
+         */
+        distribution: Array<AnalyticsBundleSizeCount>;
+    };
+    /**
+     * Discounts given on payments that went through in the range.
+     */
+    discounts: {
+        /**
+         * Payments in the range that carried a discount of any kind: a discount code, a limited-time offer or an upgrade offer.
+         */
+        discounted_payments: number;
+        /**
+         * The discount given through each discount code, per currency. A discount from an offer has no code, so it is counted in `discounted_payments` only.
+         */
+        by_code: Array<AnalyticsDiscountCode>;
+    };
+};
+/**
+ * AnalyticsBundleSizeCount
+ */
+type AnalyticsBundleSizeCount = {
+    /**
+     * The bundle's data allowance in bytes. Null for an unlimited bundle.
+     */
+    size_bytes: number | null;
+    /**
+     * The size as a reader would say it, in binary units (`5GB` is 5 × 1024³ bytes), or `Unlimited`.
+     */
+    label: string;
+    /**
+     * Codes issued in the range with this bundle size.
+     */
+    count: number;
+};
+/**
+ * AnalyticsDestinationCount
+ */
+type AnalyticsDestinationCount = {
+    /**
+     * The destination's id. A destination withdrawn since keeps its row and its name.
+     */
+    id: string;
+    /**
+     * The destination's name.
+     */
+    name: string;
+    /**
+     * Codes issued in the range for this destination.
+     */
+    count: number;
+};
+/**
+ * AnalyticsDiscountCode
+ */
+type AnalyticsDiscountCode = {
+    /**
+     * The discount code as travellers enter it.
+     */
+    code: string;
+    /**
+     * The discount given through this code in the range, per ISO 4217 currency code, in integer minor units. Currencies are never converted or added together.
+     */
+    discount: {
+        [key: string]: number;
+    };
+};
+/**
+ * AnalyticsFunnel
+ */
+type AnalyticsFunnel = {
+    /**
+     * Always `new`: the funnel covers bookings made on this platform only. Bookings moved over from the previous platform are left out, so `cohort.codes` can differ from the summary's `bookings.total`, which includes them.
+     */
+    population: string;
+    /**
+     * The codes the funnel follows.
+     */
+    cohort: {
+        /**
+         * Booking codes (one per traveller) of the new bookings created in the range: the funnel's first step.
+         */
+        codes: number;
+        /**
+         * The new bookings those codes belong to.
+         */
+        bookings: number;
+        /**
+         * Codes of bookings moved over from the previous platform, left out of the funnel.
+         */
+        moved_over_codes_excluded: number;
+        /**
+         * Codes of test bookings, left out of the funnel.
+         */
+        test_codes_excluded: number;
+    };
+    /**
+     * True when the range ended within the last 14 days and has codes: travellers are still claiming, installing and activating, so later steps are still climbing. Read low rates as "too early to tell".
+     */
+    is_immature: boolean;
+    /**
+     * The steps, in order: `codes_issued`, `claimed`, `paid`, `esim_installed`, `package_activated`, `used_data`. Empty when no new booking was created in the range.
+     */
+    steps: Array<AnalyticsFunnelStep>;
+    /**
+     * The `dimension` the funnel is broken down by, as requested; null when none was.
+     */
+    dimension: string | null;
+    /**
+     * The funnel split by `dimension`, one group per value, whose codes and step counts add up to the funnel above. Null when no `dimension` was requested or no new booking was created in the range.
+     */
+    breakdown: Array<AnalyticsFunnelGroup> | null;
+};
+/**
+ * AnalyticsFunnelGroup
+ */
+type AnalyticsFunnelGroup = {
+    /**
+     * The dimension's value: a destination id, a bundle size in bytes, a sales channel, a booking source or a transaction type. Null for the codes that have none: an unlimited bundle has no size, and a code not sold in the app has no sales channel or transaction type.
+     */
+    value: string | null;
+    /**
+     * A readable name for the value: the destination's name or the bundle size (for example "5GB"), otherwise the value itself. Null when the value is null.
+     */
+    label: string | null;
+    /**
+     * This group's part of `cohort.codes`.
+     */
+    codes: number;
+    /**
+     * This group's funnel, with the same steps as the whole funnel.
+     */
+    steps: Array<AnalyticsFunnelStep>;
+};
+/**
+ * AnalyticsFunnelStep
+ */
+type AnalyticsFunnelStep = {
+    /**
+     * Which step: `codes_issued` (every booking code of the bookings created in the range), `claimed` (the traveller claimed the code), `paid` (the code was paid for in the app; only codes sold in the app can be), `esim_installed` (the eSIM carrying the code's package was installed), `package_activated` (the package went live on the network, at any time after the booking was created, with no 14-day window) or `used_data` (the package carried its first byte of data). Always in this order.
+     */
+    step: string;
+    /**
+     * `recorded` when the step is counted; `not_recorded` when no code in the funnel has a record of it, so it cannot be counted and is skipped as the previous step of the next one; `not_applicable` when it cannot happen to any code in the funnel (`paid`, when no code was sold in the app).
+     */
+    status: string;
+    /**
+     * How many codes reached this step, whenever that happened. For `paid`, out of the codes sold in the app only. Null when the step is not recorded or not applicable.
+     */
+    count: number | null;
+    rate: AnalyticsRatio | null;
+    share_of_codes: AnalyticsRatio | null;
+};
+/**
+ * AnalyticsMeta
+ */
+type AnalyticsMeta = {
+    /**
+     * The range the figures cover, as UTC dates with both ends included.
+     */
+    range: {
+        /**
+         * First day (UTC).
+         */
+        from: string;
+        /**
+         * Last day (UTC).
+         */
+        to: string;
+    };
+    /**
+     * Days are UTC days, always: a day runs from 00:00:00 to 23:59:59 UTC.
+     */
+    timezone: 'UTC';
+    /**
+     * When these figures were computed. A repeated request within 15 minutes is answered from the same computation, so this can be up to 15 minutes ago.
+     */
+    computed_at: string;
+    /**
+     * The Partners whose figures are included: your own and, with key inheritance, your descendants that are included.
+     */
+    partner_ids: Array<string>;
+    /**
+     * Descendants left out of every figure because they have not moved to this platform yet, with their names. Empty for a key without key inheritance.
+     */
+    excluded_partners: Array<{
+        id: string;
+        name: string;
+    }>;
+    /**
+     * Present when the range starts before the Partner moved to this platform: activity before that day is on the previous platform and is not in these figures. Null otherwise.
+     */
+    cut_over_note: string | null;
+};
+/**
+ * AnalyticsPartnerContribution
+ */
+type AnalyticsPartnerContribution = {
+    /**
+     * The Partner these figures are for, one of `meta.partner_ids`.
+     */
+    partner_id: string;
+    /**
+     * The Partner's name, to label the row with.
+     */
+    name: string;
+    /**
+     * This Partner's part of `bookings.total`.
+     */
+    bookings: number;
+    /**
+     * This Partner's part of `customers.total`.
+     */
+    customers: number;
+    /**
+     * This Partner's part of `revenue_net`, per ISO 4217 currency code, in integer minor units. Empty when there was none.
+     */
+    revenue_net: {
+        [key: string]: number;
+    };
+    /**
+     * This Partner's part of `data_consumed_bytes`, in bytes.
+     */
+    data_consumed_bytes: number;
+};
+/**
+ * AnalyticsRatio
+ */
+type AnalyticsRatio = {
+    /**
+     * The rate as a percentage from 0 to 100, rounded to two decimals; null when suppressed.
+     */
+    value: number | null;
+    /**
+     * True when the denominator is below 30 records, too few for the rate to mean anything.
+     */
+    suppressed: boolean;
+    /**
+     * How many records met the condition.
+     */
+    numerator: number;
+    /**
+     * How many records the rate is out of.
+     */
+    denominator: number;
+};
+/**
+ * AnalyticsSummary
+ */
+type AnalyticsSummary = {
+    /**
+     * Bookings created in the range, test bookings left out. Includes bookings moved over from the previous platform, created here on the day they moved.
+     */
+    bookings: {
+        /**
+         * New plus moved over.
+         */
+        total: number;
+        /**
+         * Bookings made on this platform.
+         */
+        new: number;
+        /**
+         * Bookings moved over from the previous platform.
+         */
+        moved_over: number;
+        /**
+         * Test bookings created in the range and left out of every figure.
+         */
+        tests_excluded: number;
+    };
+    /**
+     * Customers (travellers) gained in the range.
+     */
+    customers: {
+        /**
+         * New plus moved over.
+         */
+        total: number;
+        /**
+         * Customers who first appeared on this platform.
+         */
+        new: number;
+        /**
+         * Customers moved over from the previous platform.
+         */
+        moved_over: number;
+    };
+    /**
+     * Bookings departing from today onwards, whatever the range.
+     */
+    departing_from_today: {
+        /**
+         * Departing between today and 30 days from today (UTC).
+         */
+        next_30d: number;
+        /**
+         * Departing between today and 60 days from today (UTC).
+         */
+        next_60d: number;
+        /**
+         * Departing between today and 90 days from today (UTC).
+         */
+        next_90d: number;
+    };
+    /**
+     * The 14-day claim-to-activation rate for codes claimed in the range.
+     */
+    activation: AnalyticsActivation;
+    /**
+     * Net revenue in the range: purchases minus refunds, per ISO 4217 currency code, in integer minor units. Currencies are never converted or added together. Empty when there was none.
+     */
+    revenue_net: {
+        [key: string]: number;
+    };
+    /**
+     * Mobile data your travellers used in the range on packages sold through this platform, in bytes.
+     */
+    data_consumed_bytes: number;
+    /**
+     * Packages sold through this platform that started using data in the range.
+     */
+    used_data_packages: number;
+    /**
+     * Each Partner in `meta.partner_ids`, with its part of bookings, customers, net revenue and data consumed. The rows add up to the totals above. One row when the figures are for your own Partner alone.
+     */
+    by_partner: Array<AnalyticsPartnerContribution>;
+    /**
+     * The same headline figures for the preceding period of equal length, when `compare` was set. Null otherwise.
+     */
+    comparison: {
+        /**
+         * The preceding period, as UTC dates with both ends included.
+         */
+        range: {
+            /**
+             * First day (UTC).
+             */
+            from: string;
+            /**
+             * Last day (UTC).
+             */
+            to: string;
+        };
+        /**
+         * Bookings created in the preceding period, counted as `bookings.total` is.
+         */
+        bookings: number;
+        /**
+         * Net revenue in the preceding period, per currency, in integer minor units.
+         */
+        revenue_net: {
+            [key: string]: number;
+        };
+        /**
+         * Data used in the preceding period on packages sold through this platform, in bytes.
+         */
+        data_consumed_bytes: number;
+        /**
+         * The activation rate for codes claimed in the preceding period.
+         */
+        activation: AnalyticsActivation;
+        /**
+         * Packages that started using data in the preceding period.
+         */
+        used_data_packages: number;
+    } | null;
+};
+/**
+ * AnalyticsTimeseries
+ */
+type AnalyticsTimeseries = {
+    /**
+     * The bucket every row covers: `day`, `week` (ISO weeks, Monday to Sunday) or `month`.
+     */
+    bucket: string;
+    /**
+     * One row per bucket, oldest first, from the bucket holding `meta.range.from` to the bucket holding `meta.range.to`.
+     */
+    series: Array<AnalyticsTimeseriesBucket>;
+};
+/**
+ * AnalyticsTimeseriesBucket
+ */
+type AnalyticsTimeseriesBucket = {
+    /**
+     * The bucket's first day (UTC): the day itself, the Monday of the week, or the first of the month. A week or month bucket at either end of the range can start before or end after it; only the days inside the range are counted.
+     */
+    date: string;
+    /**
+     * Bookings created in the bucket, test bookings left out. Includes bookings moved over from the previous platform, created here on the day they moved.
+     */
+    bookings_created: number;
+    /**
+     * Bookings whose departure date falls in the bucket, test bookings left out, moved-over bookings included. This follows the requested range, unlike the summary's `departing_from_today`, which always looks forward from today.
+     */
+    bookings_departing: number;
+    /**
+     * Bookings cancelled in the bucket, test bookings left out, moved-over bookings included.
+     */
+    bookings_cancelled: number;
+    /**
+     * Customers (travellers) gained in the bucket.
+     */
+    customers: number;
+    /**
+     * Net revenue in the bucket: purchases minus refunds, per ISO 4217 currency code, in integer minor units. Currencies are never converted or added together. Empty when there was none.
+     */
+    revenue_net: {
+        [key: string]: number;
+    };
+    /**
+     * Mobile data your travellers used in the bucket on packages sold through this platform, in bytes.
+     */
+    data_consumed_bytes: number;
+};
+/**
+ * Booking
+ */
+type Booking = {
+    id: string;
+    partner_id: string;
+    visual_identity_id: string | null;
+    external_reference: string | null;
+    external_reference_secondary: string | null;
+    source: BookingSource;
+    depart_at: string | null;
+    return_at: string | null;
+    locale: string | null;
+    email: string | null;
+    phone: string | null;
+    first_name: string | null;
+    last_name: string | null;
+    full_name: string | null;
+    title: string | null;
+    gender: string | null;
+    date_of_birth: string | null;
+    pax: number | null;
+    flight_number: string | null;
+    departure_location: string | null;
+    /**
+     * The partner `data` blob is write-only: a resource field named
+     * `data` would collide with the response's `data` wrapper (Laravel
+     * skips wrapping when the key already exists).
+     */
+    communication_options: {
+        should_send_message?: boolean;
+        channels?: Array<string>;
+    } | null;
+    cancelled_at: string | null;
+    /**
+     * Whether `DELETE /v1/bookings/{id}` would cancel this booking now. False once it is cancelled, after `depart_at`, while any item is issued, or while a traveller's money sits on an item. Read it before offering a cancel button.
+     */
+    is_cancellable: boolean;
+    is_pseudonymized: boolean;
+    /**
+     * The booking's items, one per package specification. Each item's `id` is the `{item}` you issue, read and terminate its package with.
+     */
+    items?: Array<BookingItem & {
+        [key: string]: unknown;
+    }>;
+    created_at: string | null;
+    updated_at: string | null;
+};
+/**
+ * BookingItem
+ */
+type BookingItem = {
+    id: string;
+    /**
+     * The human-typeable redemption code for this package, twelve
+     * characters from an unambiguous alphabet. It is a bearer
+     * credential: whoever redeems it is bound to the package, so treat
+     * it like a voucher and do not put it anywhere public.
+     * Absent when your End-customer channel is `partner_app`.
+     */
+    code?: string | null;
+    /**
+     * The key of this item's upgrade-offer page, where the traveller
+     * can buy a larger package before redeeming. Distinct from `id`:
+     * `id` is what the outbound webhooks send as `package_queue_uuid`,
+     * this is the page's own token, and the two are never
+     * interchangeable. Use it only if you build the link yourself —
+     * `upgrade_url` is already the whole link.
+     * Absent when your End-customer channel is `partner_app`.
+     */
+    offer_uuid?: string | null;
+    /**
+     * The traveller's upgrade-offer link for this item, ready to send.
+     * It is a bearer capability URL — whoever opens it can buy an
+     * upgrade for this package — so treat it like `code` and keep it
+     * out of anywhere public. Null only on an environment with no
+     * public-pages deployment configured.
+     * Absent when your End-customer channel is `partner_app`.
+     */
+    upgrade_url?: string | null;
+    /**
+     * A universal link that opens the Hubby app and applies this
+     * item's `code` automatically, so a traveller never types it. On
+     * a device without the app it leads to the store instead; on
+     * desktop, to a download page — it is a mobile CTA, not a general
+     * redemption URL. Send it as given rather than rebuilding it.
+     * Null for an item carrying no code.
+     * Absent when your End-customer channel is `partner_app`.
+     */
+    deep_link_url?: string | null;
+    external_user_id?: string | null;
+    email?: string | null;
+    customer_id: string | null;
+    /**
+     * iso2 for countries, iso3 for regions (which carry only one of the two).
+     */
+    destination?: string | null;
+    package_type: PackageType | null;
+    size_bytes: number | null;
+    duration_seconds: number | null;
+    start_at: string | null;
+    end_at: string | null;
+    status: PackageQueueStatus;
+    /**
+     * The bundle this item books: the one named by `bundle_id` at booking, or, once issued, the bundle the closest match chose. Null while an item specified by dimensions is not issued yet.
+     */
+    bundle_id: string | null;
+    /**
+     * Where this item is in its lifecycle. Read it instead of `status`: `queued` (reserved, not issued yet; you can issue it), `unavailable` (cannot be issued now: no bundle answers its specification, or a payment is still pending; cancel the booking or book again), `redeemed` (issued, install material available), `installed` (the eSIM is on a phone), `activated` (live on the network, validity running), `expired` (validity elapsed or consumed), `terminated` (ended before activation), `cancelled` (the booking was cancelled).
+     */
+    state: PackageLifecycleState;
+    package: IssuedPackage | null;
+};
+/**
+ * BookingSource
+ */
+type BookingSource = 'api' | 'platform' | 'manual' | 'synthetic' | 'migrated' | 'free_esim' | 'import' | 'membership';
+/**
+ * Bundle
+ */
+type Bundle = {
+    /**
+     * The bundle's id. Stable: name it as `bundle_id` to book exactly this bundle.
+     */
+    id: string;
+    /**
+     * The destination the bundle is sold for. `iso2` and `iso3` are null on a region.
+     */
+    destination: {
+        id: string;
+        iso2: string | null;
+        iso3: string | null;
+    };
+    /**
+     * `data_limited`, `starter` or `unlimited`.
+     */
+    type: string;
+    label: string;
+    provider: string;
+    size_bytes: number | null;
+    duration_seconds: number | null;
+    /**
+     * The validity in whole days, counted from first use. The same value as `duration_seconds`. Unlimited bundles are listed once for every day count from 1 to 30 that has a price.
+     */
+    duration_days: number | null;
+    package_template: {
+        id: string;
+        name: string;
+    };
+    partner: {
+        id: string;
+        name: string;
+    } | null;
+    traffic_policy: {
+        description: string | null;
+    } | null;
+    fair_use_throttle: FairUseThrottle | null;
+    is_active: boolean;
+    is_visible: boolean;
+    priority: number;
+    created_at: string | null;
+    /**
+     * When anything on the bundle last changed. A price change does not move it: compare `prices` too, or watch the catalog `ETag`.
+     */
+    updated_at: string | null;
+    deleted_at: string | null;
+    created_by: string | null;
+    updated_by: string | null;
+    /**
+     * The recommended retail price in EUR major units. Kept for older integrations; read `prices` instead.
+     */
+    pricing_info: {
+        final_price: number;
+        original_price: number;
+        currency: string;
+        currency_symbol: string;
+        discount_applied: boolean;
+        discount_percentage: number;
+    };
+    /**
+     * Both prices of the bundle, in EUR cents.
+     */
+    prices: {
+        /**
+         * The recommended retail price: what a traveller pays in Hubby's own shop.
+         */
+        retail: {
+            amount: number;
+            currency: 'EUR';
+        };
+        /**
+         * Your price under your agreement: the amount Hubby invoices you. Null when your agreement sets no price for this bundle.
+         */
+        net: {
+            amount: number;
+            currency: 'EUR';
+        } | null;
+    };
+};
+/**
+ * CheckDeviceCompatibilityData
+ *
+ * Device-compatibility check input. No real device dataset exists (see
+ * {@see DeviceCompatibilityController}), so both fields are required
+ * presence-only — there is nothing to validate the values against.
+ */
+type CheckDeviceCompatibilityData = {
+    phone_brand: string;
+    phone_model: string;
+};
+/**
+ * CommunicationChannel
+ *
+ * Channels a partner may name in a booking's communication_options. Backed by the exact wire values of the legacy API so stored payloads and validation share one source of truth. Core stores the choice; acting on it belongs to the (future) messaging domain.
+ *
+ */
+type CommunicationChannel = 'EMAIL' | 'WHATSAPP' | 'PUSH_NOTIFICATION' | 'SMS';
+/**
+ * CreateBookingRequest
+ *
+ * A new booking: your reference, the trip, and one package specification per eSIM to issue. Travel dates are `depart_at` and `return_at` and branding is `visual_identity_id`, the names the booking response uses; the legacy spellings `departure_date`, `return_date` and `custom_branding` are refused.
+ */
+type CreateBookingRequest = {
+    external_reference: string;
+    external_reference_secondary?: string | null;
+    visual_identity_id?: string | null;
+    depart_at?: string | null;
+    return_at?: string | null;
+    locale?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    full_name?: string | null;
+    title?: string | null;
+    gender?: string | null;
+    date_of_birth?: string | null;
+    /**
+     * The storage bound (int4), so an overflowing value 422s instead
+     * of 500ing on insert.
+     */
+    pax?: number | null;
+    flight_number?: string | null;
+    departure_location?: string | null;
+    data?: Array<string> | null;
+    communication_options?: {
+        should_send_message: boolean;
+        channels: Array<CommunicationChannel> | null;
+    };
+    /**
+     * The package specifications to fulfil, one per traveller. When `GET /v1/me` reports a `package_strategy`, `package_type` may be omitted and `size` and `package_duration` are not required by the type: the strategy overwrites all three on every specification you create, whether or not you send them. Each specification must carry `email` or `external_user_id` when `GET /v1/me` reports `end_customer_channel: webapp`; otherwise both are optional and a specification naming neither is claimed by its code.
+     */
+    package_specifications: Array<{
+        external_user_id?: string | null;
+        email?: string | null;
+        /**
+         * Required unless `bundle_id` is sent. The country or region the package is for: an ISO 3166-1 alpha-2 or alpha-3 code, or a destination name. May also be omitted when `GET /v1/me` reports `force_destinationless: true`; a sent one is then ignored.
+         */
+        destination?: string;
+        /**
+         * Required unless `bundle_id` is sent. `data-limited` (or `data_limited`), `starter` or `unlimited`. Both spellings are accepted; answers always spell it `data_limited`. May also be omitted when `GET /v1/me` reports a `package_strategy`, which sets it for you.
+         */
+        package_type?: string;
+        size?: string | null;
+        package_duration?: number | null;
+        start_at?: string | null;
+        end_at?: string | null;
+        /**
+         * A bundle `id` from the catalogue (`GET /v1/bundles`). Books exactly that bundle: its destination, type, size and duration are read from it, so `destination`, `package_type`, `size` and `package_duration` may be omitted and are ignored when sent. A bundle outside your catalogue answers 422. Omit it to specify by dimensions instead, which books the closest bundle. Refused with 422 when `GET /v1/me` reports a `package_strategy`, or when your bookings are made without a destination: those settings choose the bundle for you.
+         */
+        bundle_id?: string | null;
+        esim_type?: string;
+        expires_at?: string;
+    }>;
+    /**
+     * Create this booking for one of your descendant partners instead of your own account, naming it by its `slug` (the value `GET /v1/me` reports). Optional: omit it and the booking is yours, exactly as before. No setting on your API key is needed — every account may do this. The named partner must be an active partner below you in the hierarchy, at any depth rather than only a direct child, and every partner between you and it must be active too. Naming anything else — a partner that is not yours, an inactive one, or a slug that does not exist — answers 422. The whole booking is then the named partner's: its catalog and price list, its visual identities, its Package strategy, and its customers.
+     */
+    partner?: string | null;
+    /**
+     * Legacy wire spellings and retired fields: reject rather than
+     * silently drop, so a payload copied from a legacy integration
+     * fails loudly instead of storing null dates or losing branding.
+     * Channel hardening, not row semantics — so it lives here, not in
+     * the domain groups. The legacy shim maps/relaxes these before
+     * validation. Exception (decided 2026-07-24): per-item package_id
+     * is accepted and ignored — it maps to nothing, so dropping it
+     * loses nothing.
+     */
+    departure_date?: string;
+    return_date?: string;
+    custom_branding?: string;
+};
+/**
+ * CreateRedirectTokenData
+ *
+ * Identifies the customer a redirect token should be minted for. The
+ * authenticated partner (never client input) scopes which customer can be
+ * resolved — see ResolveCustomerFromExternalId.
+ */
+type CreateRedirectTokenData = {
+    external_user_id: string;
+};
+/**
+ * Destination
+ */
+type Destination = {
+    id: string;
+    name: string | null;
+    type: string;
+    iso3s: Array<string>;
+    i18n_name: {
+        [key: string]: string;
+    };
+    iso2: string | null;
+    iso3: string | null;
+} | {
+    id: string;
+    name: string | null;
+    type: string;
+    iso2: string | null;
+    iso3: string | null;
+    iso3s: Array<unknown>;
+    /**
+     * A region's name token in template names is its uppercased slug,
+     * not its iso2/iso3 (those are independently optional short codes
+     * on a region, not derived from the slug) — the client name
+     * preview needs it.
+     */
+    slug: string | null;
+    i18n_name: {
+        [key: string]: string;
+    };
+    country_names: {
+        [key: string]: string;
+    };
+};
+/**
+ * DestinationResource
+ */
+type DestinationResource = {
+    id: string;
+    type: string;
+    tier: null;
+    iso3s: Array<string>;
+    name: string | null;
+    i18n_name: {
+        [key: string]: string;
+    };
+    is_active: boolean;
+    sort_order: number;
+    click_count: number;
+    created_at: string | null;
+    updated_at: string | null;
+    created_by: string | null;
+    updated_by: string | null;
+    bundles: Array<Bundle>;
+};
+/**
+ * DeviceCompatibility
+ */
+type DeviceCompatibility = {
+    phone_brand: string;
+    phone_model: string;
+    is_compatible: boolean;
+};
+/**
+ * DeviceCompatibilityList
+ */
+type DeviceCompatibilityList = {
+    devices: Array<unknown>;
+};
+/**
+ * EndCustomerChannel
+ */
+type EndCustomerChannel = 'webapp' | 'native_app' | 'partner_app';
+/**
+ * Esim
+ */
+type Esim = {
+    /**
+     * The eSIM's ICCID.
+     */
+    iccid: string;
+    /**
+     * Your own identifier for the traveller holding this eSIM.
+     */
+    external_user_id: string | null;
+    /**
+     * When the eSIM was first installed on a phone. Null until then.
+     */
+    installed_at: string | null;
+    /**
+     * Every package on this eSIM, oldest first, ended ones included.
+     */
+    packages: Array<EsimPackage>;
+    /**
+     * When the usage figures were last read from the network. Null when they never were. Send `refresh=true` to read them now.
+     */
+    refreshed_at: string | null;
+};
+/**
+ * EsimInstallMaterial
+ */
+type EsimInstallMaterial = {
+    iccid: string;
+    /**
+     * When this eSIM was first installed on a phone, whichever package it was installed for. Set for a repeat traveller: the eSIM is already on their phone, so skip the install screen and show that the new package is ready. Null until the eSIM is installed.
+     */
+    installed_at: string | null;
+    /**
+     * The activation string. Render it as a QR code for "install on another device".
+     */
+    lpa: string | null;
+    /**
+     * The SM-DP+ address from `lpa`, for manual entry in the phone's settings.
+     */
+    smdp_address: string | null;
+    /**
+     * The matching id (activation code) from `lpa`, for manual entry in the phone's settings.
+     */
+    matching_id: string | null;
+    /**
+     * One-tap install links. Open the one for the phone that will hold the eSIM; its own installer opens. Each is null when the activation string is not in the standard `LPA:1$…` form.
+     */
+    install_links: {
+        ios: string | null;
+        android: string | null;
+    };
+};
+/**
+ * EsimPackage
+ */
+type EsimPackage = {
+    id: string;
+    /**
+     * The booking this package was issued from. Null for a package the traveller bought in the Hubby app.
+     */
+    booking_id: string | null;
+    /**
+     * Where this package is in its lifecycle, the same `state` its booking item carries: `redeemed`, `installed`, `activated`, `expired` or `terminated`.
+     */
+    state: PackageLifecycleState;
+    bundle_id: string;
+    /**
+     * When the package first attached on the network and its validity started. Null before.
+     */
+    activated_at: string | null;
+    /**
+     * The latest moment this package can still be activated: the deadline the connectivity provider sets when the package is issued, after which an unused package can no longer be started. It is **not** when the package's validity ends: a package with a few days of validity is typically still activatable for about a year. Use `valid_until` for when the package stops working.
+     */
+    expires_at: string | null;
+    /**
+     * When this package's validity ends and its data stops working: the moment it activated plus its time allowance. Null until the package activates, because the clock starts at activation, not at issue. Also null for a package that carries no time allowance.
+     */
+    valid_until: string | null;
+    /**
+     * Data used so far, in bytes. Reported on unlimited packages too, where it is the position against the fair-use threshold.
+     */
+    data_used_bytes: number;
+    /**
+     * Data left, in bytes. `0` once the package has ended (`state` is `expired` or `terminated`), whatever was unused: an ended package has no data the traveller can still use. Null on an unlimited package.
+     */
+    data_remaining_bytes: number | null;
+};
+/**
+ * FairUseThrottle
+ */
+type FairUseThrottle = {
+    /**
+     * The daily threshold, in bytes: the data a traveller can use in one day at full speed. The threshold applies per day, not to the whole package.
+     */
+    throttle_after_bytes: number;
+    /**
+     * The speed after the daily threshold is passed, in kbps (decimal: 1 Mbps is 1000 kbps). It applies until the threshold resets.
+     */
+    throttled_kbps: number;
+    /**
+     * When the threshold resets and the full speed comes back.
+     * | |
+     * |---|
+     * | `daily` <br/> Each day: the threshold applies to the data used in one day. |
+     */
+    resets: FairUseThrottleReset;
+};
+/**
+ * FairUseThrottleReset
+ *
+ * When the Fair-use throttle's threshold starts again: after it, the data used counts from zero and the full speed comes back.
+ * | |
+ * |---|
+ * | `daily` <br/> Each day: the threshold applies to the data used in one day. |
+ */
+type FairUseThrottleReset = 'daily';
+/**
+ * InstallInstructionSection
+ */
+type InstallInstructionSection = {
+    /**
+     * What the section does, in this order: `rename` the line, `turn_on` the line, enable `roaming`, pick the line for `mobile_data`.
+     */
+    id: string | null;
+    /**
+     * The section's title, localized.
+     */
+    title: string;
+    /**
+     * A short screen recording of the whole section on this phone family, in this language. Null when none exists.
+     */
+    clip_url: string | null;
+    /**
+     * The steps, in order.
+     */
+    steps: Array<InstallInstructionStep>;
+};
+/**
+ * InstallInstructionSet
+ */
+type InstallInstructionSet = {
+    /**
+     * The phone family: `iphone` on iOS; `samsung`, `pixel` or `xiaomi` on Android. For an Android phone you cannot place, use `samsung`.
+     */
+    family: string;
+    /**
+     * The lowest OS version these instructions apply to.
+     */
+    min_os_version: string;
+    /**
+     * Install on the phone itself: open `install_link` on that phone, then follow the steps the OS asks.
+     */
+    one_tap: {
+        title: string;
+        /**
+         * The OS's own one-tap install link for this eSIM. Null when the eSIM's activation string is not in the standard `LPA:1$…` form.
+         */
+        install_link: string | null;
+        clip_url: string | null;
+        steps: Array<InstallInstructionStep>;
+    };
+    /**
+     * Install from a second screen: render `lpa` as a QR code and scan it with the phone.
+     */
+    qr_code: {
+        title: string;
+        /**
+         * The eSIM's activation string, to render as a QR code.
+         */
+        lpa: string | null;
+        clip_url: string | null;
+        steps: Array<InstallInstructionStep>;
+    };
+    /**
+     * Install by typing the SM-DP+ address and the matching id in the phone's settings.
+     */
+    manual: {
+        title: string;
+        /**
+         * The SM-DP+ address from the activation string. Null when the string is not in the standard form.
+         */
+        smdp_address: string | null;
+        /**
+         * The matching id (activation code) from the activation string. Null when the string is not in the standard form.
+         */
+        matching_id: string | null;
+        clip_url: string | null;
+        steps: Array<InstallInstructionStep>;
+    };
+    /**
+     * What to do on arrival, in order: rename the line, turn it on, enable roaming, pick it for mobile data.
+     */
+    on_arrival: Array<InstallInstructionSection>;
+};
+/**
+ * InstallInstructionStep
+ */
+type InstallInstructionStep = {
+    /**
+     * The step, localized. Tap targets are marked with markdown bold, `**Activate**`, and nothing else; render or strip it.
+     */
+    text: string;
+    /**
+     * An image of the screen for this step, in this language. Null when none exists.
+     */
+    screenshot_url: string | null;
+};
+/**
+ * InstallInstructions
+ */
+type InstallInstructions = {
+    /**
+     * The eSIM's ICCID.
+     */
+    iccid: string;
+    /**
+     * The locale the instructions were asked in: `locale` from the query, else the locale of the booking that issued the eSIM, else `en-US`. Copy without a translation in that language is English.
+     */
+    locale: string;
+    /**
+     * The name the eSIM carries in your branding, already filled in wherever a step names the line. From the Visual identity of the booking that issued the eSIM, else your default one, else `Hubby eSIM`.
+     */
+    esim_label: string;
+    /**
+     * One entry per iOS phone family: `iphone`.
+     */
+    ios: Array<InstallInstructionSet>;
+    /**
+     * One entry per Android phone family: `samsung`, `pixel`, `xiaomi`.
+     */
+    android: Array<InstallInstructionSet>;
+};
+/**
+ * IssuePackageRequest
+ *
+ * The body of an issue call. Send it empty unless the item names no traveller yet.
+ */
+type IssuePackageRequest = {
+    /**
+     * Your id for the traveller who receives this package. Required when the item does not name a traveller yet; the traveller is then bound to the item exactly as at booking. When the item already names one, send the same id or leave it out.
+     */
+    external_user_id?: string | null;
+};
+/**
+ * IssuedPackage
+ */
+type IssuedPackage = {
+    id: string;
+    /**
+     * Where this package is in its lifecycle: `redeemed` (issued, install material available), `installed` (the eSIM is on a phone), `activated` (live on the network, validity running), `expired` (validity elapsed or consumed), `terminated` (ended before activation).
+     */
+    state: PackageLifecycleState;
+    /**
+     * The bundle this package was issued from.
+     */
+    bundle_id: string;
+    /**
+     * When the package was issued.
+     */
+    issued_at: string | null;
+    /**
+     * When this package became installable on a phone: the eSIM's install, or the issue itself when the eSIM was already installed. Null until the eSIM is on a phone.
+     */
+    installed_at: string | null;
+    /**
+     * When the package attached to the network at the destination (Package activation) and its validity started. Null until then.
+     */
+    activated_at: string | null;
+    /**
+     * The latest moment this package can still be activated: the deadline the connectivity provider sets when the package is issued, after which an unused package can no longer be started. It is **not** when the package's validity ends: a package with a few days of validity is typically still activatable for about a year. Use `valid_until` for when the package stops working.
+     */
+    expires_at: string | null;
+    /**
+     * When this package's validity ends and its data stops working: the moment it activated plus its time allowance. Null until the package activates, because the clock starts at activation, not at issue. Also null for a package that carries no time allowance.
+     */
+    valid_until: string | null;
+    /**
+     * When the package was ended before it activated. Null otherwise.
+     */
+    terminated_at: string | null;
+    esim: EsimInstallMaterial;
+};
+/**
+ * PackageLifecycleState
+ *
+ * The lifecycle state a Partner reads on a booking item and on the package issued from it (partner v1 `state`), so it never interprets the internal `status`. Derived, never stored: from the item's status until a package is issued, then from the package's own timestamps and its eSIM's install.
+ *
+ */
+type PackageLifecycleState = 'queued' | 'unavailable' | 'redeemed' | 'installed' | 'activated' | 'expired' | 'terminated' | 'cancelled';
+/**
+ * PackageQueueStatus
+ */
+type PackageQueueStatus = 'queued' | 'pending_payment' | 'paid' | 'activated' | 'cancelled' | 'reverted' | 'unresolved';
+/**
+ * PackageType
+ */
+type PackageType = 'data_limited' | 'starter' | 'unlimited';
+/**
+ * Partner
+ */
+type Partner = {
+    id: string;
+    slug: string;
+    name: string;
+    is_active: boolean;
+    parent_id: string | null;
+    end_customer_channel: EndCustomerChannel | null;
+    price_list_id: string | null;
+    /**
+     * The fixed package dimensions applied to every booking you create
+     * through this API. When present, the `package_type`, `size` and
+     * `package_duration` on every package specification you send are
+     * replaced before the booking is stored — your destination, travel
+     * dates and traveller identities are never changed. The sizes here are canonical units, not the units you send:
+     * `size_bytes` is what `size` (`"1GB"`, `"512MB"`) becomes, and
+     * `duration_seconds` is what `package_duration` (whole days)
+     * becomes. A null on either means that dimension does not apply to
+     * the type — an unlimited package carries no size, a data-limited
+     * one no duration.
+     *
+     * This may be set on your account or inherited from a parent
+     * account; either way it is what governs your bookings. `null`
+     * means no strategy applies: you specify packages freely.
+     */
+    package_strategy: {
+        package_type: string;
+        size_bytes: number | null;
+        duration_seconds: number | null;
+    } | null;
+    /**
+     * Whether every booking you create through this API is stored without a destination, whatever destination you send. When `true`, the `destination` on each package specification is optional and is discarded if you send one — nothing is rejected for naming a destination, and your travel dates, package dimensions and traveller identities are untouched. Each traveller picks their destination when they redeem, from the destinations available to your account.
+     *
+     * This may be set on your account or inherited from a parent account; either way it is what governs your bookings. `false` means your bookings keep the destination you send, which is the normal case.
+     */
+    force_destinationless: boolean;
+    /**
+     * The language bookings you create through this API are recorded in when you send no `locale` — for example `nl-NL`. Only ever fills a blank. A `locale` you send on a booking is always kept, whatever this says, and a booking you send without one is recorded in this language instead of none. `null` means no default is set on your account: a booking with no `locale` keeps none, exactly as before.
+     *
+     * It applies to the booking itself. Travellers are not switched to this language — a traveller keeps whichever language they have chosen, and one who has chosen none keeps none until they do.
+     *
+     * This is set on your account. Unlike `package_strategy` and `force_destinationless`, it is NOT inherited from a parent account.
+     */
+    default_locale: string | null;
+    created_at: string | null;
+    updated_at: string | null;
+};
+/**
+ * PartnerTerminateReason
+ *
+ * Why you terminated a package you issued.
+ *
+ */
+type PartnerTerminateReason = 'changed_plans' | 'installation_failed' | 'not_received' | 'other';
+/**
+ * PresignBookingUploadData
+ *
+ * Input for POST /v1/bookings/imports/presign-upload — the HMAC-authenticated
+ * partner-v1 equivalent of the legacy-parity bucket-upload-url contract, for
+ * partners who onboard directly against core. No partnerId field: the
+ * partner is the authenticated principal ($request->partner()), never a
+ * client-supplied value.
+ */
+type PresignBookingUploadData = {
+    date: string;
+    dataset?: string;
+    overwrite?: boolean;
+};
+/**
+ * RedirectToken
+ */
+type RedirectToken = {
+    redirect_token: string;
+    /**
+     * Lifetime of the redirect token in seconds.
+     */
+    expires_in: number;
+};
+/**
+ * SupportedLocale
+ *
+ * Locales the platform supports for customer-facing content (e.g. the booking form's locale picker). Values are BCP-47 language-region tags; human-readable names are derived via ext-intl so there is no display map to maintain.
+ *
+ */
+type SupportedLocale = 'en-US' | 'en-EU' | 'en-GB' | 'en-CA' | 'nl-NL' | 'de-DE' | 'fr-FR' | 'fr-CA' | 'it-IT' | 'es-ES' | 'cs-CZ' | 'pl-PL' | 'pt-PT' | 'fr-BE' | 'nl-BE' | 'de-AT' | 'de-CH' | 'fr-CH' | 'it-CH' | 'sv-SE' | 'sk-SK' | 'de-BE' | 'en-AU' | 'da-DK' | 'ko-KR' | 'hu-HU' | 'no-NO' | 'pt-BR' | 'en-NZ' | 'zh-CN' | 'ru-RU' | 'ro-RO';
+/**
+ * UpdateBookingRequest
+ *
+ * The booking fields to change. Every field is optional: an omitted field is left as it is, and an explicit `null` clears it.
+ */
+type UpdateBookingRequest = {
+    external_reference?: string | null;
+    external_reference_secondary?: string | null;
+    visual_identity_id?: string | null;
+    /**
+     * The trip's departure day. Changing it reschedules the booking: the traveller's pre-departure emails follow the new day. Compared by calendar day, so resending the day the booking already has changes nothing. Answers 422 when the booking has already departed, when the day is before today, when it is `null` for a booking that has a departure, or when the booking is cancelled.
+     */
+    depart_at?: string | null;
+    /**
+     * The trip's return day, on or after the departure. Changing it reschedules the booking, and may still be done once the trip is under way. Answers 422 for a cancelled booking.
+     */
+    return_at?: string | null;
+    locale?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    first_name?: string | null;
+    last_name?: string | null;
+    full_name?: string | null;
+    title?: string | null;
+    gender?: string | null;
+    date_of_birth?: string | null;
+    /**
+     * The storage bound (int4), so an overflowing value 422s instead
+     * of 500ing on insert.
+     */
+    pax?: number | null;
+    flight_number?: string | null;
+    departure_location?: string | null;
+    communication_options?: {
+        should_send_message: boolean;
+        channels: Array<CommunicationChannel> | null;
+    };
+};
+/**
+ * UpdatePackageSpecificationRequest
+ *
+ * The new specification for a booking's package items. The same body updates one item (its id in the path) or every item of the booking (no id in the path). Send only the fields you change.
+ */
+type UpdatePackageSpecificationRequest = {
+    destination?: string | null;
+    /**
+     * `data-limited` (or `data_limited`), `starter` or `unlimited`. Both spellings are accepted; answers always spell it `data_limited`.
+     */
+    package_type?: string | null;
+    size?: string | null;
+    package_duration?: number | null;
+    /**
+     * A bundle `id` from the catalogue (`GET /v1/bundles`). The item takes that bundle's destination, type, size and duration, and is provisioned with exactly that bundle; `destination`, `package_type`, `size` and `package_duration` are ignored when sent with it. A bundle outside your catalogue answers 422. Omit it to re-specify by dimensions, which lets go of any bundle named before. Refused with 422 when `GET /v1/me` reports a `package_strategy`, or when your bookings are made without a destination: those settings choose the bundle for you. Also refused with 422 on an item Hubby support granted, whose bundle support chose.
+     */
+    bundle_id?: string | null;
+};
+type PartnerApiV1AnalyticsSummaryData = {
+    body?: never;
+    path?: never;
+    query?: {
+        from?: string | null;
+        to?: string | null;
+        'partner_ids[]'?: Array<string>;
+        include_self?: boolean;
+        /**
+         * Set to `1` (or `true`) to add `comparison`: the same totals for the preceding period of the same length, ending the day before `from`. Any value that is not a boolean is refused with 422.
+         */
+        compare?: boolean;
+    };
+    url: '/v1/analytics/summary';
+};
+type PartnerApiV1AnalyticsSummaryResponses = {
+    /**
+     * `AnalyticsSummary`
+     */
+    200: {
+        data: AnalyticsSummary;
+        /**
+         * What the figures cover.
+         */
+        meta: AnalyticsMeta;
+    };
+};
+type PartnerApiV1AnalyticsSummaryResponse = PartnerApiV1AnalyticsSummaryResponses[keyof PartnerApiV1AnalyticsSummaryResponses];
+type PartnerApiV1AnalyticsFunnelData = {
+    body?: never;
+    path?: never;
+    query?: {
+        from?: string | null;
+        to?: string | null;
+        'partner_ids[]'?: Array<string>;
+        include_self?: boolean;
+        /**
+         * Break the funnel down by this dimension: `destination`, `bundle_size`, `sales_channel`, `booking_source` or `transaction_type`. Any other value is refused with 422. Leave it out for no breakdown.
+         */
+        dimension?: 'destination' | 'bundle_size' | 'sales_channel' | 'booking_source' | 'transaction_type';
+    };
+    url: '/v1/analytics/funnel';
+};
+type PartnerApiV1AnalyticsFunnelResponses = {
+    /**
+     * `AnalyticsFunnel`
+     */
+    200: {
+        data: AnalyticsFunnel;
+        /**
+         * What the figures cover.
+         */
+        meta: AnalyticsMeta;
+    };
+};
+type PartnerApiV1AnalyticsFunnelResponse = PartnerApiV1AnalyticsFunnelResponses[keyof PartnerApiV1AnalyticsFunnelResponses];
+type PartnerApiV1AnalyticsTimeseriesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        from?: string | null;
+        to?: string | null;
+        'partner_ids[]'?: Array<string>;
+        include_self?: boolean;
+        /**
+         * The length of each row: `day` (the default), `week` (ISO weeks, starting Monday) or `month`, all in UTC. Any other value is refused with 422.
+         */
+        bucket?: 'day' | 'week' | 'month';
+    };
+    url: '/v1/analytics/timeseries';
+};
+type PartnerApiV1AnalyticsTimeseriesResponses = {
+    /**
+     * `AnalyticsTimeseries`
+     */
+    200: {
+        data: AnalyticsTimeseries;
+        /**
+         * What the figures cover.
+         */
+        meta: AnalyticsMeta;
+    };
+};
+type PartnerApiV1AnalyticsTimeseriesResponse = PartnerApiV1AnalyticsTimeseriesResponses[keyof PartnerApiV1AnalyticsTimeseriesResponses];
+type PartnerApiV1AnalyticsBreakdownsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        from?: string | null;
+        to?: string | null;
+        'partner_ids[]'?: Array<string>;
+        include_self?: boolean;
+    };
+    url: '/v1/analytics/breakdowns';
+};
+type PartnerApiV1AnalyticsBreakdownsResponses = {
+    /**
+     * `AnalyticsBreakdowns`
+     */
+    200: {
+        data: AnalyticsBreakdowns;
+        /**
+         * What the figures cover.
+         */
+        meta: AnalyticsMeta;
+    };
+};
+type PartnerApiV1AnalyticsBreakdownsResponse = PartnerApiV1AnalyticsBreakdownsResponses[keyof PartnerApiV1AnalyticsBreakdownsResponses];
+type PartnerApiV1BookingsIndexData = {
+    body?: never;
+    path?: never;
+    query?: {
+        per_page?: number;
+        /**
+         * The page to read: a `pagination.nextCursor` or `pagination.prevCursor` from the previous page, sent back unchanged. Omit it for the first page.
+         */
+        cursor?: string | null;
+        email?: string | null;
+        external_reference?: string | null;
+        depart_at?: string | null;
+        created_at?: string | null;
+        promo_code?: string | null;
+        destination?: string | null;
+        sort?: 'created_at' | 'depart_at' | 'external_reference';
+        order?: 'asc' | 'desc';
+        format?: 'csv' | null;
+        departure_from?: string | null;
+        departure_to?: string | null;
+    };
+    url: '/v1/bookings';
+};
+type PartnerApiV1BookingsIndexResponses = {
+    200: {
+        data: Array<Booking>;
+        pagination: {
+            perPage: number;
+            nextCursor: string | null;
+            prevCursor: string | null;
+            hasNextPage: boolean;
+            hasPrevPage: boolean;
+        };
+    } | {
+        data: Array<Booking>;
+        pagination: {
+            hasNextPage: boolean;
+        };
+    };
+};
+type PartnerApiV1BookingsIndexResponse = PartnerApiV1BookingsIndexResponses[keyof PartnerApiV1BookingsIndexResponses];
+type PartnerApiV1BookingsImportsPresignUploadResponses = {
+    200: {
+        bucket: string;
+        object_path: string;
+        upload_url: string;
+        expires_at: string;
+        required_headers: {
+            [key: string]: string;
+        };
+    };
+};
+type PartnerApiV1BookingsImportsPresignUploadResponse = PartnerApiV1BookingsImportsPresignUploadResponses[keyof PartnerApiV1BookingsImportsPresignUploadResponses];
+type PartnerApiV1BookingsUpdatePackageSpecificationsResponses = {
+    200: {
+        updated_count: number;
+        skipped_count: number;
+    } | {
+        updated_count: 1;
+    };
+};
+type PartnerApiV1BookingsUpdatePackageSpecificationsResponse = PartnerApiV1BookingsUpdatePackageSpecificationsResponses[keyof PartnerApiV1BookingsUpdatePackageSpecificationsResponses];
+type PartnerApiV1BookingsShowResponses = {
+    200: {
+        data: Booking;
+    };
+};
+type PartnerApiV1BookingsShowResponse = PartnerApiV1BookingsShowResponses[keyof PartnerApiV1BookingsShowResponses];
+type PartnerApiV1BookingsItemsPackageShowResponses = {
+    200: {
+        data: IssuedPackage;
+    };
+};
+type PartnerApiV1BookingsItemsPackageShowResponse = PartnerApiV1BookingsItemsPackageShowResponses[keyof PartnerApiV1BookingsItemsPackageShowResponses];
+type PartnerApiV1BundlesIndexResponses = {
+    /**
+     * Array of `Bundle`
+     */
+    200: {
+        data: Array<Bundle>;
+    };
+};
+type PartnerApiV1BundlesIndexResponse = PartnerApiV1BundlesIndexResponses[keyof PartnerApiV1BundlesIndexResponses];
+type PartnerApiV1MeResponses = {
+    /**
+     * `Partner`
+     */
+    200: {
+        data: Partner;
+    };
+};
+type PartnerApiV1MeResponse = PartnerApiV1MeResponses[keyof PartnerApiV1MeResponses];
+type PartnerApiV1DestinationsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        iso3?: string | null;
+    };
+    url: '/v1/destinations';
+};
+type PartnerApiV1DestinationsResponses = {
+    200: {
+        countries: Array<Destination>;
+        regions: Array<Destination>;
+    };
+};
+type PartnerApiV1DestinationsResponse = PartnerApiV1DestinationsResponses[keyof PartnerApiV1DestinationsResponses];
+type PartnerApiV1DestinationsShowResponses = {
+    /**
+     * `DestinationResource`
+     */
+    200: {
+        data: DestinationResource;
+    };
+};
+type PartnerApiV1DestinationsShowResponse = PartnerApiV1DestinationsShowResponses[keyof PartnerApiV1DestinationsShowResponses];
+type PartnerApiV1DeviceCompatibilityIndexResponses = {
+    /**
+     * `DeviceCompatibilityList`
+     */
+    200: {
+        data: DeviceCompatibilityList;
+    };
+};
+type PartnerApiV1DeviceCompatibilityIndexResponse = PartnerApiV1DeviceCompatibilityIndexResponses[keyof PartnerApiV1DeviceCompatibilityIndexResponses];
+type PartnerApiV1DeviceCompatibilityCheckResponses = {
+    /**
+     * `DeviceCompatibility`
+     */
+    200: {
+        data: DeviceCompatibility;
+    };
+};
+type PartnerApiV1DeviceCompatibilityCheckResponse = PartnerApiV1DeviceCompatibilityCheckResponses[keyof PartnerApiV1DeviceCompatibilityCheckResponses];
+type PartnerApiV1EsimsShowResponses = {
+    /**
+     * `Esim`
+     */
+    200: {
+        data: Esim;
+    };
+};
+type PartnerApiV1EsimsShowResponse = PartnerApiV1EsimsShowResponses[keyof PartnerApiV1EsimsShowResponses];
+type PartnerApiV1EsimsInstructionsResponses = {
+    /**
+     * `InstallInstructions`
+     */
+    200: {
+        data: InstallInstructions;
+    };
+};
+type PartnerApiV1EsimsInstructionsResponse = PartnerApiV1EsimsInstructionsResponses[keyof PartnerApiV1EsimsInstructionsResponses];
+type PartnerApiV1RedirectTokensCreateResponses = {
+    /**
+     * `RedirectToken`
+     */
+    200: {
+        data: RedirectToken;
+    };
+};
+type PartnerApiV1RedirectTokensCreateResponse = PartnerApiV1RedirectTokensCreateResponses[keyof PartnerApiV1RedirectTokensCreateResponses];
+
+/**
+ * The types a Partner names: a readable alias for each method's input and
+ * response, over the generated operation types, and the resource types under
+ * their schema names. Every name is listed, never a wildcard (ADR 0058).
+ */
+
+/** `createBooking(input)`. */
+type CreateBookingInput = CreateBookingRequest;
+/** `updateBooking(id, input)`. */
+type UpdateBookingInput = UpdateBookingRequest;
+/** `getBookings(filters?)`. */
+type BookingListFilters = NonNullable<PartnerApiV1BookingsIndexData['query']>;
+/** `getDestinations(filters?)`. */
+type DestinationListFilters = NonNullable<PartnerApiV1DestinationsData['query']>;
+/** `updatePackageSpecification(bookingId, uuid, input)`: one item's package specification. */
+type PackageSpecificationInput = UpdatePackageSpecificationRequest;
+/** `updatePackageSpecifications(bookingId, input)`: every item not yet issued. */
+type PackageSpecificationsInput = UpdatePackageSpecificationRequest;
+/** `presignBookingImport(input)`. */
+type PresignBookingImportInput = PresignBookingUploadData;
+/** `issuePackage(booking, item, input)`; how to create `idempotencyKey` is on `Hubby.issuePackage`. */
+type IssuePackageInput = IssuePackageRequest & {
+    idempotencyKey: string;
+};
+/** `terminatePackage(booking, item, input?)`. */
+type TerminatePackageInput = {
+    reason?: PartnerTerminateReason;
+};
+/** `getEsim(iccid, input?)`. `refresh: true` reads the eSIM from the network now. */
+type EsimReadOptions = {
+    refresh?: boolean;
+};
+/** `getEsimInstructions(iccid, input?)`. */
+type EsimInstructionsOptions = {
+    locale?: SupportedLocale;
+};
+/** `checkDeviceCompatibility(input)`. */
+type DeviceCompatibilityInput = CheckDeviceCompatibilityData;
+/** `createRedirectToken(input)`. */
+type RedirectTokenInput = CreateRedirectTokenData;
+/** `getAnalyticsBreakdowns(query?)`: the date range and filters every analytics read takes. */
+type AnalyticsQuery = NonNullable<PartnerApiV1AnalyticsBreakdownsData['query']>;
+/** `getAnalyticsSummary(query?)`. */
+type AnalyticsSummaryQuery = NonNullable<PartnerApiV1AnalyticsSummaryData['query']>;
+/** `getAnalyticsFunnel(query?)`. */
+type AnalyticsFunnelQuery = NonNullable<PartnerApiV1AnalyticsFunnelData['query']>;
+/** `getAnalyticsTimeseries(query?)`. */
+type AnalyticsTimeseriesQuery = NonNullable<PartnerApiV1AnalyticsTimeseriesData['query']>;
+/** `getPartner()`. */
+type PartnerResponse = PartnerApiV1MeResponse;
+/** `getBundles()` and `getDestinationBundles(code)`. */
+type BundleListResponse = PartnerApiV1BundlesIndexResponse;
+/** `getDestinations(filters?)`: countries and regions. */
+type DestinationListResponse = PartnerApiV1DestinationsResponse;
+/** `getDestination(code)`. */
+type DestinationResponse = PartnerApiV1DestinationsShowResponse;
+/** `createBooking`, `getBooking` and `updateBooking`. */
+type BookingResponse = PartnerApiV1BookingsShowResponse;
+/** `getBookings(filters?)`: a page of bookings and its cursors. */
+type BookingListResponse = PartnerApiV1BookingsIndexResponse;
+/** `updatePackageSpecification` and `updatePackageSpecifications`. */
+type PackageSpecificationUpdateResponse = PartnerApiV1BookingsUpdatePackageSpecificationsResponse;
+/** `presignBookingImport(input)`: where to upload the import file, and how. */
+type BookingImportPresignResponse = PartnerApiV1BookingsImportsPresignUploadResponse;
+/** `issuePackage` and `getPackage`. */
+type PackageResponse = PartnerApiV1BookingsItemsPackageShowResponse;
+/** `getEsim(iccid, input?)`. */
+type EsimResponse = PartnerApiV1EsimsShowResponse;
+/** `getEsimInstructions(iccid, input?)`. */
+type EsimInstructionsResponse = PartnerApiV1EsimsInstructionsResponse;
+/** `getCompatibleDevices()`. */
+type DeviceCompatibilityListResponse = PartnerApiV1DeviceCompatibilityIndexResponse;
+/** `checkDeviceCompatibility(input)`. */
+type DeviceCompatibilityResponse = PartnerApiV1DeviceCompatibilityCheckResponse;
+/** `createRedirectToken(input)`. */
+type RedirectTokenResponse = PartnerApiV1RedirectTokensCreateResponse;
+/** `getAnalyticsSummary(query?)`. */
+type AnalyticsSummaryResponse = PartnerApiV1AnalyticsSummaryResponse;
+/** `getAnalyticsFunnel(query?)`. */
+type AnalyticsFunnelResponse = PartnerApiV1AnalyticsFunnelResponse;
+/** `getAnalyticsTimeseries(query?)`. */
+type AnalyticsTimeseriesResponse = PartnerApiV1AnalyticsTimeseriesResponse;
+/** `getAnalyticsBreakdowns(query?)`. */
+type AnalyticsBreakdownsResponse = PartnerApiV1AnalyticsBreakdownsResponse;
+
+type HubbyOptions = Omit<SigningClientOptions, 'baseUrl'> & {
+    /** Default `https://core.hubbyesim.com/api`; staging is `https://core-staging.hubbyesim.com/api`. */
+    baseUrl?: string;
+};
+/** Options every method takes last. */
+type RequestOptions = {
+    /** Aborts the call, a retry wait included; the call rejects with the signal's reason. */
+    signal?: AbortSignal;
+    /** Extra headers sent with the call. A `User-Agent` here replaces the SDK's. */
+    headers?: Record<string, string>;
+};
+/**
+ * The Partner API v1 client: one method per operation, each returning the
+ * response body as the Partner guide documents it. Every request is signed.
+ */
+declare class Hubby {
+    #private;
+    constructor(options: HubbyOptions);
+    /** `GET /v1/me`: the Partner the API key belongs to, and its settings. */
+    getPartner(options?: RequestOptions): Promise<PartnerResponse>;
+    /** `GET /v1/bundles`: the Bundles you sell. */
+    getBundles(options?: RequestOptions): Promise<BundleListResponse>;
+    /**
+     * `POST /v1/bookings`: creates a booking. The SDK gives the call an
+     * `Idempotency-Key` and keeps it across its retries.
+     */
+    createBooking(input: CreateBookingInput, options?: RequestOptions): Promise<BookingResponse>;
+    /**
+     * `POST /v1/bookings/{booking}/items/{item}/package`: issues the item's
+     * package. Create `idempotencyKey` once per issue attempt and store it with
+     * your own purchase record before the call, so a retry after a crash
+     * replays rather than issues again. After a terminate, the next issue of
+     * the item needs a new key.
+     */
+    issuePackage(booking: string, item: string, input: IssuePackageInput, options?: RequestOptions): Promise<PackageResponse>;
+    /** `GET /v1/bookings/{booking}/items/{item}/package`: the package issued for the item. */
+    getPackage(booking: string, item: string, options?: RequestOptions): Promise<PackageResponse>;
+    /**
+     * `DELETE /v1/bookings/{booking}/items/{item}/package`: terminates the
+     * item's package. Resolves once the Partner API answers `204`. Not retried
+     * after a network error: read the package to learn whether it ended.
+     */
+    terminatePackage(booking: string, item: string, input?: TerminatePackageInput, options?: RequestOptions): Promise<void>;
+    /**
+     * `GET /v1/esims/{iccid}`: the eSIM and its packages. `refresh: true` reads
+     * it from the network now instead of answering the last readout; it is
+     * rate-limited per Partner.
+     */
+    getEsim(iccid: string, input?: EsimReadOptions, options?: RequestOptions): Promise<EsimResponse>;
+    /** `GET /v1/destinations`: the destinations, filtered by `iso3` when given. */
+    getDestinations(filters?: DestinationListFilters, options?: RequestOptions): Promise<DestinationListResponse>;
+    /**
+     * `GET /v1/destinations/{destination}`: one destination.
+     *
+     * @param destination a ULID, an ISO alpha-2 or alpha-3 code, or a name
+     *   (English, exact, any letter case).
+     */
+    getDestination(destination: string, options?: RequestOptions): Promise<DestinationResponse>;
+    /**
+     * `GET /v1/destinations/{destination}/bundles`: the Bundles you sell for one destination.
+     *
+     * @param destination a ULID, an ISO alpha-2 or alpha-3 code, or a name
+     *   (English, exact, any letter case).
+     */
+    getDestinationBundles(destination: string, options?: RequestOptions): Promise<BundleListResponse>;
+    /** `GET /v1/bookings`: a page of your bookings, filtered and sorted. Pass `pagination.nextCursor` back as `cursor` for the next page. */
+    getBookings(filters?: BookingListFilters, options?: RequestOptions): Promise<BookingListResponse>;
+    /** `GET /v1/bookings/{id}`: one booking, by any identifier the guide lists. */
+    getBooking(id: string, options?: RequestOptions): Promise<BookingResponse>;
+    /** `PATCH /v1/bookings/{id}`: changes a booking. Not retried after a network error. */
+    updateBooking(id: string, input: UpdateBookingInput, options?: RequestOptions): Promise<BookingResponse>;
+    /**
+     * `DELETE /v1/bookings/{id}`: cancels the booking (a Booking cancellation).
+     * Resolves once the Partner API accepts it. Not retried after a network
+     * error: read the booking to learn whether it was cancelled.
+     */
+    cancelBooking(id: string, options?: RequestOptions): Promise<void>;
+    /**
+     * `PATCH /v1/bookings/{booking_id}/package-specifications/{uuid}`: changes
+     * the package specification of one item, by its package queue `uuid`.
+     */
+    updatePackageSpecification(bookingId: string, uuid: string, input: PackageSpecificationInput, options?: RequestOptions): Promise<PackageSpecificationUpdateResponse>;
+    /**
+     * `PATCH /v1/bookings/{booking_id}/package-specifications`: changes the
+     * package specification of every item of the booking not yet issued.
+     */
+    updatePackageSpecifications(bookingId: string, input: PackageSpecificationsInput, options?: RequestOptions): Promise<PackageSpecificationUpdateResponse>;
+    /** `POST /v1/bookings/imports/presign-upload`: a URL to upload a booking import file to. */
+    presignBookingImport(input: PresignBookingImportInput, options?: RequestOptions): Promise<BookingImportPresignResponse>;
+    /**
+     * `GET /v1/esims/{iccid}/instructions`: how to install the eSIM, in `locale`
+     * when given, else in the locale of the booking that issued it.
+     */
+    getEsimInstructions(iccid: string, input?: EsimInstructionsOptions, options?: RequestOptions): Promise<EsimInstructionsResponse>;
+    /** `GET /v1/device-compatibility`: the devices that take an eSIM. */
+    getCompatibleDevices(options?: RequestOptions): Promise<DeviceCompatibilityListResponse>;
+    /** `POST /v1/device-compatibility`: whether one device takes an eSIM. */
+    checkDeviceCompatibility(input: DeviceCompatibilityInput, options?: RequestOptions): Promise<DeviceCompatibilityResponse>;
+    /** `POST /v1/redirect-tokens`: a redirect token that signs one of your travellers in, creating their Customer on first use. */
+    createRedirectToken(input: RedirectTokenInput, options?: RequestOptions): Promise<RedirectTokenResponse>;
+    /** `GET /v1/analytics/summary`: the totals for a date range, with the preceding period when `compare` is set. */
+    getAnalyticsSummary(query?: AnalyticsSummaryQuery, options?: RequestOptions): Promise<AnalyticsSummaryResponse>;
+    /** `GET /v1/analytics/funnel`: booking codes issued through to first data used, split by `dimension` when given. */
+    getAnalyticsFunnel(query?: AnalyticsFunnelQuery, options?: RequestOptions): Promise<AnalyticsFunnelResponse>;
+    /** `GET /v1/analytics/timeseries`: the totals per `bucket` (day, week or month). */
+    getAnalyticsTimeseries(query?: AnalyticsTimeseriesQuery, options?: RequestOptions): Promise<AnalyticsTimeseriesResponse>;
+    /** `GET /v1/analytics/breakdowns`: the totals split by each dimension. */
+    getAnalyticsBreakdowns(query?: AnalyticsQuery, options?: RequestOptions): Promise<AnalyticsBreakdownsResponse>;
+}
+
+/**
+ * A non-2xx answer from the Partner API. Branch on `status` and `code` (the
+ * refusal code the Partner guide lists); `errors` holds a `422`'s field errors.
+ * A failure with no answer (a network error once the retries run out, or an
+ * abort) is not a `HubbyApiError`: it rejects with the underlying error.
+ */
+declare class HubbyApiError extends Error {
+    readonly status: number;
+    /** The refusal code, when the body has one, for example `idempotency_key_in_use`. */
+    readonly code: string | undefined;
+    /** The field errors of a `422`, keyed by field; absent when the body's `errors` has another shape. */
+    readonly errors: Record<string, string[]> | undefined;
+    /** The parsed error body: JSON when it parses, else the text. */
+    readonly body: unknown;
+    readonly response: Response;
+    constructor(response: Response, body: unknown);
+}
+
+/** The version tag every Partner API v1 signature binds. */
+declare const SIGNATURE_VERSION = "HUBBY-HMAC-SHA256-v1";
+type SignableRequest = {
+    method: string;
+    /** The absolute URL the request goes to. */
+    url: string;
+    /** Unix time in seconds. */
+    timestamp: number;
+    /** The exact bytes sent; empty for a request without a body. */
+    body: Uint8Array;
+};
+/**
+ * The lowercase hex `X-Signature` for a request.
+ *
+ * The canonical string is six lines: the version tag, the method, the host, the
+ * request URI as sent (path plus query string), the timestamp and the SHA-256 of
+ * the body. The WHATWG URL already lowercases the host and drops a default port,
+ * which is how core reads the host back.
+ */
+declare function signRequest(secret: string, request: SignableRequest): Promise<string>;
+
+/** The envelope of every webhook delivery. `data` is the event body. */
+type WebhookEvent<TData = Record<string, unknown>> = {
+    event: string;
+    timestamp: string;
+    data: TData;
+    /** Deduplicate on this: a retried delivery repeats it. */
+    event_id: string;
+    delivery_id: string;
+};
+type WebhookVerificationFailure = 'missing_signature' | 'missing_timestamp' | 'stale_timestamp' | 'invalid_signature' | 'invalid_body';
+declare class WebhookVerificationError extends Error {
+    readonly reason: WebhookVerificationFailure;
+    constructor(reason: WebhookVerificationFailure, message: string);
+}
+/** A `Headers`, or a plain object such as Node's `IncomingMessage.headers`. */
+type WebhookHeaders = Headers | Record<string, string | string[] | undefined>;
+type VerifyWebhookOptions = {
+    /** The signing secret configured for your endpoint. */
+    secret: string;
+    /** The raw request body, exactly as received. Not a parsed object. */
+    body: string | Uint8Array;
+    headers: WebhookHeaders;
+    /** How far `x-hubby-timestamp` may be from now, either way. Default 300. */
+    toleranceSeconds?: number;
+    /** Epoch milliseconds. Default: `Date.now`. */
+    now?: () => number;
+};
+declare const DEFAULT_WEBHOOK_TOLERANCE_SECONDS = 300;
+/**
+ * Verifies a webhook delivery and returns its parsed envelope, or throws a
+ * `WebhookVerificationError` naming why it was refused.
+ *
+ * `x-hubby-signature` is a comma-separated list of `sha256=` plus the hex
+ * HMAC-SHA256 of `{x-hubby-timestamp}.{raw body}`; any one matching entry is
+ * enough, so a secret can rotate without dropping deliveries. Every entry is
+ * compared in constant time.
+ */
+declare function verifyWebhook<TData = Record<string, unknown>>(options: VerifyWebhookOptions): Promise<WebhookEvent<TData>>;
+
+/**
+ * The Partner API version this SDK release is generated from and tested
+ * against. The SDK has its own semver; this names the API it speaks.
+ *
+ * scripts/check-api-version.mjs reads this line and fails CI when the exported
+ * Partner document's `info.version` differs, so keep it a single-quoted literal.
+ */
+declare const SUPPORTED_API_VERSION = "5.13.0";
+
+export { type AnalyticsActivation, type AnalyticsBreakdowns, type AnalyticsBreakdownsResponse, type AnalyticsBundleSizeCount, type AnalyticsDestinationCount, type AnalyticsDiscountCode, type AnalyticsFunnel, type AnalyticsFunnelGroup, type AnalyticsFunnelQuery, type AnalyticsFunnelResponse, type AnalyticsFunnelStep, type AnalyticsMeta, type AnalyticsPartnerContribution, type AnalyticsQuery, type AnalyticsRatio, type AnalyticsSummary, type AnalyticsSummaryQuery, type AnalyticsSummaryResponse, type AnalyticsTimeseries, type AnalyticsTimeseriesBucket, type AnalyticsTimeseriesQuery, type AnalyticsTimeseriesResponse, type Booking, type BookingImportPresignResponse, type BookingItem, type BookingListFilters, type BookingListResponse, type BookingResponse, type BookingSource, type Bundle, type BundleListResponse, type CommunicationChannel, type CreateBookingInput, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type Destination, type DestinationListFilters, type DestinationListResponse, type DestinationResource, type DestinationResponse, type DeviceCompatibility, type DeviceCompatibilityInput, type DeviceCompatibilityList, type DeviceCompatibilityListResponse, type DeviceCompatibilityResponse, type EndCustomerChannel, type Esim, type EsimInstallMaterial, type EsimInstructionsOptions, type EsimInstructionsResponse, type EsimPackage, type EsimReadOptions, type EsimResponse, type FairUseThrottle, type FairUseThrottleReset, Hubby, HubbyApiError, type HubbyOptions, type InstallInstructionSection, type InstallInstructionSet, type InstallInstructionStep, type InstallInstructions, type IssuePackageInput, type IssuedPackage, type PackageLifecycleState, type PackageQueueStatus, type PackageResponse, type PackageSpecificationInput, type PackageSpecificationUpdateResponse, type PackageSpecificationsInput, type PackageType, type Partner, type PartnerResponse, type PartnerTerminateReason, type PresignBookingImportInput, type RedirectToken, type RedirectTokenInput, type RedirectTokenResponse, type RequestOptions, type RetryOptions, SIGNATURE_VERSION, SUPPORTED_API_VERSION, type SignableRequest, type SupportedLocale, type TerminatePackageInput, type UpdateBookingInput, type VerifyWebhookOptions, type WebhookEvent, type WebhookHeaders, WebhookVerificationError, type WebhookVerificationFailure, signRequest, verifyWebhook };