audittraillib

README

audittrailclient

Documentation

Index

• type AuditTrail
• type AuditTrailFilter
• type Client
  • func NewClient(baseURL string, token string, apiKey string, httpClient ...*http.Client) *Client
  • func (c *Client) GetAuditTrailByActionType(actionType string) ([]AuditTrail, error)
  • func (c *Client) GetAuditTrailByDateRange(startDate, endDate time.Time) ([]AuditTrail, error)
  • func (c *Client) GetAuditTrailByEntityID(entityID uuid.UUID) ([]AuditTrail, error)
  • func (c *Client) GetAuditTrailByEntityName(entityName string) ([]AuditTrail, error)
  • func (c *Client) GetAuditTrailByUserID(userID uuid.UUID) ([]AuditTrail, error)
  • func (c *Client) GetFilteredAuditTrail(filter *AuditTrailFilter) ([]AuditTrail, error)
  • func (c *Client) LogAction(auditTrail AuditTrail) (bool, error)

Types

type AuditTrail

type AuditTrail struct {
	ID         uuid.UUID `json:"id"`
	UserID     uuid.UUID `json:"user_id"`
	ActionType string    `json:"action_type"`
	EntityName string    `json:"entity_name"`
	EntityID   uuid.UUID `json:"entity_id"`
	ChangeData string    `json:"change_data"` // or use a custom type if needed
	Timestamp  time.Time `json:"timestamp"`
}

type AuditTrailFilter

type AuditTrailFilter struct {
	UserID     *uuid.UUID
	ActionType *string
	EntityName *string
	StartDate  *time.Time
	EndDate    *time.Time
}

type Client

type Client struct {
	BaseURL    string
	HttpClient *http.Client
	Token      string
	ApiKey     string
}

Client represents an HTTP client that can be used to send requests to the audit trail server.

func NewClient

func NewClient(baseURL string, token string, apiKey string, httpClient ...*http.Client) *Client

func (*Client) GetAuditTrailByActionType

func (c *Client) GetAuditTrailByActionType(actionType string) ([]AuditTrail, error)

func (*Client) GetAuditTrailByDateRange

func (c *Client) GetAuditTrailByDateRange(startDate, endDate time.Time) ([]AuditTrail, error)

func (*Client) GetAuditTrailByEntityID

func (c *Client) GetAuditTrailByEntityID(entityID uuid.UUID) ([]AuditTrail, error)

func (*Client) GetAuditTrailByEntityName

func (c *Client) GetAuditTrailByEntityName(entityName string) ([]AuditTrail, error)

func (*Client) GetAuditTrailByUserID

func (c *Client) GetAuditTrailByUserID(userID uuid.UUID) ([]AuditTrail, error)

func (*Client) GetFilteredAuditTrail

func (c *Client) GetFilteredAuditTrail(filter *AuditTrailFilter) ([]AuditTrail, error)

func (*Client) LogAction

func (c *Client) LogAction(auditTrail AuditTrail) (bool, error)