adtype

type AccessPoint interface {
	// ID of the access point
	ID() uint64

	// AccountID of the access point
	AccountID() uint64

	// Pricing model
	PricingModel() types.PricingModel
}

type Account interface {
	ID() uint64

	// CommissionShareFactor which system get from publisher 0..1
	CommissionShareFactor() float64
}

type AccountWithBudget interface {
	Account

	// TestBudget of the account retuns true if the account has sufficient budget
	// and greater than the specified value
	TestBudget(vol billing.Money) bool
}

type Action int

type AppInfo = udetect.App

type BidRequester interface {
	fmt.Stringer
	IsNillable

	ID() string         // Unique ID of the request
	ExternalID() string // External ID of the request (from OpenRTB)

	ProjectID() uint64              // Project ID (placeholder)
	AuctionID() string              // Unique ID of the auction
	ExternalAuctionID() string      // External ID of the auction (from OpenRTB)
	AuctionType() types.AuctionType // Type of auction (first price, second price, etc)

	WithFormats(types.FormatsAccessor) BidRequester // Set formats accessor

	// HTTP and domain info
	HTTPRequest() *fasthttp.RequestCtx // Raw HTTP context
	ServiceDomain() string             // Host of the request

	// Request state and flags
	IsDebug() bool           // True if debug mode is enabled
	IsSecure() bool          // True if request is HTTPS
	IsAdBlock() bool         // True if adblock detected
	IsPrivateBrowsing() bool // True if in incognito
	IsRobot() bool           // True if bot detected
	IsProxy() bool           // True if proxy detected
	IsIPv6() bool            // True if IP is IPv6

	// Source filtering
	SourceFilterCheck(id uint64) bool // Check if source ID is allowed

	// Device and environment
	DeviceInfo() *DeviceInfo   // Full device info
	BrowserInfo() *BrowserInfo // Browser info
	OSInfo() *OSInfo           // OS info

	// App, site, geo
	TrafficSourceID() uint64   // Traffic source ID
	AppID() uint64             // Target app ID
	AppInfo() *AppInfo         // App info
	SiteInfo() *SiteInfo       // Site info or default
	Domain() []string          // Domain list
	DomainName() string        // Main domain or bundle name
	GeoID() uint64             // Geo ID
	GeoInfo() *GeoInfo         // Geo info
	CarrierInfo() *CarrierInfo // Carrier info

	// User info
	UserInfo() *User      // Full user info
	LanguageID() uint64   // Browser language
	Keywords() []string   // User keywords
	Tags() []string       // Combined tags
	Categories() []uint64 // Categories (currently cached)
	Sex() uint            // Sex of the user
	Age() uint            // Age of the user

	AccessPoint() AccessPoint   // Access point information
	Formats() types.BidFormater // Formats accessor

	// Financial
	MinECPM() billing.Money // Max of all bid floors

	// Size returns the width and height of the area of visibility for the ad.
	Size() (w, h int)

	// TargetID of the specific point
	TargetID() uint64
	TargetIDs() []uint64
	ExtTargetIDs() []string

	// Impressions
	Impressions() []*Impression                 // List of impressions
	ImpressionUpdate(fn func(*Impression) bool) // Modify all impressions
	ImpressionByID(id string) *Impression       // Exact match
	TargetPointers() []types.TargetPointer      // TargetPointer interfaces for each impression

	// Ext map manipulation
	Get(key string) any      // Get ext value
	Set(key string, val any) // Set ext value
	Unset(keys ...string)    // Unset keys

	Time() time.Time           // Timestamp of the request
	CurrentGeoTime() time.Time // Current time in the geo of the request
	Validate() error           // Validate request
	Release()                  // Release resources

	Context() context.Context // Request context
	SetContext(ctx context.Context)
	Done() <-chan struct{} // Channel that closes when context is done
}

type BrowserInfo = udetect.Browser

type CarrierInfo = udetect.Carrier

type Data struct {
	Name    string    `json:"name,omitempty"`
	Segment []Segment `json:"segment,omitempty"`
}

