connection

Jul 17, 2024

Changes in this version

type APIRequest

+ Query url.Values

type Enum

+ var APIRequestFilteringOperatorEnum Enum[APIRequestFilteringOperator] = []APIRequestFilteringOperator{ ... }

+ func (e Enum[T]) Parse(s string) (T, error)

+ func (e Enum[T]) Values() []string

+ type EnumValue interface

+ String func() string

Oct 26, 2022

Changes in this version

+ type ConnectionFactory interface

+ NewConnection func() (Connection, error)

+ type DefaultConnectionFactory struct

+ func NewDefaultConnectionFactory(opts ...DefaultConnectionFactoryOption) *DefaultConnectionFactory

+ func (f *DefaultConnectionFactory) NewConnection() (Connection, error)

+ type DefaultConnectionFactoryOption func(f *DefaultConnectionFactory)

+ func WithDefaultConnectionUserAgent(userAgent string) DefaultConnectionFactoryOption

Oct 20, 2022

Changes in this version

+ func APIResponseJSONDeserializer(r *APIResponse, out interface{}) error

+ type RequestSerializer interface

+ Serialize func() ([]byte, error)

Oct 20, 2022

Changes in this version

+ type ResponseDeserializerFunc func(resp *APIResponse, out interface{}) error

+ var JSONResponseDeserializerFunc ResponseDeserializerFunc = func(r *APIResponse, out interface{}) error { ... }

+ var NopResponseDeserializerFunc ResponseDeserializerFunc = func(r *APIResponse, out interface{}) error { ... }

Oct 19, 2022

Changes in this version

type APIResponseBody

+ func (d *APIResponseBody) Deserializer() func(r *APIResponse, out interface{}) error

type NopResponseDeserializer

+ func (d *NopResponseDeserializer) Deserializer() func(r *APIResponse, out interface{}) error

type ResponseDeserializer

+ Deserializer func() func(r *APIResponse, out interface{}) error

Oct 19, 2022

Changes in this version

+ func DeleteRaw(conn Connection, resource string, body interface{}, responseBody interface{}, ...) error

+ func GetRaw(conn Connection, resource string, parameters APIRequestParameters, ...) error

+ func PatchRaw(conn Connection, resource string, body interface{}, responseBody interface{}, ...) error

+ func PostRaw(conn Connection, resource string, body interface{}, responseBody interface{}, ...) error

+ func PutRaw(conn Connection, resource string, body interface{}, responseBody interface{}, ...) error

type APIResponseBody

+ func (d *APIResponseBody) Deserialize(r *APIResponse, out interface{}) error

+ type NopResponseDeserializer struct

+ func (d *NopResponseDeserializer) Deserialize(r *APIResponse, out interface{}) error

+ type ResponseDeserializer interface

+ Deserialize func(r *APIResponse, out interface{}) error

Oct 13, 2022

Changes in this version

type APIResponseBody

+ func (a *APIResponseBody) Error() error

+ type APIResponseBodyError struct

+ Errors []APIResponseBodyErrorItem

+ Message string

+ func (e *APIResponseBodyError) Error() string

+ type APIResponseBodyErrorItem struct

+ Detail string

+ Source string

+ Status int

+ Title string

+ func (a *APIResponseBodyErrorItem) Error() string

type ResponseBody

+ Error func() error

Sep 23, 2022

Changes in this version

type APIResponseBodyData

+ func Delete(conn Connection, resource string, body interface{}, ...) (*APIResponseBodyData[T], error)

+ func Get(conn Connection, resource string, parameters APIRequestParameters, ...) (*APIResponseBodyData[T], error)

+ func Patch(conn Connection, resource string, body interface{}, ...) (*APIResponseBodyData[T], error)

+ func Post(conn Connection, resource string, body interface{}, ...) (*APIResponseBodyData[T], error)

+ func Put(conn Connection, resource string, body interface{}, ...) (*APIResponseBodyData[T], error)

type ResponseHandler

+ func NotFoundResponseHandler(err error) ResponseHandler

+ func StatusCodeResponseHandler(code int, err error) ResponseHandler

Jun 23, 2022

Changes in this version

+ func InvokeRequestAll(getFunc PaginatedGetFunc[T], parameters APIRequestParameters) ([]T, error)

+ type APIConnection struct

+ APIScheme string

+ APIURI string

+ Credentials Credentials

+ HTTPClient *http.Client

+ Headers http.Header

+ UserAgent string

+ func NewAPIConnection(credentials Credentials) *APIConnection

+ func NewAPIKeyCredentialsAPIConnection(apiKey string) *APIConnection

+ func (c *APIConnection) Delete(resource string, body interface{}) (*APIResponse, error)

+ func (c *APIConnection) Get(resource string, parameters APIRequestParameters) (*APIResponse, error)

+ func (c *APIConnection) Invoke(request APIRequest) (*APIResponse, error)

+ func (c *APIConnection) InvokeRequest(req *http.Request) (*APIResponse, error)

+ func (c *APIConnection) NewRequest(request APIRequest) (*http.Request, error)

+ func (c *APIConnection) Patch(resource string, body interface{}) (*APIResponse, error)

+ func (c *APIConnection) Post(resource string, body interface{}) (*APIResponse, error)

+ func (c *APIConnection) Put(resource string, body interface{}) (*APIResponse, error)

+ type APIKeyCredentials struct

+ APIKey string

