accesskey

Documentation

Index

• Variables
• func Check(accessKey AccessKey) error
• func CheckNFF(accessKey AccessKey) error
• type AccessKey
  • func (a AccessKey) MarshalZerologObject(e *zerolog.Event)
  • func (a AccessKey) String() string
• type Validator
  • func NewValidator() Validator

Variables

var (
	// ErrCodeInvalidAccessKey is an error code used to imply that an access key provided was not valid
	// Deprecated: prefer using the more specific error codes and the Check function
	ErrCodeInvalidAccessKey = errors.Code("INVALID_ACCESS_KEY")
	// ErrCodeEmptyAccessKey is an error code used to imply that an access key provided was empty
	ErrCodeEmptyAccessKey = errors.Code("EMPTY_ACCESS_KEY")
	// ErrCodeInvalidLength is an error code used to imply that an access key does not contains 44 digits
	ErrCodeInvalidLength = errors.Code("INVALID_LENGTH")
	// ErrCodeInvalidCharacter is an error code used to imply that an access key has non-numeric character(s)
	ErrCodeInvalidCharacter = errors.Code("INVALID_CHARACTER")
	// ErrCodeInvalidUF is an error code used to imply that an access key does not contain a valid IBGE UF code
	ErrCodeInvalidUF = errors.Code("INVALID_UF")
	// ErrCodeInvalidMonth is an error code used to imply that an access key does not contain a month value between 01-12
	ErrCodeInvalidMonth = errors.Code("INVALID_MONTH")
	// ErrCodeInvalidCPFCNPJ is an error code used to imply that an access key does not contain a valid CNPJ
	ErrCodeInvalidCPFCNPJ = errors.Code("INVALID_CPF_CNPJ")
	// ErrCodeInvalidModel is an error code used to imply that an access key does not contain a valid SEFAZ model
	ErrCodeInvalidModel = errors.Code("INVALID_MODEL")
	// ErrCodeInvalidDigit is an error code used to imply that an access has a verification digit mismatch
	ErrCodeInvalidDigit = errors.Code("INVALID_DIGIT")

	// ErrCodeInvalidSerieForNFF
	ErrCodeInvalidSerieForNFF = errors.Code("INVALID_SERIE_FOR_NFF")
	// ErrCodeInvalidCodigoForNFF
	ErrCodeInvalidNumeroForNFF = errors.Code("INVALID_NUMERO_FOR_NFF")
	// ErrCodeInvalidCNPJForNFF
	ErrCodeInvalidCNPJForNFF = errors.Code("INVALID_CNPJ_FOR_NFF")
	// ErrCodeInvalidCPFForNFF
	ErrCodeInvalidCPFForNFF = errors.Code("INVALID_CPF_FOR_NFF")

	// ErrEmptyAccessKey is returned when the provided access key is an empty string
	ErrEmptyAccessKey = errors.New("access key is empty")
	// ErrInvalidLength the access key does not contains 44 digits
	ErrInvalidLength = errors.New("access key does not have 44 characters")
	// Deprecated: prefer ErrInvalidLength
	ErrInvalidLenght = errors.New("access key does not have 44 characters")
	// ErrInvalidCharacter the access key has non-numeric character(s)
	ErrInvalidCharacter = errors.New("access key contains non-number characters")
	// ErrInvalidUF the access key does not contain a valid IBGE UF code
	ErrInvalidUF = errors.New("access key has invalid UF value")
	// ErrInvalidMonth month not between 01-12
	ErrInvalidMonth = errors.New("access key has invalid month value")
	// ErrInvalidCPFCNPJ the access key does not contain a valid CNPJ
	ErrInvalidCPFCNPJ = errors.New("access key has invalid CPF or CNPJ")
	// ErrInvalidModel is returned when the model is not a valid SEFAZ model
	ErrInvalidModel = errors.New("access key has invalid model")
	// ErrInvalidDigit verification digit mismatch
	ErrInvalidDigit = errors.New("access key has invalid validation digit")

	// ErrInvalidSerieForNFF
	ErrInvalidSerieForNFF = errors.New("access key invalid serie for NFF")
	// ErrInvalidCodigoForNFF
	ErrInvalidNumeroForNFF = errors.New("access key invalid numero for NFF")
)

Functions

func Check

func Check(accessKey AccessKey) error

Check checks if an access key is valid. It returns an error with an specific code based on the validation problem

func CheckNFF

func CheckNFF(accessKey AccessKey) error

CheckNFF checks if an access key is valid with more restrictive rules also considering NFF. It returns an error with an specific code based on the validation proble

Types

type AccessKey

type AccessKey string

AccessKey represents the AccessKey entity

func (AccessKey) MarshalZerologObject

func (a AccessKey) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements the zerolog marshaler so it can be logged using: log.With().EmbededObject(accesskey).Msg("Some message")

func (AccessKey) String

func (a AccessKey) String() string

type Validator

type Validator interface {
	// Deprecated: prefer using the Check function
	Check(AccessKey) error
}

Validator is the interface that performs AccessKey validation Deprecated: prefer using the Check function

func NewValidator

func NewValidator() Validator

NewValidator returns a real validator Deprecated: prefer using the Check function instead of instantiating a Validator