type DeviceInfo = udetect.Device

type GeoInfo = udetect.Geo

type Impression struct {
	ID               string `json:"id,omitempty"`    // Internal impression ID
	ExternalID       string `json:"extid,omitempty"` // External impression ID (ImpID)
	ExternalTargetID string `json:"exttrgid"`        // External zone/unit/spot ID (tagid)

	Request any    `json:"request,omitempty"` // Contains subrequest from RTB or another protocol
	Target  Target `json:"target,omitempty"`

	BidFloorCPM       billing.Money `json:"bid_floor,omitempty"`
	PurchaseImpPrice  billing.Money `json:"purchase_imp_price,omitempty"`
	PurchaseViewPrice billing.Money `json:"purchase_view_price,omitempty"`

	// Ad position
	Pos          int  `json:"pos,omitempty"`  // 5.4 Ad Position
	Count        int  `json:"cnt,omitempty"`  // Count of places for multiple banners
	Interstitial bool `json:"intr,omitempty"` // Interstitial or full screen display
	Push         bool `json:"push,omitempty"` // Push notification

	// Sizes and position on the screen
	X         int `json:"x,omitempty"`
	Y         int `json:"y,omitempty"`
	Width     int `json:"w,omitempty"`
	Height    int `json:"h,omitempty"`
	WidthMax  int `json:"wm,omitempty"`
	HeightMax int `json:"hm,omitempty"`

	// Additional identifiers
	SubID1 string `json:"subid1,omitempty"`
	SubID2 string `json:"subid2,omitempty"`
	SubID3 string `json:"subid3,omitempty"`
	SubID4 string `json:"subid4,omitempty"`
	SubID5 string `json:"subid5,omitempty"`

	// Format types for impression
	FormatTypes types.FormatTypeBitset `json:"-"`
	FormatCodes []string               `json:"-"`

	Ext map[string]any `json:"ext,omitempty"`
	// contains filtered or unexported fields
}

type IsNillable interface {
	IsNil() bool
}

type MacroMapper struct {
	AuctionID   string
	AuctionType string
	ImpID       string
	ClickID     string

	CampaignID string
	AdID       string

	Platform   string
	PriceModel string

	Country   string
	City      string
	Latitude  string
	Longitude string
	Language  string

	Domain   string
	AppID    string
	ZoneID   string
	ZoneCode string

	UUID      string
	SessionID string
	UserIP    string
	CarrierID string

	DeviceType  string
	DeviceID    string
	DeviceName  string
	OSID        string
	OSName      string
	BrowserID   string
	BrowserName string

	Price float64
}

type NoSupportError struct {
	NSField string
}

type OSInfo = udetect.OS

type RequestStrategy int

type Response interface {
	// AuctionID response
	AuctionID() string

	// AuctionType of request
	AuctionType() types.AuctionType

	// Source of response
	Source() Source

	// Request information
	Request() BidRequester

	// Ads list
	Ads() []ResponseItemCommon

	// IterAds returns an iterator over the response items.
	IterAds() iter.Seq[ResponseItem]

	// Item by impression code
	Item(impid string) ResponseItemCommon

	// Count of response items
	Count() int

	// Validate response
	Validate() error

	// Error of the response
	Error() error

	// Context value
	Context(ctx ...context.Context) context.Context

	// Get context item by key
	Get(key string) any

	// Release response and all linked objects
	Release()
}

type ResponseError struct {
	// contains filtered or unexported fields
}

