libportal

type APIRequest struct {

	// ids for onject query
	Ids []string `json:"ids" query:"ids[]"`

	// for Search
	SearchQuery string `json:"search,omitempty" query:"search"`

	// profiles ids for many objects and access control
	Profiles []string `json:"profiles,omitempty" query:"profiles[]"`

	// account ids for accounts data if needed
	Accounts []string `json:"accounts,omitempty" query:"accounts[]"`

	// tariffs ids for vouchers if needed
	Tariffs []string `json:"tariffs,omitempty" query:"tariffs[]"`

	// locations ids to request
	LocIDs []string `json:"loc_ids,omitempty" query:"loc_ids[]"`

	//AdType  type of ad to download
	AdTypes []string `json:"ad_types" query:"ad_types[]"`

	// account for black/white list
	ActionList    PortalActionListType `json:"action_list" query:"action_list"`
	AccountToList string               `json:"account_to_list" query:"account_to_list"`

	// query for stat (range / pie / timeseries)
	Start   int64  `json:"start" query:"start"`
	Stop    int64  `json:"stop" query:"stop"`
	Object  string `json:"object" query:"object"`
	Subtype string `json:"subtype" query:"subtype"`

	//Query or filter account by DateOfBirth
	Day   int `json:"day" query:"day"`
	Month int `json:"month" query:"month"`
	Year  int `json:"year" query:"year"`

	// for transaction read -- possible values ["day", "week", "month", "quarter"]
	Last string `json:"last,omitempty" query:"last"`

	Query string `json:"q" query:"q"`

	Request []map[string]interface{} `json:"request" query:"request" form:"request"`

	// Pagination
	Sort   string `json:"sort" query:"sort"`
	Offset int    `json:"offset" query:"offset"`
	Limit  int    `json:"limit" query:"limit"`

	// vouchers data
	NumberOfVouchers int `json:"number_of_vouchers" query:"number_of_vouchers"`
	LengthVoucher    int `json:"length_voucher" query:"length_voucher"`

	// if true, get return list code and start stop(about vouchers)
	ListVoucher bool `json:"list_voucher" query:"list_voucher"`
	ClonePage   bool `json:"clone_page" query:"clone_page"`
	MACMask     bool `json:"mac_mask" query:"mac_mask"`
}

type APIResponse struct {
	Code   int         `json:"code"`
	Status string      `json:"status"`
	Total  int         `json:"total,omitempty"`
	Items  interface{} `json:"data,omitempty"`
	Errors []string    `json:"errors,omitempty"`
}

type AccessServer struct {
	ID string `json:"id" bson:"_id"`

	Enable bool             `json:"enable" bson:"enable"`
	Name   string           `json:"name" bson:"name"`
	Type   AccessServerType `json:"type" bson:"type"`

	NasID      string `json:"nas_id" bson:"nas_id"`
	NasIP      string `json:"nas_ip" bson:"nas_ip"`
	ExternalIP string `json:"external_ip" bson:"external_ip"`

	Location    string `json:"location" bson:"location"`
	Description string `json:"description" bson:"description"`

	Login    string `json:"login" bson:"login"`
	Password string `json:"password" bson:"password"`

	PreAuthVSA  string `json:"pre_auth_vsa" bson:"pre_auth_vsa"`
	PostAuthVSA string `json:"post_auth_vsa" bson:"post_auth_vsa"`
	CoaVSA      string `json:"coa_vsa" bson:"coa_vsa"`

	CoaSecret string `json:"coa_secret" bson:"coa_secret"`
	CoaPort   int    `json:"coa_port" bson:"coa_port"`
	MacAuth   bool   `json:"mac_auth" bson:"mac_auth"`
}

type AccessServerType string

type AccountFromSocialNetwork struct {
	ID           string   `json:"id" bson:"id"`
	Name         string   `json:"first_name" bson:"first_name"`
	LastName     string   `json:"last_name" bson:"last_name"`
	Email        string   `json:"email" bson:"email"`
	DateOfBirth  string   `json:"birthday" bson:"birthday"`
	Sex          string   `json:"sex" bson:"sex"`
	City         string   `json:"city" bson:"city"`
	Universities []string `json:"universities" bson:"universities"`
	HomeTown     string   `json:"home_town" bson:"home_town"`
	PhotoURL     string   `json:"photo_url" bson:"photo_url"`
}

type AdImageObject struct {
	Text  string `json:"text" bson:"text"`
	Image string `json:"image" bson:"image"`
}

type CaptiveRedirect struct {
	Name string `json:"name" bson:"name"`

	// URL to redirect (Portal Web part)
	RedirectURL string `json:"redirect_url" bson:"redirect_url"`

	MACWhiteList []string `json:"mac_list" bson:"mac_list"`

	URLWhiteList []DnsAddress `json:"url_list" bson:"url_list"`
	PreAuthList  []string     `json:"preauth_list" bson:"preauth_list"`

	NoMasquerade bool `json:"no_masquerade" bson:"no_masquerade"`
}

