models

type Activity struct {

	// config
	Config *Config `json:"config,omitempty"`

	// description
	// Required: true
	Description *Description `json:"description"`

	// Expires At
	// Required: true
	Exp *float64 `json:"exp"`

	// A list of streams
	// Required: true
	Streams []*Stream `json:"streams"`

	// User interfaces
	// Required: true
	Uis []*UserInterface `json:"uis"`
}

type Bookings struct {

	// Array of activities, including credentials, sufficient to permit access to the activities
	// Required: true
	Activities []*Activity `json:"activities"`

	// if true, no new bookings are being accepted
	Locked bool `json:"locked,omitempty"`

	// Maximum concurrent bookings permitted
	// Required: true
	Max *int64 `json:"max"`

	// message of the day, typically to explain any current or upcoming locked periods
	// Example: Preview Access: sessions will be available from 10am - 5pm GMT today
	Msg string `json:"msg,omitempty"`
}

type Bookingtoken struct {

	// Audience
	// Required: true
	Aud *string `json:"aud"`

	// Expires At
	// Required: true
	Exp *float64 `json:"exp"`

	// List of group names (not ID)
	// Required: true
	Groups []string `json:"groups"`

	// Issued At
	Iat float64 `json:"iat,omitempty"`

	// Not before
	// Required: true
	Nbf *float64 `json:"nbf"`

	// List of pool IDs (not name)
	Pools []string `json:"pools"`

	// List of scopes
	// Required: true
	Scopes []string `json:"scopes"`

	// Subject
	// Required: true
	Sub *string `json:"sub"`

	// booking token
	// Example: ey...
	// Required: true
	Token *string `json:"token"`
}

type Config struct {

	// URL at which to GET the configuration object
	// Example: https://assets.practable.io/config/experiments/pvna/pvna01-0.0.json
	// Required: true
	URL *string `json:"url"`
}

type Description struct {

	// URL for further information
	// Example: https://static.practable.io/info/penduino/ui.html
	Further string `json:"further,omitempty"`

	// Identification used in PoolStore
	ID string `json:"id,omitempty"`

	// URL of main image (500x500)
	// Example: https://assets.practable.io/images/penduino-500x500.png
	Image string `json:"image,omitempty"`

	// 280 char additional description of the interface in plain text
	Long string `json:"long,omitempty"`

	// Display name
	// Example: Penduino (basic)
	// Required: true
	Name *string `json:"name"`

	// 140 char max description of the interface in plain text
	// Example: Interface to the penduino electromagnetic pendulum with variable drive, active braking, short and open circuit loading.
	Short string `json:"short,omitempty"`

	// URL of thumbnail image (150x150)
	// Example: https://assets.practable.io/images/penduino-150x150.png
	Thumb string `json:"thumb,omitempty"`

	// Type of resource being described, e.g. pool, activity, userinterface
	// Example: userinterface
	// Required: true
	Type *string `json:"type"`
}

type Group struct {

	// description
	// Required: true
	Description *Description `json:"description"`

	// pools
	Pools []string `json:"pools"`
}

type ID struct {

	// identification
	// Example: d220c320-eb88-456b-b1dd-b36dae840af2
	// Required: true
	ID *string `json:"id"`
}

type IDList []string

type Permission struct {

	// audience
	// Required: true
	Audience *string `json:"audience"`

	// connection type
	// Required: true
	ConnectionType *string `json:"connection_type"`

	// scopes
	// Required: true
	Scopes []string `json:"scopes"`

	// topic
	// Required: true
	Topic *string `json:"topic"`
}

type Pool struct {

	// description
	// Required: true
	Description *Description `json:"description"`

	// max session
	MaxSession int64 `json:"max_session,omitempty"`

	// min session
	MinSession int64 `json:"min_session,omitempty"`
}

type Poolstore struct {

	// base64-encoded string representing bookingstore in JSON format
	// Required: true
	Booking *string `json:"booking"`

	// base64-encoded string representing PoolStore in JSON format
	// Required: true
	Pool *string `json:"pool"`
}

type Status struct {

	// Number of available kits
	// Example: 3
	// Required: true
	Available *int64 `json:"available"`

	// Kit available later?
	// Example: true
	Later bool `json:"later,omitempty"`

	// Number of kits in use
	// Example: 5
	Used int64 `json:"used,omitempty"`

	// Wait time in seconds until first kit available later
	// Example: 3200
	Wait int64 `json:"wait,omitempty"`
}

type StoreStatus struct {

	// activities
	Activities int64 `json:"activities,omitempty"`

	// bookings
	Bookings int64 `json:"bookings,omitempty"`

	// groups
	Groups int64 `json:"groups,omitempty"`

	// last booking ends
	LastBookingEnds float64 `json:"last_booking_ends,omitempty"`

	// locked
	Locked bool `json:"locked,omitempty"`

	// msg
	Msg string `json:"msg,omitempty"`

	// pools
	Pools int64 `json:"pools,omitempty"`
}

type Stream struct {

	// Describes the stream, and doubles as template key in the URL
	// Example: video
	// Required: true
	For *string `json:"for"`

	// permission
	// Required: true
	Permission *Permission `json:"permission"`

	// JWT bearer token for submitting in the header when making the request at the URL
	Token string `json:"token,omitempty"`

	// URL at which to obtain access to the stream (getting a redirect URL containing a one time code)
	// Example: https://relay-access.practable.io/session/abc123
	// Required: true
	URL *string `json:"url"`

	// HTPP verb to use when making request to the URL
	// Example: POST
	Verb *string `json:"verb,omitempty"`
}

type UserInterface struct {

	// description
	// Required: true
	Description *Description `json:"description"`

	// list of names of required streams
	// Example: ["data","video"]
	StreamsRequired []string `json:"streamsRequired"`

	// URL of the user interface
	// Example: https://static.practable.io/ui/penduino-basic.html?video={{video}}\u0026data={{data}}
	// Required: true
	URL *string `json:"url"`
}