type ResponseItem interface {
	ResponseItemCommon

	// NetworkName returns the name of the ad network that provided the response.
	NetworkName() string

	// AccountID returns the unique identifier of the advertiser's account.
	AccountID() uint64

	// CampaignID returns the unique identifier of the advertising campaign.
	CampaignID() uint64

	// LinkID returns the unique identifier of the served AdLink (0 if none).
	LinkID() uint64

	// AdID returns the unique identifier of the advertisement.
	AdID() string

	// CreativeID returns the unique identifier of the creative asset used in the advertisement.
	CreativeID() string

	// Format returns the format information of the advertisement.
	Format() *types.Format

	// PricingModel returns the pricing model used for the advertisement (e.g., CPC, CPM).
	PricingModel() types.PricingModel

	// ContentItem retrieves the ad response data for a given content item name.
	// It returns the content in its original type.
	ContentItem(name string) any

	// ContentItemString retrieves the ad response data for a given content item name as a string.
	ContentItemString(name string) string

	// ContentFields returns a map of all content fields associated with the advertisement.
	ContentFields() map[string]any

	// MainAsset returns the primary asset of the advertisement (e.g., image, video).
	MainAsset() *admodels.AdFileAsset

	// Assets returns a list of all assets associated with the advertisement.
	Assets() admodels.AdFileAssets

	// Source returns the source information of the advertisement response.
	Source() Source

	// ImpressionTrackerLinks returns traking links for impression action
	ImpressionTrackerLinks() []string

	// ViewTrackerLinks returns a slice of tracking URLs for view actions.
	ViewTrackerLinks() []string

	// ClickTrackerLinks returns a slice of tracking URLs for click actions.
	ClickTrackerLinks() []string

	// IsDirect indicates whether the advertisement is a direct ad type.
	IsDirect() bool

	// IsBackup indicates whether the advertisement is a backup ad type.
	IsBackup() bool

	// ActionURL returns the target URL for direct and banner click actions.
	ActionURL() string

	// Width returns the width of the advertisement in pixels.
	Width() int

	// Height returns the height of the advertisement in pixels.
	Height() int

	// ECPM returns the Effective Cost Per Mille (thousand impressions) value of the advertisement.
	ECPM() billing.Money

	// Price returns the total price for a specific action (e.g., click, lead, view).
	Price(action Action) billing.Money

	// SetBidPrice sets the current bid price for the given action, used for the
	// external auction source. If withCommission is true, the price is treated as
	// the net amount that must remain after discrepancy corrections and the
	// commission share are deducted downstream (see PublisherPrice) and is grossed
	// up via BidUpPrice-style calculation before being stored. If withCommission is
	// false, the price is stored as given.
	SetBidPrice(action Action, price billing.Money, withCommission bool) error

	// PrepareBidPrice prepares the bid price for the given action by clamping it
	// to the maximal allowed bid of that action (if defined). Used before storing
	// or comparing a candidate bid against the current auction limits.
	PrepareBidPrice(action Action, price billing.Money) billing.Money

	// PurchasePrice returns the price of a specific action from an external resource (e.g., site, app, RTB).
	// This represents the cost of the request for the network.
	// Without the network commission.
	PurchasePrice(action Action) billing.Money

	// PotentialPrice returns the potential price that could be received from the source but was marked as a discrepancy.
	PotentialPrice(action Action) billing.Money

	// FinalPrice returns the final price for the advertisement item, including all possible commissions and corrections.
	// This is the price that will be charged to the advertiser.
	FinalPrice(action Action) billing.Money

	// Second returns a pointer to the SecondAd, representing secondary campaigns.
	Second() *SecondAd

	// CommissionShareFactor returns the multiplier used for commission calculations.
	// It represents the portion of user revenue the system receives, ranging from 0 to 1.
	CommissionShareFactor() float64

	// SourceCorrectionFactor returns the correction factor applied to the source.
	SourceCorrectionFactor() float64

	// TargetCorrectionFactor returns the correction factor applied to the target.
	TargetCorrectionFactor() float64
}