type DailyProfileStat struct {
	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`
	Time     DayTime   `json:"time" bson:"time"`

	Profile string   `json:"profile" bson:"profile"`
	LocID   string   `json:"loc_id" bson:"loc_id"`
	Values  []string `json:"values" bson:"values"`
	Counts  []int    `json:"counts" bson:"counts"`
}

type DailyProfileStatDB struct {
	ID     string           `json:"id" bson:"_id"`
	Object DailyProfileStat `json:",inline" bson:",inline"`
}

type DayTime struct {
	Year  int `json:"year" bson:"year"`
	Month int `json:"month" bson:"month"`
	Day   int `json:"day" bson:"day"`
}

type DnsAddress struct {
	Ip         string `json:"ip" bson:"ip"`
	DomainName string `json:"domain_name" bson:"domain_name"`
}

type GuestControlSettings struct {
	CaptiveRedirect string   `json:"captive_redirect" bson:"captive_redirect"`
	MACAuth         []string `json:"mac_radius_auth_servers" bson:"mac_radius_auth_servers"`
}

type Locale string

type MapEntity struct {
	Key   string `json:"k"`
	Value string `json:"v"`
}

type PollEnabledFields struct {
	DateOfBirth bool `json:"date_of_birth" bson:"date_of_birth"`
	Sex         bool `json:"sex" bson:"sex"`
}

type PortalActionListType string

type PortalAd struct {
	Id string `json:"id" bson:"_id"`

	// common data
	Name        string `json:"name" bson:"name"`
	Description string `json:"description" bson:"description"`

	// more specific data to link with profiles and authorization
	Profile       string `json:"profile" bson:"profile"`
	Authorization string `json:"authorization" bson:"authorization"`

	// number beetween 1 and 100 - more is higher
	Priority int `json:"priority" bson:"priority"`

	//OS operation system of client
	//OS PortalOSType `json:"os" bson:"os"`
	OS []string `json:"os" bson:"os"`

	//Vendor customer device manufacturers
	Vendor []string `json:"vendor" bson:"vendor"`

	//Platform descktop/mobile
	Platform struct {
		Desktop bool `json:"desktop" bson:"desktop"`
		Mobile  bool `json:"mobile" bson:"mobile"`
		Tablet  bool `json:"tablet" bson:"tablet"`
	} `json:"platform" bson:"platform"`

	// schedule of ads to work start-stop and number of views to show
	Schedule Schedule `json:"schedule" bson:"schedule"`

	NumberOfVisits struct {
		Visits int            `json:"visits" bson:"visits"`
		Sign   PortalSignType `json:"sign" bson:"sign"`
	} `json:"number_of_visits" bson:"number_of_visits"`

	UserRotation struct {
		Sex         string `json:"sex" bson:"sex"`
		DateOfBirth struct {
			Day   int `json:"day" bson:"day"`
			Month int `json:"month" bson:"month"`
			Year  int `json:"year" bson:"year"`
		} `json:"date_of_birth" bson:"date_of_birth"`
		Age  int64  `json:"age" bson:"age"`
		City string `json:"city" bson:"city"`
	} `json:"user_rotation" bson:"user_rotation"`

	LocIDs []string `json:"loc_ids" bson:"loc_ids"`

	Data PortalAdData `json:"data" bson:"data"`
}

type PortalAdData struct {
	Type PortalAdvertisementType `json:"type" bson:"type"`

	// URL of iframe or URL to file on portal
	URL  string `json:"url" bson:"url"`
	File string `json:"file,omitempty" bson:"-"`

	// Desktop URL
	URLDesktop  string `json:"url_desktop" bson:"url_desktop"`
	FileDesktop string `json:"file_desktop,omitempty" bson:"-"`

	// question and poll variants if type == poll
	Question     string          `json:"question" bson:"question"`
	QuestionDesc string          `json:"question_desc" bson:"question_desc"`
	PollVariants []string        `json:"poll_variants" bson:"poll_variants"`
	PollImage    []AdImageObject `json:"poll_image" bson:"poll_image"`

	Duration     int64 `json:"duration" bson:"duration"`
	SkipDuration int64 `json:"skip_after" bson:"skip_after"`

	// for redirect to client's site
	RedirectURL string `json:"redirect_url" bson:"redirect_url"`

	// title text
	Text string `json:"text" bson:"text"`

	// color options
	Color pageColor `json:"color,omitempty" bson:"color"`

	// color themes
	ThemeType  string `json:"theme_type" bson:"theme_type"`
	ThemeColor string `json:"theme_color" bson:"theme_color"`

	// поля для цвета кнопки и текста кнопки
	RedirectButtonColor string `json:"redirect_button_color" bson:"redirect_button_color"`
	RedirectButtonText  string `json:"redirect_button_text" bson:"redirect_button_text"`

	SelfVariant bool `json:"self_variant" bson:"self_variant"`
	Skip        bool `json:"skip" bson:"skip"`

	// поля означаюзие включен ли опрос данных о пользователя
	PollFields PollEnabledFields `json:"poll_fields" bson:"poll_fields"`
}

type PortalAdStat struct {
	// same ID as portalad
	Id string `json:"id" bson:"_id"`

	Counter        int            `json:"counter" bson:"counter"`
	CounterSkipped int            `json:"counter_skipped" bson:"counter_skipped"`
	Duration       int64          `json:"duration" bson:"duration"`
	PollCounter    map[string]int `json:"poll_counter" bson:"poll_counter"`
	Follows        int            `json:"follows" bson:"follows"`
}

type PortalAdStatDaily struct {
	Id   string `json:"id" bson:"_id"`
	IdAd string `json:"id_ad" bson:"id_ad"`

	// more specific data to link with profiles and authorization
	Profile       string `json:"profile" bson:"profile"`
	LocID         string `json:"loc_id"`
	Authorization string `json:"authorization" bson:"authorization"`

	// dat of day
	Year  int `json:"year" bson:"year"`
	Month int `json:"month" bson:"month"`
	Day   int `json:"day" bson:"day"`

	Counter        int            `json:"counter" bson:"counter"`
	CounterSkipped int            `json:"counter_skipped" bson:"counter_skipped"`
	Duration       int64          `json:"duration" bson:"duration"`
	PollCounter    map[string]int `json:"poll_counter" bson:"poll_counter"`
	Follows        int            `json:"follows" bson:"follows"`

	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`
}

type PortalAdStatInc struct {
	Counter        int   `json:"counter" bson:"counter"`
	CounterSkipped int   `json:"counter_skipped" bson:"counter_skipped"`
	Duration       int64 `json:"duration" bson:"duration"`
	Follows        int   `json:"follows" bson:"follows"`
}

