api

Documentation

Index

• func ParseResetDuration(s string) time.Duration
• type AuthError
  • func (e *AuthError) Error() string
• type Client
  • func NewClient(provider *auth.Provider) *Client
  • func (c *Client) FetchUsage(ctx context.Context) (*UsageResponse, error)
• type RateLimitError
  • func (e *RateLimitError) Error() string
• type UsageResponse
  • func (u *UsageResponse) SessionResetDuration() time.Duration
  • func (u *UsageResponse) WeeklyResetDuration() time.Duration

Functions

func ParseResetDuration

func ParseResetDuration(s string) time.Duration

ParseResetDuration parses an RFC3339 timestamp and returns the duration until that time.

Types

type AuthError

type AuthError struct {
	StatusCode int
	Message    string
}

AuthError indicates an authentication failure that persists after credential reload.

func (*AuthError) Error

func (e *AuthError) Error() string

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(provider *auth.Provider) *Client

func (*Client) FetchUsage

func (c *Client) FetchUsage(ctx context.Context) (*UsageResponse, error)

type RateLimitError

type RateLimitError struct {
	RetryAfter time.Duration
}

RateLimitError indicates a 429 response with an optional Retry-After duration.

func (*RateLimitError) Error

func (e *RateLimitError) Error() string

type UsageResponse

type UsageResponse struct {
	SessionPercent    float64
	WeeklyPercent     float64
	SessionResetAt    string
	WeeklyResetAt     string
	WeeklySonnetPct   *float64
	WeeklySonnetReset string
	WeeklyOpusPct     *float64
	WeeklyOpusReset   string
	WeeklyDesignPct   *float64
	WeeklyDesignReset string
	ExtraUsageEnabled bool
	ExtraUsageLimit   *float64
	ExtraUsageUsed    *float64
	Raw               json.RawMessage
}

UsageResponse represents the parsed OAuth usage data.

func (*UsageResponse) SessionResetDuration

func (u *UsageResponse) SessionResetDuration() time.Duration

SessionResetDuration parses the session reset time and returns duration until reset.

func (*UsageResponse) WeeklyResetDuration

func (u *UsageResponse) WeeklyResetDuration() time.Duration

WeeklyResetDuration parses the weekly reset time and returns duration until reset.