core

type APIError ¶

type APIError struct {
	StatusCode int         `json:"-"`
	Header     http.Header `json:"-"`
	// contains filtered or unexported fields
}

APIError is a lightweight wrapper around the standard error interface that preserves the status code from the RPC, if any.

func NewAPIError(statusCode int, header http.Header, err error) *APIError

func (a *APIError) Error() string

func (a *APIError) Unwrap() error

type Auth0ClientEnvEntryOption ¶

type Auth0ClientEnvEntryOption struct {
	Key   string
	Value string
}

Auth0ClientEnvEntryOption implements the RequestOption interface.

type BaseURLOption ¶

type BaseURLOption struct {
	BaseURL string
}

BaseURLOption implements the RequestOption interface.

type BodyPropertiesOption ¶

type BodyPropertiesOption struct {
	BodyProperties map[string]interface{}
}

BodyPropertiesOption implements the RequestOption interface.

type BufferStreamReader ¶ added in v2.10.0

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

BufferStreamReader reads data from a *bufio.Reader, which splits on newlines.

func (b *BufferStreamReader) ReadFromStream() ([]byte, error)

type ClientCredentialsAndAudienceOption ¶

type ClientCredentialsAndAudienceOption struct {
	Ctx          *context.Context
	ClientID     string
	ClientSecret string
	Audience     string
	// contains filtered or unexported fields
}

type ClientCredentialsOption ¶

type ClientCredentialsOption struct {
	Ctx          *context.Context
	ClientID     string
	ClientSecret string
	// contains filtered or unexported fields
}

type ClientCredentialsPrivateKeyJwtAndAudienceOption ¶

type ClientCredentialsPrivateKeyJwtAndAudienceOption struct {
	Ctx        *context.Context
	ClientID   string
	PrivateKey string
	Algorithm  string
	Audience   string
	// contains filtered or unexported fields
}

type ClientCredentialsPrivateKeyJwtOption ¶

type ClientCredentialsPrivateKeyJwtOption struct {
	Ctx        *context.Context
	ClientID   string
	PrivateKey string
	Algorithm  string
	// contains filtered or unexported fields
}

type CustomDomainHeaderOption ¶

type CustomDomainHeaderOption struct {
	CustomDomainHeader string
}

CustomDomainHeaderOption implements the RequestOption interface.

type DebugOption ¶

type DebugOption struct {
	Debug bool
}

DebugOption implements the RequestOption interface.

type HTTPClient ¶

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

HTTPClient is an interface for a subset of the *http.Client.

type HTTPClientOption ¶

type HTTPClientOption struct {
	HTTPClient HTTPClient
}

HTTPClientOption implements the RequestOption interface.

type HTTPHeaderOption ¶

type HTTPHeaderOption struct {
	HTTPHeader http.Header
}

HTTPHeaderOption implements the RequestOption interface.

type InsecureOption ¶

type InsecureOption struct{}

InsecureOption implements the RequestOption interface. This option is for testing purposes only and should not be used in production.

type MaxAttemptsOption ¶

type MaxAttemptsOption struct {
	MaxAttempts uint
}

MaxAttemptsOption implements the RequestOption interface.

type MaxBufSizeOption ¶ added in v2.10.0

type MaxBufSizeOption struct {
	MaxBufSize int
}

MaxBufSizeOption implements the RequestOption interface.

type MaxStreamReconnectAttemptsOption ¶ added in v2.12.0

type MaxStreamReconnectAttemptsOption struct {
	MaxStreamReconnectAttempts uint
}

MaxStreamReconnectAttemptsOption implements the RequestOption interface.

type NoAuth0ClientInfoOption ¶

type NoAuth0ClientInfoOption struct{}

NoAuth0ClientInfoOption implements the RequestOption interface.

type Page ¶

type Page[Cursor comparable, T any, R any] struct {
	Results      []T
	Response     R
	RawResponse  PageResponse[Cursor, T, R]
	StatusCode   int
	Header       http.Header
	NextPageFunc func(context.Context) (*Page[Cursor, T, R], error)
}

Page represents a single page of results.

func (p *Page[Cursor, T, R]) GetNextPage(ctx context.Context) (*Page[Cursor, T, R], error)

func (p *Page[Cursor, T, R]) Iterator() *PageIterator[Cursor, T, R]

type PageIterator ¶

type PageIterator[Cursor comparable, T any, R any] struct {
	// contains filtered or unexported fields
}

PageIterator is an auto-iterator for paginated endpoints.

func (p *PageIterator[Cursor, T, R]) Current() T

func (p *PageIterator[Cursor, T, R]) Err() error

func (p *PageIterator[Cursor, T, R]) Next(ctx context.Context) bool

type PageRequest ¶ added in v2.3.0

type PageRequest[Cursor comparable] struct {
	Cursor Cursor

	// Holds the value of the response type (populated by the *Caller).
	Response any
}

PageRequest represents the information required to identify a single page.

type PageResponse ¶ added in v2.3.0

type PageResponse[Cursor comparable, T any, R any] struct {
	Results  []T
	Response R
	Next     Cursor
	Done     bool
}

PageResponse represents the information associated with a single page.

Type parameters:

• Cursor: the type used for pagination (e.g., string cursor or integer offset)
• T: the type of individual items in the page
• R: the response type returned by the paginated endpoint

type QueryParametersOption ¶

type QueryParametersOption struct {
	QueryParameters url.Values
}

QueryParametersOption implements the RequestOption interface.

type ReconnectFunc ¶ added in v2.12.0

