/api/v1/environments: your deployment environments (production, staging,
...), or, through EndPointBlank.Management.for_managed_client/2, a managed
client's.
An environment is %{"id", "name", "domain", "is_default", "production", "synced_at", "inserted_at", "updated_at"}. The production environment
cannot be changed or deleted ("protected").
Summary
Functions
Creates an environment. attrs: name and domain (required),
is_default. Options: idempotency_key:.
Deletes an environment: %{"id", "deleted" => true}. Refused with
"has_dependents" while grants or credentials depend on it.
One environment.
One page of environments. Options: limit:, after:.
Every environment, a page at a time. Raises EndPointBlank.Management.Error.
Updates an environment. attrs: name, domain, is_default.
Functions
@spec create(EndPointBlank.Management.t(), map() | keyword(), keyword()) :: EndPointBlank.Management.result(map())
Creates an environment. attrs: name and domain (required),
is_default. Options: idempotency_key:.
@spec delete(EndPointBlank.Management.t(), String.t()) :: EndPointBlank.Management.result(map())
Deletes an environment: %{"id", "deleted" => true}. Refused with
"has_dependents" while grants or credentials depend on it.
@spec get(EndPointBlank.Management.t(), String.t()) :: EndPointBlank.Management.result(map())
One environment.
@spec list( EndPointBlank.Management.t(), keyword() ) :: EndPointBlank.Management.result(EndPointBlank.Management.Page.t())
One page of environments. Options: limit:, after:.
@spec stream( EndPointBlank.Management.t(), keyword() ) :: Enumerable.t()
Every environment, a page at a time. Raises EndPointBlank.Management.Error.
@spec update(EndPointBlank.Management.t(), String.t(), map() | keyword()) :: EndPointBlank.Management.result(map())
Updates an environment. attrs: name, domain, is_default.