@duffel/components 2.4.22 → 2.5.0

package/dist/duffel-components.d.ts

@@ -511,6 +511,18 @@ export interface City {
  * 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 passenger
+ */
+export declare type DuffelPassengerType = "adult" | "child" | "infant_without_seat";
+/**
+ * The passenger's title
+ */
+export declare type DuffelPassengerTitle = "mr" | "ms" | "mrs" | "MR" | "MS" | "MRS";
+/**
+ * The passenger's gender
+ */
+export declare type DuffelPassengerGender = "m" | "f";
 /**
  * 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.
@@ -592,6 +604,12 @@ export declare type FlightsConditions = {
 		allowed: boolean;
 	} | null;
 };
+/**
+ * The type of payment you want to apply to the order.
+ * If you are an IATA agent with your own agreements with airlines, in some cases, you can pay using ARC/BSP cash by specifying `arc_bsp_cash`. Otherwise, you must pay using your Duffel account's balance by specifying `balance`.
+ * In test mode, your balance is unlimited. If you're not sure which of these options applies to you, get in touch with the Duffel support team at [help@duffel.com](mailto:help@duffel.com).
+ */
+export declare type PaymentType = "arc_bsp_cash" | "balance";
 export interface LayoutSelectionPassenger {
 	id: string;
 	name?: string | null;
@@ -864,11 +882,687 @@ export interface AdditionalBaggageProps {
 	currencyConversion?: CurrencyConversion;
 }
 export declare const AdditionalBaggage: React.FC<AdditionalBaggageProps>;
-export interface AdditionalBaggageSelectionProps {
+export declare type OrderAvailableService = OfferAvailableService;
+export interface TravelAgentTicket {
+	id: string;
+	externalTicketId: string;
+}
+export declare type EmptyObject = Record<string, unknown>;
+export declare type OrderAvailableAction = "cancel" | "change" | "update";
+export declare type AvailableActionType = "accept" | "cancel" | "change" | "update";
+export declare type ActionTakenType = "accepted" | "cancelled" | "changed" | null;
+export declare type OfferCondition = OfferConditionModificationAllowed | OfferConditionNoModification;
+export interface LoyaltyProgrammeAccount {
 	/**
-	 * The offer we are selecting additional bagages for
+	 * The passenger's account number for this Loyalty Programme Account
 	 */
-	offer: Offer;
+	account_number: string;
+	/**
+	 * The IATA code for the airline that this Loyalty Programme Account belongs to
+	 */
+	airline_iata_code: string;
+}
+export interface OrderService {
+	/**
+	 * The `id` of the service from the offer's `available_services` that you want to book
+	 */
+	id: string;
+	/**
+	 * The quantity of the service to book
+	 */
+	quantity: number;
+}
+export interface OrderPassenger {
+	born_on: string;
+	family_name: string;
+	gender: DuffelPassengerGender;
+	given_name: string;
+	id: string;
+	infant_passenger_id?: string | null;
+	loyalty_programme_accounts?: LoyaltyProgrammeAccount[];
+	title: DuffelPassengerTitle;
+	type: DuffelPassengerType;
+}
+export declare type OrderDocumentsType = "electronic_ticket" | "electronic_miscellaneous_document_associated" | "electronic_miscellaneous_document_standalone";
+export declare type OrderDocuments = OrderDocument[];
+export interface OrderDocument {
+	/**
+	 * The list of passenger ids the document applies to.
+	 *
+	 * @example
+	 * ["pas_00009hj8USM7Ncg31cBCLL"]
+	 */
+	passenger_ids: string[];
+	/**
+	 * The type of document.
+	 */
+	type: OrderDocumentsType;
+	/**
+	 * The identifier for the document, in the case of electronic tickets this
+	 * string represents the payment or the entitlement to fly.
+	 *
+	 * @example
+	 * "1252106312810"
+	 */
+	unique_identifier: string;
+}
+export interface OrderPaymentStatus {
+	/**
+	 * Whether a payment has been made, or the airline is waiting for a payment to be made
+	 */
+	awaiting_payment: boolean;
+	/**
+	 *  The ISO 8601 datetime by which you must pay for this order.
+	 * At this time, if still unpaid, the reserved space on the flight(s)
+	 * will be released and you will have to create a new order.
+	 * This will be null only for orders where `awaiting_payment` is `false`.
+	 * Payment Required by means it will hold space
+	 */
+	payment_required_by?: string | null;
+	/**
+	 *  The ISO 8601 datetime at which the price associated
+	 * with the order will no longer be guaranteed by the airline
+	 * and the order will need to be repriced before payment.
+	 * This can be null when there is no price guarantee.
+	 * Price Guarantee means it will hold price
+	 */
+	price_guarantee_expires_at?: string | null;
+	/**
+	 * TODO: this is undocumented. Check back on https://duffel.com/docs/api/orders/schema
+	 */
+	unpaid_guarantees?: any;
+	/**
+	 * TODO: this is undocumented. Check back on https://duffel.com/docs/api/orders/schema
+	 */
+	payBy?: string | null;
+	/**
+	 *  The ISO 8601 datetime at which the Order was paid for, if at all
+	 */
+	paid_at: string | null;
+}
+export interface OrderChangeRequestOfferSlices {
+	/**
+	 * The slices to be added
+	 */
+	add: Array<OrderSlice>;
+	/**
+	 * The slices to be removed
+	 */
+	remove: Array<OrderSlice>;
+}
+export interface OrderChangeRequestOffer {
+	/**
+	 * The available payment types to complete the order change.
+	 *
+	 * @todo
+	 * Add this field to the API docs.
+	 */
+	available_payment_types?: PaymentType[] | null;
+	/**
+	 * The amount that will be charged or returned to the original payment
+	 * method if refunded, determined according to the fare conditions. This
+	 * may be negative to reflect a refund.
+	 *
+	 * @example
+	 * "90.80"
+	 */
+	change_total_amount: string;
+	/**
+	 * The currency of the `change_total_amount`, as an ISO 4217 currency
+	 * code. It will match your organisation's billing currency unless you’re
+	 * using Duffel as an accredited IATA agent, in which case it will be in
+	 * the currency provided by the airline (which will usually be based on
+	 * the country where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	change_total_currency: string;
+	/**
+	 * The ISO 8601 datetime at which the offer was created.
+	 *
+	 * @example
+	 * "2020-01-17T10:12:14.545Z"
+	 */
+	created_at: string;
+	/**
+	 * The ISO 8601 datetime at which the offer will expire and no longer be
+	 * usable to create an order.
+	 *
+	 * @example
+	 * "2020-01-17T10:42:14.545Z"
+	 *
+	 */
+	expires_at: string;
+	/**
+	 * Duffel's unique identifier for the order change offer.
+	 *
+	 * @example
+	 * "oco_0000A3vUda8dKRtUSQPSXw"
+	 */
+	id: string;
+	/**
+	 * Whether the order change offer was created in live mode. This field
+	 * will be set to `true` if the order change offer was created in live
+	 * mode, or `false if it was created in test mode.
+	 *
+	 * @example
+	 * false
+	 */
+	live_mode: boolean;
+	/**
+	 * The price of this offer if it was newly purchased.
+	 *
+	 * @example
+	 * "35.50"
+	 */
+	new_total_amount: string;
+	/**
+	 * The currency of the `new_total_amount`, as an ISO 4217 currency code.
+	 * It will match your organisation's billing currency unless you’re using
+	 * Duffel as an accredited IATA agent, in which case it will be in the
+	 * currency provided by the airline (which will usually be based on the
+	 * country where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	new_total_currency: string;
+	/**
+	 * The ID for an order change if one has already been created from this
+	 * order change offer.
+	 *
+	 * @example
+	 * "oce_0000A4QasEUIjJ6jHKfhHU"
+	 */
+	order_change_id: string | null;
+	/**
+	 * The penalty price imposed by the airline for making this change.
+	 *
+	 * @example
+	 * "10.50"
+	 */
+	penalty_total_amount: string | null;
+	/**
+	 * The currency of the `penalty_total_amount`, as an ISO 4217 currency
+	 * code. It will match your organisation's billing currency unless you’re
+	 * using Duffel as an accredited IATA agent, in which case it will be in
+	 * the currency provided by the airline (which will usually be based on
+	 * the country where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	penalty_total_currency: string | null;
+	/**
+	 * Where the refund, once confirmed, will be sent. card is currently a
+	 * restricted feature. `awaiting_payment` is for pay later orders where no
+	 * payment has been made yet.
+	 *
+	 * @todo
+	 * Align this field with the API docs.
+	 */
+	refund_to: "voucher" | "original_form_of_payment" | null;
+	/**
+	 * The slices within an order change that are being added to and/or
+	 * removed from the order.
+	 */
+	slices: OrderChangeRequestOfferSlices;
+	/**
+	 * The ISO 8601 datetime at which the offer was last updated.
+	 *
+	 * @example
+	 * "2020-01-17T10:12:14.545Z"
+	 */
+	updated_at: string;
+}
+export interface OrderChange extends Omit<OrderChangeRequestOffer, "orderChangeId"> {
+	/**
+	 * The ISO 8601 datetime that indicates when the order change was
+	 * confirmed.
+	 *
+	 * @example
+	 * "2020-01-17T11:51:43.114803Z"
+	 */
+	confirmed_at: string | null;
+	/**
+	 * Duffel's unique identifier for the order change.
+	 *
+	 * @example
+	 * "oce_0000A4QasEUIjJ6jHKfhHU"
+	 */
+	id: string;
+}
+export declare type OrderChanges = OrderChange[];
+export interface OfferConditionModificationAllowed {
+	/**
+	 * Allow the modification to the order
+	 */
+	allowed: true;
+	/**
+	 * The penalty of the modification
+	 */
+	penalty_amount: number | null;
+	/**
+	 * The penalty currency of the modification
+	 */
+	penalty_currency: string | null;
+}
+export interface OfferConditionNoModification {
+	/**
+	 * No modification to the order is allowed
+	 */
+	allowed: false;
+	/**
+	 * When the modification to the order is not allowed, both penalty amount and currency should be null
+	 */
+	penalty_amount: null;
+	penalty_currency: null;
+}
+export interface OrderSegmentPassengerBaggage {
+	quantity: number;
+	type: string;
+}
+export interface OrderSegmentPassenger {
+	baggages: OrderSegmentPassengerBaggage[];
+	cabin_class: CabinClass;
+	cabin_class_marketing_name: string;
+	passenger_id?: string;
+	/**
+	 * TODO: undocumented. Come back to add the correct type.
+	 */
+	seat?: null;
+}
+export interface OrderSliceSegment {
+	/**
+	 * The aircraft that the operating carrier will use to operate this
+	 * segment.
+	 */
+	aircraft: Aircraft;
+	/**
+	 * The ISO 8601 datetime at which the segment is scheduled to arrive. You
+	 * should use the `arrivingAt` attribute instead of this attribute, as this
+	 * will be removed in the next API version.
+	 *
+	 * @deprecated
+	 * @example
+	 * "2020-06-13T16:38:02"
+	 */
+	arrival_datetime: string;
+	/**
+	 * The terminal at the destination airport where the segment is scheduled
+	 * to arrive. You should use the `destinationTerminal` attribute instead
+	 * of this attribute, as this will be removed in the next API version.
+	 *
+	 * @deprecated
+	 * @example
+	 * "5"
+	 */
+	arrival_terminal: string | null;
+	/**
+	 * The ISO 8601 datetime at which the segment is scheduled to arrive, in
+	 * the destination airport timezone (see `destination.timezone`)
+	 *
+	 * @example
+	 * "2020-06-13T16:38:02"
+	 */
+	arriving_at: string;
+	/**
+	 * The ISO 8601 datetime at which the segment is scheduled to depart, in
+	 * the origin airport timezone (see `origin.timezone`)
+	 *
+	 * @example
+	 * "2020-06-13T16:38:02"
+	 */
+	departing_at: string;
+	/**
+	 * The ISO 8601 datetime at which the segment is scheduled to depart. You
+	 * should use the `departingAt` attribute instead of this attribute, as
+	 * this will be removed in the next API version.
+	 *
+	 * @deprecated
+	 * @example
+	 * "2020-06-13T16:38:02"
+	 */
+	departure_datetime: string;
+	/**
+	 * The terminal at the `origin` airport from which the segment is
+	 * scheduled to depart. You should use the `origin_terminal` attribute
+	 * instead of this attribute, as this will be removed in the next API
+	 * version.
+	 *
+	 * @deprecated
+	 * @example
+	 * "B"
+	 */
+	departure_terminal: string | null;
+	destination: Airport;
+	/**
+	 * The terminal at the destination airport where the segment is scheduled
+	 * to arrive.
+	 *
+	 * @example
+	 * "5"
+	 */
+	destination_terminal: string;
+	/**
+	 * The distance of the segment in kilometres.
+	 *
+	 * @example
+	 * "424.2"
+	 */
+	distance: string;
+	/**
+	 * The duration of the segment, represented as a ISO 8601 duration.
+	 *
+	 * @example
+	 * "PT02H26M"
+	 */
+	duration: string;
+	/**
+	 * Duffel's unique identifier for the segment. It identifies the segment
+	 * of an order (i.e. the same segment across orders will have different
+	 * ids.
+	 *
+	 * @example
+	 * "seg_00009htYpSCXrwaB9Dn456"
+	 */
+	id: string;
+	/**
+	 * The airline selling the tickets for this segment. This may differ from
+	 * the `operatingCarrier` in the case of a "codeshare", where one airline
+	 * sells flights operated by another airline.
+	 */
+	marketing_carrier: Airline;
+	/**
+	 * The flight number assigned by the marketing carrier.
+	 *
+	 * @example
+	 * "1234"
+	 */
+	marketing_carrier_flight_number: string;
+	/**
+	 * The airline actually operating this segment. This may differ from the
+	 * `marketingCarrier` in the case of a "codeshare", where one airline
+	 * sells flights operated by another airline.
+	 */
+	operating_carrier: Airline;
+	/**
+	 * The flight number assigned by the operating carrier. This may not be
+	 * present, in which case you should display the `marketingCarrier`'s
+	 * information and the `marketingCarrierFlightNumber`, and simply state
+	 * the name of the `operatingCarrier.
+	 *
+	 * @example
+	 * "4321"
+	 */
+	operating_carrier_flight_number: string;
+	/**
+	 * The airport from which the flight is scheduled to depart.
+	 */
+	origin: Airport;
+	/**
+	 * The terminal at the origin airport from which the segment is scheduled
+	 * to depart.
+	 *
+	 * @example
+	 * "B"
+	 */
+	origin_terminal: string;
+	/**
+	 * Additional segment-specific information about the passengers included
+	 * in the offer (e.g. their baggage allowance and the cabin class they
+	 * will be travelling in)
+	 */
+	passengers: OrderSegmentPassenger[];
+}
+export interface OrderSlice {
+	id?: string;
+	origin: Airport;
+	origin_type?: PlaceType | null;
+	destination_type?: PlaceType | null;
+	destination: Airport;
+	segments: OrderSliceSegment[];
+	duration?: string | null;
+	conditions: {
+		change_before_departure: OfferCondition | null;
+	};
+}
+export interface AirlineInitiatedChange {
+	/**
+	 * Duffel's unique identifier for the airline-initiated change
+	 */
+	id: string;
+	/**
+	 * Duffel's unique identifier for the order
+	 */
+	order_id: string;
+	/**
+	 * List of updated slices and segments following the change
+	 */
+	added: OrderSlice[];
+	/**
+	 * List of slices and segments as they were before the change
+	 */
+	removed: OrderSlice[];
+	/**
+	 * The action taken in response to this airline-initiated change
+	 */
+	action_taken: ActionTakenType;
+	/**
+	 * The ISO 8601 datetime at which an action was taken
+	 */
+	action_taken_at: string | null;
+	/**
+	 * The available actions you can take on this Airline-Initiated Change through our API.
+	 * 'update' means that you can use the update endpoint for an Airline-Initiated Change.
+	 */
+	available_actions: AvailableActionType[];
+	/**
+	 * The ISO 8601 datetime at which the Payment Intent was created
+	 */
+	created_at: string;
+	/**
+	 * The ISO 8601 datetime at which the airline-initiated change was last updated
+	 */
+	updated_at: string;
+	/**
+	 * The associated Travel Agent Ticket, if any, for this Airline-Initiated Change.
+	 * This value will be present for Airline-Initiated changes that take some time to be processed.
+	 */
+	travel_agent_ticket: TravelAgentTicket | EmptyObject | null;
+}
+export declare type AirlineInitiatedChanges = AirlineInitiatedChange[];
+export interface Order {
+	/**
+	 * The airline-initiated changes for this order.
+	 */
+	airline_initiated_changes: AirlineInitiatedChanges;
+	/**
+	 * The available actions you can take on this Order through our API.
+	 */
+	available_actions: OrderAvailableAction[];
+	/**
+	 * The available payment types to complete the order change.
+	 *
+	 * @todo
+	 * Add this field to the API docs.
+	 */
+	available_payment_types?: PaymentType[] | null;
+	/**
+	 * The base price of the order for all flights and services booked,
+	 * excluding taxes.
+	 *
+	 * @example
+	 * "60.60"
+	 */
+	base_amount: string;
+	/**
+	 * The currency of the `base_amount`, as an ISO 4217 currency code. It
+	 * will match your organisation's billing currency unless you’re using
+	 * Duffel as an accredited IATA agent, in which case it will be in the
+	 * currency provided by the airline (which will usually be based on the
+	 * country where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	base_currency: string;
+	/**
+	 * The airline's reference for the order, sometimes known as a "passenger
+	 * name record" (PNR) or "record locator". Your customers can use this to
+	 * check in and manage their booking on the airline's website. Usually,
+	 * this is made up of six alphanumeric characters, but airlines can have
+	 * their own formats (for example, easyJet's booking references are 7
+	 * alphanumeric characters long and LATAM's references are made up of 13
+	 * alphanumeric characters beginning with `LA`.)
+	 *
+	 * @example
+	 * "RZPNX8"
+	 */
+	booking_reference: string;
+	/**
+	 * The ISO 8601 datetime at which the order was cancelled, if it has been
+	 * cancelled.
+	 *
+	 * @example
+	 * "2020-04-11T15:48:11.642Z"
+	 */
+	cancelled_at: string | null;
+	/**
+	 * The passenger-initiated changes for this Order.
+	 */
+	changes: OrderChanges;
+	/**
+	 * The conditions associated with this order, describing the kinds of
+	 * modifications you can make to it 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 order - 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.
+	 */
+	conditions: {
+		change_before_departure: OfferCondition | null;
+		refund_before_departure: OfferCondition | null;
+	};
+	/**
+	 * Whether the Order is Self-Managed or Managed.
+	 */
+	content: "self_managed" | "managed";
+	/**
+	 * The ISO 8601 datetime at which the order was created.
+	 *
+	 * @example
+	 * "2020-04-11T15:48:11.642Z"
+	 *
+	 */
+	created_at: string;
+	/**
+	 *  The documents issued for this order.
+	 */
+	documents: OrderDocuments;
+	/**
+	 * Duffel's unique identifier for the order.
+	 */
+	id: string;
+	/**
+	 * Whether the order was created in live mode. This field will be set to
+	 * `true` if the order was created in live mode, or `false` if it was
+	 * created in test mode.
+	 *
+	 * @example
+	 * false
+	 */
+	live_mode: boolean;
+	/**
+	 * Metadata contains a set of key-value pairs that you can attach to an
+	 * object. It can be useful for storing additional information about the
+	 * object, in a structured format. Duffel does not use this information.
+	 * You should not store sensitive information in this field.
+	 *
+	 * @example
+	 * {"customer_prefs":"window seat","payment_intent_id":"pit_00009htYpSCXrwaB9DnUm2"}
+	 */
+	metadata: Record<string, string>;
+	/**
+	 * The airline who owns the order.
+	 */
+	owner: Airline;
+	/**
+	 * The passengers who are travelling.
+	 */
+	passengers: OrderPassenger[];
+	/**
+	 * The payment status for this order.
+	 */
+	payment_status: OrderPaymentStatus;
+	/**
+	 * The services booked along with this order.
+	 */
+	services?: OrderService[];
+	/**
+	 * The slices that make up the itinerary of this order. One-way journeys
+	 * can be expressed using one slice, whereas return trips will need two.
+	 */
+	slices: OrderSlice[];
+	/**
+	 * Airlines are always the source of truth for orders. The orders returned
+	 * in the Duffel API are a view of those orders. This field is the ISO
+	 * 8601 datetime at which the Order was last synced with the airline. If
+	 * this datetime is in the last minute you can consider the order up to
+	 * date.
+	 *
+	 * @example
+	 * "2020-04-11T15:48:11Z"
+	 */
+	synced_at: string;
+	/**
+	 * The amount of tax payable on the order for all the flights booked.
+	 *
+	 * @example
+	 * "30.20"
+	 */
+	tax_amount: string | null;
+	/**
+	 * The currency of the tax_amount, as an ISO 4217 currency code. It will
+	 * match your organisation's billing currency unless you’re using Duffel
+	 * as an accredited IATA agent, in which case it will be in the currency
+	 * provided by the airline (which will usually be based on the country
+	 * where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	tax_currency: string | null;
+	/**
+	 * @todo
+	 * Add this field to the API docs.
+	 */
+	ticket_by?: string | null;
+	/**
+	 * The total price of the order for all the flights and services booked,
+	 * including taxes.
+	 *
+	 * @example
+	 * "90.80"
+	 */
+	total_amount: string;
+	/**
+	 * The currency of the `totalAmount`, as an ISO 4217 currency code. It
+	 * will match your organisation's billing currency unless you're using
+	 * Duffel as an accredited IATA agent, in which case it will be in the
+	 * currency provided by the airline (which will usually be based on the
+	 * country where your IATA agency is registered).
+	 *
+	 * @example
+	 * "GBP"
+	 */
+	total_currency: string;
+}
+export interface AdditionalBaggageSelectionCommonProps {
 	/**
 	 * List of all passengers that will be purchasing baggages
 	 */
@@ -886,6 +1580,35 @@ export interface AdditionalBaggageSelectionProps {
 	 */
 	currencyConversion?: CurrencyConversion;
 }
+export interface AdditionalBaggageSelectionOfferProps extends AdditionalBaggageSelectionCommonProps {
+	/**
+	 * The offer we are selecting additional baggages for
+	 */
+	offer: Offer;
+	/**
+	 * The order we are selecting additional baggages for
+	 */
+	order?: never;
+	/**
+	 * The available services that can be applied to this order
+	 */
+	availableServices?: never;
+}
+export interface AdditionalBaggageSelectionServicesProps extends AdditionalBaggageSelectionCommonProps {
+	/**
+	 * The offer we are selecting additional baggages for
+	 */
+	offer?: never;
+	/**
+	 * The order we are selecting additional baggages for
+	 */
+	order?: Order;
+	/**
+	 * The available services that can be applied to this order
+	 */
+	availableServices: OrderAvailableService[];
+}
+export declare type AdditionalBaggageSelectionProps = AdditionalBaggageSelectionOfferProps | AdditionalBaggageSelectionServicesProps;
 export declare const AdditionalBaggageSelection: React.FC<AdditionalBaggageSelectionProps>;
 
 export {};