type PortalAdStatLog struct {
	ID      string                  `json:"id" bson:"_id"`
	IDAd    string                  `json:"id_ad" bson:"id_ad"`
	Profile string                  `json:"profile" bson:"profile"`
	LocID   string                  `json:"loc_id" bson:"loc_id"`
	Account string                  `json:"account" bson:"account"`
	TypeAd  PortalAdvertisementType `json:"type_ad" bson:"type_ad"`

	CreateAt int64 `json:"create_at" bson:"create_at"`

	Time struct {
		Day   int `json:"day" bson:"day"`
		Month int `json:"month" bson:"month"`
		Year  int `json:"year" bson:"year"`
	} `json:"time" bson:"time"`

	UA UserAgent `json:"ua" bson:"ua"`

	UserAge         int    `json:"user_age" bson:"user_age"`
	UserDateOfBirth int64  `json:"user_date_of_birth" bson:"user_date_of_birth"`
	UserSex         string `json:"user_sex" bson:"user_sex"`

	CPE         string `json:"cpe" bson:"cpe"`
	MAC         string `json:"mac" bson:"mac"`
	WLAN        string `json:"wlan" bson:"wlan"`
	NASID       string `json:"nas_id" bson:"nas_id"`
	AdFollowURL string `json:"ad_follow_url" bson:"ad_follow_url"`
}

type PortalAdStatRequest struct {
	Id            string `json:"id"`
	Profile       string `json:"profile"`
	LocID         string `json:"loc_id"`
	Authorization string `json:"authorization"`

	Duration          int64                    `json:"duration"`
	Skipped           bool                     `json:"skipped"`
	PollVariant       string                   `json:"poll_variant"`
	PollUserData      PortalPollUserDataAnswer `json:"poll_user_data_answer"`
	FollowRedirectURL bool                     `json:"follow_redirect"`
}

type PortalAdvertisementState string

type PortalAdvertisementType string

type PortalAuthObject struct {
	Timestamp int64 `json:"timestamp" bson:"timestamp"`

	CPE       string `json:"cpe_id" bson:"cpe_id"`
	Ip        string `json:"client_ip" bson:"client_ip"`
	Useragent string `json:"useragent" bson:"useragent"`

	Username string `json:"username" bson:"username"`
	Password string `json:"password" bson:"password"`
}

type PortalAuthenticationConfig struct {
	Id string `json:"id" bson:"_id"`

	Enable bool                     `json:"enable" bson:"enable"`
	Type   PortalAuthenticationType `json:"type" bson:"type"`

	Name        string `json:"name" bson:"name"`
	Description string `json:"description" bson:"description"`

	Remember  int64 `json:"remember" bson:"remember"`
	OPTLength int   `json:"otp_length" bson:"otp_length"`

	PassGateway string `json:"-" bson:"pass_gateway"`

	Validate struct {
		Regex    string `json:"regex" bson:"regex"`
		ErrorMsg string `json:"error" bson:"error"`
	} `json:"validate" bson:"validate"`
}

type PortalAuthenticationData struct {
	Type PortalAuthenticationType `json:"type" bson:"type"`

	Identity string `json:"identity" bson:"identity"`
	Password string `json:"password" bson:"password"`

	Remember      int64 `json:"remember" bson:"remember"`
	PushAgreement bool  `json:"push_agree" bson:"push_agree"`

	// additional data if needed (for example full ESIA string)
	Data string `json:"data" bson:"data"`
}

type PortalAuthenticationState string

type PortalAuthenticationType string

type PortalAuthorizationConfig struct {
	Id string `json:"id" bson:"_id"`

	Enable bool                    `json:"enable" bson:"enable"`
	Type   PortalAuthorizationType `json:"type" bson:"type"`

	Name        string `json:"name" bson:"name"`
	Description string `json:"description" bson:"description"`

	// header and info for showing on captive portal page
	Header string `json:"header" bson:"header"`
	Info   string `json:"info" bson:"info"`

	// advertisements for user
	AdsIDs         []string `json:"ads_ids" bson:"ads_ids"`
	AdsToWatch     int      `json:"ads_to_watch" bson:"ads_to_watch"`
	EnableRotation bool     `json:"enable_rotation" bson:"enable_rotation"`
	EnableAdFollow bool     `json:"enable_ad_follow" bson:"enable_ad_follow"`

	// session configuration
	Config PortalSessionConfig `json:"config" bson:"config"`

	// landing page redirect URL
	RedirectURL string `json:"redirect_url" bson:"redirect_url"`

	// notification config
	Notification PortalNotification `json:"notification" bson:"notification"`

	//SocialNetworkConfig SN auth setting
	SocialNetworkConfig PortalAuthorizationWithSN `json:"social_network_config" bson:"social_network_config"`

	// skip final page (with data about how much to internet)
	SkipFinalPage bool `json:"skip_final_page" bson:"skip_final_page"`

	// is authorisation transferable on NAS
	// thus it could be divided to small chunks on NAS
	Transferable bool `json:"transferable" bson:"transferable"`

	// DEPRECATED
	Ads []PortalAd `json:"ads" bson:"ads"`
}

type PortalAuthorizationData struct {
	ConfigId string `json:"config_id" bson:"config_id"`

	Type  PortalAuthorizationType  `json:"type" bson:"type"`
	State PortalAuthorizationState `json:"state" bson:"state"`

	Config PortalSessionConfig `json:"config" bson:"config"`

	// will be deprecated
	Ads []PortalAd `json:"ads" bson:"-"`

	AdsIDs         []string `json:"ads_ids" bson:"ads_ids"`
	AdsToWatch     int      `json:"ads_to_watch" bson:"ads_to_watch"`
	EnableRotation bool     `json:"enable_rotation" bson:"enable_rotation"`
	EnableAdFollow bool     `json:"enable_ad_follow" bson:"enable_ad_follow"`

	RedirectURL string `json:"redirect_url" bson:"redirect_url"`

	Notification PortalNotification `json:"notification" bson:"notification"`

	//SocialNetworkConfig SN auth setting
	SocialNetworkConfig PortalAuthorizationWithSN `json:"social_network_config" bson:"social_network_config"`

	SkipFinalPage bool `json:"skip_final_page" bson:"skip_final_page"`
	Transferable  bool `json:"transferable" bson:"transferable"`
}

