sel.wits.client - Kotlin client library for Energy and Reserve Quantities

Requires

• Kotlin 1.4.30
• Gradle 6.8.3

Build

First, create the gradle wrapper script:

gradle wrapper

Then, run:

./gradlew check assemble

This runs all tests and packages the library.

Features/Implementation Notes

• Supports JSON inputs/outputs, File inputs, and Form inputs.
• Supports collection formats for query parameters: csv, tsv, ssv, pipes.
• Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
• Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.

Documentation for API Endpoints

All URIs are relative to https://api.electricityinfo.co.nz/api/quantities/v1

Class	Method	HTTP request	Description
EnergyApi	energyGet	GET /energy	Retrieve a list of energy quantities across schedules
EnergyApi	schedulesGet	GET /schedules	Retrieve a list of schedules for which quantity data is currently available
EnergyApi	schedulesScheduleEnergyGet	GET /schedules/{schedule}/energy	Retrieve a list of energy quantities for the given schedule
ReservesApi	reservesGet	GET /reserves	Retrieve a list of reserve quantities across schedules
ReservesApi	schedulesGet	GET /schedules	Retrieve a list of schedules for which quantity data is currently available
ReservesApi	schedulesScheduleReservesGet	GET /schedules/{schedule}/reserves	Retrieve a list of reserve quantities for the given schedule

Documentation for Models

• sel.wits.client.models.BaseQuantityDetails
• sel.wits.client.models.EnergyQuantitityDetails
• sel.wits.client.models.EnergyQuantitityDetailsAllOf
• sel.wits.client.models.EnergyScheduleDetails
• sel.wits.client.models.Fault
• sel.wits.client.models.GetEnergyQuantitiesResponse
• sel.wits.client.models.GetReserveQuantitiesResponse
• sel.wits.client.models.Island
• sel.wits.client.models.ListSchedulesResponse
• sel.wits.client.models.ReserveQuantitityDetails
• sel.wits.client.models.ReserveQuantitityDetailsAllOf
• sel.wits.client.models.ReserveScheduleDetails
• sel.wits.client.models.RunClass

Documentation for Authorization

oAuthClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A