clients

Documentation

Overview

Package clients provides the client related business logic.

Index

• Variables
• func Activate(ctx context.Context, db database.Database, project *types.Project, ...) (*database.ClientInfo, error)
• func Deactivate(ctx context.Context, db database.Database, projectID types.ID, ...) (*database.ClientInfo, error)
• func FindClientInfo(ctx context.Context, db database.Database, project *types.Project, ...) (*database.ClientInfo, error)

Variables

var (
	// ErrInvalidClientKey is returned when the given Key is not valid ClientKey.
	ErrInvalidClientKey = errors.New("invalid client key")

	// ErrInvalidClientID is returned when the given Key is not valid ClientID.
	ErrInvalidClientID = errors.New("invalid client id")
)

Functions

func Activate

func Activate(
	ctx context.Context,
	db database.Database,
	project *types.Project,
	clientKey string,
) (*database.ClientInfo, error)

Activate activates the given client.

func Deactivate

func Deactivate(
	ctx context.Context,
	db database.Database,
	projectID types.ID,
	clientID types.ID,
) (*database.ClientInfo, error)

Deactivate deactivates the given client.

func FindClientInfo

func FindClientInfo(
	ctx context.Context,
	db database.Database,
	project *types.Project,
	clientID *time.ActorID,
) (*database.ClientInfo, error)

FindClientInfo finds the client with the given id.