Scope3FlightSegment

import type { Scope3FlightSegment } from "https://googleapis.deno.dev/v1/travelimpactmodel:v1.ts";

Flight parameters with which the Scope 3 emissions are fetched.

interface Scope3FlightSegment {

cabinClass?:

| "CABIN_CLASS_UNSPECIFIED"

| "ECONOMY"

| "PREMIUM_ECONOMY"

| "BUSINESS"

| "FIRST";

carrierCode?: string;

departureDate?: Date;

destination?: string;

distanceKm?: bigint;

flightNumber?: number;

origin?: string;

}

§Properties

cabinClass?: "CABIN_CLASS_UNSPECIFIED" | "ECONOMY" | "PREMIUM_ECONOMY" | "BUSINESS" | "FIRST"

[src]

Required. The cabin class of the flight.

carrierCode?: string

[src]

Optional. IATA carrier code, e.g. KE. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).

departureDate?: Date

[src]

Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions.

destination?: string

[src]

Optional. IATA airport code for flight destination, e.g. ICN. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.

distanceKm?: bigint

[src]

Optional. Distance in kilometers, e.g. 2423. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km.

flightNumber?: number

[src]

Optional. Flight number, e.g. 71. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided.

origin?: string

[src]

Optional. IATA airport code for flight origin, e.g. YVR. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.