Files
star-kitten/packages/lib/src/eve/everef/schema.d.ts

703 lines
25 KiB
TypeScript

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/v1/industry/cost": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["industryCost"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/v1/search": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Search for inventory types
* @description Search for EVE Online inventory types by name
*/
get: operations["search"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
ApiError: {
message?: string;
};
CopyingCost: {
/** @description The alpha clone tax amount */
alpha_clone_tax?: number;
/** @description The estimated item value (EIV). This may not be completely accurate. */
estimated_item_value?: number;
/** @description The facility amount */
facility_tax?: number;
job_cost_base?: number;
materials?: {
[key: string]: components["schemas"]["MaterialCost"];
};
materials_volume?: number;
/** Format: int64 */
product_id?: number;
product_volume?: number;
/**
* Format: double
* @description The number of runs
*/
runs?: number;
/** @description The SCC surcharge amount */
scc_surcharge?: number;
/** @description Bonuses to system cost from structures, rigs, etc. */
system_cost_bonuses?: number;
/**
* @description The system cost index amount.
* Note that this will always be a slightly off, as the ESI does not report the full precision of the system cost index rates.
* See https://github.com/esi/esi-issues/issues/1411
*/
system_cost_index?: number;
time?: string;
total_cost?: number;
total_cost_per_run?: number;
/** @description The total amount of ISK required to start the job */
total_job_cost?: number;
total_material_cost?: number;
};
IndustryCost: {
copying?: {
[key: string]: components["schemas"]["CopyingCost"];
};
input?: components["schemas"]["IndustryCostInput"];
invention?: {
[key: string]: components["schemas"]["InventionCost"];
};
manufacturing?: {
[key: string]: components["schemas"]["ProductionCost"];
};
reaction?: {
[key: string]: components["schemas"]["ProductionCost"];
};
};
IndustryCostInput: {
/**
* Format: int32
* @description The Advanced Capital Ship Construction skill level the installing character
* @default 5
*/
advanced_capital_ship_construction: number;
/**
* Format: int32
* @description The Advanced Industrial Ship Construction skill level the installing character
* @default 5
*/
advanced_industrial_ship_construction: number;
/**
* Format: int32
* @description The Advanced Industry skill level the installing character
* @default 5
*/
advanced_industry: number;
/**
* Format: int32
* @description The Advanced Large Ship Construction skill level the installing character
* @default 5
*/
advanced_large_ship_construction: number;
/**
* Format: int32
* @description The Advanced Medium Ship Construction skill level the installing character
* @default 5
*/
advanced_medium_ship_construction: number;
/**
* Format: int32
* @description The Advanced Small Ship Construction skill level the installing character
* @default 5
*/
advanced_small_ship_construction: number;
/**
* @description Whether installing character is an alpha clone or not
* @default false
*/
alpha: boolean;
/**
* Format: int32
* @description The Amarr Encryption Methods skill level the installing character
* @default 5
*/
amarr_encryption_methods: number;
/**
* Format: int32
* @description The Amarr Starship Engineering skill level the installing character
* @default 5
*/
amarr_starship_engineering: number;
/**
* Format: int64
* @description The blueprint ID to calculate
*/
blueprint_id?: number;
/**
* Format: int32
* @description The Caldari Encryption Methods skill level the installing character
* @default 5
*/
caldari_encryption_methods: number;
/**
* Format: int32
* @description The Caldari Starship Engineering skill level the installing character
* @default 5
*/
caldari_starship_engineering: number;
/** @description The copying cost index of the system where the job is installed */
copying_cost?: number;
/**
* Format: int32
* @description The Core Subsystem Technology skill level the installing character
* @default 5
*/
core_subsystem_technology: number;
/**
* Format: int64
* @description The decryptor type ID to use
*/
decryptor_id?: number;
/**
* Format: int32
* @description The Defensive Subsystem Technology skill level the installing character
* @default 5
*/
defensive_subsystem_technology: number;
/**
* Format: int32
* @description The Electromagnetic Physics skill level the installing character
* @default 5
*/
electromagnetic_physics: number;
/**
* Format: int32
* @description The Electronic Engineering skill level the installing character
* @default 5
*/
electronic_engineering: number;
/**
* @description The facility tax rate of the station or structure where the job is installed
* @default 0
*/
facility_tax: number;
/**
* Format: int32
* @description The Gallente Encryption Methods skill level the installing character
* @default 5
*/
gallente_encryption_methods: number;
/**
* Format: int32
* @description The Gallente Starship Engineering skill level the installing character
* @default 5
*/
gallente_starship_engineering: number;
/**
* Format: int32
* @description The Graviton Physics skill level the installing character
* @default 5
*/
graviton_physics: number;
/**
* Format: int32
* @description The High Energy Physics skill level the installing character
* @default 5
*/
high_energy_physics: number;
/**
* Format: int32
* @description The Hydromagnetic Physics skill level the installing character
* @default 5
*/
hydromagnetic_physics: number;
/**
* Format: int32
* @description The Industry skill level the installing character
* @default 5
*/
industry: number;
/** @description The invention cost index of the system where the job is installed */
invention_cost?: number;
/**
* Format: int32
* @description The Laser Physics skill level the installing character
* @default 5
*/
laser_physics: number;
/** @description The manufacturing cost index of the system where the job is installed */
manufacturing_cost?: number;
/**
* @description Where to get material prices from
* @default ESI_AVG
* @enum {string}
*/
material_prices: "ESI_AVG" | "FUZZWORK_JITA_SELL_MIN" | "FUZZWORK_JITA_SELL_AVG" | "FUZZWORK_JITA_BUY_MAX" | "FUZZWORK_JITA_BUY_AVG";
/**
* Format: int32
* @description The material efficiency of the blueprint. Defaults to 10 for T1 products or invention output ME to T2 products
*/
me?: number;
/**
* Format: int32
* @description The Mechanical Engineering skill level the installing character
* @default 5
*/
mechanical_engineering: number;
/**
* Format: int32
* @description The Metallurgy skill level the installing character
* @default 5
*/
metallurgy: number;
/**
* Format: int32
* @description The Minmatar Encryption Methods skill level the installing character
* @default 5
*/
minmatar_encryption_methods: number;
/**
* Format: int32
* @description The Minmatar Starship Engineering skill level the installing character
* @default 5
*/
minmatar_starship_engineering: number;
/**
* Format: int32
* @description The Molecular Engineering skill level the installing character
* @default 5
*/
molecular_engineering: number;
/**
* Format: int32
* @description The Mutagenic Stabilization skill level the installing character
* @default 5
*/
mutagenic_stabilization: number;
/**
* Format: int32
* @description The Nanite Engineering skill level the installing character
* @default 5
*/
nanite_engineering: number;
/**
* Format: int32
* @description The Nuclear Physics skill level the installing character
* @default 5
*/
nuclear_physics: number;
/**
* Format: int32
* @description The Offensive Subsystem Technology skill level the installing character
* @default 5
*/
offensive_subsystem_technology: number;
/**
* Format: int32
* @description The Outpost Construction skill level the installing character
* @default 5
*/
outpost_construction: number;
/**
* Format: int32
* @description The Plasma Physics skill level the installing character
* @default 5
*/
plasma_physics: number;
/**
* Format: int64
* @description The desired product type ID
*/
product_id?: number;
/**
* Format: int32
* @description The Propulsion Subsystem Technology skill level the installing character
* @default 5
*/
propulsion_subsystem_technology: number;
/**
* Format: int32
* @description The Quantum Physics skill level the installing character
* @default 5
*/
quantum_physics: number;
/** @description The reaction cost index of the system where the job is installed */
reaction_cost?: number;
/**
* Format: int32
* @description The Reactions skill level the installing character
* @default 5
*/
reactions: number;
/**
* Format: int32
* @description The Research skill level the installing character
* @default 5
*/
research: number;
/** @description The researching material efficiency cost index of the system where the job is installed */
researching_me_cost?: number;
/** @description The researching time efficiency cost index of the system where the job is installed */
researching_te_cost?: number;
/** @description The type IDs of the rigs installed on the sture structure where the job is installed */
rig_id?: number[];
/**
* Format: int32
* @description The Rocket Science skill level the installing character
* @default 5
*/
rocket_science: number;
/**
* Format: int32
* @description The number of runs
* @default 1
*/
runs: number;
/**
* Format: int32
* @description The Science skill level the installing character
* @default 5
*/
science: number;
/**
* @description The security class of the system where the job is installed. If neither security nor system is supplied, high sec is assumed
* @enum {string}
*/
security?: "HIGH_SEC" | "LOW_SEC" | "NULL_SEC";
/**
* Format: int32
* @description The Sleeper Encryption Methods skill level the installing character
* @default 5
*/
sleeper_encryption_methods: number;
/**
* Format: int64
* @description The type ID of the structure where the job is installed. If not set, an NPC station is assumed.
*/
structure_type_id?: number;
/**
* @description Bonus to apply to system cost, such as the faction warfare bonus
* @default 0
* @example -0.5
*/
system_cost_bonus: number;
/**
* Format: int32
* @description The ID of the system where the job is installed. This will resolve security class and cost indices. If neither security nor system is supplied, high sec is assumed
*/
system_id?: number;
/**
* Format: int32
* @description The time efficiency of the blueprint. Defaults to 20 for T1 products or invention output TE to T2 products
*/
te?: number;
/**
* Format: int32
* @description The Triglavian Encryption Methods skill level the installing character
* @default 5
*/
triglavian_encryption_methods: number;
/**
* Format: int32
* @description The Triglavian Quantum Engineering skill level the installing character
* @default 5
*/
triglavian_quantum_engineering: number;
/**
* Format: int32
* @description The Upwell Encryption Methods skill level the installing character
* @default 5
*/
upwell_encryption_methods: number;
/**
* Format: int32
* @description The Upwell Starship Engineering skill level the installing character
* @default 5
*/
upwell_starship_engineering: number;
};
InventionCost: {
/** @description The alpha clone tax amount */
alpha_clone_tax?: number;
avg_cost_per_copy?: number;
avg_cost_per_run?: number;
avg_cost_per_unit?: number;
avg_time_per_copy?: string;
avg_time_per_run?: string;
avg_time_per_unit?: string;
/**
* Format: int64
* @description The source blueprint of the invention
*/
blueprint_id?: number;
/** @description The estimated item value (EIV). This may not be completely accurate. */
estimated_item_value?: number;
/** Format: double */
expected_copies?: number;
/** Format: double */
expected_runs?: number;
/** Format: double */
expected_units?: number;
/** @description The facility amount */
facility_tax?: number;
job_cost_base?: number;
materials?: {
[key: string]: components["schemas"]["MaterialCost"];
};
materials_volume?: number;
/**
* Format: int32
* @description The material efficiency of the invented blueprint
*/
me?: number;
/** Format: double */
probability?: number;
/** Format: int64 */
product_id?: number;
product_volume?: number;
/**
* Format: double
* @description The number of runs
*/
runs?: number;
/**
* Format: int32
* @description The number of runs on each successfully invented copy
*/
runs_per_copy?: number;
/** @description The SCC surcharge amount */
scc_surcharge?: number;
/** @description Bonuses to system cost from structures, rigs, etc. */
system_cost_bonuses?: number;
/**
* @description The system cost index amount.
* Note that this will always be a slightly off, as the ESI does not report the full precision of the system cost index rates.
* See https://github.com/esi/esi-issues/issues/1411
*/
system_cost_index?: number;
/**
* Format: int32
* @description The time efficiency of the invented blueprint
*/
te?: number;
time?: string;
total_cost?: number;
/** @description The total amount of ISK required to start the job */
total_job_cost?: number;
total_material_cost?: number;
/** Format: int32 */
units_per_run?: number;
};
MaterialCost: {
cost?: number;
cost_per_unit?: number;
/** Format: double */
quantity?: number;
/** Format: int64 */
type_id?: number;
volume?: number;
volume_per_unit?: number;
};
ProductionCost: {
/** @description The alpha clone tax amount */
alpha_clone_tax?: number;
/**
* Format: int64
* @description The source blueprint of the manufacture
*/
blueprint_id?: number;
/** @description The estimated item value (EIV). This may not be completely accurate. */
estimated_item_value?: number;
/** @description The facility amount */
facility_tax?: number;
materials?: {
[key: string]: components["schemas"]["MaterialCost"];
};
materials_volume?: number;
/**
* Format: int32
* @description The material efficiency used
*/
me?: number;
/** Format: int64 */
product_id?: number;
product_volume?: number;
/**
* Format: double
* @description The number of runs
*/
runs?: number;
/** @description The SCC surcharge amount */
scc_surcharge?: number;
/** @description Bonuses to system cost from structures, rigs, etc. */
system_cost_bonuses?: number;
/**
* @description The system cost index amount.
* Note that this will always be a slightly off, as the ESI does not report the full precision of the system cost index rates.
* See https://github.com/esi/esi-issues/issues/1411
*/
system_cost_index?: number;
/**
* Format: int32
* @description The time efficiency used
*/
te?: number;
time?: string;
time_per_run?: string;
time_per_unit?: string;
total_cost?: number;
total_cost_per_run?: number;
total_cost_per_unit?: number;
/** @description The total amount of ISK required to start the job */
total_job_cost?: number;
total_material_cost?: number;
/**
* Format: int64
* @description Total number of item produced
*/
units?: number;
/**
* Format: int64
* @description Total number of item produced
*/
units_per_run?: number;
};
SearchEntry: {
/** Format: int64 */
id?: number;
language?: string;
/**
* Format: int64
* @description Relevance score of the search result. Lower is better.
*/
relevance?: number;
title?: string;
/** @enum {string} */
type?: "inventory_type" | "market_group" | "category" | "group";
type_name?: string;
urls?: components["schemas"]["SearchEntryUrls"];
};
SearchEntryUrls: {
everef?: string;
reference_data?: string;
};
SearchResult: {
entries?: components["schemas"]["SearchEntry"][];
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
industryCost: {
parameters: {
query?: {
input?: components["schemas"]["IndustryCostInput"];
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Success */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["IndustryCost"];
};
};
/** @description Client error */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiError"];
};
};
/** @description Server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiError"];
};
};
};
};
search: {
parameters: {
query: {
/** @description Search query (minimum 3 characters) */
q: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Success */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SearchResult"];
};
};
/** @description Client error */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiError"];
};
};
/** @description Server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiError"];
};
};
};
};
}