notehub

type DbQuery struct {
	Columns    string `json:"columns,omitempty"`
	Format     string `json:"format,omitempty"`
	Count      bool   `json:"count,omitempty"`
	Offset     int    `json:"offset,omitempty"`
	Limit      int    `json:"limit,omitempty"`
	NoHeader   bool   `json:"noheader,omitempty"`
	Where      string `json:"where,omitempty"`
	Last       string `json:"last,omitempty"`
	Order      string `json:"order,omitempty"`
	Descending bool   `json:"descending,omitempty"`
}

type HubRequest struct {
	notecard.Request `json:",omitempty"`
	Contact          *note.Contact                 `json:"contact,omitempty"`
	AppUID           string                        `json:"app,omitempty"`
	FleetUID         string                        `json:"fleet,omitempty"`
	EventSerials     []string                      `json:"events,omitempty"`
	DbQuery          *DbQuery                      `json:"query,omitempty"`
	Uploads          []UploadMetadata              `json:"uploads,omitempty"`
	Contains         string                        `json:"contains,omitempty"`
	Handlers         *[]string                     `json:"handlers,omitempty"`
	FileType         UploadType                    `json:"type,omitempty"`
	FileTags         string                        `json:"tags,omitempty"`
	FileNotes        string                        `json:"filenotes,omitempty"`
	Provision        bool                          `json:"provision,omitempty"`
	Scope            string                        `json:"scope,omitempty"`
	Env              *map[string]string            `json:"env,omitempty"`
	FleetEnv         *map[string]map[string]string `json:"fleet_env,omitempty"`
	PIN              string                        `json:"pin,omitempty"`
	Compress         string                        `json:"compress,omitempty"`
	MD5              string                        `json:"md5,omitempty"`
	DeviceEndpoint   bool                          `json:"device_endpoint,omitempty"`
}

type HubRequestFileFirmware struct {
	// The organization accountable for the firmware - a display string
	Organization string `json:"org,omitempty"`
	// A description of the firmware - a display string
	Description string `json:"description,omitempty"`
	// The name and model number of the product containing the firmware - a display string
	Product string `json:"product,omitempty"`
	// The identifier of the only firmware that will be acceptable and downloaded to this device
	Firmware string `json:"firmware,omitempty"`
	// The composite version number of the firmware, generally major.minor.patch as a string
	Version string `json:"version,omitempty"`
	// The target CPU of the firmware (see notecard/src/board.h)
	Target string `json:"target,omitempty"`
	// The build number of the firmware, for numeric comparison
	Major uint32 `json:"ver_major,omitempty"`
	Minor uint32 `json:"ver_minor,omitempty"`
	Patch uint32 `json:"ver_patch,omitempty"`
	Build uint32 `json:"ver_build,omitempty"`
	// The build number of the firmware, generally just a date and time
	Built string `json:"built,omitempty"`
	// The entity who built or is responsible for the firmware - a display string
	Builder string `json:"builder,omitempty"`
}

type UploadMetadata struct {
	Name     string                  `json:"name,omitempty"`
	Length   int                     `json:"length,omitempty"`
	MD5      string                  `json:"md5,omitempty"`
	CRC32    uint32                  `json:"crc32,omitempty"`
	Created  int64                   `json:"created,omitempty"`
	Modified int64                   `json:"modified,omitempty"`
	Source   string                  `json:"source,omitempty"`
	Contains string                  `json:"contains,omitempty"`
	Found    string                  `json:"found,omitempty"`
	FileType UploadType              `json:"type,omitempty"`
	Tags     string                  `json:"tags,omitempty"`     // comma-separated, no spaces, case-insensitive
	Notes    string                  `json:"notes,omitempty"`    // Should be simple text
	Firmware *HubRequestFileFirmware `json:"firmware,omitempty"` // This value is pulled out of the firmware binary itself
	// Arbitrary metadata that the user may define - we don't interpret the schema at all
	Info map[string]interface{} `json:"info,omitempty"`
}

type UploadType string