google-apis-travelimpactmodel_v1 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ccf3adb344fc1a1c6f498a25e772165629195bed89b56210434efc53b9dd9e5
-  data.tar.gz: 4797489a766e917e19712d7ad68ee7ce3dc9d886aa22997027f939e2fd38ed33
+  metadata.gz: 82f49f15572a2deec549d904bd480650bc3166f2d546089d2e1fcd7da47a7c1f
+  data.tar.gz: 85e3761e52709d5e06ba59c643580c53663f21e14c0fc9b34908bb7086e07a7f
 SHA512:
-  metadata.gz: e90bc66d93d93fbc0e69477301c6430d4fc2170c78136765f39b2687153143fc72dbc4fa28fdeff8a2cf0dc559f4280d8daf318a7952a351bed61050e208ed0c
-  data.tar.gz: 45890ab3bb8a3b5ac028a926c5b8f583fb0a64a278b72d6ca25808ba955186a57ec8795c03c4ac4468b1557099a8d1bee9cf556eb146bbc4ac9f7d1aed33a85a
+  metadata.gz: fbfba6ccdfe5099732c62cceff5f17ee94559046e45b1c01c300f65b7cab53ee741e8efddf60a94d01e19081a7903f2d650965bb45771b40a733f8eb7d286e1f
+  data.tar.gz: 4a183e4533d5cbe808c4181eaa84b10df43e9d92eaadee39766712e6bd89e6d1aab8566f07879f9ccf74e7137896d0561759ab3458ab7943a8986d0ff0128877

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-travelimpactmodel_v1
 
+### v0.10.0 (2025-10-12)
+
+* Regenerated from discovery document revision 20251008
+
 ### v0.9.0 (2025-06-29)
 
 * Regenerated from discovery document revision 20250624

data/lib/google/apis/travelimpactmodel_v1/classes.rb

@@ -67,6 +67,58 @@ module Google
         end
       end
       
+      # A list of flight segments to request the Scope 3 emissions for.
+      class ComputeScope3FlightEmissionsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. Flights to return emission estimates for.
+        # Corresponds to the JSON property `flights`
+        # @return [Array<Google::Apis::TravelimpactmodelV1::Scope3FlightSegment>]
+        attr_accessor :flights
+      
+        # Travel Impact Model version. For more information about the model versioning
+        # see [GitHub](https://github.com/google/travel-impact-model/#versioning).
+        # Corresponds to the JSON property `modelVersion`
+        # @return [Google::Apis::TravelimpactmodelV1::ModelVersion]
+        attr_accessor :model_version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @flights = args[:flights] if args.key?(:flights)
+          @model_version = args[:model_version] if args.key?(:model_version)
+        end
+      end
+      
+      # A list of flights with Scope 3 emission estimates.
+      class ComputeScope3FlightEmissionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of flight segments with emission estimates.
+        # Corresponds to the JSON property `flightEmissions`
+        # @return [Array<Google::Apis::TravelimpactmodelV1::Scope3FlightEmissions>]
+        attr_accessor :flight_emissions
+      
+        # Travel Impact Model version. For more information about the model versioning
+        # see [GitHub](https://github.com/google/travel-impact-model/#versioning).
+        # Corresponds to the JSON property `modelVersion`
+        # @return [Google::Apis::TravelimpactmodelV1::ModelVersion]
+        attr_accessor :model_version
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @flight_emissions = args[:flight_emissions] if args.key?(:flight_emissions)
+          @model_version = args[:model_version] if args.key?(:model_version)
+        end
+      end
+      
       # A list of pair of airports (markets) to request the typical emissions for.
       class ComputeTypicalFlightEmissionsRequest
         include Google::Apis::Core::Hashable
@@ -420,6 +472,137 @@ module Google
         end
       end
       