type PortalAuthorizationState string

type PortalAuthorizationType string

type PortalAuthorizationWithSN struct {
	RedirectURL string `json:"redirect_url" bson:"redirect_url"`
	GroupURL    string `json:"group_url" bson:"group_url"`
	Post        struct {
		Message     string `json:"message" bson:"message"`
		AttachedURL string `json:"attached_url" bson:"attached_url"`
	} `json:"post" bson:"post"`
}

type PortalBackendRequest struct {
	// Needed client data
	MAC   string `json:"mac"`
	CPE   string `json:"cpe_id"`
	WLAN  string `json:"wlan_id"`
	Ip    string `json:"client_ip"`
	NAS   string `json:"nas"`
	LocID string `json:"loc_id"`
	Hash  string `json:"hash"`

	// client credentials
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`

	// browser specific data
	UserAgent string `json:"useragent"`

	// Address of platform CoA manager
	SwitchURL string `json:"switch_url"`

	// Remember period for user accounts
	Remember int64 `json:"remember"`

	// Type of choosen type
	Type string `json:"type"`

	// info for watched advertisement / poll
	Ad PortalAdStatRequest `json:"ad"`

	// auth type -- free / sponsor / paid / etc
	AuthType string `json:"auth_type"`

	// authentype -- sms / callback / etc
	AuthenType string `json:"authen_type"`

	// voucher for paid voucher internet
	Voucher string `json:"voucher"`

	// account update data
	AccountName    string `json:"account_name"`
	AccountSurName string `json:"account_surname"`

	// tarriff to buy a voucher
	Tariff string `json:"tariff"`

	// payment system
	PaymentSystem string `json:"payment_system"`
	PaymentAmount int    `json:"payment_amount"`

	// vouchers
	Vouchers []string `json:"vouchers"`

	// client locale
	Locale string `json:"locale"`

	//socialNetwork data
	SocialNetwork map[string]AccountFromSocialNetwork `json:"social_network"`

	// segment for knowing where from this user is
	Segment string `json:"segment"`

	// for internal using
	Timeout int64 `json:"-" validate:"-"`
	// profile id
	Profile string `json:"-" validate:"-"`

	// push aggrement
	PushAgreement bool `json:"push_agree"`

	// for voucher activation in once
	Activate bool `json:"activate"`

	// is CNA (Captive network Assistant)
	CNA bool `json:"cna"`

	// is session transferable (internal usage)
	Transferable bool `json:"transferable"`

	// Add For UAM (aka Coova Chilli) server
	Res       string `json:"res"`
	UAMIP     string `json:"uamip"`
	UAMPort   string `json:"uamport"`
	Challenge string `json:"challenge"`
	Called    string `json:"called"`
	// MAC       string
	IP        string `json:"ip"`
	NasID     string `json:"nasid"`
	SessionID string `json:"sessionid"`
	UserURL   string `json:"userurl"`
}

type PortalBackendResponse struct {
	// status - success / error
	Status PortalResponseStatus `json:"status,omitempty"`
	// code 0 if OK, > 1 another
	Code int `json:"code"`
	// desctiption if error
	Description string `json:"description,omitempty"`
	// current state - authen, auth, ad, pass
	State PortalUserState `json:"state,omitempty"`
	// current substate - need, check
	Substate string `json:"substate,omitempty"`
	// additional data if needed
	Data interface{} `json:"data,omitempty"`

	// additional available data
	Available interface{} `json:"available,omitempty"`
	// account data provided
	Account interface{} `json:"account,omitempty"`

	// data for new auth stage
	Data2 interface{} `json:"data2,omitempty"`

	// "removal" of identification and authorization of clients
	IsDeleted bool `json:"is_deleted"`
}

type PortalClientAuthentication struct {
	Id string `json:"id" bson:"_id"`

	// client identification
	MAC     string `json:"mac" bson:"mac"`
	Profile string `json:"profile" bson:"profile"`

	WLAN string `json:"wlan_id" bson:"wlan_id"` // not actually needed

	// data with identity and authentication info
	Data PortalAuthenticationData `json:"data" bson:"data"`

	Create time.Time `json:"create" bson:"create"`

	// valid time
	CreateAt int64 `json:"create_at" bson:"create_at"`
	ExpireAt int64 `json:"expire_at" bson:"expire_at"`

	// "removal" of identification and authorization of clients
	IsDeleted bool `json:"is_deleted" bson:"is_deleted"`
}

type PortalClientLog struct {
	Profile   string    `json:"profile" bson:"profile"`
	LocID     string    `json:"loc_id" bson:"loc_id"`
	MAC       string    `json:"mac" bson:"mac"`
	Identity  string    `json:"identity,omitempty" bson:"identity,omitempty"`
	Account   string    `json:"account,omitempty" bson:"account"`
	UserAgent string    `json:"useragent" bson:"useragent"`
	Locale    string    `json:"locale" bson:"locale"`
	Path      string    `json:"path" bson:"path"`
	State     string    `json:"state" bson:"state"`
	Success   bool      `json:"success" bson:"success"`
	Error     string    `json:"error,omitempty" bson:"error,omitempty"`
	Create    time.Time `json:"create" bson:"create"`
	CreateAt  int64     `json:"create_at" bson:"create_at"`
}

type PortalClientSession struct {
	ID string `json:"id" bson:"_id"`

	// identity
	MAC     string `json:"mac" bson:"mac"`
	WLAN    string `json:"wlan_id" bson:"wlan_id"`
	CPE     string `json:"cpe" bson:"cpe"`
	NAS     string `json:"nas" bson:"nas"`
	LocID   string `json:"loc_id" bson:"loc_id"`
	IP      string `json:"ip" bson:"ip"`
	Hash    string `json:"hash" bson:"hash"`
	Segment string `json:"segment" bson:"segment"`

	// link with profile and account
	Profile string `json:"profile" bson:"profile"`
	Account string `json:"account" bson:"account"`

	// creation time (index needs)
	Create time.Time `json:"create" bson:"create"`

	// from create to end of internet + block
	CreateAt int64 `json:"create_at" bson:"create_at"`
	ExpireAt int64 `json:"expire_at" bson:"expire_at"`

	// real internet part
	StartAt  int64 `json:"start_at" bson:"start_at"`
	StopAt   int64 `json:"stop_at" bson:"stop_at"`
	Duration int64 `json:"duration" bson:"duration"`

	SessionConfig PortalSessionConfig `json:"session_config" bson:"session_config"`
	Auth          []PortalAuthObject  `json:"auth" bson:"auth"`

	State       PortalUserState `json:"state" bson:"state"`
	AuthenState PortalAuthenticationState
	AuthState   PortalAuthorizationState

	Authentication PortalAuthenticationData `json:"authentication" bson:"authentication"`
	Authorization  PortalAuthorizationData  `json:"authorization" bson:"authorization"`

	// data from UserAgent
	UA     UserAgent `json:"ua" bson:"ua"`
	Locale string    `json:"locale" bson:"locale"`

	// will be deprecated
	Status   string `json:"status" bson:"status"`
	Username string `json:"username" bson:"username"`
	Password string `json:"password" bson:"password"`

	// "removal" of identification and authorization of clients
	IsDeleted bool `json:"is_deleted" bson:"is_deleted"`

	// Cost sms from sms.ru
	Cost float64 `json:"cost" bson:"cost"`

	SocialNetwork map[string]AccountFromSocialNetwork `json:"social_network" bson:"social_network"`

	AcctSessionID string `json:"acct_session_id" bson:"acct_session_id"`
}

type PortalClientStat struct {
	Profile  string `json:"profile" bson:"profile"`
	LocID    string `json:"loc_id" bson:"loc_id"`
	MAC      string `json:"mac" bson:"mac"`
	Identity string `json:"identity,omitempty" bson:"identity,omitempty"`
	Account  string `json:"account,omitempty" bson:"account"`

	AuthenType string `json:"authen" bson:"authen,omitempty"`
	AuthType   string `json:"auth" bson:"auth,omitempty"`

	UA         UserAgent `json:"ua" bson:"ua"`
	Vendor     string    `json:"vendor" bson:"vendor"`
	Locale     string    `json:"locale" bson:"locale"`
	FirstVisit string    `json:"first_visit" bson:"first_visit"`

	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`
}

