repository

Documentation

Overview

Package repository implements different repository services required by the user service

Package repository implements different repository services required by the user service

Index

• type CreateUserRequest
• type CreateUserResponse
• type DeleteUserRequest
• type DeleteUserResponse
• type ReadUserRequest
• type ReadUserResponse
• type RepositoryContract
• type UpdateUserRequest
• type UpdateUserResponse

Types

type CreateUserRequest

type CreateUserRequest struct {
	Email string
	User  models.User
}

CreateUserRequest contains the request to create a new user

type CreateUserResponse

type CreateUserResponse struct {
	User   models.User
	Cursor string
}

CreateUserResponse contains the result of creating a new user

type DeleteUserRequest

type DeleteUserRequest struct {
	Email string
}

DeleteUserRequest contains the request to delete an existing user

type DeleteUserResponse

type DeleteUserResponse struct {
}

DeleteUserResponse contains the result of deleting an existing user

type ReadUserRequest

type ReadUserRequest struct {
	Email string
}

ReadUserRequest contains the request to read an existing user

type ReadUserResponse

type ReadUserResponse struct {
	User models.User
}

ReadUserResponse contains the result of reading an existing user

type RepositoryContract

type RepositoryContract interface {
	// CreateUser creates a new user.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to create a new user
	// Returns either the result of creating new user or error if something goes wrong.
	CreateUser(
		ctx context.Context,
		request *CreateUserRequest) (*CreateUserResponse, error)

	// ReadUser read an existing user
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to read an existing user
	// Returns either the result of reading an existing user or error if something goes wrong.
	ReadUser(
		ctx context.Context,
		request *ReadUserRequest) (*ReadUserResponse, error)

	// UpdateUser update an existing user
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to update an existing user
	// Returns either the result of updateing an existing user or error if something goes wrong.
	UpdateUser(
		ctx context.Context,
		request *UpdateUserRequest) (*UpdateUserResponse, error)

	// DeleteUser delete an existing user
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to delete an existing user
	// Returns either the result of deleting an existing user or error if something goes wrong.
	DeleteUser(
		ctx context.Context,
		request *DeleteUserRequest) (*DeleteUserResponse, error)
}

RepositoryContract declares the repository service that can create new user, read, update and delete existing users.

type UpdateUserRequest

type UpdateUserRequest struct {
	Email string
	User  models.User
}

UpdateUserRequest contains the request to update an existing user

type UpdateUserResponse

type UpdateUserResponse struct {
	User   models.User
	Cursor string
}

UpdateUserResponse contains the result of updating an existing user