+      # Scope 3 flight with emission estimates.
+      class Scope3FlightEmissions
+        include Google::Apis::Core::Hashable
+      
+        # Flight parameters with which the Scope 3 emissions are fetched.
+        # Corresponds to the JSON property `flight`
+        # @return [Google::Apis::TravelimpactmodelV1::Scope3FlightSegment]
+        attr_accessor :flight
+      
+        # Optional. The source of the emissions data.
+        # Corresponds to the JSON property `source`
+        # @return [String]
+        attr_accessor :source
+      
+        # Optional. Tank-to-wake flight emissions per passenger based on the requested
+        # info.
+        # Corresponds to the JSON property `ttwEmissionsGramsPerPax`
+        # @return [Fixnum]
+        attr_accessor :ttw_emissions_grams_per_pax
+      
+        # Optional. Well-to-tank flight emissions per passenger based on the requested
+        # info.
+        # Corresponds to the JSON property `wttEmissionsGramsPerPax`
+        # @return [Fixnum]
+        attr_accessor :wtt_emissions_grams_per_pax
+      
+        # Optional. Total flight emissions (sum of well-to-tank and tank-to-wake) per
+        # passenger based on the requested info. This is the total emissions and unless
+        # you have specific reasons for using TTW or WTT emissions, you should use this
+        # number.
+        # Corresponds to the JSON property `wtwEmissionsGramsPerPax`
+        # @return [Fixnum]
+        attr_accessor :wtw_emissions_grams_per_pax
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @flight = args[:flight] if args.key?(:flight)
+          @source = args[:source] if args.key?(:source)
+          @ttw_emissions_grams_per_pax = args[:ttw_emissions_grams_per_pax] if args.key?(:ttw_emissions_grams_per_pax)
+          @wtt_emissions_grams_per_pax = args[:wtt_emissions_grams_per_pax] if args.key?(:wtt_emissions_grams_per_pax)
+          @wtw_emissions_grams_per_pax = args[:wtw_emissions_grams_per_pax] if args.key?(:wtw_emissions_grams_per_pax)
+        end
+      end
+      
+      # Flight parameters with which the Scope 3 emissions are fetched.
+      class Scope3FlightSegment
+        include Google::Apis::Core::Hashable
+      
+        # Required. The cabin class of the flight.
+        # Corresponds to the JSON property `cabinClass`
+        # @return [String]
+        attr_accessor :cabin_class
+      
+        # 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).
+        # Corresponds to the JSON property `carrierCode`
+        # @return [String]
+        attr_accessor :carrier_code
+      
+        # Represents a whole or partial calendar date, such as a birthday. The time of
+        # day and time zone are either specified elsewhere or are insignificant. The
+        # date is relative to the Gregorian Calendar. This can represent one of the
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+        # Corresponds to the JSON property `departureDate`
+        # @return [Google::Apis::TravelimpactmodelV1::Date]
+        attr_accessor :departure_date
+      
+        # 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.
+        # Corresponds to the JSON property `destination`
+        # @return [String]
+        attr_accessor :destination
+      
+        # 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.
+        # Corresponds to the JSON property `distanceKm`
+        # @return [Fixnum]
+        attr_accessor :distance_km
+      
+        # 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.
+        # Corresponds to the JSON property `flightNumber`
+        # @return [Fixnum]
+        attr_accessor :flight_number
+      
+        # 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.
+        # Corresponds to the JSON property `origin`
+        # @return [String]
+        attr_accessor :origin
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @cabin_class = args[:cabin_class] if args.key?(:cabin_class)
+          @carrier_code = args[:carrier_code] if args.key?(:carrier_code)
+          @departure_date = args[:departure_date] if args.key?(:departure_date)
+          @destination = args[:destination] if args.key?(:destination)
+          @distance_km = args[:distance_km] if args.key?(:distance_km)
+          @flight_number = args[:flight_number] if args.key?(:flight_number)
+          @origin = args[:origin] if args.key?(:origin)
+        end
+      end
+      
       # Typical flight emission estimates for a certain market
       class TypicalFlightEmissions
         include Google::Apis::Core::Hashable

data/lib/google/apis/travelimpactmodel_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module TravelimpactmodelV1
       # Version of the google-apis-travelimpactmodel_v1 gem
-      GEM_VERSION = "0.9.0"
+      GEM_VERSION = "0.10.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250624"
+      REVISION = "20251008"
     end
   end
 end

data/lib/google/apis/travelimpactmodel_v1/representations.rb

@@ -34,6 +34,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ComputeScope3FlightEmissionsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ComputeScope3FlightEmissionsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ComputeTypicalFlightEmissionsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -88,6 +100,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Scope3FlightEmissions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class Scope3FlightSegment
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class TypicalFlightEmissions
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -112,6 +136,26 @@ module Google
         end
       end
       
+      class ComputeScope3FlightEmissionsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :flights, as: 'flights', class: Google::Apis::TravelimpactmodelV1::Scope3FlightSegment, decorator: Google::Apis::TravelimpactmodelV1::Scope3FlightSegment::Representation
+      
+          property :model_version, as: 'modelVersion', class: Google::Apis::TravelimpactmodelV1::ModelVersion, decorator: Google::Apis::TravelimpactmodelV1::ModelVersion::Representation
+      
+        end
+      end
+      
+      class ComputeScope3FlightEmissionsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :flight_emissions, as: 'flightEmissions', class: Google::Apis::TravelimpactmodelV1::Scope3FlightEmissions, decorator: Google::Apis::TravelimpactmodelV1::Scope3FlightEmissions::Representation
+      
+          property :model_version, as: 'modelVersion', class: Google::Apis::TravelimpactmodelV1::ModelVersion, decorator: Google::Apis::TravelimpactmodelV1::ModelVersion::Representation
+      
+        end
+      end
+      
       class ComputeTypicalFlightEmissionsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -205,6 +249,32 @@ module Google
         end
       end
       
