httpx

type Client struct {

	// RateLimiter specifies a client-side requests per second limit.
	//
	// Ultimately, most APIs enforce this limit on their side, but this is a
	// good way to be a good citizen.
	RateLimiter *rate.Limiter

	// RetryPolicy specifies the policy for retrying requests.
	RetryPolicy *RetryPolicy

	// UserAgent is the User-Agent header to use for all requests.
	UserAgent *UserAgent

	// Transport specifies the mechanism by which individual HTTP requests are
	// made. If nil, DefaultTransport is used.
	Transport http.RoundTripper

	// CheckRedirect specifies the policy for handling redirects. If
	// CheckRedirect is nil, the Client uses its default policy, which is to
	// not follow redirects at all.
	CheckRedirect func(req *http.Request, via []*http.Request) error

	// Jar specifies the cookie jar. If nil, cookies are only sent if they are
	// explicitly set on the Request.
	Jar http.CookieJar

	// Cache is an optional cache mechanism to store HTTP responses.
	Cache pagecache.Cache

	// Logger is the logger to use for logging requests when debugging.
	Logger Logger

	// Timeout is the timeout for all requests made by the client, overriding
	// the default value set in the underlying http.Client.
	Timeout time.Duration

	// Debug specifies whether or not to enable debug logging.
	Debug bool
	// contains filtered or unexported fields
}

type Error struct {
	// URL is the URL that was requested.
	URL *url.URL

	// Method is the HTTP method used.
	Method string

	// Message is a human-readable error message.
	Message string

	// StatusText is the HTTP status text.
	StatusText string

	// StatusCode is the HTTP status code.
	StatusCode int
}

type Logger interface {
	Printf(format string, v ...any)
}

type RateLimitExceededError struct {
	// ResetTime is the time at which the rate limit will reset.
	ResetTime time.Time

	// Remaining is the number of requests remaining in the current time window.
	Remaining int

	// Limit is the maximum number of requests allowed within a specific time
	// window.
	Limit int
}

type RetryAfterExceededError struct {
	// RetryAfter is the duration specified in the Retry-After header, indicating
	// the time clients should wait before sending another request.
	RetryAfter time.Duration

	// MaxRetries is the maximum number of retries allowed for an HTTP request.
	MaxRetries int
}

type RetryPolicy struct {

	// RetryableStatusCodes is a slice of HTTP status codes that should trigger
	// a retry.
	//
	// If a response's status code is in this slice, the request will be
	// retried according to the policy.
	RetryableStatusCodes []int

	// MaxRetries is the maximum number of times a request will be retried if
	// it encounters a retryable status code.
	MaxRetries int

	// MinRetryDelay is the minimum duration to wait before retrying a request.
	MinRetryDelay time.Duration

	// MaxRetryDelay is the maximum duration to wait before retrying a request.
	MaxRetryDelay time.Duration
	// contains filtered or unexported fields
}

type UserAgent struct {
	// Token is the product token.
	Token string

	// Version is the product version.
	Version string

	// Comment is the product comment.
	Comment []string
}