eve-esi-types/v2/globals/factionwarfare.d.ts

Extracted the main type of ESI. use for ESI request response types (version 2 only)

// Generated by scripts/lib/code-synthesizer.mjs

// - - - - - - - - - - - - - - - - - - - -
//            @method {get}
// - - - - - - - - - - - - - - - - - - - -
/*!
 * ESI endpoint: get:/characters/{character_id}/fw/stats/
 */

/**
 * 200 ok object
 */
interface GetCharactersCharacterIdFwStatsOk {
  /**
   * The given character's current faction rank
   */
  current_rank?: number;
  /**
   * The enlistment date of the given character into faction warfare. Will not be included if character is not enlisted in faction warfare
   */
  enlisted_on?: string;
  /**
   * The faction the given character is enlisted to fight for. Will not be included if character is not enlisted in faction warfare
   */
  faction_id?: number;
  /**
   * The given character's highest faction rank achieved
   */
  highest_rank?: number;
  kills: GetCharactersCharacterIdFwStatsKills;
  victory_points: GetCharactersCharacterIdFwStatsVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Summary of kills done by the given character against enemy factions
 */
interface GetCharactersCharacterIdFwStatsKills {
  /**
   * Last week's total number of kills by a given character against enemy factions
   */
  last_week: number;
  /**
   * Total number of kills by a given character against enemy factions since the character enlisted
   */
  total: number;
  /**
   * Yesterday's total number of kills by a given character against enemy factions
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}
/**
 * Summary of victory points gained by the given character for the enlisted faction
 */
interface GetCharactersCharacterIdFwStatsVictoryPoints {
  /**
   * Last week's victory points gained by the given character
   */
  last_week: number;
  /**
   * Total victory points gained since the given character enlisted
   */
  total: number;
  /**
   * Yesterday's victory points gained by the given character
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}

/*!
 * ESI endpoint: get:/corporations/{corporation_id}/fw/stats/
 */

/**
 * 200 ok object
 */
interface GetCorporationsCorporationIdFwStatsOk {
  /**
   * The enlistment date of the given corporation into faction warfare. Will not be included if corporation is not enlisted in faction warfare
   */
  enlisted_on?: string;
  /**
   * The faction the given corporation is enlisted to fight for. Will not be included if corporation is not enlisted in faction warfare
   */
  faction_id?: number;
  kills: GetCorporationsCorporationIdFwStatsKills;
  /**
   * How many pilots the enlisted corporation has. Will not be included if corporation is not enlisted in faction warfare
   */
  pilots?: number;
  victory_points: GetCorporationsCorporationIdFwStatsVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Summary of kills done by the given corporation against enemy factions
 */
interface GetCorporationsCorporationIdFwStatsKills {
  /**
   * Last week's total number of kills by members of the given corporation against enemy factions
   */
  last_week: number;
  /**
   * Total number of kills by members of the given corporation against enemy factions since the corporation enlisted
   */
  total: number;
  /**
   * Yesterday's total number of kills by members of the given corporation against enemy factions
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}
/**
 * Summary of victory points gained by the given corporation for the enlisted faction
 */
interface GetCorporationsCorporationIdFwStatsVictoryPoints {
  /**
   * Last week's victory points gained by members of the given corporation
   */
  last_week: number;
  /**
   * Total victory points gained since the given corporation enlisted
   */
  total: number;
  /**
   * Yesterday's victory points gained by members of the given corporation
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}

/*!
 * ESI endpoint: get:/fw/leaderboards/
 */
/**
 * Top 4 ranking of factions active in faction warfare by total kills. A faction is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 4
 */
type GetFwLeaderboardsActiveTotal =
  | []
  | [GetFwLeaderboardsActiveTotalActiveTotal]
  | [GetFwLeaderboardsActiveTotalActiveTotal, GetFwLeaderboardsActiveTotalActiveTotal]
  | [
      GetFwLeaderboardsActiveTotalActiveTotal,
      GetFwLeaderboardsActiveTotalActiveTotal,
      GetFwLeaderboardsActiveTotalActiveTotal
    ]
  | [
      GetFwLeaderboardsActiveTotalActiveTotal,
      GetFwLeaderboardsActiveTotalActiveTotal,
      GetFwLeaderboardsActiveTotalActiveTotal,
      GetFwLeaderboardsActiveTotalActiveTotal
    ];
/**
 * Top 4 ranking of factions by kills in the past week
 *
 * @maxItems 4
 */
type GetFwLeaderboardsLastWeek =
  | []
  | [GetFwLeaderboardsLastWeekLastWeek]
  | [GetFwLeaderboardsLastWeekLastWeek, GetFwLeaderboardsLastWeekLastWeek]
  | [GetFwLeaderboardsLastWeekLastWeek, GetFwLeaderboardsLastWeekLastWeek, GetFwLeaderboardsLastWeekLastWeek]
  | [
      GetFwLeaderboardsLastWeekLastWeek,
      GetFwLeaderboardsLastWeekLastWeek,
      GetFwLeaderboardsLastWeekLastWeek,
      GetFwLeaderboardsLastWeekLastWeek
    ];
/**
 * Top 4 ranking of factions by kills in the past day
 *
 * @maxItems 4
 */
type GetFwLeaderboardsYesterday =
  | []
  | [GetFwLeaderboardsYesterdayYesterday]
  | [GetFwLeaderboardsYesterdayYesterday, GetFwLeaderboardsYesterdayYesterday]
  | [GetFwLeaderboardsYesterdayYesterday, GetFwLeaderboardsYesterdayYesterday, GetFwLeaderboardsYesterdayYesterday]
  | [
      GetFwLeaderboardsYesterdayYesterday,
      GetFwLeaderboardsYesterdayYesterday,
      GetFwLeaderboardsYesterdayYesterday,
      GetFwLeaderboardsYesterdayYesterday
    ];
/**
 * Top 4 ranking of factions active in faction warfare by total victory points. A faction is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 4
 */
type GetFwLeaderboardsVictoryPointsActiveTotal =
  | []
  | [GetFwLeaderboardsActiveTotalActiveTotal_1]
  | [GetFwLeaderboardsActiveTotalActiveTotal_1, GetFwLeaderboardsActiveTotalActiveTotal_1]
  | [
      GetFwLeaderboardsActiveTotalActiveTotal_1,
      GetFwLeaderboardsActiveTotalActiveTotal_1,
      GetFwLeaderboardsActiveTotalActiveTotal_1
    ]
  | [
      GetFwLeaderboardsActiveTotalActiveTotal_1,
      GetFwLeaderboardsActiveTotalActiveTotal_1,
      GetFwLeaderboardsActiveTotalActiveTotal_1,
      GetFwLeaderboardsActiveTotalActiveTotal_1
    ];
/**
 * Top 4 ranking of factions by victory points in the past week
 *
 * @maxItems 4
 */
type GetFwLeaderboardsVictoryPointsLastWeek =
  | []
  | [GetFwLeaderboardsLastWeekLastWeek_1]
  | [GetFwLeaderboardsLastWeekLastWeek_1, GetFwLeaderboardsLastWeekLastWeek_1]
  | [GetFwLeaderboardsLastWeekLastWeek_1, GetFwLeaderboardsLastWeekLastWeek_1, GetFwLeaderboardsLastWeekLastWeek_1]
  | [
      GetFwLeaderboardsLastWeekLastWeek_1,
      GetFwLeaderboardsLastWeekLastWeek_1,
      GetFwLeaderboardsLastWeekLastWeek_1,
      GetFwLeaderboardsLastWeekLastWeek_1
    ];
/**
 * Top 4 ranking of factions by victory points in the past day
 *
 * @maxItems 4
 */
type GetFwLeaderboardsVictoryPointsYesterday =
  | []
  | [GetFwLeaderboardsYesterdayYesterday_1]
  | [GetFwLeaderboardsYesterdayYesterday_1, GetFwLeaderboardsYesterdayYesterday_1]
  | [
      GetFwLeaderboardsYesterdayYesterday_1,
      GetFwLeaderboardsYesterdayYesterday_1,
      GetFwLeaderboardsYesterdayYesterday_1
    ]
  | [
      GetFwLeaderboardsYesterdayYesterday_1,
      GetFwLeaderboardsYesterdayYesterday_1,
      GetFwLeaderboardsYesterdayYesterday_1,
      GetFwLeaderboardsYesterdayYesterday_1
    ];

/**
 * 200 ok object
 */
interface GetFwLeaderboardsOk {
  kills: GetFwLeaderboardsKills;
  victory_points: GetFwLeaderboardsVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Top 4 rankings of factions by number of kills from yesterday, last week and in total
 */
interface GetFwLeaderboardsKills {
  active_total: GetFwLeaderboardsActiveTotal;
  last_week: GetFwLeaderboardsLastWeek;
  yesterday: GetFwLeaderboardsYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsActiveTotalActiveTotal {
  /**
   * Amount of kills
   */
  amount?: number;
  /**
   * faction_id integer
   */
  faction_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsLastWeekLastWeek extends GetFwLeaderboardsActiveTotalActiveTotal {}
/**
 * yesterday object
 */
interface GetFwLeaderboardsYesterdayYesterday extends GetFwLeaderboardsActiveTotalActiveTotal {}
/**
 * Top 4 rankings of factions by victory points from yesterday, last week and in total
 */
interface GetFwLeaderboardsVictoryPoints {
  active_total: GetFwLeaderboardsVictoryPointsActiveTotal;
  last_week: GetFwLeaderboardsVictoryPointsLastWeek;
  yesterday: GetFwLeaderboardsVictoryPointsYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsActiveTotalActiveTotal_1 {
  /**
   * Amount of victory points
   */
  amount?: number;
  /**
   * faction_id integer
   */
  faction_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsLastWeekLastWeek_1 extends GetFwLeaderboardsActiveTotalActiveTotal_1 {}
/**
 * yesterday object
 */
interface GetFwLeaderboardsYesterdayYesterday_1 extends GetFwLeaderboardsActiveTotalActiveTotal_1 {}

/*!
 * ESI endpoint: get:/fw/leaderboards/characters/
 */
/**
 * Top 100 ranking of pilots active in faction warfare by total kills. A pilot is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersActiveTotal = GetFwLeaderboardsCharactersActiveTotalActiveTotal[];
/**
 * Top 100 ranking of pilots by kills in the past week
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersLastWeek = GetFwLeaderboardsCharactersLastWeekLastWeek[];
/**
 * Top 100 ranking of pilots by kills in the past day
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersYesterday = GetFwLeaderboardsCharactersYesterdayYesterday[];
/**
 * Top 100 ranking of pilots active in faction warfare by total victory points. A pilot is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersVictoryPointsActiveTotal = GetFwLeaderboardsCharactersActiveTotalActiveTotal_1[];
/**
 * Top 100 ranking of pilots by victory points in the past week
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersVictoryPointsLastWeek = GetFwLeaderboardsCharactersLastWeekLastWeek_1[];
/**
 * Top 100 ranking of pilots by victory points in the past day
 *
 * @maxItems 100
 */
type GetFwLeaderboardsCharactersVictoryPointsYesterday = GetFwLeaderboardsCharactersYesterdayYesterday_1[];

/**
 * 200 ok object
 */
interface GetFwLeaderboardsCharactersOk {
  kills: GetFwLeaderboardsCharactersKills;
  victory_points: GetFwLeaderboardsCharactersVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Top 100 rankings of pilots by number of kills from yesterday, last week and in total
 */
interface GetFwLeaderboardsCharactersKills {
  active_total: GetFwLeaderboardsCharactersActiveTotal;
  last_week: GetFwLeaderboardsCharactersLastWeek;
  yesterday: GetFwLeaderboardsCharactersYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsCharactersActiveTotalActiveTotal {
  /**
   * Amount of kills
   */
  amount?: number;
  /**
   * character_id integer
   */
  character_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsCharactersLastWeekLastWeek extends GetFwLeaderboardsCharactersActiveTotalActiveTotal{}
/**
 * yesterday object
 */
interface GetFwLeaderboardsCharactersYesterdayYesterday extends GetFwLeaderboardsCharactersActiveTotalActiveTotal{}
/**
 * Top 100 rankings of pilots by victory points from yesterday, last week and in total
 */
interface GetFwLeaderboardsCharactersVictoryPoints {
  active_total: GetFwLeaderboardsCharactersVictoryPointsActiveTotal;
  last_week: GetFwLeaderboardsCharactersVictoryPointsLastWeek;
  yesterday: GetFwLeaderboardsCharactersVictoryPointsYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsCharactersActiveTotalActiveTotal_1 {
  /**
   * Amount of victory points
   */
  amount?: number;
  /**
   * character_id integer
   */
  character_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsCharactersLastWeekLastWeek_1 extends GetFwLeaderboardsCharactersActiveTotalActiveTotal_1{}
/**
 * yesterday object
 */
interface GetFwLeaderboardsCharactersYesterdayYesterday_1 extends GetFwLeaderboardsCharactersActiveTotalActiveTotal_1{}

/*!
 * ESI endpoint: get:/fw/leaderboards/corporations/
 */
/**
 * Top 10 ranking of corporations active in faction warfare by total kills. A corporation is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsActiveTotal = GetFwLeaderboardsCorporationsActiveTotalActiveTotal[];
/**
 * Top 10 ranking of corporations by kills in the past week
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsLastWeek = GetFwLeaderboardsCorporationsLastWeekLastWeek[];
/**
 * Top 10 ranking of corporations by kills in the past day
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsYesterday = GetFwLeaderboardsCorporationsYesterdayYesterday[];
/**
 * Top 10 ranking of corporations active in faction warfare by total victory points. A corporation is considered "active" if they have participated in faction warfare in the past 14 days
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsVictoryPointsActiveTotal = GetFwLeaderboardsCorporationsActiveTotalActiveTotal_1[];
/**
 * Top 10 ranking of corporations by victory points in the past week
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsVictoryPointsLastWeek = GetFwLeaderboardsCorporationsLastWeekLastWeek_1[];
/**
 * Top 10 ranking of corporations by victory points in the past day
 *
 * @maxItems 10
 */
type GetFwLeaderboardsCorporationsVictoryPointsYesterday = GetFwLeaderboardsCorporationsYesterdayYesterday_1[];
/**
 * 200 ok object
 */
interface GetFwLeaderboardsCorporationsOk {
  kills: GetFwLeaderboardsCorporationsKills;
  victory_points: GetFwLeaderboardsCorporationsVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Top 10 rankings of corporations by number of kills from yesterday, last week and in total
 */
interface GetFwLeaderboardsCorporationsKills {
  active_total: GetFwLeaderboardsCorporationsActiveTotal;
  last_week: GetFwLeaderboardsCorporationsLastWeek;
  yesterday: GetFwLeaderboardsCorporationsYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsCorporationsActiveTotalActiveTotal {
  /**
   * Amount of kills
   */
  amount?: number;
  /**
   * corporation_id integer
   */
  corporation_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsCorporationsLastWeekLastWeek extends GetFwLeaderboardsCorporationsActiveTotalActiveTotal {}
/**
 * yesterday object
 */
interface GetFwLeaderboardsCorporationsYesterdayYesterday extends GetFwLeaderboardsCorporationsActiveTotalActiveTotal {}
/**
 * Top 10 rankings of corporations by victory points from yesterday, last week and in total
 */
interface GetFwLeaderboardsCorporationsVictoryPoints {
  active_total: GetFwLeaderboardsCorporationsVictoryPointsActiveTotal;
  last_week: GetFwLeaderboardsCorporationsVictoryPointsLastWeek;
  yesterday: GetFwLeaderboardsCorporationsVictoryPointsYesterday;
  [k: string]: unknown | undefined;
}
/**
 * active_total object
 */
interface GetFwLeaderboardsCorporationsActiveTotalActiveTotal_1 {
  /**
   * Amount of victory points
   */
  amount?: number;
  /**
   * corporation_id integer
   */
  corporation_id?: number;
  [k: string]: unknown | undefined;
}
/**
 * last_week object
 */
interface GetFwLeaderboardsCorporationsLastWeekLastWeek_1 extends GetFwLeaderboardsCorporationsActiveTotalActiveTotal_1 {}
/**
 * yesterday object
 */
interface GetFwLeaderboardsCorporationsYesterdayYesterday_1 extends GetFwLeaderboardsCorporationsActiveTotalActiveTotal_1 {}

/*!
 * ESI endpoint: get:/fw/stats/
 */
/**
 * 200 ok array
 *
 * @maxItems 100
 */
type GetFwStatsOk = GetFwStats_200Ok[];

/**
 * 200 ok object
 */
interface GetFwStats_200Ok {
  /**
   * faction_id integer
   */
  faction_id: number;
  kills: GetFwStatsKills;
  /**
   * How many pilots fight for the given faction
   */
  pilots: number;
  /**
   * The number of solar systems controlled by the given faction
   */
  systems_controlled: number;
  victory_points: GetFwStatsVictoryPoints;
  [k: string]: unknown | undefined;
}
/**
 * Summary of kills against an enemy faction for the given faction
 */
interface GetFwStatsKills {
  /**
   * Last week's total number of kills against enemy factions
   */
  last_week: number;
  /**
   * Total number of kills against enemy factions since faction warfare began
   */
  total: number;
  /**
   * Yesterday's total number of kills against enemy factions
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}
/**
 * Summary of victory points gained for the given faction
 */
interface GetFwStatsVictoryPoints {
  /**
   * Last week's victory points gained
   */
  last_week: number;
  /**
   * Total victory points gained since faction warfare began
   */
  total: number;
  /**
   * Yesterday's victory points gained
   */
  yesterday: number;
  [k: string]: unknown | undefined;
}

/*!
 * ESI endpoint: get:/fw/systems/
 */
/**
 * contested string
 */
type GetFwSystemsContested = "captured" | "contested" | "uncontested" | "vulnerable";
/**
 * 200 ok array
 *
 * @maxItems 171
 */
type GetFwSystemsOk = GetFwSystems_200Ok[];

/**
 * 200 ok object
 */
interface GetFwSystems_200Ok {
  contested: GetFwSystemsContested;
  /**
   * occupier_faction_id integer
   */
  occupier_faction_id: number;
  /**
   * owner_faction_id integer
   */
  owner_faction_id: number;
  /**
   * solar_system_id integer
   */
  solar_system_id: number;
  /**
   * victory_points integer
   */
  victory_points: number;
  /**
   * victory_points_threshold integer
   */
  victory_points_threshold: number;
  [k: string]: unknown | undefined;
}

/*!
 * ESI endpoint: get:/fw/wars/
 */
/**
 * List of factions at war
 *
 * @maxItems 100
 */
type GetFwWarsOk = GetFwWars_200Ok[];

/**
 * 200 ok object
 */
interface GetFwWars_200Ok {
  /**
   * The faction ID of the enemy faction.
   */
  against_id: number;
  /**
   * faction_id integer
   */
  faction_id: number;
  [k: string]: unknown | undefined;
}