# energyatit
Multi-tenant energy platform — carbon attestation, demand response, compliance, and grid intelligence.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.12.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://energyatit.com](https://energyatit.com)

## Requirements.

Python 3.8+

## 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 energyatit
```

### 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 energyatit
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import energyatit
from energyatit.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://energyatit.com
# See configuration.py for a list of all supported configuration parameters.
configuration = energyatit.Configuration(
    host = "https://energyatit.com"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Configure Bearer authorization (JWT): BearerAuth
configuration = energyatit.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with energyatit.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = energyatit.APIKeysApi(api_client)

    try:
        # List API keys
        api_response = api_instance.api_v1_api_keys_get()
        print("The response of APIKeysApi->api_v1_api_keys_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->api_v1_api_keys_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://energyatit.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeysApi* | [**api_v1_api_keys_get**](docs/APIKeysApi.md#api_v1_api_keys_get) | **GET** /api/v1/api-keys | List API keys
*APIKeysApi* | [**api_v1_api_keys_id_delete**](docs/APIKeysApi.md#api_v1_api_keys_id_delete) | **DELETE** /api/v1/api-keys/{id} | Revoke API key
*APIKeysApi* | [**api_v1_api_keys_post**](docs/APIKeysApi.md#api_v1_api_keys_post) | **POST** /api/v1/api-keys | Generate API key
*AuthenticationApi* | [**api_auth_login_post**](docs/AuthenticationApi.md#api_auth_login_post) | **POST** /api/auth/login | Login
*AuthenticationApi* | [**api_auth_me_get**](docs/AuthenticationApi.md#api_auth_me_get) | **GET** /api/auth/me | Current user profile
*AuthenticationApi* | [**api_auth_refresh_post**](docs/AuthenticationApi.md#api_auth_refresh_post) | **POST** /api/auth/refresh | Refresh token
*AuthenticationApi* | [**api_auth_register_post**](docs/AuthenticationApi.md#api_auth_register_post) | **POST** /api/auth/register | Register a new user
*CarbonAttestationApi* | [**api_v1_carbon_certificate_facility_id_get**](docs/CarbonAttestationApi.md#api_v1_carbon_certificate_facility_id_get) | **GET** /api/v1/carbon/certificate/{facilityId} | Generate certificate
*CarbonAttestationApi* | [**api_v1_carbon_record_post**](docs/CarbonAttestationApi.md#api_v1_carbon_record_post) | **POST** /api/v1/carbon/record | Create carbon record
*CarbonAttestationApi* | [**api_v1_carbon_records_facility_id_get**](docs/CarbonAttestationApi.md#api_v1_carbon_records_facility_id_get) | **GET** /api/v1/carbon/records/{facilityId} | List carbon records
*CarbonAttestationApi* | [**api_v1_carbon_summary_facility_id_get**](docs/CarbonAttestationApi.md#api_v1_carbon_summary_facility_id_get) | **GET** /api/v1/carbon/summary/{facilityId} | Carbon summary
*CarbonAttestationApi* | [**api_v1_carbon_verify_meter_id_get**](docs/CarbonAttestationApi.md#api_v1_carbon_verify_meter_id_get) | **GET** /api/v1/carbon/verify/{meterId} | Verify hash chain
*ComplianceApi* | [**api_v1_comply_report_post**](docs/ComplianceApi.md#api_v1_comply_report_post) | **POST** /api/v1/comply/report | Generate Scope 2 report
*ComplianceApi* | [**api_v1_comply_site_id_generate_post**](docs/ComplianceApi.md#api_v1_comply_site_id_generate_post) | **POST** /api/v1/comply/{siteId}/generate | Generate compliance package
*ComplianceApi* | [**api_v1_comply_site_id_packages_get**](docs/ComplianceApi.md#api_v1_comply_site_id_packages_get) | **GET** /api/v1/comply/{siteId}/packages | List compliance packages
*ComplianceApi* | [**api_v1_comply_standards_get**](docs/ComplianceApi.md#api_v1_comply_standards_get) | **GET** /api/v1/comply/standards | List supported standards
*DemandResponseApi* | [**api_v1_dr_events_active_get**](docs/DemandResponseApi.md#api_v1_dr_events_active_get) | **GET** /api/v1/dr/events/active | Active DR events
*DemandResponseApi* | [**api_v1_dr_events_event_id_dispatch_post**](docs/DemandResponseApi.md#api_v1_dr_events_event_id_dispatch_post) | **POST** /api/v1/dr/events/{eventId}/dispatch | Execute DR dispatch
*DemandResponseApi* | [**api_v1_dr_events_event_id_get**](docs/DemandResponseApi.md#api_v1_dr_events_event_id_get) | **GET** /api/v1/dr/events/{eventId} | Get DR event
*DemandResponseApi* | [**api_v1_dr_events_event_id_measure_post**](docs/DemandResponseApi.md#api_v1_dr_events_event_id_measure_post) | **POST** /api/v1/dr/events/{eventId}/measure | Trigger M&amp;V
*DemandResponseApi* | [**api_v1_dr_events_event_id_settle_post**](docs/DemandResponseApi.md#api_v1_dr_events_event_id_settle_post) | **POST** /api/v1/dr/events/{eventId}/settle | Settle DR event
*DemandResponseApi* | [**api_v1_dr_events_event_id_status_patch**](docs/DemandResponseApi.md#api_v1_dr_events_event_id_status_patch) | **PATCH** /api/v1/dr/events/{eventId}/status | Update DR event status
*DemandResponseApi* | [**api_v1_dr_events_get**](docs/DemandResponseApi.md#api_v1_dr_events_get) | **GET** /api/v1/dr/events | List DR events
*DemandResponseApi* | [**api_v1_dr_events_post**](docs/DemandResponseApi.md#api_v1_dr_events_post) | **POST** /api/v1/dr/events | Create DR event
*DemandResponseApi* | [**api_v1_dr_summary_facility_id_get**](docs/DemandResponseApi.md#api_v1_dr_summary_facility_id_get) | **GET** /api/v1/dr/summary/{facilityId} | DR summary
*DeveloperApi* | [**api_v1_developer_examples_language_get**](docs/DeveloperApi.md#api_v1_developer_examples_language_get) | **GET** /api/v1/developer/examples/{language} | Code examples
*DeveloperApi* | [**api_v1_developer_openapi_json_get**](docs/DeveloperApi.md#api_v1_developer_openapi_json_get) | **GET** /api/v1/developer/openapi.json | OpenAPI spec
*DeveloperApi* | [**api_v1_developer_quickstart_get**](docs/DeveloperApi.md#api_v1_developer_quickstart_get) | **GET** /api/v1/developer/quickstart | Quickstart guide
*IntelApi* | [**api_v1_intel_assets_id_score_get**](docs/IntelApi.md#api_v1_intel_assets_id_score_get) | **GET** /api/v1/intel/assets/{id}/score | Asset reliability score
*IntelApi* | [**api_v1_intel_fleet_fleet_id_get**](docs/IntelApi.md#api_v1_intel_fleet_fleet_id_get) | **GET** /api/v1/intel/fleet/{fleetId} | Fleet intelligence
*IntelApi* | [**api_v1_intel_grid_region_capacity_get**](docs/IntelApi.md#api_v1_intel_grid_region_capacity_get) | **GET** /api/v1/intel/grid/{region}/capacity | Grid capacity
*IntelApi* | [**api_v1_intel_grid_region_trends_get**](docs/IntelApi.md#api_v1_intel_grid_region_trends_get) | **GET** /api/v1/intel/grid/{region}/trends | Grid trends
*IntelApi* | [**api_v1_intel_sites_id_score_get**](docs/IntelApi.md#api_v1_intel_sites_id_score_get) | **GET** /api/v1/intel/sites/{id}/score | Site reliability score
*SettlementApi* | [**api_v1_settlements_settlement_id_verify_get**](docs/SettlementApi.md#api_v1_settlements_settlement_id_verify_get) | **GET** /api/v1/settlements/{settlementId}/verify | Verify settlement
*SettlementApi* | [**api_v1_settlements_site_id_carbon_attestation_get**](docs/SettlementApi.md#api_v1_settlements_site_id_carbon_attestation_get) | **GET** /api/v1/settlements/{siteId}/carbon-attestation | Carbon attestation for site
*SettlementApi* | [**api_v1_settlements_site_id_generate_get**](docs/SettlementApi.md#api_v1_settlements_site_id_generate_get) | **GET** /api/v1/settlements/{siteId}/generate | Generate settlement
*TenantsApi* | [**api_v1_tenants_get**](docs/TenantsApi.md#api_v1_tenants_get) | **GET** /api/v1/tenants | List my tenants
*TenantsApi* | [**api_v1_tenants_id_get**](docs/TenantsApi.md#api_v1_tenants_id_get) | **GET** /api/v1/tenants/{id} | Get tenant
*TenantsApi* | [**api_v1_tenants_id_members_get**](docs/TenantsApi.md#api_v1_tenants_id_members_get) | **GET** /api/v1/tenants/{id}/members | List members
*TenantsApi* | [**api_v1_tenants_id_members_post**](docs/TenantsApi.md#api_v1_tenants_id_members_post) | **POST** /api/v1/tenants/{id}/members | Add member
*TenantsApi* | [**api_v1_tenants_id_members_user_id_delete**](docs/TenantsApi.md#api_v1_tenants_id_members_user_id_delete) | **DELETE** /api/v1/tenants/{id}/members/{userId} | Remove member
*TenantsApi* | [**api_v1_tenants_id_patch**](docs/TenantsApi.md#api_v1_tenants_id_patch) | **PATCH** /api/v1/tenants/{id} | Update tenant
*TenantsApi* | [**api_v1_tenants_post**](docs/TenantsApi.md#api_v1_tenants_post) | **POST** /api/v1/tenants | Create tenant


## Documentation For Models

 - [ApiAuthLoginPost200Response](docs/ApiAuthLoginPost200Response.md)
 - [ApiAuthLoginPostRequest](docs/ApiAuthLoginPostRequest.md)
 - [ApiAuthRefreshPostRequest](docs/ApiAuthRefreshPostRequest.md)
 - [ApiAuthRegisterPost201Response](docs/ApiAuthRegisterPost201Response.md)
 - [ApiAuthRegisterPost201ResponseData](docs/ApiAuthRegisterPost201ResponseData.md)
 - [ApiAuthRegisterPost400Response](docs/ApiAuthRegisterPost400Response.md)
 - [ApiAuthRegisterPostRequest](docs/ApiAuthRegisterPostRequest.md)
 - [ApiV1ApiKeysPostRequest](docs/ApiV1ApiKeysPostRequest.md)
 - [ApiV1CarbonRecordPostRequest](docs/ApiV1CarbonRecordPostRequest.md)
 - [ApiV1ComplyReportPostRequest](docs/ApiV1ComplyReportPostRequest.md)
 - [ApiV1ComplySiteIdGeneratePostRequest](docs/ApiV1ComplySiteIdGeneratePostRequest.md)
 - [ApiV1DrEventsEventIdStatusPatchRequest](docs/ApiV1DrEventsEventIdStatusPatchRequest.md)
 - [ApiV1DrEventsPostRequest](docs/ApiV1DrEventsPostRequest.md)
 - [ApiV1TenantsIdMembersPostRequest](docs/ApiV1TenantsIdMembersPostRequest.md)
 - [ApiV1TenantsIdPatchRequest](docs/ApiV1TenantsIdPatchRequest.md)
 - [ApiV1TenantsPostRequest](docs/ApiV1TenantsPostRequest.md)
 - [CarbonRecord](docs/CarbonRecord.md)
 - [DrEvent](docs/DrEvent.md)
 - [Error](docs/Error.md)
 - [Tenant](docs/Tenant.md)
 - [User](docs/User.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication (JWT)

<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




