restapi

type Account struct {
	// ID is the ID of the Account.
	ID string `json:"id"`

	// Name is display name for the Account.
	Name *string `json:"name"`

	// Created is the date when the Account was created.
	Created string `json:"created"`

	// Key is the secret key to authenticate the Account ID.
	Key string `json:"key"`
}

type Application struct {
	// ID is the ID of the Application.
	ID string `json:"id"`

	// Created is the date when the Application was created.
	Created string `json:"created"`

	// Account is the ID of the Account owning the Application.
	Account string `json:"account"`

	// Name is the application's name.
	Name string `json:"name"`
}

type Attempt struct {
	// ID is the Attempt ID.
	ID string `json:"id"`

	// Created is the date when the Attempt was created.
	Created string `json:"created"`

	// Account is the ID of the Account owning the Task.
	Account string `json:"account"`

	// Application is the name of the parent Application.
	Application string `json:"application"`

	// Task is the task's name.
	Task string `json:"name"`

	// TaskID is the ID of the parent Task of this attempt.
	TaskID string `json:"taskID"`

	// Queue is the name of the parent Queue.
	Queue string `json:"queue"`

	// URL is the URL that the worker with requests.
	URL string `json:"url"`

	// HTTPAuth is the HTTP authentication to use if any.
	HTTPAuth models.HTTPAuth `json:"auth"`

	// Method is the HTTP method that will be used to execute the request.
	Method string `json:"method"`

	// Headers are the HTTP headers that will be used schedule executing the request.
	Headers map[string]string `json:"headers,omitempty"`

	// Payload is arbitrary data that will be POSTed on the URL.
	Payload string `json:"payload,omitempty"`

	// At is a date representing the time this attempt will be executed.
	At string `json:"at,omitempty"`

	// Finished is a Unix timestamp representing the time the attempt finished.
	Finished string `json:"finished,omitempty"`

	// Status is either `pending`, `retrying`, `canceled`, `success` or `error`
	Status string `json:"status"`

	// StatusCode is the HTTP status code.
	StatusCode int32 `json:"statusCode,omitempty"`

	// StatusMessage is a human readable message related to the StatusCode.
	StatusMessage string `json:"statusMessage,omitempty"`
}

type AuthBasicMiddleware struct {

	// Realm name to display to the user. Required.
	Realm string

	// Callback function that should perform the authentication of the user based on userId and
	// password. Must return true on success, false on failure. Required.
	Authenticator func(userId string, password string, request *rest.Request) bool

	// Callback function that should perform the authorization of the authenticated user. Called
	// only after an authentication success. Must return true on success, false on failure.
	// Optional, default to success.
	Authorizator func(userId string, request *rest.Request) bool
}

type BaseMiddleware struct {
	Store *store.Store
}

type Queue struct {
	// ID is the ID of the Queue.
	ID string `json:"id"`

	// Created is the date when the Queue was created.
	Created string `json:"created"`

	// Account is the ID of the Account owning the Queue.
	Account string `json:"account"`

	// Application is the name of the parent Application.
	Application string `json:"application"`

	// Name is the queue's name.
	Name string `json:"name"`

	// Retry is the retry strategy parameters in case of errors.
	Retry *models.Retry `json:"retry"`

	// MaxInFlight is the maximum number of attempts executed in parallel.
	MaxInFlight int `json:"maxInFlight"`

	// InFlight is the current number of attempts executed in parallel.
	InFlight int `json:"inFlight"`
}

type Task struct {
	// ID is the Task ID.
	ID string `json:"id"`

	// Created is the date when the Task was created.
	Created string `json:"created"`

	// Account is the ID of the Account owning the Task.
	Account string `json:"account"`

	// Application is the name of the parent Application.
	Application string `json:"application"`

	// Name is the task's name.
	Name string `json:"name"`

	// Queue is the name of the parent Queue.
	Queue string `json:"queue"`

	// URL is the URL that the worker with requests.
	URL string `json:"url"`

	// HTTPAuth is the HTTP authentication to use if any.
	HTTPAuth models.HTTPAuth `json:"auth"`

	// Method is the HTTP method that will be used to execute the request.
	Method string `json:"method"`

	// Headers are the HTTP headers that will be used schedule executing the request.
	Headers map[string]string `json:"headers,omitempty"`

	// Payload is arbitrary data that will be POSTed on the URL.
	Payload string `json:"payload,omitempty"`

	// Schedule is a cron specification describing the recurrency if any.
	Schedule string `json:"schedule,omitempty"`

	// At is a date representing the next time a attempt will be executed.
	At string `json:"at,omitempty"`

	// Status is either `pending`, `retrying`, `canceled`, `success` or `error`
	Status string `json:"status"`

	// Executed is the date of the last time a attempt was executed.
	Executed string `json:"executed,omitempty"`

	// Active is the task active.
	Active *bool `json:"active"`

	// Errors counts the number of attempts that failed.
	Errors int `json:"errors"`

	// LastError is the date of the last attempt in error status.
	LastError string `json:"lastError,omitempty"`

	// LastSuccess is the date of the last attempt in success status.
	LastSuccess string `json:"lastSuccess,omitempty"`

	// Executions counts the number of attempts that were executed.
	Executions int `json:"executions"`

	// ErrorRate is the rate of errors in percent.
	ErrorRate int `json:"errorRate"`

	// Retry is the retry strategy parameters in case of errors.
	Retry *models.Retry `json:"retry"`
}