type ReconnectFunc func(ctx context.Context, lastEventID string) (*http.Response, error)

ReconnectFunc is invoked when the underlying SSE response body reaches EOF before the configured terminator is observed and reconnection is enabled. It must return a fresh *http.Response with the same SSE semantics.

type RequestOption ¶

type RequestOption interface {
	// contains filtered or unexported methods
}

RequestOption adapts the behavior of the client or an individual request.

type RequestOptions ¶

type RequestOptions struct {
	BaseURL                    string
	HTTPClient                 HTTPClient
	HTTPHeader                 http.Header
	BodyProperties             map[string]interface{}
	QueryParameters            url.Values
	MaxAttempts                uint
	MaxBufSize                 int
	MaxStreamReconnectAttempts uint
	DisableStreamReconnection  bool
	DisableRetries             bool

	Ctx         context.Context
	Token       string
	TokenSource oauth2.TokenSource
	Insecure    bool // For testing purposes only - allows HTTP instead of HTTPS

	// Auth0ClientEnv holds custom environment entries for the Auth0-Client header
	Auth0ClientEnv map[string]string

	// NoAuth0ClientInfo when true, prevents sending the "Auth0-Client" header
	NoAuth0ClientInfo bool

	// CustomDomainHeader is the custom domain to be sent in the "Auth0-Custom-Domain" header
	// for whitelisted API endpoints
	CustomDomainHeader string
}

RequestOptions defines all of the possible request options.

This type is primarily used by the generated code and is not meant to be used directly; use the option package instead.

func NewRequestOptions(opts ...RequestOption) *RequestOptions

func (r *RequestOptions) ToHeader() http.Header

type Response ¶

type Response[T any] struct {
	StatusCode int
	Header     http.Header
	Body       T
}

Response is an HTTP response from an HTTP client.

type ScannerStreamReader ¶ added in v2.10.0

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

ScannerStreamReader reads data from a *bufio.Scanner, which allows for configurable delimiters.

func (s *ScannerStreamReader) ReadFromStream() ([]byte, error)

type SseEvent ¶ added in v2.10.0

type SseEvent struct {
	SseEventMeta
	Data []byte
	// contains filtered or unexported fields
}

func (event *SseEvent) String() string

type SseEventMeta ¶ added in v2.10.0

type SseEventMeta struct {
	ID    string
	Event string
	// Retry is the reconnection time in milliseconds.
	// Zero if not set or if the value was not a valid integer.
	Retry int
}

SseEventMeta holds SSE metadata fields shared by StreamEvent and StreamEventRaw.

type SseStreamReader ¶ added in v2.10.0

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

func (s *SseStreamReader) LastEventID() string

func (s *SseStreamReader) LastRetryMs() int

func (s *SseStreamReader) ReadEvent() (*SseEvent, error)

func (s *SseStreamReader) ReadFromStream() ([]byte, error)

func (s *SseStreamReader) TerminatorSeen() bool

type Stream ¶ added in v2.10.0

type Stream[T any] struct {
	// contains filtered or unexported fields
}

Stream represents a stream of messages sent from a server.

Stream is not safe for concurrent use by multiple goroutines. Cancel the context passed to NewStream to tear the stream down.

func NewStream[T any](ctx context.Context, response *http.Response, opts ...StreamOption) *Stream[T]

func (s *Stream[T]) Close() error

func (s *Stream[T]) LastEventID() string

func (s *Stream[T]) LastRetryMs() int

func (s *Stream[T]) Recv() (T, error)

func (s *Stream[T]) RecvEvent() (StreamEvent[T], error)

func (s *Stream[T]) RecvEventRaw() (StreamEventRaw, error)

func (s *Stream[T]) RecvRaw() ([]byte, error)

type StreamEvent ¶ added in v2.10.0

type StreamEvent[T any] struct {
	SseEventMeta
	Data T
}

StreamEvent contains the parsed data and SSE metadata for a single event.

type StreamEventRaw ¶ added in v2.10.0

type StreamEventRaw struct {
	SseEventMeta
	Data []byte
}

StreamEventRaw contains the raw bytes and SSE metadata for a single event.

type StreamFormat ¶ added in v2.10.0

type StreamFormat string

const (
	StreamFormatSSE   StreamFormat = "sse"
	StreamFormatEmpty StreamFormat = ""
)

type StreamOption ¶ added in v2.10.0

type StreamOption func(*streamOptions)

StreamOption adapts the behavior of the Stream.

func WithDelimiter(delimiter string) StreamOption

func WithEventDiscriminator(field string) StreamOption

func WithFormat(format StreamFormat) StreamOption

func WithMaxBufSize(size int) StreamOption

func WithPrefix(prefix string) StreamOption

func WithReconnect(fn ReconnectFunc, maxAttempts uint) StreamOption

func WithTerminator(terminator string) StreamOption

type TokenOption ¶

type TokenOption struct {
	Token string
}

TokenOption implements the RequestOption interface.

type TokenSourceOption ¶ added in v2.6.0

type TokenSourceOption struct {
	TokenSource oauth2.TokenSource
}

TokenSourceOption implements the RequestOption interface.

type UserAgentOption ¶

type UserAgentOption struct {
	UserAgent string
}

UserAgentOption implements the RequestOption interface.

type WithoutRetriesOption ¶ added in v2.12.0

type WithoutRetriesOption struct{}

WithoutRetriesOption implements the RequestOption interface.

type WithoutStreamReconnectionOption ¶ added in v2.12.0

type WithoutStreamReconnectionOption struct{}

WithoutStreamReconnectionOption implements the RequestOption interface.