type ResponseItemCommon interface {
	// ID returns the unique identifier of the current response item.
	ID() string

	// Impression returns the Impression object associated with this response item.
	Impression() *Impression

	// ImpressionID returns the unique identifier string of the Impression.
	ImpressionID() string

	// ExtImpressionID returns the external unique identifier of the auction bid impression.
	ExtImpressionID() string

	// ExtTargetID returns the external target identifier from the external network.
	ExtTargetID() string

	// TargetCodename returns the target placement codename.
	TargetCodename() string

	// InternalAuctionCPMBid provides the maximum possible CPM (Cost Per Mille) bid without any commission.
	// This value is used by the system to select the best item for the auction.
	InternalAuctionCPMBid() billing.Money

	// PriorityFormatType returns the format type that has priority in the current ad.
	PriorityFormatType() types.FormatType

	// Validate checks the validity of the response item.
	// It returns an error if the item is invalid.
	Validate() error

	// Context returns the contextual information associated with the response item.
	// It can accept additional contexts to merge with the existing one.
	Context(ctx ...context.Context) context.Context

	// Get retrieves a value from the response item's extension map by the provided key.
	// It returns nil if the key does not exist.
	Get(key string) any
}

type ResponseItemEmpty struct {
	Imp *Impression
	Req BidRequester
	Src Source
	// contains filtered or unexported fields
}

type ResponseMultipleItem interface {
	ResponseItemCommon

	// Ads returns a slice of ResponseItem interfaces representing individual ads within the response.
	Ads() []ResponseItem

	// Count returns the total number of response items (ads) in the response.
	Count() int
}

type SecondAd struct {
	ID         string        `json:"id,omitempty"`
	Network    string        `json:"network,omitempty"`
	SourceID   uint64        `json:"source_id,omitempty"`
	CampaignID uint64        `json:"campaign_id,omitempty"`
	Price      billing.Money `json:"price,omitempty"`
}

type Segment struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

type SiteInfo = udetect.Site

type Source interface {
	SourceMinimal

	// AccountID of the source driver
	AccountID() uint64

	SourceTesteChecker

	// ID of the source driver
	ID() uint64

	// ObjectKey of the source driver
	ObjectKey() uint64

	// Protocol of the source driver
	Protocol() string

	// Info returns information about the source platform and the source protocol
	Info() *SourceInfo

	// PriceCorrectionReduceFactor which is a potential
	// Returns percent from 0 to 1 for reducing of the value
	// If there is 10% of price correction, it means that 10% of the final price must be ignored
	PriceCorrectionReduceFactor() float64

	// RequestStrategy description
	RequestStrategy() RequestStrategy
}

type SourceAccessor interface {
	// Iterator returns the configured queue accessor
	Iterator(request BidRequester) SourceIterator

	// SourceByID returns source instance
	SourceByID(ctx context.Context, id uint64) (Source, error)

	// SetTimeout for sourcer
	SetTimeout(ctx context.Context, timeout time.Duration)
}

type SourceEmpty struct {
	PriceCorrectionReduce float64 // from 0 to 1
}

type SourceFactory interface {
	// Info returns information about the source platform
	// and the source protocol
	Info() info.Platform

	// Protocols returns list of supported protocols of the source
	Protocols() []string

	// New creates a new source instance for the given RTBSource
	New(ctx context.Context, source *admodels.RTBSource, opts ...any) (SourceTester, error)
}

type SourceInfo struct {
	ID          string         `json:"id"`
	Protocol    string         `json:"protocol"`
	Name        string         `json:"name,omitempty"`
	Description string         `json:"description,omitempty"`
	Domain      string         `json:"domain,omitempty"`
	IconURL     string         `json:"icon_url,omitempty"`
	LogoURL     string         `json:"logo_url,omitempty"`
	URL         string         `json:"url,omitempty"`
	DSPDomains  []string       `json:"dsp_domains,omitempty"` // ["*.dsp.domain.com"]
	Metadata    map[string]any `json:"metadata,omitempty"`
}

type SourceInfoList []*SourceInfo

type SourceIterator = iter.Seq2[float32, Source]

type SourceMinimal interface {
	// Bid request for standart system filter
	Bid(request BidRequester) Response

	// ProcessResponseItem result or error
	ProcessResponseItem(Response, ResponseItem)
}

type SourceTesteChecker interface {
	// Test current request for compatibility.
	// Returns a typed cause on rejection, or nil when the request may proceed.
	Test(request BidRequester) error
}

type SourceTester interface {
	Source
	SourceTesteChecker
}

type SourceTimeoutSetter interface {
	// SetTimeout for sourcer
	SetTimeout(timeout time.Duration)
}

