--- title: TravelComponents editUrl: false head: [] template: doc prev: false next: false sidebar: hidden: false attrs: {} pagefind: true draft: false --- Defined in: [src/travel/types.gen.ts:85](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L85) ## Properties ### headers > **headers**: `never` Defined in: [src/travel/types.gen.ts:792](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L792) *** ### parameters > **parameters**: `never` Defined in: [src/travel/types.gen.ts:790](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L790) *** ### pathItems > **pathItems**: `never` Defined in: [src/travel/types.gen.ts:793](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L793) *** ### requestBodies > **requestBodies**: `never` Defined in: [src/travel/types.gen.ts:791](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L791) *** ### responses > **responses**: `never` Defined in: [src/travel/types.gen.ts:789](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L789) *** ### schemas > **schemas**: `object` Defined in: [src/travel/types.gen.ts:86](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/travel/types.gen.ts#L86) #### Address > **Address**: `object` ##### Description A location. All fields are optional, but the object will hold as much information as possible. ##### Address.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### Address.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### Address.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### Address.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### Address.coordinates? > `optional` **coordinates?**: `object` ##### Address.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### Address.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### Address.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### Address.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### Address.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### Address.GeoCoordinates > **Address.GeoCoordinates**: `object` ###### Description The coordinates of an address. ##### Address.GeoCoordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### Address.GeoCoordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` #### AirBookingData > **AirBookingData**: `object` ##### Description Air-specific booking information. ##### AirBookingData.journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ##### AirBookingData.known\_traveler\_number? > `optional` **known\_traveler\_number?**: `object` ##### AirBookingData.known\_traveler\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ##### AirBookingData.known\_traveler\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ##### AirBookingData.redress\_number? > `optional` **redress\_number?**: `object` ##### AirBookingData.redress\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ##### AirBookingData.redress\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ##### AirBookingData.tickets > **tickets**: `object`[] ###### Description The flight tickets in this booking. ##### AirBookingData.type > **type**: `"AIR"` ###### Description discriminator enum property added by openapi-typescript ##### AirBookingData.CabinClass > **AirBookingData.CabinClass**: `"BUSINESS"` \| `"ECONOMY"` \| `"PREMIUM_ECONOMY"` \| `"FIRST"` ###### Description The cabin class of a flight. ###### Example ```ts ECONOMY @enum {string} ``` ##### AirBookingData.DocumentNumber > **AirBookingData.DocumentNumber**: `object` ###### Description A document number such as a redress number or a known traveler number. ##### AirBookingData.DocumentNumber.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ##### AirBookingData.DocumentNumber.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ##### AirBookingData.Flight > **AirBookingData.Flight**: `object` ###### Description A flight taken by the traveler. ##### AirBookingData.Flight.arrival\_time > **arrival\_time**: `object` ##### AirBookingData.Flight.arrival\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### AirBookingData.Flight.arrival\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### AirBookingData.Flight.cabin\_class? > `optional` **cabin\_class?**: `"BUSINESS"` \| `"ECONOMY"` \| `"PREMIUM_ECONOMY"` \| `"FIRST"` ##### AirBookingData.Flight.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description The airline confirmation code. ###### Example ```ts PWZRTQ ``` ##### AirBookingData.Flight.departure\_time > **departure\_time**: `object` ##### AirBookingData.Flight.departure\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### AirBookingData.Flight.departure\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### AirBookingData.Flight.destination > **destination**: `object` ##### AirBookingData.Flight.destination.airport\_code > **airport\_code**: `string` ###### Description The 3-letter IATA code of the airport. ###### Example ```ts GIG ``` ##### AirBookingData.Flight.destination.airport\_location? > `optional` **airport\_location?**: `object` ##### AirBookingData.Flight.destination.airport\_location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.Flight.destination.airport\_location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### AirBookingData.Flight.destination.airport\_location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### AirBookingData.Flight.destination.airport\_location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### AirBookingData.Flight.destination.airport\_location.coordinates? > `optional` **coordinates?**: `object` ##### AirBookingData.Flight.destination.airport\_location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### AirBookingData.Flight.destination.airport\_location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### AirBookingData.Flight.destination.airport\_location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### AirBookingData.Flight.destination.airport\_location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### AirBookingData.Flight.destination.airport\_location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### AirBookingData.Flight.destination.gate? > `optional` **gate?**: `string` \| `null` ###### Description The gate for boarding or leaving the plane. ###### Example ```ts B13 ``` ##### AirBookingData.Flight.destination.terminal? > `optional` **terminal?**: `string` \| `null` ###### Description The terminal name and/or number. ###### Example ```ts T2 ``` ##### AirBookingData.Flight.duration? > `optional` **duration?**: `string` \| `null` ###### Description The duration of the flight in the ISO 8601 PnYnMnDTnHnMnS format. ###### Example ```ts PT4h20M ``` ##### AirBookingData.Flight.marketing\_flight? > `optional` **marketing\_flight?**: `object` ##### AirBookingData.Flight.marketing\_flight.airline\_code > **airline\_code**: `string` ###### Description The IATA code for the airline. ###### Example ```ts G3 ``` ##### AirBookingData.Flight.marketing\_flight.airline\_name? > `optional` **airline\_name?**: `string` \| `null` ###### Description The name of the airline. ###### Example ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.Flight.marketing\_flight.number > **number**: `string` ###### Description The number of the flight. ###### Example ```ts 1234 ``` ##### AirBookingData.Flight.operating\_flight? > `optional` **operating\_flight?**: `object` ##### AirBookingData.Flight.operating\_flight.airline\_code > **airline\_code**: `string` ###### Description The IATA code for the airline. ###### Example ```ts G3 ``` ##### AirBookingData.Flight.operating\_flight.airline\_name? > `optional` **airline\_name?**: `string` \| `null` ###### Description The name of the airline. ###### Example ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.Flight.operating\_flight.number > **number**: `string` ###### Description The number of the flight. ###### Example ```ts 1234 ``` ##### AirBookingData.Flight.origin > **origin**: `object` ##### AirBookingData.Flight.origin.airport\_code > **airport\_code**: `string` ###### Description The 3-letter IATA code of the airport. ###### Example ```ts GIG ``` ##### AirBookingData.Flight.origin.airport\_location? > `optional` **airport\_location?**: `object` ##### AirBookingData.Flight.origin.airport\_location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.Flight.origin.airport\_location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### AirBookingData.Flight.origin.airport\_location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### AirBookingData.Flight.origin.airport\_location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### AirBookingData.Flight.origin.airport\_location.coordinates? > `optional` **coordinates?**: `object` ##### AirBookingData.Flight.origin.airport\_location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### AirBookingData.Flight.origin.airport\_location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### AirBookingData.Flight.origin.airport\_location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### AirBookingData.Flight.origin.airport\_location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### AirBookingData.Flight.origin.airport\_location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### AirBookingData.Flight.origin.gate? > `optional` **gate?**: `string` \| `null` ###### Description The gate for boarding or leaving the plane. ###### Example ```ts B13 ``` ##### AirBookingData.Flight.origin.terminal? > `optional` **terminal?**: `string` \| `null` ###### Description The terminal name and/or number. ###### Example ```ts T2 ``` ##### AirBookingData.Flight.seat? > `optional` **seat?**: `object` ##### AirBookingData.Flight.seat.number > **number**: `string` ###### Description The seat number. ###### Example ```ts 31D ``` ##### AirBookingData.Flight.seat.status? > `optional` **status?**: `"CANCELED"` \| `"PENDING"` \| `"CONFIRMED"` ##### AirBookingData.FlightEndpoint > **AirBookingData.FlightEndpoint**: `object` ###### Description The place where a flight departs from or arrives at. ##### AirBookingData.FlightEndpoint.airport\_code > **airport\_code**: `string` ###### Description The 3-letter IATA code of the airport. ###### Example ```ts GIG ``` ##### AirBookingData.FlightEndpoint.airport\_location? > `optional` **airport\_location?**: `object` ##### AirBookingData.FlightEndpoint.airport\_location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### AirBookingData.FlightEndpoint.airport\_location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### AirBookingData.FlightEndpoint.airport\_location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### AirBookingData.FlightEndpoint.airport\_location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates? > `optional` **coordinates?**: `object` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### AirBookingData.FlightEndpoint.airport\_location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### AirBookingData.FlightEndpoint.airport\_location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### AirBookingData.FlightEndpoint.airport\_location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### AirBookingData.FlightEndpoint.airport\_location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### AirBookingData.FlightEndpoint.gate? > `optional` **gate?**: `string` \| `null` ###### Description The gate for boarding or leaving the plane. ###### Example ```ts B13 ``` ##### AirBookingData.FlightEndpoint.terminal? > `optional` **terminal?**: `string` \| `null` ###### Description The terminal name and/or number. ###### Example ```ts T2 ``` ##### AirBookingData.FlightNumber > **AirBookingData.FlightNumber**: `object` ###### Description The flight number, including carrier information. ##### AirBookingData.FlightNumber.airline\_code > **airline\_code**: `string` ###### Description The IATA code for the airline. ###### Example ```ts G3 ``` ##### AirBookingData.FlightNumber.airline\_name? > `optional` **airline\_name?**: `string` \| `null` ###### Description The name of the airline. ###### Example ```ts GOL Linhas Aereas S.A. ``` ##### AirBookingData.FlightNumber.number > **number**: `string` ###### Description The number of the flight. ###### Example ```ts 1234 ``` ##### AirBookingData.FlightSeat > **AirBookingData.FlightSeat**: `object` ###### Description Seat information in a flight. ##### AirBookingData.FlightSeat.number > **number**: `string` ###### Description The seat number. ###### Example ```ts 31D ``` ##### AirBookingData.FlightSeat.status? > `optional` **status?**: `"CANCELED"` \| `"PENDING"` \| `"CONFIRMED"` ##### AirBookingData.FlightSeatStatus > **AirBookingData.FlightSeatStatus**: `"CANCELED"` \| `"PENDING"` \| `"CONFIRMED"` ###### Description The status of a flight seat. ###### Example ```ts CONFIRMED @enum {string} ``` ##### AirBookingData.FlightTicket > **AirBookingData.FlightTicket**: `object` ###### Description A flight ticket. ##### AirBookingData.FlightTicket.issue\_date? > `optional` **issue\_date?**: `string` \| `null` Format: date ###### Description The date when the ticket was issued. ###### Example ```ts 2017-12-27 ``` ##### AirBookingData.FlightTicket.number > **number**: `string` ###### Description The ticket number provided by the airline. ###### Example ```ts 0017959463925 ``` ##### AirBookingData.Journey > **AirBookingData.Journey**: `object` ###### Description A journey is composed of one or more flight segments that take a passenger from an origin to a final destination. E.g. if a traveler is doing a round trip from GIG to SFO, but they need to make a connection in IAH in each direction, the booking will contain 2 journeys. The first will contain 2 segments: GIG > IAH, and IAH > SFO. The second journey will also contain 2 segments: SFO > IAH, and IAH > GIG. ##### AirBookingData.Journey.cabin\_display\_name? > `optional` **cabin\_display\_name?**: `string` \| `null` ###### Description The cabin name as shown by the airline. ###### Example ```ts Flexible Economy ``` ##### AirBookingData.Journey.flights > **flights**: `object`[] ###### Description The flights that make up this journey. ##### AirBookingData.Journey.status > **status**: `"PROCESSING"` \| `"CANCELED"` \| `"REFUNDED"` \| `"IN_PROGRESS"` \| `"APPROVAL_DENIED"` \| `"PENDING"` \| `"CONFIRMED"` \| `"HOLD"` \| `"COMPLETED"` \| `"VOIDED"` \| `"UNCONFIRMED"` \| `"AIRLINE_CONTROL"` \| `"PAYMENT_DECLINED"` \| `"SCHEDULE_CHANGE"` \| `"APPROVAL_REQUESTED"` \| `"CANCELLATION_IN_PROGRESS"` #### Booking > **Booking**: `object` ##### Description A booking representation. ##### Booking.booking\_data > **booking\_data**: \{ `journeys`: `object`[]; `known_traveler_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `redress_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `tickets`: `object`[]; `type`: `"AIR"`; \} \| \{ `car_details`: \{ `car_class?`: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; \}; `reservation_details`: \{ `confirmation_code?`: `string` \| `null`; `drop_off`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `pickup`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `rental_company?`: `string` \| `null`; \}; `type`: `"CAR_RENTAL"`; \} \| \{ `lodging_details`: \{ `brand_name?`: `string` \| `null`; `chain_name?`: `string` \| `null`; `contact_information?`: \{ `email?`: `string` \| `null`; `fax?`: `string` \| `null`; `phone?`: `string` \| `null`; \}; `display_name`: `string`; `location?`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `star_rating?`: `number` \| `null`; \}; `reservation_details`: \{ `check_in_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `checkout_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `confirmation_code?`: `string` \| `null`; `room?`: \{ `bed_count?`: `number` \| `null`; `bed_type?`: `string` \| `null`; `description?`: `string` \| `null`; `display_name?`: `string` \| `null`; \}; \}; `type`: `"LODGING"`; \} \| \{ `journeys`: `object`[]; `type`: `"RAIL"`; \} ###### Union Members ###### Type Literal \{ `journeys`: `object`[]; `known_traveler_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `redress_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `tickets`: `object`[]; `type`: `"AIR"`; \} ###### journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ###### known\_traveler\_number? > `optional` **known\_traveler\_number?**: `object` ###### known\_traveler\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ###### known\_traveler\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ###### redress\_number? > `optional` **redress\_number?**: `object` ###### redress\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ###### redress\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ###### tickets > **tickets**: `object`[] ###### Description The flight tickets in this booking. ###### type > **type**: `"AIR"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `car_details`: \{ `car_class?`: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; \}; `reservation_details`: \{ `confirmation_code?`: `string` \| `null`; `drop_off`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `pickup`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `rental_company?`: `string` \| `null`; \}; `type`: `"CAR_RENTAL"`; \} ###### car\_details > **car\_details**: `object` ###### car\_details.car\_class? > `optional` **car\_class?**: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"` ###### car\_details.display\_name > **display\_name**: `string` ###### Description The name of the car as displayed to the user. ###### Example ```ts Intermediate car ``` ###### reservation\_details > **reservation\_details**: `object` ###### reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description The confirmation code given by the vendor. ###### Example ```ts 7003XBQ504 ``` ###### reservation\_details.drop\_off > **drop\_off**: `object` ###### reservation\_details.drop\_off.location > **location**: `object` ###### reservation\_details.drop\_off.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.drop\_off.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### reservation\_details.drop\_off.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### reservation\_details.drop\_off.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### reservation\_details.drop\_off.location.coordinates? > `optional` **coordinates?**: `object` ###### reservation\_details.drop\_off.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### reservation\_details.drop\_off.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### reservation\_details.drop\_off.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### reservation\_details.drop\_off.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### reservation\_details.drop\_off.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### reservation\_details.drop\_off.time > **time**: `object` ###### reservation\_details.drop\_off.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.drop\_off.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.pickup > **pickup**: `object` ###### reservation\_details.pickup.location > **location**: `object` ###### reservation\_details.pickup.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.pickup.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### reservation\_details.pickup.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### reservation\_details.pickup.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### reservation\_details.pickup.location.coordinates? > `optional` **coordinates?**: `object` ###### reservation\_details.pickup.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### reservation\_details.pickup.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### reservation\_details.pickup.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### reservation\_details.pickup.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### reservation\_details.pickup.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### reservation\_details.pickup.time > **time**: `object` ###### reservation\_details.pickup.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.pickup.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.rental\_company? > `optional` **rental\_company?**: `string` \| `null` ###### Description Name of car rental company. ###### Example ```ts Catch-A-Ride ``` ###### type > **type**: `"CAR_RENTAL"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `lodging_details`: \{ `brand_name?`: `string` \| `null`; `chain_name?`: `string` \| `null`; `contact_information?`: \{ `email?`: `string` \| `null`; `fax?`: `string` \| `null`; `phone?`: `string` \| `null`; \}; `display_name`: `string`; `location?`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `star_rating?`: `number` \| `null`; \}; `reservation_details`: \{ `check_in_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `checkout_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `confirmation_code?`: `string` \| `null`; `room?`: \{ `bed_count?`: `number` \| `null`; `bed_type?`: `string` \| `null`; `description?`: `string` \| `null`; `display_name?`: `string` \| `null`; \}; \}; `type`: `"LODGING"`; \} ###### lodging\_details > **lodging\_details**: `object` ###### lodging\_details.brand\_name? > `optional` **brand\_name?**: `string` \| `null` ###### Description The brand name of the hotel. ###### Example ```ts Marriott Hotels ``` ###### lodging\_details.chain\_name? > `optional` **chain\_name?**: `string` \| `null` ###### Description The name of the hotel chain. ###### Example ```ts Accor Hotels ``` ###### lodging\_details.contact\_information? > `optional` **contact\_information?**: `object` ###### lodging\_details.contact\_information.email? > `optional` **email?**: `string` \| `null` ###### Description The email address of the venue. ###### Example ```ts city@hotelchain.com ``` ###### lodging\_details.contact\_information.fax? > `optional` **fax?**: `string` \| `null` ###### Description The fax number of the venue. ###### Example ```ts 12345554321 ``` ###### lodging\_details.contact\_information.phone? > `optional` **phone?**: `string` \| `null` ###### Description The phone number of the venue. ###### Example ```ts 12345554321 ``` ###### lodging\_details.display\_name > **display\_name**: `string` ###### Description The name of the venue as displayed to the user. ###### Example ```ts Fancy Hotel ``` ###### lodging\_details.location? > `optional` **location?**: `object` ###### lodging\_details.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### lodging\_details.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### lodging\_details.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### lodging\_details.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### lodging\_details.location.coordinates? > `optional` **coordinates?**: `object` ###### lodging\_details.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### lodging\_details.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### lodging\_details.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### lodging\_details.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### lodging\_details.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### lodging\_details.star\_rating? > `optional` **star\_rating?**: `number` \| `null` Format: float ###### Description The star rating of the hotel. Some hotels have half stars. ###### Example ```ts 3.5 ``` ###### reservation\_details > **reservation\_details**: `object` ###### reservation\_details.check\_in\_time > **check\_in\_time**: `object` ###### reservation\_details.check\_in\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.check\_in\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.checkout\_time > **checkout\_time**: `object` ###### reservation\_details.checkout\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.checkout\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description Confirmation code provided by the vendor. ###### Example ```ts 7003XBQ504 ``` ###### reservation\_details.room? > `optional` **room?**: `object` ###### reservation\_details.room.bed\_count? > `optional` **bed\_count?**: `number` \| `null` Format: int32 ###### Description The number of beds. ###### Example ```ts 1 ``` ###### reservation\_details.room.bed\_type? > `optional` **bed\_type?**: `string` \| `null` ###### Description The kind of bed. ###### Example ```ts DOUBLE ``` ###### reservation\_details.room.description? > `optional` **description?**: `string` \| `null` ###### Description A description of the room. ###### Example ```ts Superior room ``` ###### reservation\_details.room.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description The name of the room as displayed to the user. ###### Example ```ts Standard room ``` ###### type > **type**: `"LODGING"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `journeys`: `object`[]; `type`: `"RAIL"`; \} ###### journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ###### type > **type**: `"RAIL"` ###### Description discriminator enum property added by openapi-typescript ##### Booking.created\_at > **created\_at**: `string` Format: date-time ###### Description The time when the booking was created. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Booking.id > **id**: `string` ###### Description The ID of the booking. ###### Example ```ts booking_cl9t5dnu800040m3071dandeq ``` ##### Booking.source > **source**: `"BREX_TRAVEL"` \| `"EXTERNAL"` ##### Booking.status > **status**: `"PROCESSING"` \| `"CANCELED"` \| `"REFUNDED"` \| `"IN_PROGRESS"` \| `"APPROVAL_DENIED"` \| `"PENDING"` \| `"CONFIRMED"` \| `"HOLD"` \| `"COMPLETED"` \| `"VOIDED"` \| `"UNCONFIRMED"` \| `"AIRLINE_CONTROL"` \| `"PAYMENT_DECLINED"` \| `"SCHEDULE_CHANGE"` \| `"APPROVAL_REQUESTED"` \| `"CANCELLATION_IN_PROGRESS"` ##### Booking.trip\_id > **trip\_id**: `string` ###### Description The ID of the trip to which this booking belongs. ###### Example ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### Booking.type > **type**: `"CAR_RENTAL"` \| `"LODGING"` \| `"AIR"` \| `"RAIL"` ##### Booking.updated\_at > **updated\_at**: `string` Format: date-time ###### Description The time when the booking was last updated. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Booking.version > **version**: `number` Format: int32 ###### Description The current version of the booking. ###### Example ```ts 2 ``` ##### Booking.Data > **Booking.Data**: \{ `journeys`: `object`[]; `known_traveler_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `redress_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `tickets`: `object`[]; `type`: `"AIR"`; \} \| \{ `car_details`: \{ `car_class?`: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; \}; `reservation_details`: \{ `confirmation_code?`: `string` \| `null`; `drop_off`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `pickup`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `rental_company?`: `string` \| `null`; \}; `type`: `"CAR_RENTAL"`; \} \| \{ `lodging_details`: \{ `brand_name?`: `string` \| `null`; `chain_name?`: `string` \| `null`; `contact_information?`: \{ `email?`: `string` \| `null`; `fax?`: `string` \| `null`; `phone?`: `string` \| `null`; \}; `display_name`: `string`; `location?`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `star_rating?`: `number` \| `null`; \}; `reservation_details`: \{ `check_in_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `checkout_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `confirmation_code?`: `string` \| `null`; `room?`: \{ `bed_count?`: `number` \| `null`; `bed_type?`: `string` \| `null`; `description?`: `string` \| `null`; `display_name?`: `string` \| `null`; \}; \}; `type`: `"LODGING"`; \} \| \{ `journeys`: `object`[]; `type`: `"RAIL"`; \} ###### Union Members ###### Type Literal \{ `journeys`: `object`[]; `known_traveler_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `redress_number?`: \{ `document_number`: `string`; `issuing_country`: `string`; \}; `tickets`: `object`[]; `type`: `"AIR"`; \} ###### journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ###### known\_traveler\_number? > `optional` **known\_traveler\_number?**: `object` ###### known\_traveler\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ###### known\_traveler\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ###### redress\_number? > `optional` **redress\_number?**: `object` ###### redress\_number.document\_number > **document\_number**: `string` ###### Description The actual document number. ###### Example ```ts 1231231 ``` ###### redress\_number.issuing\_country > **issuing\_country**: `string` ###### Description The country that issued this document. ###### Example ```ts BR ``` ###### tickets > **tickets**: `object`[] ###### Description The flight tickets in this booking. ###### type > **type**: `"AIR"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `car_details`: \{ `car_class?`: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"`; `display_name`: `string`; \}; `reservation_details`: \{ `confirmation_code?`: `string` \| `null`; `drop_off`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `pickup`: \{ `location`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; \}; `rental_company?`: `string` \| `null`; \}; `type`: `"CAR_RENTAL"`; \} ###### car\_details > **car\_details**: `object` ###### car\_details.car\_class? > `optional` **car\_class?**: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"` ###### car\_details.display\_name > **display\_name**: `string` ###### Description The name of the car as displayed to the user. ###### Example ```ts Intermediate car ``` ###### reservation\_details > **reservation\_details**: `object` ###### reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description The confirmation code given by the vendor. ###### Example ```ts 7003XBQ504 ``` ###### reservation\_details.drop\_off > **drop\_off**: `object` ###### reservation\_details.drop\_off.location > **location**: `object` ###### reservation\_details.drop\_off.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.drop\_off.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### reservation\_details.drop\_off.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### reservation\_details.drop\_off.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### reservation\_details.drop\_off.location.coordinates? > `optional` **coordinates?**: `object` ###### reservation\_details.drop\_off.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### reservation\_details.drop\_off.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### reservation\_details.drop\_off.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### reservation\_details.drop\_off.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### reservation\_details.drop\_off.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### reservation\_details.drop\_off.time > **time**: `object` ###### reservation\_details.drop\_off.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.drop\_off.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.pickup > **pickup**: `object` ###### reservation\_details.pickup.location > **location**: `object` ###### reservation\_details.pickup.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### reservation\_details.pickup.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### reservation\_details.pickup.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### reservation\_details.pickup.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### reservation\_details.pickup.location.coordinates? > `optional` **coordinates?**: `object` ###### reservation\_details.pickup.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### reservation\_details.pickup.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### reservation\_details.pickup.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### reservation\_details.pickup.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### reservation\_details.pickup.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### reservation\_details.pickup.time > **time**: `object` ###### reservation\_details.pickup.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.pickup.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.rental\_company? > `optional` **rental\_company?**: `string` \| `null` ###### Description Name of car rental company. ###### Example ```ts Catch-A-Ride ``` ###### type > **type**: `"CAR_RENTAL"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `lodging_details`: \{ `brand_name?`: `string` \| `null`; `chain_name?`: `string` \| `null`; `contact_information?`: \{ `email?`: `string` \| `null`; `fax?`: `string` \| `null`; `phone?`: `string` \| `null`; \}; `display_name`: `string`; `location?`: \{ `address_line_1?`: `string` \| `null`; `address_line_2?`: `string` \| `null`; `administrative_area?`: `string` \| `null`; `city?`: `string` \| `null`; `coordinates?`: \{ `latitude`: `number`; `longitude`: `number`; \}; `country?`: `string` \| `null`; `postal_code?`: `string` \| `null`; `timezone?`: `string` \| `null`; \}; `star_rating?`: `number` \| `null`; \}; `reservation_details`: \{ `check_in_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `checkout_time`: \{ `local_time`: `string`; `timestamp?`: `string` \| `null`; \}; `confirmation_code?`: `string` \| `null`; `room?`: \{ `bed_count?`: `number` \| `null`; `bed_type?`: `string` \| `null`; `description?`: `string` \| `null`; `display_name?`: `string` \| `null`; \}; \}; `type`: `"LODGING"`; \} ###### lodging\_details > **lodging\_details**: `object` ###### lodging\_details.brand\_name? > `optional` **brand\_name?**: `string` \| `null` ###### Description The brand name of the hotel. ###### Example ```ts Marriott Hotels ``` ###### lodging\_details.chain\_name? > `optional` **chain\_name?**: `string` \| `null` ###### Description The name of the hotel chain. ###### Example ```ts Accor Hotels ``` ###### lodging\_details.contact\_information? > `optional` **contact\_information?**: `object` ###### lodging\_details.contact\_information.email? > `optional` **email?**: `string` \| `null` ###### Description The email address of the venue. ###### Example ```ts city@hotelchain.com ``` ###### lodging\_details.contact\_information.fax? > `optional` **fax?**: `string` \| `null` ###### Description The fax number of the venue. ###### Example ```ts 12345554321 ``` ###### lodging\_details.contact\_information.phone? > `optional` **phone?**: `string` \| `null` ###### Description The phone number of the venue. ###### Example ```ts 12345554321 ``` ###### lodging\_details.display\_name > **display\_name**: `string` ###### Description The name of the venue as displayed to the user. ###### Example ```ts Fancy Hotel ``` ###### lodging\_details.location? > `optional` **location?**: `object` ###### lodging\_details.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ###### lodging\_details.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ###### lodging\_details.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ###### lodging\_details.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ###### lodging\_details.location.coordinates? > `optional` **coordinates?**: `object` ###### lodging\_details.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ###### lodging\_details.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ###### lodging\_details.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ###### lodging\_details.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ###### lodging\_details.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ###### lodging\_details.star\_rating? > `optional` **star\_rating?**: `number` \| `null` Format: float ###### Description The star rating of the hotel. Some hotels have half stars. ###### Example ```ts 3.5 ``` ###### reservation\_details > **reservation\_details**: `object` ###### reservation\_details.check\_in\_time > **check\_in\_time**: `object` ###### reservation\_details.check\_in\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.check\_in\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.checkout\_time > **checkout\_time**: `object` ###### reservation\_details.checkout\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ###### reservation\_details.checkout\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ###### reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description Confirmation code provided by the vendor. ###### Example ```ts 7003XBQ504 ``` ###### reservation\_details.room? > `optional` **room?**: `object` ###### reservation\_details.room.bed\_count? > `optional` **bed\_count?**: `number` \| `null` Format: int32 ###### Description The number of beds. ###### Example ```ts 1 ``` ###### reservation\_details.room.bed\_type? > `optional` **bed\_type?**: `string` \| `null` ###### Description The kind of bed. ###### Example ```ts DOUBLE ``` ###### reservation\_details.room.description? > `optional` **description?**: `string` \| `null` ###### Description A description of the room. ###### Example ```ts Superior room ``` ###### reservation\_details.room.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description The name of the room as displayed to the user. ###### Example ```ts Standard room ``` ###### type > **type**: `"LODGING"` ###### Description discriminator enum property added by openapi-typescript *** ###### Type Literal \{ `journeys`: `object`[]; `type`: `"RAIL"`; \} ###### journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ###### type > **type**: `"RAIL"` ###### Description discriminator enum property added by openapi-typescript ###### Description Type-specific booking data. ##### Booking.Source > **Booking.Source**: `"BREX_TRAVEL"` \| `"EXTERNAL"` ###### Description The original source of a booking: * `BREX_TRAVEL` - The booking was created via Brex Travel. * `EXTERNAL` - The booking was manually inserted, e.g. a hotel room block for a group event. ###### Example ```ts BREX_TRAVEL @enum {string} ``` ##### Booking.Time > **Booking.Time**: `object` ###### Description A time within a booking, including local time in the relevant location, and a timestamp when possible. ##### Booking.Time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### Booking.Time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Booking.Type > **Booking.Type**: `"CAR_RENTAL"` \| `"LODGING"` \| `"AIR"` \| `"RAIL"` ###### Description The type of a booking. ###### Example ```ts AIR @enum {string} ``` #### BookingStatus > **BookingStatus**: `"PROCESSING"` \| `"CANCELED"` \| `"REFUNDED"` \| `"IN_PROGRESS"` \| `"APPROVAL_DENIED"` \| `"PENDING"` \| `"CONFIRMED"` \| `"HOLD"` \| `"COMPLETED"` \| `"VOIDED"` \| `"UNCONFIRMED"` \| `"AIRLINE_CONTROL"` \| `"PAYMENT_DECLINED"` \| `"SCHEDULE_CHANGE"` \| `"APPROVAL_REQUESTED"` \| `"CANCELLATION_IN_PROGRESS"` ##### Description The status of the booking: * `HOLD` - The booking is a hold, and may be canceled without being charged. * `PENDING` - Some action needs to be completed before the booking is confirmed. Usually the action is the payment being confirmed. * `CONFIRMED` - The booking is confirmed. * `COMPLETED` - The booking has already happened. * `CANCELED` - The booking has been canceled. * `IN_PROGRESS` - The booking is currently in progress. * `REFUNDED` - A refund has been issued. It may or may not be a full refund. * `VOIDED` - Voided is similar to (and can be treated the same as) canceled. * `PROCESSING` - The booking has been created or changed, but confirmation from the vendor has not been received yet. * `UNCONFIRMED` - The booking was in the `PROCESSING` state for too long and some action is probably required to get this booking confirmed. * `AIRLINE_CONTROL` - The airline has taken control of the booking and further updates may not be visible. * `PAYMENT_DECLINED` - The payment for the booking has failed. * `SCHEDULE_CHANGE` - Some change has happened to the booking schedule, e.g. the flight getting canceled and the passenger reallocated to another flight. Travel support should reach out to confirm the traveler accepts the new schedule. * `APPROVAL_REQUESTED` - The booking is subject to approval, and it is waiting for a review. * `APPROVAL_DENIED` - A reviewer has denied the booking, or the deadline to approve the booking has passed and it got canceled. * `CANCELLATION_IN_PROGRESS` - The booking is currently being canceled. ##### Example ```ts CONFIRMED @enum {string} ``` #### CarRentalBookingData > **CarRentalBookingData**: `object` ##### Description Car rental-specific booking information. ##### CarRentalBookingData.car\_details > **car\_details**: `object` ##### CarRentalBookingData.car\_details.car\_class? > `optional` **car\_class?**: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"` ##### CarRentalBookingData.car\_details.display\_name > **display\_name**: `string` ###### Description The name of the car as displayed to the user. ###### Example ```ts Intermediate car ``` ##### CarRentalBookingData.reservation\_details > **reservation\_details**: `object` ##### CarRentalBookingData.reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description The confirmation code given by the vendor. ###### Example ```ts 7003XBQ504 ``` ##### CarRentalBookingData.reservation\_details.drop\_off > **drop\_off**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location > **location**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates? > `optional` **coordinates?**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### CarRentalBookingData.reservation\_details.drop\_off.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.reservation\_details.drop\_off.time > **time**: `object` ##### CarRentalBookingData.reservation\_details.drop\_off.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.reservation\_details.drop\_off.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.reservation\_details.pickup > **pickup**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location > **location**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.reservation\_details.pickup.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### CarRentalBookingData.reservation\_details.pickup.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### CarRentalBookingData.reservation\_details.pickup.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates? > `optional` **coordinates?**: `object` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### CarRentalBookingData.reservation\_details.pickup.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### CarRentalBookingData.reservation\_details.pickup.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.reservation\_details.pickup.time > **time**: `object` ##### CarRentalBookingData.reservation\_details.pickup.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.reservation\_details.pickup.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.reservation\_details.rental\_company? > `optional` **rental\_company?**: `string` \| `null` ###### Description Name of car rental company. ###### Example ```ts Catch-A-Ride ``` ##### CarRentalBookingData.type > **type**: `"CAR_RENTAL"` ###### Description discriminator enum property added by openapi-typescript ##### CarRentalBookingData.CarClass > **CarRentalBookingData.CarClass**: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"` ###### Description The kind of car. ###### Example ```ts INTERMEDIATE @enum {string} ``` ##### CarRentalBookingData.CarDetails > **CarRentalBookingData.CarDetails**: `object` ###### Description Information on a rental car. ##### CarRentalBookingData.CarDetails.car\_class? > `optional` **car\_class?**: `"OTHER"` \| `"ECONOMY"` \| `"COMPACT"` \| `"INTERMEDIATE"` \| `"PREMIUM"` \| `"LUXURY"` \| `"CONVERTIBLE"` \| `"COMPACT_SUV"` \| `"INTERMEDIATE_SUV"` \| `"PREMIUM_SUV"` \| `"LUXURY_SUV"` \| `"MINI_VAN"` \| `"PASSENGER_VAN"` \| `"PICKUP_TRUCK"` \| `"HYBRID"` \| `"ELECTRIC"` \| `"MINI"` \| `"STANDARD"` \| `"FULL_SIZE"` \| `"SUV"` \| `"SPORTS"` \| `"SPECIAL"` \| `"RECREATIONAL_VEHICLE"` ##### CarRentalBookingData.CarDetails.display\_name > **display\_name**: `string` ###### Description The name of the car as displayed to the user. ###### Example ```ts Intermediate car ``` ##### CarRentalBookingData.RentalEndpoint > **CarRentalBookingData.RentalEndpoint**: `object` ###### Description Information about the car pickup or drop-off. ##### CarRentalBookingData.RentalEndpoint.location > **location**: `object` ##### CarRentalBookingData.RentalEndpoint.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.RentalEndpoint.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### CarRentalBookingData.RentalEndpoint.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### CarRentalBookingData.RentalEndpoint.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### CarRentalBookingData.RentalEndpoint.location.coordinates? > `optional` **coordinates?**: `object` ##### CarRentalBookingData.RentalEndpoint.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### CarRentalBookingData.RentalEndpoint.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### CarRentalBookingData.RentalEndpoint.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### CarRentalBookingData.RentalEndpoint.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### CarRentalBookingData.RentalEndpoint.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.RentalEndpoint.time > **time**: `object` ##### CarRentalBookingData.RentalEndpoint.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.RentalEndpoint.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails > **CarRentalBookingData.ReservationDetails**: `object` ###### Description Information on a car reservation such as pickup, drop-off, etc. ##### CarRentalBookingData.ReservationDetails.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description The confirmation code given by the vendor. ###### Example ```ts 7003XBQ504 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off > **drop\_off**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location > **location**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates? > `optional` **coordinates?**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.ReservationDetails.drop\_off.time > **time**: `object` ##### CarRentalBookingData.ReservationDetails.drop\_off.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.ReservationDetails.drop\_off.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails.pickup > **pickup**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location > **location**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates? > `optional` **coordinates?**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### CarRentalBookingData.ReservationDetails.pickup.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### CarRentalBookingData.ReservationDetails.pickup.time > **time**: `object` ##### CarRentalBookingData.ReservationDetails.pickup.time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### CarRentalBookingData.ReservationDetails.pickup.time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### CarRentalBookingData.ReservationDetails.rental\_company? > `optional` **rental\_company?**: `string` \| `null` ###### Description Name of car rental company. ###### Example ```ts Catch-A-Ride ``` #### LodgingBookingData > **LodgingBookingData**: `object` ##### Description Lodging-specific booking information. ##### LodgingBookingData.lodging\_details > **lodging\_details**: `object` ##### LodgingBookingData.lodging\_details.brand\_name? > `optional` **brand\_name?**: `string` \| `null` ###### Description The brand name of the hotel. ###### Example ```ts Marriott Hotels ``` ##### LodgingBookingData.lodging\_details.chain\_name? > `optional` **chain\_name?**: `string` \| `null` ###### Description The name of the hotel chain. ###### Example ```ts Accor Hotels ``` ##### LodgingBookingData.lodging\_details.contact\_information? > `optional` **contact\_information?**: `object` ##### LodgingBookingData.lodging\_details.contact\_information.email? > `optional` **email?**: `string` \| `null` ###### Description The email address of the venue. ###### Example ```ts city@hotelchain.com ``` ##### LodgingBookingData.lodging\_details.contact\_information.fax? > `optional` **fax?**: `string` \| `null` ###### Description The fax number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.lodging\_details.contact\_information.phone? > `optional` **phone?**: `string` \| `null` ###### Description The phone number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.lodging\_details.display\_name > **display\_name**: `string` ###### Description The name of the venue as displayed to the user. ###### Example ```ts Fancy Hotel ``` ##### LodgingBookingData.lodging\_details.location? > `optional` **location?**: `object` ##### LodgingBookingData.lodging\_details.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### LodgingBookingData.lodging\_details.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### LodgingBookingData.lodging\_details.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### LodgingBookingData.lodging\_details.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### LodgingBookingData.lodging\_details.location.coordinates? > `optional` **coordinates?**: `object` ##### LodgingBookingData.lodging\_details.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### LodgingBookingData.lodging\_details.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### LodgingBookingData.lodging\_details.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### LodgingBookingData.lodging\_details.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### LodgingBookingData.lodging\_details.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### LodgingBookingData.lodging\_details.star\_rating? > `optional` **star\_rating?**: `number` \| `null` Format: float ###### Description The star rating of the hotel. Some hotels have half stars. ###### Example ```ts 3.5 ``` ##### LodgingBookingData.reservation\_details > **reservation\_details**: `object` ##### LodgingBookingData.reservation\_details.check\_in\_time > **check\_in\_time**: `object` ##### LodgingBookingData.reservation\_details.check\_in\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.reservation\_details.check\_in\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.reservation\_details.checkout\_time > **checkout\_time**: `object` ##### LodgingBookingData.reservation\_details.checkout\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.reservation\_details.checkout\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.reservation\_details.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description Confirmation code provided by the vendor. ###### Example ```ts 7003XBQ504 ``` ##### LodgingBookingData.reservation\_details.room? > `optional` **room?**: `object` ##### LodgingBookingData.reservation\_details.room.bed\_count? > `optional` **bed\_count?**: `number` \| `null` Format: int32 ###### Description The number of beds. ###### Example ```ts 1 ``` ##### LodgingBookingData.reservation\_details.room.bed\_type? > `optional` **bed\_type?**: `string` \| `null` ###### Description The kind of bed. ###### Example ```ts DOUBLE ``` ##### LodgingBookingData.reservation\_details.room.description? > `optional` **description?**: `string` \| `null` ###### Description A description of the room. ###### Example ```ts Superior room ``` ##### LodgingBookingData.reservation\_details.room.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description The name of the room as displayed to the user. ###### Example ```ts Standard room ``` ##### LodgingBookingData.type > **type**: `"LODGING"` ###### Description discriminator enum property added by openapi-typescript ##### LodgingBookingData.ContactInfo > **LodgingBookingData.ContactInfo**: `object` ###### Description Contact information of a venue. ##### LodgingBookingData.ContactInfo.email? > `optional` **email?**: `string` \| `null` ###### Description The email address of the venue. ###### Example ```ts city@hotelchain.com ``` ##### LodgingBookingData.ContactInfo.fax? > `optional` **fax?**: `string` \| `null` ###### Description The fax number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.ContactInfo.phone? > `optional` **phone?**: `string` \| `null` ###### Description The phone number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails > **LodgingBookingData.LodgingDetails**: `object` ###### Description Information on a lodging venue. ##### LodgingBookingData.LodgingDetails.brand\_name? > `optional` **brand\_name?**: `string` \| `null` ###### Description The brand name of the hotel. ###### Example ```ts Marriott Hotels ``` ##### LodgingBookingData.LodgingDetails.chain\_name? > `optional` **chain\_name?**: `string` \| `null` ###### Description The name of the hotel chain. ###### Example ```ts Accor Hotels ``` ##### LodgingBookingData.LodgingDetails.contact\_information? > `optional` **contact\_information?**: `object` ##### LodgingBookingData.LodgingDetails.contact\_information.email? > `optional` **email?**: `string` \| `null` ###### Description The email address of the venue. ###### Example ```ts city@hotelchain.com ``` ##### LodgingBookingData.LodgingDetails.contact\_information.fax? > `optional` **fax?**: `string` \| `null` ###### Description The fax number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails.contact\_information.phone? > `optional` **phone?**: `string` \| `null` ###### Description The phone number of the venue. ###### Example ```ts 12345554321 ``` ##### LodgingBookingData.LodgingDetails.display\_name > **display\_name**: `string` ###### Description The name of the venue as displayed to the user. ###### Example ```ts Fancy Hotel ``` ##### LodgingBookingData.LodgingDetails.location? > `optional` **location?**: `object` ##### LodgingBookingData.LodgingDetails.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### LodgingBookingData.LodgingDetails.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### LodgingBookingData.LodgingDetails.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### LodgingBookingData.LodgingDetails.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### LodgingBookingData.LodgingDetails.location.coordinates? > `optional` **coordinates?**: `object` ##### LodgingBookingData.LodgingDetails.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### LodgingBookingData.LodgingDetails.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### LodgingBookingData.LodgingDetails.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### LodgingBookingData.LodgingDetails.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### LodgingBookingData.LodgingDetails.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### LodgingBookingData.LodgingDetails.star\_rating? > `optional` **star\_rating?**: `number` \| `null` Format: float ###### Description The star rating of the hotel. Some hotels have half stars. ###### Example ```ts 3.5 ``` ##### LodgingBookingData.ReservationDetails > **LodgingBookingData.ReservationDetails**: `object` ###### Description Information on a reservation such as check-in, checkout, etc. ##### LodgingBookingData.ReservationDetails.check\_in\_time > **check\_in\_time**: `object` ##### LodgingBookingData.ReservationDetails.check\_in\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.ReservationDetails.check\_in\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.ReservationDetails.checkout\_time > **checkout\_time**: `object` ##### LodgingBookingData.ReservationDetails.checkout\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### LodgingBookingData.ReservationDetails.checkout\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### LodgingBookingData.ReservationDetails.confirmation\_code? > `optional` **confirmation\_code?**: `string` \| `null` ###### Description Confirmation code provided by the vendor. ###### Example ```ts 7003XBQ504 ``` ##### LodgingBookingData.ReservationDetails.room? > `optional` **room?**: `object` ##### LodgingBookingData.ReservationDetails.room.bed\_count? > `optional` **bed\_count?**: `number` \| `null` Format: int32 ###### Description The number of beds. ###### Example ```ts 1 ``` ##### LodgingBookingData.ReservationDetails.room.bed\_type? > `optional` **bed\_type?**: `string` \| `null` ###### Description The kind of bed. ###### Example ```ts DOUBLE ``` ##### LodgingBookingData.ReservationDetails.room.description? > `optional` **description?**: `string` \| `null` ###### Description A description of the room. ###### Example ```ts Superior room ``` ##### LodgingBookingData.ReservationDetails.room.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description The name of the room as displayed to the user. ###### Example ```ts Standard room ``` ##### LodgingBookingData.Room > **LodgingBookingData.Room**: `object` ###### Description Information on a room that was booked. ##### LodgingBookingData.Room.bed\_count? > `optional` **bed\_count?**: `number` \| `null` Format: int32 ###### Description The number of beds. ###### Example ```ts 1 ``` ##### LodgingBookingData.Room.bed\_type? > `optional` **bed\_type?**: `string` \| `null` ###### Description The kind of bed. ###### Example ```ts DOUBLE ``` ##### LodgingBookingData.Room.description? > `optional` **description?**: `string` \| `null` ###### Description A description of the room. ###### Example ```ts Superior room ``` ##### LodgingBookingData.Room.display\_name? > `optional` **display\_name?**: `string` \| `null` ###### Description The name of the room as displayed to the user. ###### Example ```ts Standard room ``` #### Page\_Booking\_ > **Page\_Booking\_**: `object` ##### Page\_Booking\_.items > **items**: `object`[] ##### Page\_Booking\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### Page\_Trip\_ > **Page\_Trip\_**: `object` ##### Page\_Trip\_.items > **items**: `object`[] ##### Page\_Trip\_.next\_cursor? > `optional` **next\_cursor?**: `string` \| `null` #### RailBookingData > **RailBookingData**: `object` ##### Description Rail-specific booking information. ##### RailBookingData.journeys > **journeys**: `object`[] ###### Description The journeys that make up this booking. ##### RailBookingData.type > **type**: `"RAIL"` ###### Description discriminator enum property added by openapi-typescript ##### RailBookingData.RailClass > **RailBookingData.RailClass**: `"EXECUTIVE"` \| `"BUSINESS"` \| `"FIRST"` \| `"STANDARD"` \| `"SLEEPER"` \| `"STANDARD_PREMIUM"` \| `"BUSINESS_PREMIUM"` \| `"COACH"` \| `"ROOM"` ###### Description The class of travel for a rail leg. ###### Example ```ts SLEEPER @enum {string} ``` ##### RailBookingData.RailJourney > **RailBookingData.RailJourney**: `object` ###### Description A journey is composed of the legs that take a passenger from an origin to a final destination. E.g. if a traveler is going from Aberdeen to London, but they need to change trains in Edinburgh, the booking will contain 1 journey composed of 2 legs. The first leg is Aberdeen to Edinburgh, and the second is Edinburgh to London. ##### RailBookingData.RailJourney.legs > **legs**: `object`[] ###### Description The legs that make up this journey. ##### RailBookingData.RailLeg > **RailBookingData.RailLeg**: `object` ###### Description A leg is a portion of the journey between two consecutive stops. ##### RailBookingData.RailLeg.arrival\_time > **arrival\_time**: `object` ##### RailBookingData.RailLeg.arrival\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### RailBookingData.RailLeg.arrival\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### RailBookingData.RailLeg.departure\_time > **departure\_time**: `object` ##### RailBookingData.RailLeg.departure\_time.local\_time > **local\_time**: `string` Format: date-time ###### Description The local time in the relevant location in the ISO 8601 format. ##### RailBookingData.RailLeg.departure\_time.timestamp? > `optional` **timestamp?**: `string` \| `null` Format: date-time ###### Description An ISO 8601 timestamp. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### RailBookingData.RailLeg.destination > **destination**: `object` ##### RailBookingData.RailLeg.destination.location? > `optional` **location?**: `object` ##### RailBookingData.RailLeg.destination.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailLeg.destination.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### RailBookingData.RailLeg.destination.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### RailBookingData.RailLeg.destination.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### RailBookingData.RailLeg.destination.location.coordinates? > `optional` **coordinates?**: `object` ##### RailBookingData.RailLeg.destination.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### RailBookingData.RailLeg.destination.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### RailBookingData.RailLeg.destination.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### RailBookingData.RailLeg.destination.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### RailBookingData.RailLeg.destination.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### RailBookingData.RailLeg.destination.name? > `optional` **name?**: `string` \| `null` ###### Description The name of the station. ###### Example ```ts London - King's Cross ``` ##### RailBookingData.RailLeg.destination.type? > `optional` **type?**: `"INDIVIDUAL"` \| `"GROUP"` \| `"METRO"` \| `"BUS_STOP"` \| `"FERRY_TERMINAL"` ##### RailBookingData.RailLeg.duration? > `optional` **duration?**: `string` \| `null` ###### Description PT4h20M ###### Example ```ts PT4h20M ``` ##### RailBookingData.RailLeg.origin > **origin**: `object` ##### RailBookingData.RailLeg.origin.location? > `optional` **location?**: `object` ##### RailBookingData.RailLeg.origin.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailLeg.origin.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### RailBookingData.RailLeg.origin.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### RailBookingData.RailLeg.origin.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### RailBookingData.RailLeg.origin.location.coordinates? > `optional` **coordinates?**: `object` ##### RailBookingData.RailLeg.origin.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### RailBookingData.RailLeg.origin.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### RailBookingData.RailLeg.origin.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### RailBookingData.RailLeg.origin.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### RailBookingData.RailLeg.origin.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### RailBookingData.RailLeg.origin.name? > `optional` **name?**: `string` \| `null` ###### Description The name of the station. ###### Example ```ts London - King's Cross ``` ##### RailBookingData.RailLeg.origin.type? > `optional` **type?**: `"INDIVIDUAL"` \| `"GROUP"` \| `"METRO"` \| `"BUS_STOP"` \| `"FERRY_TERMINAL"` ##### RailBookingData.RailLeg.rail\_class? > `optional` **rail\_class?**: `"EXECUTIVE"` \| `"BUSINESS"` \| `"FIRST"` \| `"STANDARD"` \| `"SLEEPER"` \| `"STANDARD_PREMIUM"` \| `"BUSINESS_PREMIUM"` \| `"COACH"` \| `"ROOM"` ##### RailBookingData.RailLeg.seat? > `optional` **seat?**: `object` ##### RailBookingData.RailLeg.seat.coach\_number? > `optional` **coach\_number?**: `string` \| `null` ###### Description The number of the coach. ###### Example ```ts 12 ``` ##### RailBookingData.RailLeg.seat.seat\_number? > `optional` **seat\_number?**: `string` \| `null` ###### Description The number of the seat. ###### Example ```ts 41 ``` ##### RailBookingData.RailLeg.vehicle? > `optional` **vehicle?**: `object` ##### RailBookingData.RailLeg.vehicle.carrier? > `optional` **carrier?**: `string` \| `null` ###### Description The carrier that operates this leg. E.g. Amtrak, Thameslink. ###### Example ```ts Amtrak ``` ##### RailBookingData.RailLeg.vehicle.timetable\_id? > `optional` **timetable\_id?**: `string` \| `null` ###### Description The timetable ID for the vehicle. The concept is similar to a flight number. ###### Example ```ts L79727 ``` ##### RailBookingData.RailLeg.vehicle.type? > `optional` **type?**: `"METRO"` \| `"TRAIN"` \| `"BUS"` \| `"FERRY"` \| `"WALK"` \| `"TAXI"` \| `"TRAM"` \| `"TUBE"` ##### RailBookingData.RailSeat > **RailBookingData.RailSeat**: `object` ###### Description A seat in a train leg. ##### RailBookingData.RailSeat.coach\_number? > `optional` **coach\_number?**: `string` \| `null` ###### Description The number of the coach. ###### Example ```ts 12 ``` ##### RailBookingData.RailSeat.seat\_number? > `optional` **seat\_number?**: `string` \| `null` ###### Description The number of the seat. ###### Example ```ts 41 ``` ##### RailBookingData.RailStation > **RailBookingData.RailStation**: `object` ###### Description An endpoint in a rail leg. ##### RailBookingData.RailStation.location? > `optional` **location?**: `object` ##### RailBookingData.RailStation.location.address\_line\_1? > `optional` **address\_line\_1?**: `string` \| `null` ###### Description The first line of the address. ###### Example ```ts Av. Vinte de Janeiro, S/N ``` ##### RailBookingData.RailStation.location.address\_line\_2? > `optional` **address\_line\_2?**: `string` \| `null` ###### Description The second line of the address. ###### Example ```ts Ilha do Governador ``` ##### RailBookingData.RailStation.location.administrative\_area? > `optional` **administrative\_area?**: `string` \| `null` ###### Description Depending on the country, this can be a state, a province, or something equivalent to those. May be an abbreviation or the full name. ###### Example ```ts RJ ``` ##### RailBookingData.RailStation.location.city? > `optional` **city?**: `string` \| `null` ###### Description The city where the address is located. ###### Example ```ts Rio de Janeiro ``` ##### RailBookingData.RailStation.location.coordinates? > `optional` **coordinates?**: `object` ##### RailBookingData.RailStation.location.coordinates.latitude > **latitude**: `number` Format: double ###### Example ```ts -22.8145373 ``` ##### RailBookingData.RailStation.location.coordinates.longitude > **longitude**: `number` Format: double ###### Example ```ts -43.2465548 ``` ##### RailBookingData.RailStation.location.country? > `optional` **country?**: `string` \| `null` ###### Description The country where the address is located. May be an alpha-2 code, an alpha-3 code, or the full name of the country. ###### Example ```ts Brazil ``` ##### RailBookingData.RailStation.location.postal\_code? > `optional` **postal\_code?**: `string` \| `null` ###### Description The postal code of the given address. ###### Example ```ts 21941-900 ``` ##### RailBookingData.RailStation.location.timezone? > `optional` **timezone?**: `string` \| `null` ###### Description The timezone in the given address. ###### Example ```ts America/Sao_Paulo ``` ##### RailBookingData.RailStation.name? > `optional` **name?**: `string` \| `null` ###### Description The name of the station. ###### Example ```ts London - King's Cross ``` ##### RailBookingData.RailStation.type? > `optional` **type?**: `"INDIVIDUAL"` \| `"GROUP"` \| `"METRO"` \| `"BUS_STOP"` \| `"FERRY_TERMINAL"` ##### RailBookingData.RailStationType > **RailBookingData.RailStationType**: `"INDIVIDUAL"` \| `"GROUP"` \| `"METRO"` \| `"BUS_STOP"` \| `"FERRY_TERMINAL"` ###### Description The kind of station. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. * `INDIVIDUAL` - A regular train station. * `GROUP` - Stations grouped together, usually in a major European city. E.g. "London, Any". * `METRO` - A metro/subway station. * `BUS_STOP` - A bus stop. * `FERRY_TERMINAL` - A ferry terminal. ###### Example ```ts INDIVIDUAL @enum {string} ``` ##### RailBookingData.Vehicle > **RailBookingData.Vehicle**: `object` ###### Description A vehicle used in a train leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. ##### RailBookingData.Vehicle.carrier? > `optional` **carrier?**: `string` \| `null` ###### Description The carrier that operates this leg. E.g. Amtrak, Thameslink. ###### Example ```ts Amtrak ``` ##### RailBookingData.Vehicle.timetable\_id? > `optional` **timetable\_id?**: `string` \| `null` ###### Description The timetable ID for the vehicle. The concept is similar to a flight number. ###### Example ```ts L79727 ``` ##### RailBookingData.Vehicle.type? > `optional` **type?**: `"METRO"` \| `"TRAIN"` \| `"BUS"` \| `"FERRY"` \| `"WALK"` \| `"TAXI"` \| `"TRAM"` \| `"TUBE"` ##### RailBookingData.VehicleType > **RailBookingData.VehicleType**: `"METRO"` \| `"TRAIN"` \| `"BUS"` \| `"FERRY"` \| `"WALK"` \| `"TAXI"` \| `"TRAM"` \| `"TUBE"` ###### Description The kind of vehicle to be used in a leg. Some rail itineraries include taking a bus or walking between stations, and these are represented as legs in the journey. * `TRAIN` - A regular train. * `BUS` - A bus. * `FERRY` - A ferry. * `WALK`- Walking between stations. * `TAXI` - A taxi between stations. * `TRAM` - Tram/light rail. * `METRO` - Metro/subway. * `TUBE` - London underground. ###### Example ```ts TRAIN @enum {string} ``` #### Traveler > **Traveler**: `object` ##### Description Information on the person who will be traveling. ##### Traveler.guest\_email? > `optional` **guest\_email?**: `string` \| `null` ###### Description If the traveler is a guest, this is their email. ###### Example ```ts guest@gmail.com ``` ##### Traveler.name? > `optional` **name?**: `object` ##### Traveler.name.first\_name? > `optional` **first\_name?**: `string` ###### Description The traveler's first name. ###### Example ```ts John ``` ##### Traveler.name.last\_name? > `optional` **last\_name?**: `string` ###### Description The traveler's last name. ###### Example ```ts Doe ``` ##### Traveler.name.middle\_name? > `optional` **middle\_name?**: `string` \| `null` ###### Description The traveler's middle name. ###### Example ```ts Paul ``` ##### Traveler.name.suffix? > `optional` **suffix?**: `string` \| `null` ###### Description The suffix in the traveler's name. ###### Example ```ts Jr. ``` ##### Traveler.type > **type**: `"EMPLOYEE"` \| `"GUEST"` ##### Traveler.user\_id? > `optional` **user\_id?**: `string` \| `null` ###### Description If the traveler is an employee, this is their user ID. ###### Example ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Traveler.Name > **Traveler.Name**: `object` ###### Description The name of the traveler. ##### Traveler.Name.first\_name? > `optional` **first\_name?**: `string` ###### Description The traveler's first name. ###### Example ```ts John ``` ##### Traveler.Name.last\_name? > `optional` **last\_name?**: `string` ###### Description The traveler's last name. ###### Example ```ts Doe ``` ##### Traveler.Name.middle\_name? > `optional` **middle\_name?**: `string` \| `null` ###### Description The traveler's middle name. ###### Example ```ts Paul ``` ##### Traveler.Name.suffix? > `optional` **suffix?**: `string` \| `null` ###### Description The suffix in the traveler's name. ###### Example ```ts Jr. ``` ##### Traveler.Type > **Traveler.Type**: `"EMPLOYEE"` \| `"GUEST"` ###### Description Whether the trip is for an employee or a guest. ###### Example ```ts EMPLOYEE @enum {string} ``` #### Trip > **Trip**: `object` ##### Description A trip representation. ##### Trip.billable\_at? > `optional` **billable\_at?**: `string` \| `null` Format: date-time ###### Description The time when the trip became billable. If absent, the trip is currently not billable. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Trip.booker\_user\_id > **booker\_user\_id**: `string` ###### Description The ID of the user who booked the trip. If the trip was created on copilot mode, this will be the ID of the user on behalf of whom the trip was booked. ###### Example ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Trip.created\_at > **created\_at**: `string` Format: date-time ###### Description The time when the trip was created. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Trip.ends\_at? > `optional` **ends\_at?**: `string` \| `null` Format: date-time ###### Description The time when the last booking in the trip ends. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Trip.id > **id**: `string` ###### Description The ID of the trip. ###### Example ```ts trip_cl9rh1n8g001e0j84w6fb4fd1 ``` ##### Trip.name? > `optional` **name?**: `string` \| `null` ###### Description The name of the trip as seen in the dashboard. ###### Example ```ts Trip to Rio de Janeiro ``` ##### Trip.starts\_at? > `optional` **starts\_at?**: `string` \| `null` Format: date-time ###### Description The time when the first booking in the trip starts. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Trip.status > **status**: `"DELETED"` \| `"INVITED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"REFUNDED"` \| `"DRAFT"` \| `"IN_PROGRESS"` \| `"APPROVAL_DENIED"` \| `"PENDING"` \| `"HOLD"` \| `"COMPLETED"` \| `"VOIDED"` \| `"UNCONFIRMED"` \| `"AIRLINE_CONTROL"` \| `"PAYMENT_DECLINED"` \| `"SCHEDULE_CHANGE"` \| `"APPROVAL_REQUESTED"` \| `"CANCELLATION_IN_PROGRESS"` \| `"UPCOMING"` ##### Trip.traveler? > `optional` **traveler?**: `object` ##### Trip.traveler.guest\_email? > `optional` **guest\_email?**: `string` \| `null` ###### Description If the traveler is a guest, this is their email. ###### Example ```ts guest@gmail.com ``` ##### Trip.traveler.name? > `optional` **name?**: `object` ##### Trip.traveler.name.first\_name? > `optional` **first\_name?**: `string` ###### Description The traveler's first name. ###### Example ```ts John ``` ##### Trip.traveler.name.last\_name? > `optional` **last\_name?**: `string` ###### Description The traveler's last name. ###### Example ```ts Doe ``` ##### Trip.traveler.name.middle\_name? > `optional` **middle\_name?**: `string` \| `null` ###### Description The traveler's middle name. ###### Example ```ts Paul ``` ##### Trip.traveler.name.suffix? > `optional` **suffix?**: `string` \| `null` ###### Description The suffix in the traveler's name. ###### Example ```ts Jr. ``` ##### Trip.traveler.type > **type**: `"EMPLOYEE"` \| `"GUEST"` ##### Trip.traveler.user\_id? > `optional` **user\_id?**: `string` \| `null` ###### Description If the traveler is an employee, this is their user ID. ###### Example ```ts cuuser_cky0xs54b004h01pidi0pcuz1 ``` ##### Trip.updated\_at > **updated\_at**: `string` Format: date-time ###### Description The time when the latest trip update happened. ###### Example ```ts 2017-12-27T15:42:30Z ``` ##### Trip.version > **version**: `number` Format: int32 ###### Description The current version of the trip. ###### Example ```ts 2 ``` ##### Trip.Status > **Trip.Status**: `"DELETED"` \| `"INVITED"` \| `"PROCESSING"` \| `"CANCELED"` \| `"REFUNDED"` \| `"DRAFT"` \| `"IN_PROGRESS"` \| `"APPROVAL_DENIED"` \| `"PENDING"` \| `"HOLD"` \| `"COMPLETED"` \| `"VOIDED"` \| `"UNCONFIRMED"` \| `"AIRLINE_CONTROL"` \| `"PAYMENT_DECLINED"` \| `"SCHEDULE_CHANGE"` \| `"APPROVAL_REQUESTED"` \| `"CANCELLATION_IN_PROGRESS"` \| `"UPCOMING"` ###### Description The current status of a trip. ###### Example ```ts UPCOMING @enum {string} ```