# `Codex.Protocol.RateLimit.Snapshot`
[🔗](https://github.com/nshkrdotcom/codex_sdk/blob/v0.16.1/lib/codex/protocol/rate_limit.ex#L222)

Complete rate limit snapshot

# `plan_type`

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

# `t`

```elixir
@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
}
```

# `from_map`

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

# `parse`

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

# `parse!`

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

# `schema`

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

# `to_map`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*