api

type BaseVariable struct {
	// Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id.
	Key string `json:"key"`
	// Variable type
	Type_ string `json:"type"`
	// Variable value can be a string, number, boolean, or JSON
	Value interface{} `json:"value"`

	Eval EvalDetails `json:"eval"`
}

type BatchEventsBody struct {
	Batch []UserEventsBatchRecord `json:"batch"`
}

type BucketedUserConfig struct {
	Project              Project                     `json:"project"`
	Environment          Environment                 `json:"environment"`
	Features             map[string]Feature          `json:"features"`
	FeatureVariationMap  map[string]string           `json:"featureVariationMap"`
	VariableVariationMap map[string]FeatureVariation `json:"variableVariationMap"`
	Variables            map[string]ReadOnlyVariable `json:"variables"`
	KnownVariableKeys    []float64                   `json:"knownVariableKeys"`

	User *User `json:"-"`
}

type ClientEvent struct {
	EventType ClientEventType `json:"eventType"`
	EventData interface{}     `json:"eventData"`
	Status    string          `json:"status"`
	Error     error           `json:"error"`
}

type ClientEventType string

type DefaultReason string

type EdgeDBSettings struct {
	Enabled bool `json:"enabled"`
}

type Environment struct {
	Id  string `json:"_id" validate:"required"`
	Key string `json:"key" validate:"required"`
}

type EnvironmentMetadata struct {
	Id  string `json:"id,omitempty"`
	Key string `json:"key,omitempty"`
}

type ErrorResponse struct {
	// Error message
	Message string `json:"message"`
	// Additional error information detailing the error reasoning
	Data interface{} `json:"data,omitempty"`
}

type EvalDetails struct {
	Reason   EvaluationReason `json:"reason"`
	Details  string           `json:"details"`
	TargetId string           `json:"target_id,omitempty"`
}

type EvaluationReason string

type Event struct {
	Type_       string                 `json:"type"`
	Target      string                 `json:"target,omitempty"`
	CustomType  string                 `json:"customType,omitempty"`
	UserId      string                 `json:"user_id"`
	ClientDate  time.Time              `json:"clientDate"`
	Value       float64                `json:"value,omitempty"`
	FeatureVars map[string]string      `json:"featureVars"`
	MetaData    map[string]interface{} `json:"metaData,omitempty"`
}

type EventQueueOptions struct {
	FlushEventsInterval          time.Duration `json:"flushEventsMS"`
	DisableAutomaticEventLogging bool          `json:"disableAutomaticEventLogging"`
	DisableCustomEventLogging    bool          `json:"disableCustomEventLogging"`
	MaxEventQueueSize            int           `json:"maxEventsPerFlush,omitempty"`
	FlushEventQueueSize          int           `json:"minEventsPerFlush,omitempty"`
	EventRequestChunkSize        int           `json:"eventRequestChunkSize,omitempty"`
	EventsAPIBasePath            string        `json:"eventsAPIBasePath,omitempty"`
}

type Feature struct {
	// unique database id
	Id string `json:"_id"`
	// Unique key by Project, can be used in the SDK / API to reference by 'key' rather than _id.
	Key string `json:"key"`
	// Feature type
	Type_ string `json:"type"`
	// Bucketed feature variation
	Variation string `json:"_variation"`
	// Bucketed feature variation key
	VariationKey string `json:"variationKey"`
	// Bucketed feature variation name
	VariationName string `json:"variationName"`
	// Evaluation reasoning
	EvalReason string `json:"evalReason,omitempty"`
}

type FeatureVariation struct {
	Feature   string `json:"_feature"`
	Variation string `json:"_variation"`
}

type FlushPayload struct {
	PayloadId  string                  `json:"payloadId"`
	EventCount int                     `json:"eventCount"`
	Records    []UserEventsBatchRecord `json:"records"`
	Status     string
}

