/**
 * User
 *
 * @interface IUser
 */
export interface IUser {
  /**
   * IFA of user
   * @memberof IUser
   */
  aaid?: string | null;

  /**
   * Ogury user ID
   * @memberof IUser
   */
  odid: string;

  /**
   * True if we get consent for this user
   * @memberof IUser
   */
  is_data_optin?: boolean | null;

  /**
   * IAB string
   * @memberof IUser
   */
  consent?: string | null;

  /**
   * consent ADS flag
   * @memberof IUser
   */
  consent_ads?: string | null;

  tcf_version?: number | null;

  /**
   * Should GDPR apply to the request
   * @memberof IUser
   */
  is_gdpr_applied?: boolean | null;
}

export interface IAsset {
  name: string;

  seller_id?: string | null;

  publisher_name?: string | null;

  publisher_is_network_partner?: boolean | null;

  ad_unit_id?: string | null;

  ad_unit_type?: string | null;

  sdk_version?: string | null;
}

export interface IApp extends IAsset {
  // Bundle Name of the app (eg. net.zedge.android)
  bundle: string;

  // IAB categories
  categories?: string[] | null;
}

export interface ISite extends IAsset {
  domain: string;
  bsw_id?: string | null;
  ttd_id?: string | null;
}

export interface IDeviceScreenSize {
  width: number;
  height: number;
  density?: number | null;
}

export interface IDevice {
  user_agent: string;

  language?: string | null;

  os_type: string;

  ip: string;

  /**
   * Whether the request comes from omid compliant device
   * @memberof IDevice
   */
  is_omid_compliant: boolean;

  screen_size?: IDeviceScreenSize;
}

export interface ICampaign {
  id: number;

  bid_floor?: number | null;

  deal_id?: string | null;

  /**
   * Array of Buyer seats allowed to bid on this Deal (SSP)
   * @memberof IDevice
   */
  wseat?: string[] | null;

  // DSP buyer ID for TTD direct integration
  dsp_buyer_id?: string | null;

  // Campaign compatible with vpaid tracking
  vpaid?: boolean | null;

  // Type of ads video|display
  ad_type?: string | null;
}

export interface IAuctionRequest {
  /**
   * Unique ID of the marketplace request
   *
   * @memberof IMarketPlaceRequest
   */
  advert_id: string;

  user: IUser;

  app?: IApp;

  site?: ISite;

  device: IDevice;

  /**
   * Campaigns candidate for the request
   *
   * @memberof IMarketPlaceRequest
   */
  campaigns: ICampaign[];

  ogury_bidfloor?: number | null;

  context: {
    country_code: string;
    environment_type: string;
    inventory_source: string;
    auction_type: string;
  };
}

export interface IAuctionResponse {
  advert_id: string;

  /**
   * Selected Campaign
   *
   * @memberof IMarketPlaceResponse
   */
  campaign: number;

  /**
   * Clearing price computed by SSP, in USD, in CPM
   *
   * @memberof IMarketPlaceResponse
   */
  price: number;

  /**
   * Advertiser’s primary or top-level domain for advertiser checking.
   *
   * @memberof IMarketPlaceResponse
   */
  advertiser_domain: string;
  /**
   * The name of the advertiser serving the creative
   *
   * @memberof IMarketPlaceResponse
   */
  advertiser_name: string;

  /**
   * The name of the agency representing the advertiser
   *
   * @memberof IMarketPlaceResponse
   */
  agency_name: string;

  /**
   * ID of the agency representing the advertiser
   *
   * @memberof IMarketPlaceResponse
   */
  agency_id: string;

  /**
   * ID of the bidder seat on whose behalf this ad response is made.
   *
   * @memberof IMarketPlaceResponse
   */
  seat: string;

  /**
   * DealID of the winning campaign
   */
  deal_id?: string;
}