fds.sdk.FactSetPowerUtilities 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. fds/__init__.py +0 -0
  2. fds/sdk/FactSetPowerUtilities/__init__.py +28 -0
  3. fds/sdk/FactSetPowerUtilities/api/__init__.py +3 -0
  4. fds/sdk/FactSetPowerUtilities/api/generation__emissions_api.py +559 -0
  5. fds/sdk/FactSetPowerUtilities/api/market_data_api.py +568 -0
  6. fds/sdk/FactSetPowerUtilities/api/plants_api.py +424 -0
  7. fds/sdk/FactSetPowerUtilities/api/prices_api.py +309 -0
  8. fds/sdk/FactSetPowerUtilities/api/reference_api.py +1086 -0
  9. fds/sdk/FactSetPowerUtilities/api/units_api.py +559 -0
  10. fds/sdk/FactSetPowerUtilities/api_client.py +939 -0
  11. fds/sdk/FactSetPowerUtilities/apis/__init__.py +22 -0
  12. fds/sdk/FactSetPowerUtilities/configuration.py +496 -0
  13. fds/sdk/FactSetPowerUtilities/exceptions.py +160 -0
  14. fds/sdk/FactSetPowerUtilities/model/__init__.py +5 -0
  15. fds/sdk/FactSetPowerUtilities/model/balancing_authority_coverage.py +272 -0
  16. fds/sdk/FactSetPowerUtilities/model/balancing_authority_ids.py +283 -0
  17. fds/sdk/FactSetPowerUtilities/model/balancing_authority_sub_region_ids.py +283 -0
  18. fds/sdk/FactSetPowerUtilities/model/capacity_price_data.py +280 -0
  19. fds/sdk/FactSetPowerUtilities/model/capacity_price_record.py +353 -0
  20. fds/sdk/FactSetPowerUtilities/model/capacity_price_record_all_of.py +288 -0
  21. fds/sdk/FactSetPowerUtilities/model/category_capacity.py +276 -0
  22. fds/sdk/FactSetPowerUtilities/model/category_demand.py +276 -0
  23. fds/sdk/FactSetPowerUtilities/model/category_forward.py +276 -0
  24. fds/sdk/FactSetPowerUtilities/model/category_generation.py +276 -0
  25. fds/sdk/FactSetPowerUtilities/model/category_interchange.py +276 -0
  26. fds/sdk/FactSetPowerUtilities/model/category_metadata.py +276 -0
  27. fds/sdk/FactSetPowerUtilities/model/category_pipeline.py +276 -0
  28. fds/sdk/FactSetPowerUtilities/model/category_power.py +276 -0
  29. fds/sdk/FactSetPowerUtilities/model/category_solar.py +276 -0
  30. fds/sdk/FactSetPowerUtilities/model/category_spark_spread.py +276 -0
  31. fds/sdk/FactSetPowerUtilities/model/category_thermal.py +276 -0
  32. fds/sdk/FactSetPowerUtilities/model/category_wind.py +276 -0
  33. fds/sdk/FactSetPowerUtilities/model/collection_response_meta.py +262 -0
  34. fds/sdk/FactSetPowerUtilities/model/entity_history_record.py +280 -0
  35. fds/sdk/FactSetPowerUtilities/model/entity_history_response.py +268 -0
  36. fds/sdk/FactSetPowerUtilities/model/error_object.py +288 -0
  37. fds/sdk/FactSetPowerUtilities/model/error_object_links.py +268 -0
  38. fds/sdk/FactSetPowerUtilities/model/error_response.py +262 -0
  39. fds/sdk/FactSetPowerUtilities/model/forward_price_data.py +300 -0
  40. fds/sdk/FactSetPowerUtilities/model/forward_price_record.py +361 -0
  41. fds/sdk/FactSetPowerUtilities/model/forward_price_record_all_of.py +304 -0
  42. fds/sdk/FactSetPowerUtilities/model/hourly_generation_record.py +304 -0
  43. fds/sdk/FactSetPowerUtilities/model/hourly_generation_request.py +274 -0
  44. fds/sdk/FactSetPowerUtilities/model/hourly_generation_request_data.py +280 -0
  45. fds/sdk/FactSetPowerUtilities/model/hourly_generation_response.py +268 -0
  46. fds/sdk/FactSetPowerUtilities/model/iso_mapping_record.py +260 -0
  47. fds/sdk/FactSetPowerUtilities/model/iso_mapping_response.py +268 -0
  48. fds/sdk/FactSetPowerUtilities/model/location_ids.py +283 -0
  49. fds/sdk/FactSetPowerUtilities/model/location_mapping_record.py +264 -0
  50. fds/sdk/FactSetPowerUtilities/model/location_mapping_response.py +268 -0
  51. fds/sdk/FactSetPowerUtilities/model/market_data_coverage_response.py +268 -0
  52. fds/sdk/FactSetPowerUtilities/model/market_data_demand_data.py +288 -0
  53. fds/sdk/FactSetPowerUtilities/model/market_data_generation_data.py +288 -0
  54. fds/sdk/FactSetPowerUtilities/model/market_data_interchange_data.py +292 -0
  55. fds/sdk/FactSetPowerUtilities/model/market_data_record.py +303 -0
  56. fds/sdk/FactSetPowerUtilities/model/market_data_request.py +274 -0
  57. fds/sdk/FactSetPowerUtilities/model/market_data_request_data.py +348 -0
  58. fds/sdk/FactSetPowerUtilities/model/market_data_response.py +268 -0
  59. fds/sdk/FactSetPowerUtilities/model/monthly_generation_record.py +312 -0
  60. fds/sdk/FactSetPowerUtilities/model/monthly_generation_request.py +274 -0
  61. fds/sdk/FactSetPowerUtilities/model/monthly_generation_request_data.py +280 -0
  62. fds/sdk/FactSetPowerUtilities/model/monthly_generation_response.py +268 -0
  63. fds/sdk/FactSetPowerUtilities/model/plant_id_record.py +313 -0
  64. fds/sdk/FactSetPowerUtilities/model/plant_ids.py +283 -0
  65. fds/sdk/FactSetPowerUtilities/model/plant_ids_response.py +268 -0
  66. fds/sdk/FactSetPowerUtilities/model/plant_metadata_data.py +303 -0
  67. fds/sdk/FactSetPowerUtilities/model/plant_metadata_detail.py +401 -0
  68. fds/sdk/FactSetPowerUtilities/model/plant_pipeline_data.py +290 -0
  69. fds/sdk/FactSetPowerUtilities/model/plant_pipeline_detail.py +288 -0
  70. fds/sdk/FactSetPowerUtilities/model/plant_solar_data.py +290 -0
  71. fds/sdk/FactSetPowerUtilities/model/plant_solar_detail.py +304 -0
  72. fds/sdk/FactSetPowerUtilities/model/plant_thermal_data.py +290 -0
  73. fds/sdk/FactSetPowerUtilities/model/plant_thermal_detail.py +284 -0
  74. fds/sdk/FactSetPowerUtilities/model/plant_unit_detail.py +520 -0
  75. fds/sdk/FactSetPowerUtilities/model/plant_unit_ids.py +283 -0
  76. fds/sdk/FactSetPowerUtilities/model/plant_units_request.py +274 -0
  77. fds/sdk/FactSetPowerUtilities/model/plant_units_request_data.py +358 -0
  78. fds/sdk/FactSetPowerUtilities/model/plant_units_response.py +268 -0
  79. fds/sdk/FactSetPowerUtilities/model/plant_wind_data.py +290 -0
  80. fds/sdk/FactSetPowerUtilities/model/plant_wind_detail.py +304 -0
  81. fds/sdk/FactSetPowerUtilities/model/power_price_data.py +288 -0
  82. fds/sdk/FactSetPowerUtilities/model/power_price_record.py +349 -0
  83. fds/sdk/FactSetPowerUtilities/model/power_price_record_all_of.py +284 -0
  84. fds/sdk/FactSetPowerUtilities/model/price_record.py +421 -0
  85. fds/sdk/FactSetPowerUtilities/model/price_record_base.py +276 -0
  86. fds/sdk/FactSetPowerUtilities/model/prices_request.py +274 -0
  87. fds/sdk/FactSetPowerUtilities/model/prices_request_data.py +357 -0
  88. fds/sdk/FactSetPowerUtilities/model/prices_response.py +268 -0
  89. fds/sdk/FactSetPowerUtilities/model/request_meta.py +262 -0
  90. fds/sdk/FactSetPowerUtilities/model/request_pagination.py +267 -0
  91. fds/sdk/FactSetPowerUtilities/model/response_meta.py +270 -0
  92. fds/sdk/FactSetPowerUtilities/model/response_pagination.py +260 -0
  93. fds/sdk/FactSetPowerUtilities/model/spark_spread_data.py +288 -0
  94. fds/sdk/FactSetPowerUtilities/model/spark_spread_price_record.py +351 -0
  95. fds/sdk/FactSetPowerUtilities/model/spark_spread_price_record_all_of.py +294 -0
  96. fds/sdk/FactSetPowerUtilities/model/spark_spread_prices_mwh.py +268 -0
  97. fds/sdk/FactSetPowerUtilities/model/units_ownership_detail.py +290 -0
  98. fds/sdk/FactSetPowerUtilities/model/units_ownership_request.py +274 -0
  99. fds/sdk/FactSetPowerUtilities/model/units_ownership_request_data.py +268 -0
  100. fds/sdk/FactSetPowerUtilities/model/units_ownership_response.py +268 -0
  101. fds/sdk/FactSetPowerUtilities/model/zone_mapping_record.py +272 -0
  102. fds/sdk/FactSetPowerUtilities/model/zone_mapping_response.py +268 -0
  103. fds/sdk/FactSetPowerUtilities/model_utils.py +2062 -0
  104. fds/sdk/FactSetPowerUtilities/models/__init__.py +99 -0
  105. fds/sdk/FactSetPowerUtilities/rest.py +347 -0
  106. fds/sdk/__init__.py +0 -0
  107. fds_sdk_factsetpowerutilities-0.1.0.dist-info/METADATA +449 -0
  108. fds_sdk_factsetpowerutilities-0.1.0.dist-info/RECORD +111 -0
  109. fds_sdk_factsetpowerutilities-0.1.0.dist-info/WHEEL +5 -0
  110. fds_sdk_factsetpowerutilities-0.1.0.dist-info/licenses/LICENSE +202 -0
  111. fds_sdk_factsetpowerutilities-0.1.0.dist-info/top_level.txt +1 -0