+      class Scope3FlightEmissions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :flight, as: 'flight', class: Google::Apis::TravelimpactmodelV1::Scope3FlightSegment, decorator: Google::Apis::TravelimpactmodelV1::Scope3FlightSegment::Representation
+      
+          property :source, as: 'source'
+          property :ttw_emissions_grams_per_pax, :numeric_string => true, as: 'ttwEmissionsGramsPerPax'
+          property :wtt_emissions_grams_per_pax, :numeric_string => true, as: 'wttEmissionsGramsPerPax'
+          property :wtw_emissions_grams_per_pax, :numeric_string => true, as: 'wtwEmissionsGramsPerPax'
+        end
+      end
+      
+      class Scope3FlightSegment
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :cabin_class, as: 'cabinClass'
+          property :carrier_code, as: 'carrierCode'
+          property :departure_date, as: 'departureDate', class: Google::Apis::TravelimpactmodelV1::Date, decorator: Google::Apis::TravelimpactmodelV1::Date::Representation
+      
+          property :destination, as: 'destination'
+          property :distance_km, :numeric_string => true, as: 'distanceKm'
+          property :flight_number, as: 'flightNumber'
+          property :origin, as: 'origin'
+        end
+      end
+      
       class TypicalFlightEmissions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/travelimpactmodel_v1/service.rb

@@ -91,6 +91,71 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Stateless method to retrieve GHG emissions estimates for a set of flight
+        # segments for Scope 3 reporting. The response will contain all entries that
+        # match the input Scope3FlightSegment flight segments, in the same order
+        # provided. The estimates will be computed using the following cascading logic (
+        # using the first one that is available): 1. TIM-based emissions given origin,
+        # destination, carrier, flightNumber, departureDate, and cabinClass. 2. Typical
+        # flight emissions given origin, destination, year in departureDate, and
+        # cabinClass. 3. Distance-based emissions calculated using distanceKm, year in
+        # departureDate, and cabinClass. If there is a future flight requested in this
+        # calendar year, we do not support Tier 1 emissions and will fallback to Tier 2
+        # or 3 emissions. If the requested future flight is in not in this calendar year,
+        # we will return an empty response. We recommend that for future flights,
+        # computeFlightEmissions API is used instead. If there are no estimates
+        # available for a certain flight with any of the three methods, the response
+        # will return a Scope3FlightEmissions object with empty emission fields. The
+        # request will still be considered successful. Generally, missing emissions
+        # estimates occur when the flight is unknown to the server (e.g. no specific
+        # flight exists, or typical flight emissions are not available for the requested
+        # pair). The request will fail with an `INVALID_ARGUMENT` error if: * The
+        # request contains more than 1,000 flight legs. * The input flight leg is
+        # missing one or more identifiers. For example, missing origin/destination
+        # without a valid distance for TIM_EMISSIONS or TYPICAL_FLIGHT_EMISSIONS type
+        # matching, or missing distance for a DISTANCE_BASED_EMISSIONS type matching (if
+        # you want to fallback to distance-based emissions or want a distance-based
+        # emissions estimate, you need to specify a distance). * The flight date is
+        # before 2019 (Scope 3 data is only available for 2019 and after). * The flight
+        # distance is 0 or lower. * Missing cabin class. Because the request is
+        # processed with fallback logic, it is possible that misconfigured requests
+        # return valid emissions estimates using fallback methods. For example, if a
+        # request has the wrong flight number but specifies the origin and destination,
+        # the request will still succeed, but the returned emissions will be based
+        # solely on the typical flight emissions. Similarly, if a request is missing the
+        # origin for a typical flight emissions request, but specifies a valid distance,
+        # the request could succeed based solely on the distance-based emissions.
+        # Consequently, one should check the source of the returned emissions (source)
+        # to confirm the results are as expected.
+        # @param [Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsRequest] compute_scope3_flight_emissions_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def compute_scope3_flight_emissions(compute_scope3_flight_emissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/flights:computeScope3FlightEmissions', options)
+          command.request_representation = Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsRequest::Representation
+          command.request_object = compute_scope3_flight_emissions_request_object
+          command.response_representation = Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsResponse::Representation
+          command.response_class = Google::Apis::TravelimpactmodelV1::ComputeScope3FlightEmissionsResponse
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Retrieves typical flight emissions estimates between two airports, also known
         # as a market. If there are no estimates available for a certain market, the
         # response will return the market object with empty emission fields. The request

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-travelimpactmodel_v1
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-travelimpactmodel_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-travelimpactmodel_v1/v0.9.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-travelimpactmodel_v1/v0.10.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-travelimpactmodel_v1
 rdoc_options: []
 require_paths: