@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class TestDataFactory

    Builds response objects in the shapes the custom domain clients return.

    Index
    constructor
    createAllianceInfo createAllianceContact createAllianceContactLabel createCharacterInfo createCharacterPortrait createCharacterAttributes createCharacterSkill createCharacterRoles createCorporationHistoryEntry createCharacterMedal createCharacterNotification createMarketPrice createMarketHistory createCharacterMarketOrder createCharacterOrderHistory createSolarSystem createStation createStructure createItemType createItemGroup createStar createPlanet createSearchResults createEntityName createCorporationMemberRoles createCorporationAsset createCorporationStructure createCorporationWallet createWalletJournalEntry createFleetInfo createFleetMember createFleetWing createIndustryJob createCorporationIndustryJob createBlueprint createCharacterAsset createCharacterLocation createCharacterSkills createCorporationInfo createMarketOrder createWalletTransaction createCorporationWalletTransaction createContract createPublicContract createSovereigntySystem createSovereigntyHub createOrbitalSkyhook createRaidableSkyhook createMercenaryDen createMercenaryTacticalOperation createAccessList createError createTestScenarios createPerformanceTestData createRealisticTestData

    • GET /alliances/{alliance_id}: the alliance ID is in the path, not the body.

      Parameters

      Returns {
          alliance_id?: number;
          name: string;
          ticker: string;
          creator_id: number;
          creator_corporation_id: number;
          executor_corporation_id?: number;
          date_founded: string;
          faction_id?: number;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          contact_id: number;
          contact_type: string & {} | "character" | "corporation" | "alliance";
          standing: number;
          label_ids?: number[];
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          character_id?: number;
          name: string;
          description?: string;
          corporation_id: number;
          alliance_id?: number;
          faction_id?: number;
          ancestry_id?: number;
          bloodline_id: number;
          race_id: number;
          gender: string & {} | "male" | "female";
          security_status?: number;
          title?: string;
          corporation_title?: string;
          character_title_id?: string;
          achievement_score?: number;
          birthday: string;
          [key: string]: unknown;
      }

      • [key: string]: unknown
      • Optionalcharacter_id?: number
      • name: string
      • Optionaldescription?: string
      • corporation_id: number
      • Optionalalliance_id?: number
      • Optionalfaction_id?: number
      • Optionalancestry_id?: number
      • bloodline_id: number
      • race_id: number
      • gender: string & {} | "male" | "female"
      • Optionalsecurity_status?: number
      • Optionaltitle?: string

        Before 2026-08-18; replaced by corporation_title.

      • Optionalcorporation_title?: string

        From 2026-08-18.

      • Optionalcharacter_title_id?: string

        From 2026-08-18.

      • Optionalachievement_score?: number

        From 2026-08-18.

      • birthday: string

    • Parameters

      • characterId: number = 1689391488

      Returns {
          px64x64?: string;
          px128x128?: string;
          px256x256?: string;
          px512x512?: string;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          charisma: number;
          intelligence: number;
          memory: number;
          perception: number;
          willpower: number;
          bonus_remaps?: number;
          last_remap_date?: string;
          accrued_remap_cooldown_date?: string;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          skill_id: number;
          skillpoints_in_skill: number;
          trained_skill_level: number;
          active_skill_level: number;
          [key: string]: unknown;
      }

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /universe/structures/{structure_id}: the ID is in the path, not the body.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /universe/types/{type_id}: the category is on the group, not the type.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /universe/stars/{star_id}: the star ID is in the path, not the body.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /characters/{character_id}/search: one list per requested category, keyed by the singular category name.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /fleets/{fleet_id}: the fleet ID is in the path, not the body.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • A fleet member as GET /fleets/{fleet_id}/members sends it. The default is the fleet commander, whom ESI places in no wing or squad (-1).

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • A wing as GET /fleets/{fleet_id}/wings sends it: keyed by id.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • A corporation industry job as GET /corporations/{corporation_id}/industry/jobs sends it: placed by location_id, where a character job has station_id.

      Parameters

      • overrides: Record<string, any> = {}

      Returns any

    • GET /corporations/{corporation_id}: the ID is in the path, not the body.

      Parameters

      Returns {
          corporation_id?: number;
          name: string;
          ticker: string;
          description?: string;
          url?: string;
          alliance_id?: number;
          ceo_id?: number;
          creator_id?: number;
          date_founded?: string;
          faction_id?: number;
          enlisted_faction_id?: number;
          home_station_id?: number;
          member_count: number;
          shares?: number;
          tax_rate?: number;
          tax_rates?: { isk: number; loyalty_point: number; [key: string]: unknown };
          war_eligible?: boolean;
          friendly_fire?: string & {} | "legal" | "illegal";
          state?: "closed" | string & {} | "active";
          type?: string & {} | "player_owned" | "npc_owned";
          palette?: {
              main_color: string;
              secondary_color?: string;
              tertiary_color?: string;
              [key: string]: unknown;
          };
          [key: string]: unknown;
      }

      • [key: string]: unknown
      • Optionalcorporation_id?: number
      • name: string
      • ticker: string
      • Optionaldescription?: string
      • Optionalurl?: string
      • Optionalalliance_id?: number
      • Optionalceo_id?: number
      • Optionalcreator_id?: number
      • Optionaldate_founded?: string
      • Optionalfaction_id?: number

        Before 2026-08-18.

      • Optionalenlisted_faction_id?: number

        From 2026-08-18.

      • Optionalhome_station_id?: number
      • member_count: number
      • Optionalshares?: number
      • Optionaltax_rate?: number

        Before 2026-08-18.

      • Optionaltax_rates?: { isk: number; loyalty_point: number; [key: string]: unknown }

        From 2026-08-18.

      • Optionalwar_eligible?: boolean
      • Optionalfriendly_fire?: string & {} | "legal" | "illegal"

        From 2026-08-18.

      • Optionalstate?: "closed" | string & {} | "active"

        From 2026-08-18.

      • Optionaltype?: string & {} | "player_owned" | "npc_owned"

        From 2026-08-18.

      • Optionalpalette?: {
            main_color: string;
            secondary_color?: string;
            tertiary_color?: string;
            [key: string]: unknown;
        }

        From 2026-08-18.

    • Parameters

      Returns {
          order_id: number;
          type_id: number;
          location_id: number;
          volume_total: number;
          volume_remain: number;
          min_volume: number;
          price: number;
          is_buy_order: boolean;
          system_id: number;
          duration: number;
          issued: string;
          range: string;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          transaction_id: number;
          date: string;
          type_id: number;
          location_id: number;
          unit_price: number;
          quantity: number;
          client_id: number;
          is_buy: boolean;
          is_personal: boolean;
          journal_ref_id: number;
          [key: string]: unknown;
      }

    • A corporation wallet transaction as GET /corporations/{corporation_id}/wallets/{division}/transactions sends it: no is_personal.

      Parameters

      Returns {
          transaction_id: number;
          date: string;
          type_id: number;
          location_id: number;
          unit_price: number;
          quantity: number;
          client_id: number;
          is_buy: boolean;
          journal_ref_id: number;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          contract_id: number;
          issuer_id: number;
          issuer_corporation_id: number;
          assignee_id: number;
          acceptor_id: number;
          start_location_id?: number;
          end_location_id?: number;
          type:
              | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
          status: | string & {}
          | "cancelled"
          | "outstanding"
          | "in_progress"
          | "finished_issuer"
          | "finished_contractor"
          | "finished"
          | "rejected"
          | "failed"
          | "deleted"
          | "reversed";
          title?: string;
          for_corporation: boolean;
          availability: | string & {}
          | "corporation"
          | "alliance"
          | "public"
          | "personal";
          date_issued: string;
          date_expired: string;
          date_accepted?: string;
          date_completed?: string;
          days_to_complete?: number;
          price?: number;
          reward?: number;
          collateral?: number;
          buyout?: number;
          volume?: number;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          contract_id: number;
          issuer_id: number;
          issuer_corporation_id: number;
          start_location_id?: number;
          end_location_id?: number;
          type:
              | string & {}
              | "unknown"
              | "item_exchange"
              | "auction"
              | "courier"
              | "loan";
          title?: string;
          for_corporation?: boolean;
          date_issued: string;
          date_expired: string;
          days_to_complete?: number;
          price?: number;
          reward?: number;
          collateral?: number;
          buyout?: number;
          volume?: number;
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          solar_systems: {
              solar_system_id: number;
              claim: {
                  alliance?: {
                      alliance_id: number;
                      corporation_id?: number;
                      claimed_since?: string;
                      sovereignty_hub?: {
                          id: number;
                          vulnerability_window?: {
                              start: string;
                              end: string;
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      is_capital_system?: boolean;
                      development?: {
                          activity_defense_multiplier?: number;
                          military_level?: number;
                          industrial_level?: number;
                          strategic_level?: number;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  };
                  faction?: { faction_id: number; [key: string]: unknown };
                  unclaimed?: boolean;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }[];
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          planet_id: number;
          solar_system_id: number;
          theft_vulnerability: { start: string; end: string; [key: string]: unknown };
          [key: string]: unknown;
      }

    • Parameters

      Returns {
          id: number;
          name: string;
          description: string;
          membership: {
              allow_everyone: boolean;
              alliances: {
                  alliance_id: number;
                  access:
                      | string & {}
                      | "Unspecified"
                      | "Allowed"
                      | "Blocked"
                      | "Manager"
                      | "Admin";
                  [key: string]: unknown;
              }[];
              corporations: {
                  corporation_id: number;
                  access: | string & {}
                  | "Unspecified"
                  | "Allowed"
                  | "Blocked"
                  | "Manager"
                  | "Admin";
                  [key: string]: unknown;
              }[];
              characters: {
                  character_id: number;
                  access: | string & {}
                  | "Unspecified"
                  | "Allowed"
                  | "Blocked"
                  | "Manager"
                  | "Admin";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          };
          [key: string]: unknown;
      }

    • Returns {
          alliances: { id: number; name: string; ticker: string }[];
          characters: { id: number; name: string; corp: number; alliance: number }[];
          corporations: {
              id: number;
              name: string;
              ticker: string;
              alliance: number;
          }[];
          errorScenarios: { statusCode: number; label: string; probability: number }[];
      }

    • Parameters

      • size: "small" | "medium" | "large" = 'medium'

      Returns {
          alliances: {
              alliance_id?: number;
              name: string;
              ticker: string;
              creator_id: number;
              creator_corporation_id: number;
              executor_corporation_id?: number;
              date_founded: string;
              faction_id?: number;
              [key: string]: unknown;
          }[];
          characters: {
              character_id?: number;
              name: string;
              description?: string;
              corporation_id: number;
              alliance_id?: number;
              faction_id?: number;
              ancestry_id?: number;
              bloodline_id: number;
              race_id: number;
              gender: string & {}
              | "male"
              | "female";
              security_status?: number;
              title?: string;
              corporation_title?: string;
              character_title_id?: string;
              achievement_score?: number;
              birthday: string;
              [key: string]: unknown;
          }[];
          corporations: {
              corporation_id?: number;
              name: string;
              ticker: string;
              description?: string;
              url?: string;
              alliance_id?: number;
              ceo_id?: number;
              creator_id?: number;
              date_founded?: string;
              faction_id?: number;
              enlisted_faction_id?: number;
              home_station_id?: number;
              member_count: number;
              shares?: number;
              tax_rate?: number;
              tax_rates?: { isk: number; loyalty_point: number; [key: string]: unknown };
              war_eligible?: boolean;
              friendly_fire?: string & {} | "legal" | "illegal";
              state?: "closed" | string & {} | "active";
              type?: string & {} | "player_owned" | "npc_owned";
              palette?: {
                  main_color: string;
                  secondary_color?: string;
                  tertiary_color?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }[];
      }

    • Returns {
          alliances: {
              alliance_id?: number;
              name: string;
              ticker: string;
              creator_id: number;
              creator_corporation_id: number;
              executor_corporation_id?: number;
              date_founded: string;
              faction_id?: number;
              [key: string]: unknown;
          }[];
          corporations: {
              corporation_id?: number;
              name: string;
              ticker: string;
              description?: string;
              url?: string;
              alliance_id?: number;
              ceo_id?: number;
              creator_id?: number;
              date_founded?: string;
              faction_id?: number;
              enlisted_faction_id?: number;
              home_station_id?: number;
              member_count: number;
              shares?: number;
              tax_rate?: number;
              tax_rates?: { isk: number; loyalty_point: number; [key: string]: unknown };
              war_eligible?: boolean;
              friendly_fire?: string & {} | "legal" | "illegal";
              state?: "closed" | string & {} | "active";
              type?: string & {} | "player_owned" | "npc_owned";
              palette?: {
                  main_color: string;
                  secondary_color?: string;
                  tertiary_color?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          }[];
          characters: {
              character_id?: number;
              name: string;
              description?: string;
              corporation_id: number;
              alliance_id?: number;
              faction_id?: number;
              ancestry_id?: number;
              bloodline_id: number;
              race_id: number;
              gender: string & {}
              | "male"
              | "female";
              security_status?: number;
              title?: string;
              corporation_title?: string;
              character_title_id?: string;
              achievement_score?: number;
              birthday: string;
              [key: string]: unknown;
          }[];
          relationships: {
              allianceExecutor: { alliance: number; corporation: number };
              corporationCEO: { corporation: number; character: number };
              characterMembership: {
                  character: number;
                  corporation: number;
                  alliance: number;
              };
          };
      }

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods
    createAllianceInfocreateAllianceContactcreateAllianceContactLabelcreateCharacterInfocreateCharacterPortraitcreateCharacterAttributescreateCharacterSkillcreateCharacterRolescreateCorporationHistoryEntrycreateCharacterMedalcreateCharacterNotificationcreateMarketPricecreateMarketHistorycreateCharacterMarketOrdercreateCharacterOrderHistorycreateSolarSystemcreateStationcreateStructurecreateItemTypecreateItemGroupcreateStarcreatePlanetcreateSearchResultscreateEntityNamecreateCorporationMemberRolescreateCorporationAssetcreateCorporationStructurecreateCorporationWalletcreateWalletJournalEntrycreateFleetInfocreateFleetMembercreateFleetWingcreateIndustryJobcreateCorporationIndustryJobcreateBlueprintcreateCharacterAssetcreateCharacterLocationcreateCharacterSkillscreateCorporationInfocreateMarketOrdercreateWalletTransactioncreateCorporationWalletTransactioncreateContractcreatePublicContractcreateSovereigntySystemcreateSovereigntyHubcreateOrbitalSkyhookcreateRaidableSkyhookcreateMercenaryDencreateMercenaryTacticalOperationcreateAccessListcreateErrorcreateTestScenarioscreatePerformanceTestDatacreateRealisticTestData