View Source ExTier.Api.Limits (ex_tier v0.11.1)

Link to this section Summary

Functions

List the limits & usage of a given organization's feature

List the limits & usage of a given organization

Link to this section Types

@type limit_params() :: %{org: String.t(), feature: String.t()}
@type limits_params() :: %{org: String.t()}

Link to this section Functions

@spec limit(limit_params()) :: {:ok, ExTier.Usage.t()} | {:error, ExTier.Error.t()}

List the limits & usage of a given organization's feature

{:ok, %ExTier.Usage{}} = ExTier.limit(%{org: "org:org_id", feature: "feature:feature_name"})
@spec limits(limits_params()) :: {:ok, ExTier.Limits.t()} | {:error, ExTier.Error.t()}

List the limits & usage of a given organization

{:ok, %ExTier.Usage{}} = ExTier.limit(%{org: "org:org_id"})