gateways

Documentation

Overview

Package gateways contains the different interfaces to send the TicketBAI documents to.

Index

• Variables
• type ArabaConn
  • func (c *ArabaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error
  • func (c *ArabaConn) Post(ctx context.Context, doc *doc.TicketBAI) error
• type ArabaResponse
• type Connection
  • func New(env Environment, zone l10n.Code, cert *xmldsig.Certificate) (Connection, error)
• type EBizkaiaConn
  • func (c *EBizkaiaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error
  • func (c *EBizkaiaConn) Fetch(ctx context.Context, nif, name, year string, page int, ...) ([]*doc.TicketBAI, error)
  • func (c *EBizkaiaConn) Post(ctx context.Context, doc *doc.TicketBAI) error
• type Environment
• type Error
  • func (e *Error) Code() string
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
  • func (e *Error) Key() string
  • func (e *Error) Message() string
• type GipuzkoaConn
  • func (c *GipuzkoaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error
  • func (c *GipuzkoaConn) Post(ctx context.Context, doc *doc.TicketBAI) error
• type GipuzkoaResponse

Variables

var (
	ErrConnection = newError("connection")
	ErrValidation = newError("validation")
	ErrDuplicate  = newError("duplicate")
)

Standard gateway error responses. Keys match the ones from main package.

Types

type ArabaConn

type ArabaConn struct {
	// contains filtered or unexported fields
}

ArabaConn keeps all the connection details together for the Araba region.

func (*ArabaConn) Cancel

func (c *ArabaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error

Cancel will send a request to the Araba API to cancel a previously issued document.

func (*ArabaConn) Post

func (c *ArabaConn) Post(ctx context.Context, doc *doc.TicketBAI) error

Post sends the complete TicketBAI document to the Araba API.

type ArabaResponse

type ArabaResponse struct {
	Output struct {
		ID                string `xml:"IdentificadoTBAI"`
		Data              string `xml:"FechaRecepcion"`
		Status            string `xml:"Estado"`
		Description       string `xml:"Descripcion"`
		BasqueDescription string `xml:"Azalpena"` // Description, but in Basque
		Errors            []struct {
			Code              string `xml:"Codigo"`
			Description       string `xml:"Descripcion"`
			BasqueDescription string `xml:"Azalpena"`
		} `xml:"ResultadosValidacion"`
		CSV string `xml:"CSV"` // Secure Verification Code
	} `xml:"Salida"`
}

ArabaResponse defines the response fields from the Araba region.

type Connection

type Connection interface {
	// Post sends the complete TicketBAI document to the remote end-point. We assume
	// the document has been fully prepared and signed.
	Post(ctx context.Context, doc *doc.TicketBAI) error
	Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error
}

Connection defines what is expected from a connection to a gateway.

func New

func New(env Environment, zone l10n.Code, cert *xmldsig.Certificate) (Connection, error)

New instantiates a new connection for the given zone and environment.

type EBizkaiaConn

type EBizkaiaConn struct {
	// contains filtered or unexported fields
}

EBizkaiaConn keeps all the connection details together for the Vizcaya region.

func (*EBizkaiaConn) Cancel

func (c *EBizkaiaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error

Cancel sends the cancellation request for the TickeBAI invoice to the remote end-point.

func (*EBizkaiaConn) Fetch

func (c *EBizkaiaConn) Fetch(ctx context.Context, nif, name, year string, page int, head *doc.CabeceraFactura) ([]*doc.TicketBAI, error)

Fetch retrieves the TicketBAI from the remote end-point for the given taxpayer and year. This is no longer used as it is only available in this region.

func (*EBizkaiaConn) Post

func (c *EBizkaiaConn) Post(ctx context.Context, doc *doc.TicketBAI) error

Post sends the complete TicketBAI document to the remote end-point. We assume the document has been signed and prepared.

type Environment

type Environment string

Environment defines the environment to use for connections

const (
	EnvironmentProduction Environment = "production"
	EnvironmentSandbox    Environment = "sandbox"
)

Environment to use for connections

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error allows for structured responses from the gateway to be able to response codes and messages.

func (*Error) Code

func (e *Error) Code() string

Code returns the code provided by the remote service.

func (*Error) Error

func (e *Error) Error() string

Error produces a human readable error message.

func (*Error) Is

func (e *Error) Is(target error) bool

Is checks to see if the target error is the same as the current one or forms part of the chain.

func (*Error) Key

func (e *Error) Key() string

Key returns the key for the error.

func (*Error) Message

func (e *Error) Message() string

Message returns the human message for the error.

type GipuzkoaConn

type GipuzkoaConn struct {
	// contains filtered or unexported fields
}

GipuzkoaConn keeps all the connection details together for the Gipuzkoa region.

func (*GipuzkoaConn) Cancel

func (c *GipuzkoaConn) Cancel(ctx context.Context, doc *doc.AnulaTicketBAI) error

Cancel will send a request to the Gipuzkoa API to cancel a previously issued document.

func (*GipuzkoaConn) Post

func (c *GipuzkoaConn) Post(ctx context.Context, doc *doc.TicketBAI) error

Post sends the complete TicketBAI document to the Gipuzkoa API.

type GipuzkoaResponse

type GipuzkoaResponse struct {
	Output struct {
		ID                string `xml:"IdentificadoTBAI"`
		Data              string `xml:"FechaRecepcion"`
		Status            string `xml:"Estado"`
		Description       string `xml:"Descripcion"`
		BasqueDescription string `xml:"Azalpena"` // Description, but in Basque
		Errors            []struct {
			Code              string `xml:"Codigo"`
			Description       string `xml:"Descripcion"`
			BasqueDescription string `xml:"Azalpena"`
		} `xml:"ResultadosValidacion"`
		CSV string `xml:"CSV"` // Secure Verification Code
	} `xml:"Salida"`
}

GipuzkoaResponse defines the response fields from the Gipuzkoa region.