+ func (c *APIKeyCredentials) GetAuthHeaders() AuthHeaders

+ type APIRequest struct

+ Body interface{}

+ Method string

+ Parameters APIRequestParameters

+ Resource string

+ type APIRequestBodyDefaultValidator struct

+ func (a *APIRequestBodyDefaultValidator) Validate(v interface{}) *ValidationError

+ type APIRequestFiltering struct

+ Operator APIRequestFilteringOperator

+ Property string

+ Value []string

+ func NewAPIRequestFiltering(property string, operator APIRequestFilteringOperator, value []string) *APIRequestFiltering

+ type APIRequestFilteringOperator int

+ const EQOperator

+ const GTOperator

+ const INOperator

+ const LKOperator

+ const LTOperator

+ const NEQOperator

+ const NINOperator

+ const NLKOperator

+ func ParseOperator(o string) (APIRequestFilteringOperator, error)

+ func (o APIRequestFilteringOperator) String() string

+ type APIRequestPagination struct

+ Page int

+ PerPage int

+ type APIRequestParameters struct

+ Filtering []APIRequestFiltering

+ Pagination APIRequestPagination

+ Sorting APIRequestSorting

+ func NewAPIRequestParameters() *APIRequestParameters

+ func (p *APIRequestParameters) Copy() APIRequestParameters

+ func (p *APIRequestParameters) WithFilter(filters ...APIRequestFiltering) *APIRequestParameters

+ func (p *APIRequestParameters) WithPagination(pagination APIRequestPagination) *APIRequestParameters

+ func (p *APIRequestParameters) WithSorting(sorting APIRequestSorting) *APIRequestParameters

+ type APIRequestSorting struct

+ Descending bool

+ Property string

+ type APIResponse struct

+ func (r *APIResponse) DeserializeResponseBody(out interface{}) error

+ func (r *APIResponse) HandleResponse(respBody ResponseBody, handlers ...ResponseHandler) error

+ func (r *APIResponse) ValidateStatusCode(codes []int, respBody ResponseBody) error

+ type APIResponseBody struct

+ Errors []APIResponseError

+ Message string

+ Metadata APIResponseMetadata

+ func (a *APIResponseBody) ErrorString() string

+ func (a *APIResponseBody) Pagination() APIResponseMetadataPagination

+ type APIResponseBodyData struct

+ Data T

+ type APIResponseBodyStringData struct

+ Data string

+ type APIResponseError struct

+ Detail string

+ Source string

+ Status int

+ Title string

+ func (a *APIResponseError) Error() error

+ func (a *APIResponseError) String() string

+ type APIResponseMetadata struct

+ Pagination APIResponseMetadataPagination

+ type APIResponseMetadataPagination struct

+ Count int

+ Links APIResponseMetadataPaginationLinks

+ PerPage int

+ Total int

+ TotalPages int

+ type APIResponseMetadataPaginationLinks struct

+ First string

+ Last string

+ Next string

+ Previous string

+ type AuthHeaders map[string]string

+ type Connection interface

+ Delete func(resource string, body interface{}) (*APIResponse, error)

+ Get func(resource string, parameters APIRequestParameters) (*APIResponse, error)

+ Invoke func(request APIRequest) (*APIResponse, error)

+ Patch func(resource string, body interface{}) (*APIResponse, error)

+ Post func(resource string, body interface{}) (*APIResponse, error)

+ Put func(resource string, body interface{}) (*APIResponse, error)

+ type Credentials interface

+ GetAuthHeaders func() AuthHeaders

+ type Date string

+ func (c Date) String() string

+ func (c Date) Time() time.Time

+ type DateTime string

+ func (c DateTime) String() string

+ func (c DateTime) Time() time.Time

+ type Enum interface

+ String func() string

+ func ParseEnum(s string, enums EnumSlice) (Enum, error)

+ type EnumSlice []Enum

+ func (enums EnumSlice) String() string

+ func (enums EnumSlice) StringSlice() []string

+ type ErrInvalidEnumValue struct

+ Message string

+ func NewErrInvalidEnumValue(msg string) *ErrInvalidEnumValue

+ func (e *ErrInvalidEnumValue) Error() string

+ type IPAddress string

+ func (i IPAddress) IP() net.IP

+ func (i IPAddress) String() string

+ type Paginated struct

+ func NewPaginated(body *APIResponseBodyData[[]T], parameters APIRequestParameters, ...) *Paginated[T]

+ func (p *Paginated[T]) CurrentPage() int

+ func (p *Paginated[T]) First() (*Paginated[T], error)

+ func (p *Paginated[T]) Items() []T

+ func (p *Paginated[T]) Last() (*Paginated[T], error)

+ func (p *Paginated[T]) Next() (*Paginated[T], error)

+ func (p *Paginated[T]) Previous() (*Paginated[T], error)

+ func (p *Paginated[T]) Total() int

+ func (p *Paginated[T]) TotalPages() int

+ type PaginatedGetFunc func(parameters APIRequestParameters) (*Paginated[T], error)

+ type ResponseBody interface

+ ErrorString func() string

+ Pagination func() APIResponseMetadataPagination

+ type ResponseHandler func(resp *APIResponse) error

+ type Validatable interface

+ Validate func() *ValidationError

+ type ValidationError struct

+ Message string

+ func NewValidationError(msg string) *ValidationError

+ func (e *ValidationError) Error() string