nhostclient

Documentation

Overview

This package provides functionality to interact with the Nhost API.

Index

• Constants
• func MakeJSONRequest(ctx context.Context, client *http.Client, url string, method string, ...) error
• type BasicRetryer
  • func NewBasicRetryer(maxAttempts int, multiplier int) BasicRetryer
  • func (s BasicRetryer) Retry(f Func) error
• type Client
  • func New(authURL, graphqlURL string, interceptors ...clientv2.RequestInterceptor) *Client
  • func (n *Client) CreatePAT(ctx context.Context, accessToken string) (credentials.Credentials, error)
  • func (n *Client) Login(ctx context.Context, email, password string) (credentials.Session, error)
  • func (n *Client) LoginPAT(ctx context.Context, pat string) (credentials.Session, error)
  • func (n *Client) Logout(ctx context.Context, refreshTokenID string, accessToken string) error
  • func (n *Client) RefreshToken(ctx context.Context, refreshToken string) (RefreshTokenResponse, error)
  • func (n *Client) VerifyEmail(ctx context.Context, email string) error
• type CreatePATRequest
• type Func
• type LoginPATRequest
• type LoginRequest
• type RefreshTokenRequest
• type RefreshTokenResponse
• type RequestError
  • func (e *RequestError) Error() string
• type ResponseValidator
• type VerifyEmailRequest

Constants

const (
	PATDuration = 90 * 24 * time.Hour
)

Functions

func MakeJSONRequest

func MakeJSONRequest(
	ctx context.Context,
	client *http.Client,
	url string,
	method string,
	requestBody any,
	headers http.Header,
	response any,
	responseValidator ResponseValidator,
	retryer BasicRetryer,
) error

Types

type BasicRetryer

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

func NewBasicRetryer

func NewBasicRetryer(maxAttempts int, multiplier int) BasicRetryer

func (BasicRetryer) Retry

func (s BasicRetryer) Retry(f Func) error

type Client

type Client struct {
	*graphql.Client
	// contains filtered or unexported fields
}

func New

func New(authURL, graphqlURL string, interceptors ...clientv2.RequestInterceptor) *Client

func (*Client) CreatePAT

func (n *Client) CreatePAT(
	ctx context.Context,
	accessToken string,
) (credentials.Credentials, error)

func (*Client) Login

func (n *Client) Login(ctx context.Context, email, password string) (credentials.Session, error)

func (*Client) LoginPAT

func (n *Client) LoginPAT(ctx context.Context, pat string) (credentials.Session, error)

func (*Client) Logout

func (n *Client) Logout(ctx context.Context, refreshTokenID string, accessToken string) error

func (*Client) RefreshToken

func (n *Client) RefreshToken(
	ctx context.Context,
	refreshToken string,
) (RefreshTokenResponse, error)

func (*Client) VerifyEmail

func (n *Client) VerifyEmail(ctx context.Context, email string) error

type CreatePATRequest

type CreatePATRequest struct {
	ExpiresAt time.Time      `json:"expiresAt"`
	Metadata  map[string]any `json:"metadata"`
}

type Func

type Func func(attempt int) error

type LoginPATRequest

type LoginPATRequest struct {
	PersonalAccessToken string `json:"personalAccessToken"`
}

type LoginRequest

type LoginRequest struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type RefreshTokenRequest

type RefreshTokenRequest struct {
	RefreshToken string `json:"refreshToken"`
}

type RefreshTokenResponse

type RefreshTokenResponse struct {
	AccessToken string `json:"accessToken"`
}

type RequestError

type RequestError struct {
	Status    int    `json:"status"`
	ErrorCode string `json:"error"`
	Message   string `json:"message"`
}

func (*RequestError) Error

func (e *RequestError) Error() string

type ResponseValidator

type ResponseValidator func(resp *http.Response) error

type VerifyEmailRequest

type VerifyEmailRequest struct {
	Email string `json:"email"`
}