type PortalCondition struct {
	WLAN  []string `json:"wlan" bson:"wlan"`
	CPE   []string `json:"cpe" bson:"cpe"`
	NasID []string `json:"nas_id" bson:"nas_id"`
	LocID []string `json:"loc_id" bson:"loc_id"`
}

type PortalConditionRequest struct {
	WLAN  string `json:"wlan,omitempty" bson:"wlan"`
	CPE   string `json:"cpe,omitempty" bson:"cpe"`
	NasID string `json:"nas_id,omitempty" bson:"nas_id"`
	LocID string `json:"loc_id,omitempty" bson:"loc_id"`
}

type PortalDailyLocale = DailyProfileStat

type PortalDailyOS = DailyProfileStat

type PortalDailyType = DailyProfileStat

type PortalDailyVendor = DailyProfileStat

type PortalMSISDNConfig struct {
	// example: {"992": ["90","92"...]}
	Prefix map[string][]string `json:"prefix" bson:"prefix"`
	PrMap  []string            `json:"-" bson:"map"`
}

type PortalNotification struct {
	Enable            bool   `json:"enable" bson:"enable"`
	Text              string `json:"text" bson:"text"`
	SecondsBeforeStop int    `json:"seconds_before_stop" bson:"seconds_before_stop"`
}

type PortalOSType string

type PortalPageProfile struct {
	Id string `json:"id" bson:"_id"`

	Name        string `json:"name" bson:"name"`
	Description string `json:"description" bson:"description"`

	// URL generated id
	IdURL string `json:"url_id" bson:"url_id"`

	// title of webpage
	Title string `json:"title" bson:"title"`

	// footer text
	Footer string `json:"footer" bson:"footer"`

	// interface features
	Interface struct {
		// Favicon    string `json:"favicon" bson:"-"`
		Logo       string `json:"logo" bson:"-"`
		LogoFooter string `json:"logo_footer" bson:"-"`
		Background string `json:"background" bson:"-"`

		// FaviconURL    string `json:"favicon_url" bson:"favicon_url"`
		LogoURL       string `json:"logo_url" bson:"logo_url"`
		LogoFooterURL string `json:"logo_footer_url" bson:"logo_footer_url"`
		BackgroundURL string `json:"background_url" bson:"background_url"`
		ButtonColor   string `json:"button_color" bson:"button_color"`

		Color pageColor `json:"color" bson:"color"`

		// color themes (new 1.3)
		Theme      string `json:"theme" bson:"theme"`
		ThemeType  string `json:"theme_type" bson:"theme_type"`
		ThemeColor string `json:"theme_color" bson:"theme_color"`
	} `json:"interface" bson:"interface"`

	// locales
	Locales map[Locale]string `json:"locales" bson:"locales"`

	// service aggrement per locale
	Agreements map[Locale]string `json:"agreements" bson:"agreements"`

	// service aggrement plain text (no locale)
	Agreement string `json:"agreement" bson:"agreement"`

	// support field (email / phone / etc) (no locale)
	Support string `json:"support" bson:"support"`
}

