https://github.com/magicmonkey/givenergy_api_python_client
https://github.com/magicmonkey/givenergy_api_python_client
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/magicmonkey/givenergy_api_python_client
- Owner: magicmonkey
- Created: 2023-11-07T21:29:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-08T22:51:53.000Z (over 2 years ago)
- Last Synced: 2025-01-26T12:27:56.446Z (about 1 year ago)
- Language: Python
- Size: 167 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.6
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import openapi_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.givenergy.cloud/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.givenergy.cloud/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: default
configuration = openapi_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.AccountApi(api_client)
user_id = '1234' # str | The ID of the user.
page = 1 # int | Page number to return (optional)
page_size = 56 # int | Number of items to return in a page. Defaults to 15 (optional)
authorization = 'Bearer {YOUR_API_KEY}' # str | (optional)
try:
# Get Account Children Information by ID
api_response = api_instance.get_account_children_information_by_id(user_id, page=page, page_size=page_size, authorization=authorization)
print("The response of AccountApi->get_account_children_information_by_id:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AccountApi->get_account_children_information_by_id: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.givenergy.cloud/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**get_account_children_information_by_id**](docs/AccountApi.md#get_account_children_information_by_id) | **GET** /account-children/{user_id} | Get Account Children Information by ID
*AccountApi* | [**get_account_dongles_by_id**](docs/AccountApi.md#get_account_dongles_by_id) | **GET** /account/{user_username}/devices | Get Account Dongles by ID
*AccountApi* | [**get_account_information_by_id**](docs/AccountApi.md#get_account_information_by_id) | **GET** /account/{user_id} | Get Account Information by ID
*AccountApi* | [**get_account_information_by_username**](docs/AccountApi.md#get_account_information_by_username) | **GET** /account/search/{user_username} | Get Account Information by Username
*AccountApi* | [**get_your_account_children_information**](docs/AccountApi.md#get_your_account_children_information) | **GET** /account-children | Get Your Account Children Information
*AccountApi* | [**get_your_account_information**](docs/AccountApi.md#get_your_account_information) | **GET** /account | Get Your Account Information
*CommunicationDeviceApi* | [**get_communication_device_information_by_serial_number**](docs/CommunicationDeviceApi.md#get_communication_device_information_by_serial_number) | **GET** /communication-device/{communicationDevice_serial_number} | Get Communication Device Information by Serial Number
*EVChargerApi* | [**evget_data_points**](docs/EVChargerApi.md#evget_data_points) | **GET** /ev-charger/{charger_uuid}/meter-data | Get Data Points
*EVChargerApi* | [**get_charging_sessions**](docs/EVChargerApi.md#get_charging_sessions) | **GET** /ev-charger/{charger_uuid}/charging-sessions | Get Charging Sessions
*EVChargerApi* | [**get_command_data**](docs/EVChargerApi.md#get_command_data) | **GET** /ev-charger/{charger_uuid}/commands/{command_id} | Get Command Data
*EVChargerApi* | [**get_ev_charger_by_uuid**](docs/EVChargerApi.md#get_ev_charger_by_uuid) | **GET** /ev-charger/{charger_uuid} | Get EV Charger by UUID
*EVChargerApi* | [**get_supported_commands**](docs/EVChargerApi.md#get_supported_commands) | **GET** /ev-charger/{charger_uuid}/commands | Get Supported Commands
*EVChargerApi* | [**get_your_ev_chargers**](docs/EVChargerApi.md#get_your_ev_chargers) | **GET** /ev-charger | Get Your EV Chargers
*EVChargerApi* | [**send_command**](docs/EVChargerApi.md#send_command) | **POST** /ev-charger/{charger_uuid}/commands/{command_id} | Send Command
*EnergyFlowDataApi* | [**get_energy_flow_data**](docs/EnergyFlowDataApi.md#get_energy_flow_data) | **POST** /inverter/{inverter_serial_number}/energy-flows | Get Energy Flow Data
*InverterControlApi* | [**get_setting_presets**](docs/InverterControlApi.md#get_setting_presets) | **GET** /inverter/{inverter_serial_number}/presets | Get Setting Presets
*InverterControlApi* | [**get_settings_list**](docs/InverterControlApi.md#get_settings_list) | **GET** /inverter/{inverter_serial_number}/settings | Get Settings List
*InverterControlApi* | [**modify_preset**](docs/InverterControlApi.md#modify_preset) | **POST** /inverter/{inverter_serial_number}/presets/{preset} | Modify Preset
*InverterControlApi* | [**modify_setting**](docs/InverterControlApi.md#modify_setting) | **POST** /inverter/{inverter_serial_number}/settings/{setting_id}/write | Modify Setting
*InverterControlApi* | [**modify_setting_multiple**](docs/InverterControlApi.md#modify_setting_multiple) | **POST** /multi-control/write | Modify Setting (Multiple)
*InverterControlApi* | [**read_setting**](docs/InverterControlApi.md#read_setting) | **POST** /inverter/{inverter_serial_number}/settings/{setting_id}/read | Read Setting
*InverterControlApi* | [**read_setting_multiple**](docs/InverterControlApi.md#read_setting_multiple) | **POST** /multi-control/read | Read Setting (Multiple)
*InverterDataApi* | [**get_data_points**](docs/InverterDataApi.md#get_data_points) | **GET** /inverter/{inverter_serial_number}/data-points/{date} | Get Data Points
*InverterDataApi* | [**get_events**](docs/InverterDataApi.md#get_events) | **GET** /inverter/{inverter_serial_number}/events | Get Events
*InverterDataApi* | [**get_latest_meter_data**](docs/InverterDataApi.md#get_latest_meter_data) | **GET** /inverter/{inverter_serial_number}/meter-data/latest | Get Latest Meter Data
*InverterDataApi* | [**get_latest_system_data**](docs/InverterDataApi.md#get_latest_system_data) | **GET** /inverter/{inverter_serial_number}/system-data/latest | Get Latest System Data
*SmartDeviceApi* | [**create_smart_device_data_point**](docs/SmartDeviceApi.md#create_smart_device_data_point) | **POST** /smart-device/{smartDevice_uuid}/data | Create Smart Device Data Point
*SmartDeviceApi* | [**get_smart_device_by_id**](docs/SmartDeviceApi.md#get_smart_device_by_id) | **GET** /smart-device/{smartDevice_uuid} | Get Smart Device by ID
*SmartDeviceApi* | [**get_smart_device_data_points_by_id**](docs/SmartDeviceApi.md#get_smart_device_data_points_by_id) | **GET** /smart-device/{smartDevice_uuid}/data | Get Smart Device Data Points by ID
## Documentation For Models
- [CreateSmartDeviceDataPoint200Response](docs/CreateSmartDeviceDataPoint200Response.md)
- [CreateSmartDeviceDataPoint200ResponseDataInner](docs/CreateSmartDeviceDataPoint200ResponseDataInner.md)
- [CreateSmartDeviceDataPointRequest](docs/CreateSmartDeviceDataPointRequest.md)
- [EvgetDataPoints200Response](docs/EvgetDataPoints200Response.md)
- [EvgetDataPoints200ResponseDataInner](docs/EvgetDataPoints200ResponseDataInner.md)
- [EvgetDataPoints200ResponseDataInnerMeasurementsInner](docs/EvgetDataPoints200ResponseDataInnerMeasurementsInner.md)
- [GetAccountChildrenInformationByID200Response](docs/GetAccountChildrenInformationByID200Response.md)
- [GetAccountChildrenInformationByID200ResponseDataInner](docs/GetAccountChildrenInformationByID200ResponseDataInner.md)
- [GetAccountDonglesByID200Response](docs/GetAccountDonglesByID200Response.md)
- [GetAccountDonglesByID200ResponseDataInner](docs/GetAccountDonglesByID200ResponseDataInner.md)
- [GetAccountDonglesByID200ResponseDataInnerInverter](docs/GetAccountDonglesByID200ResponseDataInnerInverter.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterConnections](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnections.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInner](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInner.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInnerCapacity](docs/GetAccountDonglesByID200ResponseDataInnerInverterConnectionsBatteriesInnerCapacity.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterFirmwareVersion](docs/GetAccountDonglesByID200ResponseDataInnerInverterFirmwareVersion.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterInfo](docs/GetAccountDonglesByID200ResponseDataInnerInverterInfo.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterInfoBattery](docs/GetAccountDonglesByID200ResponseDataInnerInverterInfoBattery.md)
- [GetAccountDonglesByID200ResponseDataInnerInverterWarranty](docs/GetAccountDonglesByID200ResponseDataInnerInverterWarranty.md)
- [GetAccountInformationByID200Response](docs/GetAccountInformationByID200Response.md)
- [GetAccountInformationByID200ResponseData](docs/GetAccountInformationByID200ResponseData.md)
- [GetAccountInformationByUsername200Response](docs/GetAccountInformationByUsername200Response.md)
- [GetAccountInformationByUsername200ResponseData](docs/GetAccountInformationByUsername200ResponseData.md)
- [GetChargingSessions200Response](docs/GetChargingSessions200Response.md)
- [GetChargingSessions200ResponseDataInner](docs/GetChargingSessions200ResponseDataInner.md)
- [GetChargingSessionsRequest](docs/GetChargingSessionsRequest.md)
- [GetCommandData200Response](docs/GetCommandData200Response.md)
- [GetCommandData200ResponseData](docs/GetCommandData200ResponseData.md)
- [GetCommunicationDeviceInformationBySerialNumber200Response](docs/GetCommunicationDeviceInformationBySerialNumber200Response.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseData](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseData.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverter](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverter.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnections](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnections.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInner](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInner.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInnerCapacity](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterConnectionsBatteriesInnerCapacity.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterFirmwareVersion](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterFirmwareVersion.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfo](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfo.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfoBattery](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterInfoBattery.md)
- [GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterWarranty](docs/GetCommunicationDeviceInformationBySerialNumber200ResponseDataInverterWarranty.md)
- [GetDataPoints200Response](docs/GetDataPoints200Response.md)
- [GetDataPoints200ResponseDataInner](docs/GetDataPoints200ResponseDataInner.md)
- [GetDataPoints200ResponseDataInnerPower](docs/GetDataPoints200ResponseDataInnerPower.md)
- [GetDataPoints200ResponseDataInnerPowerBattery](docs/GetDataPoints200ResponseDataInnerPowerBattery.md)
- [GetDataPoints200ResponseDataInnerPowerConsumption](docs/GetDataPoints200ResponseDataInnerPowerConsumption.md)
- [GetDataPoints200ResponseDataInnerPowerGrid](docs/GetDataPoints200ResponseDataInnerPowerGrid.md)
- [GetDataPoints200ResponseDataInnerPowerInverter](docs/GetDataPoints200ResponseDataInnerPowerInverter.md)
- [GetDataPoints200ResponseDataInnerPowerSolar](docs/GetDataPoints200ResponseDataInnerPowerSolar.md)
- [GetDataPoints200ResponseDataInnerPowerSolarArraysInner](docs/GetDataPoints200ResponseDataInnerPowerSolarArraysInner.md)
- [GetDataPoints200ResponseDataInnerToday](docs/GetDataPoints200ResponseDataInnerToday.md)
- [GetDataPoints200ResponseDataInnerTodayBattery](docs/GetDataPoints200ResponseDataInnerTodayBattery.md)
- [GetDataPoints200ResponseDataInnerTodayGrid](docs/GetDataPoints200ResponseDataInnerTodayGrid.md)
- [GetDataPoints200ResponseDataInnerTotal](docs/GetDataPoints200ResponseDataInnerTotal.md)
- [GetDataPoints200ResponseDataInnerTotalBattery](docs/GetDataPoints200ResponseDataInnerTotalBattery.md)
- [GetDataPoints200ResponseDataInnerTotalGrid](docs/GetDataPoints200ResponseDataInnerTotalGrid.md)
- [GetEVChargerByUUID200Response](docs/GetEVChargerByUUID200Response.md)
- [GetEVChargerByUUID200ResponseData](docs/GetEVChargerByUUID200ResponseData.md)
- [GetEnergyFlowDataRequest](docs/GetEnergyFlowDataRequest.md)
- [GetEvents200Response](docs/GetEvents200Response.md)
- [GetEvents200ResponseDataInner](docs/GetEvents200ResponseDataInner.md)
- [GetEventsRequest](docs/GetEventsRequest.md)
- [GetLatestMeterData200Response](docs/GetLatestMeterData200Response.md)
- [GetLatestMeterData200ResponseData](docs/GetLatestMeterData200ResponseData.md)
- [GetLatestMeterData200ResponseDataToday](docs/GetLatestMeterData200ResponseDataToday.md)
- [GetLatestMeterData200ResponseDataTodayBattery](docs/GetLatestMeterData200ResponseDataTodayBattery.md)
- [GetLatestMeterData200ResponseDataTodayGrid](docs/GetLatestMeterData200ResponseDataTodayGrid.md)
- [GetLatestMeterData200ResponseDataTotal](docs/GetLatestMeterData200ResponseDataTotal.md)
- [GetLatestMeterData200ResponseDataTotalBattery](docs/GetLatestMeterData200ResponseDataTotalBattery.md)
- [GetLatestMeterData200ResponseDataTotalGrid](docs/GetLatestMeterData200ResponseDataTotalGrid.md)
- [GetLatestSystemData200Response](docs/GetLatestSystemData200Response.md)
- [GetLatestSystemData200ResponseData](docs/GetLatestSystemData200ResponseData.md)
- [GetLatestSystemData200ResponseDataBattery](docs/GetLatestSystemData200ResponseDataBattery.md)
- [GetLatestSystemData200ResponseDataGrid](docs/GetLatestSystemData200ResponseDataGrid.md)
- [GetLatestSystemData200ResponseDataInverter](docs/GetLatestSystemData200ResponseDataInverter.md)
- [GetLatestSystemData200ResponseDataSolar](docs/GetLatestSystemData200ResponseDataSolar.md)
- [GetLatestSystemData200ResponseDataSolarArraysInner](docs/GetLatestSystemData200ResponseDataSolarArraysInner.md)
- [GetSettingsList200Response](docs/GetSettingsList200Response.md)
- [GetSettingsList200ResponseDataInner](docs/GetSettingsList200ResponseDataInner.md)
- [GetSmartDeviceByID200Response](docs/GetSmartDeviceByID200Response.md)
- [GetSmartDeviceByID200ResponseDataInner](docs/GetSmartDeviceByID200ResponseDataInner.md)
- [GetSmartDeviceByID200ResponseDataInnerOtherData](docs/GetSmartDeviceByID200ResponseDataInnerOtherData.md)
- [GetSmartDeviceDataPointsByID200Response](docs/GetSmartDeviceDataPointsByID200Response.md)
- [GetSmartDeviceDataPointsByID200ResponseDataInner](docs/GetSmartDeviceDataPointsByID200ResponseDataInner.md)
- [GetSupportedCommands200Response](docs/GetSupportedCommands200Response.md)
- [GetYourAccountChildrenInformation200Response](docs/GetYourAccountChildrenInformation200Response.md)
- [GetYourAccountChildrenInformation200ResponseDataInner](docs/GetYourAccountChildrenInformation200ResponseDataInner.md)
- [GetYourAccountInformation200Response](docs/GetYourAccountInformation200Response.md)
- [GetYourAccountInformation200ResponseData](docs/GetYourAccountInformation200ResponseData.md)
- [GetYourEVChargers200Response](docs/GetYourEVChargers200Response.md)
- [GetYourEVChargers200ResponseDataInner](docs/GetYourEVChargers200ResponseDataInner.md)
- [ModifyPreset200Response](docs/ModifyPreset200Response.md)
- [ModifyPreset200ResponseData](docs/ModifyPreset200ResponseData.md)
- [ModifySetting200Response](docs/ModifySetting200Response.md)
- [ModifySetting200ResponseData](docs/ModifySetting200ResponseData.md)
- [ModifySettingMultipleRequest](docs/ModifySettingMultipleRequest.md)
- [ReadSetting200Response](docs/ReadSetting200Response.md)
- [ReadSetting200ResponseData](docs/ReadSetting200ResponseData.md)
- [ReadSettingMultipleRequest](docs/ReadSettingMultipleRequest.md)
- [SendCommand200Response](docs/SendCommand200Response.md)
- [SendCommand200ResponseData](docs/SendCommand200ResponseData.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### default
- **Type**: Bearer authentication
## Author