type Target interface {
	// ID of object (Zone OR SmartLink only)
	ID() uint64

	// Codename of the target (equal to tagid)
	Codename() string

	// ObjectKey of the target
	ObjectKey() string

	// PricingModel of the target
	// Undefined as any priceing model type
	PricingModel() types.PricingModel

	// AlternativeAdCode returns URL or any code (HTML, XML, etc)
	// for alternative ad code for the target.
	// Key represents adformat code (banner, video, direct, etc)
	AlternativeAdCode(key string) string

	// PurchasePrice gives the price of view from external resource
	PurchasePrice(action Action) billing.Money

	// CommissionShareFactor of current target from 0 to 1
	CommissionShareFactor() float64

	// RevenueShareReduceFactor correction factor to reduce target proce of the access point to avoid descrepancy
	// Returns percent from 0 to 1 for reducing of the value
	// If there is 10% of price correction, it means that 10% of the final price must be ignored
	RevenueShareReduceFactor() float64

	// Account object
	Account() Account
}

type TargetEmpty struct {
	Acc Account
}

type TypeSex uint8

type URLGenerator interface {
	// CDNURL returns full URL to path
	CDNURL(path string) string

	// LibURL returns full URL to lib file path
	LibURL(path string) string

	// PixelURL generator from response of item
	// @param js generates the JavaScript pixel type
	PixelURL(event events.Type, status uint8, item ResponseItem, response Response, js bool) (string, error)

	// PixelDirectURL generator from response of item
	PixelDirectURL(event events.Type, status uint8, item ResponseItem, response Response, direct string) (string, error)

	// PixelLead URL
	PixelLead(item ResponseItem, response Response, js bool) (string, error)

	// MustClickURL generator from response of item
	MustClickURL(item ResponseItem, response Response) string

	// ClickURL generator from response of item
	ClickURL(item ResponseItem, response Response) (string, error)

	// ClickRouterURL returns router pattern
	ClickRouterURL() string

	// DirectURL generator from response of item
	DirectURL(event events.Type, item ResponseItem, response Response) (string, error)

	// DirectRouterURL returns router pattern
	DirectRouterURL() string

	// WinURL generator from response of item
	WinURL(event events.Type, status uint8, item ResponseItem, response Response) (string, error)

	// BillingNoticeURL generator from response of item
	BillingNoticeURL(event events.Type, status uint8, item ResponseItem, response Response) (string, error)

	// WinRouterURL returns router pattern
	WinRouterURL() string
}

type User struct {
	ID            string       `json:"id,omitempty"`        // Unique User ID
	Email         string       `json:"email,omitempty"`     // In some cases it's able the use email, and we are gonna use it
	Username      string       `json:"username,omitempty"`  // User profile name from the external service or potentional username
	SessionID     string       `json:"sessid,omitempty"`    // Unique session ID
	FingerPrintID string       `json:"fpid,omitempty"`      //
	ETag          string       `json:"etag,omitempty"`      //
	Birthday      string       `json:"birthday,omitempty"`  // * Prefer do not use such personal information in alghoritm
	AgeStart      int          `json:"age_start,omitempty"` // Year of birth from
	AgeEnd        int          `json:"age_end,omitempty"`   // Year of birth from
	Gender        string       `json:"gender,omitempty"`    // Gender ("M": male, "F" female, "O" Other)
	Keywords      string       `json:"keywords,omitempty"`  // Comma separated list of keywords, interests, or intent
	Geo           *udetect.Geo `json:"geo,omitempty"`
	Data          []Data       `json:"data,omitempty"`
	// contains filtered or unexported fields
}

type VirtualTarget struct {
	// contains filtered or unexported fields
}

type WinEvent struct {
	Time     time.Time `json:"t,omitempty"`
	Counter  int       `json:"c,omitempty"`
	URL      string    `json:"u"`
	Data     any       `json:"d,omitempty"`
	Response string    `json:"-"`
	Error    error     `json:"-"`
	Status   int       `json:"-"`
}