NorbixApi class
Norbix Api client.
Resources are exposed as direct properties — for example
client.apiKeys.someMethod(...) — so callers do NOT navigate
a redundant client.xxx.apiKeys namespace.
Constructors
- NorbixApi({NorbixConfig? config, HttpDriver? driver})
-
Build a client. Defaults to the public Norbix host. To point at a
self-hosted deployment (e.g.
https://api.norbix.isidos.ltorhttp://localhost:5000), pass a NorbixConfig with the desired URL. -
NorbixApi.fromEnv({Map<
String, String> ? overrides, HttpDriver? driver}) -
Build a client that reads its base URL and credentials from
environment variables. Falls back to the public host when the
URL var is not set, so callers always get a usable client.
factory
Properties
- apiKeys → ApiKeysResource
-
latefinal
- auth → AuthResource
-
latefinal
- config → NorbixConfig
-
Currently active configuration. Mutate via setApiKey, setBearerToken,
or by passing a new NorbixConfig at construction time.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- users → UsersResource
-
latefinal
Methods
-
close(
) → void - Closes the underlying HTTP client. Call when you are done.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setApiKey(
String? key) → void - Replace the API key without rebuilding the client.
-
setBearerToken(
String? token) → void - Replace the bearer token without rebuilding the client.
-
setConfig(
NorbixConfig config) → void - Replace the entire configuration. Useful for switching environments (staging <-> production) at runtime.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited