responses

Documentation

Index

• type AuthResponse
• type ErrorResponse
• type MessageResponse
• type RefreshSessionResponse
• type ResponseWithWarnings
  • func NewResponseWithWarnings(data interface{}, warnings ...Warning) *ResponseWithWarnings
  • func (r *ResponseWithWarnings) AddWarning(code, message string)
  • func (r *ResponseWithWarnings) HasWarnings() bool
• type SessionResponse
• type StatusResponse
• type SuccessResponse
• type TwoFARequiredResponse
• type VerifyResponse
• type Warning

Types

type AuthResponse

type AuthResponse struct {
	User         *user.User       `json:"user"`
	Session      *session.Session `json:"session,omitempty"`
	Token        string           `json:"token,omitempty"`
	RequireTwoFA bool             `json:"requireTwofa,omitempty"`
}

AuthResponse represents a successful authentication response with user, session, and token

type ErrorResponse

type ErrorResponse = errs.AuthsomeError

ErrorResponse is an alias to errs.AuthsomeError for consistency across the codebase. Instead of using &ErrorResponse{Error: "message"}, use the errs package constructors:

• errs.New(code, message, httpStatus)
• errs.BadRequest(message)
• errs.Unauthorized()
• errs.NotFound(message)
• etc.

See internal/errs/errors.go for all available error constructors.

type MessageResponse

type MessageResponse struct {
	Message string `json:"message"`
}

MessageResponse represents a simple message response

type RefreshSessionResponse

type RefreshSessionResponse struct {
	User             *user.User       `json:"user"`
	Session          *session.Session `json:"session"`
	AccessToken      string           `json:"accessToken"`
	RefreshToken     string           `json:"refreshToken"`
	ExpiresAt        string           `json:"expiresAt"`
	RefreshExpiresAt string           `json:"refreshExpiresAt"`
}

RefreshSessionResponse represents a refresh token response

type ResponseWithWarnings

type ResponseWithWarnings struct {
	Data     interface{} `json:"data"`
	Warnings []Warning   `json:"warnings,omitempty"`
}

ResponseWithWarnings wraps any response data with optional warnings

func NewResponseWithWarnings

func NewResponseWithWarnings(data interface{}, warnings ...Warning) *ResponseWithWarnings

NewResponseWithWarnings creates a new response with warnings

func (*ResponseWithWarnings) AddWarning

func (r *ResponseWithWarnings) AddWarning(code, message string)

AddWarning adds a warning to the response

func (*ResponseWithWarnings) HasWarnings

func (r *ResponseWithWarnings) HasWarnings() bool

HasWarnings returns true if the response has any warnings

type SessionResponse

type SessionResponse struct {
	User    *user.User       `json:"user"`
	Session *session.Session `json:"session,omitempty"`
}

SessionResponse represents a session query response

type StatusResponse

type StatusResponse struct {
	Status string `json:"status"`
}

StatusResponse represents a status response

type SuccessResponse

type SuccessResponse struct {
	Success bool `json:"success"`
}

SuccessResponse represents a success boolean response

type TwoFARequiredResponse

type TwoFARequiredResponse struct {
	User         *user.User `json:"user"`
	RequireTwoFA bool       `json:"requireTwofa,omitempty"`
	DeviceID     string     `json:"deviceId,omitempty"`
}

TwoFARequiredResponse indicates that two-factor authentication is required

type VerifyResponse

type VerifyResponse struct {
	User    interface{} `json:"user"`
	Session interface{} `json:"session"`
	Token   string      `json:"token,omitempty"`
}

VerifyResponse represents a verification response (used by emailotp, magiclink, phone plugins) Uses interface{} for flexibility across different plugin implementations

type Warning

type Warning struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

Warning represents a single warning message