openadr3.api — energy.grid-coordination/clj-oa3 0.3.0

OpenADR 3 API client library. Spec-driven HTTP client built on Martian with the OpenAPI spec as the single source of truth.

Functions return raw HTTP responses by default. Use the coerced helpers (programs, events, vens, etc.) to get namespaced Clojure entities.

all-routes clj

(all-routes client)

Returns vector of all route-name keywords.

authorized? clj

(authorized? client-scopes endpoint-scopes)

Returns truthy if the client's scopes intersect with the endpoint's required scopes.

body clj

(body response)

Extract the :body from an HTTP response.

build-shared-http-client clj

(build-shared-http-client {:keys [connect-timeout-ms]
                           :or {connect-timeout-ms 5000}})

Build a shared Java HttpClient with connection timeout. Reuse across requests to avoid per-request client creation.

client-type clj

(client-type client)

Returns OpenADR3 client-type keyword, :ven or :bl

create-authentication-header clj

(create-authentication-header token)

Martian interceptor that adds a Bearer token to requests.

create-bl-client clj

(create-bl-client auth-token url)

(create-bl-client auth-token url opts)

Create an authenticated BL (Business Logic) client. Uses the embedded spec (default version 3.1.0). Pass opts map to override :spec-version, :http-client, or :user-agent.

Examples: (create-bl-client token url) (create-bl-client token url {:spec-version "3.0.1"}) (create-bl-client token url {:http-client hc}) (create-bl-client token url {:user-agent "my-app/1.0"})

create-event clj

(create-event openapi-client event-request-body)

Create a new event.

create-program clj

(create-program openapi-client program-request-body)

Create a new program.

create-report clj

(create-report openapi-client report-request-body)

Create a new report.

create-resource clj

(create-resource openapi-client resource-body)

Create a resource for a VEN. Body should include :venID, :resourceName, and :objectType (VEN_RESOURCE_REQUEST or BL_RESOURCE_REQUEST). For BL requests, also include :clientID.

create-subscription clj

(create-subscription openapi-client subscription-request-body)

Create a new subscription.

create-user-agent-header clj

(create-user-agent-header user-agent)

Martian interceptor that sets the User-Agent header on requests.

create-ven clj

(create-ven openapi-client ven-request-body)

Create a new VEN.

create-ven-client clj

(create-ven-client auth-token url)

(create-ven-client auth-token url opts)

Create an authenticated VEN (Virtual End Node) client. Uses the embedded spec (default version 3.1.0). Pass opts map to override :spec-version, :http-client, or :user-agent.

Examples: (create-ven-client token url) (create-ven-client token url {:spec-version "3.0.1"}) (create-ven-client token url {:http-client hc}) (create-ven-client token url {:user-agent "my-app/1.0"})

default-spec-version clj

default-user-agent clj

default-vtn-url clj

delete-event clj

(delete-event openapi-client event-id)

Delete an event by ID.

delete-program clj

(delete-program openapi-client program-id)

Delete a program by ID.

delete-report clj

(delete-report openapi-client report-id)

Delete a report by ID.

delete-resource clj

(delete-resource openapi-client resource-id)

Delete a resource by ID.

delete-subscription clj

(delete-subscription openapi-client subscription-id)

Delete a subscription by ID.

delete-ven clj

(delete-ven openapi-client ven-id)

Delete a VEN by ID.

endpoint-scopes clj

(endpoint-scopes client endpoint)

Returns set of OAuth2 scopes required for the given endpoint.

event clj

(event client event-id)

Fetch and coerce an event by ID. Returns an Event entity.

events clj

(events client)

Fetch and coerce all events. Returns a vector of Event entities.

find-program-by-name clj

(find-program-by-name client name)

Find a program by name. Returns the first match, or nil if not found.

find-ven-by-name clj

(find-ven-by-name client name)

Find a VEN by name. Returns the first match, or nil if not found.

get-auth-server clj

(get-auth-server openapi-client)

GET auth server info.

get-event-by-id clj

(get-event-by-id openapi-client event-id)

Get an event by its ID.

get-events clj

(get-events openapi-client)

Search all events.

get-handler clj

(get-handler martian route-kw)

Returns the handler for the specified route-name keyword.

get-mqtt-topics-events clj

(get-mqtt-topics-events openapi-client)

get-mqtt-topics-program clj

(get-mqtt-topics-program openapi-client program-id)

Get MQTT topic names for a specific program.

get-mqtt-topics-program-events clj

(get-mqtt-topics-program-events openapi-client program-id)

Get MQTT topic names for events on a specific program.

get-mqtt-topics-programs clj

(get-mqtt-topics-programs openapi-client)

get-mqtt-topics-reports clj

(get-mqtt-topics-reports openapi-client)

get-mqtt-topics-resources clj

(get-mqtt-topics-resources openapi-client)

get-mqtt-topics-subscriptions clj

(get-mqtt-topics-subscriptions openapi-client)

get-mqtt-topics-ven clj

(get-mqtt-topics-ven openapi-client ven-id)

