utils

Documentation

Index

• Variables
• func BuildFlexibleSearchQuery(criteria []SearchQueryCriteria, additionalQuery ...Fields) string
• func BuildSearchQuery(field, value, conditionType string) string
• func MayReturnErrorForHTTPResponse(err error, resp *resty.Response, triedTo string) error
• func MayTrimSurroundingQuotes(s string) string
• type Fields
• type Filter
• type FilterFields
• type SearchQueryCriteria

Variables

var ErrBadRequest = fmt.Errorf("%s", "bad request")

var ErrExecution = fmt.Errorf("%s", "failed while calling endpoint")

var ErrInternalServer = fmt.Errorf("%s", "internal server error")

Functions

func BuildFlexibleSearchQuery

func BuildFlexibleSearchQuery(criteria []SearchQueryCriteria, additionalQuery ...Fields) string

this method is used to build very flexible search-queries for example: ?searchCriteria[filter_groups][2][filters][0][field]=increment_id &searchCriteria[filter_groups][2][filters][0][value]=XXXXX &searchCriteria[filter_groups][2][filters][0][condition_type]=eq &fields=items[entity_id]

func BuildSearchQuery

func BuildSearchQuery(field, value, conditionType string) string

use this method for building simple search queries without any flexibility

func MayReturnErrorForHTTPResponse

func MayReturnErrorForHTTPResponse(err error, resp *resty.Response, triedTo string) error

func MayTrimSurroundingQuotes

func MayTrimSurroundingQuotes(s string) string

Types

type Fields

type Fields struct {
	Key   string
	Value string
}

type Filter

type Filter struct {
	FilterGroups int
	Filters      int
	FilterFor    string
}

type FilterFields

type FilterFields struct {
	Field         Filter
	Value         Filter
	ConditionType Filter
}

type SearchQueryCriteria

type SearchQueryCriteria struct {
	Fields []FilterFields
}