@duffel/components 2.2.1 → 2.3.0

package/dist/duffel-components.d.ts

@@ -454,6 +454,156 @@ export interface OfferSliceSegmentPassengerBaggage {
 	 */
 	quantity: number;
 }
+declare const DUFFEL_COMPONENTS_VERSION = "2.2.1";
+/**
+ * The metropolitan area where the airport is located.
+ * Only present for airports which are registered with IATA as belonging to a metropolitan area.
+ * @link https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area
+ */
+export interface City {
+	/**
+	 * The type of the place
+	 */
+	type?: "city";
+	/**
+	 * The three-character IATA code for the city
+	 * @example "LON"
+	 */
+	iata_code: string;
+	/**
+	 * The ISO 3166-1 alpha-2 code for the country where the city is located
+	 * @link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+	 * @example "GB"
+	 */
+	iata_country_code: string;
+	/**
+	 * Duffel's unique identifier for the city
+	 * @example "cit_lon_gb"
+	 */
+	id: string;
+	/**
+	 * The name of the city
+	 * @example "London"
+	 */
+	name: string;
+	/**
+	 * The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database)
+	 */
+	time_zone?: string | null;
+	/**
+	 * The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180°
+	 */
+	longitude?: number | null;
+	/**
+	 * The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90°
+	 */
+	latitude?: number | null;
+	/**
+	 * The 3-letter IATA code for the city where the place is located.
+	 * Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area).
+	 */
+	iata_city_code?: string | null;
+	/**
+	 * The name of the city (or cities separated by a `/`) where the airport is located
+	 */
+	city_name?: string | null;
+}
+/**
+ * The cabin class that the passenger will travel in on this segment
+ */
+export declare type CabinClass = "first" | "business" | "premium_economy" | "economy";
+/**
+ * The type of the identity document. Currently, the only supported type is passport.
+ * This must be one of the `allowed_passenger_identity_document_types` on the offer.
+ */
+export declare type PassengerIdentityDocumentType = "passport";
+/**
+ * The type of the origin or destination
+ */
+export declare type PlaceType = "airport" | "city";
+export declare type Place = (Airport & {
+	type?: "airport";
+	airports?: Airport[] | null;
+}) | (City & {
+	type?: "city";
+});
+/**
+ * The conditions associated with this offer, describing the kinds of modifications you can make post-booking and any penalties that will apply to those modifications.
+ * This information assumes the condition is applied to all of the slices and passengers associated with this offer - for information at the slice level (e.g. "what happens if I just want to change the first slice?") refer to the slices.
+ * If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API.
+ * In some cases, you may need to contact the Duffel support team or the airline directly.
+ */
+export declare type FlightsConditions = {
+	/**
+	 * Whether the whole order or offer can be refunded before the departure of the first slice.
+	 * If all of the slices on the order or offer can be refunded then the `allowed` property will be `true` and information will be provided about any penalties.
+	 * If any of the slices on the order or offer can't be refunded then the `allowed` property will be `false`.
+	 * If the airline hasn't provided any information about whether this order or offer can be refunded then this property will be `null`.
+	 */
+	refund_before_departure?: {
+		/**
+		 * The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+		 * This will be in a currency determined by the airline, which is not necessarily the same as the currency of the order or offer.
+		 * If this is `null` then `penalty_amount` will also be `null`.
+		 * @example "GBP"
+		 */
+		penalty_currency?: string;
+		/**
+		 * If the modification is `allowed` then this is the amount payable to apply the modification to all passengers.
+		 * If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`.
+		 * If this is `null` then the `penalty_currency` will also be null.
+		 * @example "100.00"
+		 */
+		penalty_amount?: string;
+		/**
+		 * Whether this kind of modification is allowed post-booking
+		 *
+		 * @example "true"
+		 */
+		allowed: boolean;
+	} | null;
+	/**
+	 * Whether the whole order or offer can be changed before the departure of the first slice.
+	 * If all of the slices on the order or offer can be changed then the `allowed` property will be `true`.
+	 * Refer to the `slices` for information about change penalties.
+	 * If any of the slices on the order or offer can't be changed then the `allowed` property will be `false`.
+	 * In this case you should refer to the slices conditions to determine if any part of the order or offer is changeable.
+	 * If the airline hasn't provided any information about whether this order or offer can be changed then this property will be `null`.
+	 */
+	change_before_departure?: {
+		/**
+		 * The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+		 * This will be in a currency determined by the airline, which is not necessarily the same as the currency of the order or offer.
+		 * If this is `null` then `penalty_amount` will also be `null`.
+		 * @example "GBP"
+		 */
+		penalty_currency: string;
+		/**
+		 * If the modification is `allowed` then this is the amount payable to apply the modification to all passengers.
+		 * If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`.
+		 * If this is `null` then the `penalty_currency` will also be null.
+		 * @example "100.00"
+		 */
+		penalty_amount?: string;
+		/**
+		 * Whether this kind of modification is allowed post-booking
+		 *
+		 * @example "true"
+		 */
+		allowed: boolean;
+	} | null;
+};
+export interface LayoutSelectionPassenger {
+	id: string;
+	name?: string | null;
+}
+/**
+ * Metadata for component usage tracking
+ */
+export interface ComponentUsageMetadata {
+	duffel_component_used: "additional_baggage" | "additional_baggage_selection" | "seat_selection";
+	duffel_components_version: typeof DUFFEL_COMPONENTS_VERSION;
+}
 /**
  * Seat maps are used to build a rich experience for your customers so they can select a seat as part of an order.
  * A seat map includes the data for rendering seats in the relevant cabins, along with their total cost and other information such as disclosures.
@@ -570,6 +720,10 @@ export interface SeatMapCabinRowSectionAvailableService {
 	 * The currency of the total_amount, as an ISO 4217 currency code
 	 */
 	total_currency: string;