type MinimalConfig struct {
	SSE                *SSEHost     `json:"sse,omitempty"`
	Project            *Project     `json:"project,omitempty"`
	Environment        *Environment `json:"environment,omitempty"`
	ConfigETag         string       `json:"configETag,omitempty"`
	ConfigLastModified string       `json:"configLastModified,omitempty"`
}

type OptInColors struct {
	Primary   string `json:"primary"`
	Secondary string `json:"secondary"`
}

type OptInSettings struct {
	Enabled     bool        `json:"enabled"`
	Title       string      `json:"title"`
	Description string      `json:"description"`
	ImageURL    string      `json:"imageURL"`
	Colors      OptInColors `json:"colors"`
}

type PlatformData struct {
	SdkType         string `json:"sdkType"`
	SdkVersion      string `json:"sdkVersion"`
	PlatformVersion string `json:"platformVersion"`
	DeviceModel     string `json:"deviceModel"`
	Platform        string `json:"platform"`
	Hostname        string `json:"hostname"`
}

type PopulatedUser struct {
	User
	*PlatformData
	// Date the user was created, Unix epoch timestamp format
	CreatedDate time.Time `json:"createdDate,omitempty"`
}

type Project struct {
	Id               string          `json:"_id" validate:"required"`
	Key              string          `json:"key" validate:"required"`
	A0OrganizationId string          `json:"a0_organization" validate:"required"`
	Settings         ProjectSettings `json:"settings" validate:"required"`
}

type ProjectMetadata struct {
	Id  string `json:"id,omitempty"`
	Key string `json:"key,omitempty"`
}

type ProjectSettings struct {
	EdgeDB                     EdgeDBSettings `json:"edgeDB"`
	OptIn                      OptInSettings  `json:"optIn"`
	DisablePassthroughRollouts bool           `json:"disablePassthroughRollouts"`
}

type ReadOnlyVariable struct {
	BaseVariable
	// unique database id
	Id string `json:"_id"`
}

type SSEHost struct {
	Hostname string `json:"hostname,omitempty"`
	Path     string `json:"path,omitempty"`
}

type User struct {
	// Unique id to identify the user
	UserId string `json:"user_id"`
	// User's email used to identify the user on the dashboard / target audiences
	Email string `json:"email,omitempty"`
	// User's name used to identify the user on the dashboard / target audiences
	Name string `json:"name,omitempty"`
	// User's language in ISO 639-1 format
	Language string `json:"language,omitempty"`
	// User's country in ISO 3166 alpha-2 format
	Country string `json:"country,omitempty"`
	// App Version of the running application
	AppVersion string `json:"appVersion,omitempty"`
	// App Build number of the running application
	AppBuild string `json:"appBuild,omitempty"`
	// User's custom data to target the user with, data will be logged to DevCycle for use in dashboard.
	CustomData map[string]interface{} `json:"customData,omitempty"`
	// User's custom data to target the user with, data will not be logged to DevCycle only used for feature bucketing.
	PrivateCustomData map[string]interface{} `json:"privateCustomData,omitempty"`
	// User's device model
	DeviceModel string `json:"deviceModel,omitempty"`
	// Date the user was created, Unix epoch timestamp format
	LastSeenDate time.Time `json:"lastSeenDate,omitempty"`
}

type UserDataAndEventsBody struct {
	Events []Event        `json:"events,omitempty"`
	User   *PopulatedUser `json:"user,omitempty"`
}

type UserEventsBatchRecord struct {
	User   PopulatedUser `json:"user"`
	Events []Event       `json:"events"`
}

type UserFeatureData struct {
	User        User `json:"user"`
	FeatureVars map[string]string
}

type Variable struct {
	BaseVariable

	DefaultValue interface{} `json:"defaultValue"`
	IsDefaulted  bool        `json:"isDefaulted"`
}

type VariableMetadata struct {
	FeatureId string `json:"featureId,omitempty"`
}