type PortalPageSchedule struct {
	ID       string   `json:"id" bson:"_id"`
	PageID   string   `json:"page_id" bson:"page_id"`
	PageURL  string   `json:"page_url" bson:"page_url"`
	LocID    string   `json:"loc_id" bson:"loc_id"`
	Schedule Schedule `json:"schedule" bson:"schedule"`
}

type PortalPaymentSystem struct {
	ID string `json:"id" bson:"_id"`

	Name string                  `json:"name" bson:"name"`
	Type PortalPaymentSystemType `json:"type" bson:"type"`

	// for External
	Merchant   string `json:"merchant" bson:"merchant"`
	Profile    string `json:"profile" bson:"profile"`
	TranUnique bool   `json:"tran_unique" bson:"tran_unique"`

	// for buttons / guides
	Image string `json:"image" bson:"image"`
	Text  string `json:"text" bson:"text"`
	Head  string `json:"head" bson:"head"`

	// only for ExternalURL
	TemplateURL  string `json:"template_url" bson:"template_url"`
	TemplateHash string `json:"template_hash" bson:"template_hash"`
	HashKey      string `json:"hash_key" bson:"hash_key"`

	// will be deprecated
	Identity string `json:"identity" bson:"identity"`
}

type PortalPaymentSystemType string

type PortalPollUserDataAnswer struct {
	Sex         string `json:"sex" bson:"sex"`
	DateOfBirth struct {
		Day   int `json:"day" bson:"day"`
		Month int `json:"month" bson:"month"`
		Year  int `json:"year" bson:"year"`
	} `json:"date_of_birth" bson:"date_of_birth"`
}

type PortalProfile struct {
	Id string `json:"id" bson:"_id"`

	ShortID     string `json:"short_id" bson:"short_id"`
	Name        string `json:"name" bson:"name"`
	Description string `json:"description" bson:"description"`

	// condition to check
	// TODO: check profile special API to find what profile will be for condition
	Condition PortalCondition `json:"condition" bson:"condition"`

	// authentication types
	Authentications    []PortalAuthenticationConfig `json:"authentications" bson:"authentications"`
	AuthenticationSkip bool                         `json:"authn_skip" bson:"authn_skip"`

	// available MSISDN prefixes --
	MSISDNConfig PortalMSISDNConfig `json:"msisdn_config" bson:"msisdn_config"`

	// authorization types
	Authorizations       []PortalAuthorizationConfig `json:"authorizations" bson:"authorizations"`
	AuthorizationDefault string                      `json:"authz_default" bson:"authz_default"`

	// limits for authens and auths per page
	AuthenticationLimit int `json:"authentication_limit" bson:"authentication_limit"`
	AuthorizationLimit  int `json:"authorization_limit" bson:"authorization_limit"`

	//AccessList list to pass special user by code
	AccessList map[string]bool `json:"access_list" bson:"access_list"`
	//WhiteList to pass user with out auth
	WhiteList map[string]bool `json:"white_list" bson:"white_list"`
	//BlackList is list to block user
	BlackList map[string]bool `json:"black_list" bson:"black_list"`

	// default session configuration (timeout and block timeout)
	SessionConfig PortalSessionConfig `json:"session_config" bson:"session_config"`

	// UTC diff (plus or minus from UTC time)
	UTCDiff int `json:"utc_diff" bson:"utc_diff"`

	MACsLimit int `json:"macs_limit" bson:"macs_limit"`

	// to payments and payments system integration
	AllowBalance   bool     `json:"allow_balance" bson:"allow_balance"`
	PaymentSystems []string `json:"payment_systems" bson:"payment_systems"`

	// settings for terms of service (no locale)
	TermsOfService struct {
		Enable   bool   `json:"enable" bson:"enable"`
		External bool   `json:"external" bson:"external"`
		FileURL  string `json:"file_url" bson:"file_url"`
		Text     string `json:"text" bson:"text"`
	} `json:"terms_of_service" bson:"terms_of_service"`

	// messages for OTP codes / vouchers and subscriptions
	PushText struct {
		OTP          string `json:"otp" bson:"otp"`
		Voucher      string `json:"voucher" bson:"voucher"`
		Subscription string `json:"subscription" bson:"subscription"`
	} `json:"push_text" bson:"push_text"`

	// Block page for Random (Local Assigned) MAC Addresses
	RandomMACBlockPage bool `json:"random_mac_block_page" bson:"random_mac_block_page"`

	// settings for PushAgreement (no locale)
	PushAgreement struct {
		Enable   bool   `json:"enable" bson:"enable"`
		External bool   `json:"external" bson:"external"`
		FileURL  string `json:"file_url" bson:"file_url"`
		Text     string `json:"text" bson:"text"`
	} `json:"push_agreement" bson:"push_agreement"`

	// service private area
	EnableLineCabinet bool `json:"enable_line_cabinet" bson:"enable_line_cabinet"`
}

type PortalReportObjectType string

type PortalResponseStatus string

type PortalSessionConfig struct {

	// session timeout -- 30 min as example
	Timeout int64 `json:"timeout" bson:"timeout"`

	// timeout to remember
	AuthTimeout int64 `json:"auth_timeout" bson:"auth_timeout"`

	// block after using timeout for (example: 3600 is for seconds online)
	BlockAfterTimeout int64 `json:"block_after" bson:"block_after"`

	// expiration of block after (example: 7200 is for seconds to nullify block_after)
	BlockExpireTimeout int64 `json:"block_expire" bson:"block_expire"`

	// traffic limit
	DownloadLimit int `json:"download_limit" bson:"download_limit"`

	// max number
	MaxSessions int `json:"max_sessions" bson:"max_sessions"`

	// DEPRECATED field for block timeout
	BlockTimeout int64 `json:"block_timeout" bson:"block_timeout"`
}