+	/**
+	 * Metadata for component usage tracking
+	 */
+	metadata?: ComponentUsageMetadata;
 }
 /**
  * A bassinet is a child's cradle. This element will be aligned with the corresponding seat in the following row.
@@ -642,148 +796,6 @@ export interface SeatMapCabinRowSectionElementStairs {
 	type: "stairs";
 }
 export declare type SeatMapCabinRowSectionElement = SeatMapCabinRowSectionElementSeat | SeatMapCabinRowSectionElementBassinet | SeatMapCabinRowSectionElementEmpty | SeatMapCabinRowSectionElementExitRow | SeatMapCabinRowSectionElementLavatory | SeatMapCabinRowSectionElementGalley | SeatMapCabinRowSectionElementCloset | SeatMapCabinRowSectionElementStairs;
-/**
- * The metropolitan area where the airport is located.
- * Only present for airports which are registered with IATA as belonging to a metropolitan area.
- * @link https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area
- */
-export interface City {
-	/**
-	 * The type of the place
-	 */
-	type?: "city";
-	/**
-	 * The three-character IATA code for the city
-	 * @example "LON"
-	 */
-	iata_code: string;
-	/**
-	 * The ISO 3166-1 alpha-2 code for the country where the city is located
-	 * @link https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
-	 * @example "GB"
-	 */
-	iata_country_code: string;
-	/**
-	 * Duffel's unique identifier for the city
-	 * @example "cit_lon_gb"
-	 */
-	id: string;
-	/**
-	 * The name of the city
-	 * @example "London"
-	 */
-	name: string;
-	/**
-	 * The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database)
-	 */
-	time_zone?: string | null;
-	/**
-	 * The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180°
-	 */
-	longitude?: number | null;
-	/**
-	 * The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90°
-	 */
-	latitude?: number | null;
-	/**
-	 * The 3-letter IATA code for the city where the place is located.
-	 * Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area).
-	 */
-	iata_city_code?: string | null;
-	/**
-	 * The name of the city (or cities separated by a `/`) where the airport is located
-	 */
-	city_name?: string | null;
-}
-/**
- * The cabin class that the passenger will travel in on this segment
- */
-export declare type CabinClass = "first" | "business" | "premium_economy" | "economy";
-/**
- * The type of the identity document. Currently, the only supported type is passport.
- * This must be one of the `allowed_passenger_identity_document_types` on the offer.
- */
-export declare type PassengerIdentityDocumentType = "passport";
-/**
- * The type of the origin or destination
- */
-export declare type PlaceType = "airport" | "city";
-export declare type Place = (Airport & {
-	type?: "airport";
-	airports?: Airport[] | null;
-}) | (City & {
-	type?: "city";
-});
-/**
- * The conditions associated with this offer, describing the kinds of modifications you can make post-booking and any penalties that will apply to those modifications.
- * This information assumes the condition is applied to all of the slices and passengers associated with this offer - for information at the slice level (e.g. "what happens if I just want to change the first slice?") refer to the slices.
- * If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API.
- * In some cases, you may need to contact the Duffel support team or the airline directly.
- */
-export declare type FlightsConditions = {
-	/**
-	 * Whether the whole order or offer can be refunded before the departure of the first slice.
-	 * If all of the slices on the order or offer can be refunded then the `allowed` property will be `true` and information will be provided about any penalties.
-	 * If any of the slices on the order or offer can't be refunded then the `allowed` property will be `false`.
-	 * If the airline hasn't provided any information about whether this order or offer can be refunded then this property will be `null`.
-	 */
-	refund_before_departure?: {
-		/**
-		 * The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-		 * This will be in a currency determined by the airline, which is not necessarily the same as the currency of the order or offer.
-		 * If this is `null` then `penalty_amount` will also be `null`.
-		 * @example "GBP"
-		 */
-		penalty_currency?: string;
-		/**
-		 * If the modification is `allowed` then this is the amount payable to apply the modification to all passengers.
-		 * If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`.
-		 * If this is `null` then the `penalty_currency` will also be null.
-		 * @example "100.00"
-		 */
-		penalty_amount?: string;
-		/**
-		 * Whether this kind of modification is allowed post-booking
-		 *
-		 * @example "true"
-		 */
-		allowed: boolean;
-	} | null;
-	/**
-	 * Whether the whole order or offer can be changed before the departure of the first slice.
-	 * If all of the slices on the order or offer can be changed then the `allowed` property will be `true`.
-	 * Refer to the `slices` for information about change penalties.
-	 * If any of the slices on the order or offer can't be changed then the `allowed` property will be `false`.
-	 * In this case you should refer to the slices conditions to determine if any part of the order or offer is changeable.
-	 * If the airline hasn't provided any information about whether this order or offer can be changed then this property will be `null`.
-	 */
-	change_before_departure?: {
-		/**
-		 * The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
-		 * This will be in a currency determined by the airline, which is not necessarily the same as the currency of the order or offer.
-		 * If this is `null` then `penalty_amount` will also be `null`.
-		 * @example "GBP"
-		 */
-		penalty_currency: string;
-		/**
-		 * If the modification is `allowed` then this is the amount payable to apply the modification to all passengers.
-		 * If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`.
-		 * If this is `null` then the `penalty_currency` will also be null.
-		 * @example "100.00"
-		 */
-		penalty_amount?: string;
-		/**
-		 * Whether this kind of modification is allowed post-booking
-		 *
-		 * @example "true"
-		 */
-		allowed: boolean;
-	} | null;
-};
-export interface LayoutSelectionPassenger {
-	id: string;
-	name?: string | null;
-}
 export interface SeatSelectionPassenger {
 	id: string;
 	name?: string | null;