1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
|
# coding: utf-8
"""
Amber Electric Public API
Amber is an Australian-based electricity retailer that pass through the real-time wholesale price of energy. Because of Amber's wholesale power prices, you can save hundreds of dollars a year by automating high power devices like air-conditioners, heat pumps and pool pumps. This Python library provides an interface to the API, allowing you to react to current and forecast prices, as well as download your historic usage.
The version of the OpenAPI document: 2.0.0
Contact: dev@amber.com.au
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import re # noqa: F401
import io
import warnings
from pydantic import validate_arguments, ValidationError
from typing_extensions import Annotated
from datetime import date
from pydantic import Field, StrictInt, StrictStr
from typing import List, Optional
from amberelectric.models.interval import Interval
from amberelectric.models.renewable import Renewable
from amberelectric.models.site import Site
from amberelectric.models.usage import Usage
from amberelectric.api_client import ApiClient
from amberelectric.api_response import ApiResponse
from amberelectric.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
class AmberApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@validate_arguments
def get_current_prices(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching prices for. Can be found using the `/sites` enpoint")], next : Annotated[Optional[StrictInt], Field(description="Return the _next_ number of forecast intervals")] = None, previous : Annotated[Optional[StrictInt], Field(description="Return the _previous_ number of actual intervals.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 30. Default: 30")] = None, **kwargs) -> List[Interval]: # noqa: E501
"""get_current_prices # noqa: E501
Returns the current price # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_prices(site_id, next, previous, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching prices for. Can be found using the `/sites` enpoint (required)
:type site_id: str
:param next: Return the _next_ number of forecast intervals
:type next: int
:param previous: Return the _previous_ number of actual intervals.
:type previous: int
:param resolution: Specify the required interval duration resolution. Valid options: 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: timeout setting for this request.
If one number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: List[Interval]
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_current_prices_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
return self.get_current_prices_with_http_info(site_id, next, previous, resolution, **kwargs) # noqa: E501
@validate_arguments
def get_current_prices_with_http_info(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching prices for. Can be found using the `/sites` enpoint")], next : Annotated[Optional[StrictInt], Field(description="Return the _next_ number of forecast intervals")] = None, previous : Annotated[Optional[StrictInt], Field(description="Return the _previous_ number of actual intervals.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 30. Default: 30")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""get_current_prices # noqa: E501
Returns the current price # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_prices_with_http_info(site_id, next, previous, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching prices for. Can be found using the `/sites` enpoint (required)
:type site_id: str
:param next: Return the _next_ number of forecast intervals
:type next: int
:param previous: Return the _previous_ number of actual intervals.
:type previous: int
:param resolution: Specify the required interval duration resolution. Valid options: 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[Interval], status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'site_id',
'next',
'previous',
'resolution'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_current_prices" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['site_id'] is not None:
_path_params['siteId'] = _params['site_id']
# process the query parameters
_query_params = []
if _params.get('next') is not None: # noqa: E501
_query_params.append(('next', _params['next']))
if _params.get('previous') is not None: # noqa: E501
_query_params.append(('previous', _params['previous']))
if _params.get('resolution') is not None: # noqa: E501
_query_params.append(('resolution', _params['resolution']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['apiKey'] # noqa: E501
_response_types_map = {
'200': "List[Interval]",
'400': None,
'401': None,
'404': None,
'500': None,
}
return self.api_client.call_api(
'/sites/{siteId}/prices/current', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def get_current_renewables(self, state : Annotated[StrictStr, Field(..., description="State you would like the renewables for. Valid states: nsw, sa, qld, vic")], next : Annotated[Optional[StrictInt], Field(description="Return the _next_ number of forecast intervals")] = None, previous : Annotated[Optional[StrictInt], Field(description="Return the _previous_ number of actual intervals.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 5, 30. Default: 30")] = None, **kwargs) -> List[Renewable]: # noqa: E501
"""get_current_renewables # noqa: E501
Returns the current percentage of renewables in the grid # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_renewables(state, next, previous, resolution, async_req=True)
>>> result = thread.get()
:param state: State you would like the renewables for. Valid states: nsw, sa, qld, vic (required)
:type state: str
:param next: Return the _next_ number of forecast intervals
:type next: int
:param previous: Return the _previous_ number of actual intervals.
:type previous: int
:param resolution: Specify the required interval duration resolution. Valid options: 5, 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: timeout setting for this request.
If one number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: List[Renewable]
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_current_renewables_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
return self.get_current_renewables_with_http_info(state, next, previous, resolution, **kwargs) # noqa: E501
@validate_arguments
def get_current_renewables_with_http_info(self, state : Annotated[StrictStr, Field(..., description="State you would like the renewables for. Valid states: nsw, sa, qld, vic")], next : Annotated[Optional[StrictInt], Field(description="Return the _next_ number of forecast intervals")] = None, previous : Annotated[Optional[StrictInt], Field(description="Return the _previous_ number of actual intervals.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 5, 30. Default: 30")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""get_current_renewables # noqa: E501
Returns the current percentage of renewables in the grid # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_current_renewables_with_http_info(state, next, previous, resolution, async_req=True)
>>> result = thread.get()
:param state: State you would like the renewables for. Valid states: nsw, sa, qld, vic (required)
:type state: str
:param next: Return the _next_ number of forecast intervals
:type next: int
:param previous: Return the _previous_ number of actual intervals.
:type previous: int
:param resolution: Specify the required interval duration resolution. Valid options: 5, 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[Renewable], status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'state',
'next',
'previous',
'resolution'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_current_renewables" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['state'] is not None:
_path_params['state'] = _params['state']
# process the query parameters
_query_params = []
if _params.get('next') is not None: # noqa: E501
_query_params.append(('next', _params['next']))
if _params.get('previous') is not None: # noqa: E501
_query_params.append(('previous', _params['previous']))
if _params.get('resolution') is not None: # noqa: E501
_query_params.append(('resolution', _params['resolution']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = [] # noqa: E501
_response_types_map = {
'200': "List[Renewable]",
'400': None,
'404': None,
'500': None,
}
return self.api_client.call_api(
'/state/{state}/renewables/current', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def get_prices(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching prices for. Can be found using the `/sites` endpoint")], start_date : Annotated[Optional[date], Field(description="Return all prices for each interval on and after this day. Defaults to today.")] = None, end_date : Annotated[Optional[date], Field(description="Return all prices for each interval on and before this day. Defaults to today.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 5, 30. Default: 30")] = None, **kwargs) -> List[Interval]: # noqa: E501
"""get_prices # noqa: E501
Returns all the prices between the start and end dates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_prices(site_id, start_date, end_date, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching prices for. Can be found using the `/sites` endpoint (required)
:type site_id: str
:param start_date: Return all prices for each interval on and after this day. Defaults to today.
:type start_date: date
:param end_date: Return all prices for each interval on and before this day. Defaults to today.
:type end_date: date
:param resolution: Specify the required interval duration resolution. Valid options: 5, 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: timeout setting for this request.
If one number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: List[Interval]
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_prices_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
return self.get_prices_with_http_info(site_id, start_date, end_date, resolution, **kwargs) # noqa: E501
@validate_arguments
def get_prices_with_http_info(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching prices for. Can be found using the `/sites` endpoint")], start_date : Annotated[Optional[date], Field(description="Return all prices for each interval on and after this day. Defaults to today.")] = None, end_date : Annotated[Optional[date], Field(description="Return all prices for each interval on and before this day. Defaults to today.")] = None, resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 5, 30. Default: 30")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""get_prices # noqa: E501
Returns all the prices between the start and end dates # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_prices_with_http_info(site_id, start_date, end_date, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching prices for. Can be found using the `/sites` endpoint (required)
:type site_id: str
:param start_date: Return all prices for each interval on and after this day. Defaults to today.
:type start_date: date
:param end_date: Return all prices for each interval on and before this day. Defaults to today.
:type end_date: date
:param resolution: Specify the required interval duration resolution. Valid options: 5, 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[Interval], status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'site_id',
'start_date',
'end_date',
'resolution'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_prices" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['site_id'] is not None:
_path_params['siteId'] = _params['site_id']
# process the query parameters
_query_params = []
if _params.get('start_date') is not None: # noqa: E501
if isinstance(_params['start_date'], date):
_query_params.append(('startDate', _params['start_date'].strftime(self.api_client.configuration.date_format)))
else:
_query_params.append(('startDate', _params['start_date']))
if _params.get('end_date') is not None: # noqa: E501
if isinstance(_params['end_date'], date):
_query_params.append(('endDate', _params['end_date'].strftime(self.api_client.configuration.date_format)))
else:
_query_params.append(('endDate', _params['end_date']))
if _params.get('resolution') is not None: # noqa: E501
_query_params.append(('resolution', _params['resolution']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['apiKey'] # noqa: E501
_response_types_map = {
'200': "List[Interval]",
'400': None,
'401': None,
'404': None,
'500': None,
}
return self.api_client.call_api(
'/sites/{siteId}/prices', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def get_sites(self, **kwargs) -> List[Site]: # noqa: E501
"""get_sites # noqa: E501
Return all sites linked to your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sites(async_req=True)
>>> result = thread.get()
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: timeout setting for this request.
If one number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: List[Site]
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_sites_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
return self.get_sites_with_http_info(**kwargs) # noqa: E501
@validate_arguments
def get_sites_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501
"""get_sites # noqa: E501
Return all sites linked to your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_sites_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[Site], status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_sites" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['apiKey'] # noqa: E501
_response_types_map = {
'200': "List[Site]",
'401': None,
'500': None,
}
return self.api_client.call_api(
'/sites', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@validate_arguments
def get_usage(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching usage for. Can be found using the `/sites` enpoint")], start_date : Annotated[date, Field(..., description="Return all usage for each interval on and after this day.")], end_date : Annotated[date, Field(..., description="Return all usage for each interval on and before this day.")], resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 30. Default: 30")] = None, **kwargs) -> List[Usage]: # noqa: E501
"""get_usage # noqa: E501
Returns all usage data between the start and end dates. The API can only return 90-days worth of data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_usage(site_id, start_date, end_date, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching usage for. Can be found using the `/sites` enpoint (required)
:type site_id: str
:param start_date: Return all usage for each interval on and after this day. (required)
:type start_date: date
:param end_date: Return all usage for each interval on and before this day. (required)
:type end_date: date
:param resolution: Specify the required interval duration resolution. Valid options: 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: timeout setting for this request.
If one number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: List[Usage]
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_usage_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
return self.get_usage_with_http_info(site_id, start_date, end_date, resolution, **kwargs) # noqa: E501
@validate_arguments
def get_usage_with_http_info(self, site_id : Annotated[StrictStr, Field(..., description="ID of the site you are fetching usage for. Can be found using the `/sites` enpoint")], start_date : Annotated[date, Field(..., description="Return all usage for each interval on and after this day.")], end_date : Annotated[date, Field(..., description="Return all usage for each interval on and before this day.")], resolution : Annotated[Optional[StrictInt], Field(description="Specify the required interval duration resolution. Valid options: 30. Default: 30")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""get_usage # noqa: E501
Returns all usage data between the start and end dates. The API can only return 90-days worth of data. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_usage_with_http_info(site_id, start_date, end_date, resolution, async_req=True)
>>> result = thread.get()
:param site_id: ID of the site you are fetching usage for. Can be found using the `/sites` enpoint (required)
:type site_id: str
:param start_date: Return all usage for each interval on and after this day. (required)
:type start_date: date
:param end_date: Return all usage for each interval on and before this day. (required)
:type end_date: date
:param resolution: Specify the required interval duration resolution. Valid options: 30. Default: 30
:type resolution: int
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(List[Usage], status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'site_id',
'start_date',
'end_date',
'resolution'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_usage" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['site_id'] is not None:
_path_params['siteId'] = _params['site_id']
# process the query parameters
_query_params = []
if _params.get('start_date') is not None: # noqa: E501
if isinstance(_params['start_date'], date):
_query_params.append(('startDate', _params['start_date'].strftime(self.api_client.configuration.date_format)))
else:
_query_params.append(('startDate', _params['start_date']))
if _params.get('end_date') is not None: # noqa: E501
if isinstance(_params['end_date'], date):
_query_params.append(('endDate', _params['end_date'].strftime(self.api_client.configuration.date_format)))
else:
_query_params.append(('endDate', _params['end_date']))
if _params.get('resolution') is not None: # noqa: E501
_query_params.append(('resolution', _params['resolution']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['application/json']) # noqa: E501
# authentication setting
_auth_settings = ['apiKey'] # noqa: E501
_response_types_map = {
'200': "List[Usage]",
'400': None,
'401': None,
'404': None,
'500': None,
}
return self.api_client.call_api(
'/sites/{siteId}/usage', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
|