type PortalSignType string

type PortalTariffPlan struct {
	ID string `json:"id" bson:"_id"`

	Profile string `json:"profile" bson:"profile"`

	// tariff plan code be for vouchers or for subscriptions
	Type TariffPlanType `json:"type" bson:"type"`

	// name of plan
	Name string `json:"name" bson:"name"`

	// limits
	SpeedLimit   int   `json:"speed" bson:"speed"`
	TimeoutLimit int64 `json:"session" bson:"session"`
	TrafficLimit int   `json:"traffic" bson:"traffic"`

	// how much to pay
	Amount   int    `json:"amount" bson:"amount"`
	Currency string `json:"currency" bson:"currency"`

	// data for subscriptions
	Reccuring         bool   `json:"recurring" bson:"recurring"`
	ReccuringInterval string `json:"recurring_period" bson:"recurring_period"`

	// friendly description on different languages
	Description map[Locale]string `json:"description" bson:"description"`

	// service info
	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`
}

type PortalTransaction struct {
	ID string `json:"id" bson:"_id"`

	Profile string `json:"profile" bson:"profile"`

	Account  string `json:"account" bson:"account"`
	Identity string `json:"identity" bson:"identity"`

	Value    int    `json:"balance" bson:"balance"`
	Currency string `json:"currency" bson:"currency"`

	Type string `json:"type" bson:"type"`
	Fill bool   `json:"fill" bson:"fill"`

	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`
}

type PortalUserAccount struct {
	ID string `json:"id" bson:"_id"`

	// identity info
	Profile            string   `json:"profile" bson:"profile"`
	Identity           string   `json:"identity" bson:"identity"`
	AuthenticationCode string   `json:"authentication_code" bson:"authentication_code"`
	MACs               []string `json:"macs" bson:"macs"`

	// basic personal info
	Name    string `json:"name" bson:"name"`
	SurName string `json:"surname" bson:"surname"`

	DateOfBirth       string `json:"date_of_birth" bson:"date_of_birth"`
	DateOfBirthStruct struct {
		Day   int `json:"day" bson:"day"`
		Month int `json:"month" bson:"month"`
		Year  int `json:"year" bson:"year"`
	} `json:"date_of_birth_struct" bson:"date_of_birth_struct"`

	// personal info
	Email    string `json:"email" bson:"email"`
	Phone    string `json:"phone" bson:"phone"`
	Sex      string `json:"sex" bson:"sex"`
	City     string `json:"city" bson:"city"`
	HomeTown string `json:"home_town" bson:"home_town"`
	PhotoURL string `json:"photo_url" bson:"photo_url"`

	// data for external addintional use
	Passport       string      `json:"passport" bson:"passport"`
	AdditionalData interface{} `json:"additional_data" bson:"addition_data"`

	// info from social network after authorizations
	SocialNetwork map[string]AccountFromSocialNetwork `json:"social_network" bson:"social_network"`

	// is filled filled bt user and acceptable for pushes from portal
	Filled        bool `json:"filled" bson:"filled"`
	PushAgreement bool `json:"push_agreement" bson:"push_agreement"`

	// balance for paid internet
	Balance  int    `json:"balance" bson:"balance"`
	Currency string `json:"currency" bson:"currency"`

	// creation time
	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`

	// common statistics
	Visits map[string]int `json:"visits" bson:"visits"`

	// subscription data
	SubscribeID       string `json:"subscribe_id" bson:"subscribe_id"`
	CreateAtSubscribe int64  `json:"create_at_subscribe" bson:"create_at_subscribe"`
}

type PortalUserAccountShort struct {
	Profile string `json:"profile" bson:"profile"`

	Identity string   `json:"identity" bson:"identity"`
	MACs     []string `json:"macs" bson:"macs"`

	Name    string `json:"name" bson:"name"`
	SurName string `json:"surname" bson:"surname"`
	Filled  bool   `json:"filled" bson:"filled"`

	PushAgreement bool `json:"push_agreement" bson:"push_agreement"`

	Balance  int    `json:"balance" bson:"balance"`
	Currency string `json:"currency" bson:"currency"`

	CreateAt int64 `json:"create_at" bson:"create_at"`

	SubscribeID       string `json:"subscribe_id"`
	CreateAtSubscribe int64  `json:"create_at_subscribe"`
}

type PortalUserHotelVoucher struct {
	ID string `json:"id" bson:"_id"`

	Account string `json:"account" bson:"account"`
	Profile string `json:"profile" bson:"profile"`

	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`

	StartAt  int64 `json:"start_at" bson:"start_at"`
	ExpireAt int64 `json:"expire_at" bson:"expire_at"`

	Code string `json:"code" bson:"code"`
	Used bool   `json:"used" bson:"used"`

	// limits
	SpeedLimit   int   `json:"speed" bson:"speed"`
	TimeoutLimit int64 `json:"session" bson:"session"`
	TrafficLimit int   `json:"traffic" bson:"traffic"`
}

type PortalUserState string

type PortalUserVoucher struct {
	ID string `json:"id" bson:"_id"`

	Account string `json:"account" bson:"account"`
	Profile string `json:"profile" bson:"profile"`

	Create   time.Time `json:"create" bson:"create"`
	CreateAt int64     `json:"create_at" bson:"create_at"`

	StartAt  int64 `json:"start_at" bson:"start_at"`
	ExpireAt int64 `json:"expire_at" bson:"expire_at"`

	Code string `json:"code" bson:"code"`
	Used bool   `json:"used" bson:"used"`

	Identity string `json:"identity" bson:"identity"`

	// limits
	SpeedLimit   int   `json:"speed" bson:"speed"`
	TimeoutLimit int64 `json:"session" bson:"session"`
	TrafficLimit int   `json:"traffic" bson:"traffic"`

	// not needed anymore
	Plan string `json:"tariff" bson:"tariff"`
}

