anydesk

type API struct {
	// API license ID as provided by AnyDesk support
	LicenseID string `json:"license_id"`

	// API password as provided by AnyDesk support
	APIPassword string `json:"api_password"`

	// API endpoint to be used
	APIEndpoint string `json:"api_endpoint"`

	// The http client used for API requests.
	// Can be used or overwritten for timeout and transport layer configuration.
	HTTPClient *http.Client
}

type APINotFoundError struct {
}

type APIRequest interface {
	// Returns debug information
	GetDebug() *DebugInfo

	// Returns base information about the http request. This information
	// is used to compose the API request signature.
	GetRequestDetails() *BaseRequest

	// Returns the http.Request that is composed, signed and ready to execute
	GetHTTPRequest(api *API) (req *http.Request, err error)
}

type AuthenticationRequest struct {
	*BaseRequest
}

type AuthenticationResponse struct {
	// Status result, should be "success".
	Result string `json:"result"`

	// The humen readable error message.
	Error string `json:"error"`

	// Specific error code as string, i.e. "invalid_token".
	Code string `json:"code"`

	// Echoing the failed request method.
	Method string `json:"method"`

	// Echoing the failed request resource.
	Resource string `json:"resource"`

	// Echoping the failed request timestamp.
	RequestTimestamp string `json:"request-time"`

	// Echoing the failed request content hash.
	ContentHash string `json:"content-hash"`

	// Echoing the API license ID on success.
	LicenseID string `json:"license-id"`
}

type BaseRequest struct {
	Method    string      `json:"-"`
	Resource  string      `json:"-"`
	Query     *url.Values `json:"-"`
	Timestamp int64       `json:"-"`
	Content   []byte      `json:"-"`
	// contains filtered or unexported fields
}

type ClientDetailRequest struct {
	*BaseRequest
}

type ClientDetailResponse struct {
	// ID of the client the response is about.
	ClientID int64 `json:"cid"`

	// Current version of the clients AnyDesk software.
	ClientVersion string `json:"client-version"`

	// Currently set alias of the client.
	Alias string `json:"alias"`

	// Indicates if the client is currently online.
	Online bool `json:"online"`

	// Comment for the given client, as defined in the address book.
	Comment string `json:"comment"`

	// Seconds since the client came online.
	// Will be -1 if client is Offline, but please use the .Online attribute for check.
	OnlineSinceSeconds int64 `json:"online-time"`

	// Last five sessions that this client was involved in.
	LastSessions []SessionNode `json:"last-sessions"`
}

type ClientNode struct {
	// The unique client ID of the client AnyDesk software installation.
	ClientID int64 `json:"cid"`

	// The unique client alias of the AnyDesk software installation.
	Alias string `json:"alias"`
}

type DebugInfo struct {
	// Is "true" when debug info was populated, "false" when no info was collected.
	Available bool

	// The full request URL sent by the http request.
	RequestURL *url.URL

	// The http.Request used for the request.
	Request *http.Request

	// The plain request body sent to the API.
	RequestBody []byte

	// The http.Response received by the http request.
	Response *http.Response

	// The plain response body received by the API.
	ResponseBody []byte
}

type PaginatedAPIRequest interface {
	APIRequest

	// Returns the pagination options for the current request
	GetPaginationOptions() *PaginationOptions
}

type PaginationOptions struct {
	// Result offset, starting at 0
	Offset int64 `json:"-"`

	// Result limit, use anydesk.Infinite for unlimited results
	Limit int64 `json:"-"`

	// Result sort by property name
	Sort string `json:"-"`

	// Result sort order, use anydesk.OrderAsc or anydesk.OrderDesc
	Order SortOrder `json:"-"`
}

type SessionCommentChangeRequest struct {
	*BaseRequest
	Comment *string `json:"comment"`
}

type SessionDirection string

type SessionListRequest struct {
	*BaseRequest
	*PaginationOptions
}

type SessionListSearch struct {
	// Limit search to client ID
	ClientID int64

	// Limit search to given sessiond direction, [in, out, inout]
	Direction SessionDirection

	// Limit search to sessions after the given time
	TimeFrom time.Time

	// Limit search to sessions up to the given time
	TimeTo time.Time
}

type SessionNode struct {
	// Indicatges of the session is currently active.
	Active bool `json:"active"`

	// The unique sesson ID for this connection.
	SessionID string `json:"sid"`

	// The source client responsible for this session.
	Source *ClientNode `json:"from"`

	// The connected client of the session.
	Target *ClientNode `json:"to"`

	// Connection start as unix-timestamp.
	StartTimestamp int64 `json:"start-time"`

	// Connection end as unix-timestamp.
	EndTimestamp int64 `json:"end-time"`

	// Total duration of the session in seconds.
	DurationInSeconds int64 `json:"duration"`

	// The comment left by the source client.
	Comment string `json:"comment"`
}

type SortOrder string

type SysinfoRequest struct {
	*BaseRequest
}

type SysinfoResponse struct {
	Name       string `json:"name"`
	APIVersion string `json:"api-ver"`
	License    struct {
		Name             string `json:"name"`
		ExpiresTimestamp int64  `json:"expires"`
		HasExpired       bool   `json:"has-expired"` // undocumented or deprecated
		MaxClients       int    `json:"max-clients"`
		MaxSessions      int    `json:"max-sessions"`
		MaxSessionTime   int    `json:"max-session-time"`
		Namespaces       []struct {
			Name string `json:"name"`
			Size int    `json:"size"`
		} `json:"namespaces"`
		ID          string `json:"license-id"`
		Key         string `json:"license-key"`
		APIPassword string `json:"api-password"`
		PowerUser   bool   `json:"power-user"` // undocumented or deprecated
	} `json:"license"`
	Clients struct {
		Total  int `json:"total"`
		Online int `json:"online"`
	} `json:"clients"`
	Sessions struct {
		Total  int `json:"total"`
		Active int `json:"active"`
	} `json:"sessions"`
	Standalone bool `json:"standalone"`
}