api

type Client interface {
	// Do sends an HTTP request to the OneFS API.
	Do(
		ctx context.Context,
		method, path, id string,
		params OrderedValues,
		body, resp interface{}) error

	// DoWithHeaders sends an HTTP request to the OneFS API.
	DoWithHeaders(
		ctx context.Context,
		method, path, id string,
		params OrderedValues, headers map[string]string,
		body, resp interface{}) error

	// Get sends an HTTP request using the GET method to the OneFS API.
	Get(
		ctx context.Context,
		path, id string,
		params OrderedValues, headers map[string]string,
		resp interface{}) error

	// Post sends an HTTP request using the POST method to the OneFS API.
	Post(
		ctx context.Context,
		path, id string,
		params OrderedValues, headers map[string]string,
		body, resp interface{}) error

	// Put sends an HTTP request using the PUT method to the OneFS API.
	Put(
		ctx context.Context,
		path, id string,
		params OrderedValues, headers map[string]string,
		body, resp interface{}) error

	// Delete sends an HTTP request using the DELETE method to the OneFS API.
	Delete(
		ctx context.Context,
		path, id string,
		params OrderedValues, headers map[string]string,
		resp interface{}) error

	// APIVersion returns the API version.
	APIVersion() uint8

	// User returns the user name used to access the OneFS API.
	User() string

	// Group returns the group name used to access the OneFS API.
	Group() string

	// VolumesPath returns the client's configured volumes path.
	VolumesPath() string

	// VolumePath returns the path to a volume with the provided name.
	VolumePath(name string) string

	// SetAuthToken sets the Auth token/Cookie for the HTTP client
	SetAuthToken(token string)

	// SetCSRFToken sets the Auth token for the HTTP client
	SetCSRFToken(csrf string)

	// SetReferer sets the Referer header
	SetReferer(referer string)

	// GetAuthToken gets the Auth token/Cookie for the HTTP client
	GetAuthToken() string

	// GetCSRFToken gets the CSRF token for the HTTP client
	GetCSRFToken() string

	// GetReferer gets the Referer header
	GetReferer() string
}

type ClientOptions struct {
	// Insecure is a flag that indicates whether or not to supress SSL errors.
	Insecure bool

	// VolumesPath is the location on the Isilon server where volumes are
	// stored.
	VolumesPath string

	// VolumesPathPermissions is the directory permissions for VolumesPath
	VolumesPathPermissions string

	// IgnoreUnresolvableHosts is the unresolvable hosts param from platform
	IgnoreUnresolvableHosts bool

	// Timeout specifies a time limit for requests made by this client.
	Timeout time.Duration
}

type Error struct {
	Code    string `json:"code"`
	Field   string `json:"field"`
	Message string `json:"message"`
}

type HTMLError struct {
	StatusCode int
	Message    string
}

type JSONError struct {
	StatusCode int
	Err        []Error `json:"errors"`
}

type OrderedValues [][][]byte

type VerboseType uint