Codex.Protocol.RateLimit.Snapshot (Codex SDK v0.16.1)

Copy Markdown View Source

Complete rate limit snapshot

Summary

Types

plan_type()
t()

Functions

from_map(data)
parse(snapshot)
parse!(snapshot)
schema()
to_map(snapshot)

Types

plan_type()

@type plan_type() :: :plus | :pro | :team | :enterprise | :api | nil

t()

@type t() :: %Codex.Protocol.RateLimit.Snapshot{
  credits: (Codex.Protocol.RateLimit.CreditsSnapshot.t() | nil) | nil,
  extra: map(),
  plan_type: plan_type() | nil,
  primary: (Codex.Protocol.RateLimit.Window.t() | nil) | nil,
  secondary: (Codex.Protocol.RateLimit.Window.t() | nil) | nil
}

Functions

from_map(data)

@spec from_map(map()) :: t()

parse(snapshot)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error,
     {:invalid_rate_limit_snapshot, CliSubprocessCore.Schema.error_detail()}}

parse!(snapshot)

@spec parse!(map() | keyword() | t()) :: t()

schema()

@spec schema() :: Zoi.schema()

to_map(snapshot)

@spec to_map(t()) :: map()