Code Monkey home page Code Monkey logo

givenergy_api_python_client's Introduction

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 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:

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:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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 GET /account-children/{user_id} Get Account Children Information by ID
AccountApi get_account_dongles_by_id GET /account/{user_username}/devices Get Account Dongles by ID
AccountApi get_account_information_by_id GET /account/{user_id} Get Account Information by ID
AccountApi get_account_information_by_username GET /account/search/{user_username} Get Account Information by Username
AccountApi get_your_account_children_information GET /account-children Get Your Account Children Information
AccountApi get_your_account_information GET /account Get Your Account Information
CommunicationDeviceApi get_communication_device_information_by_serial_number GET /communication-device/{communicationDevice_serial_number} Get Communication Device Information by Serial Number
EVChargerApi evget_data_points GET /ev-charger/{charger_uuid}/meter-data Get Data Points
EVChargerApi get_charging_sessions GET /ev-charger/{charger_uuid}/charging-sessions Get Charging Sessions
EVChargerApi get_command_data GET /ev-charger/{charger_uuid}/commands/{command_id} Get Command Data
EVChargerApi get_ev_charger_by_uuid GET /ev-charger/{charger_uuid} Get EV Charger by UUID
EVChargerApi get_supported_commands GET /ev-charger/{charger_uuid}/commands Get Supported Commands
EVChargerApi get_your_ev_chargers GET /ev-charger Get Your EV Chargers
EVChargerApi send_command POST /ev-charger/{charger_uuid}/commands/{command_id} Send Command
EnergyFlowDataApi get_energy_flow_data POST /inverter/{inverter_serial_number}/energy-flows Get Energy Flow Data
InverterControlApi get_setting_presets GET /inverter/{inverter_serial_number}/presets Get Setting Presets
InverterControlApi get_settings_list GET /inverter/{inverter_serial_number}/settings Get Settings List
InverterControlApi modify_preset POST /inverter/{inverter_serial_number}/presets/{preset} Modify Preset
InverterControlApi modify_setting POST /inverter/{inverter_serial_number}/settings/{setting_id}/write Modify Setting
InverterControlApi modify_setting_multiple POST /multi-control/write Modify Setting (Multiple)
InverterControlApi read_setting POST /inverter/{inverter_serial_number}/settings/{setting_id}/read Read Setting
InverterControlApi read_setting_multiple POST /multi-control/read Read Setting (Multiple)
InverterDataApi get_data_points GET /inverter/{inverter_serial_number}/data-points/{date} Get Data Points
InverterDataApi get_events GET /inverter/{inverter_serial_number}/events Get Events
InverterDataApi get_latest_meter_data GET /inverter/{inverter_serial_number}/meter-data/latest Get Latest Meter Data
InverterDataApi get_latest_system_data GET /inverter/{inverter_serial_number}/system-data/latest Get Latest System Data
SmartDeviceApi create_smart_device_data_point POST /smart-device/{smartDevice_uuid}/data Create Smart Device Data Point
SmartDeviceApi get_smart_device_by_id GET /smart-device/{smartDevice_uuid} Get Smart Device by ID
SmartDeviceApi get_smart_device_data_points_by_id GET /smart-device/{smartDevice_uuid}/data Get Smart Device Data Points by ID

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

default

  • Type: Bearer authentication

Author

givenergy_api_python_client's People

Contributors

magicmonkey avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.