ports

Documentation

Index

• type Accounts
• type Handlers
• type Me
• type Operators
• type Repository
• type Users

Types

type Accounts

type Accounts interface {
	// ListAccounts ...
	ListAccounts(ctx context.Context, pagination *models.Pagination[models.Account]) error
	// CreateAccount ...
	CreateAccount(ctx context.Context, account *models.Account) error
	// GetAccount ...
	GetAccount(ctx context.Context, account *models.Account) error
	// UpdateAccount ...
	UpdateAccount(ctx context.Context, account *models.Account) error
	// DeleteAccount ...
	DeleteAccount(ctx context.Context, account *models.Account) error
}

Accounts is a port that defines the methods for accounts

type Handlers

type Handlers interface {
	// Login ...
	Login() fiber.Handler
	// Dashboard ...
	Dashboard() fiber.Handler
	// Me ...
	Me() fiber.Handler
	// ListOperators ...
	ListOperators() fiber.Handler
	// NewOperator ...
	NewOperator() fiber.Handler
	// CreateOperator ...
	CreateOperator() fiber.Handler
	// ShowOperator ...
	ShowOperator() fiber.Handler
	// TokenOperator ...
	TokenOperator() fiber.Handler
	// DeleteOperator ...
	DeleteOperator() fiber.Handler
	// ListAccounts ...
	ListAccounts() fiber.Handler
	// NewAccount ...
	NewAccount() fiber.Handler
	// CreateAccount ...
	CreateAccount() fiber.Handler
	// ShowAccount ...
	ShowAccount() fiber.Handler
	// DeleteAccount ...
	DeleteAccount() fiber.Handler
	// ListUsers ...
	ListUsers() fiber.Handler
	// NewOperatorSkg ...
	NewOperatorSkg() fiber.Handler
	// CreateOperatorSkg ...
	CreateOperatorSkg() fiber.Handler
	// OperatorSkgsOptions ...
	OperatorSkgsOptions() fiber.Handler
	// AccountSksOptions ...
	AccountSksOptions() fiber.Handler
	// NewUser ...
	NewUser() fiber.Handler
	// ShowUser ...
	ShowUser() fiber.Handler
	// UserCredentials ...
	UserCredentials() fiber.Handler
	// DeleteUser ...
	DeleteUser() fiber.Handler
	// UpdateSystemAccount ...
	UpdateSystemAccount() fiber.Handler
	// GetAccountToken ...
	GetAccountToken() fiber.Handler
	// ListSystems ...
	ListSystems() fiber.Handler
}

Handlers ...

type Me

type Me interface {
	// GetProfile is a method that returns the profile of the current user
	GetProfile(ctx context.Context, user *adapters.GothUser) error
}

Me ...

type Operators

type Operators interface {
	// ListOperators is a method that returns a list of operators
	ListOperators(ctx context.Context, pagination *models.Pagination[models.Operator]) error
	// CreateOperator is a method that creates a new operator
	CreateOperator(ctx context.Context, operator *models.Operator) error
	// GetOperator is a method that returns an operator by ID
	GetOperator(ctx context.Context, operator *models.Operator) error
	// UpdateOperator is a method that updates an operator
	UpdateOperator(ctx context.Context, operator *models.Operator) error
	// DeleteOperator is a method that deletes an operator
	DeleteOperator(ctx context.Context, operator *models.Operator) error
}

Operators is a port that defines the methods for operators

type Repository

type Repository interface {
	Accounts
	Operators
	Users
	Me
}

Repository ...

type Users

type Users interface {
	// GetUser is a method that returns a user by ID
	GetUser(ctx context.Context, user *models.User) error
	// ListUsers is a method that returns a list of users
	ListUsers(ctx context.Context, pagination *models.Pagination[models.User]) error
	// CreateUser is a method that creates a user
	CreateUser(ctx context.Context, user *models.User) error
	// UpdateUser is a method that updates a user
	UpdateUser(ctx context.Context, user *models.User) error
	// DeleteUser is a method that deletes a user
	DeleteUser(ctx context.Context, user *models.User) error
}

Users ...