client

type AuthenticateUserOptions struct {
	Username string
	Password string
}

type AuthenticateUserRequest struct {
	Username string
	Password string
}

type AuthenticateUserResponse struct {
	Jwt string
}

type Config struct {
	URL           *url.URL
	User          string
	Password      string
	Token         string
	UserAgent     string
	DoNotUseToken bool
}

type GenericError struct {
	Code    int
	Err     string
	Details string
}

type PortainerClient interface {
	// AuthenticateUser a user to get an auth token
	AuthenticateUser(options AuthenticateUserOptions) (token string, err error)

	// Get endpoints
	EndpointList() ([]portainer.Endpoint, error)

	// Get endpoint groups
	EndpointGroupList() ([]portainer.EndpointGroup, error)

	// Get stacks, optionally filtered by swarmId and endpointId
	StackList(options StackListOptions) ([]portainer.Stack, error)

	// Create swarm stack
	StackCreateSwarm(options StackCreateSwarmOptions) (stack portainer.Stack, err error)

	// Create compose stack
	StackCreateCompose(options StackCreateComposeOptions) (stack portainer.Stack, err error)

	// Update stack
	StackUpdate(options StackUpdateOptions) error

	// Delete stack
	StackDelete(stackID portainer.StackID) error

	// Get stack file content
	StackFileInspect(stackID portainer.StackID) (content string, err error)

	// Get endpoint Docker info
	EndpointDockerInfo(endpointID portainer.EndpointID) (info map[string]interface{}, err error)

	// Get Portainer status info
	Status() (portainer.Status, error)

	// Run a function before sending a request to Portainer
	BeforeRequest(hook func(req *http.Request) (err error))

	// Run a function after receiving a response from Portainer
	AfterResponse(hook func(resp *http.Response) (err error))

	// Proxy proxies a request to /endpoint/{id}/docker and returns its result
	Proxy(endpointID portainer.EndpointID, req *http.Request) (resp *http.Response, err error)

	// ResourceControlCreate creates a resource control
	ResourceControlCreate(options ResourceControlCreateOptions) (resourceControl portainer.ResourceControl, err error)

	// ResourceControlUpdate updates a resource control
	ResourceControlUpdate(options ResourceControlUpdateOptions) (resourceControl portainer.ResourceControl, err error)

	// ResourceControlDelete deletes a resource control
	ResourceControlDelete(resourceControlID portainer.ResourceControlID) (err error)

	// UserList retrieves a list of users
	UserList() (users []portainer.User, err error)

	// GetUsername returns the user name used by the client
	GetUsername() string

	// DoJSONWithToken makes an HTTP request with a JSON body and an auth token
	DoJSONWithToken(uri, method string, headers http.Header, request interface{}, response interface{}) (err error)
}

type ResourceControlCreateOptions struct {
	ResourceID     string
	Type           ResourceType
	Public         bool
	Users          []portainer.UserID
	Teams          []portainer.TeamID
	SubResourceIDs []string
}

type ResourceControlCreateRequest struct {
	ResourceID     string
	Type           ResourceType
	Public         bool               `json:",omitempty"`
	Users          []portainer.UserID `json:",omitempty"`
	Teams          []portainer.TeamID `json:",omitempty"`
	SubResourceIDs []string           `json:",omitempty"`
}

type ResourceControlUpdateOptions struct {
	ID     portainer.ResourceControlID
	Public bool
	Users  []portainer.UserID
	Teams  []portainer.TeamID
}

type ResourceControlUpdateRequest struct {
	Public bool               `json:",omitempty"`
	Users  []portainer.UserID `json:",omitempty"`
	Teams  []portainer.TeamID `json:",omitempty"`
}

type ResourceType string

type StackCreateComposeOptions struct {
	StackName            string
	EnvironmentVariables []portainer.Pair
	StackFileContent     string
	EndpointID           portainer.EndpointID
}

type StackCreateRequest struct {
	Name             string
	SwarmID          string
	StackFileContent string
	Env              []portainer.Pair `json:",omitempty"`
}

type StackCreateSwarmOptions struct {
	StackName            string
	EnvironmentVariables []portainer.Pair
	StackFileContent     string
	SwarmClusterID       string
	EndpointID           portainer.EndpointID
}

type StackFileInspectResponse struct {
	StackFileContent string
}

type StackListFilter struct {
	SwarmID    string               `json:"SwarmId,omitempty"`
	EndpointID portainer.EndpointID `json:"EndpointId,omitempty"`
}

type StackListOptions struct {
	Filter StackListFilter
}

type StackUpdateOptions struct {
	Stack                portainer.Stack
	EnvironmentVariables []portainer.Pair
	StackFileContent     string
	Prune                bool
	EndpointID           portainer.EndpointID
}

type StackUpdateRequest struct {
	StackFileContent string
	Env              []portainer.Pair `json:",omitempty"`
	Prune            bool
}