@hubbyesim/sdk 2.1.0 → 2.2.0

package/dist/index.d.ts

@@ -28,11 +28,11 @@ type SigningClientOptions = {
 /**
  * AnalyticsActivation
  */
-type AnalyticsActivation = {
+type AnalyticsActivation$1 = {
     /**
      * Activated over claimed, as a rate.
      */
-    rate: AnalyticsRatio;
+    rate: AnalyticsRatio$1;
     /**
      * Booking codes first claimed in the judged part of the range.
      */
@@ -66,7 +66,7 @@ type AnalyticsActivation = {
 /**
  * AnalyticsBreakdowns
  */
-type AnalyticsBreakdowns = {
+type AnalyticsBreakdowns$1 = {
     /**
      * Codes issued in the range, by destination. Includes codes of bookings moved over from the previous platform.
      */
@@ -78,7 +78,7 @@ type AnalyticsBreakdowns = {
         /**
          * Every destination with a code issued in the range, most codes first.
          */
-        top: Array<AnalyticsDestinationCount>;
+        top: Array<AnalyticsDestinationCount$1>;
     };
     /**
      * Codes issued in the range, by bundle size. Includes codes of bookings moved over from the previous platform.
@@ -91,7 +91,7 @@ type AnalyticsBreakdowns = {
         /**
          * One row per bundle size, most codes first.
          */
-        distribution: Array<AnalyticsBundleSizeCount>;
+        distribution: Array<AnalyticsBundleSizeCount$1>;
     };
     /**
      * Discounts given on payments that went through in the range.
@@ -104,13 +104,13 @@ type AnalyticsBreakdowns = {
         /**
          * 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>;
+        by_code: Array<AnalyticsDiscountCode$1>;
     };
 };
 /**
  * AnalyticsBundleSizeCount
  */
-type AnalyticsBundleSizeCount = {
+type AnalyticsBundleSizeCount$1 = {
     /**
      * The bundle's data allowance in bytes. Null for an unlimited bundle.
      */
@@ -127,7 +127,7 @@ type AnalyticsBundleSizeCount = {
 /**
  * AnalyticsDestinationCount
  */
-type AnalyticsDestinationCount = {
+type AnalyticsDestinationCount$1 = {
     /**
      * The destination's id. A destination withdrawn since keeps its row and its name.
      */
@@ -144,7 +144,7 @@ type AnalyticsDestinationCount = {
 /**
  * AnalyticsDiscountCode
  */
-type AnalyticsDiscountCode = {
+type AnalyticsDiscountCode$1 = {
     /**
      * The discount code as travellers enter it.
      */
@@ -159,7 +159,7 @@ type AnalyticsDiscountCode = {
 /**
  * AnalyticsFunnel
  */
-type AnalyticsFunnel = {
+type AnalyticsFunnel$1 = {
     /**
      * 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.
      */
@@ -192,7 +192,7 @@ type AnalyticsFunnel = {
     /**
      * 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>;
+    steps: Array<AnalyticsFunnelStep$1>;
     /**
      * The `dimension` the funnel is broken down by, as requested; null when none was.
      */
@@ -200,12 +200,12 @@ type AnalyticsFunnel = {
     /**
      * 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;
+    breakdown: Array<AnalyticsFunnelGroup$1> | null;
 };
 /**
  * AnalyticsFunnelGroup
  */
-type AnalyticsFunnelGroup = {
+type AnalyticsFunnelGroup$1 = {
     /**
      * 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.
      */
@@ -221,12 +221,12 @@ type AnalyticsFunnelGroup = {
     /**
      * This group's funnel, with the same steps as the whole funnel.
      */
-    steps: Array<AnalyticsFunnelStep>;
+    steps: Array<AnalyticsFunnelStep$1>;
 };
 /**
  * AnalyticsFunnelStep
  */
-type AnalyticsFunnelStep = {
+type AnalyticsFunnelStep$1 = {
     /**
      * 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.
      */
@@ -239,13 +239,13 @@ type AnalyticsFunnelStep = {
      * 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;
+    rate: AnalyticsRatio$1 | null;
+    share_of_codes: AnalyticsRatio$1 | null;
 };
 /**
  * AnalyticsMeta
  */
-type AnalyticsMeta = {
+type AnalyticsMeta$1 = {
     /**
      * The range the figures cover, as UTC dates with both ends included.
      */
@@ -286,7 +286,7 @@ type AnalyticsMeta = {
 /**
  * AnalyticsPartnerContribution
  */
-type AnalyticsPartnerContribution = {
+type AnalyticsPartnerContribution$1 = {
     /**
      * The Partner these figures are for, one of `meta.partner_ids`.
      */
@@ -317,7 +317,7 @@ type AnalyticsPartnerContribution = {
 /**
  * AnalyticsRatio
  */
-type AnalyticsRatio = {
+type AnalyticsRatio$1 = {
     /**
      * The rate as a percentage from 0 to 100, rounded to two decimals; null when suppressed.
      */
@@ -338,7 +338,7 @@ type AnalyticsRatio = {
 /**
  * AnalyticsSummary
  */
-type AnalyticsSummary = {
+type AnalyticsSummary$1 = {
     /**
      * Bookings created in the range, test bookings left out. Includes bookings moved over from the previous platform, created here on the day they moved.
      */
@@ -397,7 +397,7 @@ type AnalyticsSummary = {
     /**
      * The 14-day claim-to-activation rate for codes claimed in the range.
      */
-    activation: AnalyticsActivation;
+    activation: AnalyticsActivation$1;
     /**
      * 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.
      */
@@ -415,7 +415,7 @@ type AnalyticsSummary = {
     /**
      * 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>;
+    by_partner: Array<AnalyticsPartnerContribution$1>;
     /**
      * The same headline figures for the preceding period of equal length, when `compare` was set. Null otherwise.
      */
@@ -450,7 +450,7 @@ type AnalyticsSummary = {
         /**
          * The activation rate for codes claimed in the preceding period.
          */
-        activation: AnalyticsActivation;
+        activation: AnalyticsActivation$1;
         /**
          * Packages that started using data in the preceding period.
          */
@@ -460,7 +460,7 @@ type AnalyticsSummary = {
 /**
  * AnalyticsTimeseries
  */
-type AnalyticsTimeseries = {
+type AnalyticsTimeseries$1 = {
     /**
      * The bucket every row covers: `day`, `week` (ISO weeks, Monday to Sunday) or `month`.
      */
@@ -468,12 +468,12 @@ type AnalyticsTimeseries = {
     /**
      * One row per bucket, oldest first, from the bucket holding `meta.range.from` to the bucket holding `meta.range.to`.
      */
-    series: Array<AnalyticsTimeseriesBucket>;
+    series: Array<AnalyticsTimeseriesBucket$1>;
 };
 /**
  * AnalyticsTimeseriesBucket
  */
-type AnalyticsTimeseriesBucket = {
+type AnalyticsTimeseriesBucket$1 = {
     /**
      * 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.
      */
@@ -508,13 +508,13 @@ type AnalyticsTimeseriesBucket = {
 /**
  * Booking
  */
-type Booking = {
+type Booking$1 = {
     id: string;
     partner_id: string;
     visual_identity_id: string | null;
     external_reference: string | null;
     external_reference_secondary: string | null;
-    source: BookingSource;
+    source: BookingSource$1;
     depart_at: string | null;
     return_at: string | null;
     locale: string | null;
@@ -547,7 +547,7 @@ type Booking = {
     /**
      * 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 & {
+    items?: Array<BookingItem$1 & {
         [key: string]: unknown;
     }>;
     created_at: string | null;
@@ -556,7 +556,7 @@ type Booking = {
 /**
  * BookingItem
  */
-type BookingItem = {
+type BookingItem$1 = {
     id: string;
     /**
      * The human-typeable redemption code for this package, twelve
@@ -602,12 +602,12 @@ type BookingItem = {
      * iso2 for countries, iso3 for regions (which carry only one of the two).
      */
     destination?: string | null;
-    package_type: PackageType | null;
+    package_type: PackageType$1 | null;
     size_bytes: number | null;
     duration_seconds: number | null;
     start_at: string | null;
     end_at: string | null;
-    status: PackageQueueStatus;
+    status: PackageQueueStatus$1;
     /**
      * 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.
      */
@@ -615,17 +615,17 @@ type BookingItem = {
     /**
      * 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;
+    state: PackageLifecycleState$1;
+    package: IssuedPackage$1 | null;
 };
 /**
  * BookingSource
  */
-type BookingSource = 'api' | 'platform' | 'manual' | 'synthetic' | 'migrated' | 'free_esim' | 'import' | 'membership';
+type BookingSource$1 = 'api' | 'platform' | 'manual' | 'synthetic' | 'migrated' | 'free_esim' | 'import' | 'membership';
 /**
  * Bundle
  */
-type Bundle = {
+type Bundle$1 = {
     /**
      * The bundle's id. Stable: name it as `bundle_id` to book exactly this bundle.
      */
@@ -633,11 +633,7 @@ type Bundle = {
     /**
      * The destination the bundle is sold for. `iso2` and `iso3` are null on a region.
      */
-    destination: {
-        id: string;
-        iso2: string | null;
-        iso3: string | null;
-    };
+    destination: DestinationSummary$1;
     /**
      * `data_limited`, `starter` or `unlimited`.
      */
@@ -661,7 +657,7 @@ type Bundle = {
     traffic_policy: {
         description: string | null;
     } | null;
-    fair_use_throttle: FairUseThrottle | null;
+    fair_use_throttle: FairUseThrottle$1 | null;
     is_active: boolean;
     is_visible: boolean;
     priority: number;
@@ -810,7 +806,7 @@ type CreateRedirectTokenData = {
 /**
  * Destination
  */
-type Destination = {
+type Destination$1 = {
     id: string;
     name: string | null;
     type: string;
@@ -841,10 +837,14 @@ type Destination = {
         [key: string]: string;
     };
 };
+/**
+ * DestinationKind
+ */
+type DestinationKind$1 = 'country' | 'region';
 /**
  * DestinationResource
  */
-type DestinationResource = {
+type DestinationResource$1 = {
     id: string;
     type: string;
     tier: null;
@@ -860,12 +860,78 @@ type DestinationResource = {
     updated_at: string | null;
     created_by: string | null;
     updated_by: string | null;
-    bundles: Array<Bundle>;
+    bundles: Array<Bundle$1>;
+};
+/**
+ * DestinationSummary
+ */
+type DestinationSummary$1 = {
+    /**
+     * The destination's id: the `id` of `GET /v1/destinations/{destination}`.
+     */
+    id: string;
+    /**
+     * The destination's English name, for example `Spain` or `Europe`.
+     */
+    name: string | null;
+    /**
+     * `country` or `region`.
+     */
+    type: DestinationKind$1;
+    /**
+     * The country's ISO 3166-1 alpha-2 code. Null on a region.
+     */
+    iso2: string | null;
+    /**
+     * The country's ISO 3166-1 alpha-3 code. Null on a region.
+     */
+    iso3: string | null;
+};
+/**
+ * DestinationUsage
+ */
+type DestinationUsage$1 = {
+    /**
+     * The destination every package in this entry is for, the same object a bundle carries in `GET /v1/bundles`. A country and a region that covers it are two entries. Top up this entry with a bundle for this destination.
+     */
+    destination: DestinationSummary$1;
+    /**
+     * True for unlimited packages. `total_bytes` and `remaining_bytes` are then null; `used_bytes` is still set. A destination with unlimited and data packages has one entry of each.
+     */
+    is_unlimited: boolean;
+    /**
+     * The data allowance of every package in `package_ids` added up, in bytes, ended packages included. Always `used_bytes + remaining_bytes`. Draw a gauge from `remaining_bytes` against `total_bytes`, as the Hubby app does. Null when `is_unlimited`.
+     */
+    total_bytes: number | null;
+    /**
+     * The data that is no longer available, in bytes: `total_bytes - remaining_bytes`, the figure the Hubby app shows as used. Data an ended package of the same trip did not use counts as used, because it can no longer be used. On unlimited entries, where there is no total, the data the packages in `package_ids` used, added up.
+     */
+    used_bytes: number;
+    /**
+     * The data the traveller can still use, in bytes: what the live packages have left, added up, and never below `0`. A provider can report a package slightly over its allowance; that overrun is taken from what the entry's other live packages have left. `0` means used up, even when `valid_until` is still ahead; a top-up adds to it. Null when `is_unlimited`.
+     */
+    remaining_bytes: number | null;
+    /**
+     * When this entry's data stops working. For data packages, which run side by side, the end of the live package with the most time left; for unlimited packages, which run one after the other, the end of their added-up time. Null while that time has not started: the package it belongs to has not been used on the network yet, and its clock starts on first use. Null does not mean the entry is unused: an older package in it can already be in use. Use `remaining_seconds` for the time left.
+     */
+    valid_until: string | null;
+    /**
+     * The time left on this entry, in seconds, the figure behind "N days left" in the Hubby app. Set even while `valid_until` is null: a package that has not started counts its whole validity. For data packages, the time left on the live package with the most time left; for unlimited packages, the time left on their added-up time. Counts down only once the time has started.
+     */
+    remaining_seconds: number;
+    /**
+     * Every package this entry adds up, oldest first, ended packages of the same trip included: the `id` of packages in `GET /v1/esims/{iccid}`. Packages the traveller bought in the Hubby app count too.
+     */
+    package_ids: Array<string>;
+    /**
+     * When these figures were last read from the network: the oldest read among the entry's live packages. Null when one of them was never read. Send `refresh=true` to read them now.
+     */
+    synced_at: string | null;
 };
 /**
  * DeviceCompatibility
  */
-type DeviceCompatibility = {
+type DeviceCompatibility$1 = {
     phone_brand: string;
     phone_model: string;
     is_compatible: boolean;
@@ -873,17 +939,17 @@ type DeviceCompatibility = {
 /**
  * DeviceCompatibilityList
  */
-type DeviceCompatibilityList = {
+type DeviceCompatibilityList$1 = {
     devices: Array<unknown>;
 };
 /**
  * EndCustomerChannel
  */
-type EndCustomerChannel = 'webapp' | 'native_app' | 'partner_app';
+type EndCustomerChannel$1 = 'webapp' | 'native_app' | 'partner_app';
 /**
  * Esim
  */
-type Esim = {
+type Esim$1 = {
     /**
      * The eSIM's ICCID.
      */
@@ -899,7 +965,7 @@ type Esim = {
     /**
      * Every package on this eSIM, oldest first, ended ones included.
      */
-    packages: Array<EsimPackage>;
+    packages: Array<EsimPackage$1>;
     /**
      * When the usage figures were last read from the network. Null when they never were. Send `refresh=true` to read them now.
      */
@@ -908,7 +974,7 @@ type Esim = {
 /**
  * EsimInstallMaterial
  */
-type EsimInstallMaterial = {
+type EsimInstallMaterial$1 = {
     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.
@@ -937,7 +1003,7 @@ type EsimInstallMaterial = {
 /**
  * EsimPackage
  */
-type EsimPackage = {
+type EsimPackage$1 = {
     id: string;
     /**
      * The booking this package was issued from. Null for a package the traveller bought in the Hubby app.
@@ -946,8 +1012,12 @@ type EsimPackage = {
     /**
      * Where this package is in its lifecycle, the same `state` its booking item carries: `redeemed`, `installed`, `activated`, `expired` or `terminated`.
      */
-    state: PackageLifecycleState;
+    state: PackageLifecycleState$1;
     bundle_id: string;
+    /**
+     * The destination this package is for, the same object a bundle carries in `GET /v1/bundles`. Always set, also on a package that has ended and on a package whose bundle is no longer sold.
+     */
+    destination: DestinationSummary$1;
     /**
      * When the package first attached on the network and its validity started. Null before.
      */
@@ -972,7 +1042,7 @@ type EsimPackage = {
 /**
  * FairUseThrottle
  */
-type FairUseThrottle = {
+type FairUseThrottle$1 = {
     /**
      * 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.
      */
@@ -987,7 +1057,7 @@ type FairUseThrottle = {
      * |---|
      * | `daily` <br/> Each day: the threshold applies to the data used in one day. |
      */
-    resets: FairUseThrottleReset;
+    resets: FairUseThrottleReset$1;
 };
 /**
  * FairUseThrottleReset
@@ -997,11 +1067,11 @@ type FairUseThrottle = {
  * |---|
  * | `daily` <br/> Each day: the threshold applies to the data used in one day. |
  */
-type FairUseThrottleReset = 'daily';
+type FairUseThrottleReset$1 = 'daily';
 /**
  * InstallInstructionSection
  */
-type InstallInstructionSection = {
+type InstallInstructionSection$1 = {
     /**
      * What the section does, in this order: `rename` the line, `turn_on` the line, enable `roaming`, pick the line for `mobile_data`.
      */
@@ -1017,12 +1087,12 @@ type InstallInstructionSection = {
     /**
      * The steps, in order.
      */
-    steps: Array<InstallInstructionStep>;
+    steps: Array<InstallInstructionStep$1>;
 };
 /**
  * InstallInstructionSet
  */
-type InstallInstructionSet = {
+type InstallInstructionSet$1 = {
     /**
      * The phone family: `iphone` on iOS; `samsung`, `pixel` or `xiaomi` on Android. For an Android phone you cannot place, use `samsung`.
      */
@@ -1041,7 +1111,7 @@ type InstallInstructionSet = {
          */
         install_link: string | null;
         clip_url: string | null;
-        steps: Array<InstallInstructionStep>;
+        steps: Array<InstallInstructionStep$1>;
     };
     /**
      * Install from a second screen: render `lpa` as a QR code and scan it with the phone.
@@ -1053,7 +1123,7 @@ type InstallInstructionSet = {
          */
         lpa: string | null;
         clip_url: string | null;
-        steps: Array<InstallInstructionStep>;
+        steps: Array<InstallInstructionStep$1>;
     };
     /**
      * Install by typing the SM-DP+ address and the matching id in the phone's settings.
@@ -1069,17 +1139,17 @@ type InstallInstructionSet = {
          */
         matching_id: string | null;
         clip_url: string | null;
-        steps: Array<InstallInstructionStep>;
+        steps: Array<InstallInstructionStep$1>;
     };
     /**
      * What to do on arrival, in order: rename the line, turn it on, enable roaming, pick it for mobile data.
      */
-    on_arrival: Array<InstallInstructionSection>;
+    on_arrival: Array<InstallInstructionSection$1>;
 };
 /**
  * InstallInstructionStep
  */
-type InstallInstructionStep = {
+type InstallInstructionStep$1 = {
     /**
      * The step, localized. Tap targets are marked with markdown bold, `**Activate**`, and nothing else; render or strip it.
      */
@@ -1092,7 +1162,7 @@ type InstallInstructionStep = {
 /**
  * InstallInstructions
  */
-type InstallInstructions = {
+type InstallInstructions$1 = {
     /**
      * The eSIM's ICCID.
      */
@@ -1108,11 +1178,11 @@ type InstallInstructions = {
     /**
      * One entry per iOS phone family: `iphone`.
      */
-    ios: Array<InstallInstructionSet>;
+    ios: Array<InstallInstructionSet$1>;
     /**
      * One entry per Android phone family: `samsung`, `pixel`, `xiaomi`.
      */
-    android: Array<InstallInstructionSet>;
+    android: Array<InstallInstructionSet$1>;
 };
 /**
  * IssuePackageRequest
@@ -1128,12 +1198,12 @@ type IssuePackageRequest = {
 /**
  * IssuedPackage
  */
-type IssuedPackage = {
+type IssuedPackage$1 = {
     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;
+    state: PackageLifecycleState$1;
     /**
      * The bundle this package was issued from.
      */
@@ -1162,7 +1232,7 @@ type IssuedPackage = {
      * When the package was ended before it activated. Null otherwise.
      */
     terminated_at: string | null;
-    esim: EsimInstallMaterial;
+    esim: EsimInstallMaterial$1;
 };
 /**
  * PackageLifecycleState
@@ -1170,25 +1240,25 @@ type IssuedPackage = {
  * 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';
+type PackageLifecycleState$1 = 'queued' | 'unavailable' | 'redeemed' | 'installed' | 'activated' | 'expired' | 'terminated' | 'cancelled';
 /**
  * PackageQueueStatus
  */
-type PackageQueueStatus = 'queued' | 'pending_payment' | 'paid' | 'activated' | 'cancelled' | 'reverted' | 'unresolved';
+type PackageQueueStatus$1 = 'queued' | 'pending_payment' | 'paid' | 'activated' | 'cancelled' | 'reverted' | 'unresolved';
 /**
  * PackageType
  */
-type PackageType = 'data_limited' | 'starter' | 'unlimited';
+type PackageType$1 = 'data_limited' | 'starter' | 'unlimited';
 /**
  * Partner
  */
-type Partner = {
+type Partner$1 = {
     id: string;
     slug: string;
     name: string;
     is_active: boolean;
     parent_id: string | null;
-    end_customer_channel: EndCustomerChannel | null;
+    end_customer_channel: EndCustomerChannel$1 | null;
     price_list_id: string | null;
     /**
      * The fixed package dimensions applied to every booking you create
@@ -1252,7 +1322,7 @@ type PresignBookingUploadData = {
 /**
  * RedirectToken
  */
-type RedirectToken = {
+type RedirectToken$1 = {
     redirect_token: string;
     /**
      * Lifetime of the redirect token in seconds.
@@ -1342,11 +1412,11 @@ type PartnerApiV1AnalyticsSummaryResponses = {
      * `AnalyticsSummary`
      */
     200: {
-        data: AnalyticsSummary;
+        data: AnalyticsSummary$1;
         /**
          * What the figures cover.
          */
-        meta: AnalyticsMeta;
+        meta: AnalyticsMeta$1;
     };
 };
 type PartnerApiV1AnalyticsSummaryResponse = PartnerApiV1AnalyticsSummaryResponses[keyof PartnerApiV1AnalyticsSummaryResponses];
@@ -1370,11 +1440,11 @@ type PartnerApiV1AnalyticsFunnelResponses = {
      * `AnalyticsFunnel`
      */
     200: {
-        data: AnalyticsFunnel;
+        data: AnalyticsFunnel$1;
         /**
          * What the figures cover.
          */
-        meta: AnalyticsMeta;
+        meta: AnalyticsMeta$1;
     };
 };
 type PartnerApiV1AnalyticsFunnelResponse = PartnerApiV1AnalyticsFunnelResponses[keyof PartnerApiV1AnalyticsFunnelResponses];
@@ -1398,11 +1468,11 @@ type PartnerApiV1AnalyticsTimeseriesResponses = {
      * `AnalyticsTimeseries`
      */
     200: {
-        data: AnalyticsTimeseries;
+        data: AnalyticsTimeseries$1;
         /**
          * What the figures cover.
          */
-        meta: AnalyticsMeta;
+        meta: AnalyticsMeta$1;
     };
 };
 type PartnerApiV1AnalyticsTimeseriesResponse = PartnerApiV1AnalyticsTimeseriesResponses[keyof PartnerApiV1AnalyticsTimeseriesResponses];
@@ -1422,11 +1492,11 @@ type PartnerApiV1AnalyticsBreakdownsResponses = {
      * `AnalyticsBreakdowns`
      */
     200: {
-        data: AnalyticsBreakdowns;
+        data: AnalyticsBreakdowns$1;
         /**
          * What the figures cover.
          */
-        meta: AnalyticsMeta;
+        meta: AnalyticsMeta$1;
     };
 };
 type PartnerApiV1AnalyticsBreakdownsResponse = PartnerApiV1AnalyticsBreakdownsResponses[keyof PartnerApiV1AnalyticsBreakdownsResponses];
@@ -1455,7 +1525,7 @@ type PartnerApiV1BookingsIndexData = {
 };
 type PartnerApiV1BookingsIndexResponses = {
     200: {
-        data: Array<Booking>;
+        data: Array<Booking$1>;
         pagination: {
             perPage: number;
             nextCursor: string | null;
@@ -1464,7 +1534,7 @@ type PartnerApiV1BookingsIndexResponses = {
             hasPrevPage: boolean;
         };
     } | {
-        data: Array<Booking>;
+        data: Array<Booking$1>;
         pagination: {
             hasNextPage: boolean;
         };
@@ -1494,13 +1564,13 @@ type PartnerApiV1BookingsUpdatePackageSpecificationsResponses = {
 type PartnerApiV1BookingsUpdatePackageSpecificationsResponse = PartnerApiV1BookingsUpdatePackageSpecificationsResponses[keyof PartnerApiV1BookingsUpdatePackageSpecificationsResponses];
 type PartnerApiV1BookingsShowResponses = {
     200: {
-        data: Booking;
+        data: Booking$1;
     };
 };
 type PartnerApiV1BookingsShowResponse = PartnerApiV1BookingsShowResponses[keyof PartnerApiV1BookingsShowResponses];
 type PartnerApiV1BookingsItemsPackageShowResponses = {
     200: {
-        data: IssuedPackage;
+        data: IssuedPackage$1;
     };
 };
 type PartnerApiV1BookingsItemsPackageShowResponse = PartnerApiV1BookingsItemsPackageShowResponses[keyof PartnerApiV1BookingsItemsPackageShowResponses];
@@ -1509,7 +1579,7 @@ type PartnerApiV1BundlesIndexResponses = {
      * Array of `Bundle`
      */
     200: {
-        data: Array<Bundle>;
+        data: Array<Bundle$1>;
     };
 };
 type PartnerApiV1BundlesIndexResponse = PartnerApiV1BundlesIndexResponses[keyof PartnerApiV1BundlesIndexResponses];
@@ -1518,7 +1588,7 @@ type PartnerApiV1MeResponses = {
      * `Partner`
      */
     200: {
-        data: Partner;
+        data: Partner$1;
     };
 };
 type PartnerApiV1MeResponse = PartnerApiV1MeResponses[keyof PartnerApiV1MeResponses];
@@ -1532,8 +1602,8 @@ type PartnerApiV1DestinationsData = {
 };
 type PartnerApiV1DestinationsResponses = {
     200: {
-        countries: Array<Destination>;
-        regions: Array<Destination>;
+        countries: Array<Destination$1>;
+        regions: Array<Destination$1>;
     };
 };
 type PartnerApiV1DestinationsResponse = PartnerApiV1DestinationsResponses[keyof PartnerApiV1DestinationsResponses];
@@ -1542,7 +1612,7 @@ type PartnerApiV1DestinationsShowResponses = {
      * `DestinationResource`
      */
     200: {
-        data: DestinationResource;
+        data: DestinationResource$1;
     };
 };
 type PartnerApiV1DestinationsShowResponse = PartnerApiV1DestinationsShowResponses[keyof PartnerApiV1DestinationsShowResponses];
@@ -1551,7 +1621,7 @@ type PartnerApiV1DeviceCompatibilityIndexResponses = {
      * `DeviceCompatibilityList`
      */
     200: {
-        data: DeviceCompatibilityList;
+        data: DeviceCompatibilityList$1;
     };
 };
 type PartnerApiV1DeviceCompatibilityIndexResponse = PartnerApiV1DeviceCompatibilityIndexResponses[keyof PartnerApiV1DeviceCompatibilityIndexResponses];
@@ -1560,7 +1630,7 @@ type PartnerApiV1DeviceCompatibilityCheckResponses = {
      * `DeviceCompatibility`
      */
     200: {
-        data: DeviceCompatibility;
+        data: DeviceCompatibility$1;
     };
 };
 type PartnerApiV1DeviceCompatibilityCheckResponse = PartnerApiV1DeviceCompatibilityCheckResponses[keyof PartnerApiV1DeviceCompatibilityCheckResponses];
@@ -1569,16 +1639,25 @@ type PartnerApiV1EsimsShowResponses = {
      * `Esim`
      */
     200: {
-        data: Esim;
+        data: Esim$1;
     };
 };
 type PartnerApiV1EsimsShowResponse = PartnerApiV1EsimsShowResponses[keyof PartnerApiV1EsimsShowResponses];
+type PartnerApiV1EsimsUsageResponses = {
+    /**
+     * Array of `DestinationUsage`
+     */
+    200: {
+        data: Array<DestinationUsage$1>;
+    };
+};
+type PartnerApiV1EsimsUsageResponse = PartnerApiV1EsimsUsageResponses[keyof PartnerApiV1EsimsUsageResponses];
 type PartnerApiV1EsimsInstructionsResponses = {
     /**
      * `InstallInstructions`
      */
     200: {
-        data: InstallInstructions;
+        data: InstallInstructions$1;
     };
 };
 type PartnerApiV1EsimsInstructionsResponse = PartnerApiV1EsimsInstructionsResponses[keyof PartnerApiV1EsimsInstructionsResponses];
@@ -1587,17 +1666,88 @@ type PartnerApiV1RedirectTokensCreateResponses = {
      * `RedirectToken`
      */
     200: {
-        data: RedirectToken;
+        data: RedirectToken$1;
     };
 };
 type PartnerApiV1RedirectTokensCreateResponse = PartnerApiV1RedirectTokensCreateResponses[keyof PartnerApiV1RedirectTokensCreateResponses];
 
+/**
+ * Open response enums. The Partner API may add a value to a response enum in a
+ * minor release (a new Package `state`, say), so the SDK types every response
+ * enum as its known values or any other string. Code that branches on one
+ * needs a `default` branch; editors still complete the known values. Request
+ * enums stay closed, because the server refuses a value it does not know.
+ *
+ * The generated types in ../src are closed; lib/types.ts opens them here, so a
+ * regeneration keeps the open types without a generator post-process.
+ */
+/**
+ * A response enum: one of the known values `Known`, or a string a later
+ * Partner API minor adds. `string & {}` keeps the literals from collapsing
+ * into `string`, which is what keeps editor completion.
+ */
+type Open<Known extends string> = Known | (string & {});
+/**
+ * `T` with every string enum inside it opened: each union of string literals,
+ * at any depth (objects, arrays, nullable fields), becomes `Open` of itself.
+ * Plain `string` fields and every other type stay as they are.
+ */
+type OpenEnums<T> = T extends string ? string extends T ? T : Open<T> : T extends object ? {
+    [K in keyof T]: OpenEnums<T[K]>;
+} : T;
+
 /**
  * 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).
+ *
+ * Every response and resource type is wrapped in `OpenEnums`, and every
+ * response enum in `Open`, so a value a later Partner API minor adds still
+ * type-checks (lib/open-enums.ts). Inputs, query filters and request enums
+ * stay as generated: closed.
  */
 
+type BookingSource = Open<BookingSource$1>;
+type DestinationKind = Open<DestinationKind$1>;
+type EndCustomerChannel = Open<EndCustomerChannel$1>;
+type FairUseThrottleReset = Open<FairUseThrottleReset$1>;
+type PackageLifecycleState = Open<PackageLifecycleState$1>;
+type PackageQueueStatus = Open<PackageQueueStatus$1>;
+type PackageType = Open<PackageType$1>;
+type AnalyticsActivation = OpenEnums<AnalyticsActivation$1>;
+type AnalyticsBreakdowns = OpenEnums<AnalyticsBreakdowns$1>;
+type AnalyticsBundleSizeCount = OpenEnums<AnalyticsBundleSizeCount$1>;
+type AnalyticsDestinationCount = OpenEnums<AnalyticsDestinationCount$1>;
+type AnalyticsDiscountCode = OpenEnums<AnalyticsDiscountCode$1>;
+type AnalyticsFunnel = OpenEnums<AnalyticsFunnel$1>;
+type AnalyticsFunnelGroup = OpenEnums<AnalyticsFunnelGroup$1>;
+type AnalyticsFunnelStep = OpenEnums<AnalyticsFunnelStep$1>;
+type AnalyticsMeta = OpenEnums<AnalyticsMeta$1>;
+type AnalyticsPartnerContribution = OpenEnums<AnalyticsPartnerContribution$1>;
+type AnalyticsRatio = OpenEnums<AnalyticsRatio$1>;
+type AnalyticsSummary = OpenEnums<AnalyticsSummary$1>;
+type AnalyticsTimeseries = OpenEnums<AnalyticsTimeseries$1>;
+type AnalyticsTimeseriesBucket = OpenEnums<AnalyticsTimeseriesBucket$1>;
+type Booking = OpenEnums<Booking$1>;
+type BookingItem = OpenEnums<BookingItem$1>;
+type Bundle = OpenEnums<Bundle$1>;
+type Destination = OpenEnums<Destination$1>;
+type DestinationResource = OpenEnums<DestinationResource$1>;
+type DestinationSummary = OpenEnums<DestinationSummary$1>;
+type DestinationUsage = OpenEnums<DestinationUsage$1>;
+type DeviceCompatibility = OpenEnums<DeviceCompatibility$1>;
+type DeviceCompatibilityList = OpenEnums<DeviceCompatibilityList$1>;
+type Esim = OpenEnums<Esim$1>;
+type EsimInstallMaterial = OpenEnums<EsimInstallMaterial$1>;
+type EsimPackage = OpenEnums<EsimPackage$1>;
+type FairUseThrottle = OpenEnums<FairUseThrottle$1>;
+type InstallInstructions = OpenEnums<InstallInstructions$1>;
+type InstallInstructionSection = OpenEnums<InstallInstructionSection$1>;
+type InstallInstructionSet = OpenEnums<InstallInstructionSet$1>;
+type InstallInstructionStep = OpenEnums<InstallInstructionStep$1>;
+type IssuedPackage = OpenEnums<IssuedPackage$1>;
+type Partner = OpenEnums<Partner$1>;
+type RedirectToken = OpenEnums<RedirectToken$1>;
 /** `createBooking(input)`. */
 type CreateBookingInput = CreateBookingRequest;
 /** `updateBooking(id, input)`. */
@@ -1620,7 +1770,7 @@ type IssuePackageInput = IssuePackageRequest & {
 type TerminatePackageInput = {
     reason?: PartnerTerminateReason;
 };
-/** `getEsim(iccid, input?)`. `refresh: true` reads the eSIM from the network now. */
+/** `getEsim(iccid, input?)` and `getEsimUsage(iccid, input?)`. `refresh: true` reads the eSIM from the network now. */
 type EsimReadOptions = {
     refresh?: boolean;
 };
@@ -1641,41 +1791,43 @@ type AnalyticsFunnelQuery = NonNullable<PartnerApiV1AnalyticsFunnelData['query']
 /** `getAnalyticsTimeseries(query?)`. */
 type AnalyticsTimeseriesQuery = NonNullable<PartnerApiV1AnalyticsTimeseriesData['query']>;
 /** `getPartner()`. */
-type PartnerResponse = PartnerApiV1MeResponse;
+type PartnerResponse = OpenEnums<PartnerApiV1MeResponse>;
 /** `getBundles()` and `getDestinationBundles(code)`. */
-type BundleListResponse = PartnerApiV1BundlesIndexResponse;
+type BundleListResponse = OpenEnums<PartnerApiV1BundlesIndexResponse>;
 /** `getDestinations(filters?)`: countries and regions. */
-type DestinationListResponse = PartnerApiV1DestinationsResponse;
+type DestinationListResponse = OpenEnums<PartnerApiV1DestinationsResponse>;
 /** `getDestination(code)`. */
-type DestinationResponse = PartnerApiV1DestinationsShowResponse;
+type DestinationResponse = OpenEnums<PartnerApiV1DestinationsShowResponse>;
 /** `createBooking`, `getBooking` and `updateBooking`. */
-type BookingResponse = PartnerApiV1BookingsShowResponse;
+type BookingResponse = OpenEnums<PartnerApiV1BookingsShowResponse>;
 /** `getBookings(filters?)`: a page of bookings and its cursors. */
-type BookingListResponse = PartnerApiV1BookingsIndexResponse;
+type BookingListResponse = OpenEnums<PartnerApiV1BookingsIndexResponse>;
 /** `updatePackageSpecification` and `updatePackageSpecifications`. */
-type PackageSpecificationUpdateResponse = PartnerApiV1BookingsUpdatePackageSpecificationsResponse;
+type PackageSpecificationUpdateResponse = OpenEnums<PartnerApiV1BookingsUpdatePackageSpecificationsResponse>;
 /** `presignBookingImport(input)`: where to upload the import file, and how. */
-type BookingImportPresignResponse = PartnerApiV1BookingsImportsPresignUploadResponse;
+type BookingImportPresignResponse = OpenEnums<PartnerApiV1BookingsImportsPresignUploadResponse>;
 /** `issuePackage` and `getPackage`. */
-type PackageResponse = PartnerApiV1BookingsItemsPackageShowResponse;
+type PackageResponse = OpenEnums<PartnerApiV1BookingsItemsPackageShowResponse>;
 /** `getEsim(iccid, input?)`. */
-type EsimResponse = PartnerApiV1EsimsShowResponse;
+type EsimResponse = OpenEnums<PartnerApiV1EsimsShowResponse>;
+/** `getEsimUsage(iccid, input?)`: one `DestinationUsage` per destination. */
+type EsimUsageResponse = OpenEnums<PartnerApiV1EsimsUsageResponse>;
 /** `getEsimInstructions(iccid, input?)`. */
-type EsimInstructionsResponse = PartnerApiV1EsimsInstructionsResponse;
+type EsimInstructionsResponse = OpenEnums<PartnerApiV1EsimsInstructionsResponse>;
 /** `getCompatibleDevices()`. */
-type DeviceCompatibilityListResponse = PartnerApiV1DeviceCompatibilityIndexResponse;
+type DeviceCompatibilityListResponse = OpenEnums<PartnerApiV1DeviceCompatibilityIndexResponse>;
 /** `checkDeviceCompatibility(input)`. */
-type DeviceCompatibilityResponse = PartnerApiV1DeviceCompatibilityCheckResponse;
+type DeviceCompatibilityResponse = OpenEnums<PartnerApiV1DeviceCompatibilityCheckResponse>;
 /** `createRedirectToken(input)`. */
-type RedirectTokenResponse = PartnerApiV1RedirectTokensCreateResponse;
+type RedirectTokenResponse = OpenEnums<PartnerApiV1RedirectTokensCreateResponse>;
 /** `getAnalyticsSummary(query?)`. */
-type AnalyticsSummaryResponse = PartnerApiV1AnalyticsSummaryResponse;
+type AnalyticsSummaryResponse = OpenEnums<PartnerApiV1AnalyticsSummaryResponse>;
 /** `getAnalyticsFunnel(query?)`. */
-type AnalyticsFunnelResponse = PartnerApiV1AnalyticsFunnelResponse;
+type AnalyticsFunnelResponse = OpenEnums<PartnerApiV1AnalyticsFunnelResponse>;
 /** `getAnalyticsTimeseries(query?)`. */
-type AnalyticsTimeseriesResponse = PartnerApiV1AnalyticsTimeseriesResponse;
+type AnalyticsTimeseriesResponse = OpenEnums<PartnerApiV1AnalyticsTimeseriesResponse>;
 /** `getAnalyticsBreakdowns(query?)`. */
-type AnalyticsBreakdownsResponse = PartnerApiV1AnalyticsBreakdownsResponse;
+type AnalyticsBreakdownsResponse = OpenEnums<PartnerApiV1AnalyticsBreakdownsResponse>;
 
 type HubbyOptions = Omit<SigningClientOptions, 'baseUrl'> & {
     /** Default `https://core.hubbyesim.com/api`; staging is `https://core-staging.hubbyesim.com/api`. */
@@ -1726,6 +1878,12 @@ declare class Hubby {
      * rate-limited per Partner.
      */
     getEsim(iccid: string, input?: EsimReadOptions, options?: RequestOptions): Promise<EsimResponse>;
+    /**
+     * `GET /v1/esims/{iccid}/usage`: what the traveller can still use on the
+     * eSIM, one entry per destination, newest first. `refresh: true` reads
+     * the network now; it shares `getEsim`'s per-Partner rate limit.
+     */
+    getEsimUsage(iccid: string, input?: EsimReadOptions, options?: RequestOptions): Promise<EsimUsageResponse>;
     /** `GET /v1/destinations`: the destinations, filtered by `iso3` when given. */
     getDestinations(filters?: DestinationListFilters, options?: RequestOptions): Promise<DestinationListResponse>;
     /**
@@ -1872,6 +2030,6 @@ declare function verifyWebhook<TData = Record<string, unknown>>(options: VerifyW
  * 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";
+declare const SUPPORTED_API_VERSION = "5.14.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 };
+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 DestinationKind, type DestinationListFilters, type DestinationListResponse, type DestinationResource, type DestinationResponse, type DestinationSummary, type DestinationUsage, 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 EsimUsageResponse, 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 };