fds/__init__.py ADDED
File without changes
@@ -0,0 +1,28 @@
1
+ # flake8: noqa
2
+
3
+ """
4
+ FactSet Power & Utilities API
5
+
6
+ The FactSet Power & Utilities API provides comprehensive global power generation and energy market data. Coverage includes power plant metadata and technical specifications, balancing authority supply and demand, power spot and forward prices, spark spreads, capacity prices, and hourly and monthly plant-level generation and emissions. **Note:** Plant metadata and reference/mapping endpoints (Plants, ISO/TSO mapping, zone mapping) reflect current data only — historical or point-in-time values are not retained. The exception is `GET /reference/entity-history`, which provides historical entity and ownership records. Unit-level mapping information (unit names, EIA codes, project grades, and regional mappings) are included in the `/units/details` metadata response. **Key Features:** - Global power plant metadata including ownership, location, pipeline connections, and fuel-specific technical specifications (solar, wind, thermal) - Balancing authority-level generation (by fuel type), demand, and net interchange data - Power spot prices, spark spreads, capacity auction clearing prices, and forward power curves - Hourly and monthly plant-level net generation with CO₂, N₂O, and SO₂ emissions data - Reference data for ISO/TSO codes, price zones and hubs, and entity/ownership history **Units and abbreviations used throughout this API:** - `MW` — megawatt (unit of instantaneous power capacity) - `MWh` — megawatt-hour (unit of energy; one MW delivered for one hour) - `$/MWh` — US dollars per megawatt-hour (power price unit) - `$/MW-day` — US dollars per megawatt per day (capacity market price unit) - `MMBtu` — million British thermal units (heat input unit) - `Dth` — dekatherm (one million BTU; unit for natural gas interconnection capacity) - `CO₂` — carbon dioxide; reported in metric tons - `SO₂` — sulfur dioxide; reported in metric tons (hourly) or short tons (monthly) - `N₂O` — nitrous oxide; reported in metric tons (hourly) or short tons (monthly) - `BA` — Balancing Authority; a grid operator responsible for balancing generation and load within its area - `ISO/TSO` — Independent System Operator / Transmission System Operator - `EIA` — US Energy Information Administration # noqa: E501
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Contact: api@factset.com
10
+ Generated by: https://openapi-generator.tech
11
+ """
12
+
13
+
14
+ __version__ = "0.1.0"
15
+
16
+ # import ApiClient
17
+ from fds.sdk.FactSetPowerUtilities.api_client import ApiClient
18
+
19
+ # import Configuration
20
+ from fds.sdk.FactSetPowerUtilities.configuration import Configuration
21
+
22
+ # import exceptions
23
+ from fds.sdk.FactSetPowerUtilities.exceptions import OpenApiException
24
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiAttributeError
25
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiTypeError
26
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiValueError
27
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiKeyError
28
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiException
@@ -0,0 +1,3 @@
1
+ # do not import all apis into this module because that uses a lot of memory and stack frames
2
+ # if you need the ability to import all apis from one package, import them with
3
+ # from fds.sdk.FactSetPowerUtilities.apis import GenerationEmissionsApi
@@ -0,0 +1,559 @@
1
+ """
2
+ FactSet Power & Utilities API
3
+
4
+ The FactSet Power & Utilities API provides comprehensive global power generation and energy market data. Coverage includes power plant metadata and technical specifications, balancing authority supply and demand, power spot and forward prices, spark spreads, capacity prices, and hourly and monthly plant-level generation and emissions. **Note:** Plant metadata and reference/mapping endpoints (Plants, ISO/TSO mapping, zone mapping) reflect current data only — historical or point-in-time values are not retained. The exception is `GET /reference/entity-history`, which provides historical entity and ownership records. Unit-level mapping information (unit names, EIA codes, project grades, and regional mappings) are included in the `/units/details` metadata response. **Key Features:** - Global power plant metadata including ownership, location, pipeline connections, and fuel-specific technical specifications (solar, wind, thermal) - Balancing authority-level generation (by fuel type), demand, and net interchange data - Power spot prices, spark spreads, capacity auction clearing prices, and forward power curves - Hourly and monthly plant-level net generation with CO₂, N₂O, and SO₂ emissions data - Reference data for ISO/TSO codes, price zones and hubs, and entity/ownership history **Units and abbreviations used throughout this API:** - `MW` — megawatt (unit of instantaneous power capacity) - `MWh` — megawatt-hour (unit of energy; one MW delivered for one hour) - `$/MWh` — US dollars per megawatt-hour (power price unit) - `$/MW-day` — US dollars per megawatt per day (capacity market price unit) - `MMBtu` — million British thermal units (heat input unit) - `Dth` — dekatherm (one million BTU; unit for natural gas interconnection capacity) - `CO₂` — carbon dioxide; reported in metric tons - `SO₂` — sulfur dioxide; reported in metric tons (hourly) or short tons (monthly) - `N₂O` — nitrous oxide; reported in metric tons (hourly) or short tons (monthly) - `BA` — Balancing Authority; a grid operator responsible for balancing generation and load within its area - `ISO/TSO` — Independent System Operator / Transmission System Operator - `EIA` — US Energy Information Administration # noqa: E501
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: api@factset.com
8
+ Generated by: https://openapi-generator.tech
9
+ """
10
+
11
+
12
+ import re # noqa: F401
13
+ import sys # noqa: F401
14
+ from multiprocessing.pool import ApplyResult
15
+ import typing
16
+
17
+ from fds.sdk.FactSetPowerUtilities.api_client import ApiClient, Endpoint as _Endpoint
18
+ from fds.sdk.FactSetPowerUtilities.model_utils import ( # noqa: F401
19
+ check_allowed_values,
20
+ check_validations,
21
+ date,
22
+ datetime,
23
+ file_type,
24
+ none_type,
25
+ validate_and_convert_types
26
+ )
27
+ from fds.sdk.FactSetPowerUtilities.exceptions import ApiException
28
+ from fds.sdk.FactSetPowerUtilities.model.error_response import ErrorResponse
29
+ from fds.sdk.FactSetPowerUtilities.model.hourly_generation_request import HourlyGenerationRequest
30
+ from fds.sdk.FactSetPowerUtilities.model.hourly_generation_response import HourlyGenerationResponse
31
+ from fds.sdk.FactSetPowerUtilities.model.monthly_generation_request import MonthlyGenerationRequest
32
+ from fds.sdk.FactSetPowerUtilities.model.monthly_generation_response import MonthlyGenerationResponse
33
+
34
+
35
+
36
+
37
+
38
+ class GenerationEmissionsApi(object):
39
+ """NOTE: This class is auto generated by OpenAPI Generator
40
+ Ref: https://openapi-generator.tech
41
+
42
+ Do not edit the class manually.
43
+ """
44
+
45
+ def __init__(self, api_client=None):
46
+ if api_client is None:
47
+ api_client = ApiClient()
48
+ self.api_client = api_client
49
+
50
+ self.list_hourly_generation_units_endpoint = _Endpoint(
51
+ settings={
52
+ 'response_type': (
53
+ { 200: (HourlyGenerationResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 404: (ErrorResponse,), 415: (ErrorResponse,), 422: (ErrorResponse,), 429: (ErrorResponse,), 500: (ErrorResponse,), 503: (ErrorResponse,), },
54
+ None
55
+ ),
56
+ 'auth': [
57
+ 'FactSetApiKey',
58
+ 'FactSetOAuth2'
59
+ ],
60
+ 'endpoint_path': '/generation/hourly/units',
61
+ 'operation_id': 'list_hourly_generation_units',
62
+ 'http_method': 'POST',
63
+ 'servers': None,
64
+ },
65
+ params_map={
66
+ 'all': [
67
+ 'hourly_generation_request',
68
+ ],
69
+ 'required': [
70
+ 'hourly_generation_request',
71
+ ],
72
+ 'nullable': [
73
+ ],
74
+ 'enum': [
75
+ ],
76
+ 'validation': [
77
+ ]
78
+ },
79
+ root_map={
80
+ 'validations': {
81
+ },
82
+ 'allowed_values': {
83
+ },
84
+ 'openapi_types': {
85
+ 'hourly_generation_request':
86
+ (HourlyGenerationRequest,),
87
+ },
88
+ 'attribute_map': {
89
+ },
90
+ 'location_map': {
91
+ 'hourly_generation_request': 'body',
92
+ },
93
+ 'collection_format_map': {
94
+ }
95
+ },
96
+ headers_map={
97
+ 'accept': [
98
+ 'application/json'
99
+ ],
100
+ 'content_type': [
101
+ 'application/json'
102
+ ]
103
+ },
104
+ api_client=api_client
105
+ )
106
+
107
+ self.list_monthly_generation_endpoint = _Endpoint(
108
+ settings={
109
+ 'response_type': (
110
+ { 200: (MonthlyGenerationResponse,), 400: (ErrorResponse,), 401: (ErrorResponse,), 403: (ErrorResponse,), 404: (ErrorResponse,), 415: (ErrorResponse,), 422: (ErrorResponse,), 429: (ErrorResponse,), 500: (ErrorResponse,), 503: (ErrorResponse,), },
111
+ None
112
+ ),
113
+ 'auth': [
114
+ 'FactSetApiKey',
115
+ 'FactSetOAuth2'
116
+ ],
117
+ 'endpoint_path': '/generation/monthly',
118
+ 'operation_id': 'list_monthly_generation',
119
+ 'http_method': 'POST',
120
+ 'servers': None,
121
+ },
122
+ params_map={
123
+ 'all': [
124
+ 'monthly_generation_request',
125
+ ],
126
+ 'required': [
127
+ 'monthly_generation_request',
128
+ ],
129
+ 'nullable': [
130
+ ],
131
+ 'enum': [
132
+ ],
133
+ 'validation': [
134
+ ]
135
+ },
136
+ root_map={
137
+ 'validations': {
138
+ },
139
+ 'allowed_values': {
140
+ },
141
+ 'openapi_types': {
142
+ 'monthly_generation_request':
143
+ (MonthlyGenerationRequest,),
144
+ },
145
+ 'attribute_map': {
146
+ },
147
+ 'location_map': {
148
+ 'monthly_generation_request': 'body',
149
+ },
150
+ 'collection_format_map': {
151
+ }
152
+ },
153
+ headers_map={
154
+ 'accept': [
155
+ 'application/json'
156
+ ],
157
+ 'content_type': [
158
+ 'application/json'
159
+ ]
160
+ },
161
+ api_client=api_client
162
+ )
163
+
164
+
165
+ @staticmethod
166
+ def apply_kwargs_defaults(kwargs, return_http_data_only, async_req):
167
+ kwargs["async_req"] = async_req
168
+ kwargs["_return_http_data_only"] = return_http_data_only
169
+ kwargs["_preload_content"] = kwargs.get("_preload_content", True)
170
+ kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
171
+ kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
172
+ kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
173
+ kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
174
+ kwargs["_content_type"] = kwargs.get("_content_type")
175
+ kwargs["_host_index"] = kwargs.get("_host_index")
176
+
177
+
178
+ def list_hourly_generation_units(
179
+ self,
180
+ hourly_generation_request,
181
+ **kwargs
182
+ ) -> HourlyGenerationResponse:
183
+ """Returns hourly plant unit generation and emissions # noqa: E501
184
+
185
+ Returns hourly net generation and emissions for the requested power plant units over the specified date range. Each record provides net generation in MWh and reported emissions of CO₂, SO₂, and N₂O (nitrous oxide) in metric tons, along with heat input in MMBtu and steam generation. This endpoint operates at the unit level, matching the underlying source data. # noqa: E501
186
+ This method makes a synchronous HTTP request. Returns the http data only
187
+
188
+ Args:
189
+ hourly_generation_request (HourlyGenerationRequest):
190
+
191
+ Keyword Args:
192
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
193
+ will be returned without reading/decoding response data.
194
+ Default is True. NOTE: if this API returns a file, it is the responsibility
195
+ of the caller to close the file stream.
196
+ _request_timeout (int/float/tuple): timeout setting for this request. If
197
+ one number provided, it will be total request timeout. It can also
198
+ be a pair (tuple) of (connection, read) timeouts.
199
+ Default is None.
200
+ _check_input_type (bool): specifies if type checking
201
+ should be done one the data sent to the server.
202
+ Default is True.
203
+ _check_return_type (bool): specifies if type checking
204
+ should be done one the data received from the server.
205
+ Default is True.
206
+ _spec_property_naming (bool): True if the variable names in the input data
207
+ are serialized names, as specified in the OpenAPI document.
208
+ False if the variable names in the input data
209
+ are pythonic names, e.g. snake case (default)
210
+ _content_type (str/None): force body content-type.
211
+ Default is None and content-type will be predicted by allowed
212
+ content-types and body.
213
+ _host_index (int/None): specifies the index of the server
214
+ that we want to use.
215
+ Default is read from the configuration.
216
+ Returns:
217
+ HourlyGenerationResponse
218
+ Response Object
219
+ """
220
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
221
+ kwargs['hourly_generation_request'] = \
222
+ hourly_generation_request
223
+ return self.list_hourly_generation_units_endpoint.call_with_http_info(**kwargs)
224
+
225
+ def list_hourly_generation_units_with_http_info(
226
+ self,
227
+ hourly_generation_request,
228
+ **kwargs
229
+ ) -> typing.Tuple[HourlyGenerationResponse, int, typing.MutableMapping]:
230
+ """Returns hourly plant unit generation and emissions # noqa: E501
231
+
232
+ Returns hourly net generation and emissions for the requested power plant units over the specified date range. Each record provides net generation in MWh and reported emissions of CO₂, SO₂, and N₂O (nitrous oxide) in metric tons, along with heat input in MMBtu and steam generation. This endpoint operates at the unit level, matching the underlying source data. # noqa: E501
233
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
234
+
235
+ Args:
236
+ hourly_generation_request (HourlyGenerationRequest):
237
+
238
+ Keyword Args:
239
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
240
+ will be returned without reading/decoding response data.
241
+ Default is True. NOTE: if this API returns a file, it is the responsibility
242
+ of the caller to close the file stream.
243
+ _request_timeout (int/float/tuple): timeout setting for this request. If
244
+ one number provided, it will be total request timeout. It can also
245
+ be a pair (tuple) of (connection, read) timeouts.
246
+ Default is None.
247
+ _check_input_type (bool): specifies if type checking
248
+ should be done one the data sent to the server.
249
+ Default is True.
250
+ _check_return_type (bool): specifies if type checking
251
+ should be done one the data received from the server.
252
+ Default is True.
253
+ _spec_property_naming (bool): True if the variable names in the input data
254
+ are serialized names, as specified in the OpenAPI document.
255
+ False if the variable names in the input data
256
+ are pythonic names, e.g. snake case (default)
257
+ _content_type (str/None): force body content-type.
258
+ Default is None and content-type will be predicted by allowed
259
+ content-types and body.
260
+ _host_index (int/None): specifies the index of the server
261
+ that we want to use.
262
+ Default is read from the configuration.
263
+ Returns:
264
+ HourlyGenerationResponse
265
+ Response Object
266
+ int
267
+ Http Status Code
268
+ dict
269
+ Dictionary of the response headers
270
+ """
271
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
272
+ kwargs['hourly_generation_request'] = \
273
+ hourly_generation_request
274
+ return self.list_hourly_generation_units_endpoint.call_with_http_info(**kwargs)
275
+
276
+ def list_hourly_generation_units_async(
277
+ self,
278
+ hourly_generation_request,
279
+ **kwargs
280
+ ) -> "ApplyResult[HourlyGenerationResponse]":
281
+ """Returns hourly plant unit generation and emissions # noqa: E501
282
+
283
+ Returns hourly net generation and emissions for the requested power plant units over the specified date range. Each record provides net generation in MWh and reported emissions of CO₂, SO₂, and N₂O (nitrous oxide) in metric tons, along with heat input in MMBtu and steam generation. This endpoint operates at the unit level, matching the underlying source data. # noqa: E501
284
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
285
+
286
+ Args:
287
+ hourly_generation_request (HourlyGenerationRequest):
288
+
289
+ Keyword Args:
290
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
291
+ will be returned without reading/decoding response data.
292
+ Default is True. NOTE: if this API returns a file, it is the responsibility
293
+ of the caller to close the file stream.
294
+ _request_timeout (int/float/tuple): timeout setting for this request. If
295
+ one number provided, it will be total request timeout. It can also
296
+ be a pair (tuple) of (connection, read) timeouts.
297
+ Default is None.
298
+ _check_input_type (bool): specifies if type checking
299
+ should be done one the data sent to the server.
300
+ Default is True.
301
+ _check_return_type (bool): specifies if type checking
302
+ should be done one the data received from the server.
303
+ Default is True.
304
+ _spec_property_naming (bool): True if the variable names in the input data
305
+ are serialized names, as specified in the OpenAPI document.
306
+ False if the variable names in the input data
307
+ are pythonic names, e.g. snake case (default)
308
+ _content_type (str/None): force body content-type.
309
+ Default is None and content-type will be predicted by allowed
310
+ content-types and body.
311
+ _host_index (int/None): specifies the index of the server
312
+ that we want to use.
313
+ Default is read from the configuration.
314
+ Returns:
315
+ ApplyResult[HourlyGenerationResponse]
316
+ """
317
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
318
+ kwargs['hourly_generation_request'] = \
319
+ hourly_generation_request
320
+ return self.list_hourly_generation_units_endpoint.call_with_http_info(**kwargs)
321
+
322
+ def list_hourly_generation_units_with_http_info_async(
323
+ self,
324
+ hourly_generation_request,
325
+ **kwargs
326
+ ) -> "ApplyResult[typing.Tuple[HourlyGenerationResponse, int, typing.MutableMapping]]":
327
+ """Returns hourly plant unit generation and emissions # noqa: E501
328
+
329
+ Returns hourly net generation and emissions for the requested power plant units over the specified date range. Each record provides net generation in MWh and reported emissions of CO₂, SO₂, and N₂O (nitrous oxide) in metric tons, along with heat input in MMBtu and steam generation. This endpoint operates at the unit level, matching the underlying source data. # noqa: E501
330
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
331
+
332
+ Args:
333
+ hourly_generation_request (HourlyGenerationRequest):
334
+
335
+ Keyword Args:
336
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
337
+ will be returned without reading/decoding response data.
338
+ Default is True. NOTE: if this API returns a file, it is the responsibility
339
+ of the caller to close the file stream.
340
+ _request_timeout (int/float/tuple): timeout setting for this request. If
341
+ one number provided, it will be total request timeout. It can also
342
+ be a pair (tuple) of (connection, read) timeouts.
343
+ Default is None.
344
+ _check_input_type (bool): specifies if type checking
345
+ should be done one the data sent to the server.
346
+ Default is True.
347
+ _check_return_type (bool): specifies if type checking
348
+ should be done one the data received from the server.
349
+ Default is True.
350
+ _spec_property_naming (bool): True if the variable names in the input data
351
+ are serialized names, as specified in the OpenAPI document.
352
+ False if the variable names in the input data
353
+ are pythonic names, e.g. snake case (default)
354
+ _content_type (str/None): force body content-type.
355
+ Default is None and content-type will be predicted by allowed
356
+ content-types and body.
357
+ _host_index (int/None): specifies the index of the server
358
+ that we want to use.
359
+ Default is read from the configuration.
360
+ Returns:
361
+ ApplyResult[(HourlyGenerationResponse, int, typing.Dict)]
362
+ """
363
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
364
+ kwargs['hourly_generation_request'] = \
365
+ hourly_generation_request
366
+ return self.list_hourly_generation_units_endpoint.call_with_http_info(**kwargs)
367
+
368
+
369
+ def list_monthly_generation(
370
+ self,
371
+ monthly_generation_request,
372
+ **kwargs
373
+ ) -> MonthlyGenerationResponse:
374
+ """Returns monthly plant generation and emissions # noqa: E501
375
+
376
+ Returns monthly net generation and emissions for the requested power plants over the specified date range. Each record provides net generation in MWh, plant/fuel-type capacity and capacity factor, and total emissions of CO₂ (metric tons), SO₂ (short tons), and N₂O (nitrous oxide, short tons), along with heat input in MMBtu and a CO₂ intensity measure. # noqa: E501
377
+ This method makes a synchronous HTTP request. Returns the http data only
378
+
379
+ Args:
380
+ monthly_generation_request (MonthlyGenerationRequest):
381
+
382
+ Keyword Args:
383
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
384
+ will be returned without reading/decoding response data.
385
+ Default is True. NOTE: if this API returns a file, it is the responsibility
386
+ of the caller to close the file stream.
387
+ _request_timeout (int/float/tuple): timeout setting for this request. If
388
+ one number provided, it will be total request timeout. It can also
389
+ be a pair (tuple) of (connection, read) timeouts.
390
+ Default is None.
391
+ _check_input_type (bool): specifies if type checking
392
+ should be done one the data sent to the server.
393
+ Default is True.
394
+ _check_return_type (bool): specifies if type checking
395
+ should be done one the data received from the server.
396
+ Default is True.
397
+ _spec_property_naming (bool): True if the variable names in the input data
398
+ are serialized names, as specified in the OpenAPI document.
399
+ False if the variable names in the input data
400
+ are pythonic names, e.g. snake case (default)
401
+ _content_type (str/None): force body content-type.
402
+ Default is None and content-type will be predicted by allowed
403
+ content-types and body.
404
+ _host_index (int/None): specifies the index of the server
405
+ that we want to use.
406
+ Default is read from the configuration.
407
+ Returns:
408
+ MonthlyGenerationResponse
409
+ Response Object
410
+ """
411
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
412
+ kwargs['monthly_generation_request'] = \
413
+ monthly_generation_request
414
+ return self.list_monthly_generation_endpoint.call_with_http_info(**kwargs)
415
+
416
+ def list_monthly_generation_with_http_info(
417
+ self,
418
+ monthly_generation_request,
419
+ **kwargs
420
+ ) -> typing.Tuple[MonthlyGenerationResponse, int, typing.MutableMapping]:
421
+ """Returns monthly plant generation and emissions # noqa: E501
422
+
423
+ Returns monthly net generation and emissions for the requested power plants over the specified date range. Each record provides net generation in MWh, plant/fuel-type capacity and capacity factor, and total emissions of CO₂ (metric tons), SO₂ (short tons), and N₂O (nitrous oxide, short tons), along with heat input in MMBtu and a CO₂ intensity measure. # noqa: E501
424
+ This method makes a synchronous HTTP request. Returns http data, http status and headers
425
+
426
+ Args:
427
+ monthly_generation_request (MonthlyGenerationRequest):
428
+
429
+ Keyword Args:
430
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
431
+ will be returned without reading/decoding response data.
432
+ Default is True. NOTE: if this API returns a file, it is the responsibility
433
+ of the caller to close the file stream.
434
+ _request_timeout (int/float/tuple): timeout setting for this request. If
435
+ one number provided, it will be total request timeout. It can also
436
+ be a pair (tuple) of (connection, read) timeouts.
437
+ Default is None.
438
+ _check_input_type (bool): specifies if type checking
439
+ should be done one the data sent to the server.
440
+ Default is True.
441
+ _check_return_type (bool): specifies if type checking
442
+ should be done one the data received from the server.
443
+ Default is True.
444
+ _spec_property_naming (bool): True if the variable names in the input data
445
+ are serialized names, as specified in the OpenAPI document.
446
+ False if the variable names in the input data
447
+ are pythonic names, e.g. snake case (default)
448
+ _content_type (str/None): force body content-type.
449
+ Default is None and content-type will be predicted by allowed
450
+ content-types and body.
451
+ _host_index (int/None): specifies the index of the server
452
+ that we want to use.
453
+ Default is read from the configuration.
454
+ Returns:
455
+ MonthlyGenerationResponse
456
+ Response Object
457
+ int
458
+ Http Status Code
459
+ dict
460
+ Dictionary of the response headers
461
+ """
462
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
463
+ kwargs['monthly_generation_request'] = \
464
+ monthly_generation_request
465
+ return self.list_monthly_generation_endpoint.call_with_http_info(**kwargs)
466
+
467
+ def list_monthly_generation_async(
468
+ self,
469
+ monthly_generation_request,
470
+ **kwargs
471
+ ) -> "ApplyResult[MonthlyGenerationResponse]":
472
+ """Returns monthly plant generation and emissions # noqa: E501
473
+
474
+ Returns monthly net generation and emissions for the requested power plants over the specified date range. Each record provides net generation in MWh, plant/fuel-type capacity and capacity factor, and total emissions of CO₂ (metric tons), SO₂ (short tons), and N₂O (nitrous oxide, short tons), along with heat input in MMBtu and a CO₂ intensity measure. # noqa: E501
475
+ This method makes a asynchronous HTTP request. Returns the http data, wrapped in ApplyResult
476
+
477
+ Args:
478
+ monthly_generation_request (MonthlyGenerationRequest):
479
+
480
+ Keyword Args:
481
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
482
+ will be returned without reading/decoding response data.
483
+ Default is True. NOTE: if this API returns a file, it is the responsibility
484
+ of the caller to close the file stream.
485
+ _request_timeout (int/float/tuple): timeout setting for this request. If
486
+ one number provided, it will be total request timeout. It can also
487
+ be a pair (tuple) of (connection, read) timeouts.
488
+ Default is None.
489
+ _check_input_type (bool): specifies if type checking
490
+ should be done one the data sent to the server.
491
+ Default is True.
492
+ _check_return_type (bool): specifies if type checking
493
+ should be done one the data received from the server.
494
+ Default is True.
495
+ _spec_property_naming (bool): True if the variable names in the input data
496
+ are serialized names, as specified in the OpenAPI document.
497
+ False if the variable names in the input data
498
+ are pythonic names, e.g. snake case (default)
499
+ _content_type (str/None): force body content-type.
500
+ Default is None and content-type will be predicted by allowed
501
+ content-types and body.
502
+ _host_index (int/None): specifies the index of the server
503
+ that we want to use.
504
+ Default is read from the configuration.
505
+ Returns:
506
+ ApplyResult[MonthlyGenerationResponse]
507
+ """
508
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
509
+ kwargs['monthly_generation_request'] = \
510
+ monthly_generation_request
511
+ return self.list_monthly_generation_endpoint.call_with_http_info(**kwargs)
512
+
513
+ def list_monthly_generation_with_http_info_async(
514
+ self,
515
+ monthly_generation_request,
516
+ **kwargs
517
+ ) -> "ApplyResult[typing.Tuple[MonthlyGenerationResponse, int, typing.MutableMapping]]":
518
+ """Returns monthly plant generation and emissions # noqa: E501
519
+
520
+ Returns monthly net generation and emissions for the requested power plants over the specified date range. Each record provides net generation in MWh, plant/fuel-type capacity and capacity factor, and total emissions of CO₂ (metric tons), SO₂ (short tons), and N₂O (nitrous oxide, short tons), along with heat input in MMBtu and a CO₂ intensity measure. # noqa: E501
521
+ This method makes a asynchronous HTTP request. Returns http data, http status and headers, wrapped in ApplyResult
522
+
523
+ Args:
524
+ monthly_generation_request (MonthlyGenerationRequest):
525
+
526
+ Keyword Args:
527
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
528
+ will be returned without reading/decoding response data.
529
+ Default is True. NOTE: if this API returns a file, it is the responsibility
530
+ of the caller to close the file stream.
531
+ _request_timeout (int/float/tuple): timeout setting for this request. If
532
+ one number provided, it will be total request timeout. It can also
533
+ be a pair (tuple) of (connection, read) timeouts.
534
+ Default is None.
535
+ _check_input_type (bool): specifies if type checking
536
+ should be done one the data sent to the server.
537
+ Default is True.
538
+ _check_return_type (bool): specifies if type checking
539
+ should be done one the data received from the server.
540
+ Default is True.
541
+ _spec_property_naming (bool): True if the variable names in the input data
542
+ are serialized names, as specified in the OpenAPI document.
543
+ False if the variable names in the input data
544
+ are pythonic names, e.g. snake case (default)
545
+ _content_type (str/None): force body content-type.
546
+ Default is None and content-type will be predicted by allowed
547
+ content-types and body.
548
+ _host_index (int/None): specifies the index of the server
549
+ that we want to use.
550
+ Default is read from the configuration.
551
+ Returns:
552
+ ApplyResult[(MonthlyGenerationResponse, int, typing.Dict)]
553
+ """
554
+ self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
555
+ kwargs['monthly_generation_request'] = \
556
+ monthly_generation_request
557
+ return self.list_monthly_generation_endpoint.call_with_http_info(**kwargs)
558
+
559
+