clean_energy_api library

Provides Dart HTTP bindings for the Clean Energy backend APIs.

This package has the following features:

Easily create HTTP calls to Kohler Energy Management API endpoints
Provides Dart classes that model the return values from the API
Uses code generation based on swagger files, so code is always up-to-date using the backend as the source of truth

Classes

Enums

Mixins

MockChopperClientMixin: ChopperClient mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.
MockChopperLogRecordMixin: ChopperLogRecord mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.
MockPartValueFileMixin<T>: PartValueFile mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.
MockPartValueMixin<T>: PartValue mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.
MockRequestMixin: Request mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.
MockResponseMixin<BodyType>: Response mixin for the purposes of creating mocks using a mocking framework such as Mockito or Mocktail.

Extensions

Constants

body → const Body: Declares the Body of POST, PUT, and PATCH requests
chopperApi → const ChopperApi: Defines a Chopper API.
contentTypeKey → const String
delete → const DELETE: Defines a method as an HTTP DELETE request.
factoryConverter → const FactoryConverter: Defines custom Converter methods for a single network API endpoint. See ConvertRequest, ConvertResponse.
field → const Field: Defines a field for a x-www-form-urlencoded request. Automatically binds to the name of the method parameter.
fieldMap → const FieldMap: Provides field parameters of a request as Map<String, dynamic>.
formEncodedHeaders → const String
formUrlEncoded → const FormUrlEncoded: Denotes that the request body will use form URL encoding. Fields should be declared as parameters and annotated with Field/FieldMap.
get → const GET: Defines a method as an HTTP GET request.
head → const HEAD: Defines a method as an HTTP HEAD request.
header → const Header: Passes a value to the header of the request.
jsonApiHeaders → const String
jsonHeaders → const String
multipart → const Multipart: Defines a multipart request.
options → const OPTIONS: Defines a method as an HTTP OPTIONS request.
part → const Part: Use Part to define a part of a Multipart request.
partFile → const PartFile: Use PartFile to define a file field for a Multipart request.
partFileMap → const PartFileMap: Provides partFile parameters of a request as PartValueFile.
partMap → const PartMap: Provides part parameters of a request as PartValue.
patch → const PATCH: Defines a method as an HTTP PATCH request. Use the Body annotation to pass data to send.
path → const Path: Provides a parameter in the url.
post → const POST: Defines a method as an HTTP POST request.
put → const PUT: Defines a method as an HTTP PUT request.
query → const Query: Provides the query parameters of a request.
queryMap → const QueryMap: Provides query parameters of a request as Map<String, dynamic>.
tag → const Tag: Adds the argument instance as a request tag.

Properties

Functions

Typedefs

AuthenticationCallback = FutureOr<void> Function(Request request, Response response, [Request? originalRequest]): Callback that is called when an authentication challenge is received based on the given request, response, and optionally the originalRequest.
ConvertRequest = FutureOr<Request> Function(Request request): A function that should convert the body of a Request to the HTTP representation.
ConvertResponse<T> = FutureOr<Response<T>> Function(Response response): A function that should convert the body of a Response from the HTTP representation to a Dart object.

Exceptions / Errors

ChopperException: An exception thrown when something goes wrong with Chopper.
ChopperHttpException: An exception thrown when a Response is unsuccessful < 200 or > 300.

clean_energy_api library

Classes

Enums

Mixins

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

clean_energy_api package

clean_energy_api library