google-apis-travelimpactmodel_v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 90463f24e2570b99551f04d547d7b8cec2e6d0d3a3fb833c68caca2b28aae455
4
+ data.tar.gz: d8c3f9312e772994c9afe62c4c920a3bfa8cd53cbb8e1eaf9768db3dbd3c169e
5
+ SHA512:
6
+ metadata.gz: '0587dc0de18270722068f8708480fdcda520f05ab37e713d9ac8f7d8896f137d6fd0ebb2b6aaf2bc000c5e9d5d6cf3e7ee423ebd2dfe103749db6f4b9737bc8e'
7
+ data.tar.gz: f409bb07b2a1f58af1cc04caf70e3fc5a34b6ad48c668c71d92208dbd705dac3d7f8ff4000fddd10906c1368c3eee2d38ec241529f6efc300b1bcf05a6ff66ac
data/.yardopts ADDED
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-travelimpactmodel_v1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/travelimpactmodel_v1/*.rb
9
+ lib/google/apis/travelimpactmodel_v1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-travelimpactmodel_v1
2
+
3
+ ### v0.1.0 (2022-11-01)
4
+
5
+ * Regenerated from discovery document revision 20221027
6
+ * Regenerated using generator version 0.11.0
7
+
data/LICENSE.md ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/OVERVIEW.md ADDED
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1 of the Travel Impact Model API
2
+
3
+ This is a simple client library for version V1 of the Travel Impact Model API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/travelimpactmodel.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-travelimpactmodel_v1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-travelimpactmodel_v1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/travelimpactmodel_v1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::TravelimpactmodelV1::TravelImpactModelService.new
52
+
53
+ # Authenticate calls
54
+ client.authorization = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Travelimpactmodel service in particular.)
67
+
68
+ For reference information on specific calls in the Travel Impact Model API, see the {Google::Apis::TravelimpactmodelV1::TravelImpactModelService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-travelimpactmodel_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/travel/impact-model) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,279 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module TravelimpactmodelV1
24
+
25
+ # Input definition for the ComputeFlightEmissions request.
26
+ class ComputeFlightEmissionsRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # Required. Direct flights to return emission estimates for.
30
+ # Corresponds to the JSON property `flights`
31
+ # @return [Array<Google::Apis::TravelimpactmodelV1::Flight>]
32
+ attr_accessor :flights
33
+
34
+ def initialize(**args)
35
+ update!(**args)
36
+ end
37
+
38
+ # Update properties of this object
39
+ def update!(**args)
40
+ @flights = args[:flights] if args.key?(:flights)
41
+ end
42
+ end
43
+
44
+ # Output definition for the ComputeFlightEmissions response.
45
+ class ComputeFlightEmissionsResponse
46
+ include Google::Apis::Core::Hashable
47
+
48
+ # List of flight legs with emission estimates.
49
+ # Corresponds to the JSON property `flightEmissions`
50
+ # @return [Array<Google::Apis::TravelimpactmodelV1::FlightWithEmissions>]
51
+ attr_accessor :flight_emissions
52
+
53
+ # Travel Impact Model version. For more information about the model versioning
54
+ # see https://github.com/google/travel-impact-model/#versioning.
55
+ # Corresponds to the JSON property `modelVersion`
56
+ # @return [Google::Apis::TravelimpactmodelV1::ModelVersion]
57
+ attr_accessor :model_version
58
+
59
+ def initialize(**args)
60
+ update!(**args)
61
+ end
62
+
63
+ # Update properties of this object
64
+ def update!(**args)
65
+ @flight_emissions = args[:flight_emissions] if args.key?(:flight_emissions)
66
+ @model_version = args[:model_version] if args.key?(:model_version)
67
+ end
68
+ end
69
+
70
+ # Represents a whole or partial calendar date, such as a birthday. The time of
71
+ # day and time zone are either specified elsewhere or are insignificant. The
72
+ # date is relative to the Gregorian Calendar. This can represent one of the
73
+ # following: * A full date, with non-zero year, month, and day values. * A month
74
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
75
+ # with a zero month and a zero day. * A year and month, with a zero day (for
76
+ # example, a credit card expiration date). Related types: * google.type.
77
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
78
+ class Date
79
+ include Google::Apis::Core::Hashable
80
+
81
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
82
+ # specify a year by itself or a year and month where the day isn't significant.
83
+ # Corresponds to the JSON property `day`
84
+ # @return [Fixnum]
85
+ attr_accessor :day
86
+
87
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
88
+ # and day.
89
+ # Corresponds to the JSON property `month`
90
+ # @return [Fixnum]
91
+ attr_accessor :month
92
+
93
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
94
+ # year.
95
+ # Corresponds to the JSON property `year`
96
+ # @return [Fixnum]
97
+ attr_accessor :year
98
+
99
+ def initialize(**args)
100
+ update!(**args)
101
+ end
102
+
103
+ # Update properties of this object
104
+ def update!(**args)
105
+ @day = args[:day] if args.key?(:day)
106
+ @month = args[:month] if args.key?(:month)
107
+ @year = args[:year] if args.key?(:year)
108
+ end
109
+ end
110
+
111
+ # Grouped emissions per seating class results.
112
+ class EmissionsGramsPerPax
113
+ include Google::Apis::Core::Hashable
114
+
115
+ # Emissions for one passenger in business class in grams. This field is always
116
+ # computed and populated, regardless of whether the aircraft has business class
117
+ # seats or not.
118
+ # Corresponds to the JSON property `business`
119
+ # @return [Fixnum]
120
+ attr_accessor :business
121
+
122
+ # Emissions for one passenger in economy class in grams. This field is always
123
+ # computed and populated, regardless of whether the aircraft has economy class
124
+ # seats or not.
125
+ # Corresponds to the JSON property `economy`
126
+ # @return [Fixnum]
127
+ attr_accessor :economy
128
+
129
+ # Emissions for one passenger in first class in grams. This field is always
130
+ # computed and populated, regardless of whether the aircraft has first class
131
+ # seats or not.
132
+ # Corresponds to the JSON property `first`
133
+ # @return [Fixnum]
134
+ attr_accessor :first
135
+
136
+ # Emissions for one passenger in premium economy class in grams. This field is
137
+ # always computed and populated, regardless of whether the aircraft has premium
138
+ # economy class seats or not.
139
+ # Corresponds to the JSON property `premiumEconomy`
140
+ # @return [Fixnum]
141
+ attr_accessor :premium_economy
142
+
143
+ def initialize(**args)
144
+ update!(**args)
145
+ end
146
+
147
+ # Update properties of this object
148
+ def update!(**args)
149
+ @business = args[:business] if args.key?(:business)
150
+ @economy = args[:economy] if args.key?(:economy)
151
+ @first = args[:first] if args.key?(:first)
152
+ @premium_economy = args[:premium_economy] if args.key?(:premium_economy)
153
+ end
154
+ end
155
+
156
+ # All details related to a single request item for a direct flight emission
157
+ # estimates.
158
+ class Flight
159
+ include Google::Apis::Core::Hashable
160
+
161
+ # Represents a whole or partial calendar date, such as a birthday. The time of
162
+ # day and time zone are either specified elsewhere or are insignificant. The
163
+ # date is relative to the Gregorian Calendar. This can represent one of the
164
+ # following: * A full date, with non-zero year, month, and day values. * A month
165
+ # and day, with a zero year (for example, an anniversary). * A year on its own,
166
+ # with a zero month and a zero day. * A year and month, with a zero day (for
167
+ # example, a credit card expiration date). Related types: * google.type.
168
+ # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
169
+ # Corresponds to the JSON property `departureDate`
170
+ # @return [Google::Apis::TravelimpactmodelV1::Date]
171
+ attr_accessor :departure_date
172
+
173
+ # Required. IATA airport code for flight destination, e.g. "JFK".
174
+ # Corresponds to the JSON property `destination`
175
+ # @return [String]
176
+ attr_accessor :destination
177
+
178
+ # Required. Flight number, e.g. 324.
179
+ # Corresponds to the JSON property `flightNumber`
180
+ # @return [Fixnum]
181
+ attr_accessor :flight_number
182
+
183
+ # Required. IATA carrier code, e.g. "AA".
184
+ # Corresponds to the JSON property `operatingCarrierCode`
185
+ # @return [String]
186
+ attr_accessor :operating_carrier_code
187
+
188
+ # Required. IATA airport code for flight origin, e.g. "LHR".
189
+ # Corresponds to the JSON property `origin`
190
+ # @return [String]
191
+ attr_accessor :origin
192
+
193
+ def initialize(**args)
194
+ update!(**args)
195
+ end
196
+
197
+ # Update properties of this object
198
+ def update!(**args)
199
+ @departure_date = args[:departure_date] if args.key?(:departure_date)
200
+ @destination = args[:destination] if args.key?(:destination)
201
+ @flight_number = args[:flight_number] if args.key?(:flight_number)
202
+ @operating_carrier_code = args[:operating_carrier_code] if args.key?(:operating_carrier_code)
203
+ @origin = args[:origin] if args.key?(:origin)
204
+ end
205
+ end
206
+
207
+ # Direct flight with emission estimates.
208
+ class FlightWithEmissions
209
+ include Google::Apis::Core::Hashable
210
+
211
+ # Grouped emissions per seating class results.
212
+ # Corresponds to the JSON property `emissionsGramsPerPax`
213
+ # @return [Google::Apis::TravelimpactmodelV1::EmissionsGramsPerPax]
214
+ attr_accessor :emissions_grams_per_pax
215
+
216
+ # All details related to a single request item for a direct flight emission
217
+ # estimates.
218
+ # Corresponds to the JSON property `flight`
219
+ # @return [Google::Apis::TravelimpactmodelV1::Flight]
220
+ attr_accessor :flight
221
+
222
+ def initialize(**args)
223
+ update!(**args)
224
+ end
225
+
226
+ # Update properties of this object
227
+ def update!(**args)
228
+ @emissions_grams_per_pax = args[:emissions_grams_per_pax] if args.key?(:emissions_grams_per_pax)
229
+ @flight = args[:flight] if args.key?(:flight)
230
+ end
231
+ end
232
+
233
+ # Travel Impact Model version. For more information about the model versioning
234
+ # see https://github.com/google/travel-impact-model/#versioning.
235
+ class ModelVersion
236
+ include Google::Apis::Core::Hashable
237
+
238
+ # Dated versions: Model datasets are recreated with refreshed input data but no
239
+ # change to the algorithms regularly.
240
+ # Corresponds to the JSON property `dated`
241
+ # @return [String]
242
+ attr_accessor :dated
243
+
244
+ # Major versions: Major changes to methodology (e.g. adding new data sources to
245
+ # the model that lead to major output changes). Such changes will be infrequent
246
+ # and announced well in advance. Might involve API version changes, which will
247
+ # respect guidelines in https://cloud.google.com/endpoints/docs/openapi/
248
+ # versioning-an-api#backwards-incompatible
249
+ # Corresponds to the JSON property `major`
250
+ # @return [Fixnum]
251
+ attr_accessor :major
252
+
253
+ # Minor versions: Changes to the model that, while being consistent across
254
+ # schema versions, change the model parameters or implementation.
255
+ # Corresponds to the JSON property `minor`
256
+ # @return [Fixnum]
257
+ attr_accessor :minor
258
+
259
+ # Patch versions: Implementation changes meant to address bugs or inaccuracies
260
+ # in the model implementation.
261
+ # Corresponds to the JSON property `patch`
262
+ # @return [Fixnum]
263
+ attr_accessor :patch
264
+
265
+ def initialize(**args)
266
+ update!(**args)
267
+ end
268
+
269
+ # Update properties of this object
270
+ def update!(**args)
271
+ @dated = args[:dated] if args.key?(:dated)
272
+ @major = args[:major] if args.key?(:major)
273
+ @minor = args[:minor] if args.key?(:minor)
274
+ @patch = args[:patch] if args.key?(:patch)
275
+ end
276
+ end
277
+ end
278
+ end
279
+ end
@@ -0,0 +1,28 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module Google
16
+ module Apis
17
+ module TravelimpactmodelV1
18
+ # Version of the google-apis-travelimpactmodel_v1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.11.0"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20221027"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,137 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module TravelimpactmodelV1
24
+
25
+ class ComputeFlightEmissionsRequest
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class ComputeFlightEmissionsResponse
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class Date
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class EmissionsGramsPerPax
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class Flight
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class FlightWithEmissions
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class ModelVersion
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class ComputeFlightEmissionsRequest
68
+ # @private
69
+ class Representation < Google::Apis::Core::JsonRepresentation
70
+ collection :flights, as: 'flights', class: Google::Apis::TravelimpactmodelV1::Flight, decorator: Google::Apis::TravelimpactmodelV1::Flight::Representation
71
+
72
+ end
73
+ end
74
+
75
+ class ComputeFlightEmissionsResponse
76
+ # @private
77
+ class Representation < Google::Apis::Core::JsonRepresentation
78
+ collection :flight_emissions, as: 'flightEmissions', class: Google::Apis::TravelimpactmodelV1::FlightWithEmissions, decorator: Google::Apis::TravelimpactmodelV1::FlightWithEmissions::Representation
79
+
80
+ property :model_version, as: 'modelVersion', class: Google::Apis::TravelimpactmodelV1::ModelVersion, decorator: Google::Apis::TravelimpactmodelV1::ModelVersion::Representation
81
+
82
+ end
83
+ end
84
+
85
+ class Date
86
+ # @private
87
+ class Representation < Google::Apis::Core::JsonRepresentation
88
+ property :day, as: 'day'
89
+ property :month, as: 'month'
90
+ property :year, as: 'year'
91
+ end
92
+ end
93
+
94
+ class EmissionsGramsPerPax
95
+ # @private
96
+ class Representation < Google::Apis::Core::JsonRepresentation
97
+ property :business, as: 'business'
98
+ property :economy, as: 'economy'
99
+ property :first, as: 'first'
100
+ property :premium_economy, as: 'premiumEconomy'
101
+ end
102
+ end
103
+
104
+ class Flight
105
+ # @private
106
+ class Representation < Google::Apis::Core::JsonRepresentation
107
+ property :departure_date, as: 'departureDate', class: Google::Apis::TravelimpactmodelV1::Date, decorator: Google::Apis::TravelimpactmodelV1::Date::Representation
108
+
109
+ property :destination, as: 'destination'
110
+ property :flight_number, as: 'flightNumber'
111
+ property :operating_carrier_code, as: 'operatingCarrierCode'
112
+ property :origin, as: 'origin'
113
+ end
114
+ end
115
+
116
+ class FlightWithEmissions
117
+ # @private
118
+ class Representation < Google::Apis::Core::JsonRepresentation
119
+ property :emissions_grams_per_pax, as: 'emissionsGramsPerPax', class: Google::Apis::TravelimpactmodelV1::EmissionsGramsPerPax, decorator: Google::Apis::TravelimpactmodelV1::EmissionsGramsPerPax::Representation
120
+
121
+ property :flight, as: 'flight', class: Google::Apis::TravelimpactmodelV1::Flight, decorator: Google::Apis::TravelimpactmodelV1::Flight::Representation
122
+
123
+ end
124
+ end
125
+
126
+ class ModelVersion
127
+ # @private
128
+ class Representation < Google::Apis::Core::JsonRepresentation
129
+ property :dated, as: 'dated'
130
+ property :major, as: 'major'
131
+ property :minor, as: 'minor'
132
+ property :patch, as: 'patch'
133
+ end
134
+ end
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,101 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module TravelimpactmodelV1
23
+ # Travel Impact Model API
24
+ #
25
+ # Travel Impact Model API lets you query travel carbon emission estimates.
26
+ #
27
+ # @example
28
+ # require 'google/apis/travelimpactmodel_v1'
29
+ #
30
+ # Travelimpactmodel = Google::Apis::TravelimpactmodelV1 # Alias the module
31
+ # service = Travelimpactmodel::TravelImpactModelService.new
32
+ #
33
+ # @see https://developers.google.com/travel/impact-model
34
+ class TravelImpactModelService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://travelimpactmodel.googleapis.com/', '',
47
+ client_name: 'google-apis-travelimpactmodel_v1',
48
+ client_version: Google::Apis::TravelimpactmodelV1::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Stateless method to retrieve emission estimates. Details on how emission
53
+ # estimates are computed: https://github.com/google/travel-impact-model The
54
+ # response will contain all entries that match the input flight legs, in the
55
+ # same order. If there are no estimates available for a certain flight leg, the
56
+ # response will return the flight leg object with empty emission fields. The
57
+ # request will still be considered successful. Reasons for missing emission
58
+ # estimates include: - The flight is unknown to the server. - The input flight
59
+ # leg is missing one or more identifiers. - The flight date is in the past. -
60
+ # The aircraft type is not supported by the model. - Missing seat configuration.
61
+ # The request can contain up to 1000 flight legs. If the request has more than
62
+ # 1000 direct flights, if will fail with an INVALID_ARGUMENT error.
63
+ # @param [Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsRequest] compute_flight_emissions_request_object
64
+ # @param [String] fields
65
+ # Selector specifying which fields to include in a partial response.
66
+ # @param [String] quota_user
67
+ # Available to use for quota purposes for server-side applications. Can be any
68
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
69
+ # @param [Google::Apis::RequestOptions] options
70
+ # Request-specific options
71
+ #
72
+ # @yield [result, err] Result & error if block supplied
73
+ # @yieldparam result [Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsResponse] parsed result object
74
+ # @yieldparam err [StandardError] error object if request failed
75
+ #
76
+ # @return [Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsResponse]
77
+ #
78
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
79
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
80
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
81
+ def compute_flight_emissions(compute_flight_emissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
82
+ command = make_simple_command(:post, 'v1/flights:computeFlightEmissions', options)
83
+ command.request_representation = Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsRequest::Representation
84
+ command.request_object = compute_flight_emissions_request_object
85
+ command.response_representation = Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsResponse::Representation
86
+ command.response_class = Google::Apis::TravelimpactmodelV1::ComputeFlightEmissionsResponse
87
+ command.query['fields'] = fields unless fields.nil?
88
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
89
+ execute_or_queue_command(command, &block)
90
+ end
91
+
92
+ protected
93
+
94
+ def apply_command_defaults(command)
95
+ command.query['key'] = key unless key.nil?
96
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
97
+ end
98
+ end
99
+ end
100
+ end
101
+ end
@@ -0,0 +1,33 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/travelimpactmodel_v1/service.rb'
16
+ require 'google/apis/travelimpactmodel_v1/classes.rb'
17
+ require 'google/apis/travelimpactmodel_v1/representations.rb'
18
+ require 'google/apis/travelimpactmodel_v1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Travel Impact Model API
23
+ #
24
+ # Travel Impact Model API lets you query travel carbon emission estimates.
25
+ #
26
+ # @see https://developers.google.com/travel/impact-model
27
+ module TravelimpactmodelV1
28
+ # Version of the Travel Impact Model API this client connects to.
29
+ # This is NOT the gem version.
30
+ VERSION = 'V1'
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/travelimpactmodel_v1"
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-travelimpactmodel_v1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-11-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 0.9.1
20
+ - - "<"
21
+ - !ruby/object:Gem::Version
22
+ version: 2.a
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: 0.9.1
30
+ - - "<"
31
+ - !ruby/object:Gem::Version
32
+ version: 2.a
33
+ description: This is the simple REST client for Travel Impact Model API V1. Simple
34
+ REST clients are Ruby client libraries that provide access to Google services via
35
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
36
+ based on the discovery documents published by the service, and they handle most
37
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
38
+ use this client to access the Travel Impact Model API, but note that some services
39
+ may provide a separate modern client that is easier to use.
40
+ email: googleapis-packages@google.com
41
+ executables: []
42
+ extensions: []
43
+ extra_rdoc_files: []
44
+ files:
45
+ - ".yardopts"
46
+ - CHANGELOG.md
47
+ - LICENSE.md
48
+ - OVERVIEW.md
49
+ - lib/google-apis-travelimpactmodel_v1.rb
50
+ - lib/google/apis/travelimpactmodel_v1.rb
51
+ - lib/google/apis/travelimpactmodel_v1/classes.rb
52
+ - lib/google/apis/travelimpactmodel_v1/gem_version.rb
53
+ - lib/google/apis/travelimpactmodel_v1/representations.rb
54
+ - lib/google/apis/travelimpactmodel_v1/service.rb
55
+ homepage: https://github.com/google/google-api-ruby-client
56
+ licenses:
57
+ - Apache-2.0
58
+ metadata:
59
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-travelimpactmodel_v1/CHANGELOG.md
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-travelimpactmodel_v1/v0.1.0
62
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-travelimpactmodel_v1
63
+ post_install_message:
64
+ rdoc_options: []
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: '2.5'
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ requirements: []
78
+ rubygems_version: 3.3.14
79
+ signing_key:
80
+ specification_version: 4
81
+ summary: Simple REST client for Travel Impact Model API V1
82
+ test_files: []