api

Documentation

Index

• type Account
• type AccountsApi
  • func NewAccountsApi(querier dbc.Querier, ctx *context.Context) AccountsApi
• type AccountsApiFactory
• type Person
• type UserCreateInput

Types

type Account

type Account struct {
	ID     uuid.UUID
	Email  string
	Person *Person
}

Account: an actor in the system. e.g. service account or user accoun

type AccountsApi

type AccountsApi interface {
	GetUserById(id uuid.UUID) (*Account, error)
	GetUserByEmail(email string) (*Account, error)
	CreateAccount(email string) (uuid.UUID, error)
	CreateUser(input UserCreateInput) (uuid.UUID, error)
}

AccountsApi: interfaces for working with accounts and users

func NewAccountsApi

func NewAccountsApi(querier dbc.Querier, ctx *context.Context) AccountsApi

NewAccountsApi: factor for an instance of AccountsApi

type AccountsApiFactory

type AccountsApiFactory func(querier dbc.Querier, ctx *context.Context) AccountsApi

AccountsApiFactory: injected into context so testing can mock the api.

type Person

type Person struct {
	ID        uuid.UUID
	AccountID uuid.UUID
	FirstName string
	LastName  string
}

Person: a person in the system. When an account has a person, then it is a user account

type UserCreateInput

type UserCreateInput struct {
	Email     string
	FirstName string
	LastName  string
}

UserCreateInput: input type for creating a user