type RadAccessRequest struct {
	NASIdentifier string `json:"NAS-Identifier"`
	NASIPAddress  string `json:"NAS-IP-Address"`
	NASPortId     string `json:"NAS-Port-Id"`
	NASPort       string `json:"NAS-Port"`
	NASPortType   string `json:"NAS-Port-Type"`

	UserName         string `json:"User-Name"`
	CHAPPassword     string `json:"CHAP-Password"`
	CHAPChallenge    string `json:"CHAP-Challenge"`
	FramedIPAddress  string `json:"Framed-IP-Address"`
	WISPrLocationID  string `json:"WISPr-Location-ID"`
	WISPrLogoffURL   string `json:"WISPr-Logoff-URL"`
	CalledStationId  string `json:"Called-Station-Id"`
	CallingStationId string `json:"Calling-Station-Id"`
	AcctSessionId    string `json:"Acct-Session-Id"`

	ServiceType          string `json:"Service-Type"`
	MessageAuthenticator string `json:"Message-Authenticator"`
	EventTimestamp       string `json:"Event-Timestamp"`
	ChilliSpotVersion    string `json:"ChilliSpot-Version"`
}

type RadAccessResponce struct {
	Code  int         `json:"Code"`
	Reply []MapEntity `json:"Reply-Message,omitempty"`
}

type RadAccounting struct {
	RadAcctRequest
	Create time.Time `json:"create" bson:"create"`
	ID     string    `json:"id" bson:"_id"`
}

type RadAcctRequest struct {
	CalledStationId  string `json:"Called-Station-Id"`
	CallingStationId string `json:"Calling-Station-Id"`
	EventTimestamp   string `json:"Event-Timestamp"`

	NASIdentifier string `json:"NAS-Identifier"`
	NASIPAddress  string `json:"NAS-IP-Address"`
	NASPortType   string `json:"NAS-Port-Type"`

	AcctStatusType      string `json:"Acct-Status-Type"`
	AcctTerminateCause  string `json:"Acct-Terminate-Cause,omitempty"`
	AcctSessionID       string `json:"Acct-Session-ID"`
	AcctDelayTime       string `json:"Acct-Delay-Time"`
	AcctInputGigawords  string `json:"Acct-Input-Gigawords"`
	AcctOutputGigawords string `json:"Acct-Output-Gigawords"`
	AcctOutputOctets    string `json:"Acct-Output-Octets"`
	AcctInputOctets     string `json:"Acct-Input-Octets"`
	AcctInputPackets    string `json:"Acct-Input-Packets"`
	AcctOutputPackets   string `json:"Acct-Output-Packets"`
	AcctSessionTime     string `json:"Acct-Session-Time"`

	Attr261455910     string `json:"Attr-26.14559.10"`
	ChilliSpotVersion string `json:"ChilliSpot-Version"`
	WISPrLocationID   string `json:"WISPr-Location-ID"`
}

type RadAcctResponse RadAccessResponce

type RadCoARequest struct {
	UserName        string `json:"User-Name"`
	AcctSessionId   string `json:"Acct-Session-Id"`
	FramedIPAddress string `json:"Framed-IP-Address"`

	SessionTimeout int `json:"Session-Timeout"`
	IdleTimeout    int `json:"Idle-Timeout"`
}

type Schedule struct {
	// only for ADvertisement
	Views int `json:"views" bson:"views"`

	// range of schedule
	Start int64 `json:"start" bson:"start"`
	Stop  int64 `json:"stop" bson:"stop"`

	// diff with UTC (+4 or -3)
	UTCDiff int `json:"utc_diff" bson:"utc_diff"`

	// day Of week mask (1 << ct.Weekday()!)
	// example: 1 << 0 && 1 << 6 for Sunday && Saturday (or yeah, Sunday FIRST)
	DoWMask int `json:"dow_mask" bson:"dow_mask"`

	// hour of day mask (1 << ct.Hour()!)
	// example: HourMask = 1 << 0 + 1 << 1 for 0-1 and 1-2 hours
	HourMask int `json:"hour_mask" bson:"hour_mask"`

	// old time of day format
	TimeOfDay struct {
		Morning   bool `json:"morning,omitempty" bson:"morning"`
		Afternoon bool `json:"afternoon,omitempty" bson:"afternoon"`
		Evening   bool `json:"evening,omitempty" bson:"evening"`
		Night     bool `json:"night,omitempty" bson:"night"`
	} `json:"time_of_day,omitempty" bson:"time_of_day"`

	// old day of week format
	DayOfWeek struct {
		Monday    bool `json:"monday,omitempty" bson:"monday"`
		Tuesday   bool `json:"tuesday,omitempty" bson:"tuesday"`
		Wednesday bool `json:"wednesday,omitempty" bson:"wednesday"`
		Thursday  bool `json:"thursday,omitempty" bson:"thursday"`
		Friday    bool `json:"friday,omitempty" bson:"friday"`
		Saturday  bool `json:"saturday,omitempty" bson:"saturday"`
		Sunday    bool `json:"sunday,omitempty" bson:"sunday"`
	} `json:"day_of_week,omitempty" bson:"day_of_week"`
}

type TariffPlanType string

type UserAgent struct {
	Type      string `json:"type" bson:"type"`
	Device    string `json:"device" bson:"device"`
	Name      string `json:"name" bson:"name"`
	OS        string `json:"os" bson:"os"`
	OSVersion string `json:"os_version" bson:"os_version"`
}