Get MQTT topic names for a specific VEN.

get-mqtt-topics-ven-events clj

(get-mqtt-topics-ven-events openapi-client ven-id)

Get MQTT topic names for events targeted at a VEN.

get-mqtt-topics-ven-programs clj

(get-mqtt-topics-ven-programs openapi-client ven-id)

Get MQTT topic names for programs targeted at a VEN.

get-mqtt-topics-ven-resources clj

(get-mqtt-topics-ven-resources openapi-client ven-id)

Get MQTT topic names for resources of a VEN.

get-mqtt-topics-vens clj

(get-mqtt-topics-vens openapi-client)

get-notifiers clj

(get-notifiers openapi-client)

List all notifiers.

get-program-by-id clj

(get-program-by-id openapi-client program-id)

Get a program by its ID.

get-programs clj

(get-programs openapi-client)

Search all programs.

get-report-by-id clj

(get-report-by-id openapi-client report-id)

Get a report by its ID.

get-reports clj

(get-reports openapi-client)

Search all reports.

get-resource-by-id clj

(get-resource-by-id openapi-client resource-id)

Get a resource by its ID.

get-subscription-by-id clj

(get-subscription-by-id openapi-client subscription-id)

Get a subscription by its ID.

get-subscriptions clj

(get-subscriptions openapi-client)

Search all subscriptions.

get-token clj

(get-token openapi-client client-id client-secret)

Fetch an OAuth2 token using client credentials.

get-unauthenticated-routes clj

(get-unauthenticated-routes martian)

Returns vector of route-names that require no authentication.

get-ven-by-id clj

(get-ven-by-id openapi-client ven-id)

Get a VEN by its ID.

get-vens clj

(get-vens openapi-client)

Search all VENs.

hash-map-by clj

(hash-map-by f coll)

Like group-by, but the mapping must be unique. Throws on duplicate keys.

inject-http-client clj

(inject-http-client http-client)

Martian interceptor that injects a shared HttpClient into every request.

lib-version clj

program clj

(program client program-id)

Fetch and coerce a program by ID. Returns a Program entity.

programs clj

(programs client)

Fetch and coerce all programs. Returns a vector of Program entities.

read-openapi-spec clj

(read-openapi-spec filename)

(read-openapi-spec filename interceptors)

(read-openapi-spec filename interceptors url)

(read-openapi-spec filename interceptors url http-client)

Bootstrap a Martian client from an OpenAPI spec file. Returns a Martian instance with optional interceptors and API root URL. When http-client is provided, prepends an interceptor to inject it into every request, avoiding per-request HttpClient creation.

report clj

(report client report-id)

Fetch and coerce a report by ID. Returns a Report entity.

reports clj

(reports client)

Fetch and coerce all reports. Returns a vector of Report entities.

safe-default-interceptors clj

Martian hato default interceptors with safe response coercion for error responses.

scopes clj

(scopes client)

Returns set of OpenADR client scopes.

search-events clj

(search-events openapi-client query-params)

Search events with query parameters.

search-programs clj

(search-programs openapi-client query-params)

Search programs with query parameters (targets, skip, limit).

search-reports clj

(search-reports openapi-client query-params)

Search reports with query parameters.

search-subscriptions clj

(search-subscriptions openapi-client query-params)

Search subscriptions with query parameters.

search-ven-resources clj

(search-ven-resources openapi-client query-params)

Search VEN resources with query parameters.

search-vens clj

(search-vens openapi-client query-params)

Search VENs with query parameters (targetType, targetValues, skip, limit, venName).

spec-path clj

(spec-path)

(spec-path version)

Resolve a spec version string to a classpath resource name. Returns the resource name string (not a filesystem path) so that martian.file/local-resource can find it via clojure.java.io/resource. Throws if the version is unknown or the resource is not found.

spec-versions clj

Map of OA3 spec version string to classpath resource path.

subscription clj

(subscription client subscription-id)

Fetch and coerce a subscription by ID. Returns a Subscription entity.

subscriptions clj

(subscriptions client)

Fetch and coerce all subscriptions. Returns a vector of Subscription entities.

success? clj

(success? response)

True if the HTTP response has a 2xx status code.

turn-off-exception-throwing clj

(turn-off-exception-throwing)

Martian interceptor that prevents Hato from throwing on non-2xx responses.

update-event clj

(update-event openapi-client event-id event-request-body)

Update an existing event.

update-program clj

(update-program openapi-client program-id program-request-body)

Update an existing program.

update-report clj

(update-report openapi-client report-id report-request-body)

Update an existing report.

update-resource clj

(update-resource openapi-client resource-id resource-request-body)

Update an existing resource.

update-subscription clj

(update-subscription openapi-client subscription-id subscription-request-body)

Update an existing subscription.

update-ven clj

(update-ven openapi-client ven-id ven-request-body)

Update an existing VEN.

ven clj

(ven client ven-id)

Fetch and coerce a VEN by ID. Returns a Ven entity.

vens clj

(vens client)

Fetch and coerce all VENs. Returns a vector of Ven entities.