apiresource

Documentation

Index

• Variables
• type APIResource
  • func NewAPIResource(communicator *communicator.Communicator, clientMetaInfo string, ...) (*APIResource, error)
  • func NewAPIResourceWithParent(parent *APIResource, pathContext map[string]string) *APIResource
  • func (ar *APIResource) ClientHeaders() []communication.Header
  • func (ar *APIResource) ClientMetaInfo() string
  • func (ar *APIResource) Communicator() *communicator.Communicator
  • func (ar *APIResource) InstantiateURI(uri string) (string, error)
  • func (ar *APIResource) InstantiateURIWithContext(uri string, pathContext map[string]string) (string, error)

Variables

var ErrNilCommunicator = errors.New("communicator is nil")

ErrNilCommunicator occurs when the communicator is nil

var ErrNilParent = errors.New("parent is nil")

ErrNilParent occurs when the parent is nil

Types

type APIResource

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

APIResource represents the base type of all Ingenico ePayments platform API resources.

func NewAPIResource

func NewAPIResource(communicator *communicator.Communicator, clientMetaInfo string, pathContext map[string]string) (*APIResource, error)

NewAPIResource creates an APIResource with the given communicator, clientMetaInfo and pathContext

func NewAPIResourceWithParent

func NewAPIResourceWithParent(parent *APIResource, pathContext map[string]string) *APIResource

NewAPIResourceWithParent creates an APIResource with the given parent and pathContext

func (*APIResource) ClientHeaders

func (ar *APIResource) ClientHeaders() []communication.Header

ClientHeaders returns the headers used by the resource

func (*APIResource) ClientMetaInfo

func (ar *APIResource) ClientMetaInfo() string

ClientMetaInfo returns the ClientMetaInfo used by the resource

func (*APIResource) Communicator

func (ar *APIResource) Communicator() *communicator.Communicator

Communicator returns the Communicator used by the resource

func (*APIResource) InstantiateURI

func (ar *APIResource) InstantiateURI(uri string) (string, error)

InstantiateURI instantiates the given uri with the path context of the resource

func (*APIResource) InstantiateURIWithContext

func (ar *APIResource) InstantiateURIWithContext(uri string, pathContext map[string]string) (string, error)

InstantiateURIWithContext instantiates the given URI with the path context