electric-coop-api 0.0.1

package/README.md

@@ -0,0 +1,619 @@
+# Generated SDK
+
+This folder contains the Speakeasy-generated TypeScript SDK.
+
+Regenerate with:
+
+```
+npm run sdk:generate
+```
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Electric Cooperative Consumer Portal API: Multi-tenant SaaS platform for Philippine electric cooperatives
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [Generated SDK](#generated-sdk)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [File uploads](#file-uploads)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+> [!TIP]
+> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
+
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add https://github.com/caninojories/electric-coop-api
+```
+
+### PNPM
+
+```bash
+pnpm add https://github.com/caninojories/electric-coop-api
+```
+
+### Bun
+
+```bash
+bun add https://github.com/caninojories/electric-coop-api
+```
+
+### Yarn
+
+```bash
+yarn add https://github.com/caninojories/electric-coop-api
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { SDK } from "electric-coop-api";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await sdk.auth.authControllerLogin({
+    email: "user@example.com",
+    password: "P@ssw0rd!",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name     | Type | Scheme      |
+| -------- | ---- | ----------- |
+| `bearer` | http | HTTP Bearer |
+
+To authenticate with the API the `bearer` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { SDK } from "electric-coop-api";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await sdk.auth.authControllerLogin({
+    email: "user@example.com",
+    password: "P@ssw0rd!",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [Admin](docs/sdks/admin/README.md)
+
+* [adminControllerGetDashboard](docs/sdks/admin/README.md#admincontrollergetdashboard) - Get admin dashboard summary
+
+### [AdminBills](docs/sdks/adminbills/README.md)
+
+* [adminBillsControllerFindAll](docs/sdks/adminbills/README.md#adminbillscontrollerfindall) - Get paginated bills (admin)
+* [adminBillsControllerCreate](docs/sdks/adminbills/README.md#adminbillscontrollercreate) - Create bill (admin)
+* [adminBillsControllerFindOne](docs/sdks/adminbills/README.md#adminbillscontrollerfindone) - Get bill by id (admin)
+* [adminBillsControllerUpdate](docs/sdks/adminbills/README.md#adminbillscontrollerupdate) - Update bill (admin)
+* [adminBillsControllerDelete](docs/sdks/adminbills/README.md#adminbillscontrollerdelete) - Delete bill (admin)
+* [adminBillsControllerImportCsv](docs/sdks/adminbills/README.md#adminbillscontrollerimportcsv) - Import bills from CSV (admin)
+
+### [AdminComplaints](docs/sdks/admincomplaints/README.md)
+
+* [adminComplaintsControllerFindAll](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerfindall) - Get complaints (admin)
+* [adminComplaintsControllerGetStats](docs/sdks/admincomplaints/README.md#admincomplaintscontrollergetstats) - Get complaint stats
+* [adminComplaintsControllerFindOne](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerfindone) - Get complaint by id (admin)
+* [adminComplaintsControllerUpdate](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerupdate) - Update complaint (admin)
+* [adminComplaintsControllerUpdateStatus](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerupdatestatus) - Update complaint status (admin)
+
+### [AdminConsumers](docs/sdks/adminconsumers/README.md)
+
+* [adminConsumersControllerCreate](docs/sdks/adminconsumers/README.md#adminconsumerscontrollercreate) - Create consumer
+* [adminConsumersControllerFindAll](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerfindall) - Get paginated consumers
+* [adminConsumersControllerGetUnbilledConsumers](docs/sdks/adminconsumers/README.md#adminconsumerscontrollergetunbilledconsumers) - Get unbilled consumers by billing period
+* [adminConsumersControllerFindOne](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerfindone) - Get consumer by id
+* [adminConsumersControllerUpdate](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerupdate) - Update consumer
+* [adminConsumersControllerRemove](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerremove) - Delete consumer
+
+### [AdminServiceRequests](docs/sdks/adminservicerequests/README.md)
+
+* [adminServiceRequestsControllerFindAll](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerfindall) - List service requests (admin)
+* [adminServiceRequestsControllerGetStats](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollergetstats) - Get service request stats
+* [adminServiceRequestsControllerFindOne](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerfindone) - Get service request by id (admin)
+* [adminServiceRequestsControllerUpdate](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerupdate) - Update service request (admin)
+
+### [Auth](docs/sdks/auth/README.md)
+
+* [authControllerLogin](docs/sdks/auth/README.md#authcontrollerlogin) - Login consumer user
+* [authControllerAdminLogin](docs/sdks/auth/README.md#authcontrolleradminlogin) - Login admin/staff user
+* [authControllerRefresh](docs/sdks/auth/README.md#authcontrollerrefresh) - Refresh access token
+* [authControllerLogout](docs/sdks/auth/README.md#authcontrollerlogout) - Logout current user
+* [authControllerRevokeUser](docs/sdks/auth/README.md#authcontrollerrevokeuser) - Revoke all tokens for a user (admin)
+* [authControllerRevokeTenant](docs/sdks/auth/README.md#authcontrollerrevoketenant) - Revoke all tokens for a tenant (admin)
+
+### [Bills](docs/sdks/bills/README.md)
+
+* [billsControllerFindAll](docs/sdks/bills/README.md#billscontrollerfindall) - Get paginated bills
+* [billsControllerCreate](docs/sdks/bills/README.md#billscontrollercreate) - Create bill
+* [billsControllerGetCurrent](docs/sdks/bills/README.md#billscontrollergetcurrent) - Get current bill
+* [billsControllerGetPaymentHistory](docs/sdks/bills/README.md#billscontrollergetpaymenthistory) - Get payment history
+* [billsControllerFindOne](docs/sdks/bills/README.md#billscontrollerfindone) - Get bill by id
+* [billsControllerCreateBulk](docs/sdks/bills/README.md#billscontrollercreatebulk) - Create bills in bulk
+* [billsControllerImportCsv](docs/sdks/bills/README.md#billscontrollerimportcsv) - Import bills from CSV
+* [billsControllerDownloadCsvTemplate](docs/sdks/bills/README.md#billscontrollerdownloadcsvtemplate) - Download CSV template
+* [billsControllerDownloadPdf](docs/sdks/bills/README.md#billscontrollerdownloadpdf) - Download bill PDF
+
+### [Complaints](docs/sdks/complaints/README.md)
+
+* [complaintsControllerCreate](docs/sdks/complaints/README.md#complaintscontrollercreate) - Create complaint
+* [complaintsControllerFindAll](docs/sdks/complaints/README.md#complaintscontrollerfindall) - List complaints
+* [complaintsControllerFindOne](docs/sdks/complaints/README.md#complaintscontrollerfindone) - Get complaint by id
+* [complaintsControllerUpdate](docs/sdks/complaints/README.md#complaintscontrollerupdate) - Update complaint
+
+### [ConsumerServiceRequests](docs/sdks/consumerservicerequests/README.md)
+
+* [consumerServiceRequestsControllerCreate](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollercreate) - Create service request (consumer)
+* [consumerServiceRequestsControllerFindAll](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollerfindall) - List service requests (consumer)
+* [consumerServiceRequestsControllerFindOne](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollerfindone) - Get service request by id (consumer)
+* [consumerServiceRequestsControllerCancel](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollercancel) - Cancel service request (consumer)
+
+### [Consumers](docs/sdks/consumers/README.md)
+
+* [consumersControllerGetProfile](docs/sdks/consumers/README.md#consumerscontrollergetprofile) - Get consumer profile
+* [consumersControllerGetAccounts](docs/sdks/consumers/README.md#consumerscontrollergetaccounts) - Get consumer accounts
+* [consumersControllerGetAccount](docs/sdks/consumers/README.md#consumerscontrollergetaccount) - Get consumer account by number
+
+### [Dashboard](docs/sdks/dashboard/README.md)
+
+* [dashboardControllerGetStats](docs/sdks/dashboard/README.md#dashboardcontrollergetstats) - Get dashboard stats
+
+### [Meters](docs/sdks/meters/README.md)
+
+* [metersControllerFindByMeterNumber](docs/sdks/meters/README.md#meterscontrollerfindbymeternumber) - Find consumer by meter number
+* [metersControllerGetReadingHistory](docs/sdks/meters/README.md#meterscontrollergetreadinghistory) - Get meter reading history
+
+### [Notifications](docs/sdks/notifications/README.md)
+
+* [notificationsControllerFindAll](docs/sdks/notifications/README.md#notificationscontrollerfindall) - List notifications
+* [notificationsControllerGetUnreadCount](docs/sdks/notifications/README.md#notificationscontrollergetunreadcount) - Get unread notification count
+* [notificationsControllerMarkAsRead](docs/sdks/notifications/README.md#notificationscontrollermarkasread) - Mark notification as read
+* [notificationsControllerMarkAllAsRead](docs/sdks/notifications/README.md#notificationscontrollermarkallasread) - Mark all notifications as read
+
+### [RateDisplay](docs/sdks/ratedisplay/README.md)
+
+* [rateDisplayControllerGetStructure](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetstructure) - Get rate display structure
+* [rateDisplayControllerUpdateStructure](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerupdatestructure) - Update rate display structure
+* [rateDisplayControllerDeleteStructure](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerdeletestructure) - Delete rate display structure
+* [rateDisplayControllerGetAllVersions](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetallversions) - List rate display versions
+* [rateDisplayControllerCreateVersion](docs/sdks/ratedisplay/README.md#ratedisplaycontrollercreateversion) - Create rate display version
+* [rateDisplayControllerGetVersion](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetversion) - Get rate display version
+* [rateDisplayControllerDeleteVersion](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerdeleteversion) - Delete rate display version
+* [rateDisplayControllerActivateVersion](docs/sdks/ratedisplay/README.md#ratedisplaycontrolleractivateversion) - Activate rate display version
+* [rateDisplayControllerInitializeDefault](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerinitializedefault) - Initialize rate display structure
+
+### [Rates](docs/sdks/rates/README.md)
+
+* [ratesControllerGetCurrentRates](docs/sdks/rates/README.md#ratescontrollergetcurrentrates) - Get current rates
+* [ratesControllerGetCurrentRatesByType](docs/sdks/rates/README.md#ratescontrollergetcurrentratesbytype) - Get current rates by consumer type
+* [ratesControllerGetRateHistory](docs/sdks/rates/README.md#ratescontrollergetratehistory) - Get rate history
+* [ratesControllerGetAdjustments](docs/sdks/rates/README.md#ratescontrollergetadjustments) - List rate adjustments
+* [ratesControllerCreateAdjustment](docs/sdks/rates/README.md#ratescontrollercreateadjustment) - Create rate adjustment
+* [ratesControllerApproveAdjustment](docs/sdks/rates/README.md#ratescontrollerapproveadjustment) - Approve rate adjustment
+* [ratesControllerRejectAdjustment](docs/sdks/rates/README.md#ratescontrollerrejectadjustment) - Reject rate adjustment
+* [ratesControllerReapplyAdjustment](docs/sdks/rates/README.md#ratescontrollerreapplyadjustment) - Reapply approved rate adjustment
+
+### [Users](docs/sdks/users/README.md)
+
+* [usersControllerCreate](docs/sdks/users/README.md#userscontrollercreate) - Create user
+* [usersControllerFindAll](docs/sdks/users/README.md#userscontrollerfindall) - Get paginated staff users
+* [usersControllerGetStaffUsers](docs/sdks/users/README.md#userscontrollergetstaffusers) - Get paginated staff users
+* [usersControllerFindOne](docs/sdks/users/README.md#userscontrollerfindone) - Get user by id
+* [usersControllerUpdate](docs/sdks/users/README.md#userscontrollerupdate) - Update user
+* [usersControllerRemove](docs/sdks/users/README.md#userscontrollerremove) - Delete user
+* [usersControllerGetUserConsumerAccounts](docs/sdks/users/README.md#userscontrollergetuserconsumeraccounts) - Get user consumer accounts
+* [usersControllerCreateConsumerAccount](docs/sdks/users/README.md#userscontrollercreateconsumeraccount) - Create consumer account for user
+* [usersControllerLinkConsumerAccount](docs/sdks/users/README.md#userscontrollerlinkconsumeraccount) - Link consumer account to user
+* [usersControllerUnlinkConsumerAccount](docs/sdks/users/README.md#userscontrollerunlinkconsumeraccount) - Unlink consumer account from user
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`adminAdminControllerGetDashboard`](docs/sdks/admin/README.md#admincontrollergetdashboard) - Get admin dashboard summary
+- [`adminBillsAdminBillsControllerCreate`](docs/sdks/adminbills/README.md#adminbillscontrollercreate) - Create bill (admin)
+- [`adminBillsAdminBillsControllerDelete`](docs/sdks/adminbills/README.md#adminbillscontrollerdelete) - Delete bill (admin)
+- [`adminBillsAdminBillsControllerFindAll`](docs/sdks/adminbills/README.md#adminbillscontrollerfindall) - Get paginated bills (admin)
+- [`adminBillsAdminBillsControllerFindOne`](docs/sdks/adminbills/README.md#adminbillscontrollerfindone) - Get bill by id (admin)
+- [`adminBillsAdminBillsControllerImportCsv`](docs/sdks/adminbills/README.md#adminbillscontrollerimportcsv) - Import bills from CSV (admin)
+- [`adminBillsAdminBillsControllerUpdate`](docs/sdks/adminbills/README.md#adminbillscontrollerupdate) - Update bill (admin)
+- [`adminComplaintsAdminComplaintsControllerFindAll`](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerfindall) - Get complaints (admin)
+- [`adminComplaintsAdminComplaintsControllerFindOne`](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerfindone) - Get complaint by id (admin)
+- [`adminComplaintsAdminComplaintsControllerGetStats`](docs/sdks/admincomplaints/README.md#admincomplaintscontrollergetstats) - Get complaint stats
+- [`adminComplaintsAdminComplaintsControllerUpdate`](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerupdate) - Update complaint (admin)
+- [`adminComplaintsAdminComplaintsControllerUpdateStatus`](docs/sdks/admincomplaints/README.md#admincomplaintscontrollerupdatestatus) - Update complaint status (admin)
+- [`adminConsumersAdminConsumersControllerCreate`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollercreate) - Create consumer
+- [`adminConsumersAdminConsumersControllerFindAll`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerfindall) - Get paginated consumers
+- [`adminConsumersAdminConsumersControllerFindOne`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerfindone) - Get consumer by id
+- [`adminConsumersAdminConsumersControllerGetUnbilledConsumers`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollergetunbilledconsumers) - Get unbilled consumers by billing period
+- [`adminConsumersAdminConsumersControllerRemove`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerremove) - Delete consumer
+- [`adminConsumersAdminConsumersControllerUpdate`](docs/sdks/adminconsumers/README.md#adminconsumerscontrollerupdate) - Update consumer
+- [`adminServiceRequestsAdminServiceRequestsControllerFindAll`](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerfindall) - List service requests (admin)
+- [`adminServiceRequestsAdminServiceRequestsControllerFindOne`](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerfindone) - Get service request by id (admin)
+- [`adminServiceRequestsAdminServiceRequestsControllerGetStats`](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollergetstats) - Get service request stats
+- [`adminServiceRequestsAdminServiceRequestsControllerUpdate`](docs/sdks/adminservicerequests/README.md#adminservicerequestscontrollerupdate) - Update service request (admin)
+- [`authAuthControllerAdminLogin`](docs/sdks/auth/README.md#authcontrolleradminlogin) - Login admin/staff user
+- [`authAuthControllerLogin`](docs/sdks/auth/README.md#authcontrollerlogin) - Login consumer user
+- [`authAuthControllerLogout`](docs/sdks/auth/README.md#authcontrollerlogout) - Logout current user
+- [`authAuthControllerRefresh`](docs/sdks/auth/README.md#authcontrollerrefresh) - Refresh access token
+- [`authAuthControllerRevokeTenant`](docs/sdks/auth/README.md#authcontrollerrevoketenant) - Revoke all tokens for a tenant (admin)
+- [`authAuthControllerRevokeUser`](docs/sdks/auth/README.md#authcontrollerrevokeuser) - Revoke all tokens for a user (admin)
+- [`billsBillsControllerCreate`](docs/sdks/bills/README.md#billscontrollercreate) - Create bill
+- [`billsBillsControllerCreateBulk`](docs/sdks/bills/README.md#billscontrollercreatebulk) - Create bills in bulk
+- [`billsBillsControllerDownloadCsvTemplate`](docs/sdks/bills/README.md#billscontrollerdownloadcsvtemplate) - Download CSV template
+- [`billsBillsControllerDownloadPdf`](docs/sdks/bills/README.md#billscontrollerdownloadpdf) - Download bill PDF
+- [`billsBillsControllerFindAll`](docs/sdks/bills/README.md#billscontrollerfindall) - Get paginated bills
+- [`billsBillsControllerFindOne`](docs/sdks/bills/README.md#billscontrollerfindone) - Get bill by id
+- [`billsBillsControllerGetCurrent`](docs/sdks/bills/README.md#billscontrollergetcurrent) - Get current bill
+- [`billsBillsControllerGetPaymentHistory`](docs/sdks/bills/README.md#billscontrollergetpaymenthistory) - Get payment history
+- [`billsBillsControllerImportCsv`](docs/sdks/bills/README.md#billscontrollerimportcsv) - Import bills from CSV
+- [`complaintsComplaintsControllerCreate`](docs/sdks/complaints/README.md#complaintscontrollercreate) - Create complaint
+- [`complaintsComplaintsControllerFindAll`](docs/sdks/complaints/README.md#complaintscontrollerfindall) - List complaints
+- [`complaintsComplaintsControllerFindOne`](docs/sdks/complaints/README.md#complaintscontrollerfindone) - Get complaint by id
+- [`complaintsComplaintsControllerUpdate`](docs/sdks/complaints/README.md#complaintscontrollerupdate) - Update complaint
+- [`consumersConsumersControllerGetAccount`](docs/sdks/consumers/README.md#consumerscontrollergetaccount) - Get consumer account by number
+- [`consumersConsumersControllerGetAccounts`](docs/sdks/consumers/README.md#consumerscontrollergetaccounts) - Get consumer accounts
+- [`consumersConsumersControllerGetProfile`](docs/sdks/consumers/README.md#consumerscontrollergetprofile) - Get consumer profile
+- [`consumerServiceRequestsConsumerServiceRequestsControllerCancel`](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollercancel) - Cancel service request (consumer)
+- [`consumerServiceRequestsConsumerServiceRequestsControllerCreate`](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollercreate) - Create service request (consumer)
+- [`consumerServiceRequestsConsumerServiceRequestsControllerFindAll`](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollerfindall) - List service requests (consumer)
+- [`consumerServiceRequestsConsumerServiceRequestsControllerFindOne`](docs/sdks/consumerservicerequests/README.md#consumerservicerequestscontrollerfindone) - Get service request by id (consumer)
+- [`dashboardDashboardControllerGetStats`](docs/sdks/dashboard/README.md#dashboardcontrollergetstats) - Get dashboard stats
+- [`metersMetersControllerFindByMeterNumber`](docs/sdks/meters/README.md#meterscontrollerfindbymeternumber) - Find consumer by meter number
+- [`metersMetersControllerGetReadingHistory`](docs/sdks/meters/README.md#meterscontrollergetreadinghistory) - Get meter reading history
+- [`notificationsNotificationsControllerFindAll`](docs/sdks/notifications/README.md#notificationscontrollerfindall) - List notifications
+- [`notificationsNotificationsControllerGetUnreadCount`](docs/sdks/notifications/README.md#notificationscontrollergetunreadcount) - Get unread notification count
+- [`notificationsNotificationsControllerMarkAllAsRead`](docs/sdks/notifications/README.md#notificationscontrollermarkallasread) - Mark all notifications as read
+- [`notificationsNotificationsControllerMarkAsRead`](docs/sdks/notifications/README.md#notificationscontrollermarkasread) - Mark notification as read
+- [`rateDisplayRateDisplayControllerActivateVersion`](docs/sdks/ratedisplay/README.md#ratedisplaycontrolleractivateversion) - Activate rate display version
+- [`rateDisplayRateDisplayControllerCreateVersion`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollercreateversion) - Create rate display version
+- [`rateDisplayRateDisplayControllerDeleteStructure`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerdeletestructure) - Delete rate display structure
+- [`rateDisplayRateDisplayControllerDeleteVersion`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerdeleteversion) - Delete rate display version
+- [`rateDisplayRateDisplayControllerGetAllVersions`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetallversions) - List rate display versions
+- [`rateDisplayRateDisplayControllerGetStructure`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetstructure) - Get rate display structure
+- [`rateDisplayRateDisplayControllerGetVersion`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollergetversion) - Get rate display version
+- [`rateDisplayRateDisplayControllerInitializeDefault`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerinitializedefault) - Initialize rate display structure
+- [`rateDisplayRateDisplayControllerUpdateStructure`](docs/sdks/ratedisplay/README.md#ratedisplaycontrollerupdatestructure) - Update rate display structure
+- [`ratesRatesControllerApproveAdjustment`](docs/sdks/rates/README.md#ratescontrollerapproveadjustment) - Approve rate adjustment
+- [`ratesRatesControllerCreateAdjustment`](docs/sdks/rates/README.md#ratescontrollercreateadjustment) - Create rate adjustment
+- [`ratesRatesControllerGetAdjustments`](docs/sdks/rates/README.md#ratescontrollergetadjustments) - List rate adjustments
+- [`ratesRatesControllerGetCurrentRates`](docs/sdks/rates/README.md#ratescontrollergetcurrentrates) - Get current rates
+- [`ratesRatesControllerGetCurrentRatesByType`](docs/sdks/rates/README.md#ratescontrollergetcurrentratesbytype) - Get current rates by consumer type
+- [`ratesRatesControllerGetRateHistory`](docs/sdks/rates/README.md#ratescontrollergetratehistory) - Get rate history
+- [`ratesRatesControllerReapplyAdjustment`](docs/sdks/rates/README.md#ratescontrollerreapplyadjustment) - Reapply approved rate adjustment
+- [`ratesRatesControllerRejectAdjustment`](docs/sdks/rates/README.md#ratescontrollerrejectadjustment) - Reject rate adjustment
+- [`usersUsersControllerCreate`](docs/sdks/users/README.md#userscontrollercreate) - Create user
+- [`usersUsersControllerCreateConsumerAccount`](docs/sdks/users/README.md#userscontrollercreateconsumeraccount) - Create consumer account for user
+- [`usersUsersControllerFindAll`](docs/sdks/users/README.md#userscontrollerfindall) - Get paginated staff users
+- [`usersUsersControllerFindOne`](docs/sdks/users/README.md#userscontrollerfindone) - Get user by id
+- [`usersUsersControllerGetStaffUsers`](docs/sdks/users/README.md#userscontrollergetstaffusers) - Get paginated staff users
+- [`usersUsersControllerGetUserConsumerAccounts`](docs/sdks/users/README.md#userscontrollergetuserconsumeraccounts) - Get user consumer accounts
+- [`usersUsersControllerLinkConsumerAccount`](docs/sdks/users/README.md#userscontrollerlinkconsumeraccount) - Link consumer account to user
+- [`usersUsersControllerRemove`](docs/sdks/users/README.md#userscontrollerremove) - Delete user
+- [`usersUsersControllerUnlinkConsumerAccount`](docs/sdks/users/README.md#userscontrollerunlinkconsumeraccount) - Unlink consumer account from user
+- [`usersUsersControllerUpdate`](docs/sdks/users/README.md#userscontrollerupdate) - Update user
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start File uploads [file-upload] -->
+## File uploads
+
+Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
+
+> [!TIP]
+>
+> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
+>
+> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
+> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
+> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
+> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
+
+```typescript
+import { SDK } from "electric-coop-api";
+import { openAsBlob } from "node:fs";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await sdk.bills.billsControllerImportCsv({
+    file: await openAsBlob("example.file"),
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End File uploads [file-upload] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { SDK } from "electric-coop-api";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await sdk.auth.authControllerLogin({
+    email: "user@example.com",
+    password: "P@ssw0rd!",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { SDK } from "electric-coop-api";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await sdk.auth.authControllerLogin({
+    email: "user@example.com",
+    password: "P@ssw0rd!",
+  });
+
+  console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+[`SDKError`](./src/models/errors/sdkerror.ts) is the base class for all HTTP error responses. It has the following properties:
+
+| Property            | Type       | Description                                            |
+| ------------------- | ---------- | ------------------------------------------------------ |
+| `error.message`     | `string`   | Error message                                          |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                     |
+| `error.headers`     | `Headers`  | HTTP response headers                                  |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned. |
+| `error.rawResponse` | `Response` | Raw HTTP response                                      |
+
+### Example
+```typescript
+import { SDK } from "electric-coop-api";
+import * as errors from "electric-coop-api/models/errors";
+
+const sdk = new SDK({
+  serverURL: "https://api.example.com",
+  bearer: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  try {
+    const result = await sdk.auth.authControllerLogin({
+      email: "user@example.com",
+      password: "P@ssw0rd!",
+    });
+
+    console.log(result);
+  } catch (error) {
+    if (error instanceof errors.SDKError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+    }
+  }
+}
+
+run();
+
+```
+
+### Error Classes
+**Primary error:**
+* [`SDKError`](./src/models/errors/sdkerror.ts): The base class for HTTP error responses.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`SDKError`](./src/models/errors/sdkerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
+<!-- End Error Handling [errors] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { SDK } from "electric-coop-api";
+import { HTTPClient } from "electric-coop-api/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new SDK({ httpClient: httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { SDK } from "electric-coop-api";
+
+const sdk = new SDK({ debugLogger: console });
+```
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->

package/RUNTIMES.md

@@ -0,0 +1,48 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
+
+- [Web Fetch API][web-fetch]
+- [Web Streams API][web-streams] and in particular `ReadableStream`
+- [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of],
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"]
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.